51 1 4MB
HUAWEI HSS9860 PGW MML Command Protocol
(V900R010C00)
Huawei Technologies Co., Ltd.
2016-10-27
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Contents HUAWEI HSS9860...........................................................................................................................1 PGW MML Command Protocol.....................................................................................................1 Huawei Technologies Co., Ltd...........................................................................................................1 Contents..............................................................................................................................................i HUAWEI HSS9860 PGW MML Command Protocol...............................................................lii HLR, provisioning system interface, protocol, MML, OMC.................................................lii 1 Change History..............................................................................................................................1 2 Overview.......................................................................................................................................15 2.1 System Description.......................................................................................................................................................15 2.2 Network Connection.....................................................................................................................................................16 2.3 Terms............................................................................................................................................................................16
Provisioning System Interface.....................................................................................................16 Provisioning System Client..........................................................................................................17 Web UI..............................................................................................................................................17 PGW..................................................................................................................................................17 3 Stipulation....................................................................................................................................18 The stipulation of matching error messages:............................................................................18 4 Time Setting.................................................................................................................................20 4.1 Handshake Message Time............................................................................................................................................20 4.2 Command Reply Time..................................................................................................................................................20
5 Communication Protocol...........................................................................................................21 6 Command Syntax........................................................................................................................22 7 Command Output........................................................................................................................24 7.1 General Message Format (TCP Port 7777)..................................................................................................................24
There is together 1 report..............................................................................................................24
All rights reserved.
Page i of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
7.2 General Message Format (TCP Port 7776)..................................................................................................................25
There is together 1 report..............................................................................................................25 There is together 1 report..............................................................................................................26 There is together 1 report..............................................................................................26 7.3 Difference Between Messages over Port 7776 and Port 7777.....................................................................................26 7.4 Operation Success Message.........................................................................................................................................27 7.5 Operation Failure Message...........................................................................................................................................27
Total count=1...................................................................................................................................28 There is together 1 report..............................................................................................................28 SUBID=subinfo..............................................................................................................................29 Total count=6...................................................................................................................................29 There is together 1 report..............................................................................................................29 STDPRIOR......................................................................................................................................29 Total count=2...................................................................................................................................29 There is together 1 report..............................................................................................................29 8 Key Parameters............................................................................................................................30 9 Summary of Commands.............................................................................................................31 9.1 Operator Login.............................................................................................................................................................31
Parameter Description:..................................................................................................................31 LGI: HLRSN=2, OPNAME="NKR", PWD="*****";.................................................................31 9.2 Operator Logout...........................................................................................................................................................32 9.3 Add a Subscriber Using the Template..........................................................................................................................32
Parameter Description:..................................................................................................................32 9.4 Delete a Subscriber.......................................................................................................................................................33
Parameter Description:..................................................................................................................34 RMV SUB: ISDN="13623456789", RMVKI=TRUE;.................................................................34 9.5 Query the Static Subscriber Data.................................................................................................................................34
Parameter Description:..................................................................................................................34 LST SUB: IMSI="955678112", DETAIL=TRUE;........................................................................35 "EPS Data"........................................................................................................................................42 "Dynamic Status Information For MME"..................................................................................43 "Dynamic Status Information For Non-3GPP".........................................................................45
All rights reserved.
Page ii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.6 Query the Dynamic Subscriber Data............................................................................................................................55
Parameter Description:..................................................................................................................55 LST DYNSUB: ISDN="955678112", EPSFEATURELISTDETAIL=TRUE;..........................56 "Dynamic Status information For GPRS"..................................................................................58 "Dynamic Status Information For Non-3GPP".........................................................................64 "Short Message Dynamic data for GSM"..................................................................................64 "Short Message Dynamic data for GPRS".................................................................................64 "ShortMessage Center Information"...........................................................................................64 "ShortMessage Center Information of Line2"...........................................................................64 "ODB Supported Features For GSM".........................................................................................65 "ODB Supported Features For GPRS"........................................................................................65 "Unsupported TeleService Feature"............................................................................................65 "Unsupported Bearer service Feature"........................................................................................66 "Unsupported supplementary service Feature"........................................................................66 "Supported LCS "............................................................................................................................67 "Featured Service Supported Features"......................................................................................67 "AS Subscription to notifications Data"....................................................................................67 "Resend Information"....................................................................................................................68 9.7 Modify the Lock State of a Subscriber.........................................................................................................................69
Parameter Description:..................................................................................................................69 MOD LCK: IMSI="984519856312345",IC=TRUE,OC=FALSE;..............................................70 9.8 Query the Lock State of a Subscriber...........................................................................................................................71
Parameter Description:..................................................................................................................71 LST LCK: IMSI="984519856312345";...........................................................................................71 9.9 Modify the GPRS Lock State of a Subscriber..............................................................................................................71
Parameter Description:..................................................................................................................72 MOD GPRSLCK: IMSI="984519856312345",LOCK=TRUE;..................................................72 9.10 Query the GPRS Lock State of a Subscriber..............................................................................................................72
Parameter Description:..................................................................................................................72 LST GPRSLCK: IMSI="984519856312345";................................................................................73 9.11 Modify the SAB Lock State of a Subscriber..............................................................................................................73
All rights reserved.
Page iii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:..................................................................................................................73 MOD SABLCK: IMSI="984519856312345",IC=TRUE,OC=FALSE;......................................74 9.12 Query the SAB Lock State of a Subscriber................................................................................................................74
Parameter Description:..................................................................................................................74 LST SABLCK: IMSI="984519856312345";...................................................................................74 9.13 Set a Subscriber with Multi-MSISDN........................................................................................................................75
Parameter Description:..................................................................................................................75 9.14 Modify the Subscriber IMSI.......................................................................................................................................76
Parameter Description:..................................................................................................................76 MOD IMSI: ISDN="9854670023", NEWIMSI="438320000247111";......................................77 9.15 Query the Subscriber IMSI.........................................................................................................................................77
Parameter Description:..................................................................................................................77 LST IMSI: ISDN="9854670023";...................................................................................................78 9.16 Modify the Subscriber MSISDN................................................................................................................................78
Parameter Description:..................................................................................................................78 MOD ISDN: ISDN="934567901", NEWISDN="9854670023";................................................78 9.17 Query the Subscriber MSISDN..................................................................................................................................79
Parameter Description:..................................................................................................................79 LST ISDN: IMSI="452323132423";...............................................................................................79 9.18 Modify the Telephony Service (TS11).......................................................................................................................81
Parameter Description:..................................................................................................................81 MOD TELE: IMSI="444441234567890", PROV=TRUE;...........................................................81 9.19 Modify the Short Message MT/PP Service(TS21).....................................................................................................82
Parameter Description:..................................................................................................................82 MOD SMSMT: IMSI="444441234567890", PROV=TRUE;.....................................................82 9.20 Modify the Short Message MO/PP Service (TS22)...................................................................................................82
Parameter Description:..................................................................................................................82 MOD SMSMO: IMSI="444441234567890", PROV=TRUE;.....................................................83 9.21 Modify the Alternate Speech and Facsimile Service Group 3 (TS61).......................................................................83
Parameter Description:..................................................................................................................83 MOD TS61: IMSI="444441234567890", PROV=TRUE;............................................................84 9.22 Modify the Automatic Facsimile Service Group 3 (TS62)........................................................................................84
Parameter Description:..................................................................................................................84
All rights reserved.
Page iv of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD TS62: IMSI="444441234567890", PROV=TRUE;............................................................84 9.23 Query the Teleservices................................................................................................................................................85
Parameter Description:..................................................................................................................85 LST TS: IMSI="444440123456789";..............................................................................................85 9.24 Modify the Bearer Service 20 (BS20)........................................................................................................................85
Parameter Description:..................................................................................................................85 MOD BS20: IMSI="444441234567890", PROV=TRUE;............................................................86 9.25 Modify the Bearer Service 21 (BS21)........................................................................................................................86
Parameter Description:..................................................................................................................86 MOD BS21: IMSI="444441234567890", PROV=TRUE;............................................................86 9.26 Modify the Bearer Service 22 (BS22)........................................................................................................................87
Parameter Description:..................................................................................................................87 MOD BS22: IMSI="444441234567890", PROV=TRUE;............................................................87 9.27 Modify the Bearer Service 23 (BS23)........................................................................................................................88
Parameter Description:..................................................................................................................88 MOD BS23: IMSI="444441234567890", PROV=TRUE;............................................................88 9.28 Modify the Bearer Service 24 (BS24)........................................................................................................................88
Parameter Description:..................................................................................................................89 MOD BS24: IMSI="444441234567890",PROV=TRUE;.............................................................89 9.29 Modify the Bearer Service 25 (BS25)........................................................................................................................89
Parameter Description:..................................................................................................................89 MOD BS25: IMSI="444441234567890", PROV=TRUE;............................................................90 9.30 Modify the Bearer Service 26 (BS26)........................................................................................................................90
Parameter Description:..................................................................................................................90 MOD BS26: IMSI="444441234567890",PROV=TRUE;.............................................................90 9.31 Modify the Bearer Service 30 (BS30)........................................................................................................................91
Parameter Description:..................................................................................................................91 MOD BS30: IMSI="444441234567890", PROV=TRUE;............................................................91 9.32 Modify the Bearer Service 31 (BS31)........................................................................................................................92
Parameter Description:..................................................................................................................92 MOD BS31: IMSI="444441234567890", PROV=TRUE;............................................................92 9.33 Modify the Bearer Service 32 (BS32)........................................................................................................................92
Parameter Description:..................................................................................................................93
All rights reserved.
Page v of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD BS32: IMSI="444441234567890", PROV=TRUE;............................................................93 9.34 Modify the Bearer Service 33 (BS33)........................................................................................................................93
Parameter Description:..................................................................................................................93 MOD BS33: IMSI="444441234567890", PROV=TRUE;............................................................94 9.35 Modify the Bearer Service 34 (BS34)........................................................................................................................94
Parameter Description:..................................................................................................................94 MOD BS34: IMSI="444441234567890", PROV=TRUE;............................................................94 9.36 Modify the Bearer Service 41 (BS41)........................................................................................................................95
Parameter Description:..................................................................................................................95 MOD BS41: IMSI="444441234567890", PROV=TRUE;............................................................95 9.37 Modify the Bearer Service 42 (BS42)........................................................................................................................95
Parameter Description:..................................................................................................................96 MOD BS42: IMSI="444441234567890", PROV=TRUE;............................................................96 9.38 Modify the Bearer Service 43 (BS43)........................................................................................................................96
Parameter Description:..................................................................................................................96 MOD BS43: IMSI="444441234567890", PROV=TRUE;............................................................97 9.39 Modify the Bearer Service 44 (BS44)........................................................................................................................97
Parameter Description:..................................................................................................................97 MOD BS44: IMSI="444441234567890", PROV=TRUE;............................................................97 9.40 Modify the Bearer Service 45 (BS45)........................................................................................................................98
Parameter Description:..................................................................................................................98 MOD BS45: IMSI="444441234567890",PROV=TRUE;.............................................................98 9.41 Modify the Bearer Service 46 (BS46)........................................................................................................................98
Parameter Description:..................................................................................................................98 MOD BS46: IMSI="444441234567890",PROV=TRUE;.............................................................99 9.42 Modify the Bearer Service 51 (BS51)........................................................................................................................99
Parameter Description:..................................................................................................................99 MOD BS51: IMSI="444441234567890",PROV=TRUE;.............................................................99 9.43 Modify the Bearer Service 52 (BS52)......................................................................................................................100
Parameter Description:................................................................................................................100 MOD BS52: IMSI="444441234567890",PROV=TRUE;...........................................................100 9.44 Modify the Bearer Service 53 (BS53)......................................................................................................................101
Parameter Description:................................................................................................................101
All rights reserved.
Page vi of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD BS53: IMSI="444441234567890",PROV=TRUE;...........................................................101 9.45 Modify the Bearer Service 61 (BS61)......................................................................................................................101
Parameter Description:................................................................................................................101 MOD BS61: IMSI="444441234567890",PROV=TRUE;...........................................................102 9.46 Modify the Bearer Service 81 (BS81)......................................................................................................................102
Parameter Description:................................................................................................................102 MOD BS81: IMSI="444441234567890",PROV=TRUE;...........................................................102 9.47 Query Bearer Services..............................................................................................................................................103
Parameter Description:................................................................................................................103 LST BS: IMSI="444440123456789";............................................................................................103 9.48 Modify the ODB-SS.................................................................................................................................................103
Parameter Description:................................................................................................................104 MOD ODBSS: IMSI="984519856312345",ODBSS=TRUE;...................................................104 9.49 Modify the ODB-BIC Service..................................................................................................................................104
Parameter Description:................................................................................................................104 MOD ODBIC: IMSI="984519856312345",ODBIC=BAIC;.....................................................105 9.50 Modify the ODB-BOC Service................................................................................................................................105
Parameter Description:................................................................................................................105 MOD ODBOC: IMSI="984519856312345",ODBOC=BAOC;................................................106 9.51 Modify the ODB-PB1 Service..................................................................................................................................107
Parameter Description:................................................................................................................107 MOD ODBPB1: IMSI="984519856312345",ODBPB1=TRUE;...............................................107 9.52 Modify the ODB-PB2 Service..................................................................................................................................107
Parameter Description:................................................................................................................107 MOD ODBPB2: IMSI="984519856312345",ODBPB2=TRUE;...............................................108 9.53 Modify the ODB-PB3 Service..................................................................................................................................108
Parameter Description:................................................................................................................108 MOD ODBPB3: IMSI="984519856312345",ODBPB3=TRUE;...............................................108 9.54 Modify the ODB-PB4 Service..................................................................................................................................109
Parameter Description:................................................................................................................109 MOD ODBPB4: IMSI="984519856312345",ODBPB4=TRUE;...............................................109 9.55 Modify the ODB-Entertainment Service..................................................................................................................110
Parameter Description:................................................................................................................110
All rights reserved.
Page vii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD ODBENTE: IMSI="984519856312345",ODBENTE=TRUE;.......................................110 9.56 Modify the ODB-Information Service.....................................................................................................................110
Parameter Description.................................................................................................................110 MOD ODBINFO: IMSI="984519856312345",ODBINFO=TRUE;........................................111 9.57 Modify the ODB-Roam Service...............................................................................................................................111
Parameter Description.................................................................................................................111 MOD ODBROAM: IMSI="984519856312345",ODBROAM=NOBAR;..............................112 9.58 Query the ODB Services..........................................................................................................................................113
Parameter Description:................................................................................................................113 LST ODBDAT: IMSI="984519856312345";...............................................................................113 9.59 Modify the CLIP Service..........................................................................................................................................114
Parameter Description:................................................................................................................114 MOD CLIP: IMSI="345126789012345",PROV=FALSE;.........................................................115 MOD CLIP:IMSI="345126789012345",PROV=TRUE,OVERRIDE=FALSE;.....................115 9.60 Query the CLIP Service............................................................................................................................................115
Parameter Description:................................................................................................................116 LST CLIP: IMSI="345126789012345";........................................................................................116 9.61 Modify the CLIR Service.........................................................................................................................................116
Parameter Description:................................................................................................................116 MOD CLIR: IMSI="345126789012345",PROV=FALSE;........................................................117 MOD CLIR: IMSI="345126789012345",PROV=TRUE,MODE=TEMPALLOWED;.........117 9.62 Query the CLIR Service...........................................................................................................................................118
Parameter Description:................................................................................................................118 LST CLIR: IMSI="345126789012345";.......................................................................................118 9.63 Modify the COLP Service........................................................................................................................................118
Parameter Description:................................................................................................................118 MOD COLP: IMSI="345126789012345",PROV=TRUE,OVERRIDE=FALSE;...................119 MOD COLP: IMSI="345126789012345",PROV=FALSE;.......................................................119 9.64 Query the COLP Service..........................................................................................................................................120
Parameter Description:................................................................................................................120 LST COLP: IMSI="345126789012345";......................................................................................120 9.65 Modify the COLR Service........................................................................................................................................120
Parameter Description:................................................................................................................121
All rights reserved.
Page viii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD COLR: IMSI="345126789012345",PROV=FALSE;.......................................................121 9.66 Query the COLR Service..........................................................................................................................................121
Parameter Description:................................................................................................................122 LST COLR: IMSI="345126789012345";......................................................................................122 9.67 Query the Presentation/Restriction Attribute............................................................................................................122
Parameter Description:................................................................................................................122 LST PRERES: IMSI="984519856312345";..................................................................................122 9.68 Modify the CFU Service..........................................................................................................................................123
Parameter Description:................................................................................................................123 MOD CFU: IMSI="123454321234543",PROV=TRUE,OFAID=2,NCS=TRUE,.................124 9.69 Register the CFU Service.........................................................................................................................................124
Parameter Description:................................................................................................................124 9.70 Erase the CFU Service..............................................................................................................................................126
Parameter Description:................................................................................................................126 ERA CFU: IMSI="123454321234543";........................................................................................126 9.71 Modify the CFB Service...........................................................................................................................................127
Parameter Description:................................................................................................................127 9.72 Register the CFB Service.........................................................................................................................................128
Parameter Description:................................................................................................................128 9.73 Erase the CFB Service..............................................................................................................................................129
Parameter Description:................................................................................................................129 ERA CFB: IMSI="123454321234543";.........................................................................................130 9.74 Modify the CFNRy Service......................................................................................................................................130
Parameter Description:................................................................................................................130 9.75 Register the CFNRy Service.....................................................................................................................................132
Parameter Description:................................................................................................................132 9.76 Erase the CFNRy Service.........................................................................................................................................133
Parameter Description:................................................................................................................133 ERA CFNRY:IMSI="123454321234543";...................................................................................133 9.77 Modify the CFNRc Service......................................................................................................................................134
Parameter Description:................................................................................................................134 MOD CFNRC: IMSI="123454321234543",PROV=TRUE,OFAID=2,NCS=TRUE;...........135 9.78 Register the CFNRc Service.....................................................................................................................................135
Parameter Description:................................................................................................................135 All rights reserved.
Page ix of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.79 Erase the CFNRc Service.........................................................................................................................................136
Parameter Description:................................................................................................................136 ERA CFNRC: IMSI="123454321234543";..................................................................................137 9.80 Query All Call Forwarding Services........................................................................................................................137
Parameter Description:................................................................................................................137 LST CFALL: IMSI="984519856312345";....................................................................................137 "CFB"...............................................................................................................................................138 "CFNRC".........................................................................................................................................138 "CFNRY".........................................................................................................................................138 "CFD"..............................................................................................................................................139 9.81 Modify the Call Waiting Supplementary Service.....................................................................................................139
Parameter Description:................................................................................................................139 MOD CWAIT: IMSI="444441234567890",PROV=TRUE;......................................................139 9.82 Activate the Call Waiting Supplementary Service....................................................................................................140
Parameter Description:................................................................................................................140 ACT CWAIT: IMSI="123454321234543",BSG=TS1X;............................................................140 9.83 Deactivate the Call Waiting Supplementary Service................................................................................................141
Parameter Description:................................................................................................................141 DEA CWAIT: IMSI="123454321234543";..................................................................................141 9.84 Query the Call Waiting Supplementary Service.......................................................................................................142
Parameter Description:................................................................................................................142 LST CWAIT: IMSI="444441234567890";...................................................................................142 Output.............................................................................................................................................142 9.85 Modify the Call Hold Supplementary Service.........................................................................................................143
Parameter Description:................................................................................................................143 MOD HOLD: IMSI="444441234567890", PROV=TRUE;......................................................143 9.86 Query the Call Hold Supplementary Service...........................................................................................................144
Parameter Description:................................................................................................................144 LST HOLD: IMSI="444441234567890";.....................................................................................144 9.87 Modify the Multiparty Supplementary Service........................................................................................................144
Parameter Description:................................................................................................................144 MOD MPTY: IMSI="444441234567890", PROV=TRUE;.......................................................145
All rights reserved.
Page x of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.88 Query the Multiparty Supplementary Service..........................................................................................................145
Parameter Description:................................................................................................................145 LST MPTY: IMSI="444441234567890";.....................................................................................145 9.89 Modify the AoCC Supplementary Service...............................................................................................................146
Parameter Description:................................................................................................................146 MOD AOCC: IMSI="444441234567890",PROV=TRUE;........................................................146 9.90 Query the AoCC Supplementary Service.................................................................................................................147
Parameter Description:................................................................................................................147 LST AOCC: IMSI="444441234567890";.....................................................................................147 9.91 Modify the AoCI Supplementary Service................................................................................................................147
Parameter Description:................................................................................................................147 MOD AOCI: IMSI="444441234567890", PROV=TRUE;........................................................148 9.92 Query the AoCI Supplementary Service..................................................................................................................148
Parameter Description:................................................................................................................148 LST AOCI: IMSI="444441234567890";......................................................................................148 9.93 Modify the ECT Supplementary Service..................................................................................................................149
Parameter Description:................................................................................................................149 MOD ECT: IMSI="444441234567890",PROV=TRUE;............................................................149 9.94 Query the ECT Supplementary Service....................................................................................................................150
Parameter Description:................................................................................................................150 LST ECT: IMSI="444441234567890";.........................................................................................150 9.95 Modify the BAOC Supplementary Service..............................................................................................................150
Parameter Description:................................................................................................................150 MOD BAOC:IMSI="444441234567890",PROV=TRUE;.........................................................151 9.96 Modify the BOIC Calls Supplementary Service......................................................................................................151
Parameter Description:................................................................................................................151 MOD BOIC: IMSI="444441234567890",PROV=TRUE;.........................................................152 9.97 Modify the BOIC-exHC Supplementary Service.....................................................................................................152
Parameter Description:................................................................................................................152 MOD BOICEXHC: IMSI="444441234567890",PROV=TRUE;..............................................152 9.98 Modify the BAIC Supplementary Service...............................................................................................................153
Parameter Description:................................................................................................................153 MOD BAIC: IMSI="444441234567890",PROV=TRUE;..........................................................153
All rights reserved.
Page xi of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.99 Modify the BIC-Roam Supplementary Service.......................................................................................................154
Parameter Description:................................................................................................................154 MOD BICROM: IMSI="444441234567890",PROV=TRUE;..................................................154 9.100 Activate the BAOC Supplementary Service...........................................................................................................155
Parameter Description:................................................................................................................155 ACT BAOC: IMSI="444441234567890";....................................................................................155 9.101 Activate the BOIC Supplementary Service............................................................................................................156
Parameter Description:................................................................................................................156 ACT BOIC: IMSI="444441234567890";......................................................................................156 9.102 Activate the BOIC-exHC Supplementary Service.................................................................................................157
Parameter Description:................................................................................................................157 ACT BOICEXHC: IMSI="444441234567890";..........................................................................157 9.103 Activate the BAIC Supplementary Service............................................................................................................158
Parameter Description:................................................................................................................158 ACT BAIC: IMSI="444441234567890";......................................................................................158 9.104 Activate the BIC-Roam Supplementary Service....................................................................................................159
Parameter Description:................................................................................................................159 ACT BICROM: IMSI="444441234567890";...............................................................................159 9.105 Deactivate the BAOC Supplementary Service.......................................................................................................160
Parameter Description:................................................................................................................160 DEA BAOC: IMSI="444441234567890";....................................................................................160 9.106 Deactivate the BOIC Supplementary Service........................................................................................................161
Parameter Description:................................................................................................................161 DEA BOIC: IMSI="444441234567890";.....................................................................................161 9.107 Deactivate the BOIC-exHC Supplementary Service..............................................................................................162
Parameter Description:................................................................................................................162 DEA BOICEXHC: IMSI="444441234567890";..........................................................................162 9.108 Deactivate the BAIC Supplementary Service........................................................................................................163
Parameter Description:................................................................................................................163 DEA BAIC: IMSI="444441234567890";......................................................................................163 9.109 Deactivate the BIC-Roam Supplementary Service................................................................................................164
Parameter Description:................................................................................................................164 DEA BICROM: IMSI="444441234567890";...............................................................................164
All rights reserved.
Page xii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.110 Query the Call Barring Supplementary Services....................................................................................................165
LST CBAR: IMSI="444441234567890",BSG=TS1X;................................................................165 9.111 Modify the Calling Barring Password....................................................................................................................166
Parameter Description:................................................................................................................166 MOD BARPWD: IMSI="444440123456789",PWD="1234";...................................................166 9.112 Modify the Call Barring Control Party...................................................................................................................167
Parameter Description:................................................................................................................167 MOD CBCOU: IMSI="444441234567890", COU=OPERATOR;..........................................167 9.113 Query Supplementary Services..............................................................................................................................168
Parameter Description:................................................................................................................168 LST SS: IMSI="444441234567890";............................................................................................168 9.114 Modify the VLR/SGSN-Specific Roaming Restriction Service............................................................................171
Parameter Description:................................................................................................................171 MOD VSRR: IMSI="984519856312345",PROV=TRUE,TPLTYPE=VLR,TPLID=123;.....172 MOD VSRR: IMSI="984519856312345", PROV=FALSE,TPLTYPE=VLR;........................172 9.115 Query the VLR/SGSN-Specific Roaming Restriction Service..............................................................................172
Parameter Description:................................................................................................................172 LST VSRR: IMSI="984519856312345";......................................................................................172 9.116 Modify the GPRS Service Using a Template.........................................................................................................173
Parameter Description:................................................................................................................173 MOD TPLGPRS: IMSI="984519856312345",PROV=TRUE,TPLID=123;...........................173 9.117 Query the GPRS Service........................................................................................................................................174
Parameter Description:................................................................................................................174 LST GPRS: IMSI="984519856312345";......................................................................................174 9.118 Modify Network Access Mode...............................................................................................................................175
Parameter Description:................................................................................................................176 MOD NAM: IMSI="984519856312345", NAM=BOTH;.........................................................176 9.119 Query Network Access Mode.................................................................................................................................176
Parameter Description:................................................................................................................176 LST NAM: IMSI="984519856312345";.......................................................................................176 9.120 Modify the O-CSI Service......................................................................................................................................177
Parameter Description:................................................................................................................177 MOD OCSI: ISDN="987654321",PROV=TRUE,TPLID=2;...................................................177
All rights reserved.
Page xiii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.121 Modify the T-CSI Service.......................................................................................................................................178
Parameter Description:................................................................................................................178 MOD TCSI: ISDN="987654321",PROV=TRUE,TPLID=2;...................................................178 9.122 Modify the VT-CSI Service....................................................................................................................................179
Parameter Description:................................................................................................................179 MOD VTCSI: ISDN="987654321",PROV=TRUE,TPLID=2;................................................179 9.123 Modify the U-CSI Service......................................................................................................................................180
Parameter Description:................................................................................................................180 MOD UCSI: ISDN="987654321",PROV=TRUE,TPLID=2;...................................................180 9.124 Modify the SS-CSI Service....................................................................................................................................181
Parameter Description:................................................................................................................181 MOD SSCSI: ISDN="987654321",PROV=TRUE,TPLID=2;.................................................181 9.125 Modify the TIF-CSI Service...................................................................................................................................182
Parameter Description:................................................................................................................182 MOD TIFCSI: ISDN="987654321",PROV=TRUE;.................................................................182 9.126 Modify the M-CSI Service.....................................................................................................................................183
Parameter Description:................................................................................................................183 MOD MCSI: ISDN="987654321",PROV=TRUE,TPLID=2;..................................................183 9.127 Modify the SMS-CSI Service.................................................................................................................................184
Parameter Description:................................................................................................................184 9.128 Modify the GPRS-CSI Service...............................................................................................................................185
Parameter Description:................................................................................................................185 MOD GPRSCSI: ISDN="987654321",PROV=TRUE,TPLID=2;...........................................185 9.129 Modify the D-CSI Service......................................................................................................................................186
Parameter Description:................................................................................................................186 MOD DCSI: ISDN="987654321",PROV=TRUE,TPLID=2;...................................................186 9.130 Query the CSI Service............................................................................................................................................187
Parameter Description:................................................................................................................187 LST CSI: ISDN="987654321", CSITYPE=ALL;........................................................................188 9.131 Send a Cancel Location Message...........................................................................................................................188
Parameter Description:................................................................................................................188 SND CANCELC: IMSI="984519856312345",VLRNO="123456789",CHECK=FALSE;.....190 9.132 Modify the Short Message Deliver Path................................................................................................................191
All rights reserved.
Page xiv of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................191 MOD SMDP: IMSI="444441234567890", SMDP=MSC;........................................................191 9.133 Query the Short Message Deliver Path..................................................................................................................192
Parameter Description:................................................................................................................192 LST SMDP: IMSI="984519856312345";.....................................................................................192 9.134 Modify the LCS......................................................................................................................................................192
Parameter Description:................................................................................................................192 MOD LCS: IMSI="984519856312345",PROV=TRUE,TPLID=123;......................................193 9.135 Query the LCS........................................................................................................................................................193
LST LCS: IMSI="984519856312345";.........................................................................................193 9.136 Modify the Subscriber Category............................................................................................................................194
Parameter Description:................................................................................................................194 MOD CATEGORY: IMSI="984519856312345",CATEGORY=COMMON;.......................195 9.137 Query the Subscriber Category..............................................................................................................................195
Parameter Description:................................................................................................................195 LST CATEGORY: IMSI="984519856312345";..........................................................................195 9.138 Add a Subscriber.....................................................................................................................................................196
Parameter Description:................................................................................................................196 9.139 Modify the CUG Subscription Data.......................................................................................................................224
Parameter Description:................................................................................................................224 9.140 Modify the CUG Feature Data...............................................................................................................................226
Parameter Description:................................................................................................................226 9.141 Query the CUG Data..............................................................................................................................................228
Parameter Description:................................................................................................................228 LST CUG: ISDN="955678112";...................................................................................................228 "CUG Subscription List".............................................................................................................228 9.142 Modify the NAEA Service.....................................................................................................................................229
Parameter Description:................................................................................................................229 MOD NAEA: IMSI="444441234567890", PROV=TRUE,NAEA=39,NAEATYPE=BOTH; ..........................................................................................................................................................229 9.143 Query the NAEA Services......................................................................................................................................230
Parameter Description:................................................................................................................230 LST NAEA: IMSI="444441234567890";.....................................................................................230 9.144 Add a KI or Modify an Existing KI........................................................................................................................231
All rights reserved.
Page xv of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................231 9.145 Query the KI Value.................................................................................................................................................233
Parameter Description:................................................................................................................233 LST KI: IMSI="123456789";.........................................................................................................233 9.146 Remove the KI Value..............................................................................................................................................234
Parameter Description:................................................................................................................234 RMV KI: IMSI="123456789";......................................................................................................234 9.147 Check the KI Value.................................................................................................................................................234
Parameter Description:................................................................................................................234 CHK KI: IMSI="123456789";.......................................................................................................234 9.148 Modify the USIM/SIM Card Type.........................................................................................................................235
Parameter Description:................................................................................................................235 9.149 Modify the CFD Service........................................................................................................................................236
Parameter Description:................................................................................................................236 9.150 Modify the ODB-BRCF Service............................................................................................................................239
Parameter Description:................................................................................................................239 MOD ODBRCF: IMSI="984519856312345", ODBRCF=NOBRCF;......................................240 9.151 Modify the ODB-BECT Service............................................................................................................................240
Parameter Description:................................................................................................................240 MOD ODBECT: IMSI="984519856312345", ODBECT=NOBECT;......................................241 9.152 Modify the BORO Service.....................................................................................................................................242
Parameter Description:................................................................................................................242 MOD BORO: IMSI="444441234567890",PROV=TRUE;........................................................242 9.153 Activate the BORO Service....................................................................................................................................243
Parameter Description.................................................................................................................243 ACT BORO: IMSI="444441234567890";....................................................................................243 9.154 Deactivate the BORO Service................................................................................................................................244
Parameter Description:................................................................................................................244 DEA BORO: IMSI="444441234567890";....................................................................................244 9.155 Modify the GPRS Service Without a Template......................................................................................................245
Parameter Description:................................................................................................................245 9.156 Modify the PLMN Specific Supplementary Services............................................................................................251
Parameter Description:................................................................................................................251
All rights reserved.
Page xvi of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD PLMNSS: IMSI="123454321234543", PROV=TRUE, PLMNSPECSS=PLMN-SS-1; ..........................................................................................................................................................252 Or.....................................................................................................................................................252 9.157 Modify the ALS Service.........................................................................................................................................252
Parameter Description:................................................................................................................252 MOD ALS: IMSI="984519856312345",PROV=TRUE,LINE2NUM="1234567890123";.....253 9.158 Query the ALS Service...........................................................................................................................................253
Parameter Description:................................................................................................................253 LST ALS: IMSI="444441234567890";.........................................................................................254 9.159 Modify the VVDN Service.....................................................................................................................................254
Parameter Description:................................................................................................................254 MOD VVDN: IMSI="444441234567890", PROV=TRUE;......................................................254 9.160 Query the VVDN Service.......................................................................................................................................255
Parameter Description:................................................................................................................255 LST VVDN: IMSI="444441234567890";....................................................................................255 9.161 Modify the RBT Service.........................................................................................................................................255
Parameter Description:................................................................................................................255 MOD RBT: IMSI="444441234567890",PROV=TRUE,RBT=6;..............................................256 9.162 Query the RBT Service...........................................................................................................................................256
Parameter Description:................................................................................................................256 LST RBT: IMSI="444441234567890";.........................................................................................256 9.163 Modify the ODBPOS Service................................................................................................................................257
Parameter Description:................................................................................................................257 9.164 Modify the EMLPP Service...................................................................................................................................258
Parameter Description:................................................................................................................258 9.165 Query the EMLPP Service.....................................................................................................................................259
Parameter Description:................................................................................................................259 LST EMLPP: IMSI="444441234567890";...................................................................................259 9.166 Modify the ECATEGORY Service.........................................................................................................................260
Parameter Description:................................................................................................................260 MOD ECATEGORY: IMSI="444441234567890",PROV=TRUE, ECATEGORY=6;..........260 9.167 Query the ECATEGORY Service...........................................................................................................................261
Parameter Description:................................................................................................................261
All rights reserved.
Page xvii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
LST ECATEGORY: IMSI="444441234567890";.......................................................................261 9.168 Modify the ARD Service........................................................................................................................................262
Parameter Description:................................................................................................................262 9.169 Query the ARD Service..........................................................................................................................................263
Parameter Description:................................................................................................................263 LST ARD: IMSI="444441234567890";........................................................................................264 9.170 Modify the CARP Service......................................................................................................................................264
Parameter Description:................................................................................................................264 MOD CARP: IMSI="444441234567890",PROV=TRUE, CARP=6;.......................................265 9.171 Query the CARP Service........................................................................................................................................265
Parameter Description:................................................................................................................265 LST CARP: IMSI="444441234567890";......................................................................................265 9.172 Modify the RSZI Service........................................................................................................................................266
Parameter Description:................................................................................................................266 9.173 Query the RSZI Service..........................................................................................................................................267
Parameter Description:................................................................................................................267 LST RSZI: IMSI="444441234567890";........................................................................................267 9.174 Modify the BS........................................................................................................................................................267
Parameter Description:................................................................................................................267 MOD BS: IMSI="444441234567890",BS20=TRUE, BS25=TRUE;.........................................270 9.175 Modify the EIN Service..........................................................................................................................................270
Parameter Description:................................................................................................................270 MOD EIN: IMSI="460000009123456", OSKPROV=TRUE, OSK=2;...................................272 9.176 Query the EIN Service............................................................................................................................................272
Parameter Description:................................................................................................................272 LST EIN: IMSI="460000009123456";..........................................................................................272 9.177 Modify the VBS Service Using a Template...........................................................................................................273
Parameter Description:................................................................................................................273 MOD TPLVBS: IMSI="444441234567890",PROV=TRUE, TPLID=1;.................................273 9.178 Modify the VBS Service........................................................................................................................................274
Parameter Description:................................................................................................................274 9.179 Query the VBS Service..........................................................................................................................................275
Parameter Description:................................................................................................................275
All rights reserved.
Page xviii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
LST VBS: IMSI="444441234567890";.........................................................................................275 9.180 Modify the VGCS Using a Template......................................................................................................................276
Parameter Description:................................................................................................................276 MOD TPLVGCS: IMSI="444441234567890",PROV=TRUE, TPLID=1;..............................276 9.181 Modify the VGCS...................................................................................................................................................277
Parameter Description:................................................................................................................277 9.182 Query the VGCS.....................................................................................................................................................278
Parameter Description:................................................................................................................278 LST VGCS: IMSI="444441234567890";.....................................................................................278 9.183 Modify the Data of Remote Subscribers................................................................................................................278
Parameter Description:................................................................................................................279 9.184 Query the Data of Remote Subscribers..................................................................................................................280
Parameter Description:................................................................................................................280 LST RMPY: RMNUM="955589";...............................................................................................280 9.185 Modify the FM Service..........................................................................................................................................280
Parameter Description:................................................................................................................280 9.186 Query the FM Service Data....................................................................................................................................281
Parameter Description:................................................................................................................281 LST FM: IMSI="123456789";.......................................................................................................282 9.187 Send a USSD Notify Request.................................................................................................................................282
Parameter Description:................................................................................................................282 SND FMNOTIFY: RMNUM="955589", INITNUM="861386559";.......................................282 9.188 Modify the Data of an Authorized Subscriber........................................................................................................283
Parameter Description:................................................................................................................283 9.189 Query the Data of an Authorized Subscriber..........................................................................................................284
Parameter Description:................................................................................................................284 9.190 Modify FM Registration Data................................................................................................................................285
Parameter Description:................................................................................................................285 9.191 Modify UUS Service..............................................................................................................................................285
Parameter Description:................................................................................................................285 MOD UUS: IMSI="460000009123456", PROV=TRUE, UUS=UUS2;..................................286 9.192 Query UUS Service................................................................................................................................................286
Parameter Description:................................................................................................................286 LST UUS: IMSI="460000009123456";.........................................................................................286 All rights reserved.
Page xix of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.193 Modify the CF Services..........................................................................................................................................287
Parameter Description:................................................................................................................287 9.194 Modify the TS Services..........................................................................................................................................289
Parameter Description:................................................................................................................289 MOD TS: IMSI="444441234567890", TS11=TRUE, TS21=TRUE, TS61=TRUE;...............290 9.195 Modify the ODB Services......................................................................................................................................290
Parameter Description:................................................................................................................290 9.196 Modify the Number Identification Services...........................................................................................................295
Parameter Description:................................................................................................................295 9.197 Modify Other SSs...................................................................................................................................................297
Parameter Description:................................................................................................................297 MOD OSS: IMSI="444441234567890",CWAIT=TRUE,ACTCWAIT=TS1X, HOLD=TRUE;...............................................................................................................................299 9.198 Query Other SSs.....................................................................................................................................................300
Parameter Description:................................................................................................................300 LST OSS: IMSI="444441234567890", DETAIL=TRUE;..........................................................300 9.199 Modify the CB Services.........................................................................................................................................301
Parameter Description:................................................................................................................301 9.200 Modify the CAMEL Services.................................................................................................................................303
Parameter Description:................................................................................................................303 9.201 Check the Subscriber Data Consistency.................................................................................................................306
Parameter Description:................................................................................................................306 CHK CONSY: IMSI="111111111111111";.................................................................................306 9.202 Modify the SMSCF Service...................................................................................................................................307
Parameter Description:................................................................................................................307 MOD SMSCF: IMSI="460000009123456", PROV=TRUE, OFAID=1;.................................307 MOD SMSCF: IMSI="460000009123456", PROV=FALSE;...................................................307 9.203 Active Subscriber’s SMSCF Service......................................................................................................................308
Parameter Description:................................................................................................................308 9.204 Query the SMSCF Service.....................................................................................................................................309
Parameter Description:................................................................................................................309 LST SMSCF: IMSI="460000009123456";...................................................................................309 9.205 Modify the MC Service..........................................................................................................................................309
Parameter Description:................................................................................................................309
All rights reserved.
Page xx of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD MC: IMSI="460000009123456", PROV=TRUE, NBRSB=3, NBRUSER=3;.............310 9.206 Query the MC Service............................................................................................................................................310
Parameter Description:................................................................................................................310 LST MC: IMSI="460000009123456";..........................................................................................310 9.207 Modify the IST Service..........................................................................................................................................311
Parameter Description:................................................................................................................311 MOD IST: IMSI="465700000000000", PROV=TRUE, ISTTIMER=20, ISTRSP=EMPTY; ..........................................................................................................................................................312 9.208 Query the IST Service............................................................................................................................................312
Parameter Description:................................................................................................................312 LST IST: IMSI="460000009123456";...........................................................................................312 9.209 Send a Command for Immediate Service Termination..........................................................................................313
Parameter Description:................................................................................................................313 SND ISTCMD: IMSI="984519856312345",MSCNUM="123456789";..................................313 9.210 Modify the DIC Service.........................................................................................................................................314
Parameter Description:................................................................................................................314 MOD DIC: IMSI="460111111111111", PROV=TRUE, DICLENGTH=DICR_0;...............314 9.211 Query the DIC Service...........................................................................................................................................315
Parameter Description:................................................................................................................315 LST DIC: IMSI="460111111111111";.........................................................................................315 9.212 Modify the Multi-IMSI Service..............................................................................................................................315
Parameter Description:................................................................................................................315 9.213 Query the Multi-IMSI Service................................................................................................................................317
Parameter Description:................................................................................................................317 LST MIMSI: IMSI="460111111111111";....................................................................................318 9.214 Modify the ROUTECATEGORY Service..............................................................................................................319
Parameter Description:................................................................................................................319 9.215 Query the ROUTECATEGORY Service................................................................................................................319
Parameter Description:................................................................................................................320 LST ROUTECATEGORY: IMSI="460100008001001";...........................................................320 9.216 Modify the Expand Enhanced Routing Service.....................................................................................................320
Parameter Description:................................................................................................................320 9.217 Query the Expand Enhanced Routing Service.......................................................................................................321
Parameter Description:................................................................................................................321
All rights reserved.
Page xxi of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
LST EXEXROUTECATEGORY: IMSI="460100008001001";.................................................321 9.218 Modify the Multi-IMSI Voice Mail Service...........................................................................................................321
Parameter Description:................................................................................................................322 9.219 Query the Multi-IMSI Voice Mail Service.............................................................................................................322
Parameter Description:................................................................................................................322 LST MIMSIVM: IMSI="460100008001001";.............................................................................323 9.220 Modify the Call Redirection Service......................................................................................................................323
Parameter Description:................................................................................................................323 MOD CR: IMSI="460100008001001", PROV=TRUE, CALLREDIRECT=23;.....................323 9.221 Query the Call Redirection Service........................................................................................................................324
Parameter Description:................................................................................................................324 LST CR: IMSI="460100008001001";...........................................................................................324 9.222 Modify the NRBT Service......................................................................................................................................324
Parameter Description:................................................................................................................324 MOD NRBT: IMSI="444441234567890",PROV=TRUE,NRBT=600;...................................325 9.223 Query the NRBT Service........................................................................................................................................326
Parameter Description:................................................................................................................326 LST NRBT: IMSI="444441234567890";......................................................................................326 9.224 Modify the Optimized GPRS/EPS Data.................................................................................................................326
Command Name: MOD OPTGPRS..........................................................................................326 Parameter Description:................................................................................................................327 9.225 Query the Optimized GPRS Data...........................................................................................................................332
Parameter Description:................................................................................................................332 LST OPTGPRS: IMSI="444441234567890";..............................................................................332 "Binding OptGprsTpl Data".......................................................................................................333 9.226 Modify the Optimized GPRS by a Template..........................................................................................................334
Parameter Description:................................................................................................................334 MOD TPLOPTGPRS: IMSI="460000009123456", PROV=TRUE, TPLID=2;.....................334 9.227 Modify Multi-Number User Group Services.........................................................................................................335
Parameter Description:................................................................................................................335 9.228 List Multi-Number User Group Services...............................................................................................................336
Parameter Description:................................................................................................................336 LST MNUG: IMSI="460000009123456";...................................................................................336
All rights reserved.
Page xxii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.229 Modify the CCBS Service......................................................................................................................................337
Parameter Description:................................................................................................................337 MOD CCBS: IMSI="460000009123456", CCBS=TRUE, CCBSTARGET=TRUE;.............337 9.230 Query the CCBS Service........................................................................................................................................338
Parameter Description:................................................................................................................338 LST CCBS: IMSI="460000009012345";......................................................................................338 9.231 Modify CSI STATE................................................................................................................................................338
Parameter Description:................................................................................................................338 MOD CSISTATE: IMSI="4600000000000", CSITYPE=MCSI, CSISTATE=TRUE;..........339 Output.............................................................................................................................................339 9.232 Modify Subscription Data of ACR.........................................................................................................................339
Parameter Description:................................................................................................................339 MOD ACR: IMSI="444441234567890",PROV=TRUE;...........................................................339 Output.............................................................................................................................................340 9.233 Query Subscription Data of ACR...........................................................................................................................340
Parameter Description:................................................................................................................340 LST ACR: IMSI="444441234567890";........................................................................................340 Output.............................................................................................................................................340 9.234 Activate ACR..........................................................................................................................................................340
Parameter Description:................................................................................................................340 ACT ACR: IMSI="444441234567890";.......................................................................................341 Output.............................................................................................................................................341 9.235 Deactivate ACR......................................................................................................................................................341
Parameter Description:................................................................................................................341 DEA ACR: IMSI="444441234567890";.......................................................................................341 Output.............................................................................................................................................341 9.236 Add the IMSI-Specific Routing Data.....................................................................................................................342
Parameter Description:................................................................................................................342 ADD IMSIRTSUB: IMSI="123456", HLRSN="222";..............................................................342 Output.............................................................................................................................................342 9.237 Modify the IMSI-Specific Routing Data................................................................................................................342
Parameter Description:................................................................................................................342
All rights reserved.
Page xxiii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD IMSIRTSUB: IMSI="123456", HLRSN="222";.............................................................342 Output.............................................................................................................................................342 9.238 Query the IMSI-Specific Routing Data..................................................................................................................343
Parameter Description:................................................................................................................343 LST IMSIRTSUB: IMSI="123456";............................................................................................343 Output.............................................................................................................................................343 9.239 Remove the IMSI-Specific Routing Data...............................................................................................................343
Parameter Description:................................................................................................................343 RMV IMSIRTSUB: IMSI="123456";.........................................................................................344 Output.............................................................................................................................................344 9.240 Add the NPOTHERRPT Data................................................................................................................................344
Parameter Description:................................................................................................................344 ADD NPOTHERRPT: ISDN="86131075003002", RN="1112";..............................................344 Output.............................................................................................................................................344 9.241 Remove the NPOTHERRPT Data..........................................................................................................................344
Parameter Description:................................................................................................................345 RMV NPOTHERRPT: ISDN="86131075003002";...................................................................345 Output.............................................................................................................................................345 9.242 Modify the NPOTHERRPT Data...........................................................................................................................345
Parameter Description:................................................................................................................345 MOD NPOTHERRPT: ISDN="86131075003003", RN="1113";.............................................345 Output.............................................................................................................................................345 9.243 Query the NPOTHERRPT Data.............................................................................................................................346
Parameter Description:................................................................................................................346 Output.............................................................................................................................................346 9.244 Add the NPDONORSUB Data...............................................................................................................................346
Parameter Description:................................................................................................................346 ADD NPDONORSUB: IMSI="4601075003001",ISDN="86131075003001", RN="1112";..347 Output.............................................................................................................................................347 9.245 Modify the NPDONORSUB Data..........................................................................................................................347
Parameter Description:................................................................................................................347 MOD NPDONORSUB: IMSI="460000009012345", RN="1113";..........................................347
All rights reserved.
Page xxiv of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Output.............................................................................................................................................347 9.246 Remove the NPDONORSUB Data........................................................................................................................348
Parameter Description:................................................................................................................348 RMV NPDONORSUB: ISDN="86138075003001";.................................................................348 Output.............................................................................................................................................348 9.247 Query the NPDONORSUB Data............................................................................................................................348
Parameter Description:................................................................................................................348 LST NPDONORSUB: IMSI="460000009012345";...................................................................348 Output.............................................................................................................................................348 9.248 Modify the SMSROUTE Data...............................................................................................................................349
Parameter Description:................................................................................................................349 MOD SMSROUTE: IMSI="460000009123456", PROV=TRUE, TPLID=4;.........................349 Output.............................................................................................................................................349 9.249 Query the SMSROUTE Data.................................................................................................................................350
Parameter Description:................................................................................................................350 LST SMSROUTE: IMSI="460000009123456";..........................................................................350 Output.............................................................................................................................................350 9.250 Activating the CFD Service....................................................................................................................................350
Parameter Description:................................................................................................................350 ACT CFD: IMSI="460000009123456";........................................................................................351 Output.............................................................................................................................................351 9.251 Deactivating the CFD Service................................................................................................................................351
Parameter Description:................................................................................................................351 DEA CFD: IMSI="460000009123456";.......................................................................................351 Output.............................................................................................................................................351 9.252 Send a Simulative UpdateLocation Message.........................................................................................................352
Parameter Description:................................................................................................................352 SND UPL: ISDN="86131075003003";.........................................................................................352 9.253 Send a Reset Update Location Message.................................................................................................................352
Parameter Description:................................................................................................................352 N/A..................................................................................................................................................352 RST UPL:;.......................................................................................................................................352
All rights reserved.
Page xxv of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.254 Activate the Auxiliary MSISDN.............................................................................................................................353
Parameter Description:................................................................................................................353 ACT ISDN: ISDN="13516888888";............................................................................................353 9.255 Modify the NSMSIN..............................................................................................................................................353
Parameter Description:................................................................................................................353 9.256 List the NSMSIN....................................................................................................................................................354
Parameter Description:................................................................................................................354 LST NSMSIN: IMSI="460000009123456";................................................................................355 9.257 Modifythe COMISDN Service...............................................................................................................................355
Parameter Description:................................................................................................................355 9.258 List the COMISDN Service....................................................................................................................................356
Parameter Description:................................................................................................................356 LST COMISDN: IMSI="460000009012345";............................................................................356 9.259 List the OWNISDN................................................................................................................................................357
Parameter Description:................................................................................................................357 LST OWNISDN: ISDN="460000009123456";...........................................................................357 9.260 Modify the Default OFA Service............................................................................................................................357
Parameter Description:................................................................................................................357 MOD DEFAULTOFA: IMSI="460035589300001", DEFAULTOFA_ID=8;.........................358 9.261 Listing the Default OFA Service............................................................................................................................358
Parameter Description:................................................................................................................358 LST DEFAULTOFA: IMSI="460035589300001";.....................................................................358 9.262 Modify the CPP Service.........................................................................................................................................359
Parameter Description:................................................................................................................359 MOD CPP: IMSI="460035589300001", PROV=TRUE;...........................................................359 9.263 List the CPP Service...............................................................................................................................................359
Parameter Description:................................................................................................................359 LST CPP: IMSI="460035589300001";.........................................................................................359 9.264 Modify the NIR Service.........................................................................................................................................360
Parameter Description:................................................................................................................360 MOD NIR: IMSI="460000009123456", PROV=TRUE, NIR=22;...........................................360 MOD NIR: IMSI="460000009123456", PROV=FALSE;.........................................................360 9.265 List the NIR Service...............................................................................................................................................361
All rights reserved.
Page xxvi of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................361 LST NIR: IMSI="460000009123456";.........................................................................................361 9.266 Modify the ELCS Service......................................................................................................................................361
Parameter Description:................................................................................................................362 MOD ELCS: IMSI="460035589300001", PROV=TRUE;.........................................................362 9.267 List the ELCS Service............................................................................................................................................362
Parameter Description:................................................................................................................362 LST ELCS: IMSI="460035589300001";.......................................................................................362 9.268 Modify the M2M Binding Service.........................................................................................................................363
Parameter Description:................................................................................................................363 9.269 List the M2M Binding Service...............................................................................................................................364
Parameter Description:................................................................................................................364 LST IMEIBIND: IMSI="123456789123456";.............................................................................364 9.270 Modify the Status Notify to M2M Service.............................................................................................................364
Parameter Description:................................................................................................................365 MOD M2MNOTIFY: IMSI="123456789012345", PROV=TRUE;.........................................365 Output.............................................................................................................................................365 9.271 Listing status notify to M2M Service.....................................................................................................................365
Parameter Description:................................................................................................................365 LST M2MNOTIFY: IMSI="123456789123456";.......................................................................365 Output.............................................................................................................................................365 9.272 Modifying the Charging Area Service....................................................................................................................366
Parameter Description:................................................................................................................366 MOD CA: IMSI="460000009012345", PROV=TRUE, CA1=1, CA2=2;................................366 Output.............................................................................................................................................366 9.273 Listing the Charging Area Service (LST CA)........................................................................................................366
Parameter Description:................................................................................................................367 LST CA: IMSI="460000009012345";...........................................................................................367 Output.............................................................................................................................................367 9.274 Modifying the Fraud Prevention Service...............................................................................................................367
Parameter Description:................................................................................................................367 MOD FRAUD: IMSI="444441234567890",PROV= TRUE , TPLID=2;................................368
All rights reserved.
Page xxvii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Output.............................................................................................................................................368 9.275 Listing the Fraud Prevention Service.....................................................................................................................368
Parameter Description:................................................................................................................368 LST FRAUD: IMSI="460035589300001";...................................................................................368 Output.............................................................................................................................................368 9.276 Modify the CNAP Service......................................................................................................................................368
Parameter Description:................................................................................................................369 MOD CNAP:IMSI="345126789012345",PROV=FALSE;.......................................................369 MOD CNAP:IMSI="345126789012345",PROV=TRUE,OVERRIDE=FALSE;...................369 9.277 Query the CNAP Service........................................................................................................................................369
Parameter Description:................................................................................................................369 LST CNAP: IMSI="345126789012345";.....................................................................................370 9.278 Modifying NON-3GPP Subscriber Attributes........................................................................................................370
Parameter Description:................................................................................................................370 MOD NONSUB: IMSI="460000009012345", NON3GPPSUPP=FALSE;............................371 9.279 Listing NON-3GPP Subscriber Attributes..............................................................................................................371
Parameter Description:................................................................................................................371 LST NONSUB: IMSI="460000009012345";...............................................................................371 9.280 Adding a KI in a different Partition........................................................................................................................372
Parameter Description:................................................................................................................372 9.281 Listing Subscrier's Location and Status Information.............................................................................................373
Parameter Description:................................................................................................................374 9.282 Deleting Subscriber's GPRS Data..........................................................................................................................375
Parameter Description:................................................................................................................375 RMV GPRS: IMSI=”123456789”;...............................................................................................375 9.283 Modifying the ICS Service.....................................................................................................................................376
Parameter Description:................................................................................................................376 MOD ICSIND: IMSI="460000009012345", ICSIND=TRUE;................................................376 9.284 Listing the ICS Service...........................................................................................................................................376
Parameter Description:................................................................................................................376 LST ICSIND: IMSI="460000009012345";..................................................................................377 9.285 Modifying the Anchor Service...............................................................................................................................377
Parameter Description:................................................................................................................377
All rights reserved.
Page xxviii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD ANCHOR: IMSI="460000009012345", ANCHOR=FALSE;.......................................378 9.286 Listing the ANCHOR Service................................................................................................................................378
Parameter Description:................................................................................................................378 LST ANCHOR: IMSI="460000009012345";..............................................................................378 9.287 Modifying the IM-O-CSI Service..........................................................................................................................379
Parameter Description:................................................................................................................379 MOD IMOCSI:ISDN="987654321",PROV=TRUE,TPLID=2;..............................................379 9.288 Modifying the IM-VT-CSI Service........................................................................................................................380
Parameter Description:................................................................................................................380 MOD IMVTCSI:ISDN="987654321",PROV=TRUE,TPLID=2;............................................380 9.289 Modify a GROUPSIM Subscriber..........................................................................................................................380
Parameter Description:................................................................................................................380 9.290 List GROUPSIM Subscribers.................................................................................................................................383
Parameter Description:................................................................................................................384 LST GROUPSIM: GIMSI="460000000000000";.......................................................................384 9.291 Modify a GROUPSIM Member.............................................................................................................................385
Parameter Description:................................................................................................................385 9.292 Modifying the EGR................................................................................................................................................386
Parameter Description:................................................................................................................386 MOD EGR: IMSI="460030000000001", PROV=TRUE, EGRHLRSN=4;.............................387 9.293 Listing the EGR......................................................................................................................................................387
Parameter Description:................................................................................................................387 LST EGR: IMSI="460030000000003";.........................................................................................387 9.294 Modifying the EPS.................................................................................................................................................388
Parameter Description:................................................................................................................388 9.295 Listing the EPS.......................................................................................................................................................393
Parameter Description:................................................................................................................393 LST EPS: IMSI="460000009123456";..........................................................................................393 9.296 Modifying the LU-CSI Service..............................................................................................................................394
Parameter Description:................................................................................................................394 MOD LUCSI: IMSI="460000009123456", PROV=TRUE, TPLID=2;...................................394 9.297 Listing the LU-CSI Service....................................................................................................................................395
Parameter Description:................................................................................................................395
All rights reserved.
Page xxix of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
LST LUCSI: IMSI="460000009123456";.....................................................................................395 9.298 Deleting USER_CHANGED_ISDN......................................................................................................................395
Parameter Description:................................................................................................................395 RMV CHANGEDISDN: ISDN="8613772897878";.................................................................395 9.299 Modify the PLMN Region Roaming Service.........................................................................................................396
Parameter Description:................................................................................................................396 MOD PLMNRSZI: IMSI="444441234567890", PROV = TRUE, PLMNTPLID =1;...........397 9.300 List the PLMN Region Roaming Service...............................................................................................................397
Parameter Description:................................................................................................................397 LST PLMNRSZI: IMSI="444441234567890";...........................................................................397 9.301 Modify the STN-SR for a Subscriber.....................................................................................................................398
Parameter Description:................................................................................................................398 MOD STNSR: IMSI="460000009123456", PROV =TRUE, STNSR =”4601389162252”;...398 9.302 List the STN-SR of a Subscriber............................................................................................................................399
Parameter Description:................................................................................................................399 LST STNSR: IMSI="444441234567890";...................................................................................400 9.303 Modify the APN Operator Identifier for a Subscriber............................................................................................400
Parameter Description:................................................................................................................400 9.304 List the APN Operator Identifier of a Subscriber...................................................................................................401
Parameter Description:................................................................................................................401 LST EPSAPNOI: IMSI="444441234567890";............................................................................401 9.305 Modify the EPS AMBR Data for a Subscriber......................................................................................................401
Parameter Description:................................................................................................................401 9.306 List the EPS AMBR Data of a Subscriber..............................................................................................................402
Parameter Description:................................................................................................................402 LST EPSAMBR: IMSI="444441234567890";.............................................................................403 9.307 Modify the Radio Frequency Access Selection Priority for a Subscriber..............................................................403
Parameter Description:................................................................................................................403 MOD RFPRID: IMSI="460000009123456", RATFREQSELPRIID =10;...............................403 9.308 List the Radio Frequency Access Selection Priority of a Subscriber.....................................................................404
Parameter Description:................................................................................................................404 LST RFPRID: IMSI="444441234567890";..................................................................................404 9.309 Modifying the Diameter Roaming Restriction Service..........................................................................................404
All rights reserved.
Page xxx of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................404 MOD DIAMRRS: IMSI="460000009123456", PROV=TRUE, DIAMNODETPL_ID=20; ..........................................................................................................................................................405 9.310 Listing the Diameter Roaming Restriction Service................................................................................................405
Parameter Description:................................................................................................................405 LST DIAMRRS: IMSI="444441234567890";.............................................................................406 The parameters IMSI and ISDN are mutually exclusive. Specify only one of them......406 9.311 Modify the UserCategory.......................................................................................................................................406
Parameter Description:................................................................................................................406 MOD USERCATEGORY: IMSI="984519856312345",USERCATEGORY=M2M;............407 9.312 Listing the UserCategory........................................................................................................................................407
Parameter Description:................................................................................................................407 LST USERCATEGORY: IMSI="984519856312345";...............................................................407 9.313 Modify the Multi-SIM Service...............................................................................................................................408
Parameter Description:................................................................................................................408 9.314 List the Multi-SIM Service.....................................................................................................................................409
Parameter Description:................................................................................................................409 LST MSIM: IMSI="460000009123456";.....................................................................................409 9.315 Modify CSI Not Using Templates..........................................................................................................................410
Parameter Description:................................................................................................................410 9.316 List CSI Provided Not Using Templates................................................................................................................417
Parameter Description:................................................................................................................417 LST NTCSI: IMSI="460000009123456";....................................................................................418 IMSI = 460000009123456..............................................................................................................419 MSISDN = 13500001234..............................................................................................................419 OCSI DATA...................................................................................................................................419 CAMEL = PHASE3.......................................................................................................................419 OCSIDP = COLLECTINFO........................................................................................................419 SK = 1..............................................................................................................................................419 GSMSCFADD = 11234................................................................................................................419 DEFAULTCALL = continueCall................................................................................................419 TCSI DATA...................................................................................................................................419
All rights reserved.
Page xxxi of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
CAMEL = PHASE3.......................................................................................................................419 TCSIDP = TAA.............................................................................................................................419 SK = 1..............................................................................................................................................419 GSMSCFADD = 11234................................................................................................................419 DEFAULTCALL = continueCall................................................................................................419 PSICONF = TRUE........................................................................................................................420 AVAILABLE_PLMN = HPLMN................................................................................................420 9.317 Modifying Premium SMS Barring Service............................................................................................................420
Parameter Description:................................................................................................................420 9.318 Listing Premium SMS Barring Service..................................................................................................................421
Parameter Description:................................................................................................................421 LST PREMSMS: IMSI="460000009123456";.............................................................................421 9.319 Modifying Zone Lock Service................................................................................................................................421
Parameter Description:................................................................................................................421 MOD ZCLOCK: IMSI="460000009123456", ZCLOCKPROV=TRUE;................................422 9.320 Listing Zone Lock Service.....................................................................................................................................422
Parameter Description:................................................................................................................422 LST ZCLOCK: IMSI="460000009123456";................................................................................422 9.321 Listing Zone Lock Service Data.............................................................................................................................423
Parameter Description:................................................................................................................423 LST DYNZC: IMSI="460000009123456";..................................................................................423 9.322 Reseting Zone Lock Service...................................................................................................................................423
Parameter Description:................................................................................................................423 RESET BINDEDTAI: IMSI="460000009123456";....................................................................424 9.323 Modifying the ALS Supplimentary Service...........................................................................................................424
Parameter Description:................................................................................................................424 MOD ALSSUPP: IMSI="460030000000001", PROV=TRUE, ALS_SUPP_TYPE=AOCC; ..........................................................................................................................................................424 9.324 Modifying the ALS ODB Service..........................................................................................................................425
Parameter Description:................................................................................................................425 9.325 Modifying the PS Services.....................................................................................................................................425
Parameter Description:................................................................................................................426 9.326 Modifying the EPS Services...................................................................................................................................427
All rights reserved.
Page xxxii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................427 9.327 Listing the PS Services...........................................................................................................................................428
Parameter Description:................................................................................................................428 LST PSSER: IMSI="460000009123456", DETAIL=FALSE;....................................................429 9.328 Listing the EPS Services........................................................................................................................................429
Parameter Description:................................................................................................................429 LST EPSSER: IMSI="460000009123456", DETAIL=FALSE;.................................................430 Output.............................................................................................................................................430 9.329 Modify the PS Services by PSUSERTPL...............................................................................................................430
Parameter Description:................................................................................................................430 MOD TPLPSSER: IMSI="460000009123456", TPLID=2;.......................................................431 9.330 Modify the EPS Services by EPSUSERTPL..........................................................................................................431
Parameter Description:................................................................................................................431 MOD TPLEPSSER: IMSI="460000009123456", RECORDCOUNT=4, TPLID=3;.............431 9.331 Adding a CS or PS Subscriber................................................................................................................................432
Parameter Description:................................................................................................................432 9.332 Modify the EPS by Template..................................................................................................................................458
Parameter Description:................................................................................................................458 MOD TPLEPS: IMSI="460000009123456", EPSUSERTPLID=2;..........................................458 9.333 Removing a CS or PS Subscriber...........................................................................................................................458
Parameter Description:................................................................................................................458 RMV CSPSSUB: ISDN="13310911001";...................................................................................459 9.334 Querying global charging characteristic.................................................................................................................460
Parameter Description:................................................................................................................460 LST CCGLOBAL: IMSI="460000009123456";..........................................................................460 9.335 Modify Global Charging Characteristic.................................................................................................................460
Parameter Description:................................................................................................................461 MOD CCGLOBAL: IMSI="460000009123456", CHARGE_GLOBAL=NORMAL;..........461 9.336 Adding a Subscriber by CSPS Template................................................................................................................461
Parameter Description:................................................................................................................462 9.337 Add a Convergent HSS Subscriber Using Template..............................................................................................462
Parameter Description:................................................................................................................462 9.338 Remove a Convergent HSS Subscriber..................................................................................................................464
All rights reserved.
Page xxxiii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................464 RMV USCSUB: IMSI="460000009123456";..............................................................................464 9.339 Modifying the CAPL Service.................................................................................................................................465
Parameter Description:................................................................................................................465 MOD CAPL: IMSI="460000009123456", CAPLPROV=TRUE, CAPL=2;............................465 9.340 Listing the CAPL Service.......................................................................................................................................465
Parameter Description:................................................................................................................465 LST CAPL: IMSI="460000009123456";......................................................................................466 9.341 Modifying the EMMIN Service.............................................................................................................................466
Parameter Description:................................................................................................................466 MOD EMMIN: IMSI="1234567", PROV=ADD, DP=12, SCPADDR="1111", SK=12;.....467 9.342 Listing the EMMIN Service...................................................................................................................................467
Parameter Description:................................................................................................................468 LST EMMIN: IMSI="1234567";..................................................................................................468 9.343 Modifying the Association Between IMSI and MSISDN......................................................................................469
Parameter Description:................................................................................................................469 MOD IMSIISDN: IMSI="2013521", ISDN="2014521", PROV=TRUE;..............................469 9.344 Listing the Association Between IMSI and MSISDN............................................................................................470
Parameter Description:................................................................................................................470 LST IMSIISDN: IMSI="45000000";...........................................................................................470 IMSI = 45000000..........................................................................................................................470 ISDN = 2014521...........................................................................................................................470 9.345 Modify VoLTE Subscriber Flag..............................................................................................................................471
Parameter Description:................................................................................................................471 MOD VOLTETAG: IMSI="46000000012345", VOLTETAG=FALSE;.................................471 9.346 List VoLTE Subscriber Flag...................................................................................................................................472
Parameter Description:................................................................................................................472 LST VOLTETAG: IMSI="46000000012345";............................................................................472 9.347 Modify an UE-Level APN Operator Identifier Used in the PS Domain................................................................473
Parameter Description:................................................................................................................473 MOD PSAPNOI: IMSI="460000009123456", PROV =TRUE, PSAPNOITPLID = 1;........473 9.348 List UE-Level APN Operator Identifier Used in the PS Domain...........................................................................474
Parameter Description:................................................................................................................474
All rights reserved.
Page xxxiv of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
LST PSAPNOI: IMSI="460000009123456";...............................................................................474 9.349 Add a KI.................................................................................................................................................................474
Parameter Description:................................................................................................................474 9.350 Remove a KI...........................................................................................................................................................475
Parameter Description:................................................................................................................475 9.351 Modify a KI............................................................................................................................................................476
Parameter Description:................................................................................................................476 9.352 List KIs...................................................................................................................................................................477
Parameter Description:................................................................................................................477 9.353 Check the Value of a KI..........................................................................................................................................478
Parameter Description:................................................................................................................478 9.354 Check the Value of an OPC....................................................................................................................................478
Parameter Description:................................................................................................................478 9.355 Add the HTTP Digest Authentication Information for an IMPI.............................................................................479
Parameter Description:................................................................................................................479 9.356 Remove the HTTP Digest Authentication Information of an IMPI.......................................................................480
Parameter Description:................................................................................................................480 9.357 Modify the HTTP Digest Authentication Information of an IMPI.........................................................................481
Parameter Description:................................................................................................................481 9.358 List the HTTP Digest Authentication Information of an IMPI..............................................................................482
Parameter Description:................................................................................................................482 9.359 Check the HTTP Digest Authentication Information.............................................................................................483
Parameter Description:................................................................................................................483 9.360 Add the SIP Digest Authentication Information for an IMPI.................................................................................483
Parameter Description:................................................................................................................484 9.361 Remove the SIP Digest Authentication Information of an IMPI............................................................................485
Parameter Description:................................................................................................................485 9.362 Modify the SIP Digest Authentication Information of an IMPI.............................................................................485
Parameter Description:................................................................................................................486 9.363 List the SIP Digest Authentication Information of an IMPI...................................................................................487
Parameter Description:................................................................................................................487 9.364 Check the SIP Digest Authentication Information of an IMPI...............................................................................488
Parameter Description:................................................................................................................488 9.365 Set the Early IMS Authentication Scheme.............................................................................................................489
Parameter Description:................................................................................................................489
All rights reserved.
Page xxxv of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.366 List the Early IMS Authentication Scheme............................................................................................................489
Parameter Description:................................................................................................................489 9.367 Set the Early AKA Authentication Scheme............................................................................................................490
Parameter Description:................................................................................................................490 9.368 List the Early AKA Authentication Scheme...........................................................................................................491
Parameter Description:................................................................................................................491 9.369 Add the NASS Bundled Authentication Information for an IMPI.........................................................................491
Parameter Description:................................................................................................................492 9.370 Remove the NASS Bundled Authentication Information of an IMPI....................................................................492
Parameter Description:................................................................................................................492 9.371 List the NASS Bundled Authentication Information of an IMPI...........................................................................493
Parameter Description:................................................................................................................493 9.372 Set the TAA Authentication Scheme for an IMPI..................................................................................................494
Parameter Description:................................................................................................................494 9.373 List the TAA Authentication Scheme Supported by an IMPI.................................................................................494
Parameter Description:................................................................................................................494 TAAFLAG: 1 | 0............................................................................................................................495 Remark: 1 represents TRUE, 0 represents FALSE..................................................................495 9.374 Set the CAVEAKA Authentication Capability.......................................................................................................495
Parameter Description:................................................................................................................495 9.375 List the CAVEAKA Authentication Capability......................................................................................................496
Parameter Description:................................................................................................................496 9.376 List the Authentication Schemes Supported by an IMPI........................................................................................497
Parameter Description:................................................................................................................497 AKAFLAG: 1 | 0...........................................................................................................................497 EAAFLAG: 1 | 0............................................................................................................................497 9.377 Check the HA1 Value for an IMPI.........................................................................................................................498
Parameter Description:................................................................................................................498 9.378 Add an IMS Subscription.......................................................................................................................................498
Parameter Description:................................................................................................................498 9.379 Add an IMS Subscription Using One Command...................................................................................................499
Parameter Description:................................................................................................................500 9.380 Remove an IMS Subscription Using One Command.............................................................................................504
Parameter Description:................................................................................................................504
All rights reserved.
Page xxxvi of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.381 Remove an IMS Subscription.................................................................................................................................504
Parameter Description:................................................................................................................505 9.382 Modify an IMS Subscription ID.............................................................................................................................505
Parameter Description:................................................................................................................505 9.383 List IMS Subscription Information........................................................................................................................506
Parameter Description:................................................................................................................506 9.384 List an IMS Subscription Using One Command....................................................................................................507
Parameter Description:................................................................................................................507 9.385 Set IMS PBX Flag..................................................................................................................................................508
Parameter Description:................................................................................................................508 9.386 List IMS PBX Flag.................................................................................................................................................508
Parameter Description:................................................................................................................508 9.387 Set IMS Subscriber Description.............................................................................................................................509
Parameter Description:................................................................................................................509 9.388 List IMS Subscriber Description............................................................................................................................510
Parameter Description:................................................................................................................510 LST HSUBINFO: SUBID="6290000001";..................................................................................510 9.389 Set Service Data Consistency Flag.........................................................................................................................510
Parameter Description:................................................................................................................510 9.390 List Service Data Consistency Flag........................................................................................................................511
Parameter Description:................................................................................................................511 9.391 Add an IMS Subscriber..........................................................................................................................................512
Parameter Description:................................................................................................................512 9.392 List IMS Subscriber Data.......................................................................................................................................514
Parameter Description:................................................................................................................514 LST IMSSUB: IMSI="123456789";.............................................................................................514 9.393 Add an IMPI...........................................................................................................................................................515
Parameter Description:................................................................................................................515 9.394 Remove an IMPI.....................................................................................................................................................516
Parameter Description:................................................................................................................516 9.395 Modify an IMPI......................................................................................................................................................516
Parameter Description:................................................................................................................516 9.396 Modify an IMPI by One Command........................................................................................................................517
Parameter Description:................................................................................................................517
All rights reserved.
Page xxxvii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.397 Add an IMPU..........................................................................................................................................................519
Parameter Description:................................................................................................................519 9.398 Remove an IMPU...................................................................................................................................................520
Parameter Description:................................................................................................................520 9.399 Modify an IMPU....................................................................................................................................................520
Parameter Description:................................................................................................................520 9.400 Check an IMPU......................................................................................................................................................521
Parameter Description:................................................................................................................521 9.401 Set the Sharing Attribute of an IMPU....................................................................................................................522
Parameter Description:................................................................................................................522 9.402 Add a PSI User.......................................................................................................................................................523
Parameter Description:................................................................................................................523 9.403 Remove a PSI User.................................................................................................................................................524
Parameter Description:................................................................................................................524 9.404 List PSI User Associations.....................................................................................................................................524
Parameter Description:................................................................................................................524 9.405 Set an IRS...............................................................................................................................................................525
Parameter Description:................................................................................................................525 9.406 Set the Default IMPU of an IRS.............................................................................................................................526
Parameter Description:................................................................................................................526 9.407 Add an IMSI...........................................................................................................................................................527
Parameter Description:................................................................................................................527 ADD HIMSI: IMSI="460001234567890", ISDN="8613988888888";......................................527 9.408 Remove an IMSI.....................................................................................................................................................527
Parameter Description:................................................................................................................528 RMV HIMSI: IMSI="460001234567890";..................................................................................528 9.409 Modify an IMSI......................................................................................................................................................528
Parameter Description:................................................................................................................528 MOD HIMSI: IMSI="460001234567890", NEWIMSI="460001234567891";........................528 9.410 Modify Subscriber Identities Using One Command..............................................................................................529
Parameter Description:................................................................................................................529 9.411 Add an MSISDN.....................................................................................................................................................530
Parameter Description:................................................................................................................530 ADD HISDN: IMSI="861381234567890", ISDN="861381234567890";.................................531
All rights reserved.
Page xxxviii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.412 Remove an MSISDN..............................................................................................................................................531
Parameter Description:................................................................................................................531 RMV HISDN: ISDN="861381234567890";................................................................................531 9.413 Modify an MSISDN...............................................................................................................................................531
Parameter Description:................................................................................................................531 MOD HISDN: ISDN="8613988888888", NEWISDN="8613977777777";.............................532 9.414 Modify MSISDNs and IMPUs Using One Command...........................................................................................532
Parameter Description:................................................................................................................532 9.415 List the IMSI Data Associated with an IMPI.........................................................................................................533
Parameter Description:................................................................................................................533 LST HMSID: IMSI="8613988888888";.......................................................................................533 9.416 Add an IMPI-IMSI Association..............................................................................................................................534
Parameter Description:................................................................................................................534 9.417 Remove an IMPI-IMSI Association.......................................................................................................................534
Parameter Description:................................................................................................................535 9.418 List IMPI-IMSI Associations.................................................................................................................................535
Parameter Description:................................................................................................................535 9.419 Modify the Multi-SIM Service for VoLTE.............................................................................................................536
Parameter Description:................................................................................................................536 MOD HMSIM: IMSI="1234567891", MASTERFLAG=TRUE;.............................................536 9.420 List the VoLTE Multi-SIM Service........................................................................................................................537
Parameter Description:................................................................................................................537 9.421 List IMS Subscription Information in Batches.......................................................................................................537
Parameter Description:................................................................................................................538 9.422 Set Mandatory or Optional Capabilities.................................................................................................................538
Parameter Description:................................................................................................................539 9.423 List Mandatory or Optional Capabilities................................................................................................................539
Parameter Description:................................................................................................................539 9.424 List Subscriber Capabilities....................................................................................................................................540
Parameter Description:................................................................................................................540 LST CAP: IMSI="123456789";.....................................................................................................540 9.425 Modify Subscriber Capabilities..............................................................................................................................541
Parameter Description:................................................................................................................541 9.426 Add an S-CSCF Name............................................................................................................................................542
All rights reserved.
Page xxxix of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................542 9.427 Remove an S-CSCF Name.....................................................................................................................................543
Parameter Description:................................................................................................................543 9.428 List S-CSCF Names...............................................................................................................................................543
Parameter Description:................................................................................................................543 9.429 Set a Charging Address ID for an IMPI or a PISI..................................................................................................544
Parameter Description:................................................................................................................544 9.430 List Charging Address IDs of an IMPI or a PISI....................................................................................................545
Parameter Description:................................................................................................................545 9.431 Set the Registration Authority of an IMPU............................................................................................................545
Parameter Description:................................................................................................................546 9.432 List the Registration Authority of an IMPU...........................................................................................................546
Parameter Description:................................................................................................................546 REGAUTH: 1 | 0...........................................................................................................................547 Remark: 1 represents TRUE, 0 represents FALSE..................................................................547 9.433 Set the Roaming Authority Check Flag for an IMPU............................................................................................547
Parameter Description:................................................................................................................547 9.434 List the Roaming Authority Check Flag of an IMPU.............................................................................................548
Parameter Description:................................................................................................................548 VNCFLAG: 1 | 0...........................................................................................................................548 Remark: 1 represents TRUE, 0 represents FALSE..................................................................548 9.435 Set a Visited Network Template ID for an IMPU...................................................................................................548
Parameter Description:................................................................................................................548 9.436 List the Visited Network Template ID of an IMPU................................................................................................549
Parameter Description:................................................................................................................549 9.437 Set the NASS Nomadism Control Flag for an IMPU.............................................................................................550
Parameter Description:................................................................................................................550 9.438 List the NASS Nomadism Control Flag of an IMPU.............................................................................................550
Parameter Description:................................................................................................................550 NNCFLAG: 1 | 0...........................................................................................................................551 Remark: 1 represents ACTIVE, 0 represents DEACTIVE....................................................551 9.439 Set a NASS Nomadism Template ID for an IMPU................................................................................................551
Parameter Description:................................................................................................................551 9.440 List the NASS Nomadism Template ID of an IMPU.............................................................................................552
All rights reserved.
Page xl of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................552 9.441 Set the Sharing of a Service Profile........................................................................................................................552
Parameter Description:................................................................................................................553 9.442 Remove the Sharing of a Service Profile...............................................................................................................553
Parameter Description:................................................................................................................553 9.443 List the Sharing Information of a Service Profile..................................................................................................554
Parameter Description:................................................................................................................554 9.444 Add Reference Location Information for an IMPU...............................................................................................555
Parameter Description:................................................................................................................555 9.445 Remove the Reference Location Information of an IMPU....................................................................................556
Parameter Description:................................................................................................................556 9.446 Modify the Reference Location Information of an IMPU......................................................................................557
Parameter Description:................................................................................................................557 9.447 List the Reference Location Information of an IMPU...........................................................................................559
Parameter Description:................................................................................................................559 DEFRLI: 1 | 0.................................................................................................................................560 9.448 Set the Barring Indication of an IMPU or a PUSI..................................................................................................560
Parameter Description:................................................................................................................560 9.449 List the Barring Indication of an IMPU or a PUSI.................................................................................................561
Parameter Description:................................................................................................................561 9.450 Set a Subscribed Media Profile ID.........................................................................................................................561
Parameter Description:................................................................................................................561 9.451 List Subscribed Media Profile IDs.........................................................................................................................562
Parameter Description:................................................................................................................562 9.452 Add an iFC..............................................................................................................................................................563
Parameter Description:................................................................................................................563 9.453 Remove an iFC.......................................................................................................................................................564
Parameter Description:................................................................................................................564 9.454 Modify an iFC........................................................................................................................................................565
Parameter Description:................................................................................................................565 9.455 List iFCs.................................................................................................................................................................566
Parameter Description:................................................................................................................567 9.456 Remove All iFC Data.............................................................................................................................................568
Parameter Description:................................................................................................................568 9.457 Remove the iFC of an IMPU by AS Address.........................................................................................................568
All rights reserved.
Page xli of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................568 9.458 Add a Shared iFC Set.............................................................................................................................................569
Parameter Description:................................................................................................................569 9.459 Remove a Shared iFC Set.......................................................................................................................................570
Parameter Description:................................................................................................................570 9.460 Modify a Shared iFC Set........................................................................................................................................570
Parameter Description:................................................................................................................571 SUCCESS0001:Operation is successful....................................................................................571 9.461 List Shared iFC Sets...............................................................................................................................................571
Parameter Description:................................................................................................................571 9.462 Add a Service Provider ID......................................................................................................................................572
Parameter Description:................................................................................................................572 9.463 Remove a Service Provider ID...............................................................................................................................573
Parameter Description:................................................................................................................573 9.464 Modify a Service Provider ID................................................................................................................................573
Parameter Description:................................................................................................................574 9.465 List the Service Provider ID...................................................................................................................................574
Parameter Description:................................................................................................................574 9.466 Set the Priority of an IMPU or a PUSI...................................................................................................................575
Parameter Description:................................................................................................................575 9.467 List the Priority of an IMPU or a PUSI..................................................................................................................576
Parameter Description:................................................................................................................576 USRPRIOR: 0 | 1 | 2....................................................................................................................576 Remark: 0 represents HIGH, 1 represents MIDDLE, 2 represents LOW..........................576 9.468 Set 3GPP-Defined Priority of an IMPU or a PUSI................................................................................................576
Parameter Description:................................................................................................................577 9.469 List 3GPP-Defined Priority of an IMPU or a PUSI...............................................................................................577
Parameter Description:................................................................................................................578 STDPRIOR: 0 | 1 | 2 | 3 | 4.......................................................................................................578 9.470 Set the loose route indication of an IMPU or a PUSI.............................................................................................578
Parameter Description:................................................................................................................578 9.471 List the loose route indication of an IMPU or a PUSI...........................................................................................579
Parameter Description:................................................................................................................579 LRI: 0 | 1.........................................................................................................................................580
All rights reserved.
Page xlii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.472 Add an AS Service Profile ID for an IMPU or a PUSI..........................................................................................580
Parameter Description:................................................................................................................580 9.473 Remove an AS Service Profile ID of an IMPU or a PUSI.....................................................................................581
Parameter Description:................................................................................................................581 9.474 List the AS Service Profile IDs of an IMPU or a PUSI..........................................................................................581
Parameter Description:................................................................................................................581 9.475 Set an Alias Group ID.............................................................................................................................................582
Parameter Description:................................................................................................................582 9.476 Set the Repository Data..........................................................................................................................................583
Parameter Description:................................................................................................................583 9.477 List the Repository Data.........................................................................................................................................585
Parameter Description:................................................................................................................585 9.478 Add an Extended Service Data...............................................................................................................................586
Parameter Description:................................................................................................................586 9.479 Remove an Extended Service Data........................................................................................................................587
Parameter Description:................................................................................................................587 9.480 Modify an Extended Service Data..........................................................................................................................588
Parameter Description:................................................................................................................588 9.481 List an Extended Service Data...............................................................................................................................589
Parameter Description:................................................................................................................589 9.482 List the Service Indication of the Repository Data................................................................................................590
Parameter Description:................................................................................................................590 9.483 Set an AS Address for a PUSI................................................................................................................................591
Parameter Description:................................................................................................................592 9.484 List the AS Address of a PUSI...............................................................................................................................592
Parameter Description:................................................................................................................592 9.485 Set the CAMEL Subscription Information.............................................................................................................593
Parameter Description:................................................................................................................593 SET HCSI: IMSI="125353", ISDN="86137565425", CSITYPE=O-CSI, CSITPLID=10;....593 9.486 List the CAMEL Subscription Information............................................................................................................593
Parameter Description:................................................................................................................593 LST HCSI: IMSI="125353", CSITYPE=O-CSI;........................................................................594 9.487 List the Dynamic Location Information of an IMPU.............................................................................................594
Parameter Description:................................................................................................................594
All rights reserved.
Page xliii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.488 List the AS Subscription Data of Subscribers........................................................................................................595
Parameter Description:................................................................................................................596 SRVIND: Service Information......................................................................................................596 ALIASID: The ID of an Alias Group........................................................................................596 ExpiryTime: The Time When the Subscribed Data Expires......................................................596 9.489 List the Dynamic Data of an IMS Subscriber........................................................................................................596
Parameter Description:................................................................................................................597 PENDINGFLAG: 0 | 1.................................................................................................................597 Remark: 0 represents FALSE, 1 represents TRUE..................................................................597 9.490 List the Dynamic Data of a PSI User.....................................................................................................................598
Parameter Description:................................................................................................................598 9.491 Deregister Subscribers............................................................................................................................................599
Parameter Description:................................................................................................................599 9.492 Set the Emergency Service Routing Number.........................................................................................................599
Parameter Description:................................................................................................................599 9.493 List the Emergency Service Routing Number........................................................................................................600
Parameter Description:................................................................................................................600 9.494 Add the OneKey Data for an IMPU.......................................................................................................................601
Parameter Description:................................................................................................................601 9.495 Remove the OneKey Data of an IMPU..................................................................................................................601
Parameter Description:................................................................................................................601 9.496 Modify the OneKey Data of an IMPU...................................................................................................................602
Parameter Description:................................................................................................................602 9.497 List the OneKey Data of an IMPU.........................................................................................................................602
Parameter Description:................................................................................................................603 9.498 Add GUSS for an IMPI..........................................................................................................................................603
Parameter Description:................................................................................................................603 9.499 Remove GUSS from an IMPI.................................................................................................................................606
Parameter Description:................................................................................................................606 9.500 Modify GUSS of an IMPI......................................................................................................................................607
Parameter Description:................................................................................................................607 9.501 List GUSS of an IMPI............................................................................................................................................609
Parameter Description:................................................................................................................609 GSID: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13................................................610
All rights reserved.
Page xliv of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
9.502 Add RCS Service....................................................................................................................................................610
Parameter Description:................................................................................................................610 9.503 Remove RCS Service.............................................................................................................................................611
Parameter Description:................................................................................................................611 RMV HRCSSERVICE: IMSI="460009876543210";.................................................................612 9.504 Modify RCS Service Status....................................................................................................................................612
Parameter Description:................................................................................................................612 9.505 List RCS Service....................................................................................................................................................613
Parameter Description:................................................................................................................613 LST HRCSSERVICE: IMSI="460009876543210";....................................................................613 9.506 Set an SMSC Address.............................................................................................................................................614
Parameter Description:................................................................................................................615 SET HSMSCADDR: ISDN="4600000091234", SMSCADDR="1234567890";....................615 9.507 Remove an SMSC Address....................................................................................................................................615
Parameter Description:................................................................................................................615 RMV HSMSCADDR: ISDN="4600000091234";......................................................................615 9.508 List an SMSC Address............................................................................................................................................616
Parameter Description:................................................................................................................616 LST HSMSCADDR: ISDN="4600000091234";........................................................................616 9.509 Add the AKA Information by Template.................................................................................................................616
Parameter Description:................................................................................................................617 9.510 Add an IMS Subscription by Template...................................................................................................................617
Parameter Description:................................................................................................................617 9.511 Add an IMPI by Template.......................................................................................................................................618
Parameter Description:................................................................................................................619 9.512 Add an IMPU by Template.....................................................................................................................................619
Parameter Description:................................................................................................................619 9.513 Add a PSI User by Template...................................................................................................................................620
Parameter Description:................................................................................................................620 9.514 Add a PUSI by Template........................................................................................................................................621
Parameter Description:................................................................................................................621 9.515 Add an iFC by Template.........................................................................................................................................622
Parameter Description:................................................................................................................622 9.516 Add an IMS Subscriber Using a Template.............................................................................................................623
All rights reserved.
Page xlv of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................623 9.517 Set Emergency Service Routing Numbers in Batches............................................................................................624
Parameter Description:................................................................................................................624 9.518 Modify Shared iFC Sets in Batches........................................................................................................................625
Parameter Description:................................................................................................................625 9.519 Remove IMS Subscription in Batches....................................................................................................................626
Parameter Description:................................................................................................................626 9.520 Remove the SIP Digest Authentication Information of IMPI in Batches...............................................................627
Parameter Description:................................................................................................................627 9.521 Modifying the M2MCISDN Service......................................................................................................................628
Parameter Description:................................................................................................................628 Output.............................................................................................................................................628 9.522 Listing the M2MCISDN Service............................................................................................................................629
Parameter Description:................................................................................................................629 LST M2MCISDN: IMSI="460000009012345";..........................................................................629 Output.............................................................................................................................................629 9.523 Modify the ODB-POS Service for EPS Subscribers..............................................................................................629
Parameter Description:................................................................................................................629 MOD EPSODB: IMSI="461111111111111", EPSODBPOS=BAPOS;..................................630 Output.............................................................................................................................................630 9.524 List the ODB-POS Service for EPS Subscribers....................................................................................................630
Parameter Description:................................................................................................................631 LST EPSODB="460000009012345";............................................................................................631 Output.............................................................................................................................................631 9.525 Provide or Withdraw MAP Address Restriction Template for Subscribers............................................................631
Parameter Description:................................................................................................................631 MOD MAPADDRRES: IMSI="460000009123456", PROV=TRUE, TPLID=4;..................632 Output.............................................................................................................................................632 9.526 List MAP Address Restriction Template of Subscribers........................................................................................632
Parameter Description:................................................................................................................632 LST MAPADDRRES: IMSI="460000009123456";...................................................................632 Output.............................................................................................................................................632 9.527 Modify the STE Service.........................................................................................................................................633
All rights reserved.
Page xlvi of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
Parameter Description:................................................................................................................633 MOD STE: IMSI="460000009123456", STE_PROV =TRUE, GMLC_ADD="12345";.......633 9.528 List the STE Service...............................................................................................................................................633
Parameter Description:................................................................................................................634 LST STE: IMSI="460000009123456";..........................................................................................634 9.529 Modify the Preferred Roaming Service for Subscribers........................................................................................634
Parameter Description:................................................................................................................634 Output.............................................................................................................................................635 9.530 List the Preferred Roaming Service of Subscribers...............................................................................................635
Parameter Description:................................................................................................................635 LST TPLROAMPER: IMSI="460000009123456";.....................................................................635 Output.............................................................................................................................................635 9.531 Modify the SPN Service.........................................................................................................................................636
Parameter Description:................................................................................................................636 Output.............................................................................................................................................636 9.532 List the SPN Service...............................................................................................................................................637
Parameter Description:................................................................................................................637 LST SPN: IMSI="460000009123456";.........................................................................................637 Output.............................................................................................................................................637 9.533 Add an AS Host Name............................................................................................................................................637
Parameter Description:................................................................................................................638 Output.............................................................................................................................................638 9.534 Remove an AS Host Name.....................................................................................................................................638
Parameter Description:................................................................................................................638 RMV HASHOST:ASID=1;.........................................................................................................639 Output.............................................................................................................................................639 9.535 List an AS Host Name............................................................................................................................................639
Parameter Description:................................................................................................................639 LST HASHOST:ASID=1;............................................................................................................639 Output.............................................................................................................................................639 9.536 Modify the NT-U-CSI Service...............................................................................................................................640
Parameter Description:................................................................................................................640
All rights reserved.
Page xlvii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
MOD NTUCSI: IMSI="460000009012345", PROV=ADD, UCSIID =1;..............................640 Output.............................................................................................................................................640 9.537 List the NT-U-CSI Service.....................................................................................................................................640
Parameter Description:................................................................................................................641 LST SPN: IMSI="460000009012345";.........................................................................................641 9.538 Modify the VMCC Service....................................................................................................................................641
Parameter Description:................................................................................................................641 MOD VMCC: IMSI="460000009012345", VMCC=TRUE;.....................................................642 Response........................................................................................................................................642 9.539 List the VMCC Service..........................................................................................................................................642
Parameter Description:................................................................................................................642 LST VMCC: IMSI="460000009012345";....................................................................................642 Response........................................................................................................................................642 9.540 Modify the DND Service........................................................................................................................................642
Parameter Description:................................................................................................................643 MOD DND: IMSI="460000009012345", PROV=TRUE;.........................................................643 Response........................................................................................................................................643 9.541 List the DND Service.............................................................................................................................................643
Parameter Description:................................................................................................................643 LST DND: IMSI="460000009012345";.......................................................................................643 Response........................................................................................................................................643 9.542 Set SIP FTN Suffix.................................................................................................................................................644
Parameter Description:................................................................................................................644 9.543 List SIP FTN Suffix................................................................................................................................................644
LST HCFFTNPOSTFIX:;.............................................................................................................645 SIPFORMATPOSTFIX................................................................................................................645 9.544 List PUR Updated Repository Data.......................................................................................................................645
Parameter Description:................................................................................................................645 9.545 Set PUR Updated Repository Data.........................................................................................................................646
Parameter Description:................................................................................................................646 1. SET HPURREPDATA: IMPU="sip:[email protected]", REPDATA="3
All rights reserved.
Page xlviii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
0", REPTYPE=ALIASREPDATA, AS="as1.huawei.com";..........................................................647 2. SET HPURREPDATA: STARTTIME=2016&05&31&09&00&00, ENDTIME=2016&06&01&09&00&00;......................................................................................647 9.546 Send Simulated PNR Message...............................................................................................................................647
Parameter Description:................................................................................................................648 1. SND HPNR: IMPU="sip:[email protected]", AS="123", DATAREF=RepositoryData;......................................................................................................648 3. SND HPNR: IMPU="sip:[email protected]", AS="as1.huawei.com", DATAREF=RepositoryData, CHECKEXIST=FALSE, SERVICEID="10";........................648 SUCCESS0001:Operation is successful....................................................................................648 10 Common Enumerations..........................................................................................................650 10.1 TSCODE (Telecommunication Service Code) Enumeration...................................................................................650 10.2 BSG (Basic Service Group for all Supplementary) Enumeration............................................................................650 10.3 CBBSG (Basic Service Group for Call Barring) Enumeration................................................................................651 10.4 CFBSG (Basic Service Group for Call Forwarding) Enumeration..........................................................................651 10.5 CWBSG (Basic Service Group for Call Waiting) Enumeration...............................................................................651 10.6 BSCODE (Bearer Service Code) Enumeration........................................................................................................652 10.7 BASCODE (Basic Service Code) Enumeration.......................................................................................................653 10.8 DSCODE (Data Service Code) Enumeration...........................................................................................................654 10.9 CAMEL Phase Enumeration....................................................................................................................................655 10.10 TSCODE and DSCODE Enumeration...................................................................................................................655 10.11 Basic Service Code Enumeration...........................................................................................................................656 10.12 ODB (Operator Determined Barring) Enumeration...............................................................................................659
ODBBIC..........................................................................................................................................659 ODBBOC........................................................................................................................................659 ODBROAM...................................................................................................................................660 10.13 NAM (Network Access Mode) Enumeration.........................................................................................................660 10.14 SMDP (Short Message Delivery Path) Enumeration.............................................................................................660 10.15 CSITYPE (CAMEL Subscription Information Type) Enumeration......................................................................661 10.16 SERVICE_PROPERTY (Service Property Enumeration List for Called Number Analysis) Enumeration...........661 10.17 Priority Locate Flag (PLF) Enumeration................................................................................................................661 10.18 Privacy Exception1-SS Code (LCSPCODE) Enumeration....................................................................................662 10.19 Privacy Exception1-SS Status (LCSSTATUS) Enumeration.................................................................................662 10.20 Privacy Exception1-NotificationToMsUser (LCSNOTIFY) Enumeration............................................................662 10.21 PrivacyException1-ExceptionClientList1-GMLC-Restrict(LCSPGMLCR) Enumeration...................................663 10.22 Privacy Exception1-PlmnClientList (LCSPLMNCL) Enumeration......................................................................663 10.23 Mobile Originated Location Request Supplementary Service Code (LCSMOLRCODE) Enumeration...............664
All rights reserved.
Page xlix of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
10.24 Mobile Originated Location Request Supplementary Service Status (LCSMOLRSTATUS) Enumeration..........664 10.25 Category Enumeration............................................................................................................................................664 10.26 GPRS QoS Enumeration Value for GPRS_BIT_RATE.........................................................................................665 10.27 GPRS QoS Enumeration Value for GPRS_EXT_BIT_RATE...............................................................................674 10.28 GPRS QoS Enumeration Value for GPRS_MEAN_THROUGHPUT...................................................................682 10.29 GPRS QoS Enumeration Value for GPRS_PEAK_THROUGHPUT....................................................................683 10.30 GPRS QoS Enumeration Value for GPRS_SDU_SIZE.........................................................................................684 10.31 GPRS QoS Enumeration Value for GPRS_RESIDUAL_BER..............................................................................689 10.32 GPRS QoS Enumeration Value for GPRS_SDU_ERROR_RATE........................................................................689 10.33 GPRS QoS Enumeration Value for GPRS_TRANSFER_DELAY........................................................................690 10.34 Authentication Algorithm Type Enumeration Value for AUTH_ALOGRITHM...................................................692 10.35 Advice of Charge Service Enumeration Value for AOC_ENU..............................................................................692 10.36 CUG Intra-Restriction Enumeration Value for INTRACUG_OPTION.................................................................693 10.37 CUG Inter-Restriction Enumeration Value for INTERCUG_RESTRICTION......................................................693 10.38 PLMN Client Enumeration Value for PLMN_CLIENT_LIST..............................................................................693 10.39 CBCODE (CB Service Code) Enumeration...........................................................................................................694 10.40 ODBPLMNCODE (ODBPLMN Service Code) Enumeration..............................................................................694 10.41 PLMN-SS-CODE (PLMN Specific-SS Code) Enumeration.................................................................................694 10.42 ODBPOS Enumeration...........................................................................................................................................695 10.43 ODBPOSTYPE Enumeration.................................................................................................................................695 10.44 DEFAULTCALL Enumeration...............................................................................................................................696 10.45 OPTIONTYPE (M2M Binding Operation Type)Enumeration..............................................................................697 10.46 GPRSOPTYPE (Operation Type of MOD OPTGPRS) Enumeration....................................................................697 10.47 APN_TYPE (APN Type of MOD OPTGPRS) Enumeration.................................................................................697 10.48 PDPTYPE (Data Service Type of MOD OPTGPRS) Enumeration.......................................................................698 10.49 DP (DP Value) Enumeration...................................................................................................................................698 10.50 NONARD (Restriction on Non-3GPP Wireless Access) Enumeration..................................................................698 10.51 MIP6FEAVEC (Mobile IP support of NONSUB) Enumeration............................................................................699 10.52 MSIMTYPE (GROUPSIM Type of MOD GROUPSIM) Enumeration................................................................699 10.53 TONETYPE (Tone Type of MOD GROUPSIM) Enumeration.............................................................................699 10.54 CONTENT (Content of LST DYNSUB) Enumeration..........................................................................................700 10.55 DEST (Destination of SND CANCELC) Enumeration.........................................................................................700 10.56 GROUPSIMOPTYPE (Operation Type of MOD GROUPSIM) Enumeration......................................................700 10.57 PRIORITY_LEVEL (PRIORITY_LEVEL of MOD OPTGPRS) Enumeration....................................................701 10.58 UserCategory (User category) Enumeration..........................................................................................................701 10.59 GTYPE (Multi-number user group) Enumeration.................................................................................................701 10.60 TCR (Terminating call right) Enumeration............................................................................................................701 10.61 MSIMTYPE (Multi-SIM service type) Enumeration.............................................................................................702 10.62 CAMELTYPE (CAMEL type) Enumeration.........................................................................................................702 10.63 PROV (Operation) Enumeration............................................................................................................................702 10.64 OCSIDP (O-CSI DP value) Enumeration...............................................................................................................702 10.65 TCSIDP (T-CSI DP value) Enumeration................................................................................................................703
All rights reserved.
Page l of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Contents
10.66 CAMEL (CAMEL phase) Enumeration.................................................................................................................703 10.67 DEFCALL (Default call handling) Enumeration...................................................................................................703 10.68 VLR_NOTSUPPHASE1 (MSC/VLR does not support CAMEL) Enumeration...................................................704 10.69 VLR_NOTSUPPHASE2 (MSC/VLR does not support CAMEL phase2) Enumeration.......................................704 10.70 VLR_NOTSUPPHASE3 (MSC/VLR does not support CAMEL phase3) Enumeration.......................................704 10.71 VLR_NOTSUPPHASE4 (MSC/VLR does not support CAMEL phase4) Enumeration.......................................705 10.72 GMSC_NOTSUPPHASE1 (GMSC does not support CAMEL) Enumeration.....................................................705 10.73 GMSC_NOTSUPPHASE2 (GMSC does not support CAMEL phase2) Enumeration.........................................705 10.74 GMSC_NOTSUPPHASE3 (GMSC does not support CAMEL phase3) Enumeration.........................................706 10.75 VLR_NOTSUPPHASE4 (GMSC does not support CAMEL phase4) Enumeration.............................................706 10.76 AVAILABLE_PLMN (Available PLMN) Enumeration.........................................................................................706 10.77 SYNC (Synchronization in group) Enumeration...................................................................................................707 10.78 MBRSYNC (Synchronization among members) Enumeration.............................................................................707 10.79 DENYUSSD (Support USSD operation of members) Enumeration.....................................................................707 10.80 MBRDC (Restrict calls terminated to Multi-SIM group members) Enumeration.................................................707 10.81 MBRSMS (Restrict messages terminated to Multi-SIM group members) Enumeration.......................................708 10.82 ODBPOS (ODB of packet oriented service) Enumeration....................................................................................708 10.83 TPLTYPE(type of the preferred roaming template) Enumeration.........................................................................708
11 Summary of Error Codes........................................................................................................709 11.1 Effectiveness Error...................................................................................................................................................709 11.2 Execution Error.........................................................................................................................................................711 11.3 System Error.............................................................................................................................................................730
12 Abbreviations:...........................................................................................................................731
All rights reserved.
Page li of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
HUAWEI HSS9860 PGW MML Command Protocol Keywords: HLR, provisioning system interface, protocol, MML, OMC Abstract: This document introduces the provisioning system interface protocol of Huawei HSS9860. The introduction includes detailed description of the system, network communication protocol, reply, command, and error code to help users to set up the hardware and software systems of the provisioning system client. The provisioning system client is the carrier's business and operation support system (BOSS) provided by third-party software suppliers. It manages the subscribers' service data in the HLR/HSS through the provisioning system interface.
All rights reserved.
Page lii of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Change HistoryChange History
1
Change History
Date
Revised Version
Changes and Modifications
2012-04-25
HSS9860 V900R008C00 B010
Added the MOD CA and LST CA commands. Added the following error code: ERR3343:PLMNSS6 conflicts with CA service
2012-04-25
HSS9860 V900R008C00B010
Modified the commands ADD SUB and LST SUB.
HSS9860 V900R008C00B010
Modified the commands ADD SUB and LST SUB.
2012-05-14
HSS9860 V900R008C00B010
Modified the commands LST SUB and LST OPTGPRS.
2012-05-22
HSS9860 V900R008C00B020
Added the command ADD CKI.
2012-04-25
Added the MOD FRAUD and LST FRAUD commands. Added the MOD CNAP and LST CNAP commands.
Added the following error codes:
ERR1145:The partition information about the subscriber cannot be obtained
ERR3249:MSISDN not provided
ERR5006:Command can not be allow to execute in this station
2012-05-22
HSS9860 V900R008C00B020
Added the GET TERMSTATE and RMV GPRS commands.
2012-06-11
HSS9860 V900R008C00B020
Added the commands MOD ICSIND, LST ICSIND, MOD ANCHOR, LST ANCHOR, MOD IMOCSI, MOD IMVTCSI, MOD NONSUB, and LST NONSUB. Modified the commands LST SUB, LST DYNSUB, MOD CAMEL, and LST CSI.
2012-06-12
HSS9860 V900R008C00B020
Added the MOD/LST EGR command.
2012-07-16
HSS9860 V900R008C00B050
Added the MODEPS, LST EPS, MODIMEIBIND, LST IMEIBIND, MOD M2MNOTIFY, MOD LUCSI, and LST
All rights reserved.
Page 1 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Date
Revised Version
Change HistoryChange History
Changes and Modifications LUCSI commands. Modified the REG CFB, REG CFNRC, REG CFNRY, REG CFU, LST SUB, and LST DYNSUB commands.
2012-07-17
HSS9860 V900R008C00B050
Added the MOD GROUPSIM, MOD GROUPUSER, and LST GROUPSIM commands. Added the following error codes:
2012-07-28
ERR3349:MEMBERISDN parameter repeated
ERR3350:The short message service (SMS)activation isdn must be a member isdn
ERR3351:The voice activation isdn must be a member isdn
HSS9860 V900R008C00B060
Added the RMV CHANGEDISDN command.
2012-08-02
HSS9860 V900R008C00B060
Modified the command ADD/LST SUB.
2012-08-03
HSS9860 V900R008C00
Added the MOD PLMNRSZI, LST PLMNRSZI, MOD STNSR, LST STNSR, MOD EPSAPNOI, LST EPSAPNOI, MOD EPSAMBR, LST EPSAMBR, MOD RFPRID, LST RFPRID, MOD DIAMRRS, and LST DIAMRRS commands.
Modified the commands MOD NAM, LST NAM, and LST SUB.
Modified the ADD SUB, LST SUB, LST DYNSUB, MOD LCK, LST LCK, MOD ARD, LST ARD, MODOPTGPRS, LST OPTGPRS, ADD TPLSUB, and MOD TPLOPTGPRS commands. 2012-08-10
HSS9860 V900R008C00
Modified the LST ANCHOR and LST ICSIND commands. Added the IMSI and ISDN parameters to the above commands in return reports.
2012-10-14
HSS9860 V900R008C00SPC100
Add the USERCATEGORY parameter to the ADD SUB command. Modified the SKEY parameter of the MOD NSMSIN command. Added the MOD USERCATEGORY and LST USERCATEGORY commands. Added the following error codes:
2012-12-03
HSS9860 V900R008C01
ERR4010: Number of M2M static subscribers exceeds the maximum
ERR4011: Number of M2M dynamic subscribers exceeds the maximum
Modified the commands MOD MNUG, LST MNUG, and MOD COMISDN. Added the MOD MSIM and LST MSIM commands Added the following error codes:
ERR3076: Request own MSISDN not possible
ERR3335: Forbid removing the primary subscriber in a MultiSIM group
All rights reserved.
Page 2 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Date
2012-12-04
Revised Version
HSS9860 V900R008C01
Change HistoryChange History
Changes and Modifications
ERR3336: COMISDN number is not the primary subscriber in a Multi-SIM group
ERR3337: Forbid deactivating the primary subscriber in a MultiSIM group
ERR3338: Forbid modifying MSISDN of the primary subscriber used for Multi-SIM
ERR3269: :A group member associated with multiple profiles cannot be deleted independently
ERR3270: The group does not exist
ERR3271: The number of group members exceeds the maximum
ERR3272: The group member number cannot be a special number
ERR3273: The group member must be defined
ERR3274: A number can belong to only one group
ERR3275: The entered number is not a group pilot number
ERR3276: The entered number is already in use
ERR3277: Sending Cancelocation fails during active number change. You must manually send Cancelocation
ERR3353: Forbid modifying the order of the primary subscriber in a Multi-SIM group
ERR3354: Forbid removing an auxiliary subscriber in a MultiSIM group
Modified the command LST DYNSUB: Added the MTRFSupported parameter to the above command in return reports.
2012-12-26
HSS9860 V900R008C01
Modified the commands MOD GROUPSIM, LST GROUPIM, MOD GROUPUSER, and LST SUB: Added the commands MOD NTCSI and LST NTCSI. Added the following error codes:
2013-01-09
HSS9860 V900R008C01
ERR3355:The MMS activation isdn must be a member isdn
ERR3356:The LCS activation isdn must be a member isdn
ERR3357:Updating a group MSISDN's data succeeds but updating a GROUPSIM member's data fails
Modified the commands ADD SUB, LST SUB,MOD EIN and LST EIN. Added the commands MOD PREMSMS and LST PREMSMS.
2013-01-25
HSS9860 V900R008C01
Modified the command LST DYNSUB: Added the URRP-MME and URRP-SGSN parameters to the above commands in return reports
2013-02-06
HSS9860 V900R008C01
Modified the ADD KI and LST KI commands. Modified the DEFAULCALL parameter of the above commands.
2013-04-01
HSS9860
Modified the commands ADD SUB, LST SUB, LST DYNSUB,
All rights reserved.
Page 3 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Date
Change HistoryChange History
Revised Version
Changes and Modifications
V900R008C01SPC100
and LST OPTGPRS. Added the commands MOD ZCLOCK, LST ZCLOCK, LST DYNZC, and RESET BINDEDTAI.
2013-06-09
HSS9860 V900R008C20
Modified the commands ADD KI, ADD CKI, MOD CARDPARA, and MOD CR.
2013-09-10
HSS9860 V900R008C20SPC101T
Added the commands MOD ALSSUPP and MOD ALSODB.
2013-11-04
HSS9860 V900R008C20SPC500B 020
Modified the command MOD BARPWD.
2013-12-04
HSS9860 V900R008C30 SPC010T
Modified the commands ADD SUB, LST SUB, MOD EIN, and LST EIN. Added the EOICK parameter to commands MOD EIN and LST EIN. Added the commands MOD CAPL and LST CAPL.
2013-12-04
HSS9860 V900R008C30 SPC010T
Modified the commands ADD KI, ADD CKI, MOD CARDPARA, and MOD IMSI.
2014-02-13
HSS9860 V900R008C30SPC030T
Modified the command ADD SUB: Added the MPS, ANCHOR, and TAUTIMER parameters to the above commands. Modified the command CHK KI: Added the KIVALUE parameters to the above command. Modified the command MOD EPS: Added the MPS and TAUTIMER parameters and modified the LTEAUTOPROV parameter in the above command. Modified the command SET MULTISDN: Added the PROV parameter to the above command. Modified the command LST EPS: Added the MPS and TAUTIMER parameters and modified the LTEAUTOPROV parameter in return reports. Modified the command LST SUB: Added the ACTIVE IMSI, MPS, ICSIND, ANCHOR, and TAUTIMER parameters. Modified the LTEAUTOPROV parameter in return reports to the above command. Modified the command LST DYNSUB: Added the ACTIVE IMSI parameter in return reports to the above command. Added the MOD EMMIN, LST EMMIN, MOD IMSIISDN, and LST IMSIISDN commands.
2014-03-13
HSS9860 V900R008C30SPC110T
Modified the command GET TERMSTATE.
All rights reserved.
Page 4 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Change HistoryChange History
Date
Revised Version
Changes and Modifications
2014-05-30
HSS9860 V900R008C50
Modified the commands MOD EPS, LST EPS, LST SUB, ADD SUB, and ADD CSPSSUB. Added the commands MOD VOLTETAG and LST VOLTETAG.
2014-07-15
HSS9860 V900R008C51
Modified the commands MOD GPRS, LST GPRS, and LST SUB. Added the commands MOD PSAPNOI and LST PSAPNOI.
2014-08-07
HSS9860 V900R008C51
Modified the commands MOD VSRR, ADD SUB, ADD KI, MOD CARDPARA, MOD GPRS, MOD OPTGPRS, MOD CSISTATE, and ADD CKI. Modified TSCODE and DSCODE enumerations.
2014-08-12
HSS9860 V900R008C51
Modified the command GET TERMSTATE.
2014-08-23
HSS9860
Modified the command MOD LCK.
V900R008C51 2014-09-28
HSS9860 V900R008C51
Modified the commands LST SUB and LST DYNSUB: Added the UNKNOWN enumeration value in the IMS-VO-PSSessions-Supported parameter of the above commands in the return reports
2014-10-23
HSS9860 V900R008C50
Added PGW MML Command Protocol of IMS and its Error Codes. Added the error code: ERR4052:Home HLRSN must be specified
2014-11-06
HSS9860 V900R008C50
Modified the format of ADD SUB command and the range of AMFSNO parameter in ADD CKI command. Added the PROPERTY parameter to the ADD CKI command, and added the Category enumeration to the MOD CATEGORY command
2014-11-07
HSS9860
Modified the command SET HREPDATA.
V900R008C50 2014-11-07
HSS9860 V900R008C50
Added description of query result, and modified IMS description of query result. Added abbreviations of IMPI, IMPU, PISI, PUSI, and AS. Deleted repeated abbreviations of MML, HLR, and OMC.
2014-11-12
HSS9860
Modified the parameter description of LST HREPDATA.
V900R008C50 2014-11-17
HSS9860 V900R008C50
Modified commands MOD STNSR, LST STNSR, MOD VOLTETAG, and LST VOLTETAG. Modified the description of the above commands.
2014-11-17
HSS9860 V900R008C50
Added the SYSNO parameter to the commands ADD HPSI, LST HPSI, and ADD HTPLPSI.
All rights reserved.
Page 5 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Change HistoryChange History
Date
Revised Version
Changes and Modifications
2014-11-17
HSS9860
Modified the range and description of parameter REALM in IMS commands which contain the parameter.
V900R008C50 2014-11-18
HSS9860 V900R008C50
2014-11-24 2014-11-25
HSS9860
Modified the range of parameter AMFSNO in commands ADD KI, MOD CARDPARA, and ADD CKI.
V900R008C50
Put the last part of chapter 9 and the first part of chapter 10 into different pages
HSS9860
Modified 3 "the stipulation of matching error messages."
V900R008C50
Modified 7 "the error code rules” and "the stipulation of matching error messages." Modified 7 "TCP Port 7776" and "TCP Port 7777." Modified 11 "Summary of Error Codes."
2014-12-10
HSS9860 V900R009C00
Modified the range of parameter RATFREQSELPRIID in the following commands: MOD RFPRID, MOD EPS, and MOD EPSSER.
2014-12-15
2014-12-23
2015-01-14
HSS9860
Modified the command LST DYNSUB:
V900R009C00
Added "Group: AS Subscription to notifications Data" in return reports.
HSS9860
Modified the command LST HASSUBDATA:
V900R009C00
Added the enum value UE-SRVCC- Capability (8) for parameter DataType in return reports.
HSS9860
Modified the commands ADD SUB, ADD CSPSSUB, ADD TPLSUB, ADD TPLCSPSSUB. Added the parameter M2MCISDN to the above commands.
V900R009C00
Modified the command LST SUB. Added two parameters USERATTRIBUTE and M2MCISDN to the above commands in return reports. 2015-01-14
HSS9860 V900R009C00
Modified the commands ADD SUB and MOD NONSUB. Added the parameter VOWIFI_TAG to the above commands. Modified the commands LST SUB and LST NONSUB. Added the parameter VOWIFI_TAG to the above commands in return reports.
2015-01-14
HSS9860
Added the MOD M2MCISDN and LST M2MCISDN commands.
V900R009C00
Added the following error codes:
ERR4053:An M2M Common MSISDN cannot be set for a nonM2M subscriber
ERR4054:Service Conflict. The subscriber has subscribed to the MSISDN-Less service
ERR4055:Service Conflict. The subscriber has subscribed to the M2M Common MSISDN service
ERR4056:Service Conflict. The subscriber has subscribed to the
All rights reserved.
Page 6 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Date
Revised Version
Change HistoryChange History
Changes and Modifications Multi-IMSI service.
2015-01-22
ERR4057:Service Conflict. The subscriber has subscribed to the Multi-SIM service.
ERR4058:Service Conflict. The subscriber has subscribed to the COMISDN service.
ERR4059:Service Conflict. The subscriber has subscribed to the GROUPSIM service.
ERR4060:Service Conflict. The subscriber has subscribed to the multi-MSISDN multi-profile service.
ERR4061:Service Conflict. The subscriber has subscribed to the ALS service.
ERR4062:Service Conflict. The subscriber has subscribed to the FM service.
ERR4063:Service Conflict. The IMSI and MSISDN are the same
HSS9860
Modified the LST SUB and LST DYNSUB commands.
V900R009C00
Added parameters CS-MSISDN-LESS and PS-MSISDN-LESS to the above commands in return reports. Modified the GET TERMSTATE command. Added the parameter CISDN to the above command in return reports.
2015-02-02
2015-02-09
HSS9860
Added the following error code:
V900R009C00
ERR4065: Forwarded-to number and Property of FTN cannot be specified for the current forwarding mode
HSS9860
Modified the command SET MULTISDN:
V900R009C00
Added the parameter SER_TYPE to the above command. Added the error code: ERR4066:Service types for the same main MSISDN are different
2015-02-11
HSS9860 V900R009C00
Modified the command LST SUB: Added parameters EPSLOCK, NON3GPPLOCK, CSUPLLCK and PSUPLLCK to the above commands in return reports.
2015-02-12
HSS9860 V900R009C00
Modified the command LST HASSUBDATA: Added the parameter IMPI to the above commands in return reports.
2015-02-25
HSS9860 V900R009C00
Modified the command MOD PLMNRSZI: Added the parameter TYPE to the above command. Modified the commands ADD SUB and MOD EPS: Added the parameter SWXPLMNTPLID to the above commands. Added the parameter SWXPLMNTPLID to LST PLMNRSZI, LST SUB, and LST EPS commands in return reports.
2015-02-25
HSS9860 V900R009C00
Added parameters CSRATTYPE and PSRATTYPE to LST SUB and LST DYNSUB commands in return reports.
All rights reserved.
Page 7 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Change HistoryChange History
Date
Revised Version
Changes and Modifications
2015-02-27
HSS9860 V900R009C00
Modified the command SET HREPDATA: Added enumeration CSSYNDATAProv to the parameter DATASOURCE.
2015-04-21
2015-04-22
2015-04-25
2015-04-25
HSS9860
Modified the command LST HASSUBDATA:
V900R009C00
Added the enum value ChargingInformation (9) for parameter DataType in return reports.
HSS9860
Modified the command LST DYNSUB:
V900R009C00
Added the parameter Server-Assignment-Time to the above command in return reports.
HSS9860
Modified the command MOD EPSAMBR:
V900R009C00
Added the parameter FORCETOBEEPSSUB to the above command.
HSS9860
Modified the command LST SUB:
V900R009C00
Added parametersCsUplStatus and PsUplStatus to the above commands in return reports. Modified the command LST DYNSUB: Added parameters CsUplStatus and PsUplStatus to the above commands in return reports. Modified the command MOD NRBT: Added parameters ARBTPROV and ARBT to the above command. Modified the command LST NRBT: Added parameters ARBT and ARBTIndex to the above commands in return reports.
2015-04-30
HSS9860
Modified the commands ADD SUB and MOD EPS:
V900R009C00
Added the parameter EPSODBPOS to the above command. Modified the command MOD EIN: Added parameters ETICKPROV and ETICK to the above command. Modified the command LST SUB: Added parameters EPSODBPOS and ETICK to the above commands in return reports. Modified the command LST EPS: Added the parameter EPSODBPOS to the above commands in return reports. Modified the command LST EIN: Added the parameter ETICK to the above commands in return reports. Added the MOD EPSODB and LST EPSODB commands.
2015-05-04
HSS9860
Modified the commands ADD SUB and ADD CSPSSUB:
V900R009C00
Added the parameter MAPADDRRESTPLID to the above
All rights reserved.
Page 8 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Date
Revised Version
Change HistoryChange History
Changes and Modifications command. Modified the command LST SUB: Added parameters MAPADDRRESTPLID and MAPADDRRESTPLNAME to the above commands in return reports. Added the MOD MAPADDRRES and LST MAPADDRRES commands.
2015-05-11
2015-05-15
2015-05-16
2015-05-27
HSS9860 V900R009C00
Modified the commands ADD SUB, ADD TPLUSCSUB, LST SUB, ADD SUBTPL, MOD SUBTPL, LST SUBTPL, MOD EPS, LST EPS, MOD ANCHOR, and LST ANCHOR: Modified the values of the parameter ANCHOR to enumeration values.
HSS9860
Modified the command LST SUB:
V900R009C00
Added the parameter Server-Assignment-Time to the above commands in return reports.
HSS9860
Modified the commands LST SUB and LST DYNSUB.
V900R009C00
Added enumeration values to the parameters CSRATTYPE and PSRATTYPE to the above commands in return reports.
HSS9860 V900R009C00
Modified the command MOD COMISDN: Added the parameter ACTMT to the above command.
2015-06-11
HSS9860
Modified the command ADD SUB:
V900R009C00
Added the parameter ARBT to the above command. Modified the command LST SUB: Added the parameter ARBTIndex to the above command in return reports.
2015-06-011
HSS9860 V900R009C00
Modified the command MOD COMISDN: Added the parameter ACTMT to the above command.
2015-06-11
HSS9860 V900R009C00
Modified the command MOD OPTGPRS: Added parameters PROVAPNOI and APNOITPLID to the above command. Modified the commands LST OPTGPRS and LST SUB: Added the parameter APNOITPLID to the above commands in return reports
2015-06-18
HSS9860 V900R009C00
Modified the command LST ISDN: When the value of SER_TYPE is set to OCMN, the parameter: SER_TYPE is added to the above command in return reports.
2015-07-16
HSS9860 V900R009C00
Modified the command MOD NAEA: Added the parameter: NAEATYPE to the above command. Modified the command LST NAEA: Added the parameter NAEA_TYPE to the above command in return reports.
All rights reserved.
Page 9 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Change HistoryChange History
Date
Revised Version
Changes and Modifications
2015-07-16
HSS9860 V900R009C00
Modified the commands MOD ODBOC, MOD ODBIC, MOD ODBROAM, and LST ODBDAT.
2015-07-21
HSS9860 V900R009C00
Modified the command ADD CKI. Added the error code: ERR4074:If the MSISDN specified does not exist in the HSS, the HSS cannot distribute the subscriber to a service partition based on the license balancing policy in the one-logical deployment
2015-07-31
HSS9860 V900R009C00
Modified the command LST ODBDAT: Added parameters RECORDCOUNT, IMSIFILE, and ISDNFILE to the above command. Added parameters ODBENTEROAM and ODBINFOROAM to the above commands in return reports.
2015-09-14
HSS9860 V900R009C00
Modified the command ADD SUB: Added parameters STE_PROV, STE, GMLC_ADD to the above command. Modified the command LST SUB. Added parameters: STE, GMLC_ADD, SPN to the above command in return reports Added the MOD STE, LST STE, MOD SPN, and LST SPN commands.
2015-11-12
HSS9860 V900R010C00
Modified the command LST DYNSUB: Added the parameter EPSFEATURELISTDETAIL to the above command. Added MME-FeatureList2 and S4SGSN-FeatureList2 to the above command in return reports FeatureList report is added to LST DYNSUB. Added the commands ADD HASHOST, RMV HASHOST, and LST HASHOST. Added the following error codes: 900003493: The AS ID already exists 900003494: The host name already exists 900003495: The AS information does not exist 900003496: The number of AS records has reached the maximum limit
2015-11-20
HSS9860 V900R009C10
Modified the command ADD HHSSSUB: Added the enumeration AKA to the parameters IMPIAUTHTYPE and IMPI2AUTHTYPE. Added the following error codes: 900003497: Authentication information of IMPI2 does not exist 900003498: Other authentication schemes have been provided for the IMPI 900003499: Other authentication schemes have been provided for
All rights reserved.
Page 10 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Date
Revised Version
Change HistoryChange History
Changes and Modifications IMPI2 900003500: ADD HHSSSUB failed to add a convergent 2G/3G/4G subscriber to use AKA for authenticating IMPI 900003501: ADD HHSSSUB failed to add a convergent 2G/3G/4G subscriber to use AKA for authenticating IMPI2
2015-11-30
HSS9860 V900R009C10
Modified the command SND CANCELC: Added the parameter CLRCSDYNDATA to the above command.
2015-11-30
HSS9860 V900R009C10
Modified the commands MOD ODBOC, MOD ODBIC, and LST ODBDAT.
2015-12-02
HSS9860 V900R009C10
Extended the maximum value of PRIORITY and NEWPRI from 1024 to 65535 in the commands ADD HIFC, MOD HIFC, RMV HIFC, and LST HIFC.
2015-12-02
HSS9860 V900R009C10
Added the "GROUP: Resend Information" to the LST DYNSUB command output.
2015-12-03
HSS9860 V900R009C10
Modified the NOTE description of the command ADD HHSSSUB.
2015-12-08
HSS9860 V900R009C10
Added the following error codes: ERR900003477: The auxiliary subscriber must be a VoLTE or VoWiFi subscriber ERR900003478: IMPUs associated with the main card do not belong to any IRS ERR900003479: IMPUs associated with the main card do not belong to any alias set ERR900003480: IMPUs associated with the main card do not share any service profile ERR900003481: IMPUs associated with the main card do not belong to the same IRS ERR900003482: IMPUs associated with the main card do not belong to the same alias set ERR900003483: IMPUs associated with the main card do not share the same service profile ERR900003485: The authentication status of synchronized CS domain repository data cannot be changed ERR900003484: PECF and PCCF addresses cannot be simultaneously removed from a charging template ERR900003486: Either a PECF or PCCF address must exist in the charging template ERR900003487: The partition information about the subscriber cannot be obtained in IMS-HSS ERR900003488: The command output exceeds the maximum length allowed ERR900003489: The password length does not meet password strength requirements ERR900003490: The password cannot contain a user name
All rights reserved.
Page 11 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Date
Revised Version
Change HistoryChange History
Changes and Modifications ERR900003491: The password cannot contain an incremental sequence of 3 or more consecutive numbers or letters ERR900003492: The characters contained in the password do not meet password strength requirements ERR4064: Service Conflict. The subscriber has subscribed to the Home Zone service ERR4067: The default roaming restriction rule is RESTRICT. Run SET DEFHLRRR to modify the default roaming restriction rule to PERMISSION or run RMV HLRRR with CHKDFT set to FALSE ERR4068: Partition ID is invalid ERR3381: The total number of IMS subscribers defined in the HLR has reached the license threshold ERR3382: The number of IMS subscribers with the HLRSN has reached the license threshold ERR4071: Number of MAP Address Restriction subscribers exceeds the maximum
2015-12-15
HSS9860 V900R009C10
Modified the command LST SUB. Added the enum values AutoLteToVolte and AutoLteToVolte_NN for parameter LTEAUTOPROV to the above command in return reports. Modified the parameter name ANCHOR Indicator in the above command. Added the enum values SELECTIVE, TCSI, PRE_FALSE, and PRE_TRUE for parameter ANCHOR-Indicator to the above command in return reports. Modified the command MOD EPS. Modified the data type of STNSR in the above command, Added the enum values AutoLteToVolte and AutoLteToVolte_NN for parameter LTEAUTOPROV in the above command. Modified the command LST EPS. Added the enum values AutoLteToVolte and AutoLteToVolte_NN for parameter LTEAUTOPROV in reports in the above command. Modified the command ADD SUB. Added parameters ODBENTEROAM and ODBINFOROAM to the above command. Modified the command MOD ODB. Added parameters ODBENTEROAM and ODBINFOROAM to the above command. Modified the command MOD IMSI. Added the enum values CUSTOM_6 and CUSTOM_7 for parameter ALG in the above command. Modified the command ADD KI. Added the enum values CUSTOM_6 and CUSTOM_7 for parameter ALG in the above command. Modified the command MOD CARDPARA. Added the enum values CUSTOM_6 and CUSTOM_7 for
All rights reserved.
Page 12 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Date
Revised Version
Change HistoryChange History
Changes and Modifications parameter ALG in the above command. Modified the command ADD CKI. Added the enum value CUSTOM_7 for parameter ALG in the above command. Modified the command LST ODBDAT. Added the enum value BICCROSSDOMESTIC for parameter ODBIC in reports in the above command. Added the enum value BOCCROSSDOMESTIC for parameter ODBOC in reports in the above command.
2015-12-22
HSS9860 V900R009C10
Modified the commands ADD SUB, ADD CSPSSUB, MOD ARD, and MOD EPS. Modified the parameter Description.
2016-01-13
HSS9860 V900R009C10
Added the MOD NTUCSI and LST NTUCSI commands. Modified the NOTE of LST SUB.
2016-01-15
HSS9860 V900R009C10
Modified the commands RMV SUB, RMV CSPSSUB, RMV USCSUB, RMV HHSSSUB, and RMV HSUB. Added the parameter SUPCAN to the above commands.
2016-02-01
HSS9860 V900R009C10
Added the ETCSICONVER_TPLID parameter to the following commands: ADD SUB, ADD CSPSSUB, MOD EIN. Added the ETCSICONVER_PROV parameter to the command MOD EIN. Added the ETCSICONVER_TPLID parameter to the output of the commands LST SUB and LST EIN.
2016-02-24
HSS9860 V900R009C10
Modified the command MOD OPTGPRS Added parameters:APN in the above command.
2016-02-27
HSS9860 V900R009C10
Modified the command ADD HIFC Modified the note of ADD HIFC.
2016-03-04
HSS9860 V900R009C10
Modified the commands ADD SUB, MOD EPS, LST SUB, LST EPS Added one parameter: LTE_M2M_FLAG
2016-03-05
HSS9860 V900R009C10
Modified the commands ADD SUB, ADD CSPSSUB, MOD CFB, MOD CFD, MOD CFNRY.
2016-03-05
HSS9860 V900R009C10
Modified the commands ADD SUB, MOD ODBECT, MOD ODB, ADD CSPSSUB.
2016-04-10
HSS9860 V900R010C00
Added the parameter DND in the commands ADD SUB and ADD CSPSSUB. Added the parameter DND in the LST SUB command output. Added the commands MOD DND and LST DND.
2016-04-11
HSS9860 V900R010C00
Added the parameter VMCC in the commands ADD SUB, ADD
All rights reserved.
Page 13 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Date
Revised Version
Change HistoryChange History
Changes and Modifications CSPSSUB, and LST SUB. Added the commands MOD VMCC and LST VMCC.
2016-04-26
HSS9860 V900R010C00
Added the parameter INCLUDEREGRSP in the commands ADD HIFC, MOD HIFC, and LST HIFC.
2016-05-24
HSS9860 V900R010C00
Added the SET HCFFTNPOSTFIX and LST HCFFTNPOSTFIX commands.
2016-06-01
HSS9860 V900R010C00
Added the parameter REATTACHREQUIRED in the command SND CANCELC.
2016-06-14
HSS9860 V900R010C00
Added the LST HPURREPDATA, SET HPURREPDATA and SND HPNR commands. Added the following error codes: 900003514: A process is still running, please try later.
2016-08-06
HSS9860 V900R010C00
Modified the command LST SUB. Added the enum value Exception for parameter CsUplStatus in reports in the above command. Added the enum value Exception for parameter PsUplStatus in reports in the above command. Modified the command LST DYNSUB. Added the enum value Exception for parameter CsUplStatus in reports in the above command. Added the enum value Exception for parameter PsUplStatus in reports in the above command.
2016-08-09
HSS9860 V900R010C00
Modifier the ADD HNNRLI commands. Added the enum values IPRANGE for parameter RLT in the above command..
2016-09-08
HSS9860 V900R010C00
Modifier the MOD COMISDN commands. Extended the maximum value of ORDER from 9 to 100.
All rights reserved.
Page 14 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
OverviewOverview
2
Overview
2.1 System Description Huawei HLR (HSS9860) provides the provisioning system interface which allows the carrier to manage the subscriber data stored in the HLR using third-party software. The provisioning system interface commands supported by the HSS9860 are string command lines which consist of command name, parameter name, and parameter value. The following sections describe the commands in details. The PGW functions as the provisioning system interface. First, the PGW translates the string command lines sent from the provisioning system client, which is a third-party software, into commands that can be recognized by the HLR/HSS. Then the PGW executes the commands, gets the result, converts the result to a format that can be recognized by the provisioning system client, and finally sends it back to the provisioning system client. Figure 1.1 shows the relationship between the provisioning system client and the PGW. Figure 1.1 Relationship between the provisioning system client and the PGW
All rights reserved.
Page 15 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
OverviewOverview
2.2 Network Connection The provisioning system client connects to the PGW over TCP/IP. The provisioning system client and the PGW can be allocated in the same or different LANs according to the actual requirements. When they are allocated in different LANs, at least one gateway must be deployed to ensure a normal connection between them. The PGW provides a fixed IP address (the fixed IP address may vary according to different sites) for the provisioning system client, and opens the TCP port 7777. The provisioning system client must send connection requests to the PGW through the fixed IP address and TCP port. The number of the connections between the PGW and the provisioning system client is limited. A PGW supports at most 100 provisioning system clients. A board supports at most six PGWs. So a board supports at most 600 provisioning system clients.
Figure 1.2 shows the connection between the provisioning system clients (client A and client B) and the PGW. Client A and the PGW are in the same network. Client B and the PGW are in different networks with a gateway connecting them. The provisioning system clients communicate with the PGW over TCP/IP. In addition, there are three Web UIs in Figure 1.2. The Web UI provides a graphical manmachine interface for the communication between the operators and the HSS9860. Based on the Windows operating system, it manages and maintains the HLR system using the Internet Explorer. Certain commands, such as adding a provisioning system user and setting a subscription template, must be configured on the Web UI. Figure 1.2 Network connection of the provisioning system
2.3 Terms Provisioning System Interface
All rights reserved.
Page 16 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
OverviewOverview
The provisioning system interface is string command lines which are supported by Huawei HSS9860. These command lines can implement functions such as defining or removing a subscriber, and querying or modifying subscription data. Provisioning System Client The provisioning system client is the BOSS provided by the third-party software suppliers. The provisioning system client must send connection requests to the PGW and maintain connection with the PGW using handshake messages. It manages the subscriber data stored in the HLR through the provisioning system interface. Web UI The Web UI provides a graphical man-machine interface for the communication between the operators and the HSS9860. Based on the Windows operating system, it manages and maintains the HLR system using the Internet Explorer. Certain commands, such as adding a provisioning system user and setting a subscription template, must be configured on the Web UI. PGW The PGW is connected to the provisioning system client and the Web UI. It processes the commands sent from the provisioning system client and the Web UI and returns the result to them.
All rights reserved.
Page 17 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
StipulationStipulation
3
Stipulation
The stipulation of matching error messages: When the provisioning system matches error messages, only the prefix ERR is matched, while the specific error code and the description of error code are not matched. This avoids BOSS modifying commands or upgrading itself while the HLR/HSS adds or modifies error codes. If an error message does not contain the prefix ERR, the provisioning system searches for the RETCODE. Error codes contain four digits or nine digits. The nine-digit error codes begin with the number nine. The stipulation in the table describes the meaning of the symbols. Symbols
Description
Example
\n
An escape character indicating a symbol of return
\t
An escape character indicating a tab
""
A string, and escape characters can be included in the string
""String\t"" indicates "String ", and """" indicates a null string
|
Indicates "or", and the contents on the left and the right are alternative
""A"|"B"" indicates "A" or "B"
+
Indicates "and", and joins the contents on the left and the right together
""A"+"B"" indicates "A and B"
-
Indicates a range from A to B
"1-15" indicates integer numbers from 1 to 15; "A-Z" indicates letters from A to Z
...
Indicates omission
""English"|...|"Chinese"" indicates a series of strings, the ones in the middle are omitted and are followed by descriptions
{}
Brace, indicates the contents in the brace is a parameter
For example, {IMSI} indicates the parameter IMSI
Angular bracket, indicates a parameter value
indicates "IMSI number" is an IMSI number, indicates "date" is a date value
All rights reserved.
Page 18 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
StipulationStipulation
The following symbols are used to describe the command parameters:
C: means conditional. The parameter of the default value is to be given at least.
M: means mandatory. The parameter must be set.
O: means optional. The parameter may or may not be set.
All rights reserved.
Page 19 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Time SettingTime Setting
4
Time Setting
4.1 Handshake Message Time If the provisioning system client requests to connect to the PGW, it needs to send the SHK HND command to the PGW every 20 seconds to ensure that the connection is normal. If the PGW does not receive the handshake message from the client within 200 seconds, the PGW will disconnect from the client, and will not respond to the handshake messages from the client. Similarly, the PGW needs to send the SHK HND command to the provisioning system client every 20 seconds to ensure that the connection is normal. If the provisioning system client does not receive any messages (including MML command reply messages and handshake messages) within 200 seconds from the PGW, the client will disconnect from the PGW automatically. The PGW can choose not to send the SHK HND command to the provisioning system client. Whether to send the SHK HND command to the provisioning system client depends on the configuration of the PGW.
4.2 Command Reply Time When the PGW receives a command request from the provisioning system client, it will return a response message to the provisioning system client within 60 seconds irrespective of whether the command is executed successfully. If the provisioning system client does not receive the response from the PGW within 60 seconds, it regards that the command failed to execute and ignores the response even if it receives the response later. The provisioning system client can set the timeout interval according to the actual situations.
All rights reserved.
Page 20 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Communication ProtocolCommunication Protocol
5
Communication Protocol
Once the provisioning system client connects to the PGW, the client can manage the subscriber data in the HLR/HSS using the provisioning system interface commands. The provisioning system client interface commands are command lines which are transmitted in command strings. The format of the command string is as follows: Command Name: parameter 1=parameter value 1, parameter 2=parameter value 2;
All rights reserved.
Page 21 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Command SyntaxCommand Syntax
6
Command Syntax
The command syntax of the HLR provisioning system interface is as follows: Command Name: parameter 1=parameter value 1, parameter 2=parameter value 2,…;
See 9Summary of Commands for details on commands.
For different commands, the parameter names, number of parameters, and the parameter types are different.
The command name and the parameter are separated by a colon ":".
The parameters are separated by commas ",."
The parameter name and parameter value are separated by an equal sign "=".
The command line ends with a semicolon ";".
The command name and the parameter name must be capitalized.
The command line must starts with the command name.
Parameters are arrayed in the sequence defined by the command.
There are six types of parameters, including numeral, Boolean, string, enumeration, date and time. The values of different types of parameters are in different forms:
String The value of the parameter is a string consisting of the following characters:
−
Uppercase letters from A to Z.
−
Lowercase letters from a to z.
−
Digits from 0 to 9.
−
Other characters that the Windows operating system supports (key characters in the MML commands such as ":", ",", "=", and ";" are not included.)
Numeral The value of the parameter is an Arabic number consisting of the digits from 0 to 9.
Boolean The value of the parameter is TRUE or FALSE.
Enumeration
All rights reserved.
Page 22 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Command SyntaxCommand Syntax
The values of the parameter are enumerated names or values. (The enumerated name and enumerated value is interchangeable in the command line. For example: enumerated name TRUE and FALSE can be interchanged with 1 and 0.)
Date The value of the parameter is in the YYYY-MM-DD (or YYYY&MM&DD) format. Put a zero in front of the month and the day if the month and the day are one-digit numbers.
Time The value of the parameter is in the HH:MM:SS or HH:MM (or HH&MM&SS or HH&MM) format. Put a zero in front of the hour, the minute and the second if they are one-digit numbers. The format of the date and time is YYYY-MM-DD HH:MM:SS or YYYY&MM&DD&HH&MM&SS. The format of the date with time must be YYYY-MM-DD HH:MM:SS (or YYYY&MM&DD&HH&MM&SS).
All rights reserved.
Page 23 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Command OutputCommand Output
7
Command Output
The PGW will return an output of the command to the provisioning system after processing each command, no matter whether the execution succeeds or fails. The output is classified into three types of messages: success message, error message, and querying result. The error code rules are as follows:
Success message: The error codes must be SUCCESS0001, SUCCESS0002, SUCCESS0003, SUCCESS0004, SUCCESS0005, SUCCESS0006, SUCCESS0007, SUCCESS0008, SUCCESS0009, SUCCESS0010, or SUCCESS0011.
Error message: When the provisioning system matches error messages, only the prefix ERR is matched, while the specific error code and the description of error code are not matched. This avoids BOSS modifying commands or upgrading itself while the HLR/HSS adds or modifies error codes. If an error message does not contain the prefix ERR, the provisioning system searches for the RETCODE. Error codes contain four digits or nine digits. The nine-digit error codes begin with the number nine.
7.1 General Message Format (TCP Port 7777) The format of general messages is defined as follows: +++ HLR9820 SMU # %%%% :
---
END
Example: +++ HLR9820 2003-11-21 08:54:14 SMU #000324 %%LGI:OPNAME="admin", PWD="*****";%% SUCCESS0001:Operation is successful There is together 1 report
All rights reserved.
Page 24 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
---
Command OutputCommand Output
END
The message is described as follows:
The message header is HLR9820. The format of data and time is YYYY-MM-DD HH:MM:SS. There is a space between them.
The NE name is permanently set to SMU. serial number is generated automatically by the PGW.
command string is the command that the provisioning system client sends to the PGW Server.
message code begins with "SUCCESS" or "ERR", followed by a four-digit or nine-digit code. The success codes for the success messages are SUCCESS0001 to SUCCESS00011. Error codes are in the ERRnnnn or ERRnnnnnnnnn format. In the format, nnnn and nnnnnnnn are message codes.
message description is a string used to simply describe the processing result.
message code and the message description are separated by a colon ":".
message details are the detail information of executed or queried result.
END indicates the end of a message.
7.2 General Message Format (TCP Port 7776) The format of general messages is defined as follows: +++ USCDB PGW # %%%% RETCODE= :
--END or +++ USCDB PGW # %%%% RETCODE=
---
END
Example: +++ USCDB 2011-01-28 17:02:52 PGW #002492 %%SET MAPSERV: CFNRTIME=30, MAXTIMECALLFWD=5;%% RETCODE=0 SUCCESS0001:Operation is successful There is together 1 report --or
END
All rights reserved.
Page 25 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Command OutputCommand Output
+++ USCDB 2014-01-20 16:17:45 PGW #011601 %%CHK BATSTAT:;%% RETCODE=1038 The record does not exist There is together 1 report --END or +++ USCDB 2014-11-25 10:45:04 PGW #000503 %%CHK HKI: IMPI="impiinfo", K="*****";%% RETCODE=900001007 The value is invalid. for There is together 1 report ---
END
The message is described as follows:
The message header is USCDB. The format of and is YYYY-MM-DD HH:MM:SS. There is a space between them.
The NE name is permanently set to PGW. is generated automatically by the PGW.
is the command that the provisioning system client sends to the PGW Server.
indicates the code of a command execution result. There is a space between the error code and the message code.
begins with "SUCCESS" or "ERR", followed by a 4-digit or 9-digit code. The success codes for the success messages are SUCCESS0001 to SUCCESS00011. Error codes are in the ERRnnnn or ERRnnnnnnnnn format. In the format, nnnn and nnnnnnnn are message codes.
is a string used to simply describe the processing result.
and the are separated by a colon ":."
are the detail information of executed or queried result.
indicates the end of a message.
7.3 Difference Between Messages over Port 7776 and Port 7777 Item
Difference
Port 7776
Port 7777
1
Message header
USCDB
HLR9820
2
NE name
PGW
SMU
3
Whether the message contains an error code
Yes
No
4
The maximum number of characters contained in each line of the message details
8192
10240
All rights reserved.
Page 26 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Command OutputCommand Output
Item
Difference
Port 7776
Port 7777
5
The number of spaces before "END"
4
3
7.4 Operation Success Message Now there are only eleven kinds of success messages/codes, which are shown as follows:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
SUCCESS0003:Operation is successful. It is suggested to send HLR reset message to all VLR/SGSN
SUCCESS0004: HLR data updated but VLR/SGSN data update failure. Indication: operator should send cancellocation
SUCCESS0005: Data to be verified is the same as that in the HLR database
SUCCESS0006: Updating data in HLR succeeded while sending 'HLR REGCANC' message to the VLR failed. Indication: You should send the REGCANC message
SUCCESS0007: It is recommended to send the 'HLR UNRELDIR' message to the VLR at night when the traffic is low
SUCCESS0008: Please modify the initial password
SUCCESS0009: Please delete multi-IMSI subscriber data
SUCCESS0010: Retrieving log, please wait More report continuing
SUCCESS0011: Only some records are displayed. To obtain all the records, save the query result to a file
7.5 Operation Failure Message There are many reasons for operation failure. They are classified as follows according to the value. For details about the meanings, see 11Summary of Error Codes.
Ineffective command: ERR1001-ERR1999, ERR900001001-ERR900001999
Command-executing error: ERR3001-ERR4999, ERR900003001-ERR900003999
Internal error of the system: ERR5001-ERR5999, ERR900005001
The stipulation of matching error messages:
When the provision system matches error messages, only the prefix ERR is matched, while the specific error code and the description of error code are not matched. This avoids BOSS modifying commands or upgrading itself while the HLR/HSS adds or modifies error codes.
If an error message does not contain the prefix ERR, the provisioning system searches for the RETCODE. Error codes contain four digits or nine digits. The nine-digit error codes begin with the number nine.Description of Query Result
Command outputs are displayed in vertical format by default. 2.
Vertical format (Each pair of parameter name and parameter value occupies a line.)
All rights reserved.
Page 27 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Command OutputCommand Output
As for the query command, the output format is as follows: {parameter 1}= {parameter 2}= ... For example, the output for the command LST IMSI: ISDN="111111" is as follows: +++ HLR9820 2004-01-12 15:28:46 SMU #000055 %%LST IMSI: ISDN="111111";%% SUCCESS0001:Operation is successful IMSI =111111 MSISDN=111111 Total count=2 There is together 1 report --END
3.
Horizontal format (Each pair of parameter name and parameter value occupies two lines.) As for the query command, the output format is as follows: parameter 1 result 1
parameter 2 ... result 2
...
For example, the output for the command LST HSUBINFO: SUBID="6290000001"is as follows: +++ USCDB 2014-11-07 18:22:36 PGW #014973 %%LST HSUBINFO: SUBID="6290000001";%% RETCODE=0 SUCCESS0001:Operation is successful SUBID 6290000001
SUBINFO
Total count=1 There is together 1 report ---
END
Some LST command outputs described in 9Summary of Commands are displayed in horizontal format. Because all the parameters cannot be displayed in one line (the actual format), the parameters are displayed in several lines. You can read the output from the left to the right, from the top to the bottom, and from the first line to the last line.
4.
Mixed format (Mixed format output) 1) Mixed format 1 (The output is displayed first in vertical format and then in horizontal format.) As for the query command, the format of the output is as follows: {parameter 1}=< result 1>
All rights reserved.
Page 28 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Command OutputCommand Output
parameter 2 parameter 3 result 2
result 3
...
...
For example, the output for the command LST HMSIM: SUBID="subinfo"is as follows: +++ USCDB 2014-11-07 18:22:36 PGW #014973 %%LST HMSIM: SUBID="subinfo";%% RETCODE=0 SUCCESS0001:Operation is successful SUBID=subinfo IMSI 1234567891 1234567892 1234567893 1234567894 1234567895
MASTERFLAG 1 0 0 0 0
Total count=6 There is together 1 report ---
END
2) Mixed format 2 (The output is displayed first in horizontal format and then in vertical format.) As for the query command, the format of the output is as follows: parameter 1
result 1
parameter 2
parameter 3 ...
result 2
result 3
...
For example, the output for the command LST HSTDPRIOR: IMPU="sip:[email protected]" is as follows: +++ USCDB 2014-11-07 18:19:42 PGW #014949 %%LST HSTDPRIOR: IMPU="sip:[email protected]";%% RETCODE=0 SUCCESS0001:Operation is successful STDPRIOR 2 NAMESPACE 0
EXTPRIOR 2
CNAMESP
Total count=2 There is together 1 report
All rights reserved.
Page 29 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Key ParametersKey Parameters
8
Key Parameters
According to the preceding description, pay attention to the following information when setting up the communication between the provisioning system and the PGW:
The PGW opens the TCP port (For a specific port number, run the LST PORT command with Service type of port set to GU-HLR on the USCDB MML Command Interface of the OMU client).
The IP addresses of the PGW may vary with the sites.
The provisioning system client must send the connection request to the PGW. If the connection between the provisioning system client and the PGW is interrupted for some reasons, the provisioning system client must send the connection request again to the PGW.
The provisioning system client must send handshake messages to the PGW within the maximum handshake duration of the PGW on a regular basis. The time interval between the handshake messages can be set to 20 seconds.
The provisioning system client regards that the command fails if the client does not receive the response from the PGW within 60 seconds.
The number of connections established between the PGW and the provisioning system client is limited. A PGW supports at most 100 provisioning system clients. A board supports at most six PGWs. So a board supports at most 600 provisioning system clients.
The PGW processes the requests in serial mode. The PGW will process a command sent from the provisioning system only after the PGW finishes processing the previous command.
Service provisioning requests to be delivered at the same time for a subscriber must be sent through the same TCP connection. A TCP connection connects the provisioning system and the PGW, or connects the PGW Web LMT and the PGW.
All rights reserved.
Page 30 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9
Summary of Commands
9.1 Operator Login Command Name: LGI Function: This command is used by the operator to log in to the system. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
1-255
HLR serial number
C
OPNAME
Character string
1-12
Operator's name
M
PWD
Character string
6-10
Password
M
Example: LGI: HLRSN=2, OPNAME="NKR", PWD="*****"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 31 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The password cannot be null, and its value is a string of 6 to 10 characters. The values of parameters OPNAME and PWD cannot contain the following characters: colon (:), semicolon (;), double quotation mark ("), percent sign (%), single quotation mark ('), square brackets ([]), equal mark (=), and comma (,). The operator name and the password must be set through the PGW.
The LGI command is the first command to run after a provisioning system connects to the PGW.
The parameters OPNAME and PWD must be set through the Web UI in the first place. The user name and password are used for the provisioning system client to connect to the HSS9860.
Various data access rights can be set for operators through the Web UI.
The parameter HLRSN is not specified or is set to the default value 255 if the PGW is a standalone version. The parameter HLRSN must be specified if the PGW is a redundancy version. In this case, this parameter does not have a default value.
9.2 Operator Logout Command Name: LGO Function: This command is used by the operator to log out of the system. Parameter Description: N/A Example: LGO:; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For the meaning of error codes, see 11"Summary of Error Codes."
9.3 Add a Subscriber Using the Template Command Name: ADD TPLSUB Function: This command is used to add a subscriber using a specified template. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
1-255
HLR serial number
M
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
TPLID
Numeral
0-65534
Template number
O
TPLTYPE
Enumerated
NORMAL
O
EPS_SEPARA TE
Identifies the template(s) to be used to provide services for the subscriber to be defined.
All rights reserved.
Page 32 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
NORMAL: The HSS9860 uses one template to provide CS, PS, or EPS services for the subscriber.
EPS_SEPARATE: The HSS9860 uses one template to provide CS or PS services and another template to provide EPS services for the subscriber.
CSPSTPLID
Numeral
0-65534
Identifies the CSPS template used to provide CS or PS services for a subscriber.
O
EPSUSERTPLID
Numeral
0-65534
Identifies the EPS subscriber template used to provide EPS services for a subscriber.
O
LINE2NUM
Character string
1-15
Specifies the MSISDN used on the alternative line during a subscriber's alternative line service (ALS).
O
STNSR
Character string
3-15
Specifies a session transfer number for single radio voice call continuity (SRVCC).
O
M2MCISDN
Character string
1-15
Specifies the common MSISDN of an M2M common MSISDN subscriber.
O
Example: ADD TPLSUB: HLRSN=2, IMSI="345612789012345", ISDN="013623456789", TPLID=4, LINE2NUM="555555555555555"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For the meaning of error codes, see 11"Summary of Error Codes."
The parameter HLRSN is not specified or is set to the default value 255 if the PGW is a standalone version. The parameter HLRSN must be specified if the PGW is a redundancy version. In this case, this parameter does not have a default value.
9.4 Delete a Subscriber Command Name: RMV SUB Function: This command is used to delete a subscriber.
All rights reserved.
Page 33 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
RMVKI
Boolean
TRUE
C
FALSE
Specifies whether the HSS/HLR deletes the subscriber's individual subscriber authentication key (KI) together with the subscriber.
TRUE: The HSS/HLR deletes the KI together with the subscriber.
FALSE: The HSS/HLR does not delete the KI together with the subscriber.
Example: RMV SUB: ISDN="13623456789", RMVKI=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
9.5 Query the Static Subscriber Data Command Name: LST SUB Function: This command is used to query the static data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
DETAIL
Boolean
TRUE
O
FALSE
Specifies whether the HSS/HLR displays only the services that are provided for the subscriber.
TRUE: The HSS/HLR displays the services that are provided and not provided for the subscriber.
All rights reserved.
Page 34 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
FALSE: The HSS/HLR only displays services that are provided for the subscriber.
Example: LST SUB: IMSI="955678112", DETAIL=TRUE; Output: If the operation succeeds, the system displays an output with the following format: {HLRSN}= {IMSI}= {ISDN}= {ISDN}= {IMEI}= "Session Transfer Number for SRVCC" {STNSR}= "LU CSI template" LUCSI_TPL_ID= {ICS-Indicator}= {ANCHOR-Indicator}= {CALL_INDEX}= {IMSI2}= {CALL_INDEX}= {IMSI3}= {CALL_INDEX}= {IMSI4}= {CALL_INDEX}= {IMSI5}= {CALL_INDEX}= {IMSI6}= {CALL_INDEX}= {IMSI7}= {CALL_INDEX}=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9>
All rights reserved.
Page 35 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{IMSI8}= {CALL_INDEX}=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {IMSI9}= {CALL_INDEX}=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {ACTIVE IMSI}= {MIMSI_SMS}=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {MIMSI_VOBB}=< 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {MIMSITYPE}=< MultiIMSI | SimultaneouslyRing | OrderlyRing | OneLive> {CardType}= {NAM}= {CATEGORY}= {SUB_AGE}= {USERCATEGORY}= {ZCLOCKPROV}= {ICI}= "LOCK" {IC}= {OC}= {GPRSLOCK}= {EPSLOCK}= {NON3GPPLOCK}= {CSUPLLCK}= {PSUPLLCK}= "SABLOCK" {IC}= {OC}= "Basic Service" {TS}= {BS}= {DefaultCall}= "ODB Data" {ODBSS}=
All rights reserved.
Page 36 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{ODBOC}= {ODBIC}= {ODBPB1}= {ODBPB2}= {ODBPB3}= {ODBPB4}= {ODBENTE}= {ODBINFO}= {ODBROAM}= {ODBRCF}=; {ODBECT}= {ODBDECT}= {ODBMECT}= {ODBPOS}= {ODBPOSTYPE}= {ODBENTEROAM}= {ODBINFOROAM}= "SS Data" {CFU}= {CFB}= {CFNRY}= {CFNRC}= {CFD}= {SPN}= (if present) {BAOC}= {BOIC}= {BOICExHc}= {BORO}= {BAIC}= {BICROAM}= {CBCOU}= {CLIP}=
All rights reserved.
Page 37 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{CLIR}= {COLP}= {COLR}= {ECT}= {CW}= {HOLD}= {MPTY}= {MC}= {NBRSB}= {NBRUSER}= {AOCI}= {AOCC}= {CUG}= {UUS1}= {UUS2}= {UUS3}= {SMSCF}= {SMSCF_OFATPL}= {SMSCFFTN}= {plmn-specificSS-1}= {plmn-specificSS-2}= {plmn-specificSS-3}= {plmn-specificSS-4}= {plmn-specificSS-5}= {plmn-specificSS-6}= {plmn-specificSS-7}= {plmn-specificSS-8}= {plmn-specificSS-9}= {plmn-specificSS-A}= {plmn-specificSS-B}= {plmn-specificSS-C}= {plmn-specificSS-D}= {plmn-specificSS-E}=
All rights reserved.
Page 38 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{plmn-specificSS-F}= {allplmn-specificSS }= {CNAP}= {CCBS}= {CCBSTARGET}= {DEFAULTOFA_ID}= {ODBPREMSMS}= {ODBADULTSMS}= "O-CSI" TPLID= TPLNAME= STATE= "T-CSI" TPLID= TPLNAME= STATE= "VT-CSI" TPLID= TPLNAME= STATE= "MO-SMS-CSI" TPLID= TPLNAME= STATE= "MT-SMS-CSI" TPLID= TPLNAME= STATE= "D-CSI" TPLID= TPLNAME= STATE= "SS-CSI"
All rights reserved.
Page 39 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
TPLID= TPLNAME= STATE= "M-CSI" TPLID= TPLNAME= STATE= "GPRS-CSI" TPLID= TPLNAME= STATE= "U-CSI" TPLID= TPLNAME= "TIF-CSI" TIFCSI=PROVISIONED (if present) STATE= "LCS-CSI" TPLID= TPLNAME= "IM-O-CSI" TPLID= TPLNAME= " IM-VT-CSI" TPLID= TPLNAME= "VLR/SGSN roaming restrict" VLRLIST= TPLNAME= SGSNLIST= TPLNAME= "Binding OptGprsTpl" OPTGPRSTPL=
All rights reserved.
Page 40 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
"GPRS Data" {CHARGE_GLOBAL}= {SCHARGE_GLOBAL}= {PSAPNOITPLID}= {CNTXID}= {PDPTYPE}= {PDPADD}= {ADDIND}= {RELCLS}= {DELAYCLS}= {PRECLS}= {PEAKTHR}=< GPRS_PEAK_THROUGHPUT enumeration> {MEANTHR}=< GPRS_MEAN_THROUGHPUT enumeration> {ARPRIORITY}= {ERRSDU}= {DELIVERY}= {TRAFFICCLS}= {MAXSDUSIZE}= {MAXBRUPL}= {MAXBRDWL}= {RESBER}= {SDUERR}= {TRANSFERDEL}= {TRAFFICPRI}= {MAXGBRUPL}= {MAXGBRDWL}= {MAXEXTBRDWL}= {MAXEXTGBRDWL}= {MAXEXTBRUPL}= {MAXEXTGBRUPL}= {APN}= {VPLMN}= {CHARGE}=
All rights reserved.
Page 41 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{STDCHARGE}= {APNTPLID}= {QOSTPLID}= {PRIORITY_LEVEL}= {APNOITPLID}= {CNXTID}= ........... "EPS Data" {CHARGE_GLOBAL}= {SCHARGE_GLOBAL}= {APNOI}={UE level APN Operator Identifier Replacement} {AMBRMAXUL}={UE level Max Requested Bandwidth of Upload} { AMBRMAXDL}={UE level Max Requested Bandwidth of Download} { RATFREQSELPRIID}={RAT Frequency Selection Priority ID} {PLMNTPLID}= {DIAMNODETPL_ID}= {EGR}= {EGRHLRSN}={NON3GPPSUPP}= {MIP6FEAVEC}= {SESSIONTIMEOUT}= { VOWIFI_TAG}= {LTEAUTOPROV}= {MPS}= {ICSIND}= {ANCHOR}= {VOLTETAG}= {TAUTIMER}={0-43200} {RELAY_NODE}= {SWXPLMNTPLID}= {EPSODBPOS}= {APNTPLID}= { DEFAULTAPN}={ WILDCARDAPN}=
All rights reserved.
Page 42 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{EPSQOSTPLID}= {PDPTYPE}= {PDPADD}= {ADDIND}= {PDPADDIPV6}= {ADDIND2}= {PDPADDIPV4}= {VPLMNALLOWED}= {CHARGE}= {STDCHARGE}= {APNOITPLID}= "PS PDP Data" {CHARGE_GLOBAL}= {CNTXID}= {PSAPNQOSTPLID}= ..........."EPS PDN Data" {CHARGE_GLOBAL}= {DEFAULTCNTXID}= {CNTXID}= {EPSAPNQOSTPLID}= ........... "Dynamic Status Information For MME" {MMEHOST}={MME Host Name} {MMEREALM}={MME Realm Name} {RATTYPE}= {VPLMN}={Visited PLMN Identifier} {PURGEDONMME}= {MME-UpdateLocation-Time}={MME Update Location Time} {MME-FeatureList}={MME FeatureList in HEX format} {MME-FeatureList2}={MME FeatureList2 in HEX format} {LastIDRorDSRFailed}= {Single-Registration-Indication}= {Skip-Subscriber-Data-Indicator}=
All rights reserved.
Page 43 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{GPRS-Subscription-Data-Indicator}= {Node-Type-Indicator}= {Initial-Attach-Indicator}= {PS-LCS-Not-Supported-By-UE}= {IMEI}= {IMEISV}= {IMS-VO-PS-Sessions-Supported}= {UE-SRVCC-Capability}= {VGMLC-MME}= "Dynamic Status Information For S4SGSN" {SGSNHOST}={SGSN Host Name} {SGSNREALM}={SGSN Realm Name} {SGSNNUMBER}={SGSN GT Number} {RATTYPE}= {VPLMN}={Visited PLMN Identifier} {PURGEDONSGSN}= {AREARESTRICT}= {S4SGSN-UpdateLocation-Time}={S4SGSN Update Location Time} {S4SGSN-FeatureList}={S4SGSN FeatureList in HEX format} {S4SGSN-FeatureList2}={S4SGSN FeatureList2 in HEX format} {LastIDRorDSRFailed}= {Skip-Subscriber-Data-Indicator}= {GPRS-Subscription-Data-Indicator}= {Node-Type-Indicator}= {Initial-Attach-Indicator}= {PS-LCS-Not-Supported-By-UE}= {IMEI}= {IMEISV}= {IMS-VO-PS-Sessions-Supported}= {UE-SRVCC-Capability}= {VGMLC-SGSN}= "Dynamic Status Information For IMS" {UE-Register-AtIMS}=
All rights reserved.
Page 44 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
"Dynamic APN Information For EPS" {CNTXID}= {APN}={Access Point Name} {PDNGWHOST}={PDN-GW Host Name} {PDNGWREALM}={PDN-GW Realm Name} {PDNGWIPV4}={the IPv4 of PDN-GW} {PDNGWIPV6}={the IPv6 of PDN-GW} {WILDCARDFLAG}= {VNI}={Visited Network Identifier} {CNXTID}= ........... "Dynamic Status Information For Non-3GPP" {VNI}= {REGSTATUS}= {ACCESSNETID}= {TGPPAAASERVERNAME}= {TGPPAAASERVERREALM}= {TGPP2MEID}= {IMEI}= {IMEISV}= {Server-Assignment-Time}={AAA Update Location Time}
{SMDP}= {NAEA_CIC}= {NLRInd}= {ALS}= {LINE2NUM}= {VVDN}= {RBTIndex}= {ARD}= {UTRANNOTALLOWED}= {GERANNOTALLOWED}= {GANNOTALLOWED}=
All rights reserved.
Page 45 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{IHSPAENOTALLOWED}= {EUTRANNOTALLOWED}= {N3GPPNOTALLOWED}= {WLANNOTALLOWED}= {CDMA2000_1XNOTALLOWED}= {HRPDNOTALLOWED}= {UMBNOTALLOWED}= {EHRPDNOTALLOWED}= {CARP}= {RROption}= {RRTPL}= {RZONE}= {VBS}= {EMLPP}= {EMLPP_COU}= {ECATEGORY}= {ECATOPTION}= {UUS1}= {UUS2}= {UUS3}= {FMInit}= {FMSupervisor}= {FMRemote}= {IST}= {ISTTIMER}= {ISTRSP}= {DIC}= {DICLENGTH}= {ROUTECATEGORY}= {CALLREDIRECT}= {NRBTIndex}=
All rights reserved.
Page 46 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{OSK}= {TSK}= {ETCSICONVER_TPLID}= {EXEXROUTECATEGORY}= {MERBT}= {NIRPROV}= {NIRIndex}= {ACR_STATUS}= {CPP}= {ELCS}= {BOSK}= {EOICK}= {CAPL}= {ETICK}= {ARBTIndex}= { STE_PROV}= { GMLC_ADD}= "Dynamic Status Information For GSM" {VlrNum}=, {MscNum}=, {MsPurgedForNonGprs}=, {VLRInHplmn}=, {VLRInHomeContry}=, {VLRInArea}=, {RequireCheckSS}=, {RoamingRestirctInMscDueToUnsupportedFeature}=, {MscOrVlrAreaRoamingRestrict}=, {ODBarredForUnsupportedCamel}=, {SupportedCamelPhase1}={TRUE|FALSE}, {SupportedCamelPhase2}={TRUE|FALSE}, {SupportedCamelPhase3}={TRUE|FALSE}, {SupportedCamelPhase4}={TRUE|FALSE},
All rights reserved.
Page 47 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{SRIMsrnCfActive}={TRUE|FALSE}, {ZoneCodeStatusAtMsc}=, {longGroupIDSupported}={TRUE|FALSE}, {basicISTSupported}={TRUE|FALSE}, {istCommandSupported}={TRUE|FALSE}, {SuperChargerSupportedForGsm}={TRUE|FALSE}, {LMSI}=, {ECATEGORYAtMsc}=, {CSUPLTIME}={Update Location Time}, {CSPURGETIME}={Purge Time At MSC}, {CS-MSISDN-LESS}=, {CSRATTYPE}=, { CsUplStatus}=, "OfferedCAMEL4CSIsInVLR" {O-CSI} {D-CSI} {VT-CSI} {T-CSI} {MT-SMS-CSI} {MG-CSI} {PSI-Enhancements} {BaocForVlrRestrict}= "Dynamic Status information For GPRS" {SgsnNum}=, {SgsnAddressType}=, {SgsnAddress}=, {SgsnInHplmn}=, {MsPurgedForGprs}=,
All rights reserved.
Page 48 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{SgsnInHomeCountry}=, {SgsnInArea}=, {RoamingRestrictInSgsnDueToUnsupportedFeature}=, {SgsnAreaRoamingRestrict}=, {ODBarredForUnsupportedCamelForGprs}=, {PSUPLTIME}={Gprs Update Location Time}, {PSPURGETIME}={Purge Time At SGSN}, {PS-MSISDN-LESS}=, {PSRATTYPE}=, { PsUplStatus}=, {GgsnNumber1}={GGSN Number1}, {GgsnAddressType1}=, {GgsnAddress1}=, {GgsnNumber2}={GGSN Number2}, {GgsnAddressType2}=, {GgsnAddress2}=, {GgsnNumber3}={GGSN Number3}, {GgsnAddressType3}=, {GgsnAddress3}=, {SupportedCamelPhase3}={TRUE|FALSE}, {SupportedCamelPhase4}={TRUE|FALSE}, {SuperChargerSupportedForGprs}=, {ZoneCodeStatusAtSgsn}=, "OfferedCAMEL4CSIsInSGSN" {O-CSI}= {D-CSI}= {VT-CSI}=
All rights reserved.
Page 49 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{T-CSI}={MT-SMS-CSI}= {MG-CSI}= {PSI-Enhancements}= "Short Message Dynamic Data for GSM" {MCEF}=, {MNRF}=, {MNRR}= "Short Message Dynamic Data for GPRS" {MCEF}=, {MNRG}= {MNRR}= {SupportedShortMessageMT-PP}= {SupportedShortMessageMO-PP}= "ShortMessage Center Information" {SC1}={SC address1}, {SC2}={SC address2}, {SC3}={SC address3}, "ODB Supported Features For GSM" {BarredSSAccess}=, {BarredOutgoingEntertainmentCall}=, {BarredOutgoingInformationCall}=, {BarredOutgoingInternationalCallExHC}=, {BarredOutgoingInternationalCall}=, {BarredAllOutgoingCall}=, {BarredAllECT}=, {BarredChargeableECT}=, {BarredInternationalECT}=, {BarredInterzonalECT}=, {BarredDECT}=, {BarredMECT}=, "ODB Supported Features For GPRS" {BarredAllOutgoingCall}= {BarredOutgoingInternationalCall}=
All rights reserved.
Page 50 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{BarredOutgoingInternationalCallExHC}= { Barring of Packet Oriented Services}= "Short Message Dynamic Data for IP" {MCEF}= {UNRI}= {UNRR}= {IP_SM_GW}=, "unsupported TeleService Feature" {UnsupTS}={TS11:
Telephony Service},
{UnsupTS}={TS12:
Emergency Call},
{UnsupTS}={TS21:
ShortMessageMT-PP}
{UnsupTS}={TS22:
ShortMessageMO-PP}
{UnsupTS}={TS61:
FascimileGroup3andAlterSpeech}
{UnsupTS}={TS62:
autoFascimileGroup3}
"Unsupported Bearer Service Feature" {UnsupBSFor2G}={BS20: HighSpeedBearerServiceCDA} {UnsupBSFor2G}={BS21: dataCDA_300bps} {UnsupBSFor2G}={BS22: dataCDA_1200bps} {UnsupBSFor2G}={BS23: dataCDA_1200_75bps} {UnsupBSFor2G}={BS24: dataCDA_2400bps} {UnsupBSFor2G}={BS25: dataCDA_4800bps} {UnsupBSFor2G}={BS26: dataCDA_9600bps} {UnsupBSFor2G}={BS30: HighSpeedBearerServiceCDS} {UnsupBSFor2G}={BS31: dataCDS_1200bps} {UnsupBSFor2G}={BS32: dataCDS_2400bps} {UnsupBSFor2G}={BS33: dataCDS_4800bps} {UnsupBSFor2G}={BS34: dataCDS_9600bps} {UnsupBSFor2G}={BS41: padAccessCA_300bps} {UnsupBSFor2G}={BS42: padAccessCA_1200bps} {UnsupBSFor2G}={BS43: padAccessCA_1200_75bps} {UnsupBSFor2G}={BS44: padAccessCA_2400bps} {UnsupBSFor2G}={BS45: padAccessCA_4800bps} {UnsupBSFor2G}={BS46: padAccessCA_9600bps}
All rights reserved.
Page 51 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{UnsupBSFor2G}={BS51: dataPDS_2400bps} {UnsupBSFor2G}={BS52: dataPDS_4800bps} {UnsupBSFor2G}={BS53: dataPDS_9600bps} {UnsupBSFor2G}={BS61: allAlternateSpeech_Data} {UnsupBSFor2G}={BS81: allSpeechFollowedByData} {UnsupBSFor2G}={BS20: HighSpeedBearerServiceCDA} {UnsupBSFor2G}={BS21: dataCDA_300bps} {UnsupBSFor2G}={BS22: dataCDA_1200bps} {UnsupBSFor2G}={BS23: dataCDA_1200_75bps} {UnsupBSFor2G}={BS24: dataCDA_2400bps} {UnsupBSFor2G}={BS25: dataCDA_4800bps} {UnsupBSFor2G}={BS26: dataCDA_9600bps} {UnsupBSFor2G}={BS30: HighSpeedBearerServiceCDS} {UnsupBSFor2G}={BS31: dataCDS_1200bps} {UnsupBSFor2G}={BS32: dataCDS_2400bps} {UnsupBSFor2G}={BS33:dataCDS_4800bps} {UnsupBSFor2G}={BS34: dataCDS_9600bps} {UnsupBSFor2G}={BS41: padAccessCA_300bps} {UnsupBSFor2G}={BS42: padAccessCA_1200bps} {UnsupBSFor2G}={BS43: padAccessCA_1200_75bps} {UnsupBSFor2G}={BS44: padAccessCA_2400bps} {UnsupBSFor2G}={BS45: padAccessCA_4800bps} {UnsupBSFor2G}={BS46: padAccessCA_9600bps} {UnsupBSFor2G}={BS51: dataPDS_2400bps} {UnsupBSFor2G}={BS52: dataPDS_4800bps} {UnsupBSFor2G}={BS53: dataPDS_9600bps} {UnsupBSFor2G}={BS61: allAlternateSpeech_Data} {UnsupBSFor2G}={BS81: allSpeechFollowedByData} "Unsupported Supplementary Service Feature" {UnsupSS}={CFU:Call Forwarding on Unconditional} {UnsupSS}={CFB:Call Forwarding on mobile subscriber Busy} {UnsupSS}={CFNRy:Call Forwarding not-Reply} {UnsupSS}={CFNRc:Call Forwarding on mobile subscriber not-reachable}
All rights reserved.
Page 52 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{UnsupSS}={BAOC:Barring All Outgoing Call} {UnsupSS}={BOIC:Barring Outgoing International Call} {UnsupSS}={BOICExHC:Barring Outgoing International Call Exception Home Country} {UnsupSS}={BAIC:Barring All Incoming Call} {UnsupSS}={BICROAM:Barring Of Incoming Call While Roaming} {UnsupSS}={CLIP:Calling Line Identification Presentation} {UnsupSS}={CLIR:Calling Line Identification Restriction} {UnsupSS}={COLP:Connected Line Presentation} {UnsupSS}={COLR:Connected Line Restriction} {UnsupSS}={CNAP:Calling Name Presentation} {UnsupSS}={CCBS:Completion of Calls to Busy Subscriber} {UnsupSS}={CCBSTARGER:Completion of Calls to Busy Subscriber target} {UnsupSS}={ECT:Explicit Call Transfer} {UnsupSS}={CW:Call Waiting} {UnsupSS}={HOLD:Call Hold} {UnsupSS}={MPTY:Multi-Party} {UnsupSS}={AOCI:Advice Of Charge Information} {UnsupSS}={AOCC:Advice Of Charge Charging} {UnsupSS}={CUG:Closed User Group} {UnsupSS}={UUS_1} {UnsupSS}={UUS_2} {UnsupSS}={UUS_3} {UnsupSS}={EMLPP:enhanced Multi-Level Precedence and Pre-emption service} {UnsupSS}={plmn-specificSS-1:PLMN specific supplemental service 1} {UnsupSS}={plmn-specificSS-2:PLMN specific supplemental service 2} {UnsupSS}={plmn-specificSS-3:PLMN specific supplemental service 3} {UnsupSS}={plmn-specificSS-4:PLMN specific supplemental service 4} {UnsupSS}={plmn-specificSS-5:PLMN specific supplemental service 5} {UnsupSS}={plmn-specificSS-6:PLMN specific supplemental service 6} {UnsupSS}={plmn-specificSS-7:PLMN specific supplemental service 7} {UnsupSS}={plmn-specificSS-8:PLMN specific supplemental service 8} {UnsupSS}={plmn-specificSS-9:PLMN specific supplemental service 9} {UnsupSS}={plmn-specificSS-A:PLMN specific supplemental service A}
All rights reserved.
Page 53 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{UnsupSS}={plmn-specificSS-B:PLMN specific supplemental service B} {UnsupSS}={plmn-specificSS-C:PLMN specific supplemental service C} {UnsupSS}={plmn-specificSS-D:PLMN specific supplemental service D} {UnsupSS}={plmn-specificSS-E:PLMN specific supplemental service E} {UnsupSS}={plmn-specificSS-F:PLMN specific supplemental service F}"Supported LCS" {MSC Supported LCS Capability Set1}=, {MSC Supported LCS Capability Set2}=, {SGSN Supported LCS Capability Set2}= "Featured Service Supported Features" {ALS}=, {VVDN}= "OKSC Features" {TPLID}= {TPLNAME}="SMS Route" {SMSROUTETPL}= { SMSROUTETPLNAME}= "SHORT-NUM" {TPLID}= {TPLNAME}= "SMS INAP Service" {SCPADD}= {SKEY}= {DP}= {TAMM}= "Fraud Limitation Service" {FRAUDTPLID}= {FRAUDTPLNAME}= "M2M" {IMEILCKPROV}= { IMSIIMEIBIND}= {M2MNOTIFY}= {USERATTRIBUTE}= {M2MCISDN}=
All rights reserved.
Page 54 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
"GroupSim Service" {MBRSYNC}= {DENY_USSD}= {GISDN}= "MAP Address Restriction Service" {MAPADDRRESTPLID}= {MAPADDRRESTPLNAME}= "Preferred Roaming Service" {CS_ROAMPERTPL_ID}= {PS_ROAMPERTPL_ID}= { LTE_M2M_FLAG}=< TRUE|FALSE > "DND Service" {DND} = < TRUE|FALSE > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
If the value of NAEA ranges from 0 to 9999, the value indicates that the NAEA service is provided and the actual NAEA value is displayed. Otherwise the value indicates that the NAEA service is not provided and NOTPROV is displayed.
When the CAMALMANAGER parameter in the SET MAPSERV command is set to Template, the HSS9860 uses MOD UCSI to provide a U-CSI service template for a subscriber and LST SUB to display the only U-CSI template provided for the subscriber. When CAMALMANAGER parameter is set to NON-Template, the HSS9860 uses MOD NTUCSI to provide one or more UCSI service templates for a subscriber and LST SUB to display all U-CSI templates provided for the subscriber.
9.6 Query the Dynamic Subscriber Data Command Name: LST DYNSUB Function: This command is used to query the dynamic data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
CONTENT
Enumerated
ALL
O
GSM
Specifies the type of dynamic data to be queried for the subscriber.
GPRS
ALL: all types of dynamic data
All rights reserved.
Page 55 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
EPSFEATURE LISTDETAIL
Type
Boolean
Summary of CommandsSummary of Commands
Range
Description
Remarks
SM
GSM: GSM service status
ODB
GPRS: GPRS status
UNSP
SM: three SMS status records
LCS
ODB: ODB service status
ALLSM
EPS
UNSP: services that are not support by the MSC/VLR
LCS: LCS status
ALLSM: all SMS status records
EPS: EPS status
TRUE
FALSE
Specifies whether the HSS displays all the features on the feature list supported by the MME and S4SGSN.
O
TRUE: The HSS displays not only the feature list values but also the features supported by the MME and S4-SGSN.
FALSE: The HSS displays only the feature list values.
Example: LST DYNSUB: ISDN="955678112", EPSFEATURELISTDETAIL=TRUE; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {RMNUM}= {FUNCDest}= {CORSet}={COR_x1 & COR_x2…} {FFN_Address }=< FFN's Address > {InitiatingNumber}=< specific Initiating number which is registered to remote party> If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
9.185 Modify the FM Service Command Name: MOD FM Function: This command is used to modify the Follow Me (FM) service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides the FM service.
TRUE: The HSS9860 provides the FM service.
All rights reserved.
Page 280 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
TYPE
CORSET
Enumerated
Enumerated
Initiating subscriber
Supervisor
COR_1
COR_2
COR_3
Remarks
FALSE: The HSS9860 withdraws the FM service.
Specifies whether the HSS9860 provides, modifies, or withdraws the FM service type of the initiating subscriber or of the supervisor.
Initiating subscriber: The HSS9860 provides, modifies, or withdraws the FM service type of the initiating subscriber.
Supervisor: The HSS9860 provides, modifies, or withdraws the FM service type of the supervisor.
Provides, modifies or deletes the subscriber's COR set.
M
O
...
COR_254
Delete_COR
Example: MOD FM: IMSI="123456789", PROV=TRUE, TYPE=Initiating subscriber, CORSET=COR_3&COR_5&COR_62&COR_164; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
9.186 Query the FM Service Data Command Name: LST FM Function: This command is used to query the Follow Me (FM) service data. Parameter Description:
All rights reserved.
Page 281 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST FM: IMSI="123456789"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {Type}=< Initiating subscriber | Supervisor > {CORSet}={COR_x1 & COR_x2…} {Remote Number registered to }={ remote party's MSISDN } =… … =… … If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
9.187 Send a USSD Notify Request Command Name: SND FMNOTIFY Function: This command is used to simulate the sending of a USSD notify request. Parameter Description: Name
Type
Range
Description
Remarks
RMNUM
Character string
1-15
Number of the remote subscriber
M
INITNUM
Character string
1-15
Initial subscriber MSISDN
M
Example: SND FMNOTIFY: RMNUM="955589", INITNUM="861386559"; Output: If the operation succeeds, the system displays the following message:
All rights reserved.
Page 282 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
9.188 Modify the Data of an Authorized Subscriber Command Name: MOD AUTHUSER Function: This command is used to modify the data of an authorized subscriber. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
1-255
HLR serial number
M
RMNUM
Character string
1-15
Number of the remote subscriber
M
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 adds or deletes the potential initiating subscriber or supervisor of the remote subscriber.
TYPE
INITNUM
Enumerated
Character string
TRUE: The HSS9860 adds the potential initiating subscriber or supervisor of the remote subscriber.
FALSE: The HSS9860 deletes the potential initiating subscriber or supervisor of the remote subscriber.
Initiating subscriber
Specifies whether the HSS9860 authorizes the initiating subscriber or of the supervisor.
Supervisor
Initiating subscriber: The HSS9860 authorizes the initiating subscriber.
Supervisor: The HSS9860 authorizes the FM service type of the supervisor.
1-15
Initial subscriber MSISDN
M
C
Example: MOD AUTHUSER: HLRSN=1, RMNUM="955589", PROV=TRUE, TYPE=Initiating subscriber, INITNUM="861386559"; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 283 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.189 Query the Data of an Authorized Subscriber Command Name: LST AUTHUSER Function: This command is used to query the authorization information of the potential initiating subscriber or supervisor of the remote subscribers. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
1-255
HLR serial number
M
RMNUM
Character string
1-15
Number of the remote subscriber
M
TYPE
Enumerated
Initiating subscriber Supervisor
Specifies whether the HSS9860 queries the initiating subscriber or of the supervisor.
M
Initiating subscriber: The HSS9860 queries the initiating subscriber.
Supervisor: The HSS9860 queries the FM service type of the supervisor.
Example: LST AUTHUSER: RMNUM="955589", TYPE=Initiating subscriber;
Output: If the operation succeeds, the system displays an output with the following format: {HLRSN}=< HLR Serial No in the redundant HLR center > {RMNUM} = {Type} = < Initiating subscriber | Supervisor > {ISDN}=< MSISDN1>, =< MSISDN2>, =< MSISDN3>, …… If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 284 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.190 Modify FM Registration Data Command Name: MOD FMREG Function: This command is used to modify the follow me (FM) registration data. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
1-255
HLR serial number
M
OPTION
Enumerated
REGISTER
M
ERASE
Specifies whether the HSS9860 registers an initiating subscriber for a remote subscriber.
REGISTER: the HSS9860 registers an initiating subscriber.
ERASE: The HSS9860 deregisters an initiating subscriber.
RMNUM
Character string
1-15
Number of the remote subscriber
M
INITNUM
Character string
1-15
Initial subscriber MSISDN
C
Example: MOD FMREG: OPTION=Register, RMNUM="955589", INITNUM="861386559"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
9.191 Modify UUS Service Command Name: MOD UUS Function: This command is used to modify the user-to-user signaling (USS) service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides the USS service.
TRUE: The HSS9860 provides
All rights reserved.
Page 285 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
the USS service.
UUS
Enumerated
FALSE: The HSS9860 withdraws the USS service.
UUS1
Specifies the UUS service type.
UUS2
UUS3
UUS1: send and receive the UUI message while originating or terminating calls
UUS2: send the UUI message while hearing ringing
UUS3: send and receive the UUI message after the communication is connected
M
Example: MOD UUS: IMSI="460000009123456", PROV=TRUE, UUS=UUS2; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
9.192 Query UUS Service Command Name: LST UUS Function: This command is used to query the user-to-user signaling (USS) service data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST UUS: IMSI="460000009123456"; Output:
All rights reserved.
Page 286 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {UUS1}= {UUS2}= {UUS3}= If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
9.193 Modify the CF Services Command Name: MOD CF Function: This command is used to provide or withdraw the call forwarding (CF) services, including call forwarding unconditional (CFU), call forwarding on mobile subscriber busy (CFB), call forwarding on mobile subscriber not reachable (CFNRc), and call forwarding on no reply (CFNRy) services. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
CFUPROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides the CFU service.
C
CFBPROV
CFNRCPROV
Boolean
Boolean
TRUE
FALSE
TRUE
FALSE
TRUE: The HSS9860 provides the CFU service.
FALSE: The HSS9860 withdraws the CFU service.
Specifies whether the HSS9860 provides the CFB service.
C
TRUE: The HSS9860 provides the CFB service.
FALSE: The HSS9860 withdraws the CFB service.
Specifies whether the HSS9860 provides the CFNRc service.
C
TRUE: The HSS9860 provides the CFNRc service.
FALSE: The HSS9860 withdraws the CFNRc service.
All rights reserved.
Page 287 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
CFNRYPROV
Boolean
TRUE
FALSE
OFAID
Numeral
0-65535
NFS
Boolean
TRUE
FALSE
NCS
COU
Boolean
Enumerated
TRUE
FALSE
SUBSCRIBER,
OPERATOR
Description
Remarks
Specifies whether the HSS9860 provides the CFNRy service.
C
TRUE: The HSS9860 provides the CFNRy service.
FALSE: The HSS9860 withdraws the CFNRy service.
OFA template ID
O
Specifies whether the HSS9860 notifies the forwarded-to party in case of CF service.
O
TRUE: The HSS9860 notifies the forwarded-to party.
FALSE: The HSS9860 does not notify the forwarded-to party.
Specifies whether the HSS9860 notifies the calling party in case of CF service.
TRUE: The HSS9860 notifies the calling party.
FALSE: The HSS9860 does not notify the calling party.
O
Specifies which party controls the CF service.
OPERATOR: The operator controls the registration, activation, deregistration, and deactivation of the CF service through the Web UI.
SUBSCRIBER: Both the operator and subscriber control the registration, activation, deregistration, and deactivation of the CF service. The subscriber controls the service through the MS.
O
Example: MOD CF:IMSI="123454321234543",CFUPROV=TRUE,OFAID=2,NFS=TRUE, NCS=TRUE, COU=OPERATOR; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
All rights reserved.
Page 288 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
This command only applies to the subscriber whose NAM is BOTH or MSC.
IMSI and ISDN are mutually exclusive. Specify only one of them.
At least one of the parameters CFUPROV, CFBPROV, CFNRYPROV, and CFNRCPROV must be specified.
If the parameter CFBPROV or CFNRYPROV is set to TRUE, the parameters NCS, NFS, COU and OFAID are optional. If the parameter CFUPROV is set to TRUE, the parameters NCS, COU and OFAID are optional. If the parameter CFNRCPROV is set to TRUE, the parameters NCS, COU and OFAID are optional.
If the parameters CFUPROV, CFBPROV, CFNRYPROV, and CFNRCPROV are set to FALSE, the parameters NCS, NFS, COU, and OFAID do not need to be specified.
9.194 Modify the TS Services Command Name: MOD TS Function: This command is used to provide or withdraw the teleservices (TS), including telephony services (TS11), short message services (TS21 and TS22), and data services (TS61 and TS62). Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
TS11
Boolean
TRUE
C
FALSE
Specifies whether the HSS9860 provides the telephony service.
TS21
TS22
TS61
Boolean
Boolean
Boolean
TRUE
FALSE
TRUE
FALSE
TRUE
TRUE: The HSS9860 provides the telephony service.
FALSE: The HSS9860 withdraws the telephony service.
Specifies whether the HSS9860 provides the short message MT/PP service.
TRUE: The HSS9860 provides the short message MT/PP service.
FALSE: The HSS9860 withdraws the short message MT/PP service.
Specifies whether the HSS9860 provides the short message MO/PP service.
TRUE: The HSS9860 provides the short message MO/PP service.
FALSE: The HSS9860 withdraws the short message MO/PP service.
Specifies whether the HSS9860 provides the
All rights reserved.
C
C
C
Page 289 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
TS62
Boolean
FALSE
TRUE
FALSE
Summary of CommandsSummary of Commands
Description
Remarks
alternate speech and facsimile group 3 service.
TRUE: The HSS9860 provides the alternate speech and facsimile group 3 service.
FALSE: The HSS9860 withdraws the alternate speech and facsimile group 3 service.
Specifies whether the HSS9860 provides the automatic facsimile group 3 service.
TRUE: The HSS9860 provides the automatic facsimile group 3 service.
FALSE: The HSS9860 withdraws the automatic facsimile group 3 service.
C
Example: MOD TS: IMSI="444441234567890", TS11=TRUE, TS21=TRUE, TS61=TRUE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
This command only applies to the subscriber whose NAM is BOTH or MSC.
IMSI and ISDN are mutually exclusive. Specify only one of them.
At least one of the parameters TS11, TS21, TS22, TS61, and TS62 must be specified.
9.195 Modify the ODB Services Command Name: MOD ODB Function: This command is used to provide or withdraw the operator-determined barring (ODB) services. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
ODBSS
Boolean
TRUE
C
FALSE
Specifies whether the HSS9860 provides the operator-determined barring (ODB) service.
All rights reserved.
Page 290 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
ODBIC
ODBOC
ODBPB1
ODBPB2
ODBPB3
Type
Enumerated
Enumerated
Boolean
Boolean
Boolean
Summary of CommandsSummary of Commands
Range
Description
NOBIC
BAIC
BICROAM
NOBOC
BAOC
BOIC
BOICEXHC
BOCROAM
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
TRUE: The HSS9860 provides the ODB service.
FALSE: The HSS9860 withdraws the ODB service.
Specifies the type of ODB-BIC services.
Remarks
NOBIC: not bar incoming calls
BAIC: bar all incoming calls
BICROAM: bar incoming calls when the subscriber is roaming outside the home PLMN country
C
Specifies the type of barring of outgoing calls or mobile originated short messages (ODB-BOC) services.
NOBOC: not bar outgoing calls
BAOC: bar all outgoing calls
BOIC: bar international outgoing calls
BOICEXHC: bar international outgoing calls except those directed to the home PLMN country
BOCROAM: bar all outgoing calls when the subscriber is roaming outside the home PLMN country
Specifies whether the HSS9860 provides the operator-determined barring of PLMN specific barring type 1 (ODB-PB1) service.
TRUE: The HSS9860 provides the ODB-PB1 service.
FALSE: The HSS9860 withdraws the ODB-PB1 service.
Specifies whether the HSS9860 provides the operator-determined barring of PLMN specific barring type 2 (ODB-PB2) service.
TRUE: The HSS9860 provides the ODB-PB2 service.
FALSE: The HSS9860 withdraws the ODB-PB2 service.
Specifies whether the HSS9860 provides the operator-determined barring of PLMN specific barring type 3 (ODB-PB3) service.
C
C
C
C
TRUE: The HSS9860 provides the
All rights reserved.
Page 291 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
ODB-PB3 service.
ODBPB4
ODBENTE
ODBINFO
ODBROAM
ODBRCF
Boolean
Boolean
Boolean
Enumerated
Enumerated
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
FALSE: The HSS9860 withdraws the ODB-PB3 service.
Specifies whether the HSS9860 provides the operator-determined barring of PLMN specific barring type 4 (ODB-PB4) service.
TRUE: The HSS9860 provides the ODB-PB4 service.
FALSE: The HSS9860 withdraws the ODB-PB4 service.
Specifies whether the HSS9860 provides the operator-determined barring of outgoing entertainment calls (ODB-ENTE) service.
TRUE: The HSS9860 provides the ODB-ENTE service.
FALSE: The HSS9860 withdraws the ODB-ENTE service.
Specifies whether the HSS9860 provides the operator-determined barring of outgoing information calls (ODB-INFO) service.
NOBAR
BROHPLMN
BROHPLMNC
BROHPLMNCGPR S
NOBRCF
BRACF
BRICFEXHC
BRICF
TRUE: The HSS9860 provides the ODB-INFO service.
FALSE: The HSS9860 withdraws the ODB-INFO service.
Specifies the type of operatordetermined barring of roaming (ODBROAM) services.
NOBAR: not bar roaming
BROHPLMN: bar roaming when the subscriber is roaming outside the home PLMN
BROHPLMNC: bar roaming when the subscriber is roaming outside the home PLMN country
BROHPLMNCGPRS: bar GPRS when the subscriber is roaming outside the home PLMN country
Specifies the type of operatordetermined registration of call forwarding (ODB-RCF) services.
C
C
C
C
C
NOBRCF: not bar the registration of forwarded-to numbers (FTNs)
All rights reserved.
Page 292 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
ODBECT
ODBDECT
ODBMECT
ODBPOS
Type
Enumerated
Boolean
Boolean
Enumerated
Summary of CommandsSummary of Commands
Range
Description
NOBECT
BAllECT
BChargeableECT
BInternationalECT
BInterzonalECT
TRUE
FALSE
TRUE
FALSE
NOBPOS
BAPOSB
Remarks
BRACF: bar the registration of all FTNs
BRICFEXHC: bar the registration of all international FTNs except those belonging to the home PLMN country
BRICF: bar the registration of all international FTNs
Specifies the type of the explicit call transfer barring.
C
NOBECT: not bar the explicit call transfer
BAllECT: bar all the explicit call transfers
BChargeableECT: bar the explicit call transfer when the served party roaming outside the home PLMN pays for at least one of incoming and outgoing calls
BInternationalECT: bar the explicit call transfer when the served party roaming internationally pays for at least one of incoming and outgoing calls
BInterzonalECT: bar the explicit call transfer when the served party roaming inter-zone pays for at least one of incoming and outgoing calls
Specifies whether the HSS9860 bars the explicit call transfer when the served party pays for incoming and outgoing calls.
C
TRUE: The HSS9860 bars the explicit call transfer service.
FALSE: The HSS9860 does not bar the explicit call transfer service.
Specifies whether the HSS9860 bars the explicit call transfer service if the served party has a call being transferred in the serving MSC/VLR.
TRUE: The HSS9860 bars the explicit call transfer service.
FALSE: The HSS9860 does not bar the explicit call transfer service.
Specifies the type of operatordetermined registration of packet
All rights reserved.
C
C
Page 293 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
ODBPOST YPE
ODBENTE ROAM
ODBINFOR OAM
Type
Enumerated
Boolean
Boolean
Summary of CommandsSummary of Commands
Range
Description
Remarks
HPLMNAPROAM
oriented service (ODB-POS).
BALLAPROAM
NOBPOS: not bar the packet oriented services
BAPOS: bar all the packet oriented services
BHPLMNAPROAM: bar the packet oriented services when access points are within the HPLMN and the subscriber is roaming in a VPLMN
BALLAPROAM: bar the packet oriented services when access points are within a VPLMN and the subscriber is roaming in the VPLMN
BOTH
MSInit
NetworkInit
TRUE
FALSE
TRUE
FALSE
Specifies valid PDP context activations.
C
BOTH: Both mobile-originated and network-originated PDP context activations are valid.
MSInit: Only mobile-originated PDP context activation is valid.
NETWORKINIT: Only networkoriginated PDP context activation is valid. Note: This parameter is optional.
Specifies whether the HSS9860 delivers the ODB-ENTE service data when subscribers are roaming.
TRUE: The HSS9860 delivers this service data when subscribers are roaming.
FALSE: The HSS9860 does not deliver this service data when subscribes are roaming.
Specifies whether the HSS9860 delivers the ODB-INFO service data when subscribers are roaming.
C
TRUE: The HSS9860 delivers this service data when subscribers are roaming.
FALSE: The HSS9860 does not deliver this service data when subscribes are roaming.
All rights reserved.
C
Page 294 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: MOD ODB: IMSI="460013907550001", ODBSS=TRUE, ODBIC=NOBIC, ODBOC=BAOC, ODBECT=NOBECT, ODBDECT=TRUE, ODBPOS=NOBPOS, ODBPOSTYPE=BOTH; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
When providing the ODB-POS service for the subscriber, the parameters ODBPOS and ODBPOSTYPE must be specified together. When modifying the ODB-POS service, one of the parameters ODBPOS or ODBPOSTYPE must be specified.
At least one type of the ODB services must be provided or withdrawn.
9.196 Modify the Number Identification Services Command Name: MOD PRERES Function: This command is used to provide or withdraw the number identification services, including calling line identification presentation (CLIP), calling line identification restriction (CLIR), connected line identification presentation (COLP), and connected line identification restriction (COLR). Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
CLIP
Boolean
TRUE
C
FALSE
Specifies whether the HSS9860 provides the COLP service.
CLIPOVERRIDE
Boolean
TRUE
FALSE
TRUE: The HSS9860 provides the COLP service.
FALSE: The HSS9860 withdraws the COLP service.
Specifies whether the HSS9860 provides the COLP-override service.
TRUE: The HSS9860 provides the COLP-override service.
FALSE: The HSS9860 withdraws the COLP-override service.
All rights reserved.
C
Page 295 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
CLIR
Boolean
TRUE
FALSE
CLIRMODE
Enumerated
PERMANENT
TEMPALLOWE D
COLP
COLPOVERRIDE
COLR
Boolean
Boolean
Boolean
Description
Remarks
Specifies whether the HSS9860 provides the CLIR service.
C
TRUE: The HSS9860 provides the CLIR service.
FALSE: The HSS9860 withdraws the CLIR service.
Specifies the mode of the CLIR service.
PERMANENT: Permanent restriction, valid for all outgoing calls. If a mobile subscriber originates a call, the number of the subscriber is not presented to the called party.
TEMPALLOWED: The CLIP service is enabled by default. The CLIR service is activated only when the mobile subscriber dials #31# before the called number.
TEMPRESTRICTED: The CLIR service is enabled by default. The CLIP service is activated only when the mobile subscriber dials *31# before the called number.
TEMPRESTRIC TED
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
C
Specifies whether the HSS9860 provides the COLP service.
TRUE: The HSS9860 provides the COLP service.
FALSE: The HSS9860 withdraws the COLP service.
C
Specifies whether the HSS9860 enables the COLP-override service.
TRUE: The HSS9860 enables the COLP-override service.
FALSE: The HSS9860 disables the COLP-override service.
Specifies whether the HSS9860 provides the COLR service.
TRUE: The HSS9860 provides the COLR service.
FALSE: The HSS9860 withdraws the COLR service.
All rights reserved.
C
C
Page 296 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: MOD PRERES: IMSI="460013907550001", CLIP=TRUE, CLIPOVERRIDE=TRUE, CLIR=TRUE, CLIRMODE=PERMANENT, COLP=TRUE, COLPOVERRIDE=TRUE, COLR=TRUE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter CLIP is set to TRUE, the parameter CLIPOVERRIDE must be specified.
If the parameter COLP is set to TRUE, the parameter COLPOVERRIDE must be specified.
If the parameter CLIR is set to TRUE, the parameter CLIRMODE must be specified.
9.197 Modify Other SSs Command Name: MOD OSS Function: This command is used to provide or withdraw other supplementary services, including:
Call waiting (CW)
Call hold (HOLD)
Multiparty service (MPTY)
Advice of charge-charging (AOCC)
Advice of charge-information (AOCI)
Explicit call transfer (ECT)
Completion of calls to busy subscriber (CCBS)
CCBS target service (CCBSTRGET)
Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
CWAIT
Boolean
TRUE
FALSE
Specifies whether the HSS9860 provides the CW service.
TRUE: The HSS9860 provides the CW service.
FALSE: The HSS9860 withdraws the CW service.
All rights reserved.
Page 297 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
ACTDEACWAIT
Enumerated
ACT
DEA
ACTDEACWAITBSG
HOLD
MPTY
AOCC
AOCI
Enumerated
Boolean
Boolean
Boolean
Boolean
ALL
TS1X
TS2X
TS6X
Description
Remarks
Specifies the action to be taken for the CW service.
C
ACT: The HSS9860 activates the CW service.
DEA: The HSS9860 deactivates the CW service.
Specifies the basic service group of BAIC service.
C
ALL: all applicable services (TS1X, TS2X, TS6X, BS2X, BS3X, and TSDX)
BS2X
TS1X: telephony service
BS3X
TS2X: short message service
TSDX
TS6X: facsimile service group
BS2X: asynchronous bearer service
BS3X: synchronous bearer service
TSDX: custom supplementary service
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
Specifies whether the HSS9860 provides the HOLD service.
C
TRUE: The HSS9860 provides the HOLD service.
FALSE: The HSS9860 withdraws the HOLD service.
Specifies whether the HSS9860 provides the MPTY service.
C
TRUE: The HSS9860 provides the MPTY service.
FALSE: The HSS9860 withdraws the MPTY service.
Specifies whether the HSS9860 provides the AOCC service.
C
TRUE: The HSS9860 provides the AOCC service.
FALSE: The HSS9860 withdraws the AOCC service.
Specifies whether the HSS9860 provides the AOCI service.
C
TRUE: The HSS9860 provides the AOCI service.
FALSE: The HSS9860 withdraws the AOCI service.
All rights reserved.
Page 298 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
ECT
Boolean
TRUE
FALSE
CCBS
Boolean
CCBSTARGET
Boolean
TRUE
FALSE
TRUE
FALSE
Description
Remarks
Specifies whether the HSS9860 provides the ECT service.
C
TRUE: The HSS9860 provides the ECT service.
FALSE: The HSS9860 withdraws the ECT service.
Specifies whether the HSS9860 provides the CCBS service.
C
TRUE: The HSS9860 provides the CCBS service.
FALSE: The HSS9860 withdraws the CCBS service.
Specifies whether the HSS9860 provides the CCBSTARGET service.
TRUE: The HSS9860 provides the CCBSTARGET service.
FALSE: The HSS9860 withdraws the CCBSTARGET service.
C
Example: MOD OSS: IMSI="444441234567890",CWAIT=TRUE,ACTCWAIT=TS1X, HOLD=TRUE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 299 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMSI and ISDN are mutually exclusive. Specify only one of them.
At least one of the parameters CWAIT, HOLD, MPTY, AOCC, AOCI, ECT, CCBS, CCBSTARGET and ACTDEACWAIT must be specified.
If the parameter CWAIT is set to TRUE, the parameter ACTDEACWAIT is optional and can only be set to ACT. If the parameter CWAIT is set to FALSE, the parameter ACTDEACWAIT does not need to be specified. If the parameter CWAIT is not specified, the parameter ACTDEACWAIT is optional.
If the parameter ACTDEACWAIT is specified, the parameter ACTDEACWAITBSG must be specified. If the parameter ACTDEACWAIT is not specified, the parameter ACTDEACWAITBSG does not need to be specified.
Before providing the MPTY or ECT services for a subscriber, the HOLD service must be provided for the subscriber first.
The parameters AOCC and AOCI are mutually exclusive. They cannot be set to TRUE at the same time.
9.198 Query Other SSs Command Name: LST OSS Function: This command is used to query other supplementary services, including:
Call waiting (CW)
Call hold (HOLD)
Multiparty service (MPTY)
Advice of charge-charging (AOCC)
Advice of charge-information (AOCI)
Explicit call transfer (ECT)
Completion of calls to busy subscriber (CCBS)
CCBS target service (CCBSTRGET)
Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
DETAIL
Boolean
TRUE
Specifies the information to be queried.
C
FALSE
TRUE: The detailed information is queried.
FALSE: The brief information is queried.
Example: LST OSS: IMSI="444441234567890", DETAIL=TRUE; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}=
All rights reserved.
Page 300 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{ISDN}= CWAIT {BSG}= {CWAIT}= {BSG}= {CWAIT}= {BSG}= {CWAIT}= {BSG}= {CWAIT}= {BSG}= {CWAIT}= {BSG}=. {CWAIT}= {HOLD} = {MPTY} = {AOCC} = {AOCI}= {ECT}= {CCBS}= {CCBSTARGET}= If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.199 Modify the CB Services Command Name: MOD CB Function: This command is used to provide or withdraw the call barring (CB) services. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
All rights reserved.
Page 301 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
BAOC
Boolean
TRUE
FALSE
BOIC
BOICEXHC
BORO
BAIC
BICROM
Boolean
Boolean
Boolean
Boolean
Boolean
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
Summary of CommandsSummary of Commands
Description
Remarks
Specifies whether the HSS9860 provides the barring of all outgoing calls (BAOC) service.
C
TRUE: The HSS9860 provides the BAOC service.
FALSE: The HSS9860 withdraws the BAOC service.
Specifies whether the HSS9860 provides the barring of outgoing international calls (BOIC) service.
TRUE: The HSS9860 provides the BOIC service.
FALSE: The HSS9860 withdraws the BOIC service.
Specifies whether the HSS9860 provides the barring of outgoing international calls except those directed to the home PLMN country (BOICEXHC) service.
TRUE: The HSS9860 provides the BOICEXHC service.
FALSE: The HSS9860 withdraws the BOICEXHC service.
Specifies whether the HSS9860 provides the barring of all outgoing calls when roaming outside the home PLMN country (BORO) service.
TRUE: The HSS9860 provides the BORO service.
FALSE: The HSS9860 withdraws the BORO service.
Specifies whether the HSS9860 provides the barring of all incoming calls (BAIC) service.
TRUE: The HSS9860 provides the BAIC service.
FALSE: The HSS9860 withdraws the BAIC service.
Specifies whether the HSS9860 provides the barring of incoming calls when roaming outside the home PLMN country (BICRoam) service.
TRUE: The HSS9860 provides the BICRoam service.
FALSE: The HSS9860 withdraws the BICRoam service.
All rights reserved.
C
C
C
C
C
Page 302 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: MOD CB: IMSI="444441234567890",BAOC=TRUE, BOIC=TRUE, BOICEXHC=TRUE, BORO=TRUE, BAIC=TRUE, BICROM=TRUE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
At least one of the parameters BAOC, BOIC, BOICEXHC, BORO, BAIC, and BICROM must be specified.
9.200 Modify the CAMEL Services Command Name: MOD CAMEL Function: This command is used to provide or withdraw the CAMEL following services:
Originating CAMEL subscription information (O-CSI)
Terminating CSI (T-CSI)
VMSC terminating CSI (VT-CSI)
USSD CSI (U-CSI)
Supplementary service invocation notification CSI (SS-CSI)
Translation information flag CSI (TIF-CSI)
Mobility management CSI (M-CSI)
Short message service CSI (SMS-CSI)
GPRS CSI (GPRS-CSI)
Dialed services CSI (D-CSI)
Originating CAMEL subscription information for IMS (O-IM-CSI)
VMSC terminating CAMEL subscription information for IMS (VT-IM-CSI)
Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
OCSIPROV
Boolean
TRUE
C
FALSE
Specifies whether the HSS9860 provides the O-CSI service.
TRUE: The HSS9860 provides the O-CSI service.
FALSE: The HSS9860 withdraws
All rights reserved.
Page 303 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
the O-CSI service. OCSITPLID
Numeral
0-65534
TCSIPROV
Boolean
TRUE
FALSE
TCSITPLID
Numeral
0-65534
VTCSIPROV
Boolean
TRUE
FALSE
VTCSITPLID
Numeral
0-65534
UCSIPROV
Boolean
TRUE
FALSE
UCSITPLID
Numeral
0-65534
SSCSIPROV
Boolean
TRUE
FALSE
SSCSITPLID
Numeral
0-65534
TIFCSIPROV
Boolean
TRUE
FALSE
MCSIPROV
Boolean
TRUE
FALSE
O-CSI template ID
C
Specifies whether the HSS9860 provides the T-CSI service.
C
TRUE: The HSS9860 provides the T-CSI service.
FALSE: The HSS9860 withdraws the T-CSI service.
T-CSI template ID
C
Specifies whether the HSS9860 provides the VT-CSI service.
C
TRUE: The HSS9860 provides the VT-CSI service.
FALSE: The HSS9860 withdraws the VT-CSI service.
VT-CSI template ID
C
Specifies whether the HSS9860 provides the U-CSI service.
C
TRUE: The HSS9860 provides the U-CSI service.
FALSE: The HSS9860 withdraws the U-CSI service.
U-CSI template ID
C
Specifies whether the HSS9860 provides the SS-CSI service.
C
TRUE: The HSS9860 provides the SS-CSI service.
FALSE: The HSS9860 withdraws the SS-CSI service.
SS-CSI template ID
C
Specifies whether the HSS9860 provides the TIF-CSI service.
C
TRUE: The HSS9860 provides the TIF-CSI service.
FALSE: The HSS9860 withdraws the TIF-CSI service.
Specifies whether the HSS9860 provides the M-CSI service.
TRUE: The HSS9860 provides the M-CSI service.
FALSE: The HSS9860 withdraws
All rights reserved.
C
Page 304 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
the M-CSI service. MCSITPLID
Numeral
0-65534
MOSMSCSIPROV
Boolean
TRUE
FALSE
MOSMSCSITPLID
Numeral
0-65534
MTSMSCSIPROV
Boolean
TRUE
FALSE
MTSMSCSITPLID
Numeral
0-65534
GPRSCSIPROV
Boolean
TRUE
FALSE
GPRSCSITPLID
Numeral
DCSIPROV
Boolean
0-65534
TRUE
FALSE
DCSITPLID
Numeral
0-65534
IMOCSIPROV
Boolean
TRUE
FALSE
IMOCSITPLID
Numeral
0-65534
IMVTCSIPROV
Boolean
TRUE
FALSE
M-CSI template ID
C
Specifies whether the HSS9860 provides the MOSMS-CSI service.
C
TRUE: The HSS9860 provides the MOSMS-CSI service.
FALSE: The HSS9860 withdraws the MOSMS-CSI service.
MOSMS-CSI template ID
C
Specifies whether the HSS9860 provides the MTSMS-CSI service.
C
TRUE: The HSS9860 provides the MTSMS-CSI service.
FALSE: The HSS9860 withdraws the MTSMS-CSI service.
MTSMS-CSI template ID
C
Specifies whether the HSS9860 provides the GPRS-CSI service.
C
TRUE: The HSS9860 provides the GPRS-CSI service.
FALSE: The HSS9860 withdraws the GPRS-CSI service.
GPRS-CSI template ID
C
Specifies whether the HSS9860 provides the D-CSI service.
C
TRUE: The HSS9860 provides the D-CSI service.
FALSE: The HSS9860 withdraws the D-CSI service.
D-CSI template ID
C
Specifies whether the HSS9860 provides the O-IM-CSI service.
C
TRUE: The HSS9860 provides the O-IM-CSI service.
FALSE: The HSS9860 withdraws the O-IM-CSI service.
O-IM-CSI template ID
C
Specifies whether the HSS9860 provides the VT-IM-CSI service.
C
TRUE: The HSS9860 provides the
All rights reserved.
Page 305 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
VT-IM-CSI service.
IMVTCSITPLID
Numeral
0-65534
FALSE: The HSS9860 withdraws the VT-IM-CSI service.
VT-IM- CSI template ID
C
Example: MOD CAMEL: IMSI="444441234567890", OCSIPROV=TRUE, OCSITPLID=1, TCSIPROV=TRUE, TCSITPLID=1,VTCSIPROV=TRUE, VTCSITPLID=1,UCSIPROV=TRUE, UCSITPLID=1, SSCSIPROV=TRUE, SSCSITPLID=1, TIFCSIPROV=TRUE, MCSIPROV=TRUE, MCSITPLID=1, MOSMSCSIPROV=TRUE, MOSMSCSITPLID=1, MTSMSCSIPROV=TRUE, MTSMSCSITPLID=1, GPRSCSIPROV=TRUE ,GPRSCSITPLID=1, DCSIPROV=TRUE ,DCSITPLID=1, IMOCSIPROV=TRUE , IMOCSITPLID=1, IMVTCSIPROV=TRUE , IMVTCSITPLID=1; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
At least one type of the CAMEL services must be provided or withdrawn.
If a CSI service is provided for a subscriber, the corresponding template ID must be specified. If a CSI service is withdrawn for a subscriber, the corresponding template ID does not need to be specified.
9.201 Check the Subscriber Data Consistency Command Name: CHK CONSY Function: This command is used to check the data consistency for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example:
All rights reserved.
Page 306 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
CHK CONSY: IMSI="111111111111111"; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.202 Modify the SMSCF Service Command Name: MOD SMSCF Function: This command is used to modify the SMS forwarding (SMSCF) service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides the SMSCF service.
OFAID
Numeral
0-65534
TRUE: The HSS9860 provides the SMSCF service.
FALSE: The HSS9860 withdraws the SMSCF service.
OFA template ID
O
Example: MOD SMSCF: IMSI="460000009123456", PROV=TRUE, OFAID=1; MOD SMSCF: IMSI="460000009123456", PROV=FALSE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 307 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMSI and ISDN are mutually exclusive. Specify only one of them.
The parameter OFAID is specified only when the parameter PROV is set to TRUE.
9.203 Active Subscriber’s SMSCF Service Command Name: ACT SMSCF Function: This command is used to activate the SMS forwarding (SMSCF) service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
ACTIVE
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 activates or deactivates the SMSCF service for subscribers.
FTN
Character string
1-16
PROPERTY
Enumerated
TRUE: The HSS9860 activates the SMSCF service.
FALSE: The HSS9860 deactivates the SMSCF service.
Forwarded-to number
C
INTERNATIONAL
Specifies the attribute of the FTN.
C
NATIONAL
INTERNATIONA: The FTN is an international number.
NATIONAL: The FTN is a national number.
Example: ACT SMSCF: IMSI="460000009123456", ACTIVE=TRUE, FTN="86139998898", PROPERTY=INTERNATIONAL; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 308 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter ACTIVE is set to TRUE, the parameters FTN and PROPERTY are mandatory.
9.204 Query the SMSCF Service Command Name: LST SMSCF Function: This command is used to query the SMS forwarding (SMSCF) data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST SMSCF: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {OFATPLID}= {FTN}= {STATUS}= If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.205 Modify the MC Service Command Name: MOD MC Function: This command is used to modify the multi-call (MC) service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
All rights reserved.
Page 309 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
PROV
Boolean
TRUE
FALSE
Summary of CommandsSummary of Commands
Description
Remarks
Specifies whether the HSS9860 provides the MC service.
M
TRUE: The HSS9860 provides the MC service.
FALSE: The HSS9860 withdraws the MC service.
NBRSB
Numeral
2-7
Maximum MC attempts allowed
C
NBRUSER
Numeral
1-7
User determined maximum MC attempts
C
Example: MOD MC: IMSI="460000009123456", PROV=TRUE, NBRSB=3, NBRUSER=3; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter MC is set to FALSE, the parameters NBRSB and NBRUSER do not need to be specified.
The value of the parameter NBRSB is greater than or equal to that of NBRUSER.
9.206 Query the MC Service Command Name: LST MC Function: This command is used to query the multi-call (MC) service data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example:
All rights reserved.
Page 310 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
LST MC: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {MC}= {NBRSB}=< Maximum of MC attempts allowed > {NBRUSER}=< User determined maximum MC attempts > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.207 Modify the IST Service Command Name: MOD IST Function: This command is used to modify the immediate service termination (IST) service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides the IST service.
ISTTIMER
Numeral
15-255
ISTRSP
Enumerated
EMPTY
NEW_ALERT_ TIMER
TERMINATECALLACT IVITYREFERRED
TERMINATEALLCALL ACTIVITIES
TRUE: The HSS9860 provides the IST service.
FALSE: The HSS9860 withdraws the IST service.
Specifies the interval at which the VMSC or GMSC sends the MAP_IST_Alert message.
C
Specifies how the HSS9860 processes a MAP_IST_Alert message.
C
EMPTY: The HSS9860 takes no action.
NEW_ALERT_TIMER: The HSS9860 uses the new scheduled period.
WITHDRAW
All rights reserved.
Page 311 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
TERMINATECALLACTI VITYREFERRED: The HSS9860 terminates the current activity at once.
TERMINATEALLCALLA CTIVITIES: The HSS9860 terminates all the activities at once.
WITHDRAW: The HSS9860 withdraws the IST service.
Example: MOD IST: IMSI="465700000000000", PROV=TRUE, ISTTIMER=20, ISTRSP=EMPTY; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter PROV is set to TRUE, the parameters ISTTIMER and ISTRSP are mandatory for the IST subscription and are optional for the IST modification.
If the parameter PROV is set to FALSE, ISTTIMER and ISTRSP cannot be specified together.
9.208 Query the IST Service Command Name: LST IST Function: This command is used to query the immediate service termination (IST) service data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST IST: IMSI="460000009123456";
All rights reserved.
Page 312 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {IST}= {ISTTIMER}= {ISTRSP}=< EMPTY | NEW_ALERT_TIMER | TERMINATECALLACTIVITYREFERRED | TERMINATEALLCALLACTIVITIES || WITHDRAW > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.209 Send a Command for Immediate Service Termination Command Name: SND ISTCMD Function: This command is used to send a command from the SMU to the VMSC/GMSC, so as to immediately terminate the activities of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
MSCNUM
Character string
1-15
MSC number
O
Example: SND ISTCMD: IMSI="984519856312345",MSCNUM="123456789"; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 313 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.210 Modify the DIC Service Command Name: MOD DIC Function: This command is used to modify the dialing identification code (DIC) service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides the DIC service.
M
DICLENGTH
Enumerated
TRUE: The HSS9860 provides the DIC service.
FALSE: The HSS9860 withdraws the DIC service.
DICR_0-0
Length of the DIC
C
DICR_1-1
DICR_2-2
DICR_3-3
DICR_4-4
DICR_0: The dial identification code (DIC) must be carried for dialing. Otherwise, the call origination fails. There is no restriction on the DIC length.
DICR_5-5
DICR_6-6
DICR_7-7
DICR_8-8
DICR_9-9
DICR_10-10
DICR_11-11
DICR_1 to DICR_16: The DIC must be carried for dialing, and the length of the DIC carried must be the same as the subscribed length, ranging from 1 to 16 digits. If the DIC is not carried or its length is inconsistent with the subscribed length, the call origination fails.
DICR_12-12
DICR_13-13
DICR_14-14
DICV: The call origination is not affected regardless of whether the DIC is carried or not.
DICR_15-15
DICR_16-16
DICV-127
Example: MOD DIC: IMSI="460111111111111", PROV=TRUE, DICLENGTH=DICR_0; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:The operation is successful.
All rights reserved.
Page 314 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter PROV is set to TRUE, the parameter DICLENGTH must be specified.
9.211 Query the DIC Service Command Name: LST DIC Function: This command is used to query the dialing identification code (DIC) service data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST DIC: IMSI="460111111111111"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}=, {ISDN}=, {Provide}= { ACCLENGTH }=< 0-16|127 >
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.212 Modify the Multi-IMSI Service Command Name: MOD MIMSI Function: This command is used to modify the multi-IMSI service for a subscriber. Parameter Description:
All rights reserved.
Page 315 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides the multi-IMSI service.
OPTIONTYPE
MIMSITYPE
Enumerated
Enumerated
ADD
MOD
MultiIMSI
SimultaneousR ing
OrderlyRing
OneLive
TRUE: The HSS9860 provides the multi-IMSI service.
FALSE: The HSS9860 withdraws the multi-IMSI service.
Specifies whether the HSS9860 adds or modifies an auxiliary IMSI.
ADD: The HSS9860 adds an auxiliary IMSI.
MOD: The HSS9860 modifies an auxiliary IMSI.
Specifies how a call is connected for a Multi-IMSI subscriber.
MultiIMSI: The call is first connected to the reachable IMSI with the smallest call sequence number.
SimultaneousRing: The call is simultaneously connected to all the IMSIs. It is connected if it is answered on any IMSI and is disconnected if it is not answered on any IMSI.
OrderlyRing: The call is sequentially connected to the IMSIs based on their call sequence numbers. If the call is not answered on any IMSI, it is connected to the specified voice mailbox.
OneLive: The call is connected to the IMSI whose location information is stored in the HSS9860.
C
C
MIMSI2
Character string
6-15
Auxiliary IMSI2
C
CALL_INDEX2
Numeral
1-9
Call sequence of IMSI2
C
MIMSI3
Character string
6-15
Auxiliary IMSI3
C
CALL_INDEX3
Numeral
1-9
Call sequence of IMSI3
C
MIMSI4
Character string
6-15
Auxiliary IMSI4
C
CALL_INDEX4
Numeral
1-9
Call sequence of IMSI4
C
All rights reserved.
Page 316 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
MIMSI5
Character string
6-15
Auxiliary IMSI5
C
CALL_INDEX5
Numeral
1-9
Call sequence of IMSI5
C
MIMSI6
Character string
6-15
Auxiliary IMSI6
C
CALL_INDEX6
Numeral
1-9
Call sequence of IMSI6
C
MIMSI7
Character string
6-15
Auxiliary IMSI7
C
CALL_INDEX7
Numeral
1-9
Call sequence of IMSI7
C
MIMSI8
Character string
6-15
Auxiliary IMSI8
C
CALL_INDEX8
Numeral
1-9
Call sequence of IMSI8
C
MIMSI9
Character string
6-15
Auxiliary IMSI9
C
CALL_INDEX9
Numeral
1-9
Call sequence of IMSI9
C
MIMSI_SMS
Numeral
1-9
Specifies the IMSI which receives short messages.
C
MIMSI_VOBB
Numeral
0-9
VOBB card
C
Example: MOD MIMSI: IMSI="460111111111111", PROV=TRUE, OPTIONTYPE=ADD, MIMSITYPE=MultiIMSI, IMSI2="460222222222222", CALL_INDEX2=3; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:The operation is successful.
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.213 Query the Multi-IMSI Service Command Name: LST MIMSI Function: This command is used to query the multi-IMSI service data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
All rights reserved.
Page 317 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
C
Example: LST MIMSI: IMSI="460111111111111"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {CALL_INDEX}=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 > {MULTIIMSI}= {IMSI2}= {CALL_INDEX}=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {IMSI3= {CALL_INDEX} =< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {IMSI4}= {CALL_INDEX}=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {IMSI5}= {CALL_INDEX}=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {IMSI6}= {CALL_INDEX} =< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {IMSI7}= {CALL_INDEX }= < 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {IMSI8}= {CALL_INDEX }= < 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {IMSI9}= {CALL_INDEX }= < 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9> {VOICENUMBER1}=< Voice number 1> {VOICE_INDEX}=< 1 | 2 > {VOICENUMBER2}=< Voice number 2> {VOICE_INDEX}=< 1 | 2 > {MIMSI_SMS}=< 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 > {MIMSI_VOBB}=< 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 >
All rights reserved.
Page 318 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{MIMSITYPE}=< MultiIMSI | SimultaneouslyRing| OrderlyRing |OneLive > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.214 Modify the ROUTECATEGORY Service Command Name: MOD ROUTECATEGORY Function: This command is used to modify the enhanced routing service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides the enhanced routing service.
M
ROUTECATEGORY
Numeral
1-255
TRUE: The HSS9860 provides the enhanced routing service.
FALSE: The HSS9860 withdraws the enhanced routing service.
Specifies the index of the enhanced routing service.
C
Example: MOD ROUTECATEGORY: IMSI="460000009123456", PROV=TRUE, ROUTECATEGORY=4; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:The operation is successful.
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.215 Query the ROUTECATEGORY Service Command Name: LST ROUTECATEGORY
All rights reserved.
Page 319 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to query the enhanced routing service data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST ROUTECATEGORY: IMSI="460100008001001"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {ROUTECATEGORY}=< 1 - 255 > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.216 Modify the Expand Enhanced Routing Service Command Name: MOD EXEXROUTECATEGORY Function: This command is used to modify the expand enhanced routing service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides the expand enhanced routing service.
M
EXEXROUTE CATEGORY
Numeral
1-2147483647
TRUE: The HSS9860 provides the expand enhanced routing service.
FALSE: The HSS9860 withdraws the expand enhanced routing service.
Specifies the index of the expand enhanced routing service.
All rights reserved.
C
Page 320 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: MOD EXEXROUTECATEGORY: IMSI="460000009123456", PROV=TRUE, EXEXROUTECATEGORY=4; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:The operation is successful.
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.217 Query the Expand Enhanced Routing Service Command Name: LST EXEXROUTECATEGORY Function: This command is used to query the expand enhanced routing service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST EXEXROUTECATEGORY: IMSI="460100008001001"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= < MSISDN number> { EXEXROUTECATEGORY }=< 1 ~ 2147483647 > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.218 Modify the Multi-IMSI Voice Mail Service Command Name: MOD MIMSIVM
All rights reserved.
Page 321 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to modify the voice mail service for a multi-IMSI subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides the voice mailbox service.
TRUE: The HSS9860 provides the voice mailbox service.
FALSE: The HSS9860 withdraws the voice mailbox service.
VOICENUMBER
Character string
1-15
Voice mailbox number
C
VOICE_INDEX
Numeral
1-2
Specifies the sequence in which a call is forwarded to a voice mailbox.
C
Example: MOD MIMSIVM: IMSI="460000009123456", PROV=TRUE, VOICENUMBER="86123456", VOICE_INDEX=1; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:The operation is successful.
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.219 Query the Multi-IMSI Voice Mail Service Command Name: LST MIMSIVM Function: This command is used to query the voice mail service data of a multi-IMSI subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
All rights reserved.
Page 322 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: LST MIMSIVM: IMSI="460100008001001"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}=
{ISDN}= {VOICENUMBER1}=< Voice number 1> {VOICE_INDEX}=< 1 | 2 > {VOICENUMBER2}=< Voice number 2> {VOICE_INDEX}=< 1 | 2 > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.220 Modify the Call Redirection Service Command Name: MOD CR Function: This command is used to modify the call redirection (CR) service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides the CR service.
C
CALLREDIRECT
Numeral
0-255
TRUE: The HSS9860 provides the CR service.
FALSE: The HSS9860 withdraws the CR service.
Call redirection category
C
Example: MOD CR: IMSI="460100008001001", PROV=TRUE, CALLREDIRECT=23; Output: If the operation succeeds, the system displays one of the following messages:
All rights reserved.
Page 323 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:The operation is successful.
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.221 Query the Call Redirection Service Command Name: LST CR Function: This command is used to query the call redirection (CR) service data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST CR: IMSI="460100008001001"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {CALLREDIRECT}=< 0 - 255 | "NOTPROV" > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.222 Modify the NRBT Service Command Name: MOD NRBT Function: This command is used to provide or withdraw the national ring back tone (NRBT) service for a subscriber. Parameter Description:
All rights reserved.
Page 324 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
C
FALSE
Specifies whether the HSS9860 provides the NRBT service.
NRBT
Numeral
1-65535
ALSNRBTP ROV
Boolean
TRUE
FALSE
ALSNRBT
Numeral
1-65535
ARBTPROV
Boolean
TRUE
FALSE
ARBT
Numeral
1-65535
TRUE: The HSS9860 provides the NRBT service.
FALSE: The HSS9860 withdraws the NRBT service.
INAP index for the NRBT service
C
Specifies whether the HSS9860 provides the ALS NRBT service.
C
TRUE: The HSS9860 provides the ALS NRBT service.
FALSE: The HSS9860 withdraws the ALS NRBT service.
NRBT index for the ALS auxiliary number
C
Specifies whether the HSS9860 provides the ALS NRBT service.
C
TRUE: The HSS9860 provides the ALS NRBT service.
FALSE: The HSS9860 withdraws the ALS NRBT service.
INDEX for ARBT
C
Example: MOD NRBT: IMSI="444441234567890",PROV=TRUE,NRBT=600; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 325 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMSI and ISDN are mutually exclusive. Specify only one of them.
This command only applies to the subscriber whose NAM is BOTH or MSC.
If the parameter PROV is set to FALSE, this command is used to withdraw the NRBT service.
If the parameter PROV is set to TRUE, this command is used to provide the NRBT service.
9.223 Query the NRBT Service Command Name: LST NRBT Function: This command is used to query the national ring back tone (NRBT) service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST NRBT: IMSI="444441234567890"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}=< IMSI Number >, {ISDN}=< MSISDN Number >, {NRBT}= {NRBTIndex}=< INAP INDEX for National Ring Back Tone service> {ARBT}= {ARBTIndex}=< INDEX for ARBT> If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
This command is only applicable to the subscriber whose NAM is BOTH, MSC, or NONE.
9.224 Modify the Optimized GPRS/EPS Data Command Name: MOD OPTGPRS Function: This command is used to modify the optimized GPRS data.
All rights reserved.
Page 326 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PRIORITY_LEV EL
Enumerated
LOW
Precedence class
C
HIGH
PROV
Enumerated
ADDPDPCNTX
Specifies the type of operation.
M
MODPDPCNTX
RMVPDPCNTX
ADDPDPCNTX: add a PDP/PDN context
RMVALLCNTX
MODGLOBALCH ARING
MODPDPCNTX: modify a PDP/PDN context
RMVPDPCNTX: delete a PDP/PDN context
RMVALLCNTX: withdraw the GPRS service
MODGLOBALCHARING: modify the global charging characteristic
CNTXID
Numeral
1-50
APN_TYPE
Enumerated
PS_APN
EPS_APN
BOTH
APNTPLID
Numeral
0-65534
DEFAULTCFGF LAG
Boolean
TRUE
FALSE
QOSTPLID
Numeral
0-65534
All rights reserved.
PDP/PDN context ID
C
Specifies the type of an access point name (APN).
C
PS_APN: The APN belongs to the packet switched (PS) domain
EPS_APN: The APN belongs to the evolved packet system (EPS).
BOTH: The APN belongs to both the PS domain and the EPS.
APN template ID
C
Specifies whether the HSS9860 configures the template identified by APNTPLID as the default EPS APN template.
C
TRUE: The HSS9860 configures the template identified by APNTPLID as the default template.
FALSE: The HSS9860 does not configure the template identified by APNTPLID as the default template.
QoS template ID
C
Page 327 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
EPS_QOSTPLID
Numeral
0-65534
EPS QoS template ID
C
PDPTYPE
Enumerated
X25
C
PPP
Specifies the type of a data service.
OCSIHOSS
IPV4
IPV6
IPV4IPV6
IPV4_OR_IPV6
STATIC DYNAMIC
Specifies a static or dynamic address of PDP/PDN.
C
ADDIND
Enumerated
PDPADD
Character string
0-40
ADD2IND
Enumerated
STATIC
DYNAMIC
PDPADDIPV4
Character string
7-15
VPLMN
Boolean
TRUE
FALSE
CHARGE
Enumerated
NONE
HOT
FLAT
PREPAID
All rights reserved.
STATIC: a static PDP/PDN address
DYNAMIC: a dynamic PDP/PDN address
PDP/PDN address
C
Specifies a static or dynamic IPv4 address of PDP/PDN.
C
STATIC: a static PDP/PDN IPv4 address
DYNAMIC: a dynamic PDP/PDN IPv4 address
PDP/PDN IPv4 address
C
Specifies whether a subscriber is allowed to access the public data network (PDP/PDN) through the VPLMN.
C
TRUE: The subscriber is allowed to access the PDP/PDN through the VPLMN.
FALSE: The subscriber is not allowed to access the PDP/PDN through the VPLMN, but is allowed to access the PDP/PDN through the HPLMN.
Specifies the charging feature that is applicable to each PDP/PDN type.
C
NONE: disable the settings on global charging
Page 328 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
NORMAL
10
11
12
13
14
15
16-254
Description
Remarks
characteristics
3
HOT: hot billing charging
5
FLAT: flat rate charging
6
PREPAID: prepaid charging
7
NORMAL: normal charging
9
3: hot billing charging and flat rate charging
5: hot billing charging and prepaid charging
6: flat rate charging and prepaid charging
7: hot billing charging, flat rate charging, and prepaid charging
9: hot billing charging and normal charging
10: flat rate charging and normal charging
11: hot billing charging, flat rate charging, and normal charging
12: prepaid charging and normal charging
13: hot billing charging, prepaid charging, and normal charging
14: flat rate charging, prepaid charging, and normal charging
15: hot billing charging, flat rate
16-254: customized global charging characteristic
STDCHARGE
Character string
"0000"-"FFFF"
CHARGE_GLO BAL
Enumerated
NONE
HOT
FLAT
PREPAID
NORMAL
Specifies the standard charging feature that is applicable to all PDP/PDN types.
C
Specifies the charging feature that is applicable to all PDP types.
C
NONE: disable the settings on global charging characteristics
3
HOT: hot billing charging
5
FLAT: flat rate charging
All rights reserved.
Page 329 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
6
PREPAID: prepaid charging
7
NORMAL: normal charging
9
10
3: hot billing charging and flat rate charging
11
12
5: hot billing charging and prepaid charging
13
6: flat rate charging and prepaid charging
14
15
16-254:
7: hot billing charging, flat rate charging, and prepaid charging
9: hot billing charging and normal charging
10: flat rate charging and normal charging
11: hot billing charging, flat rate charging, and normal charging
12: prepaid charging and normal charging
13: hot billing charging, prepaid charging, and normal charging
14: flat rate charging, prepaid charging, and normal charging
15: hot billing charging, flat rate
16-254: customized global charging characteristic
SCHARGE_GL OBAL
Character string
"0000"-"FFFF"
PROVAPNOI
Boolean
TRUE
FALSE
Specifies the standard charging feature that is applicable to all PDP/PDN types.
C
Specifies whether the HSS9860 provides the APN-OI template to subscribers.
C
TRUE: The HSS9860 provides the APN-OI template to subscribers.
FALSE: - When PROV is set to ADDPDPCNTX, the HSS9860 does not provide an APN-OI template to subscribers.
All rights reserved.
Page 330 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
- When PROV is set to MODPDPCNTX, the HSS9860 unsubscribes the APN-OI template from subscribers. APNOITPLID
Numeral
0-65534
APN operator identifier template ID
C
APN
Character string
1-63
Access point name
C
Example: MOD OPTGPRS: IMSI="123456789012345", PROV=ADDPDPCNTX, CNTXID=1, APNTPLID=3, QOSTPLID=3, PDPTYPE=IPV4,ADDIND=STATIC, PDPADD="10.64.12.11", VPLMN=TRUE, CHARGE=HOT", PROVAPNOI=TRUE, APNOITPLID=1; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 331 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter APN_TYPE is set to PS_APN or BOTH, the parameter QOSTPLID is mandatory.
If the parameter APN_TYPE is set to EPS_APN or BOTH, the parameter EPS_QOSTPLID is mandatory.
If the parameter ADDIND is set to STATIC and the parameter PDPTYPE is set to IPV4, one of the parameters PDPADD or PDPADDV4 must be specified and their values must be an IPV4 address.
If the parameter ADDIND is set to STATIC and the parameter PDPTYPE is set to IPV6, the parameter PDPADD must be specified and its value must be an IPv6 address. The parameter PDPADDV4 does not need to be specified.
If the parameter ADDIND is set to STATIC and the parameter PDPTYPE is set to IPV4IPV6, the parameter PDPADD must be specified and its value must be an IPv6 address.
If the parameter ADD2IND is set to STATIC and the parameter PDPTYPE is set to IPV4IPV6, the parameter PDPADDIPv4 must be specified and its value must be an IPv4 address.
If the parameter ADDIND is set to STATIC and the parameter PDPTYPE is set to IPv4_OR_IPv6, either or both of the parameters PDPADD and PDPADDV4 must be specified. The value of PDPADD must be an IPv6 address and the value of PDPADDV4 must be an IPv4 address.
If the parameter ADDIND is set to STATIC and the parameter PDPTYPE is set to IPV4_OR_IPV6, the parameter PDPADD must be specified and its value must be an IPv6 address.
If the parameter ADD2IND is set to STATIC and the parameter PDPTYPE is set to IPV4_OR_IPV6, the parameter PDPADDIPv4 must be specified and its value must be an IPv4 address.
If the parameter ADDIND is set to DYNAMIC, the parameter PDPADD does not need to be specified.
If the parameter ADD2IND is set to DYNAMIC, the parameter PDPADDV4 does not need to be specified.
Only one of the CHARGE and STDCHARGE must be specified.
Only one of the CHARGE_GLOBAL and SCHARGE_GLOBAL must be specified.
If the parameter PROVAPNOI is set to TRUE, the parameter APNOITPLID must be specified.
The parameters APNTPLID and APN are mutually exclusive. Specify only one of them.
9.225 Query the Optimized GPRS Data Command Name: LST OPTGPRS Function: This command is used to query the optimized GPRS data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST OPTGPRS: IMSI="444441234567890"; Output:
All rights reserved.
Page 332 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays an output with the following format: {IMSI}= {MSISDN}= {CHARGE_GLOBAL}=< NONE | HOT| FLAT | PREPAID | NORMAL| 3 | 5 | 6 | 7 | 9 | … | 254 > {SCHARGE_GLOBAL}= {TPLID}=< 0-65534> {CNTXID }=< 0-50> {APN_TYPE}=< PS_APN | EPS_APN | BOTH > {APNTPLID}=< 0-65534> {DEFAULTCFGFLAG}=< TRUE|FALSE> {QOSTPLID}=< 0-254> {EPS_QOSTPLID}=< 0-65534> {PDPTYPE}=< X25 | PPP | OCSIHOSS | IPV4 | IPV6 | IPV4IPV6 | IPV4_OR_IPV6 > { PDPADD }=< PDP Address1> {PDPADDIPV4}=< PDP IPV4 Address> { VPLMN }=< TRUE|FALSE> {CHARGE }=< NONE | HOT| FLAT | PREPAID | NORMAL | 3 | 5 | 6 | 7 | 9 | … | 254 > {STDCHARGE }= {CNTXID }=< 0-50> ........... "Binding OptGprsTpl Data" {HLRSN}=< HLR Serial No in the redundant HLR center > {TPLID}=< 0-65534> {TPLNAME}=< OptGprs Template Name> {CNTXID }=< 0-50> {APNTYPE}=< PS_APN | EPS_APN| BOTH> {APNTPLID}=< 0-65534> {DEFAULTCFGFLAG}=< TRUE | FALSE> {WILDCARDFLAG}=< TRUE | FALSE> {QOSTPLID}=< 0-65534> {EPSQOSTPLID}=< 0-65534> {VPLMN }=< TRUE | FALSE> {PDPTYPE}=< X25 | PPP | OCSIHOSS | IPV4 | IPV6 | IPV4IPV6 | IPV4_OR_IPV6 >
All rights reserved.
Page 333 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{CHARGE }=< NONE | HOT| FLAT | PREPAID | NORMAL | 3 | 5 | 6 | 7 | 9 | … | 254 > {STDCHARGE}=< Standard Charge> If the operation fails, the system displays an error code. For details on the above error codes, see 11"Summary of Error Codes."
This command only applies to the subscriber whose NAM is BOTH, MSC, or NONE.
IMSI and ISDN are mutually exclusive. Specify only one of them.
9.226 Modify the Optimized GPRS by a Template Command Name: MOD TPLOPTGPRS Function: This command is used to provide, modify, or withdraw the GPRS services for subscribers using an optimized GPRS template. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides, modifies, or withdraws the optimized GPRS/EPS service.
TPLID
Numeral
0-65534
DELOLD
Boolean
TRUE
FALSE
TRUE: The HSS9860 provides or modifies the optimized GPRS/EPS services.
FALSE: The HSS9860 withdraws the optimized GPRS/EPS services.
Optimized GPRS template ID
C
Specifies whether the HSS9860 deletes the APN that is already configured.
C
TRUE: The HSS9860 deletes the APN that is already configured.
FALSE: The HSS9860 does not delete the APN that is already configured.
Example: MOD TPLOPTGPRS: IMSI="460000009123456", PROV=TRUE, TPLID=2; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
All rights reserved.
Page 334 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
9.227 Modify Multi-Number User Group Services Command Name: MOD MNUG Function: This command is used to provide or withdraw the multi-number user group services. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Enumerated
TRUE/FALSE
Specifies whether the HSS9860 adds or deletes a member MSISDN.
M
GTYPE
Enumerated
MISDN
EIMSI
TRUE: The HSS9860 adds a member MSISDN.
FALSE: The HSS9860 deletes a member MSISDN.
Specifies the type of multi-number subscriber group.
C
MISDN: multi-MSISDN multi-profile subscriber group
EIMSI: LINKED SIM subscriber group
SIMSI
Character string
6-15
IMSI number
C
SISDN
Character string
1-15
MSISDN number
C
TCR
Enumerated
PCALL NCALL
Specifies whether a member MSISDN can receive calls or short messages.
C
ACTISDN
Enumerated
TRUE
NONE
PCALL: A member MSISDN can receive calls or short messages.
NCALL: A member MSISDN cannot receive calls or short messages.
Specifies whether the HSS9860 activates the member MSISDN.
C
TRUE: The HSS9860 activates a member MSISDN.
NONE: The HSS9860 does not activate a member MSISDN.
All rights reserved.
Page 335 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: MOD MNUG: IMSI="460000009012345", PROV=TRUE, GTYPE=EIMSI, SIMSI="460000000912345"; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are the data of subscriber A. The two parameters are mutually exclusive. Specify only one of them.
The parameters SIMSI and SISDN are the data of subscriber B. The two parameters are mutually exclusive. Specify only one of them.
If PROV is set to TRUE, specify GTYPE and SIMSI (or SISDN). SIMSI and SISDN are mutually exclusive. Specify only one of them. If PROV is set to FALSE, do not specify GTYPE.
If GTYPE is set to MISDN, specify TCR and ACTISDN.
9.228 List Multi-Number User Group Services Command Name: LST MNUG Function: This command is used to query the service data of the multi-number user group services. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST MNUG: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}=< IMSI number > {LISDN}=< MSISDN number > {GTYPE}=< EIMSI > {ACTIVE}=< Active MSISDN number > {SISDN}=< MSISDN number >
All rights reserved.
Page 336 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
"Member Number"
Summary of CommandsSummary of Commands
"TCR"
"ID"
{MSISDN number} + { PCALL | NCALL} + {1-9} If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are mutually exclusive. Specify only one of them.
The Member Number, TCR, and ID parameters are displayed in the command output only for multi-MSISDN multi-profile subscribers.
9.229 Modify the CCBS Service Command Name: MOD CCBS Function: This command is used to provide or withdraw the completion of calls to busy subscriber (CCBS) service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
CCBS
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides the CCBS service.
C
CCBSTARGET
Boolean
TRUE
FALSE
TRUE: The HSS9860 provides the CCBS service.
FALSE: The HSS9860 withdraws the CCBS service.
Specifies whether the HSS9860 provides the CCBS target service.
TRUE: The HSS9860 provides the CCBS target service.
FALSE: The HSS9860 withdraws the CCBS target service.
C
Example: MOD CCBS: IMSI="460000009123456", CCBS=TRUE, CCBSTARGET=TRUE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 337 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
This command only applies to the subscriber whose NAM is BOTH, MSC, or NONE.
IMSI and ISDN are mutually exclusive. Specify only one of them.
9.230 Query the CCBS Service Command Name: LST CCBS Function: This command is used to query the completion of calls to busy subscriber (CCBS)service data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST CCBS: IMSI="460000009012345"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= < MSISDN number> {CCBS}=< PROV| NOTPROV > {CCBSTARGET}=< PROV| NOTPROV > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
This command only applies to the subscriber whose NAM is BOTH, MSC, or NONE.
IMSI and ISDN are mutually exclusive. Specify only one of them.
9.231 Modify CSI STATE Command Name: MOD CSISTATE Function: This command is used to modify the CAMEL subscription information (CSI) state. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
All rights reserved.
Page 338 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
C
CSITYPE
Enumerated
MCSI
CSI type
M
CSISTATE
Boolean
TRUE
Specifies the CSI state.
M
FALSE
TRUE: The CSI state is active.
FALSE: The CSI state is inactive.
Example: MOD CSISTATE: IMSI="4600000000000", CSITYPE=MCSI, CSISTATE=TRUE; Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.232 Modify Subscription Data of ACR Command Name: MOD ACR Function: This command is used to modify the subscription service for the anonymous call rejection (ACR) service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Enumerated
TRUE
M
FALSE
Specifies whether the HSS9860 provides the ACR service.
TRUE: The HSS9860 provides the ACR service.
FALSE: The HSS9860 withdraws the ACR service.
Example: MOD ACR: IMSI="444441234567890",PROV=TRUE;
All rights reserved.
Page 339 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.233 Query Subscription Data of ACR Command Name: LST ACR Function: This command is used to query the subscription service data of the anonymous call rejection (ACR) service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST ACR: IMSI="444441234567890"; Output If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {STATUS}= If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.234 Activate ACR Command Name: ACT ACR Function: This command is used to activate the anonymous call rejection (ACR) service. Parameter Description:
All rights reserved.
Page 340 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: ACT ACR: IMSI="444441234567890"; Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
9.235 Deactivate ACR Command Name: DEA ACR Function: This command is used to deactivate the anonymous call rejection (ACR) service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: DEA ACR: IMSI="444441234567890"; Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 341 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.236 Add the IMSI-Specific Routing Data Command Name: ADD IMSIRTSUB Function: This command is used to map subscribers' IMSIs to HLRs in the independent authentication center. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
HLRSN
Numeral
1-255
HLR serial number
M
Example: ADD IMSIRTSUB: IMSI="123456", HLRSN="222"; Output If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." None.
9.237 Modify the IMSI-Specific Routing Data Command Name: MOD IMSIRTSUB Function: This command is used to modify the mappings between IMSIs and HLRs in the independent authentication center to enable the independent AuC to forward requests to another HLR. Parameter Description: Name
Type
Range
Description
Remark
IMSI
Character string
6-15
IMSI number
C
HLRSN
Numeral
1-255
HLR serial number
C
Example: MOD IMSIRTSUB: IMSI="123456", HLRSN="222"; Output If the operation succeeds, the system displays one of the following messages:
All rights reserved.
Page 342 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." None.
9.238 Query the IMSI-Specific Routing Data Command Name: LST IMSIRTSUB Function: This command is used to query the mappings between IMSIs and HLRs in the independent authentication center. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
Example: LST IMSIRTSUB: IMSI="123456"; Output If the operation succeeds, the system displays an output with the following format: {IMSI}=, {HLRSN}=< HLR Serial No in the redundant HLR center > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." None.
9.239 Remove the IMSI-Specific Routing Data Command Name: RMV IMSIRTSUB Function: This command is used to delete the mappings between IMSIs and HLRs in the independent authentication center. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
All rights reserved.
Page 343 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: RMV IMSIRTSUB: IMSI="123456"; Output If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." None.
9.240 Add the NPOTHERRPT Data Command Name: ADD NPOTHERRPT Function: This command is used to add a subscriber who ports the number between other networks. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
C
RN
Character string
1-10
Routing number
M
MSCID
Character string
1-15
MSC ID
C
Example: ADD NPOTHERRPT: ISDN="86131075003002", RN="1112"; Output If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameter MSCID is optional. If the target network use number portability (NP), the parameter MSCID is mandatory.
9.241 Remove the NPOTHERRPT Data Command Name: RMV NPOTHERRPT
All rights reserved.
Page 344 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to delete the data of a subscriber who ports the number between other networks. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
C
Example: RMV NPOTHERRPT: ISDN="86131075003002"; Output If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." None.
9.242 Modify the NPOTHERRPT Data Command Name: MOD NPOTHERRPT Function: This command is used to modify the data of a subscriber who ports the number between other networks. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
C
RN
Character string
1-10
Routing number
C
MSCID
Character string
1-15
MSC ID
C
Example: MOD NPOTHERRPT: ISDN="86131075003003", RN="1113"; Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 345 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The parameters RN and MSCID are optional. One of them must be specified.
9.243 Query the NPOTHERRPT Data Command Name: LST NPOTHERRPT Function: This command is used to query the data of a subscriber who ports the number between other networks. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
M
Example: { ISDN }=< ISDN Number>, { RN }=< RN >, { MSCID }=< MSCID > Output If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." None.
9.244 Add the NPDONORSUB Data Command Name: ADD NPDONORSUB Function: This command is used to add a ported-out subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
RN
Character string
1-10
Routing number
M
MSCNUM
Character string
1-15
MSC number
C
All rights reserved.
Page 346 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: ADD NPDONORSUB: IMSI="4601075003001",ISDN="86131075003001", RN="1112"; Output If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI and ISDN are optional. Specify only one of the them.
When you add a ported-out subscriber, specify the parameters of IMSI and ISDN. The parameter ISDN is mandatory, and IMSI is optional.
9.245 Modify the NPDONORSUB Data Command Name: MOD NPDONORSUB Function: This command is used to modify the data of a ported-out subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
RN
Character string
1-10
Routing number
C
MSCNUM
Character string
1-15
MSC number
C
Example: MOD NPDONORSUB: IMSI="460000009012345", RN="1113"; Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
All rights reserved.
Page 347 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.246 Remove the NPDONORSUB Data Command Name: RMV NPDONORSUB Function: This command is used to delete the data of a ported-out subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: RMV NPDONORSUB: ISDN="86138075003001"; Output If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
9.247 Query the NPDONORSUB Data Command Name: LST NPDONORSUB Function: This command is used to query the service data of a ported-out subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST NPDONORSUB: IMSI="460000009012345"; Output If the operation succeeds, the system displays an output with the following format: { IMSI }=< IMSI Number>, { ISDN }=< ISDN Number>,
All rights reserved.
Page 348 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{ RN }=< RN >, { HLRNUM }=< HLRNUM > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are mutually exclusive. Specify only one of the them.
9.248 Modify the SMSROUTE Data Command Name: MOD SMSROUTE Function: This command is used to modify the short message service rerouting (SMS_ROUTE) template ID. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides the SMS_ROUTE service.
M
TPLID
Numeral
0-254
TRUE: The HSS9860 provides the SMS_ROUTE service.
FALSE: The HSS9860 withdraws the SMS_ROUTE service.
SMS-ROUTE template ID
C
Example: MOD SMSROUTE: IMSI="460000009123456", PROV=TRUE, TPLID=4;
Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
All rights reserved.
Page 349 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.249 Query the SMSROUTE Data Command Name: LST SMSROUTE Function: This command is used to query the SMS_Route template ID. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST SMSROUTE: IMSI="460000009123456";
Output If the operation succeeds, the system displays an output with the following format: { IMSI }=< IMSI Number>, { ISDN }=< ISDN Number>, { TPLID }=< SMS-ROUTE template ID > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
9.250 Activating the CFD Service Command Name: ACT CFD Function: Use this command to activate the CFD service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
BSG
Enumerated
ALL
Specifies the basic service group of BAIC service.
C
TS1X
TS6X
ALL: all applicable services (TS1X, TS6X, BS2X, BS3X, and TSDX)
BS2X
TS1X: telephony service
BS3X
TS6X: facsimile service group
TSDX
BS2X: asynchronous bearer service
All rights reserved.
Page 350 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
Summary of CommandsSummary of Commands
Description
BS3X: synchronous bearer service
TSDX: custom supplementary service
Remarks
Example: ACT CFD: IMSI="460000009123456";
Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of them.
9.251 Deactivating the CFD Service Command Name: DEA CFD Function: Use this command to deactivate the CFD service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
BSG
Enumerated
ALL
C
TS1X
Specifies the basic service group of CFD service to be deactivated.
TS6X
BS2X
BS3X
TSDX
ALL: all applicable services (TS1X, TS6X, BS2X, BS3X, and TSDX)
TS1X: telephony service
TS6X: facsimile service group
BS2X: asynchronous bearer service
BS3X: synchronous bearer service
TSDX: custom supplementary service
Example: DEA CFD: IMSI="460000009123456"; Output
All rights reserved.
Page 351 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
9.252 Send a Simulative UpdateLocation Message Command Name: SND UPL Function: Use this command to send a simulative UpdateLocation message . Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN
C
Example: SND UPL: ISDN="86131075003003"; Output: If the operation succeeds, the following success code is displayed: SUCCESS0001:Operation is successful If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes."
9.253 Send a Reset Update Location Message Command Name: RST UPL Function: Use this command to send a Reset Update Location message to the NPMSC for the NPMSC to update the location information about a subscriber. Parameter Description: N/A Example: RST UPL:; Output: If the operation succeeds, the following success code is displayed:
All rights reserved.
Page 352 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes."
9.254 Activate the Auxiliary MSISDN Command Name: ACT ISDN Function: The Activating Auxiliary Number service allows the system to activate the auxiliary MSISDN of a specified subscriber to the main MSISDN and change the original main MSISDN to an auxiliary MSISDN. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN
C
Example: ACT ISDN: ISDN="13516888888"; Output: If the operation succeeds, the following success code is displayed: SUCCESS0001:Operation is successful If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes."
The MSISDN is an auxiliary number of a subscriber.
The MSISDN to be activated cannot be an ALS or VVDN number.
9.255 Modify the NSMSIN Command Name: MOD NSMSIN Function: Use this command to provide or withdraw the Short Message Intelligent (NSMSIN) service,or modify the NSN Short Message Intelligent (NSMSIN) service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
SMSINPROV
Boolean
TRUE
M
FALSE
Whether to provide or withdraw NSMSIN service
All rights reserved.
Page 353 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
SCPADD
Character string
1-15
Service control point address
C
SKEY
Numeral
0-2147483647
NSMSIN Service Key
C
DP
Enumeration
MO
Detecting point
MT
SR
When the service is provided for the subscriber and SMSINPROV is set to TRUE, this parameter is mandatory. When the service is modified for the subscriber and SMSINPROV is set to TRUE, this parameter is optional.
TRUE FALSE
Triggering all multiple messages
C
TRUE
C
FALSE
Whether to active or deactive NSMSINservice.
TAMM ACT
Boolean Boolean
Example: MOD NSMSIN: IMSI="460000009123456", SMSINPROV=TRUE, SCPADD="8613911111", SKEY=1, DP=MO, TAMM=TRUE, ACT= TRUE; Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
9.256 List the NSMSIN Command Name: LST NSMSIN Function: Use this command to query the NSN Short Message Intelligent (NSMSIN) service data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
All rights reserved.
Page 354 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN
C
Example: LST NSMSIN: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= { SCPADD}=< SCPADD >, { SKEY}=< 0-2147483647> { DP}=< "MO"|"MT"|"SR"> { TAMM}=< TRUE|FALSE > { STATUS }=< NOTPROV|PROV|ACT > If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of them.
9.257 Modifythe COMISDN Service Command Name: MOD COMISDN Function: Use this command to provide or withdraw the COMISDN service or modify the COMISDN service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE
Provide COMISDN
M
FALSE COMISDN
C
COMISDN override enable
C
Activation for MT
C
COMISDN
Character string
1-15
OVERIDE
Boolean
TRUE
FALSE
TRUE
ACTMT
Boolean
All rights reserved.
Page 355 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
ORDER
Summary of CommandsSummary of Commands
Numeral
Description
Remarks
Order of an enhanced multiSIM subscriber
C
FALSE
2-100
Example: MOD COMISDN: IMSI="460000009123456", PROV=TRUE, COMISDN="460000001111111", OVERIDE=TRUE; Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
9.258 List the COMISDN Service Command Name: LST COMISDN Function: Use this command to query the COMISDN service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST COMISDN: IMSI="460000009012345"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= { COMISDN}=< COMISDN Number >, { OVERIDE}=< TRUE/FALSE >
All rights reserved.
Page 356 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of them.
9.259 List the OWNISDN Command Name: LST OWNISDN Function: Use this command to query all the own MSISDNs in a common MSISDN group. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST OWNISDN: ISDN="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: { IMSI }=< IMSI Number>, { MSISDN }=< MSISDN Number>, { OWNISDN }=< OWNISDN Number >, If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of them.
9.260 Modify the Default OFA Service Command Name: MOD DEFAULTOFA Function: Use this command to set or withdraw the ofa template for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
All rights reserved.
Page 357 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
DEFAULTOFA_ID
Numeral
0-65534
Default OFA template ID
M
Example: MOD DEFAULTOFA: IMSI="460035589300001", DEFAULTOFA_ID=8; Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
9.261 Listing the Default OFA Service Command Name: LST DEFAULTOFA Function: Use this command to query the COMISDN service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST DEFAULTOFA: IMSI="460035589300001"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= { DEFAULTOFA_ID}=< 0-65534 >, If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of them.
All rights reserved.
Page 358 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.262 Modify the CPP Service Command Name: MOD CPP Function: Use this command to set or withdraw the CPP service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE FALSE
To provide or withdraw the CPP service
M
Example: MOD CPP: IMSI="460035589300001", PROV=TRUE; Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
9.263 List the CPP Service Command Name: LST CPP Function: Use this command to query the CPP service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST CPP: IMSI="460035589300001"; Output:
All rights reserved.
Page 359 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= { CPP}=< PROV|NOTPROV >, If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.264 Modify the NIR Service Command Name: MOD NIR Function: Use this command to provide or withdraw the Network Info of Region (NIR) service for or from subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
RECORDCOUNT
Numeral
1-100000
Number of subscribers
C
IMSIFILE
Character string
1-16
Name of IMSI file
C
ISDNFILE
Character string
1-16
Name of MSISDN file
C
PROV
Boolean
TRUE
Provide NIR
M
NIR index
C
FALSE NIR
Numeral
0-999
Example:
Provide the NIR service for the subscriber whose IMSI is 460000009123456 with NIR index set to 22. MOD NIR: IMSI="460000009123456", PROV=TRUE, NIR=22;
Withdraw the NIR service from the subscriber whose IMSI is 460000009123456. MOD NIR: IMSI="460000009123456", PROV=FALSE;
Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
All rights reserved.
Page 360 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of them.
9.265 List the NIR Service Command Name: LST NIR Function: Use this command to query the subscription of the NIR service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
RECORDCOUNT
Numeral
1-100000
Number of subscribers
C
IMSIFILE
Character string
1-16
Name of IMSI file
C
ISDNFILE
Character string
1-16
Name of MSISDN file
C
Example: Query whether the NIR service is provided for the subscriber whose IMSI is 460000009123456. LST NIR: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: { IMSI }=< IMSI Number>, { ISDN }=< ISDN Number>, {NIR}=< PROV|NOTPROV > {NIRIndex}= If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of them.
9.266 Modify the ELCS Service Command Name: MOD ELCS
All rights reserved.
Page 361 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: Use this command to set or withdraw the ELCS service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE
M
FALSE
To provide or withdraw the ELCS service
Example: MOD ELCS: IMSI="460035589300001", PROV=TRUE; Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them.
9.267 List the ELCS Service Command Name: LST ELCS Function: Use this command to query the ELCS service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST ELCS: IMSI="460035589300001"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}=
All rights reserved.
Page 362 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{ISDN}= { ELCS}=< PROV> If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of them.
9.268 Modify the M2M Binding Service Command Name: MOD IMEIBIND Function: Use this command to provide, modify, or remove the M2M binding service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
OPTIONTYPE
Enumeration
PROVIDE MODIFY
WITHDRAW
Specifies how to provide the M2M binding service
M
DELETEIMEI IMEI bound with IMSI
C
IMEI
Character string
14
Example: MOD IMEIBIND: IMSI="123456789012345", OPTIONTYPE=PROVIDE, IMEI="12345678901234"; Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 363 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If this command is executed, the HLR will send a CancelLocation message to the VLR or SGSN.
In the M2M binding service, one IMSI can be bound with only one IMEI. Their binding relationship applies to both the PS and CS domains.
The type of OPTIONTYPE is Enumeration: PROVIDE: Provide the M2M binding service. MODIFY: Modify the IMEI that has been bound with an IMSI. WITHDRAW: Withdraw the IMEI binding service. DELETEIMEI: Delete the IMEI that has been bound with an IMSI.
IMSI and ISDN are optional. Specify only one of the them.
9.269 List the M2M Binding Service Command Name: LST IMEIBIND Function: Use this command to query the IMSI-IMEI binding service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST IMEIBIND: IMSI="123456789123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {IMSIIMEIBIND}= If the operation fails, error codes will be returned. For details of the error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are optional. Specify only one of them.
If this command is executed for a subscriber whose M2M binding service is automatic binding and the subscriber's IMSI is not bound with an IMEI, the result of IMSIIMEIBIND is NULL.
9.270 Modify the Status Notify to M2M Service Command Name: MOD M2MNOTIFY Function: Use this command to provide or withdraw the status notification to third-party service data for subscribers.
All rights reserved.
Page 364 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Enumeration
TRUE
M
FALSE
Notify a third-party platform of subscriber status
LU
Example: MOD M2MNOTIFY: IMSI="123456789012345", PROV=TRUE; Output If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes.". IMSI and ISDN are optional. Specify only one of the them. They cannot be present together .
9.271 Listing status notify to M2M Service Command Name: LST M2MNOTIFY Function: Use this command to query the status notify to M2M Service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST M2MNOTIFY: IMSI="123456789123456"; Output If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}=< ISDN Number>,
All rights reserved.
Page 365 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{M2MNOTIFY}= If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.272 Modifying the Charging Area Service Command Name: MOD CA Function: Use this command to provide or withdraw the charging area (CA) service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE
Provide charging area
M
FALSE
CA1
Integer
1-9999
Charging area 1
C
CA2
Integer
1-9999
Charging area 2
C
CA3
Integer
1-9999
Charging area 3
C
Example: MOD CA: IMSI="460000009012345", PROV=TRUE, CA1=1, CA2=2; Output If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes."
The IMSI and MSISDN parameters are optional. Specify only one of them.
Charging area 1, Charging area 2, and Charging area 3 cannot be set to a same value.
9.273 Listing the Charging Area Service (LST CA) Command Name: LST CA
All rights reserved.
Page 366 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: Use this command to query the charging area service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST CA: IMSI="460000009012345"; Output If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {CA1}= {CA2}= {CA3}= If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes." The IMSI and MSISDN parameters are optional. Specify only one of them.
9.274 Modifying the Fraud Prevention Service Command Name: MOD FRAUD Function: Use this command to set or withdraw the Fraud Prevention service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE
M
FALSE
Provide Fraud Prevention service Fraud Prevention Template ID
C
TPLID
Integer
0-65534
Example:
All rights reserved.
Page 367 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
MOD FRAUD: IMSI="444441234567890",PROV= TRUE , TPLID=2; Output If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes."
This command is only applied to the subscriber whose NAM is BOTH or MSC.
IMSI and ISDN are optional. Specify only one of the them. They cannot be present together .
9.275 Listing the Fraud Prevention Service Command Name: LST FRAUD Function: Use this command to query the Fraud Prevention service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST FRAUD: IMSI="460035589300001"; Output If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {TPLID}=< Template id> If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.276 Modify the CNAP Service Command Name: MOD CNAP
All rights reserved.
Page 368 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to modify the Calling Name Presentation (CNAP) supplementary service data of a subscriber. It specifies whether to provide the CNAP service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
Provide or withdraw CNAP
M
FALSE
TRUE
Override Enabled
C
FALSE
OVERRIDE
Boolean
Example: MOD CNAP:IMSI="345126789012345",PROV=FALSE; MOD CNAP:IMSI="345126789012345",PROV=TRUE,OVERRIDE=FALSE; Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
This command is only applied to the subscriber whose NAM is BOTH or MSC.
If the parameter PROV is set to FALSE, the parameter OVERRIDE need not be specified.
If the parameter PROV is set to TRUE, the parameter OVERRIDE is mandatory.
9.277 Query the CNAP Service Command Name: LST CNAP Function: This command is used to query the CNAP supplementary service of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
All rights reserved.
Page 369 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: LST CNAP: IMSI="345126789012345"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {STATUS}= {OVERRIDE}= If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes."
9.278 Modifying NON-3GPP Subscriber Attributes Command Name: MOD NONSUB Function: This command is used to modify the NON-3GPP subscriber attributes. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
NON3GPPSUPP
Boolean
TRUE
M
FALSE
Whether to support Non-3GPP access
WLANNOTALLOWED CDMA2000_1XNOTALLO WED
Restriction on Non-3GPP wireless access
O
HRPDNOTALLOWED
UMBNOTALLOWED
EHRPDNOTALLOWED
TRUE
O
FALSE
Provide Mobile IP support
MIP6_INTEGRATED
Mobile IP support
C
PMIP6_SUPPORTED
IP4_HOA_SUPPORTED
ASSIGN_LOCAL_IP
MIP4_SUPPORTED
GTPv2_SUPPORTED
TRUE
Provide Session
O
NONARD
PROVMIP6 MIP6FEAVEC
PROVTIMEOUT
Character string
Boolean Enumeration
Boolean
All rights reserved.
Page 370 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
FALSE
Remarks
timeout period
SESSIONTIMEOUT
Numeral
1-4294967295
Session timeout period
C
VOWIFI_TAG
Enumeration
VoWIFI
VoWIFI subscriber flag
O
Non_VoWIFI
Example: MOD NONSUB: IMSI="460000009012345", NON3GPPSUPP=FALSE; MOD NONSUB: IMSI="460000009012345", NON3GPPSUPP=TRUE, NONARD=WLANNOTALLOWED-1, PROVMIP6=TRUE, MIP6FEAVEC=MIP6_INTEGRATED; Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes."
Before configuring the NON-3GPP subscriber attributes, ensure that the subscriber has registered the EPS service.
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter PROVMIP6 is set to TRUE, the parameter MIP6FEAVEC is mandatory.
If the parameter PROVTIMEOUT is set to TRUE, the parameter SESSIONTIMEOUT is mandatory.
9.279 Listing NON-3GPP Subscriber Attributes Command Name: LST NONSUB Function: This command is used to query the NON-3GPP subscriber attributes. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST NONSUB: IMSI="460000009012345";
All rights reserved.
Page 371 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {NON3GPPSUPP}= {WLANNOTALLOWED}= {CDMA2000_1XNOTALLOWED}= {HRPDNOTALLOWED}= {UMBNOTALLOWED}= {EHRPDNOTALLOWED}= {MIP6FEAVEC}= {SESSIONTIMEOUT}= { VOWIFI_TAG}=< Non_VoWIFI | VoWIFI >
9.280 Adding a KI in a different Partition Command Name: ADD CKI Function: This command is used to add a single KI to a different partition. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Number
1-255
HLR serial number
C
IMSI
Character string
6-15
IMSI number
M
MSISDN
Character string
6-15
MSISDN number
M
KIVALUE
Character string
32
KI value
M
K4SNO
Numeral
0-254
K4 serial number
O
CARDTYPE
Enumerated
SIM
Card type
M
USIM
COMP128_1
Authentication algorithm type
M
COMP128_2
COMP128_3
CUSTOM_1
MILENAGE
MILENAGE_2
XOR
ALG
Enumerated
All rights reserved.
Page 372 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
CAVE38
CUSTOM_2
CUSTOM_3
CUSTOM_4
CUSTOM_5
CUSTOM_7
Description
Remarks
OPCVALUE
Character string
32
OPC value
C
OPSNO
Numeral
0-16777215
OP serial number
C
AMFSNO
Numeral
1-65535
AMF serial number
C
Example: ADD CKI: HLRSN=1, IMSI="460000009123456", MSISDN="86131234567", KIVALUE="1234567890ABCDEF1111111111111111", K4SNO=2, CARDTYPE=SIM, ALG=COMP128_1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The default value of the parameter K4SNO is 0, which indicates that no K4 value will be used to decrypt KI.
The parameters ALG and CARDTYPE must be specified together. The value of the parameter ALG depends on that of the parameter CARDTYPE. Please pay attention to that the MILEANGE algorithm is also applicable to the SIM card.
If the parameter ALG is set to MILENAGE, MILENAGE_2 or CUSTOM_1, the parameters OPC and OPSNO are conditional parameters; that is, one of the two parameters must be specified. If the parameter ALG is not set to MILENAGE, MILENAGE_2 and CUSTOM_1, the parameter OPC need not be specified. If the parameter OPSNO is set to 0, it indicates that no OP data is used.
The parameter HLRSN need not be specified or is set to the default value 255 if the current PGW is a common version. The parameter HLRSN must be specified if the current PGW is a redundant version. In this case, this parameter does not have a default value.
The parameter AMFSNO is a conditionl parameter when CARDTYPE is USIM or ALG is MILENAGE, MILENAGE_2 or CUSTOM_1.
The difference between MILENAGE_2 and MILENAGE is that different algorithms are used for converting XRES of authentication quintuplets into SRES of authentication triplets.
9.281 Listing Subscrier's Location and Status Information Command Name: GET TERMSTATE Function: This command is used to query the subscriber's location and status information.
All rights reserved.
Page 373 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
OnHLR
Enumerated
TRUE
O
FALSE
DEPVLR
Specifies whether the HSS9860 queries UE status and location from the HSS9860 local database, VLR, MSC, or MME.
MME
MME_PAGE
LOCATION
STATUS
DetailFLAG
Boolean
Boolean
Boolean
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
TRUE: The HSS9860 queries UE status and location from its local database.
FALSE: The HSS9860 queries UE status and location from the VLR database.
DEPVLR: The HSS9860 queries UE status and location obtained by the MSC sending paging requests to UEs.
MME: The HSS9860 queries UE status and location from the MME database.
MME_PAGE: The HSS9860 queries UE status and location obtained by the MME sending paging requests to UEs.
Specifies whether the HSS9860 queries UE location.
TRUE: The HSS9860 queries UE location.
FALSE: The HSS9860 does not query UE location.
Specifies whether the HSS9860 queries UE status.
TRUE: The HSS9860 queries UE status.
FALSE: The HSS9860 does not query UE status.
Specifies whether the HSS9860 displays infomation for terminal.
TRUE: The HSS9860 displays the detail information.
FALSE: The HSS9860 does not display the detail information.
All rights reserved.
O
O
O
Page 374 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: GET TERMSTATE: IMSI="460021001008001", OnHLR=TRUE, LOCATION=TRUE, STATUS=TRUE, DetailFLAG=FALSE; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {OnHLR}= {LOCATION}= {CISDN}= If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.282 Deleting Subscriber's GPRS Data Command Name: RMV GPRS Function: This command is used to delete all the PDP contexts of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: RMV GPRS: IMSI=”123456789”; Output: If the operation succeeds, the system displays the following message: SUCCESS0001: Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 375 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.283 Modifying the ICS Service Command Name: MOD ICSIND Function: This command is used to modify the ICS service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
ICSIND
Boolean
TRUE
ICS Flag
M
FALSE
Example: MOD ICSIND: IMSI="460000009012345", ICSIND=TRUE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of the them.
9.284 Listing the ICS Service Command Name: LST ICSIND Function: This command is used to query the ICS service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
All rights reserved.
Page 376 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: LST ICSIND: IMSI="460000009012345"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {ICSIND}= < TRUE|FALSE> If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of the them.
9.285 Modifying the Anchor Service Command Name: MOD ANCHOR Function: This command is used to modify the ANCHOR service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
ANCHOR
Enumerated
TRUEFALSE SELECTIVE
TCSI
Specifies whether the HSS9860 provides the Anchor function for a subscriber.
M
PRE_FALSE
PRE_TRUE
TRUE: The HSS9860 provides the Anchor function for subscribers.
FALSE: The HSS9860 does not provide the Anchor function for a subscriber.
SELECTIVE: The HSS9860 determines whether to provide the Anchor function for subscribers by checking certain conditions.
TCSI: The HSS9860 delivers the T-CSI template provided to the subscriber without checking the subscriber's registration status to the MSC. The T-CSI template contains the anchor AS information for the MSC to interwork with the AS to route
All rights reserved.
Page 377 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
the call to the IMS.
PRE_FALSE: The HSS9860 does not implement mobileterminated anchoring for the inactive predefined VoWiFi subscriber. Such subscribers can use CS services but not IMS services.
PRE_TRUE: The HSS9860 implements mobile-terminated anchoring for the active predefined VoWiFi subscriber. Such subscribers can use CS and IMS services.
Example: MOD ANCHOR: IMSI="460000009012345", ANCHOR=FALSE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of the them.
9.286 Listing the ANCHOR Service Command Name: LST ANCHOR Function: This command is used to query the ANCHOR service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST ANCHOR: IMSI="460000009012345";
All rights reserved.
Page 378 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {ANCHOR}= < TRUE|FALSE|SELECTIVE|TCSI|PRE_FALSE|PRE_TRUE> If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of the them.
9.287 Modifying the IM-O-CSI Service Command Name: MOD IMOCSI Function: This command is used to provide or withdraw the IM-O-CSI service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides OCSI in the IMS domain for a subscriber.
M
TPLID
Integer
0-65534
TRUE: The HSS9860 provides O-CSI in the IMS domain for a subscriber.
FALSE: The HSS9860 withdraws O-CSI in the IMS domain from a subscriber.
IM-O-CSI template ID
C
Example: MOD IMOCSI:ISDN="987654321",PROV=TRUE,TPLID=2; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of the them.
All rights reserved.
Page 379 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.288 Modifying the IM-VT-CSI Service Command Name: MOD IMVTCSI Function: This command is used to provide or withdraw the IM-VT-CSI service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides VT-CSI in the IMS domain for a subscriber.
M
TPLID
Integer
0-65534
TRUE: The HSS9860 provides VT-CSI in the IMS domain for a subscriber.
FALSE: The HSS9860 withdraws VT-CSI in the IMS domain from a subscriber.
IM-VT-CSI template ID
C
Example: MOD IMVTCSI:ISDN="987654321",PROV=TRUE,TPLID=2; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of the them.
9.289 Modify a GROUPSIM Subscriber Command Name: MOD GROUPSIM Function: This command is used to provide, withdraw or modify the GROUPSIM service data of a subscriber. Parameter Description:
All rights reserved.
Page 380 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
GIMSI
Character string
6-15
Group IMSI number
C
GISDN
Character string
1-15
Group MSISDN number
C
PROV
Enumerated
ADD
M
RMV
MOD
Specifies whether the HSS9860 provides or withdraws the GROUPSIM service for a subscriber or modify the GROUPSIM service data of a subscriber.
(GROUPSIMOP TYPE for details)
HLRSN
Integer
1-255
MSIMTYPE
Enumerated
Sequential
Parall
Parallel_Prefered
ADD: The HSS9860 provides the GROUPSIM service for a subscriber.
RMV: The HSS9860 withdraws the GROUPSIM service from a subscriber.
MOD: The HSS9860 modifies the GROUPSIM service data of a subscriber.
HLR serial number
C
GROUPSIM type
C
MEMBERISDN1
Character string
1-15
Member Msisdn1
C
MEMBERISDN2
Character string
1-15
Member Msisdn2
C
MEMBERISDN3
Character string
1-15
Member Msisdn3
C
MEMBERISDN4
Character string
1-15
Member Msisdn4
C
MEMBERISDN5
Character string
1-15
Member Msisdn5
C
MEMBERISDN6
Character string
1-15
Member Msisdn6
C
MEMBERISDN7
Character string
1-15
Member Msisdn7
C
MEMBERISDN8
Character string
1-15
Member Msisdn8
C
USERTYPE
Integer
0-254
User type
C
TONETYPE
Enumerated
Basic_Tone
Tone type
C
Intelligent_Tone
TRUE
C
FALSE
Specifies whether the HSS9860 restricts a call routed to a GROUPSIM members to be forwarded.
CFSUP
Boolean
TRUE: The HSS9860 restricts such a call to be forwarded.
FALSE: The HSS9860 does not
All rights reserved.
Page 381 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
restrict such a call to be forwarded. STIME
Integer
0-255
Specifies the duration of a time noresponse timer in sequential ringing.
C
PTIME
Integer
0-255
Specifies the duration of a noresponse timer in simultaneous ringing.
C
SMS_PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 replies with the data of a GROUPSIM member when the HLR receives a SMS message to request the data of the group MSISDN.
C
SMS
Character string
1-15
VOICE_PROV
Boolean
TRUE
FALSE
VOICE
Character string
1-15
MMS_PROV
Boolean
TRUE
FALSE
TRUE: The HSS9860 replies with the data of a GROUPSIM member.
FALSE: The HSS9860 does not reply with the data of a GROUPSIM member.
Sms activation isdn
C
Specifies whether the HSS9860 replies with the data of a GROUPSIM member when the HLR receives a mobile-terminated service message to request the data of the group MSISDN if the MSC does not support sequential ringing or simultaneous ringing.
C
TRUE: The HSS9860 replies with the data of a GROUPSIM member.
FALSE: The HSS9860 does not reply with the data of a GROUPSIM member.
Voice activation isdn
C
Specifies whether the HSS9860 replies with the data of a GROUPSIM member when the HSS9860 receives a multimedia short message service (MMS) message to request the data of the group MSISDN.
C
All rights reserved.
TRUE: The HLR replies with the data of a GROUPSIM member.
Page 382 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
MMS
Character string
1-15
LCS_PROV
Boolean
TRUE
FALSE
LCS
Character string
1-15
SYNC
Enumerated
Allowed
Denied
Remarks
FALSE: The HLR does not reply with the data of a GROUPSIM member.
MMS activation isdn
C
Specifies whether the HSS9860 replies with the data of a GROUPSIM member when the HSS9860 receives an LCS service message to request the data of the group MSISDN.
C
TRUE: The HSS986. replies with the data of a GROUPSIM member.
FALSE: The HSS9860 does not reply with the data of a GROUPSIM member.
LCS activation isdn
C
Synchronization in group
C
Example: MOD GROUPSIM: GIMSI="460000000000000", GISDN ="861300000000000", PROV=ADD, HLRSN=1, MSIMTYPE=Sequential, MEMBERISDN1="861311111111111", USERTYPE=254, TONETYPE=Basic_Tone, CFSUP=TRUE, STIME=254, SMS="861322222222222"; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If the parameter PROV is set to ADD, the parameters GIMSI GISDN HLRSN MSIMTYPE are mandatory.
If the parameter PROV is set to RMV or MOD, the GIMSI and GISDN parameters are optional. Specify only one of them.
The value of the SMS, VOICE, MMS, or LCS cannot be the same as that of the GISDN parameter.
9.290 List GROUPSIM Subscribers Command Name: LST GROUPSIM
All rights reserved.
Page 383 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to query the data of a GROUPSIM subscriber. Parameter Description: Name
Type
Range
Description
Remarks
GIMSI
Character string
6-15
Group IMSI number
C
GISDN
Character string
1-15
Group MSISDN number
C
Example: LST GROUPSIM: GIMSI="460000000000000"; Output: If the operation succeeds, the system displays an output with the following format: {GIMSI}= {MSIMTYPE}=< sequential | parallel | parallel preferred > { USERTYPE }=< User Type > {TONETYPE}=< basic tone | intelligent tone> {CFSUP}= {STIME}=< no answer time for sequential alerting > {PTIME}=< no answer time for parallel alerting > {SMS}=< Sms activation isdn > {VOICE}=< Voice activation isdn > {MMS}=< MMS activation isdn > {LCS}=< LCS activation isdn > { SYNC }=< Allowed | Denied > {MEMBERISDN}= { AMBRMAXUL}=< UE level MAX Upload Bandwidth > { AMBRMAXDL}=< UE level MAX Download Bandwidth > {ANCHOR}=< TRUE|FALSE|SELECTIVE|TCSI|PRE_FALSE|PRE_TRUE> {VOLTETAG}= {ICSIND}= {MPS}= {TAUTIMER}={0-43200} {LTEAUTOPROV}= {RELAY_NODE}=
All rights reserved.
Page 393 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{ RATFREQSELPRIID}=< RAT frequency selection priority ID > { PLMNTPLID}=< PLMN roaming restriction template ID > { DIAMNODETPL_ID}=< Diameter roaming restriction template ID > { SWXPLMNTPLID}=< PLMN-specific roaming restriction template ID for SWx interface > {EPSODBPOS}=< NOBPOS|BAPOS|BHPLMNAPROAM|BALLAPROAM > {LTE_M2M_FLAG}= If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.296 Modifying the LU-CSI Service Command Name: MOD LUCSI Function: This command is used to provide or withdraw the LU-CSI service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE
Provide LU-CSI
M
FALSE LU-CSI template ID
C
TPLID
Integer
0-65534
Example: MOD LUCSI: IMSI="460000009123456", PROV=TRUE, TPLID=2; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of the them.
All rights reserved.
Page 394 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.297 Listing the LU-CSI Service Command Name: LST LUCSI Function: This command is used to query the LU-CSI service data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST LUCSI: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {TPLID}=< Template id> If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.298 Deleting USER_CHANGED_ISDN Command Name: RMV CHANGEDISDN Function: This command is used to delete an MSISDN from the USER_CHANGED_MSISDN table. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN
M
Example: RMV CHANGEDISDN: ISDN="8613772897878"; Output: If the operation succeeds, the system displays the following message:
All rights reserved.
Page 395 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." ISDN is mandatory.
9.299 Modify the PLMN Region Roaming Service Command Name: MOD PLMNRSZI Function: This command is used to provide or withdraw the PLMN-specific roaming restriction service, or modify the PLMN-specific roaming restriction service data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Enumerated
TRUE FALSE
Specifies whether the HSS9860 provides or withdraws the PLMN-specific roaming restriction service, or modifies the PLMNspecific roaming restriction service data.
M
PLMNTPLID
Numeral
0-65534
TYPE
Enumerated
S6a_SWx
S6a
SWx
TRUE: The HSS9860 provides the PLMN-specific roaming restriction service to subscribers or modifies the PLMN-specific roaming restriction service data of subscribers.
FALSE: The HSS9860 withdraws the PLMN-specific roaming restriction service from subscribers.
PLMN region roaming template ID
C
Specifies the interface over which the PLMN-specific roaming restriction template is used to restrict subscriber roaming.
O
S6a_SWx: The PLMN-specific roaming restriction template is used over both the S6a and SWx interfaces to restrict subscriber roaming.
S6a: The PLMN-specific roaming restriction template is used over the S6a interface to restrict subscriber roaming.
SWx: The PLMN-specific roaming restriction template is used over the SWx interface to restrict subscriber roaming.
All rights reserved.
Page 396 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: MOD PLMNRSZI: IMSI="444441234567890", PROV = TRUE, PLMNTPLID =1; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter PROV is set to TRUE, the parameter PLMNTPLID must be specified.
9.300 List the PLMN Region Roaming Service Command Name: LST PLMNRSZI Function: This command is used to query the PLMN-specific roaming restriction service data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST PLMNRSZI: IMSI="444441234567890"; Output: If the operation succeeds, the system displays an output with the following format: {PLMNTPLID}=< PLMN TemplateID > {SWXPLMNTPLID}=< PLMN-specific roaming restriction template ID for SWx interface > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 397 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.301 Modify the STN-SR for a Subscriber Command Name: MOD STNSR Function: This command is used to to add or delete the session transfer number for single radio voice call continuity (STNSR) for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
RECORDCOUNT
Numeral
1-100000
Number of subscribers
C
IMSIFILE
Character string
1-16
Name of IMSI file
C
ISDNFILE
Character string
1-16
Name of MSISDN file
C
IMSISTNSRFILE
Character string
1-16
IMSI/STNSR file name
C
ISDNSTNSRFILE
Character string
1-16
MSISDN/STNSR file name
C
PROV
Enumerated
TRUE FALSE
Specifies whether the HSS9860 provides the STN-SR.
M
STNSR
Character string
3-15
TRUE: The HSS9860 provides the STN-SR.
FALSE: The HSS9860 withdraws the STN-SR.
Session transfer number for SRVCC
C
Example: MOD STNSR: IMSI="460000009123456", PROV =TRUE, STNSR =”4601389162252”; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI, ISDN, IMSIFILE, ISDNFILE, IMSISTNSRFILE, and ISDNSTNSRFILE are mutually exclusive. Specify only one of them.
If RECORDCOUNT is specified, IMSIFILE and ISDNFILE cannot be specified. IMSI or ISDN must be specified.
RECORDCOUNT does not need to be specified if the number of subscribers is 1.
IMSIFILE: -
This parameter contains multiple inconsecutive IMSIs. Each IMSI occupies one line.
All rights reserved.
Page 398 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The file name extension is .txt. The file is uploaded to the specified location on the FTP server using the File Manager provided by the PGW Web LMT.
ISDNFILE: -
This parameter contains multiple inconsecutive MSISDNs. Each MSISDN occupies one line.
-
The file name extension is .txt. The file is uploaded to the specified location on the FTP server using the File Manager provided by the PGW Web LMT.
IMSISTNSRFILE: -
This parameter contains multiple inconsecutive IMSIs and corresponding STNSRs. Each IMSI and STNSR occupy one line.
-
The file name extension is .txt. The file is uploaded to the specified location on the FTP server using the File Manager provided by the PGW Web LMT.
ISDNSTNSRFILE: -
This parameter contains multiple inconsecutive MSISDNs and corresponding STNSRs. Each MSISDN and STNSR occupies one line.
-
The file name extension is .txt. The file is uploaded to the specified location on the FTP server using the File Manager provided by the PGW Web LMT.
PROV: -
If IMSI/STNSR file name or MSISDN/STNSR file name is specified, Whether to provide or withdraw STN-SR must be set to TRUE.
-
If Number of subscribers, Name of IMSI file, or Name of MSISDN file is specified, Whether to provide or withdraw STN-SR must be set to FALSE.
STNSR: -
This parameter can be configured when Whether to provide or withdraw STN-SR is set to TRUE.
-
This parameter cannot be specified when IMSI/STNSR file name or MSISDN/STNSR file name is specified.
-
This parameter is mandatory when neither IMSI/STNSR file name nor MSISDN/STNSR file name is specified.
9.302 List the STN-SR of a Subscriber Command Name: LST STNSR Function: This command is used to query the Session Transfer Number for SRVCC (STNSR) route of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
RECORDCOUNT
Numeral
1-100000
Number of subscribers
C
IMSIFILE
Character string
1-16
Name of IMSI file
C
ISDNFILE
Character string
1-16
Name of MSISDN file
C
Example:
All rights reserved.
Page 399 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
LST STNSR: IMSI="444441234567890"; Output: If the operation succeeds, the system displays an output with the following format: {STNSR}= < Session Transfer Number for SRVCC > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI, MSISDN, Name of IMSI file, Name of MSISDN file, IMSI/STNSR file name, and MSISDN/STNSR file name are optional. Specify only one of them.
If Number of subscribers is specified, IMSI or MSISDN must be specified, but Name of IMSI file or Name of MSISDN file cannot be specified.
RECORDCOUNT does not need to be specified if the number of subscribers is 1.
IMSIFILE:
-
This parameter contains multiple inconsecutive IMSIs. Each IMSI occupies one line.
-
The file name extension is .txt. The file is uploaded to the specified location on the FTP server using the File Manager provided by the PGW Web LMT.
ISDNFILE: -
This parameter contains multiple inconsecutive MSISDNs. Each MSISDN occupies one line.
-
The file name extension is .txt. The file is uploaded to the specified location on the FTP server using the File Manager provided by the PGW Web LMT.
9.303 Modify the APN Operator Identifier for a Subscriber Command Name: MOD EPSAPNOI Function: This command is used to set the access point name (APN) operator identifier of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Enumerated
TRUE FALSE
Specifies whether the HSS9860 provides UE level APN-OI-replacement.
M
APNOI
Character string
1-63
TRUE: The HSS9860 provides UE level APN-OI-replacement.
FALSE: The HSS9860 withdraws UE level APN-OI-replacement.
UE Leve APN Operator Identifier Replacement
C
Example: MOD EPSAPNOI: IMSI="460000009123456", PROV =TRUE, APNOI =”huawei.com”;
All rights reserved.
Page 400 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter PROV is set to TRUE, the parameter APNOI should be present.
9.304 List the APN Operator Identifier of a Subscriber Command Name: LST EPSAPNOI Function: This command is used to query the access point name (APN) operator identifier of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST EPSAPNOI: IMSI="444441234567890"; Output: If the operation succeeds, the system displays an output with the following format: { APNOI }= If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.305 Modify the EPS AMBR Data for a Subscriber Command Name: MOD EPSAMBR Function: This command is used to set the 3GPP aggregate maximum bit rate (AMBR) for a subscriber, including the maximum bandwidth for uplink and the maximum bandwidth for downlink. Parameter Description:
All rights reserved.
Page 401 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
AMBRMAXUL
Numeral
1-(232 – 1)
Specifies the maximum uplink bandwidth or the maximum upload transmission rate for a UE.
M
AMBRMAXDL
Numeral
1-(232 – 1)
Specifies the maximum downlink bandwidth or the maximum download transmission rate for a UE.
M
FORCETOBEEPSSUB
Enumerated
TRUE FALSE
Specifies whether the HSS9860 automatically sets the subscribers' EPS flag to TRUE when running MOD EPSAMBR.
O
TRUE: The HSS9860 automatically sets the subscribers' EPS flag to TRUE.
FALSE: The HSS9860 does not set the subscribers' EPS flag to TRUE.
Example: MOD EPSAMBR: IMSI="460000009123456", AMBRMAXUL =10000, AMBRMAXDL =10000; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.306 List the EPS AMBR Data of a Subscriber Command Name: LST EPSAMBR Function: This command is used to query the 3GPP aggregate maximum bit rate (AMBR) for a subscriber, including the maximum bandwidth for uplink and the maximum bandwidth for downlink. Parameter Description:
All rights reserved.
Page 402 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST EPSAMBR: IMSI="444441234567890"; Output: If the operation succeeds, the system displays an output with the following format: { AMBRMAXUL }= < UE Level Max Request Bandwidth of Upload > { AMBRMAXDL }= < UE Level Max Request Bandwidth of Download > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.307 Modify the Radio Frequency Access Selection Priority for a Subscriber Command Name: MOD RFPRID Function: This command is used to set the priority in the selection of the radio frequency access provided for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
RATFREQSELPRIID
Numeral
0-256
RAT frequency selection priority ID
M
Example: MOD RFPRID: IMSI="460000009123456", RATFREQSELPRIID =10; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
All rights reserved.
Page 403 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.308 List the Radio Frequency Access Selection Priority of a Subscriber Command Name: LST RFPRID Function: This command is used to query the priority in the selection of the radio frequency access provided for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST RFPRID: IMSI="444441234567890"; Output: If the operation succeeds, the system displays an output with the following format: { RATFREQSELPRIID}= < RAT Frequency Selection Priority ID > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.309 Modifying the Diameter Roaming Restriction Service Command Name: MOD DIAMRRS Function: This command is used to provide or withdraw the Diameter roaming restriction service for a subscriber Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
All rights reserved.
Page 404 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN
C
PROV
Enumerated
TRUE
M
FALSE
Specifies whether the HSS9860 provides or withdraws the Diameter node-specific roaming restriction service, or modifies the Diameter node-specific roaming restriction service data.
DIAMNODETPL_ID
Numeral
0-65534
TRUE: The HSS9860 provides the Diameter node-specific roaming restriction service to subscribers or modifies the Diameter nodespecific roaming restriction service data of subscribers.
FALSE: The HSS980 withdraws the Diameter node-specific roaming restriction service from subscribers.
DIAMRR template ID
C
Example: MOD DIAMRRS: IMSI="460000009123456", PROV=TRUE, DIAMNODETPL_ID=20; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
If the parameter PROV is set to TRUE, the parameter DIAMNODETPL_ID must be specified.
9.310 Listing the Diameter Roaming Restriction Service Command Name: LST DIAMRRS Function: This command is used to query the Diameter Region Roaming service data of subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
All rights reserved.
Page 405 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN
C
Example: LST DIAMRRS: IMSI="444441234567890"; Output: If the operation succeeds, the system displays an output with the following format: { DIAMNODETPLID }=< Diameter Roaming TemplateID > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.311 Modify the UserCategory Command Name: MOD USERCATEGORY Function: This command is used to change a normal subscriber into an M2M subscriber or an M2M subscriber into a normal subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
USERCATEGORY
Enumerated
NORMAL M2M
Specifies whether to change a normal subscriber into an M2M subscriber or an M2M subscriber into a normal subscriber.
M
NORMAL: The HSS9860 changes an M2M subscriber into a normal subscriber.
M2M: The HSS9860 changes a normal subscriber into an M2M subscriber.
All rights reserved.
Page 406 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: MOD USERCATEGORY: IMSI="984519856312345",USERCATEGORY=M2M; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.312 Listing the UserCategory Command Name: LST USERCATEGORY Function: This command is used to query the category of a subscriber, that is, whether the subscriber is an M2M subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST USERCATEGORY: IMSI="984519856312345"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {MSISDN}= {CATEGORY}= If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 407 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.313 Modify the Multi-SIM Service Command Name: MOD MSIM Function: This command is used to provide or withdraw the Multi-SIM service as well as modify Multi-SIM subscription data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9890 provides the Multi-SIM service for a subscriber.
M
MSIMTYPE
Enumerated
ActiveByUPL
ActiveByUSSD
TRUE: The HSS9860 provides the Multi-SIM service.
FALSE: The HSS9860 withdraws the Multi-SIM service.
Specifies the service type of the Multi-SIM group.
ActiveByUPL: The HSS9860 considers the subscriber who performs the latest location update as the activated subscriber.
ActiveByUSSD: The HSS9860 considers the subscriber who conducts a USSD operation for activating itself as activated subscriber.
C
Example: MOD MSIM: IMSI="460000009123456", PROV=TRUE, MSIMTYPE=ActiveByUSSD; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 408 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.314 List the Multi-SIM Service Command Name: LST MSIM Function: This command is used to query the subscription data of Multi-SIM, including information about the activated subscriber, Multi-SIM type, and member numbers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST MSIM: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= < MSISDN number> {MSIMTYPE}=< ActiveByUPL| ActiveByUSSD> {MTISDN}=< Active MSISDN number > {ISDN2} = < MSISDN Number 2> {ISDN3} = < MSISDN Number 3> {ISDN4} = < MSISDN Number 4> {ISDN5} = < MSISDN Number 5> {ISDN6} = < MSISDN Number 6> {ISDN7} = < MSISDN Number 7> {ISDN8} = < MSISDN Number 8> {ISDN9} = < MSISDN Number 9> Member Number { IMSI number}
+
ACTIVE
ORDERID
{ NO | YES }
+ {1-9}
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 409 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
The IMSI , ISDN, MSIMTYPE, Member Number, ACTIVE, and ORDERID parameters are displayed in the command output for enhanced multi-SIM subscribers.
The IMSI , ISDN, MSIMTYPE, MTISDN, and ISDN2-9 parameters are displayed in the command output for multi-SIM subscribers.
9.315 Modify CSI Not Using Templates Command Name: MOD NTCSI Function: This command is used to add, modify, or delete originating CAMEL subscription information (O-CSI) or terminating CAMEL subscription information (T-CSI) data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
CAMELTYPE
Enumerated
OCSI TCSI
Extended_Information
Specifies the type of the CSI data to be added, modified, or deleted.
M
PROV
CAMEL
Enumerated
Enumerated
ADD/MOD
DELETE
PHASE1
PHASE2
PHASE3
PHASE4
OCSI: O-CSI data
TCSI: T-CSI data
Extended_Information: Extended CAMEL information. If this option is selected, all extended CAMEL information of the subscriber is modified.
Specifies whether the HSS9860 adds, modifies, or deletes CSI data.
ADD: Adds CSI data.
MOD: Modifies CSI data.
DELETE: Deletes CSI data.
Specifies the CAMEL phase required for the GSM service control function (gsmSCF) to process a specific CAMEL service. Select a value based on the carrier's requirement.
All rights reserved.
C
C
PHASE1: Required for the gsmSCF to process mobile originated calls or mobile terminated calls.
Page 410 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
OCSIDP
TCSIDP
Type
Enumerated
Enumerated
Summary of CommandsSummary of Commands
Range
Description
COLLECTINFO
ROUTESELFAIL
TAA
TBUSY
TNOANSWER
All rights reserved.
Remarks
PHASE2: Required for the gsmSCF to invoke supplementary services. Phase 2 is an enhancement to phase 1.
PHASE3: Required for the gsmSCF to process mobile originated short message services (MO SMS), general packet radio service (GPRS) sessions, packet data protocol (PDP) contexts, to control subscriber data in the HLR, and to control network signaling load. Phase 3 enhances the capabilities of phase 2.
PHASE4: Required for the gsmSCF to process mobile terminated short message services (MT SMS). Phase 4 enhances the capabilities of phase 3.
Specifies the detection point defined for the O-CSI service. When the trigger criteria associated with a DP are met, the (G)MSC requests instructions from the gsmSCF.
COLLECTINFO: Collected_Info (DP2) is a point at which the dialed number is collected. DP Collected_Info can be selected for all CAMEL phases.
ROUTESELFAIL: Route_Select_Failure (DP4) is a point at which a route selection fails. DP Route_Select_Failure can be only selected for CAMEL phase 3 and CAMEL phase 4.
Specifies the detection point defined for the T-CSI service.
C
C
TAA: Terminating_Attempt_Aut
Page 411 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
horised (DP12) is a point at which a called subscriber attempts to be authenticated. DP Terminating_Attempt_Aut horised can be selected for all CAMEL phases.
TBUSY: T_Busy (DP13) is a point at which a subscriber is found busy when the GMSC attempts to route a call to the subscriber. DP T_Busy can be only selected for CAMEL phase 3 and CAMEL phase 4.
TNOANSWER: T_No_Answer (DP14) is a point at which a called subscriber does not answer a call. DP T_No_Answer can be only selected for CAMEL phase 3 and CAMEL phase 4.
GSMSCFADD
Character string
1-15
gsmSCF address
C
SK
Integer
0-2147483647
Service key
C
DEFCALL
Enumerated
continueCall
C
releaseCall
Specifies whether the gsmSCF instructs the MSC to continue or release a call if a dialogue between the gsmSSF and the gsmSCF encounters an error or if the call is subject to call gapping in the gsmSSF.
VLR_NOTSU PPHASE1
Enumerated
AllowLocationUpdateW ithMOCall
AllowLocationUpdateW ithODBBAOC
DenyLocationUpdate
continueCall: The gsmSCF instructs the MSC to continue a call.
releaseCall: The gsmSCF instructs the MSC to release a call.
Specifies how the HSS9860 responds to the requests for providing CAMEL services for calling subscribers if the serving MSC/VLR does not support CAMEL.
All rights reserved.
C
AllowLocationUpdateWit hMOCall: The HSS9860
Page 412 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
replies with a successful location update response message and delivers voice service data.
VLR_NOTSU PPHASE2
VLR_NOTSU PPHASE3
Enumerated
Enumerated
ReturnLPO-CSI
AllowLocationUpdateW ithODBBAOC
DenyLocationUpdate
ReturnLPO-CSI
AllowLocationUpdateW ithODBBAOC
DenyLocationUpdate
AllowLocationUpdateWit hODBBAOC: The HSS9860 replies with a successful location update response message and delivers ODBBAOC data for all basic services.
DenyLocationUpdate: The HSS9860 replies with a location update failure response.
Specifies how the HSS9860 responds to the requests for providing CAMEL services for calling subscribers if the serving MSC/VLR does not support CAMEL phase 2.
ReturnLPO-CSI: The HSS9860 compares the CAMEL phase supported by the MSC/VLR with the CAMEL phase configured in this template and delivers the O-CSI carrying a lower CAMEL phase.
AllowLocationUpdateWit hODBBAOC: The HSS9860 replies with a successful location update response message and delivers ODBBAOC data for all basic services.
DenyLocationUpdate: The HSS9860 replies with a location update failure response.
Specifies how the HSS9860 responds to the requests for providing CAMEL services for calling subscribers if the serving MSC/VLR does not support CAMEL phase 3.
All rights reserved.
C
C
ReturnLPO-CSI: The HSS9860 compares the
Page 413 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
CAMEL phase supported by the MSC/VLR with the CAMEL phase configured in this template and delivers the O-CSI carrying a lower CAMEL phase.
VLR_NOTSU PPHASE4
GMSC_NOTS UPPHASE1
Enumerated
Enumerated
ReturnLPO-CSI
AllowLocationUpdateW ithODBBAOC
DenyLocationUpdate
AllowMTCall
ReturnBAIC
All rights reserved.
AllowLocationUpdateWit hODBBAOC: The HSS9860 replies with a successful location update response message and delivers ODBBAOC data for all basic services.
DenyLocationUpdate: The HSS9860 replies with a location update failure response.
Specifies how the HSS9860 responds to the requests for providing CAMEL services for calling subscribers if the serving MSC/VLR does not support CAMEL phase 4.
C
ReturnLPO-CSI: The HSS9860 compares the CAMEL phase supported by the MSC/VLR with the CAMEL phase configured in this template and delivers the O-CSI carrying a lower CAMEL phase.
AllowLocationUpdateWit hODBBAOC: The HSS9860 replies with a successful location update response message and delivers ODBBAOC data for all basic services.
DenyLocationUpdate: The HSS9860 replies with a location update failure response.
Specifies how the HSS9860 responds to the requests for providing CAMEL services for called subscribers if the GMSC does not support
C
Page 414 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
CAMEL.
GMSC_NOTS UPPHASE2
GMSC_NOTS UPPHASE3
Enumerated
Enumerated
ReturnLP-CSI
AllowMTCall
ReturnBAIC
ReturnLP-CSI
AllowMTCall
ReturnBAIC
All rights reserved.
AllowMTCall: The HSS9860 delivers voice service data.
ReturnBAIC: The HSS9860 delivers BAIC data for all basic services.
Specifies how the HSS9860 responds to the requests for providing CAMEL services for called subscribers if the GMSC does not support CAMEL phase 2.
C
ReturnLP-CSI: The HSS9860 compares the CAMEL phase supported by the GMSC with the CAMEL phase configured in this template and delivers the CSI data carrying a lower CAMEL phase.
AllowMTCall: The HSS9860 delivers voice service data.
ReturnBAIC: The HSS9860 delivers BAIC data for all basic services.
Specifies how the HSS9860 responds to the requests for providing CAMEL services for called subscribers if the GMSC does not support CAMEL phase 3.
C
ReturnLP-CSI: The HSS9860 compares the CAMEL phase supported by the GMSC with the CAMEL phase configured in this template and delivers the CSI data carrying a lower CAMEL phase.
AllowMTCall: The HSS9860 delivers voice service data.
ReturnBAIC: The HSS9860 delivers BAIC
Page 415 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
data for all basic services. GMSC_NOTS UPPHASE4
PSICONF
AVAILABLE_ PLMN
Enumerated
Boolean
Enumerated
ReturnLP-CSI
AllowMTCall
ReturnBAIC
TRUE
FALSE
Specifies how the HSS9860 responds to the requests for providing CAMEL services for called subscribers if the GMSC does not support CAMEL phase 4.
C
ReturnLP-CSI: The HSS9860 compares the CAMEL phase supported by the GMSC with the CAMEL phase configured in this template and delivers the CSI data carrying a lower CAMEL phase.
AllowMTCall: The HSS9860 delivers voice service data.
ReturnBAIC: The HSS9860 delivers BAIC data for all basic services.
Specifies whether the HSS9860 sends a provide subscriber information (PSI) request message to the VLR serving the called subscriber before sending an SRI response message to the GMSC.
HPLMN
FPLMN
INTERNATIONAL
HPLMNC
ALL_PLMN
All rights reserved.
C
TRUE: The HSS9860 sends a PSI request message.
FALSE: The HSS9860 does not send a PSI request message.
Specifies the area where a called subscriber is roaming. The HSS9860 checks the area where a called subscriber is roaming when it determines whether to deliver the T-CSI for the subscriber.
HPLMN: When the subscriber is roaming within the HPLMN, the HSS9860 delivers the TCSI.
FPLMN: When the
C
Page 416 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
subscriber is roaming outside the HPLMN, the HSS9860 delivers the TCSI.
INTERNATIONAL: When the subscriber is roaming outside the home country, the HSS9860 delivers the T-CSI.
HPLMNC: When the subscriber is roaming within the home country, the HSS9860 delivers the T-CSI.
ALL_PLMN: Wherever the subscriber is roaming, the HSS9860 delivers the TCSI.
Example: MOD NTCSI: IMSI="460000009123456", CAMELTYPE=OCSI, PROV=ADD, CAMEL=PHASE1, OCSIDP=COLLECTINFO, SK=1, GSMSCFADD="158600000", DEFCALL=continueCall, VLR_NOTSUPPHASE1=AllowLocationUpdateWithMOCall, VLR_NOTSUPPHASE2=ReturnLPO-CSI, VLR_NOTSUPPHASE3=ReturnLPO-CSI, VLR_NOTSUPPHASE4=ReturnLPO-CSI, GMSC_NOTSUPPHASE1=AllowMTCall, GMSC_NOTSUPPHASE2=ReturnLP-CSI, GMSC_NOTSUPPHASE3=ReturnLP-CSI, GMSC_NOTSUPPHASE4=ReturnLP-CSI; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.316 List CSI Provided Not Using Templates Command Name: LST NTCSI Function: This command is used to query CAMEL subscription information (CSI) that is provided not using templates. Parameter Description:
All rights reserved.
Page 417 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST NTCSI: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= < MSISDN number> OCSI DATA {CAMEL}= {OCSIDP}= {SK} = {GSMSCFADD} = {DEFAULTCALL} = {VLR_NOTSUPPHASE1} = AllowLocationUpdateWithMOCall| AllowLocationUpdateWithODBBAOC| DenyLocationUpdate> {VLR_NOTSUPPHASE2} = {VLR_NOTSUPPHASE3} = {VLR_NOTSUPPHASE4} = {GMSC_NOTSUPPHASE1} = {GMSC_NOTSUPPHASE2}= {GMSC_NOTSUPPHASE3}= {GMSC_NOTSUPPHASE4}= TCSI DATA {CAMEL}= {TCSIDP}=< TAA| TBUSY| TNOANSWER> {SK} = {GSMSCFADD} = {DEFAULTCALL} =
All rights reserved.
Page 418 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{GMSC_NOTSUPPHASE1} = {GMSC_NOTSUPPHASE2}= {GMSC_NOTSUPPHASE3}= {GMSC_NOTSUPPHASE4}= {PSICONF} = < FALSE | TRUE> {AVAILABLE_PLMN} = < HPLMN|FPLMN|INTERNATIONAL|HPLMNC|ALL_PLMN> Example: IMSI = 460000009123456 MSISDN = 13500001234
OCSI DATA CAMEL = PHASE3 OCSIDP = COLLECTINFO SK = 1 GSMSCFADD = 11234 DEFAULTCALL = continueCall VLR_NOTSUPPHASE1 = AllowLocationUpdateWithODBBAOC VLR_NOTSUPPHASE2 = AllowLocationUpdateWithODBBAOC VLR_NOTSUPPHASE3 = AllowLocationUpdateWithODBBAOC VLR_NOTSUPPHASE4 = AllowLocationUpdateWithODBBAOC GMSC_NOTSUPPHASE1 = ReturnBAIC GMSC_NOTSUPPHASE2 = AllowMTCall GMSC_NOTSUPPHASE3 = ReturnBAIC GMSC_NOTSUPPHASE4 = ReturnLPT-CSI
TCSI DATA CAMEL = PHASE3 TCSIDP = TAA SK = 1 GSMSCFADD = 11234 DEFAULTCALL = continueCall GMSC_NOTSUPPHASE1 = ReturnBAIC GMSC_NOTSUPPHASE2 = ReturnLPT-CSI
All rights reserved.
Page 419 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
GMSC_NOTSUPPHASE3 = ReturnLPT-CSI GMSC_NOTSUPPHASE4 = AllowMTCall PSICONF = TRUE AVAILABLE_PLMN = HPLMN If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.317 Modifying Premium SMS Barring Service Command Name: MOD PREMSMS Function: This command is used to provide or withdraw the SMS Barring service for subscribers. The SMS Barring service restricts the delivery of certain type of short messages to subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
ODBPREMSMS
Boolean
TRUE
Provide PREMSMS barring
O
FALSE
TRUE
Provide ODBADULTSMS barring
O
FALSE
ODBADULTSMS
Boolean
Example: MOD PREMSMS: IMSI="460000009123456", ODBPREMSMS=TRUE, ODBADULTSMS=TRUE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are optional. Specify only one of the them.
All rights reserved.
Page 420 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.318 Listing Premium SMS Barring Service Command Name: LST PREMSMS Function: This command is used to query the SMS Barring service data of subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST PREMSMS: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= { ODBPREMSMS}=< TRUE| FALSE> { ODBADULTSMS}=< TRUE | FALSE> If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.319 Modifying Zone Lock Service Command Name: MOD ZCLOCK Function: This command is used to provide the Zone Lock service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
ZCLOCKPROV
Boolean
TRUE
O
FALSE
Specifies whether the HSS9860 provides the Zone Lock service for subscribers.
TRUE: The HSS9860 provides the Zone Lock service.
FALSE: The HSS9860 does not
All rights reserved.
Page 421 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
provide the Zone Lock service.
Example: MOD ZCLOCK: IMSI="460000009123456", ZCLOCKPROV=TRUE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parametes IMSI and ISDN are optional. Specify only one of the them.
9.320 Listing Zone Lock Service Command Name: LST ZCLOCK Function: This command is used to query whether the HSS provides the Zone Lock service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST ZCLOCK: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {ZCLOCKPROV}=< TRUE| FALSE> If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 422 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.321 Listing Zone Lock Service Data Command Name: LST DYNZC Function: This command is used to query the Zone Lock service data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST DYNZC: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= { ZC1}=< Zone Code> { ZC2}=< Zone Code> { ZC3}=< Zone Code> { ZC4}=< Zone Code> { ZC5}=< Zone Code> { ZC6}=< Zone Code> { ZC7}=< Zone Code> { ZC8}=< Zone Code> { ZC9}=< Zone Code> { ZC10}=< Zone Code> If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.322 Reseting Zone Lock Service Command Name: RESET BINDEDTAI Function: This command is used to reset the Zone Lock service for subscribers.
All rights reserved.
Page 423 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: RESET BINDEDTAI: IMSI="460000009123456"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.323 Modifying the ALS Supplimentary Service Command Name: MOD ALSSUPP Function: This command is used to modify supplementary service data for subscriber's ALS(Alternative Line Service) number . Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides or withdraws the ALS supplementary service.
M
ALS_SUPP_TYPE
Enumerated
Enumerated
TRUE: The HSS9860 provides the ALS supplementary service.
FALSE: The HSS9860 withdraws the ALS supplementary service.
ALS supplimentary service options
M
Example: MOD ALSSUPP: IMSI="460030000000001", PROV=TRUE, ALS_SUPP_TYPE=AOCC; Output:
All rights reserved.
Page 424 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays the following message: RETCODE = 0 SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.324 Modifying the ALS ODB Service Command Name: MOD ALSODB Function: This command is used to modify Operator Determined Barring (ODB) service data for subscriber's Alternative Line Service (ALS) number. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides or withdraws the ALS ODB service.
M
ALS_ODB_TYPE
Enumerated
Enumerated
TRUE: The HSS9860 provides the ALS ODB service.
FALSE: The HSS9860 withdraws the ALS ODB service.
ALS ODB service options
M
Example: MOD ALSODB:IMSI="460000009123456",PROV=TRUE,ALS_ODB_TYPE="ODB-PB1"; Output: If the operation succeeds, the system displays the following message: RETCODE = 0 SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 425 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.325 Modifying the PS Services Command Name: MOD PSSER Function: The command is used to modify the PS services of the subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
PROV
Enumerated
ADDPDPCNTX
Specifies the operation type.
O
MODPDPCNTX
RMVPDPCNTX
ADDPDPCNTX: Add new PDP context ID.
RMVALLCNTX
MODPDPCNTX: Modify PDP context.
RMVPDPCNTX: Remove PDP context.
RMVALLCNTX: Remove All PDP context.
CNTXID
Numeral
1-50
PDP context ID
O
PSAPNQOSTPLID
Numeral
0-65534
PSAPNQOS template ID
O
IPV4ADDIND
Enumerated
STATIC
O
DYNAMIC
Specifies the PDP IPV4 Address Indicator.
IPV4ADD
Character string
0-39
OTHERADDIND
Enumerated
STATIC
DYNAMIC
OTHERADD
Character string
0-39
STATIC: static adress.
DYNAMIC: dynamic adress
PDP IPV4 Address
O
Specifies the other address indicator.
O
STATIC: static adress.
DYNAMIC: dynamic adress.
PDP Other Address
O
Example: MOD PSSER: IMSI="460000009012345", PROV=ADDPDPCNTX, CNTXID=2, PSAPNQOSTPLID=2;
All rights reserved.
Page 426 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
Do not specify Number of subscribers together with Name of IMSI file or Name of MSISDN file.
9.326 Modifying the EPS Services Command Name: MOD EPSSER Function: The command is used to provide EPS service data for GSM/UMTS subscribers to upgrade GSM/UMTS subscribers to GSM/UMTS/EPS or VoLTE subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
PROV
Enumerated
ADDPDNCNTX MODPDNCNTX
RMVPDNCNTX
Specifies the operation to be performed on subscribers' EPS service data.
O
RMVALLCNTX
MODEPSINFO
MODDEFPDN
All rights reserved.
ADDPDNCNTX: The HSS9860 adds a PDN context for subscribers.
MODPDNCNTX: The HSS9860 modifies a PDN context for subscribers.
RMVPDNCNTX: The HSS9860 deletes a PDN context for subscribers.
MODEPSINFO: The HSS9860 modifies basic EPS service data for subscribers.
MODDEFPDN: The HSS9860 modifies the default PDN context for
Page 427 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
subscribes. CNTXID
Numeral
1-50
PDP context ID
O
EPSAPNQOSTPL ID
Numeral
0-65534
EPSAPNQOS template ID
O
IPV4ADDIND
Enumerated
STATIC
PDP IPV4 address indicator
O
DYNAMIC PDP IPV4 address
O
PDP other address indicator
O
IPV4ADD
Character string
0-39
OTHERADDIND
Enumerated
STATIC
DYNAMIC
OTHERADD
Character string
0-39
PDP other address
O
APNOI
Character string
1-63
UE Level APN-O-I replacement
O
AMBRMAXUL
Numeral
1-4294967295
UE level MAX upload bandwidth
O
AMBRMAXDL
Numeral
1-4294967295
UE level MAX download bandwidth
O
RATFREQSELPR IID
Numeral
0-256
RAT frequency selection priority ID
O
DEFAULTCNTXI D
Numeral
1-50
Default PDN context ID
O
Example: MOD EPSSER: IMSI="460000009123456", PROV=ADDPDNCNTX, CNTXID=2, EPSAPNQOSTPLID=2; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 428 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
Do not specify Number of subscribers together with Name of IMSI file or Name of MSISDN file.
9.327 Listing the PS Services Command Name: LST PSSER Function: The command is used to list the PS services of the subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-10000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
DETAIL
Boolean
TRUE
Display subscriber details
O
FALSE
Example: LST PSSER: IMSI="460000009123456", DETAIL=FALSE; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= { CNTXID}=< CNTXID > { APNQOSTPLID }=< APNQOSTPLID > { OTHERADDIND }=< OTHERADDIND > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 429 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
Do not specify Number of subscribers together with Name of IMSI file or Name of MSISDN file.
9.328 Listing the EPS Services Command Name: LST EPSSER Function: The command is used to list the EPS services of the subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-10000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
DETAIL
Boolean
TRUE FALSE
Display subscriber details
O
Example: LST EPSSER: IMSI="460000009123456", DETAIL=FALSE; Output If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= { CNTXID}=< CNTXID > { APNQOSTPLID }=< APNQOSTPLID > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
Do not specify Number of subscribers together with Name of IMSI file or Name of MSISDN file.
9.329 Modify the PS Services by PSUSERTPL Command Name: MOD TPLPSSER
All rights reserved.
Page 430 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: The command is used to modify the PS services by PSUSERTPL. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
TPLID
Numeral
0-65534
PSUSERTPL template ID
M
Example: MOD TPLPSSER: IMSI="460000009123456", TPLID=2; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Do not specify FILE together with IMSI or ISDN.
Number of subscribers cannot be present with IMSI/ISDN and FILE together.
9.330 Modify the EPS Services by EPSUSERTPL Command Name: MOD TPLEPSSER Function: The command is used to modify EPS services by EPSUSERTPL. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
TPLID
Numeral
0-65534
EPSUSERTPL template ID
M
All rights reserved.
Page 431 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Summary of CommandsSummary of Commands
Type
Range
Description
Remarks
Example: MOD TPLEPSSER: IMSI="460000009123456", RECORDCOUNT=4, TPLID=3; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI, MSISDN, Name of IMSI file, Name of MSISDN file are optional. Specify only one of them.
Do not specify Number of subscribers together with Name of IMSI file or Name of MSISDN file.
This command can only be used by subscribers who modify the information of EPS.
9.331 Adding a CS or PS Subscriber Command Name: ADD CSPSSUB Function: This command is used to add CS or PS subscribers to the database. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
1-255
HLR serial number
O
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
FILE
Character string
1-16
Name of IMSI/MSISDN file
O
NAM
Enumerated
BOTH MSC
SGSN
Specifies the type of the network that a subscriber can access.
O
All rights reserved.
BOTH: The subscribers can access both CS and PS networks.
MSC: The subscribers can access CS networks.
SGSN: The subscribers can
Page 432 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
access PS networks. CATEGORY
Enumerated
UNKNOWN
FRENCH
ENGLISH
GERMAN
RUSSIAN
SPANISH
SPECIAL
RESERVE
COMMON
SUPERIOR
DATACALL
TESTCALL
SPARE
PAYPHONE
16
Subscriber category
O
…
31
COIN
33
…
254
MNP
DEFAULTCALL
Enumerated
See "TSCODE and DSCODE Enumeration"
Specifies the default call type for the incoming call without carrying the call type parameter.
O
TS
Character string
40
Specifies the telephony service code.
O
BS
Character string
160
Specifies the bearer service code.
O
CFU
Boolean
TRUE
O
FALSE
Specifies whether the HSS9860 provides the Call Forwarding Unconditional (CFU) service.
CFUOFAID
Numeral
0-65534
TRUE: The HSS9860 provides the CFU service.
FALSE: The HSS9860 does not provide the CFU service.
OFA template ID
O
255 is an invalid value.
All rights reserved.
Page 433 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
CFUNCS
Boolean
TRUE
FALSE
CFUCOU
CFB
CFBOFAID
Enumerated
Boolean
Numeral
OPERATOR
SUBSCRIBER
TRUE
FALSE
0-65534
Description
Remarks
Specifies whether to notify the calling party in the case of CFU.
O
TRUE: The HSS9860 notifies the calling party in the case of CFU.
FALSE: The HSS9860 does not notify the calling party in the case of CFU.
Specifies the party that controls the CFU service.
OPERATOR: The carrier controls the registration, activation, deregistration, and deactivation of the CFU service through the Web UI.
SUBSCRIBER: Both the carrier and the subscriber can control the registration, activation, deregistration, and deactivation of the CFU service. The subscriber can control the CFU service through the MS.
Specifies whether the HSS9860 provides the Call Forwarding on Mobile Subscriber Busy (CFB) service.
TRUE: The HSS9860 provides the CFB service.
FALSE: The HSS9860 does not provide the CFB service.
O
O
OFA template ID
O
Specifies whether the HSS9860 notifies the forwarded-to party in the case of CFB.
O
255 is an invalid value. CFBNFS
CFBNCS
Boolean
Boolean
TRUE
FALSE
TRUE
FALSE
All rights reserved.
TRUE: the HSS9860 notifies forwarded-to party in the case of CFB.
FALSE: The HSS9860 does not notify the forwarded-to party in the case of CFB.
Specifies whether the HSS9860 notifies the calling party in the case of CFB.
O
Page 434 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
CFBCOU
CFNRY
CFNRYOFAID
Type
Enumerated
Boolean
Numeral
Summary of CommandsSummary of Commands
Range
OPERATOR
SUBSCRIBER
TRUE
FALSE
0-65534
Description
Remarks
TRUE: The HSS9860 notifies the calling party in the case of CFB.
FALSE: The HSS9860 does not notify the calling party in the case of CFB.
Specifies the party that controls the CFB service.
OPERATOR: The carrier controls the registration, activation, deregistration, and deactivation of the CFB service through the Web UI.
SUBSCRIBER: Both the carrier and the subscriber can control the registration, activation, deregistration, and deactivation of the CFB service. The subscriber can control the CFB service through the MS.
Specifies whether the HSS9860 provides the Call Forwarding on No Reply (CFNRy) service.
TRUE: The HSS9860 provides the CFNRy service.
FALSE: The HSS9860 does not provide the CFNRy service.
O
O
OFA template ID
O
Specifies whether the HSS9860 notifies the forwarded-to party in the case of CFNRy.
O
255 is an invalid value. CFNRYNFS
CFNRYNCS
Boolean
Boolean
TRUE
FALSE
TRUE
FALSE
TRUE: The HSS9860 notifies the forwarded-to party in the case of CFNRy.
FALSE: The HSS9860 does not notify the forwarded-to party in the case of CFNRy.
Specifies whether the HSS9860 notifies the calling party in the case of CFNRy.
All rights reserved.
O
TRUE: The HSS9860 notifies the calling party in the case
Page 435 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
of CFNRy.
CFNRYCOU
CFNRC
CFNRCOFAID
Enumerated
Boolean
Numeral
OPERATOR
SUBSCRIBER
TRUE
FALSE
0-65534
FALSE: The HSS9860 does not notify the calling party in the case of CFNRy.
Specifies the party that controls the CFNRy service.
OPERATOR: The carrier controls the registration, activation, deregistration, and deactivation of the CFNRy service through the Web UI.
SUBSCRIBER: Both the carrier and the subscriber can control the registration, activation, deregistration, and deactivation of the CFNRy service. The subscriber can control the CFNRy service through the MS.
Specifies whether the HSS9860 provides the Call Forwarding on Mobile Subscriber Not Reachable (CFNRc) service.
TRUE: The HSS9860 provides the CFNRc service.
FALSE: The HSS9860 does not provide the CFNRc service.
O
O
OFA template ID
O
Specifies whether the HSS9860 notifies the calling party in the case of CFNRc.
O
255 is an invalid value. CFNRCNCS
CFNRCOU
Boolean
Enumerated
TRUE
FALSE
OPERATOR
SUBSCRIBER
TRUE: The HSS9860 notifies the calling party in the case of CFNRc.
FALSE: The HSS9860 does not notify the calling party in the case of CFNRc.
Specifies the party that controls the CFNRc service.
All rights reserved.
O
OPERATOR: The carrier controls the registration,
Page 436 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
activation, deregistration, and deactivation of the CFNRc service through the Web UI.
CFD
VALIDCCF
SUPINTERCFD
CFDNFS
CFDNCS
Boolean
Enumerated
Boolean
Boolean
Boolean
TRUE
FALSE
CFB
CFNRy
CFNRc
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
Specifies whether to provide the Call Forwarding-Default (CFD) service.
TRUE: The HSS9860 provides the CFD service.
FALSE: The HSS9860 does not provide the CFD service.
O
Specifies the conditional CF services such as CFB, CFNRy, and CFNRc that can be replaced by the CFD.
O
Specifies whether the HSS9860 provides the CFD service to a subscriber who is in the international roaming.
O
TRUE: The HSS9860 provides the CFD service.
FALSE: The HSS9860 does not provide the CFD service.
Specifies whether the HSS9860 notifies the forwarded-to party in the case of CFD.
TRUE: The HSS9860 notifies the forwarded-to party in the case of CFD.
FALSE: The HSS9860 does not notify the forwarded-to party in the case of CFD.
Specifies whether the HSS9860 notifies the calling party in the case of CFD.
All rights reserved.
SUBSCRIBER: Both the carrier and the subscriber can control the registration, activation, deregistration, and deactivation of the CFNRc service. The subscriber can control the CFNRc service through the MS.
O
O
TRUE: The HSS9860 notifies the calling party in the case
Page 437 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
of CFD.
FALSE: The HSS9860 does not notify the calling party in the case of CFD.
CFDFTN
Character string
1-16
Forward to number
O
CFDBSG
Enumerated
See "CFBSG Enumeration"
Basic service group
O
CFDNRTIME
Numeral
5-60 seconds in steps of 5 seconds
Specifies the no-reply time for triggering the CFD.
O
SUPSHORTNUM
Boolean
TRUE FALSE
Specifies whether the forwarded-to number registered for the CFD service is a short number.
O
ACTCFD CB
CBCOU
Boolean Enumerated
Enumerated
TRUE
FALSE
BAOC
BOIC
BOICEXHC
BAIC
BICROAM,
BORO
OPERATOR
All rights reserved.
TRUE: The forwarded-to number registered for the CFD service is a short number.
FALSE: The forwarded-to number registered for the CFD service is not a short number.
Activate CFD
O
Specifies the type of the Call Barring (CB) services.
O
BAOC: Barring of All Outgoing Calls
BOIC: Barring of Outgoing International Calls
BOICEXHC: Barring of Outgoing International Calls except those directed to the Home PLMN Country
BAIC: Barring of All Incoming Calls
BICROAM: Barring of Incoming Calls When Roaming Outside Home PLMN Country
BORO: Barring of Outgoing Calls When Roaming Outside Home PLMN Country
Specifies the party that controls
O
Page 438 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
CLIP
CLIPOR
BSGCLIP
CLIR
CLIRMODE
Boolean
Boolean
Enumerated
Boolean
Enumerated
Summary of CommandsSummary of Commands
SUBSCRIBER
TRUE
FALSE
TRUE
FALSE
Description
Remarks
the CB services.
OPERATOR: The carrier controls the CB services.
SUBSCRIBER: Both the carrier and the subscriber control the CB services. The subscriber can control the CB services through the MS.
Specifies whether the HSS9860 provides the Calling Line Identification Presentation (CLIP) service.
TRUE: The HSS9860 provides the CLIP service.
FALSE: The HSS9860 does not provide the CLIP service.
Specifies whether the HSS9860 enables the CLIP-override attribute.
TRUE: The HSS9860 enables the CLIP-override attribute.
FALSE: The HSS9860 does not enable the CLIPoverride attribute.
TS1X
TS2X
TS6X
TS1X: telephony service
BS2X
TS2X: short message service
BS3X
TS6X: facsimile service group
BS2X: asynchronous bearer service
BS3X: synchronous bearer service
TRUE
FALSE
PERMANENT
TEMPALLOWED
Specifies the basic service group of CLIP.
All rights reserved.
O
O
Specifies whether the HSS9860 provides the CLIR service.
TRUE: The HSS9860 provides the CLIR service.
FALSE: The HSS9860 does not provide the CLIR service.
Specifies the mode of the CLIR service.
O
O
O
PERMANENT: Permanent
Page 439 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
BSGCLIR
Enumerated
COLPOR
Boolean
TEMPRESTRICTE D
Remarks
restriction, valid for all outgoing calls. When CLIR mode is set to PERMANENT and the calling party is a mobile subscriber, the calling number is not presented to the called party.
TEMPALLOWED: The CLIP service is enabled by default. The CLIR service is activated only when the mobile subscriber dials #31# before the called number to suppress the CLIP service.
TEMPRESTRICTED: The CLIR service is enabled by default. The CLIR service is activated automatically unless the mobile subscriber dials *31# before the called number to suppress the CLIR service.
TS1X
TS2X
TS6X
TS1X: telephony service
BS2X
TS2X: short message service
BS3X
TS6X: facsimile service group
BS2X: asynchronous bearer service
BS3X: synchronous bearer service
Boolean
Description
COLP
Summary of CommandsSummary of Commands
TRUE
FALSE
TRUE
FALSE
Specifies the basic service group of CLIR.
Specifies whether the HSS9860 provides the Connected Line Identification Presentation (COLP) service.
TRUE: The HSS9860 provides the COLR service.
FALSE: The HSS9860 does not provide the COLP service.
Specifies whether the HSS9860 enables the COLP-override attribute.
All rights reserved.
O
O
C
TRUE: The HSS9860 enables the COLP-override attribute.
Page 440 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
BSGCOLP
COLR
BSGCOLR
ECT
CW
Enumerated
Boolean
Enumerated
Boolean
Boolean
Remarks
FALSE: The HSS9860 does not enable the COLPoverride attribute.
TS1X
TS2X
TS6X
TS1X: telephony service
BS2X
TS2X: short message service
BS3X
TS6X: facsimile service group
BS2X: asynchronous bearer service
BS3X: synchronous bearer service
TRUE
FALSE
Specifies the basic service group of COLP.
O
Specifies whether the HSS9860 provides the COLR service.
TRUE: The HSS9860 provides the COLR service.
FALSE: The HSS9860 does not provide the COLR service.
TS1X
TS2X
TS6X
TS1X: telephony service
BS2X
TS2X: short message service
BS3X
TS6X: facsimile service group
BS2X: asynchronous bearer service
BS3X: synchronous bearer service
TRUE
FALSE
TRUE
FALSE
All rights reserved.
Specifies the basic service group of COLR.
O
O
Specifies whether the HSS9860 provides the Explicit Call Transfer (ECT) service.
TRUE: The HSS9860 provides the ECT service.
FALSE: The HSS9860 does not provide the ECT service.
Specifies whether the HSS9860 provides the Call Waiting (CW) service.
TRUE: The HSS9860 provides the CW service.
FALSE: The HSS9860 does not provide the CW service.
O
O
Page 441 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
HOLD
Boolean
TRUE
FALSE
MPTY
AOC
PLMNSPECSS
ODBSS
Boolean
Enumerated
Character string
Boolean
TRUE
FALSE
NONE
AOCI
AOCC
PLMN-SS-1
PLMN-SS-2
PLMN-SS-3
PLMN-SS-4
PLMN-SS-5
PLMN-SS-6
PLMN-SS-7
PLMN-SS-8
PLMN-SS-9
PLMN-SS-A
PLMN-SS-B
PLMN-SS-C
PLMN-SS-D
PLMN-SS-E
PLMN-SS-F
ALLPLMN-SS
TRUE
All rights reserved.
Description
Remarks
Specifies whether the HSS9860 provides the Call Hold (HOLD) service.
O
TRUE: The HSS9860 provides the HOLD service.
FALSE: The HSS9860 does not provide the HOLD service.
Specifies whether the HSS9860 provides the Multiparty (MPTY) service.
TRUE: The HSS9860 provides the MPTY service.
FALSE: The HSS9860 does not provide the MPTY service.
Specifies whether the HSS9860 provides the Advice of Charging (AOC) service.
NONE: The HSS9860 provides the AOC service.
AOCI: The HSS9860 provides the AoCI service.
AOCC: The HSS9860 provides the AoCC service.
O
O
Specifies the type of the PLMNspecific supplementary service.
O
Specifies whether the HSS9860 provides the ODB-Barring of
O
Page 442 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
ODBOC
ODBIC
ODBROAM
Enumerated
Enumerated
Enumerated
Summary of CommandsSummary of Commands
FALSE
NOBOC
BAOC
BOIC
BOICEXHC
BOCROAM
NOBIC
BAIC
BICROAM
NOBAR
BROHPLM
BROHPLMNC
BROHPLMNCGPR S
All rights reserved.
Description
Remarks
Supplementary Services Access (ODB-SS) service.
TRUE: The HSS9860 provides the ODB-SS service.
FALSE: The HSS9860 does not provide the ODB-SS service.
Specifies the type of the ODBoutgoing call.
NOBOC: The HSS9860 does not bar outgoing calls.
BAOC: The HSS9860 bars all outgoing calls.
BOIC: The HSS9860 bars outgoing international calls.
BOICEXHC: The HSS9860 bars outgoing international calls except those directed to the home PLMN country.
BOCROAM: The HSS9860 bars all outgoing calls when the subscriber roams outside the home PLMN country.
Specifies the type of the ODBincoming call.
NOBIC: The HSS9860 does not bar incoming calls.
BAIC: The HSS9860 bars all incoming calls.
BICROAM: The HSS9860 bars incoming calls when the subscriber roams outside the home PLMN country.
Specifies the type of the ODBroaming.
NOBAR: The HSS9860 does not bar roaming.
BROHPLMN: The HSS9860 bars roaming when the subscriber roams outside the home PLMN.
BROHPLMNC: The HSS9860 bars roaming when the subscriber roams outside the home PLMN
O
O
O
Page 443 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
country.
ODBENTE
ODBINFO
ODBRCF
Boolean
Boolean
Enumerated
TRUE
FALSE
TRUE
FALSE
NOBRCF
BRACF
BRICFEXHC
BRICF
All rights reserved.
BROHPLMNCGPRS: The HSS9860 bars GPRS when the subscriber roams outside the home PLMN country.
Specifies whether the HSS9860 provides barring of outgoing premium rate calls (entertainment).
TRUE: The HSS9860 provides barring of outgoing premium rate calls (entertainment).
FALSE: The HSS9860 does not provide barring of outgoing premium rate calls (entertainment).
Specifies whether the HSS9860 provides barring of outgoing premium rate calls (information).
TRUE: The HSS9860 provides barring of outgoing premium rate calls (information).
FALSE: The HSS9860 does not provide barring of outgoing premium rate calls (information).
Specifies the type of the ODB registration of call forwarding (CF).
NOBRCF: The HSS9860 does not bar the registration of call forwarding.
BRACF: The HSS9860 bars the registration of all the call forwarding services.
BRICFEXHC: The HSS9860 bars the registration of any international call forwarding except that directed to the home PLMN country.
BRICF: The HSS9860 bars the registration of international call forwarding.
O
O
O
Page 444 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
ODBECT
Enumerated
NOBECT
BAllECT
BChargeableECT
BInternationalECT
BInterzonalECT
ODBDECT
ODBMECT
ODBPLMN
Boolean
Boolean
Character string
TRUE
FALSE
TRUE
FALSE
See "ODBPLMNCODE"
All rights reserved.
Description
Remarks
Specifies the type of the explicit call transfer barring.
O
NOBECT: The HSS9860 does not bar the explicit call transfer.
BAllECT: The HSS9860 bars all the explicit call transfers.
BChargeableECT: The HSS9860 bars the explicit call transfer when the served party roaming outside the home PLMN pays for at least one of incoming and outgoing calls.
BInternationalECT: The HSS9860 bars the explicit call transfer when the served party roaming internationally pays for at least one of incoming and outgoing calls.
BInterzonalECT: The HSS9860 bars the explicit call transfer when the served party roaming inter-zone pays for at least one of incoming and outgoing calls.
Specifies whether the HSS9860 bars the explicit call transfer when the served party pays for incoming and outgoing calls.
TRUE: The HSS9860 bars the explicit call transfer.
FALSE: The HSS9860 does not bar the explicit call transfer.
Specifies whether the HSS9860 bars the explicit call transfer service if the served party has a call being transferred in the serving MSC/VLR.
TRUE: The HSS9860 bars the explicit call transfer.
FALSE: The HSS9860 does not bar the explicit call transfer.
Specifies the type of the ODB-
O
O
O
Page 445 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
PLMN-specific barring.
ODBPOS
ODBPOSTYPE
Enumerated
Enumerated
See "ODBPOS Enumeration"
See "ODBPOSTYPE Enumeration"
ODBPB1: ODB PLMNspecific barring type 1 (barring of outgoing long distance calls)
ODBPB2: ODB PLMNspecific barring type 2
ODBPB3: ODB PLMNspecific barring type 3
ODBPB4: ODB PLMNspecific barring type 4
Specifies the type of the ODB packet services.
NOBPOS: The HSS9860 does not bar the packet services.
BAPOS: The HSS9860 bars all the packet services.
BHPLMNAPROAM: The HSS9860 bars the packet services from the access points that are within the home PLMN when the subscriber is roaming in the VPLMN.
BALLAPROAM: The HSS9860 bars the packet services from the access points that are within the VPLMN in which the subscriber is roaming.
Specifies the valid ODB PDP context activation.
O
O
BOTH: MS-originated and network-originated PDP context activations are valid.
MSInit: Only MS-originated PDP context activations are valid.
NetworkInit: Only networkoriginated PDP context activations are valid.
OCSI
Numeral
0-65534
O-CSI template ID
O
TCSI
Numeral
0-65534
T-CSI template ID
O
SMSCSI
Numeral
0-65534
MO-SMS-CSI template ID
O
All rights reserved.
Page 446 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
MTSMSCSI
Numeral
0-65534
MT-SMS-CSI template ID
O
DCSI
Numeral
0-65534
D-CSI template ID
O
VTCSI
Numeral
0-65534
VT-CSI template ID
O
MCSI
Numeral
0-65534
M-CSI template ID
O
SSCSI
Numeral
0-65534
SS-CSI template ID
O
TIFCSI
Boolean
TRUE FALSE
Specifies whether to provide the TIF-CSI service.
O
TRUE: The HSS9860 provides the TIF-CSI service.
FALSE: The HSS9860 does not provide the TIF-CSI service.
UCSI
Numeral
0-65534
U-CSI template ID
O
GPRSCSI
Numeral
0-65534
GPRS-CSI template ID
O
LCS
Numeral
0-65534
LCS template ID
O
GPRSTPL
Numeral
0-65534
GPRS template ID
O
VLRLIST
Numeral
0-65534
VLR roaming restriction template ID
O
SGSNLIST
Numeral
0-65534
SGSN roaming restriction template ID
O
SMDP
Enumerated
MSC SGSN
Specifies how the HSS9860 delivers short messages when the MAP_SEND_ROUTING_INF O_FOR_SM message does not carry the gprsSupportIndicator information element.
O
MSC: The HSS9860 delivers the short messages through the MSC.
SGSN: The HSS9860 does not deliver the short messages through the SGSN.
NAEA_CIC
Numeral
0-9999
Specifies the carrier identification code of the NAEA service
O
LINE2NUM
Character string
1-15
Specifies the MSISDN of line 2 in the alternative line service (ALS).
O
VVDN
Boolean
Specifies whether the HSS9860
O
TRUE
All rights reserved.
Page 447 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
FALSE
RBT
Numeral
0-254
UTRANNOTALL OWED
Boolean
TRUE
FALSE
GERANNOTALL OWED
GANNOTALLOW ED
IHSPAENOTALL OWED
Boolean
Boolean
Boolean
TRUE
FALSE
TRUE
FALSE
TRUE
FALSE
All rights reserved.
Description
Remarks
provides the voice and videophone dual number (VVDN) service.
TRUE: The HSS9860 provides the VVDN service.
FALSE: The HSS9860 does not provide the VVDN service.
Specifies the index of the ring back tone (RBT) service.
O
Specifies whether subscribers are restricted from accessing a universal terrestrial radio access network (UTRAN).
O
TRUE: Subscribers are restricted from accessing a UTRAN.
FALSE: Subscribers are allowed to access a UTRAN.
Specifies whether subscribers are restricted from accessing a GSM/EDGE radio access network (GERAN).
TRUE: Subscribers are restricted from accessing a GERAN.
FALSE: Subscribers are allowed to access a GERAN.
Specifies whether subscribers are restricted from accessing a general access network (GAN).
TRUE: Subscribers are restricted from accessing a GAN.
FALSE: Subscribers are allowed to access a GAN.
Specifies whether subscribers are restricted from accessing an I-HSPA-Evolution network.
TRUE: Subscribers are restricted from accessing an I-HSPA-Evolution network.
FALSE: Subscribers are allowed to access an IHSPA-Evolution network.
O
O
O
Page 448 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
EUTRANNOTAL LOWED
Boolean
TRUE
FALSE
N3GPPNOTALLO WED
Boolean
TRUE
FALSE
CARP
Numeral
1-255
RROPTION
Enumerated
ALL_PLMNS
ONE_NPLMN_AL L_FPLMNS
ONLY_HPLMN
RR_TEMPLATE
Description
Remarks
Specifies whether subscribers are restricted from accessing an evolved universal terrestrial radio access network (EUTRAN).
O
TRUE: Subscribers are restricted from accessing an E-UTRAN.
FALSE: Subscribers are allowed to access an EUTRAN.
Specifies whether subscribers are restricted from accessing a non-3GPP network.
TRUE: Subscribers are restricted from accessing a non-3GPP network.
FALSE: Subscribers are allowed to access a non3GPP network.
O
Specifies the CS allocation/retention priority.
O
Specifies the area to which a subscriber can roam.
O
ALL_PLMNS: The subscriber is allowed to roam to all PLMNs.
ONE_NPLMN_ALL_FPLM NS: The subscriber is allowed to roam in the home PLMN and other international PLMNs.
ONLY_HPLMN: The subscriber is allowed to roam in the home PLMN.
RR_TEMPLATE: Roaming is restricted by the regional roaming template.
RRTPL
Numeral
0-65534
Specifies the ID of a regional roaming template.
C
VBS
Numeral
0-65534
VBS template ID
O
VGCS
Numeral
0-65534
VGCS template ID
O
EMLPP_MAX
Enumerated
priorityLevel0
O
priorityLevel1
Maximum precedence level for eMLPP Supplementary service
All rights reserved.
Page 449 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
EMLPP_DEF
EMLPP_COU
Type
Enumerated
Enumerated
Summary of CommandsSummary of Commands
Range
priorityLevel2
priorityLevel3
priorityLevel4
priorityLevel0
priorityLevel1
priorityLevel2
priorityLevel3
priorityLevel4
OPERATOR
SUBSCRIBER
Description
Remarks
Default precedence level for eMLPP Supplementary service
O
Specifies the eMLPP control party.
O
OPERATOR: The operator controls the default eMLPP priority, but the subscriber cannot control it.
SUBSCRIBER: Both the operator and the subscriber can control default eMLPP priority. The subscriber can control it through the MS.
ECATEGORY
Numeral
1-254
Enhanced category
O
ECATOPTION
Numeral
0-127
Enhanced category extension
O
UUS
Enumerated
UUS1
O
UUS2
UUS3
Specifies the type of the Userto-User Signaling (UUS) service.
SMSCF
SMSCFOFAID
Boolean
Enumerated
TRUE
FALSE
0-65534
UUS1: sending and receiving UUI during a call
UUS2: sending UUI upon ringing
UUS3: sending and receiving UUI upon connection establishment
Specifies whether the HSS9860 provides the short message service call forwarding (SMSCF).
TRUE: The HSS9860 provides the SMSCF.
FALSE: The HSS9860 does not provide the SMSCF.
SMSCF OFA template ID
O
O
255 is an invalid value.
All rights reserved.
Page 450 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
MC
Boolean
TRUE
FALSE
Description
Remarks
Specifies whether the HSS9860 provides the MC service.
O
TRUE: The HSS9860 provides the MC service.
FALSE: The HSS9860 does not provide the MC service.
NBRSB
Numeral
2-7
Maximum MC attempts allowed
O
NBRUSER
Numeral
1-7
User determined maximum MC attempts
O
IST
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides the Immediate Service Termination (IST) service.
O
ISTTIMER
Numeral
15-255
ISTRSP
Enumerated
EMPTY NEW_ALERT_ TIMER TERMINATECAL LACTIVITYREFE RRED
TERMINATEALLC ALLACTIVITIES
WITHDRAW
TRUE: The HSS9860 provides the IST service.
FALSE: The HSS9860 does not provide the IST service.
IST scheduled period
O
Specifies how the HSS9860 processes the MAP_IST_Alert message.
O
EMPTY: The HSS9860 does not take any action.
NEW_ALERT_TIMER: The HSS9860 uses the new scheduled period.
TERMINATECALLACTIV ITYREFERRED: The HSS9860 terminates the current activity at once.
TERMINATEALLCALLA CTIVITIES: The HSS9860 terminates all the activities at once.
WITHDRAW: The HSS9860 withdraws the IST service.
OPTGPRSTPLID
Numeral
0-65534
Optimized GPRS template ID
O
CHARGE_GLOB AL
Enumerated
NONE
Global charging characteristic
O
HOT FLAT PREPAID NORMAL 3
All rights reserved.
Page 451 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
Standard global charging characteristics
O
Length of DIC
O
5 6 7 9 10 11 12 13 14 15 16-254 SCHARGE_GLO BAL
Character string
0000-FFFF
DICLENGTH
Enumerated
DICR_0-0
DICR_1-1
DICR_2-2
DICR_3-3
DICR_4-4
DICR_5-5
DICR_6-6
DICR_7-7
DICR_8-8
DICR_9-9
DICR_10-10
DICR_11-11
DICR_12-12
DICR_13-13
DICR_14-14
DICR_15-15
DICR_16-16
DICV-127
ROUTECATEGO RY
Numeral
1-255
Routing category
O
CALLREDIRECT
Numeral
0-255
Call redirection category
O
NRBT
Numeral
1-65535
NRBT index
O
OSK
Numeral
1-999
EOCSI service key
O
TSK
Numeral
1-999
ETCSI service key
O
EXEXROUTECA
Numeral
1-2147483647
Expand routing category
O
All rights reserved.
Page 452 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Summary of CommandsSummary of Commands
Type
Range
Boolean
TRUE
FALSE
Description
Remarks
Specifies whether the HSS9860 provides the MERBT service.
O
TEGORY MERBT
NIRPROV
Boolean
TRUE
FALSE
TRUE: The HSS9860 provides the MERBT service.
FALSE: The HSS9860 does not provide the MERBT service.
Specifies whether the HSS9860 provides the NIR service.
TRUE: The HSS9860 provides the NIR service.
FALSE: The HSS9860 does not provide the NIR service.
O
NIRINDEX
Numeral
0-999
NIR index
O
RZONE
Numeral
0-9
RZONE index
O
CCBS
Boolean
TRUE
O
FALSE
Specifies whether the HSS9860 provides the Completion of Calls to Busy Subscriber (CCBS) service.
CCBSTARGET
ACR_STATUS
SMSROUTETPL
Boolean
Boolean
Numeral
TRUE
FALSE
TRUE
FALSE
0-65534
All rights reserved.
TRUE: The HSS9860 provides the CCBS service.
FALSE: The HSS9860 does not provide the CCBS service.
Specifies whether the HSS9860 provides the CCBS target service.
TRUE: The HSS9860 provides the CCBS target service.
FALSE: The HSS9860 does not provide the CCBS target service.
Specifies whether the HSS9860 provides the ACR service.
TRUE: The HSS9860 provides the ACR service.
FALSE: The HSS9860 does not provide the ACR service.
SMS-ROUTE template ID
O
O
O
Page 453 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
SMSINPROV
Boolean
TRUE
FALSE
Description
Remarks
Specifies whether the HSS9860 provides the NSMSIN service.
O
TRUE: The HSS9860 provides the NSMSIN service.
FALSE: The HSS9860 does not provide the NSMSIN service.
SCPADD
Character string
1-15
Service control point address
O
SKEY
Numeral
0-2147483647
NSMSIN service key
O
DP
Enumerated
MO MT
SR
Specifies the detection point where the IN service is triggered for the short message service.
O
TAMM
Boolean
TRUE
FALSE
DEFAULTOFA_I D
Numeral
0-65534
CPP
Boolean
TRUE
FALSE
ELCS
Boolean
TRUE
FALSE
FRAUDTPLID
Numeral
0-65534
CNAP
Boolean
TRUE
All rights reserved.
MO: The IN service is triggered when the SMS is originated.
MT: The IN service is triggered when the SMS is terminated.
SR: The IN service is triggered when the status report is delivered.
Triggering all multiple messages
O
Default OFA template ID
O
Specifies whether the HSS9860 provides the calling party pays (CPP) service.
O
TRUE: The HSS9860 provides the CPP service.
FALSE: The HSS9860 does not provide the CPP service.
Specifies whether the HSS9860 provides the ELCS service.
TRUE: The HSS9860 provides the ELCS service.
FALSE: The HSS9860 does not provide the ELCS service.
O
Fraud prevention template ID
O
Specifies whether the HSS9860
O
Page 454 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
CNAPOR
IMEILCKPROV
Boolean
Boolean
Summary of CommandsSummary of Commands
FALSE
TRUE
FALSE
TRUE
FALSE
IMSIIMEIBIND
Character string
14
M2MNOTIFY
Enumerated
TRUE
FALSE
LU
LUCSI_TPL_ID
Numeral
0-65534
USERCATEGOR Y
Enumerated
NORMAL
M2M
Description provides the Calling Name Presentation (CNAP) service.
TRUE: The HSS9860 provides the CNAP service.
FALSE: The HSS9860 does not provide the CNAP service.
Specifies whether the HSS9860 enables the CNAP-override attribute.
TRUE: The HSS9860 enables the CNAP-override attribute.
FALSE: The HSS9860 does not enable the CNAPoverride attribute.
Specifies whether the HSS9860 provides the M2M binding service.
TRUE: The HSS9860 provides the M2M binding service.
FALSE: The HSS9860 does not provide the M2M binding service.
O
O
IMEI bound with IMSI
O
Specifies whether the HSS9860 provides or withdraws the status notification to third-party service for a subscriber.
O
TRUE(1): The HSS9860 provides the M2M notification service for a subscriber.
FALSE(0): The HSS9860 withdraws the status notification to third-party service for a subscriber.
LU(2): The HSS9860 provides the location update notification service for a subscriber.
LU-CSI template ID
O
Specifies whether the subscriber is an M2M user.
O
All rights reserved.
Remarks
NORMAL: NORMAL USER
Page 455 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
ODBPREMSMS
Enumerated
TRUE FALSE
ODBADULTSMS
Enumerated
TRUE FALSE
Remarks
M2M: M2M USER
Specifies whether the HSS9860 restricts the delivery of premium short messages.
TRUE: The HSS9860 restricts the delivery of premium short messages.
FALSE: The HSS9860 does not restrict the delivery of premium short messages.
Specifies whether the HSS9860 restricts the delivery of adult short messages.
TRUE: The HSS9860 restricts the delivery of adult short messages.
FALSE: The HSS9860 does not restrict the delivery of adult short messages.
O
O
BOSK
Numeral
1-999
BEOCSI service key
O
ZCLOCKPROV
Enumerated
TRUE
Specifies whether the HSS9860 provides the Zone Lock service for subscribers.
O
FALSE
TRUE: The HSS9860 provides the Zone Lock service.
FALSE: The HSS9860 does not provide the Zone Lock service.
PSUSERTPLID
Numeral
0-65534
PS user template ID
O
PSAPNOITPLID
Numeral
0-65534
PS domain UE-level APNOI template ID
O
65535 is an invalid value M2MCISDN
Character string
1-15
M2M common MSISDN
O
MAPADDRREST PLID
Numeral
0-65534
MAP address restriction template ID
O
TSK
Numeral
1–999
ETCSI service key
O
ETCSICONVER_ TPLID
Numeral
0-65534
ETCSI conversion template ID
O
DND
Boolean
TRUE FALSE
Whether to provide the DND service
O
All rights reserved.
Page 456 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
VMCC
Boolean
TRUE
FALSE
Description
Remarks
Provide VMCC
O
Example: ADD CSPSSUB: HLRSN=1, IMSI="460000009123456", ISDN="460000009012389", NAM=BOTH, DEFAULTCALL=TS11, CHARGE_GLOBAL=5; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI/MSISDN and Name of IMSI/MSISDN file are optional. Specify either IMSI/MSISDN or Name of IMSI/MSISDN file.
Number of subscribers can be only specified together with IMSI/MSISDN to add the subscribers with consecutive numbers in batches.
Name of IMSI/MSISDN file specifies the batch operation file that contains inconsecutive IMSIs and their associated MSISDNs. The file is used for adding a batch of subscribers.
If Provide CFU is set to TRUE, CFU notification to calling party and CFU control party are mandatory, and CFU OFA template ID is optional.
If Provide CFB is set to TRUE, CFB notification to calling party, CFB notification to forwarded-to party, and CFB control party are mandatory, and CFB OFA template ID is optional.
If Provide CFNRy is set to TRUE, CFNRy notification to calling party, CFNRy notification to forwarded-to party, and CFNRy control party are mandatory, and CFNRy OFA template ID is optional.
If Provide CFNRc is set to TRUE, CFNRc notification to calling party and CFNRc control party are mandatory, and CFNRc OFA template ID is optional.
If Provide CFD is set to TRUE, CFD notification to forwarded-to party, CFD notification to calling party, and CFD forwarded-to number are mandatory, and CFD basic service group and CFD no reply time are optional.
If Provide CLIP is set to TRUE, CLIP override enable is mandatory.
If Provide CLIR is set to TRUE, CLIR mode is mandatory.
If Provide COLP is set to TRUE, COLP override enable is mandatory.
If Provide CNAP is set to TRUE, CNAP override enable is mandatory.
If Provide IST is set to TRUE, IST scheduled period and IST Output process are mandatory.
Before providing the MPTY service for a subscriber, you must provide the HOLD service for the subscriber.
If you specify Global charging characteristic or Standard Global charging characteristic, you cannot specify GPRS template ID.
When providing the GPRS service for subscribers using Optimized GPRS template ID, you must set GPRS management mode in the SET MAPSERV command to SuppGprsManageOptimizeon.
To provide any of the BAOC, BOIC, BOICEXHC, BAIC, and BICROAM services, you must specify CB control party.
Before adding a subscriber, run the ADD KI command to load KI for the subscriber.
All rights reserved.
Page 457 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
When the PGW is configured with only one virtual HLR, the HLR serial number parameter is not required. When the PGW is configured with multiple virtual HLRs, you must specify this parameter.
The subscribed services affect the performance and free size of the HLR database. It is suggested not to provide the services that are not required.
To provide the ODB-POS service, you must specify both ODB of packet oriented service and ODB of packet oriented service type.
Before providing the ACR service for a subscriber, ensure that the subscriber has been provided with the CLIP service.
If Provide NIR is set to TRUE, NIR index is mandatory.
If Enhanced category extension is set to a valid value, Enhanced category is mandatory.
If ODBROAM is set to BROHPLMN, BROHPLMNC, or BROHPLMNCGPRS, the HSS9860 checks the network type based on the host name or realm name and the value of Whether to deliver ODB for roaming in EPS by LST MAPCONF to determine whether to deliver ODB data for subscribers roaming in EPS networks. The value of Whether to deliver ODB for roaming in EPS is set by SET MAPCONF.
The parameter DND can be specified only when NAM is set to MSC or BOTH.
9.332 Modify the EPS by Template Command Name: MOD TPLEPS Function: The command is used to modify the EPS by template. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
EPSUSERTPLID
Numeral
0-65534
EPS template ID
M
DIAMNODETPL_ID
Numeral
0-65534
Diameter roaming restriction template ID
O
Example: MOD TPLEPS: IMSI="460000009123456", EPSUSERTPLID=2; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 458 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMSI, ISDN, IMSIFILE and ISDNFILE are optional. Specify only one of them.
Do not specify Number of subscribers together with Name of IMSI file or Name of MSISDN file.
9.333 Removing a CS or PS Subscriber Command Name: RMV CSPSSUB Function: The command is used to delete one or more subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
RMVKI
Boolean
TRUE FALSE
Specifies whether the HSS9860 deletes subscriber's individual subscriber authentication key (KI) together with the subscriber.
O
SUPCAN
Enumerated
SUPPRESSI ON
UNSUPPRE SSION
TRUE: The HSS9860 deletes the KI together with the subscriber.
FALSE: The HSS9860 does not delete the KI together with the subscriber.
Specifies whether the HSS9860 restricts the delivery of messages after deleting subscribers.
O
SUPPRESSION: The HSS9860 restricts the delivery of messages after deleting subscribers.
UNSUPPRESSION: The HSS9860 does not restrict the delivery of messages after deleting subscribers.
Example: RMV CSPSSUB: ISDN="13310911001"; Output: If the operation succeeds, the system displays one of the following messages:
All rights reserved.
Page 459 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Specify one of the following parameters: IMSI, MSISDN, Name of IMSI file, or Name of MSISDN file.
If you specify Number of subscribers, do not specify Name of IMSI file or Name of MSISDN file. Similarly, if you specify Name of IMSI file or Name of MSISDN file, do not specify Number of subscribers.
To run RMV CSPSSUB to delete a CS or PS subscriber, the CS or PS subscriber must have not subscribed to the EPS services.
9.334 Querying global charging characteristic Command Name: LST CCGLOBAL Function: The command is used to query subscribers' global charging characteristic. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-10000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
Example: LST CCGLOBAL: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= { CHARGE_GLOBAL }=< CHARGE_GLOBAL > If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 460 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMSI, ISDN, IMSIFILE, and ISDNFILE are optional. Specify only one of them.
Do not specify Number of subscribers together with Name of IMSI file or Name of MSISDN file.
9.335 Modify Global Charging Characteristic Command Name: MOD CCGLOBAL Function: The command is used to modify global charging characteristic. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
CHARGE_GLOBAL
Enumerated
NONE HOT
Global charging characteristic
O
FLAT
PREPAID
NORMAL
3
5
6
7
9-254 Standard global charging characteristic
O
SCHARGE_GLOBAL
Character string
0000-FFFF
Example: MOD CCGLOBAL: IMSI="460000009123456", CHARGE_GLOBAL=NORMAL; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 461 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMSI, ISDN, IMSIFILE and ISDNFILE are optional. Specify only one of them.
Do not specify Number of subscribers together with Name of IMSI file or Name of MSISDN file.
9.336 Adding a Subscriber by CSPS Template Command Name: ADD TPLCSPSSUB Function: This command is used to define one or more subscribers and provide CS or PS services for them using a CSPS template. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
1-255
HLR serial number
M
IMSI
Character string
6-15
IMSI number
O
ISDN
Character string
1-15
MSISDN number
O
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
FILE
Character string
1-16
Name of IMSI/MSISDN file
O
CSPSTPLID
Numeral
0-65534
CSPS subscriber template ID
M
M2MCISDN
Character string
1-15
M2M common MSISDN
O
Example: ADD TPLCSPSSUB: HLRSN=123, IMSI="460000009012345", ISDN="460000009056789", CSPSTPLID=124; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMSI/ISDNFILE are optional. Specify either of them.
Do not specify Number of subscribers together with Name of IMSI file or Name of MSISDN file.
Name of IMSI/MSISDN file specifies the batch operation file that contains inconsecutive IMSIs and their associated MSISDNs. The file is used for adding a batch of subscribers.
9.337 Add a Convergent HSS Subscriber Using Template Command Name: ADD TPLUSCSUB
All rights reserved.
Page 462 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to add a subscriber to the HSS database so that they can use services on GSM, UMTS, EPS, and IMS networks. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
1-255
HLR serial number
M
IMSI
Character string
6-15
IMSI
M
ISDN
Character string
6-15
ISDN
M
TPLID
Numeral
0-65534
Subscriber template ID
M
LINE2NUM
Character string
1-15
MSISDN of line 2
C
STNSR
Character string
3-15
Session transfer number for SRVCC
C
ANCHOR
Enumerated
TRUE
Anchor flag
C
FALSE
SELECTIVE
TCSI
PRE_FALSE
PRE_TRUE
SUBID
Character string
1-127
SUBID
M
IMPI
Character string
1-127
IMPI
M
IMPI2
Character string
1-127
IMPI2
C
IMPI2AUTHTYPE
Enumerated
HAD
Authentication type of IMPI2
C
TAA
SDA
HUSERNAME2
Character string
1-127
User name2
C
PWD2
Character string
1-128
Password2
C
REALM2
Character string
1-46
Realm2
C
HA12
Character string
32
HA1 value2
C
IMPULIST
Character string
1-1300
IMPU list
M
BARIMPULIST
Character string
1-1300
Barring IMPU list
C
CONSFLG
Boolean
TRUE/FALSE
Consistency flag
C
CHARGTPLID
Numeral
0-254
Charging address template ID
C
IMPUTPLID
Numeral
0-254
IMPU template ID
C
SPTPLID
Numeral
0-254
Service profile template ID
C
IRSID
Numeral
0-255
IRS ID
C
All rights reserved.
Page 463 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ALIASID
Numeral
0-255
Alias group ID
C
CAPTPLID
Numeral
0-254
Capability set template ID
C
Example: ADD TPLUSCSUB: HLRSN=1, IMSI="460000009123456", ISDN="8613484929766", TPLID=2, SUBID="subinfo", IMPI="impiinfo", IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\"", IRSID=1, ALIASID=1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
9.338 Remove a Convergent HSS Subscriber Command Name: RMV USCSUB Function: This command is used to delete a subscriber who can use services on GSM, UMTS, EPS, and IMS networks. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
SUPCAN
Enumerated
SUPPRESSION UNSUPPRESSION
Specifies whether the HSS9860 restricts the delivery of messages after deleting subscribers.
O
SUPPRESSION: The HSS9860 restricts the delivery of messages after deleting subscribers.
UNSUPPRESSION: The HSS9860 does not restrict the delivery of messages after deleting subscribers.
Example: RMV USCSUB: IMSI="460000009123456";
All rights reserved.
Page 464 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.339 Modifying the CAPL Service Command Name: MOD CAPL Function: This command is used to provide or withdraw the Channel Allocation Priority Level (CAPL) service from a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
CAPLPROV
Boolean
TRUE FALSE
Specifies whether the HSS9860 provides the CAPL service.
C
CAPL
Numeral
1-15
TRUE: The HSS9860 provides the CAPL service.
FALSE: The HSS9860 withdraws the CAPL service.
CAPL service level
C
Example: MOD CAPL: IMSI="460000009123456", CAPLPROV=TRUE, CAPL=2; Output: If the operation succeeds, the system displays the following message:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 465 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.340 Listing the CAPL Service Command Name: LST CAPL Function: This command is used to query the CAPL service data of subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST CAPL: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= < IMSI Number > {ISDN}=< MSISDN Number > CAPL = If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.341 Modifying the EMMIN Service Command Name: MOD EMMIN Function: This command is used to provide or withdrawn the Mobility Management IN Triggering (MMINT) service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
PROV
Enumerated
This parameter specifies whether the HSS9860 provides the
M
ADD
All rights reserved.
Page 466 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
MOD
MMINT service for a subscriber.
DEL
DEL_ALL
ACTIVE_ALL
ADD: The HSS9860 provides the MMINT service for a subscriber.
MOD: The HSS9860 modifies the MMINT service record for a subscriber.
DEL: The HSS9860 deletes the MMINT service record related to the specified detection point.
DEL_ALL: The HSS9860 deletes all the MMINT service records for a subscriber.
ACTIVE_ALL: The HSS9860 activates or deactivates all the MMINT services provided for a subscriber.
DP
Numeral
0-255
Detection point
C
SCPADDR
Character string
1-15
SCP address
C
SK
Numeral
0-2147483647
Service key
C
ACTIVE
Enumerated
TRUE
C
FALSE
Specifies whether the MMINT service is activated.
TRUE: The MMINT service is activated.
FALSE: The MMINT service is not activated.
Example: MOD EMMIN: IMSI="1234567", PROV=ADD, DP=12, SCPADDR="1111", SK=12; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 467 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Specify one of the following parameters: IMSI, MSISDN, Name of IMSI file, and Name of MSISDN file.
If you specify Number of subscribers, do not specify Name of IMSI file or Name of MSISDN file. Similarly, if you specify Name of IMSI file or Name of MSISDN file, do not specify Number of subscribers.
9.342 Listing the EMMIN Service Command Name: LST EMMIN Function: This command is used to query the Mobility Management IN Triggering (MMINT) activation status. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
ACTIVE
Enumerated
TRUE
C
FALSE
Specifies the MMINT activation status.
TRUE: The MMINT service is activated.
FALSE: The MMINT service is not activated.
Example: LST EMMIN: IMSI="1234567"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= < IMSI Number > {ISDN}=< MSISDN Number > {CAPL} = {DP} = {SK} = {SCPADDR} = {ACTIVE} = < TRUE| FALSE>
All rights reserved.
Page 468 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Specify one of the following parameters: IMSI, MSISDN, Name of IMSI file, and Name of MSISDN file.
If you specify Number of subscribers, do not specify Name of IMSI file or Name of MSISDN file. Similarly, if you specify Name of IMSI file or Name of MSISDN file, do not specify Number of subscribers.
9.343 Modifying the Association Between IMSI and MSISDN Command Name: MOD IMSIISDN Function: This command is used to bind subscribers' auxiliary IMSIs with their auxiliary MSISDNs or unbind subscribers' IMSIs from their MSISDNs. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
FILE
Character string
1-16
Name of IMSI/MSISDN file
O
PROV
Enumerated
ADD
Operation type
M
MOD
DEL
DEL_ALL
ACTIVE_ALL
Example: MOD IMSIISDN: IMSI="2013521", ISDN="2014521", PROV=TRUE; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 469 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Specify both IMSI and MSISDN or Name of IMSI/MSISDN file.
The subscribers whose auxiliary IMSIs to be bound with their auxiliary MSISDNs have been defined.
An auxiliary IMSI can be bound with one auxiliary MSISDN. An auxiliary MSISDN can be bound with multiple auxiliary IMSIs.
9.344 Listing the Association Between IMSI and MSISDN Command Name: LST IMSIISDN Function: This command is used to query the binding between subscribers' auxiliary IMSIs and their auxiliary MSISDNs. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
RECORDCOUNT
Numeral
1-100000
Number of subscribers
O
IMSIFILE
Character string
1-16
Name of IMSI file
O
ISDNFILE
Character string
1-16
Name of MSISDN file
O
Example: LST IMSIISDN: IMSI="45000000"; Output: If the operation succeeds, the system displays an output with the following format: RETCODE = 0 SUCCESS0001: Operation is successfuL IMSI = 45000000 ISDN = 2014521 "Auxilary IMSI" "Band MSISDN" 45000001
2013522
45000002
2013523
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 470 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Specify one of the following parameters: IMSI, MSISDN, Name of IMSI file, or Name of MSISDN file.
If you specify Number of subscribers, do not specify Name of IMSI file or Name of MSISDN file. Similarly, if you specify Name of IMSI file or Name of MSISDN file, do not specify Number of subscribers.
9.345 Modify VoLTE Subscriber Flag Command Name: MOD VOLTETAG Function: This command is used to modify the VoLTE flag of subscribers. The VoLTE flag specifies whether a subscriber is a VoLTE subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
RECORDCOUNT
Numeral
1-100000
Number of subscribers
C
IMSIFILE
Character string
1-16
Name of IMSI file
C
ISDNFILE
Character string
1-16
Name of MSISDN file
C
VOLTETAG
Enumerated
VoLTE subscriber flag
M
TRUE
FALSE
Example: MOD VOLTETAG: IMSI="46000000012345", VOLTETAG=FALSE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 471 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Specify one of the following parameters: IMSI, MSISDN, Name of IMSI file, or Name of MSISDN file.
If you specify Number of subscribers, do not specify Name of IMSI file or Name of MSISDN file. Similarly, if you specify Name of IMSI file or Name of MSISDN file, do not specify Number of subscribers.
RECORDCOUNT specifies the number of subscribers to be provided with the VoLTE flag at a time.The parameter value is the total number of consecutive subscriber numbers starting from the specified IMSI or MSISDN.Specify this parameter only when you want to configure the VoLTE subscriber flag for multiple subscribers with consecutive IMSIs or MSISDNs.
IMSIFILE specifies the name of an IMSI file to be used to configure the VoLTE subscriber flag for multiple subscribers with non-consecutive IMSIs.An IMSI file contains multiple non-consecutive IMSIs. It is in ANSI format, for example, lstisdn.txt. You can use the file manager function of the PGW Web LMT to upload an IMSI file to a specified directory. For details about the file content, see IMSI file content.
ISDNFILE specifies the name of an MSISDN file to be used to configure the VoLTE subscriber flag for multiple subscribers with non-consecutive MSISDNs.An MSISDN file contains multiple nonconsecutive MSISDNs. It is in ANSI format, for example, lstisdn.txt. You can use the file manager function of the PGW Web LMT to upload an MSISDN file to a specified directory. For details about the MSISDN file content, see MSISDN file content.
9.346 List VoLTE Subscriber Flag Command Name: LST VOLTETAG Function: This command is used to query subscribers’s VoLTE flag:
To query the VoLTE flag of a single subscriber, specify IMSI or MSISDN.
To query the VoLTE flag of multiple subscribers with consecutive IMSIs or MSISDNs, specify IMSI or MSISDN and Number of subscribers.
To query the VoLTE flag of multiple subscribers with non-consecutive IMSIs or MSISDNs, specify Name of IMSI file or Name of MSISDN file.
Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
RECORDCOUNT
Numeral
1-100000
Number of subscribers
C
IMSIFILE
Character string
1-16
Name of IMSI file
C
ISDNFILE
Character string
1-16
Name of MSISDN file
C
Example: LST VOLTETAG: IMSI="46000000012345"; Output: If the operation succeeds, the system displays an output with the following format:
All rights reserved.
Page 472 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{IMSI}= {MAINIMSI}= {ISDN}= {MAINISDN}= {VOLTETAG}= If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Specify one of the following parameters: IMSI, MSISDN, Name of IMSI file, or Name of MSISDN file.
If you specify Number of subscribers, do not specify Name of IMSI file or Name of MSISDN file. Similarly, if you specify Name of IMSI file or Name of MSISDN file, do not specify Number of subscribers.
9.347 Modify an UE-Level APN Operator Identifier Used in the PS Domain Command Name: MOD PSAPNOI Function: This command is used to provide a UE-level APN operator identifier (APNOI) for PS subscribers or withdraw the UE-level APNOI from PS subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Enumerated
TRUE
M
FALSE
specifies whether the HSS9860 provides a UE-level APNOI for or withdraws the UElevel APNOI from PS subscribers.
PSAPNOITPLID
Numeral
0-65534
TRUE: The HSS9860 provides a UElevel APNOI for PS subscribers.
FALSE: The HSS9860 withdraws the UE-level APNOI from PS subscribers.
PS domain UE-level APNOI template ID
C
Example: MOD PSAPNOI: IMSI="460000009123456", PROV =TRUE, PSAPNOITPLID = 1; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
All rights reserved.
Page 473 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Specify either IMSI or MSISDN.
The parameter PSAPNOITPLID must be specified if the parameter PROV is set to TRUE.
9.348 List UE-Level APN Operator Identifier Used in the PS Domain Command Name: LST PSAPNOI Function: This command is used to query the UE-level APN operator identifier (APNOI) provided for PS subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST PSAPNOI: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {PSAPNOITPLID}=< 0-65534> If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes." Specify either IMSI or MSISDN.
9.349 Add a KI Command Name: ADD HKI Function: This command is used to add a KI data record to the HSS service database. The KI is a parameter used for AKA authentication. Parameter Description:
All rights reserved.
Page 474 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
K
Character string
32
KI value
M
K4SNO
Numeral
0-128
K4 serial number
M
OPSNO
Numeral
0-128
OP serial number
M
AMFSNO
Numeral
1-128
AMF serial number
M
OPC
Character string
32
OPC value
C
OPCK4SNO
Numeral
0-128
OPC K4 serial number
C
Example: ADD HKI: IMPI="impiinfo", K="1234567890abcdef1234567890ABCDEF", K4SNO=1, OPSNO=1, AMFSNO=1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Ki and OPC are important parameters used for authentication. You are advised to encrypt the KI and OPC. If the KI and OPC have been encrypted, run ADD HKI and specify the encryption parameters.
If you enter the command in the command input pane and then specify the related parameters, the KI value and OPC value are displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the KI value and OPC value are displayed in plain text.
9.350 Remove a KI Command Name: RMV HKI Function: This command is used to remove a KI data record from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI Number
M
Example: RMV HKI: IMPI="impiinfo";
All rights reserved.
Page 475 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.351 Modify a KI Command Name: MOD HKI Function: This command is used to modify the KI value of the specified KI data record in the HSS service database. The IMPI is the key parameter used to determine the KI data record to be modified. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
K
Character string
32
KI value
C
K4SNO
Numeral
0-128
K4 serial number
C
OPSNO
Numeral
0-128
OP serial number
C
AMFSNO
Numeral
1-128
AMF serial number
C
OPC
Character string
32
OPC value
C
OPCK4SNO
Numeral
0-128
OPC K4 serial number
C
Example: MOD HKI: IMPI="impiinfo", K="abcdef1234567890ABCDEF1234567890", K4SNO=1, OPSNO=0, AMFSNO=1, OPC="ABCDef1234567890ABCDef1234567890", OPCK4SNO=1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 476 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameters K, K4SNO, OPSNO, and AMFSNO are optional, and you must specify one of them at least.
If you enter the command in the command input pane and then specify the related parameters, the KI value and OPC value are displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the KI value and OPC value are displayed in plain text.
9.352 List KIs Command Name: LST HKI Function: This command is used to query the information of a KI data record in the HSS service database. The system supports the query of one KI data record at a time. The IMPI is the key parameter used to determine the KI data record to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: LST HKI: IMPI="impiinfo"; Response: Success output: Horizontal format Output: K
K4SNO
AMFSNO
OPSNO
OPCK4SNO
OPC
Parameter description: K: KI Value K4SNO: K4 Serial Number AMFSNO: AMF Serial Number OPSNO: The Serial Number of OP for MEILEANGE Algorithm OPCK4SNO: OPC K4 Serial Number OPC: OPC value if it is applicable If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
All rights reserved.
Page 477 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.353 Check the Value of a KI Command Name: CHK HKI Function: This command is used to check the KI of the specified IMPI in the HSS service database. If the K4 value is specified, it indicates that the KI is encrypted. If the K4 value is not specified, it indicates that the KI is not encrypted. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
K
Character string
32
KI value
M
K4VALUE
Numeral
16
K4 value
C
Example: CHK HKI: IMPI="impiinfo", K="1234567890abcdef1234567890ABCDEF"; Output: If the operation succeeds, the system displays the following message: SUCCESS0005: Data to be verified is the same as that in the database If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If you enter the command in the command input pane and then specify the related parameters, the KI value is displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the KI value is displayed in plain text.
9.354 Check the Value of an OPC Command Name: CHK HOPC Function: This command is used to check the OPC value of the specified IMPI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
OPC
Character string
32
OPC value
M
OPCK4VALUE
Character string
16
OPC K4 value
C
All rights reserved.
Page 478 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: CHK HOPC: IMPI="impiinfo", OPC="1234567890abcdef1234567890abcdef"; Output: If the operation succeeds, the system displays the following message: SUCCESS0005: Data to be verified is the same as that in the database If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If you enter the command in the command input pane and then specify the related parameters, the OPC K4 value and OPC value are displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the OPC K4 value and OPC value are displayed in plain text.
9.355 Add the HTTP Digest Authentication Information for an IMPI Command Name: ADD HHDAINF Function: This command is used to add an IMPI data record that supports the HTTP digest authentication scheme or add an HTTP digest authentication data record for an existing IMPI to the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
HUSERNAME
Character string
1-127
User name
C
PWD
Character string
1-128
Password
C
HA1
Character string
32
HA1 value
C
Example: 1. ADD HHDAINF: IMPI="impiinfo", HUSERNAME="impiinfo", PWD="pwd"; 2. ADD HHDAINF: IMPI="impiinfo", HA1="11112222333344445555666677778888"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 479 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The number of IMPIs that are authenticated by the HSS using the HTTP Digest authentication scheme is specified by the license control item Number of IMPIs adopting the HDA authentication.
Only one HTTP digest authentication data record is allowed for an IMPI.
Do not specify User name and password together withHA1 value for an IMPI.
If you enter the command in the command input pane and then specify the related parameters, the Password and HA1 value are displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the Password and HA1 value are displayed in plain text.
To improve the system security, you are advised to set the password by following at least three of the rules below: -
The password must contain upper-case letter.
-
The password must contain lower-case letter.
-
The password must contain digits.
-
The password must contain special characters:`-!@#$%^&*()-_=+\|[{}];:'",/? .
And notice three of the rules below: -
Avoid using three or more than three consecutive letters or digits, for example, ABC or 123.
-
Avoid using account or the account in reverse order as the password.
-
Avoid using three or more than three same characters, for example, AAA.
9.356 Remove the HTTP Digest Authentication Information of an IMPI Command Name: RMV HHDAINF Function: This command is used to remove an IMPI that supports the HTTP Digest authentication scheme or remove the HTTP Digest data record for the specified IMPI from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: RMV HHDAINF: IMPI="impiinfo"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 480 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the specified IMPI supports only HTTP Digest authentication and the IMPI is not used, this command removes the IMPI.
If the specified IMPI supports other authentication mechanism in addition to HTTP Digest authentication, this command removes only the HTTP Digest authentication information of the IMPI.
9.357 Modify the HTTP Digest Authentication Information of an IMPI Command Name: MOD HHDAINF Function: This command is used to modify the user name, password, or HA1 value for an IMPI that supports the HTTP Digest authentication scheme in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
HUSERNAME
Character string
1-127
User name
C
PWD
Character string
1-128
Password
C
HA1
Character string
32
HA1 value
C
Example: 1. MOD HHDAINF: IMPI="impiinfo", HUSERNAME="impiinfo", PWD="pwd"; 2. MOD HHDAINF: IMPI="impiinfo", HA1="11112222333344445555666677778888"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Specify either User name and Password or HA1 value.
If you enter the command in the command input pane and then specify the related parameters, the Password and HA1 value are displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the Password and HA1 value are displayed in plain text.
To improve the system security, you are advised to set the password by following at least three of the rules below: -
The password must contain upper-case letter.
-
The password must contain lower-case letter.
-
The password must contain digits.
All rights reserved.
Page 481 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol -
Summary of CommandsSummary of Commands
The password must contain special characters:`-!@#$%^&*()-_=+\|[{}];:'",/? .
And notice three of the rules below: -
Avoid using three or more than three consecutive letters or digits, for example, ABC or 123.
-
Avoid using account or the account in reverse order as the password.
-
Avoid using three or more than three same characters, for example, AAA.
9.358 List the HTTP Digest Authentication Information of an IMPI Command Name: LST HHDAINF Function: This command is used to query the HTTP Digest authentication information about the specified IMPI or user in the HSS service database. The IMPI or User name is the key parameter used to determine the data record to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
C
HUSERNAME
Character string
1-127
User name
C
Example: LST HHDAINF: IMPI="impiinfo"; Response: Success output: Horizontal format Output: IMPI
HUSERNAME
PWD
HA1
Parameter description: IMPI: IMPI Number HUSERNAME: User Name PWD: Password HA1: HA1 Value If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
At least one of IMPI and User name must be specified.
All rights reserved.
Page 482 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.359 Check the HTTP Digest Authentication Information Command Name: CHK HHDAPWD Function: This command is used to check the HTTP Digest authentication information in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
HUSERNAME
Character string
1-127
User name
M
PWD
Character string
1-128
Password
M
Example: CHK HHDAPWD: HUSERNAME="impiinfo", PWD="pwd"; Output: If the operation succeeds, the system displays the following message: SUCCESS0005: Data to be verified is the same as that in the database If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If you enter the command in the command input pane and then specify the related parameters, the Password is displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the Password is displayed in plain text.
To improve the system security, you are advised to set the password by following at least three of the rules below: -
The password must contain upper-case letter.
-
The password must contain lower-case letter.
-
The password must contain digits.
-
The password must contain special characters:`~!@#$%^&*()-_=+\|[{}];:'",/? .
And notice three of the rules below: -
Avoid using three or more than three consecutive letters or digits, for example, ABC or 123.
-
Avoid using account or the account in reverse order as the password.
-
Avoid using three or more than three same characters, for example, AAA.
9.360 Add the SIP Digest Authentication Information for an IMPI Command Name: ADD HSDAINF Function: This command is used to add a Session Initiation Protocol (SIP) Digest authentication data record for a new IP Multimedia Private Identity (IMPI) or an existing IMPI to the Home Subscriber Server (HSS) database.
All rights reserved.
Page 483 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
HUSERNAME
Character string
1-127
User name
C
PWD
Character string
1-128
Password
C
REALM
Character string
1-46
Realm
M
HA1
Character string
32
HA1 value
C
Example: 1. ADD HSDAINF: IMPI="impiinfo", HUSERNAME="impiinfo", PWD="pwd", REALM="huawei.com"; 2. ADD HSDAINF: IMPI="IMPIINFOMATION", REALM="huawei.com", HA1="11112222333344445555666677778888"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
For an IMPI, either only HA1 value or both User name and Password must be specified.
Each IMPI can be configured with only one SIP Digest authentication data record.
The number of IMPIs that are authenticated by the HSS using the SIP Digest authentication scheme is specified by the license control item Number of HDA IMPIs.
If you enter the command in the command input pane and then specify the related parameters, the Password and HA1 value are displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the Password and HA1 value are displayed in plain text.
To improve the system security, you are advised to set the password by following at least three of the rules below: -
The password must contain upper-case letter.
-
The password must contain lower-case letter.
-
The password must contain digits.
-
The password must contain special characters:`-!@#$%^&*()-_=+\|[{}];:'",/? .
And notice three of the rules below: -
Avoid using three or more than three consecutive letters or digits, for example, ABC or 123.
-
Avoid using account or the account in reverse order as the password.
-
Avoid using three or more than three same characters, for example, AAA.
All rights reserved.
Page 484 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
REALM can be set to a string of 32 to 46 characters only when the domain name suffix is . 3gppnetwork.org. If the domain name suffix is in the other format, this parameter can be only set to a string of a maximum of 31 characters. Because the domain name suffix 3gppnetwork.org is case insensitive, it will be displayed in lowercase letters. For example, if you set REALM to SOFT300.IMS.mnc001.mcc001.3gPPNETwork.org, the domain name suffix of the realm is displayed as SOFT300.IMS.mnc001.mcc001.3gppnetwork.org.
9.361 Remove the SIP Digest Authentication Information of an IMPI Command Name: RMV HSDAINF Function: This command is used to remove an IP Multimedia Private Identity (IMPI) data record that supports the Session Initiation Protocol (SIP) Digest authentication scheme or remove the SIP Digest data record for a specified IMPI from the Home Subscriber Server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: RMV HSDAINF: IMPI="impiinfo"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If the IMPI supports only the SIP Digest authentication scheme and the IMPI is not used associated with any subscription data record, RMV HSDAINF is used to remove the IMPI data record.
If the IMPI supports other authentication schemes in addition to the SIP Digest authentication scheme, RMV HSDAINF is used to remove only the SIP Digest authentication data record for the IMPI.
9.362 Modify the SIP Digest Authentication Information of an IMPI Command Name: MOD HSDAINF Function: This command is used to modify the user name, password, HA1 value, or the realm for an IP Multimedia Private Identity (IMPI) that supports SIP Digest authentication in the Home Subscriber Server (HSS) database. The IMPI parameter identifies an SIP Digest authentication data record.
All rights reserved.
Page 485 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
HUSERNAME
Character string
1-127
User name
C
PWD
Character string
1-128
Password
C
REALM
Character string
1-46
Realm
C
HA1
Character string
32
HA1 value
C
Example: MOD HSDAINF: IMPI="impiinfo", HUSERNAME="impiinfo", PWD="pwd", REALM="huawei.com"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
At least one of the parameters User name, Password, HA1 value, and Realm must be specified.
For an IMPI, either only HA1 value or both User name and Password must be specified.
If you enter the command in the command input pane and then specify the related parameters, the Password and HA1 value are displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the Password and HA1 value are displayed in plain text.
To improve the system security, you are advised to set the password by following at least three of the rules below: -
The password must contain upper-case letter.
-
The password must contain lower-case letter.
-
The password must contain digits.
-
The password must contain special characters:`-!@#$%^&*()-_=+\|[{}];:'",/? .
And notice three of the rules below: -
Avoid using three or more than three consecutive letters or digits, for example, ABC or 123.
-
Avoid using account or the account in reverse order as the password.
-
Avoid using three or more than three same characters, for example, AAA.
All rights reserved.
Page 486 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
REALM can be set to a string of 32 to 46 characters only when the domain name suffix is . 3gppnetwork.org. If the domain name suffix is in the other format, this parameter can be only set to a string of a maximum of 31 characters. Because the domain name suffix 3gppnetwork.org is case insensitive, it will be displayed in lowercase letters. For example, if you set REALM to SOFT300.IMS.mnc001.mcc001.3gPPNETwork.org, the domain name suffix of the realm is displayed as SOFT300.IMS.mnc001.mcc001.3gppnetwork.org.
9.363 List the SIP Digest Authentication Information of an IMPI Command Name: LST HSDAINF Function: This command is used to query a Session Initiation Protocol (SIP) Digest authentication data record of a specified IP Multimedia Private Identity (IMPI) or user in the Home Subscriber Server (HSS) database. The IMPI or User name parameter identifies a SIP Digest authentication data record. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
C
HUSERNAME
Character string
1-127
User name
C
Example: 1. LST HSDAINF: IMPI="impiinfo"; 2. LST HSDAINF: HUSERNAME="impiinfo"; Response: Success output: Horizontal format Output: IMPI
HUSERNAME
PWD
REALM
HA1
Parameter description: IMPI: IMPI Number HUSERNAME: User Name PWD: Password REALM: Realm HA1: HA1 Value If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 487 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Either IMPI or User name must be specified. If HA1 value is specified, the HSS displays an error message when User name is used to query a SIP Digest authentication data record.
9.364 Check the SIP Digest Authentication Information of an IMPI Command Name: CHK HSDAPWD Function: This command is used to check whether User name and Password are correct for the Session Initiation Protocol (SIP) Digest authentication data record in the Home Subscriber Server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
HUSERNAME
Character string
1-127
User name
M
PWD
Character string
1-128
Password
M
Example: CHK HSDAPWD: HUSERNAME="impiinfo", PWD="pwd"; Output: If the operation succeeds, the system displays the following message: SUCCESS0005: Data to be verified is the same as that in the database If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If you enter the command in the command input pane and then specify the related parameters, the Password is displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the Password is displayed in plain text.
To improve the system security, you are advised to set the password by following at least three of the rules below: -
The password must contain upper-case letter.
-
The password must contain lower-case letter.
-
The password must contain digits.
-
The password must contain special characters:`-!@#$%^&*()-_=+\|[{}];:'",/? .
And notice three of the rules below: -
Avoid using three or more than three consecutive letters or digits, for example, ABC or 123.
-
Avoid using account or the account in reverse order as the password.
-
Avoid using three or more than three same characters, for example, AAA.
All rights reserved.
Page 488 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.365 Set the Early IMS Authentication Scheme Command Name: SET HEIA Function: This command is used to set or cancel the Early IMS authentication scheme for the specified IMPI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
EIAFLAG
Boolean
TRUE FALSE
Specifies the Early IMS authentication flag of an IMPI.
M
TRUE: supporting the Early IMS authentication
FALSE: not supporting the Early IMS authentication
Example: SET HEIA: IMPI="impiinfo", EIAFLAG=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None..
9.366 List the Early IMS Authentication Scheme Command Name: LST HEIA Function: This command is used to query the authentication information of an IMPI that supports the Early IMS authentication scheme in the HSS service database. The information consists of the IMSI and the IP address associated with the IMPI. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: LST HEIA:IMPI="impiinfo";
All rights reserved.
Page 489 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Response: Success output: Horizontal format Output: IMPI
IMSI
IPV4ADDR
IPV6ADDR
Parameter description: IMPI: IMPI Number IMSI: IMSI Number IPV4ADDR: IPV4 Address IPV6ADDR: IPV6 Address If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.367 Set the Early AKA Authentication Scheme Command Name: SET HEAA Function: This command is used to set or cancel the Early AKA authentication scheme for the specified IMPI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
EAAFLAG
Boolean
TRUE FALSE
Specifies the Early AKA authentication flag of an IMPI.
M
TRUE: supporting the Early AKA authentication
FALSE: not supporting the AKA authentication
Example: SET HEAA: IMPI="impiinfo", EAAFLAG=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful
All rights reserved.
Page 490 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.368 List the Early AKA Authentication Scheme Command Name: LST HEAA Function: This command is used to query the IMSI and the Early AKA authentication information of the specified IMPI in the HSS service database. The IMPI is the key parameter used to determine the data record to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: LST HEAA: IMPI="impiinfo"; Response: Success output: Horizontal format Output: IMPI
IMSI
Parameter description: IMPI: IMPI Number IMSI: IMSI Number If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.369 Add the NASS Bundled Authentication Information for an IMPI Command Name: ADD HNBAINF
All rights reserved.
Page 491 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to add an IMPI that supports the NASS Bundled authentication scheme or add a NASS Bundled authentication data record for an existing IMPI to the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
LINEIDIDX
Numeral
1-5
Line ID index
M
LINEID
Character string
1-127
Line ID
M
Example: ADD HNBAINF: IMPI="impiinfo", LINEIDIDX=1, LINEID="huawei"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.370 Remove the NASS Bundled Authentication Information of an IMPI Command Name: RMV HNBAINF Function: This command is used to remove an IMPI that supports the NASS Bundled authentication scheme or remove the NASS Bundled authentication data record for an existing IMPI from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
LINEIDIDX
Numeral
1-5
Line ID index
C
Example: RMV HNBAINF: IMPI="impiinfo"; Output: If the operation succeeds, the system displays the following message:
All rights reserved.
Page 492 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If the specified IMPI supports only NASS Bundled authentication and the IMPI is not used, this command removes the IMPI.
If the specified IMPI supports other authentication mechanism in addition to NASS Bundled authentication, this command removes only the NASS Bundled authentication information of the IMPI.
9.371 List the NASS Bundled Authentication Information of an IMPI Command Name: LST HNBAINF Function: This command is used to query the NASS Bundled authentication information of the specified IMPI in the HSS service database. The IMPI is the key parameter used to determine the data record to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: LST HNBAINF: IMPI="impiinfo"; Response: Success output: Horizontal format Output: LINEIDIDX
LINEID
Parameter description: LINEIDIDX: Line ID Index LINEID: Line ID If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
All rights reserved.
Page 493 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.372 Set the TAA Authentication Scheme for an IMPI Command Name: SET HTAA Function: This command is used to set or cancel the TAA authentication scheme of a specified IMPI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
TAAFLAG
Boolean
TRUE FALSE
Specifies the TAA authentication flag of an IMPI.
M
TRUE: supporting the TAA authentication
FALSE: not supporting the TAA authentication
Example: SET HTAA: IMPI="impiinfo", TAAFLAG=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If an IMPI is defined and supports only the TAA authentication scheme, you cannot cancel the TAA authentication scheme of the IMPI. Otherwise, the HSS displays that the operation has failed.
9.373 List the TAA Authentication Scheme Supported by an IMPI Command Name: LST HTAA Function: This command is used to query TAA authentication scheme supported by a specified IMPI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example:
All rights reserved.
Page 494 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
LST HTAA: IMPI="impiinfo"; Response: Success output: Horizontal format Output: TAAFLAG
Parameter description: TAAFLAG: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.374 Set the CAVEAKA Authentication Capability Command Name: SET HCAA Function: This command is used to add, modify or remove the CAVE AKA authentication capability for the specified IMPI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
CAVEAKAFLG
Boolean
TRUE
M
FALSE
Specifies the CAVE AKA authentication flag of an IMPI.
UIMID
Character string
8
TRUE: supporting the CAVE AKA authentication
FALSE: not supporting the CAVE AKA authentication
UIMID
C
Example: SET HCAA: IMPI="[email protected]", CAVEAKAFLG=TRUE, UIMID="12345678"; Output: If the operation succeeds, the system displays the following message:
All rights reserved.
Page 495 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If CAVEAKAFLG is set to TRUE, UIMID must be specified.
If CAVEAKAFLG is set to FALSE, you do not need to specify UIMID. If UIMID is specified, the system still ignores the setting of UIMID.
If a subscriber does not support CAVE AKA authentication, run SET HCAA with CAVEAKAFLG set to TRUE and UIMID specified to add CAVE AKA authentication information.
If a subscriber supports the CAVE AKA authentication, run SET HCAA with CAVEAKAFLG set to TRUE and UIMID specified to modify CAVE AKA authentication information.
If you run SET HCAA to disable the CAVE AKA authentication for a subscriber, the CAVE AKA authentication information of the subscriber is removed.
9.375 List the CAVEAKA Authentication Capability Command Name: LST HCAA Function: This command is used to query whether a specific IMPI supports the Cave AKA authentication and the UIM ID of the IMPI in the HSS service database. The IMPI is the key parameter used to identify the data record that is to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: LST HCAA: IMPI="[email protected]"; Response: Success output: Horizontal format Output: IMPI
CAVEAKAFLG
UIMID
Parameter description: IMPI: IMPI Number CAVEAKAFLG: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE UIMID: UIMID
All rights reserved.
Page 496 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.376 List the Authentication Schemes Supported by an IMPI Command Name: LST HAUTHINF Function: This command is used to query the authentication schemes supported by the specified user in the HSS service database. The IMPI is the key parameter used to determine the data record that is to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: LST HAUTHINF: IMPI="impiinfo"; Response: Success output: Horizontal format Output: AKAFL AG
EAAFL AG
SDAFL AG
TAAFL AG
EIAFLA G
HDAFL AG
NBAF LAG
CAVEAK AFLAG
Parameter description: AKAFLAG: 1 | 0 EAAFLAG: 1 | 0 SDAFLAG: 1 | 0 TAAFLAG: 1 | 0 EIAFLAG: 1 | 0 HDAFLAG: 1 | 0 NBAFLAG: 1 | 0 CAVEAKAFLAG: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE
All rights reserved.
Page 497 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.377 Check the HA1 Value for an IMPI Command Name: CHK HHA1 Function: This command is used to check whether HA1 value matches IMPI in a HTTP Digest authentication or SIP Digest authentication data record. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
HA1
Character string
32
HA1 value
M
Example: CHK HHA1: IMPI="impiinfo", HA1="11112222333344445555666677778888"; Output: If the operation succeeds, the system displays the following message: SUCCESS0005: Data to be verified is the same as that in the database If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If you enter the command in the command input pane and then specify the related parameters, the HA1 value is displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the HA1 value is displayed in plain text.
9.378 Add an IMS Subscription Command Name: ADD HSUB Function: This command is used to add an IP Multimedia Subsystem (IMS) subscription data record to the Home Subscriber Server (HSS) database. Subscription ID is used to identify an IMS subscription data record.You can run the ADD HSUB command to add an IP Multimedia Private Identity (IMPI) and IP Multimedia Public Identity (IMPU) for the IMS subscription data record. You can also run this command to only define a subscription data record and then add an IMPI and IMPU by running the ADD HIMPI and ADD HIMPU commands. Parameter Description:
All rights reserved.
Page 498 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
IMPI
Character string
1-127
IMPI number
C
IMPU
Character string
1-127
IMPU number
C
IMPUTYPE
Enumerated
DIMPU
Specifies the type of the IMPU.
C
WIMPU
DIMPU: The IMPU is a distinct IMPU.
WIMPU: The IMPU is a wildcarded IMPU.
PBXUSERFLAG
SYSNO
Boolean
Numeral
TRUE
FALSE
0-255
Specifies whether the IMS subscriber is a private branch exchange (PBX) subscriber.
O
TRUE: The IMS subscriber is a PBX subscriber.
FALSE: The IMS subscriber is not a PBX subscriber.
System serial number
O
Example: 1. ADD HSUB: SUBID="subinfo", IMPI="impiinfo", IMPU="sip:[email protected]", PBXUSERFLAG=FALSE; 2. ADD HSUB: SUBID="subinfo", IMPI="impiinfo", IMPU="tel:+33145297![247].*!", IMPUTYPE=WIMPU, PBXUSERFLAG=FALSE, SYSNO=10; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
IMPI is mandatory if the ADD HSUB command is used to define an IMS subscription data record and add an IMPU for the record.
9.379 Add an IMS Subscription Using One Command Command Name: ADD HHSSSUB Function: This command is used to add an IP multimedia subsystem (IMS) subscription data record to the HSS service database. You can use the command to perform the following operations:
All rights reserved.
Page 499 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Set a subscription ID that uniquely identifies an IMS subscriber, provide the capacity set for the subscriber by using a capacity set template, or configure the CS and IMS service data consistency flag for the subscriber.
Add one or two IMPIs that support the HTTP Digest, SIP Digest, Early AKA, or Trusted Access authentication scheme and provide the charging address for the IMPIs by using a charging address template.
Associate 1 to 10 IMPUs with the IMPIs, provide services for the IMPUs by using an IMPU template and a service profile template, and configure the IMPUs in an implicitly registered set (IRS) and an alias group.
The command improves the efficiency in adding an IMS subscription if the subscriber model of the subscriber to be added is consistent with the function description. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
IMPI
Character string
1-127
IMPI number
M
IMPIAUTHTYPE
Enumerated
HDA
O
EAA
Specifies the scheme used for authenticating the IMPI.
TAA
HDA(HTTP Digest)
SDA
EAA(Early AKA)
AKA
TAA(Trusted Access)
SDA(SIP Digest)
HUSERNAME
Character string
1-127
User name
C
PWD
Character string
1-128
Password
C
REALM
Character string
1-46
Realm
C
HA1
Character string
32
HA1 value
C
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
IMPI2
Character string
1-127
IMPI2 number
O
IMPI2AUTHTYPE
Enumerated
HDA
C
EAA
Specifies the scheme used for authenticating IMPI 2.
TAA
HDA(HTTP Digest)
SDA
EAA(Early AKA)
AKA
TAA(Trusted Access)
SDA(SIP Digest)
HUSERNAME2
Character string
1-127
User name2
C
PWD2
Character string
1-128
Password2
C
REALM2
Character string
1-46
Realm2
C
HA12
Character string
32
HA1 value2
C
All rights reserved.
Page 500 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMSI2
Character string
6-15
IMSI2 number
C
ISDN2
Character string
1-15
MSISDN2 number
C
IMPULIST
Character string
1-1300
IMPU list
M
BARIMPULIST
Character string
1-1300
Barring IMPU list
O
CHARGTPLID
Numeral
0-254
Charging address template ID
O
IMPUTPLID
Numeral
0-254
IMPU template ID
O
SPTPLID
Numeral
0-254
Service profile template ID
O
IRSID
Numeral
0-255
IRS ID
C
ALIASID
Numeral
0-255
Alias group ID
C
CAPTPLID
Numeral
0-254
Capability set template ID
O
SYSNO
Numeral
0-255
System serial number
O
CONSFLG
Boolean
TRUE
O
FALSE
Specifies whether to keep service data consistency between the circuit switched (CS) and IMS networks.
TRUE: Keep service data consistency between the CS and IMS networks.
FALSE: Not keep service data consistency between the CS and IMS networks.
Example: 1. ADD HHSSSUB: SUBID="subinfo", IMPI="impiinfo", IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\"", HUSERNAME="hss_user", PWD="pwd", IRSID=1, ALIASID=1; 2. ADD HHSSSUB: SUBID="subinfo", IMPI="impiinfo", IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\"", HUSERNAME="hss_user", PWD="pwd", REALM="huawei.com", CHARGTPLID=10, IMPUTPLID=11, IRSID=1, ALIASID=1, SYSNO=10; 3. ADD HHSSSUB: SUBID="subinfo", IMPI="impiinfo", IMPIAUTHTYPE=EAA, IMSI="460001234567890", ISDN="8613988888888", IMPI2="impiinfo2", IMPI2AUTHTYPE=TAA, IMPULIST="\"sip:[email protected]\"&\"tel: +8613988888888\"&\"sip:[email protected]\"&\"sip:[email protected]\"", BARIMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\"", CHARGTPLID=0, SPTPLID=1, IMPUTPLID=1, IRSID=1, ALIASID=1, CONSFLG=TRUE; Output: If the operation succeeds, the system displays the following message:
All rights reserved.
Page 501 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
To improve the system security, you are advised to set the password by following at least three of the rules below: -
The password must contain upper-case letter.
-
The password must contain lower-case letter.
-
The password must contain digits.
-
The password must contain special characters:`-!@#$%^&*()-_=+\|[{}];:'",/? .
And notice three of the rules below: -
Avoid using three or more than three consecutive letters or digits, for example, ABC or 123.
-
Avoid using account or the account in reverse order as the password.
-
Avoid using three or more than three same characters, for example, AAA.
The IMPI or IMPI2 specified in ADD HHSSSUB cannot be associated with an IMSI by running ADD HIMSI.
The first IMSI specified in ADD HHSSSUB is set as the main IMSI when both of the following conditions are met: -
Set the specified IMSI as the main IMSI is set to TRUE by running SET HSYSTEMPARA.
-
Authentication type of IMPI or Authentication type of IMPI2 is set to AKA(IMS AKA) by running ADD HHSSSUB.
You can also run MOD HMSIM to set the main IMSI of a subscriber.
When Authentication type of IMPI or Authentication type of IMPI2 is set to AKA(IMS AKA), the IMSI or IMSI2 specified cannot be loaded with a KI by ADD KI in advance.
IMPI:
-
The IMPI must be in the NAI format and case-sensitive.
-
The IMPI does not have any authentication data.
IMPIAUTHTYPE: -
The KI must be added to the IMPI by running ADD HKI before you run ADD HHSSSUB with this parameter set to AKA(IMS AKA).
HUSERNAME: -
This parameter is optional when Authentication type of IMPI is HDA or SDA.
-
This parameter is mandatory when Authentication type of IMPI is not specified. It must be specified in the MML command line input pane.
PWD: -
This parameter is optional when Authentication type of IMPI is HDA or SDA.
-
This parameter is mandatory when Authentication type of IMPI is not specified. It must be specified in the MML command line input pane.
-
To improve the system security, you are advised to set the password according to the rules described in the Note.
REALM: -
This parameter is mandatory when Authentication type of IMPI is SDA.
-
This parameter is optional when Authentication type of IMPI is not specified. To configure the HTTP Digest authentication scheme for the IMPI, do not specify Realm. To configure the SIP Digest authentication scheme for the IMPI, specify Realm in the MML command line input pane.
All rights reserved.
Page 502 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol -
Summary of CommandsSummary of Commands
This parameter can be set to a string of 32 to 46 characters only when the domain name suffix is .3gppnetwork.org. If the domain name suffix is in the other format, this parameter can be only set to a string of a maximum of 31 characters. Because the domain name suffix 3gppnetwork.org is case insensitive, it will be displayed in lowercase letters. For example, if you set REALM to SOFT300.IMS.mnc001.mcc001.3gPPNETwork.org, the domain name suffix of the realm is displayed as SOFT300.IMS.mnc001.mcc001.3gppnetwork.org.
HA1 is optional when Authentication type of IMPI is HDA or SDA.
IMSI: -
This parameter is mandatory when Authentication type of IMPI is set to EAA(Early AKA).
-
This parameter is mandatory when Authentication type of IMPI is set to AKA(IMS AKA) and MSISDN is specified.
ISDN is optional when Authentication type of IMPI is set to EAA(Early AKA) or AKA(IMS AKA).
IMPI2:
-
The IMPI must be in the NAI format and case-sensitive.
-
The IMPI does not have any authentication data.
IMPI2AUTHTYPE: -
The KI must be added to the IMPI by running ADD HKI before you run ADD HHSSSUB with this parameter set to AKA(IMS AKA).
HUSERNAME2 is optional when Authentication type of IMPI2 is HDA or SDA.
PWD2 is optional when Authentication type of IMPI2 is HDA or SDA.
REALM2: -
This parameter is mandatory when Authentication type of IMPI2 is SDA.
-
This parameter can be set to a string of 32 to 46 characters only when the domain name suffix is .3gppnetwork.org. If the domain name suffix is in the other format, this parameter can be only set to a string of a maximum of 31 characters. Because the domain name suffix 3gppnetwork.org is case insensitive, it will be displayed in lowercase letters. For example, if you set REALM to SOFT300.IMS.mnc001.mcc001.3gPPNETwork.org, the domain name suffix of the realm is displayed as SOFT300.IMS.mnc001.mcc001.3gppnetwork.org.
HA12 is optional when Authentication type of IMPI2 is HDA or SDA.
IMSI2: -
This parameter is mandatory when Authentication type of IMPI2 is set to EAA(Early AKA).
-
This parameter is mandatory when Authentication type of IMPI2 is set to AKA(IMS AKA) and MSISDN2 is specified.
ISDN2 is optional when Authentication type of IMPI2 is set to EAA(Early AKA) or AKA(IMS AKA).
IMPULIST specifies the IMPUs to be associated with the IMS subscription. When setting this parameter, note the following:
-
The list allows 1 to 10 IMPUs separated by an ampersand (&), for example: "sip:[email protected]"&"sip:[email protected]". An escape character (\) must be added before each quotation mark (").
-
The IMPUs must be in the SIP URI or TEL URI format and case-sensitive.
-
The IMPUs must be distinct IMPUs.
-
If IMPI2 is specified, the IMPUs will be associated with both IMPI and IMPI 2.
BARIMPULIST specifies the IMPUs to be restricted from using services. When setting this parameter, note the following: -
The list allows 1 to 10 IMPUs separated by an ampersand (&), for example: "sip:[email protected]"&"sip:[email protected]". An escape character (\) must be added before each quotation mark (").
-
The IMPUs must be in the SIP URI or TEL URI format and case-sensitive.
IRSID: -
Value 0 indicates that the IMPUs will not be configured in the same IRS.
All rights reserved.
Page 503 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If this parameter is set to a non-zero value, the IMPU list must contain at least two IMPUs and the first IMPU will be set as the default IMPU.
ALIASID: -
Value 0 indicates that the IMPUs will not be configured in the same alias group.
-
If this parameter is set to a non-zero value, IRS ID must be set to a non-zero value.
CONSFLG specifies whether to keep service data consistency between the circuit switched (CS) and IMS networks.
9.380 Remove an IMS Subscription Using One Command Command Name: RMV HHSSSUB Function: This command is used to delete all information associated with the SUBID or IMSI of a subscriber, including the authentication data and IMSIs associated with the subscriber's IMPIs. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
C
IMSI
Character string
6-15
IMSI number
C
SUPCAN
Enumerated
SUPPRESSION
Restrict the delivery of messages after deleting subscribers
O
UNSUPPRESSION
Example: 1. RMV HHSSSUB: SUBID="subinfo"; 2. RMV HHSSSUB: IMSI="460001234567890"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Specify either SUBID or IMSI.
After this command is executed, the subscriber whose information is deleted cannot use any network services.
9.381 Remove an IMS Subscription Command Name: RMV HSUB
All rights reserved.
Page 504 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to remove an IP Multimedia Subsystem (IMS) subscription data record and the IP Multimedia Private Identities (IMPIs) and IP Multimedia Public Identities (IMPUs) associated with the IMS subscription data records from the Home Subscriber Server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
SUPCAN
Enumerated
SUPPRESSION
Restrict the delivery of messages after deleting subscribers
O
UNSUPPRESSION
Example: RMV HSUB: SUBID="subinfo"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Removing an IMS subscription data record may affect the services provided for the subscriber specified by the subscription data record. Therefore, make sure this operation serves the intended purpose before removing an IMS subscription data record.
9.382 Modify an IMS Subscription ID Command Name: MOD HSUBID Function: This command is used to modify the subscription ID of an IP Multimedia Subsystem (IMS) subscription data record in the Home Subscriber Server (HSS) database. The Subscription ID parameter identifies an IMS subscription data record. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
NEWSUBID
Character string
1-127
New subscription ID
M
Example: MOD HSUBID: SUBID="subinfo", NEWSUBID="new_subinfo"; Output:
All rights reserved.
Page 505 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.383 List IMS Subscription Information Command Name: LST HSUB Function: This command is used to query an IP Multimedia Subsystem (IMS) subscription data record in the Home Subscriber Server (HSS) database. The data records associated with only one IMS subscription data record can be queried at a time. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
C
IMPI
Character string
1-127
IMPI number
C
IMPU
Character string
1-127
IMPU number
C
Example: LST HSUB: SUBID="subinfo"; Response: Success output: Horizontal format Output: SUBI D
IMP I
IMP U
SHARE D
IRSI D
ALIASI D
DEFIMP U
IMPUTYP E
SYSN O
Parameter description: SUBID: Subscription ID IMPI: IMPI Number IMPU: IMPU Number SHARED: 1 | 0
Remark: 1 represents TRUE, 0 represents FALSE
IRSID: IRS ID ALIASID: Alias Group ID
All rights reserved.
Page 506 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
DEFIMPU: 1 | 0
Summary of CommandsSummary of Commands
Remark: 1 represents TRUE, 0 represents FALSE
IMPUTYPE: 1 | 2 Remark: 1 represents DISTINCT, 2 represents WILDCARDED SYSNO: System Serial Number If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
Either Subscription ID, IMPI, or IMPU must be specified.
The HSS queries the IMS subscription data record according to the Subscription ID, IMPI, or IMPU setting.
9.384 List an IMS Subscription Using One Command Command Name: LST HSUBDATA Function: This command is used to query an IP multimedia subsystem (IMS) subscription data record in the home subscriber server (HSS) database based on the setting of the Subscription ID, IMPI, or IMPU. The data record associated with only one subscription ID can be queried at a time. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
C
IMPI
Character string
1-127
IMPI number
C
IMPU
Character string
1-127
IMPU number
C
Example: LST HSUBDATA: SUBID="subinfo"; Response: Success output: Horizontal format Output: SUBDATA
Parameter description: SUBDATA: Subscription Data If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 507 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The Subscription ID, IMPI, and IMPU are optional. Specify only one of them.
The HSS queries the subscription data based on the setting of the Subscription ID, IMPI, or IMPU.
9.385 Set IMS PBX Flag Command Name: SET HPBXU Function: This command is used to set the private branch exchange (PBX) user flag for a subscription data record in the Home Subscriber Server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
PBXUSERFLAG
Boolean
TRUE FALSE
Specifies whether an IMS subscriber is a PBX subscriber.
M
TRUE: The IMS subscriber is a PBX subscriber.
FALSE: The IMS subscriber is not a PBX subscriber.
Example: SET HPBXU: SUBID="subinfo", PBXUSERFLAG=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.386 List IMS PBX Flag Command Name: LST HPBXU Function: This command is used to query the PBX user flag setting for a specified subscription data record in the Home Subscriber Server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
All rights reserved.
Page 508 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
Example: LST HPBXU: SUBID="subinfo"; Response: Success output: Horizontal format Output: SUBID
PBXUSERFLAG
Parameter description: SUBID: Subscription ID PBXUSERFLAG: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.387 Set IMS Subscriber Description Command Name: SET HSUBINFO Function: This command is used to add description about an IP multimedia subsystem (IMS) subscriber to the home subscriber server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
SUBINFO
Character string
1-127
Subscriber description
O
Example: SET HSUBINFO: SUBID="6290000001", SUBINFO="subinformation"; Output: If the operation succeeds, the system displays the following message:
All rights reserved.
Page 509 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
If Subscriber Description is not specified, the HSS deletes the description about the subscriber.
9.388 List IMS Subscriber Description Command Name: LST HSUBINFO Function: This command is used to query the description about an IP multimedia subsystem (IMS) subscriber in the home subscriber server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
Example: LST HSUBINFO: SUBID="6290000001"; Response: Success output: Horizontal format Output: SUBID
SUBINFO
Parameter description: SUBID: Subscription ID SUBINFO: Subscriber Description If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.389 Set Service Data Consistency Flag Command Name: SET HCONSFLG Function: This command is used to set the Consistency flag in a specified subscription data record in the home subscriber server (HSS) database.
All rights reserved.
Page 510 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
CONSFLG
Boolean
TRUE
M
FALSE
Specifies whether to keep service data consistency between the circuit switched (CS) network and the IMS network.
TRUE: To keep service data consistency between the CS network and the IMS network.
FALSE: Not to keep service data consistency between the CS network and the IMS network.
Example: SET HCONSFLG: SUBID="subinfo", CONSFLG=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For explanations of error codes, see 11"Summary of Error Codes."
None.
9.390 List Service Data Consistency Flag Command Name: LST HCONSFLG Function: This command is used to query the Consistency flag setting in a specified subscription data record in the home subscriber server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
Example: LST HCONSFLG: SUBID="subinfo"; Output: Success output: Horizontal format
All rights reserved.
Page 511 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: SUBID
CONSFLG
Parameter description: SUBID:: Subscription ID CONSFLG:: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.391 Add an IMS Subscriber Command Name: ADD IMSSUB Function: This command is is used to provide IMS services for GSM/UMTS subscribers, EPS subscribers, or GSM/UMTS/EPS subscribers. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
0-255
HLR serial number
C
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
IMPI
Character string
1-127
IMPI number
M
IMPULIST
Character string
1-1300
IMPU list
M
BARIMPULIST
Character string
1-1300
Barring IMPU list
C
VOLTETAG
Boolean
TRUE
C
FALSE
Specifies whether the subscriber to be provided with IMS services is a VoLTE subscriber. Value:
TRUE(TRUE): The subscriber is a VoLTE subscriber.
FALSE(FALSE): The subscriber is not a VoLTE subscriber.
CHARGTPLID
Numeral
0-254
Charging address template ID
C
MCAP
Character string
1-352
Mandatory capability set
C
OCAP
Character string
1-352
Optional capability set
C
All rights reserved.
Page 512 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
SCSCFLIST
Character string
1-649
S-CSCF list
C
MEDIAID
Numeral
0429496729 5
Subscribed media profile ID
C
VNTPLID
Numeral
0-254
Visited network template ID
C
SIFCLIST
Character string
1-40
Shared iFC template ID list
C
STNSR
Character string
3-15
Session transfer number for SRVCC
C
Example: ADD IMSSUB: HLRSN=1, IMSI="123456789", IMPI="impiinfo_1", IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\""; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either IMSI or MSISDN.
When setting parameter IMPI, note the following:
-
The IMPI is case-sensitive and must be in NAI format. NAI format: user name + @ + domain name. For example, user [email protected].
-
The IMPI does not have any authentication data configured. Whether the IMPI has authentication data configured can be checked by LST HAUTHINF.
When setting parameter IMPULIST, note the following: -
An IMPU list contains 1 to 10 IMPUs, each of which is enclosed in quotation marks (") and is separated by an ampersand (&). In addition, an escape character (\) is added before each quotation mark ("). For example, \"sip:[email protected]\"&\"sip:[email protected]"\.
-
The IMPUs are case-sensitive and must be in SIP URI or TEL URI format.
-
The IMPUs must be distinct IMPUs. For details about wildcarded IMPU and distinct IMPU, see Feature Guide > Features (IMS Networks) > IMS-HSS Services > Wildcarded IMPU.
-
The subscriber's IMPUs are configured to belong to the same implicitly registered set (IRS) and the same alias group, both of which has the default ID 1.
-
The first IMPU in an IMPU list is the default IMPU of an IRS.
When setting parameter BARIMPULIST, note the following: -
An IMPU list contains 1 to 10 IMPUs, each of which is enclosed in quotation marks (") and is separated by an ampersand (&). In addition, an escape character (\) is added before each quotation mark ("). For example, \"sip:[email protected]\"&\"sip:[email protected]"\.
-
The IMPUs are case-sensitive and must be in SIP URI or TEL URI format.
-
The IMPUs must be distinct IMPUs and must be included in the IMPU list.
All rights reserved.
Page 513 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
MCAP specifies the mandatory capabilities required to satisfy the subscriber's service requirements.A mandatory capability set contains a maximum of 32 unique integers, each of which is a value ranging from 1 to 4294967295 and is separated by an ampersand (&). For example, 1&2. Meanings of the integers are planned by carriers.
OCAP specifies the optional capabilities required to satisfy the subscriber's service requirements.An optional capability set contains a maximum of 32 unique integers, each of which is a value ranging from 1 to 4294967295 and is separated by an ampersand (&). For example, 3&4. Meanings of the integers are planned by carriers.
SCSCFLIST specifies the S-CSCFs to be associated with the capability set.An S-CSCF list contains 1 to 5 S-CSCFs, each of which is a string of 1 to 127 characters, enclosed in quotation marks ("), and is separated by an ampersand (&). In addition, an escape character (\) is added before each quotation mark ("). For example, \"sip:scscf1.huawei.com\"&\"sip:scscf2.huawei.com\".
MEDIAID: Value 4294967295 indicates that the HSS does not provide a media profile for the subscriber.
SIFCLIST specifies the IDs of the shared iFC templates to be associated with the subscriber. The list contains 1 to 8 unique shared iFC template IDs, each of which is separated by an ampersand (&). Shared iFC templates can be added by ADD HSIFCTPL.
9.392 List IMS Subscriber Data Command Name: LST IMSSUB Function: This command is used to query the IMS subscription data of a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
IMPI
Character string
1-127
IMPI number
C
IMPU
Character string
1-127
IMPU number
C
Example: LST IMSSUB: IMSI="123456789"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI}= {ISDN}= {IMPI}= {IMPU}= {IRSID}= {ALIASID}= {DEFIMPU}=
All rights reserved.
Page 514 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Remark: 1 represents TRUE, 0 represents FALSE If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify one of the following parameters: IMSI, MSISDN, IMPI, or IMPU.
9.393 Add an IMPI Command Name: ADD HIMPI Function: This command is used when you need to:
Add an IP Multimedia Private Identity (IMPI) for an existing IP Multimedia Subsystem (IMS) subscription to the Home Subscriber Server (HSS) database. You can then run ADD HIMPU to add the IMPUs associated with the IMPI.
Add an IMPI and the IMPUs associated with the IMPI for an existing IMS subscription. The system automatically sets the default service profile for the IMPU, where the subscribed media profile ID and the iFC are null.
Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
IMPI
Character string
1-127
IMPI number
M
IMPU
Character string
1-127
IMPU number
C
IMPUTYPE
Enumerated
DIMPU
IMPU type
C
WIMPU
Example: 1. ADD HIMPI: SUBID="subinfo", IMPI="impiinfo", IMPU="sip:[email protected]"; 2. ADD HIMPI: SUBID="subinfo", IMPI="impiinfo", IMPU="tel:+33145297![247].*!", IMPUTYPE=WIMPU; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
All rights reserved.
Page 515 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.394 Remove an IMPI Command Name: RMV HIMPI Function: This command is used to remove an IMPI from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: RMV HIMPI: IMPI="impiinfo"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.395 Modify an IMPI Command Name: MOD HIMPI Function: This command is used to modify an IMPI in the HSS service database. The IMPI is the key parameter used to determine the IMPI record to be modified. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
NEWIMPI
Character string
1-127
New IMPI number
M
Example: MOD HIMPI: IMPI="impiinfo", NEWIMPI="new_impiinfo"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 516 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
None.
9.396 Modify an IMPI by One Command Command Name: MOD HHSSIMPI Function: This command is used to modify an IMPI data record and configure authentication data for the new IMPI in the HSS service database. IMPI uniquely identifies an IMPI data record. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
NEWIMPI
Character string
1-127
New IMPI number
M
NEWIMPIAU THTYPE
Enumerated
AKA
M
HDA
Specifies the authentication scheme the HSS uses to authenticate the new IMPI.
EIA
Value:
NBA
EAA
TAA
SDA
CAA
AKA(IMS AKA): IMS AKA authentication scheme
HDA(HTTP Digest): HTTP Digest authentication scheme
EIA(Early IMS): Early IMS authentication scheme
NBA(NASS Bundled): NASS Bundled authentication scheme
EAA(Early AKA): Early AKA authentication scheme
TAA(Trusted Access): Trusted Access authentication scheme
SDA(SIP Digest): SIP Digest authentication scheme
CAA(CAVE AKA): CAVE AKA authentication scheme
K
Character string
32
KI value
C
K4SNO
Numeral
0-128
K4 serial number
C
OPSNO
Numeral
0-128
OP serial number
C
AMFSNO
Numeral
1-128
AMF serial number
C
OPC
Character string
32
OPC value
C
OPC K4SNO
Numeral
0-128
OPC K4 serial number
C
HUSERNAME
Character string
1-127
User name
C
All rights reserved.
Page 517 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
PWD
Character string
1-128
Password
C
REALM
Character string
1-46
Realm
C
HA1
Character string
32
HA1 value
C
LINEIDIDX
Numeral
1-5
Line ID index
C
LINEID
Character string
1-127
Line ID
C
UIMID
Character string
8
UIMID
C
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: 1. MOD HHSSIMPI: IMPI="impiinfo", NEWIMPI="new_impiinfo", NEWIMPIAUTHTYPE=SDA, HUSERNAME="hss_user", PWD="pwd", REALM="huawei.com"; 2. MOD HHSSIMPI: IMPI="impiinfo", NEWIMPI="new_impiinfo", NEWIMPIAUTHTYPE=TAA; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
If you enter the command in the command input pane and then specify the related parameters, the KI value, OPC value, password, and HA1 value are displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the KI value, OPC value, password, and HA1 value are displayed in plain text.
To improve the system security, you are advised to set the password by following at least three of the rules below: -
The password must contain upper-case letter.
-
The password must contain lower-case letter.
-
The password must contain digits.
-
The password must contain special characters:`-!@#$%^&*()-_=+\|[{}];:'",/? .
And notice three of the rules below: -
Avoid using three or more than three consecutive letters or digits, for example, ABC or 123.
-
Avoid using account or the account in reverse order as the password.
-
Avoid using three or more than three same characters, for example, AAA.
All rights reserved.
Page 518 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
REALM can be set to a string of 32 to 46 characters only when the domain name suffix is . 3gppnetwork.org. If the domain name suffix is in the other format, this parameter can be only set to a string of a maximum of 31 characters. Because the domain name suffix 3gppnetwork.org is case insensitive, it will be displayed in lowercase letters. For example, if you set REALM to SOFT300.IMS.mnc001.mcc001.3gPPNETwork.org, the domain name suffix of the realm is displayed as SOFT300.IMS.mnc001.mcc001.3gppnetwork.org.
9.397 Add an IMPU Command Name: ADD HIMPU Function: This command is used to add an IP Multimedia Public Identity (IMPU) data record for an existing IP Multimedia Private Identity (IMPI) to the Home Subscriber Server (HSS) database. After an IMPU data record is added for the IMPI, the subscriber identified by the IMPI can use the IMPU to connect to the IP Multimedia Subsystem (IMS) network. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
IMPU
Character string
1-127
IMPU number
M
IMPUTYPE
Enumerated
DIMPU
Specifies the type of the IMPU.
C
WIMPU
Value:
DIMPU(DIMPU): The IMPU is a distinct IMPU.
WIMPU(WIMPU): The IMPU is a wildcarded IMPU.
Example: 1. ADD HIMPU: IMPI="impiinfo", IMPU="sip:[email protected]"; 2. ADD HIMPU: IMPI="impiinfo", IMPU="tel:+33145297![247].*!", IMPUTYPE=WIMPU; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
All rights reserved.
Page 519 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.398 Remove an IMPU Command Name: RMV HIMPU Function: This command is used to remove an IP Multimedia Public Identity (IMPU) data record from the Home Subscriber Server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example: RMV HIMPU: IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Removing an IMPU data record will deregister the subscriber identified by the IMPU. In this case, the subscriber will experience service failure. Therefore, make sure this operation serves the intended purpose before removing an IMPU data record.
9.399 Modify an IMPU Command Name: MOD HIMPU Function: This command is used to modify an IP Multimedia Public Identity (IMPU) data record in the Home Subscriber Server (HSS) database. The IMPU parameter uniquely identifies an IMPU data record. This command is executed when the subscriber identified by the IMPU changes the IMPU while retaining the IMPI and the services defined in the IMPI. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
NEWIMPU
Character string
1-127
New IMPU number
M
IMPUTYPE
Enumerated
DIMPU
C
WIMPU
Specifies the type of the new IMPU. Value:
All rights reserved.
DIMPU(DIMPU): The new
Page 520 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
IMPU is a distinct IMPU.
WIMPU(WIMPU): The new IMPU is a wildcarded IMPU.
Example: 1. MOD HIMPU:IMPU="sip:[email protected]", NEWIMPU="sip:[email protected]"; 2. MOD HIMPU:IMPU="sip:[email protected]", NEWIMPU="tel:+33145297! [247].*!", NEWIMPUTYPE=WIMPU; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Modifying an IMPU data record will deregister the subscriber identified by the IMPU. In this case, the subscriber will experience service failure. Therefore, make sure this operation serves the intended purpose before modifying an IMPU data record.
9.400 Check an IMPU Command Name: CHK HIMPU Function: This command is used check whether an IMPU and an IMPI associate with the same subscription ID. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
IMPU
Character string
1-127
IMPU number
M
Example: CHK HIMPU: IMPI="impiinfo", IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0005: Data to be verified is the same as that in the database
All rights reserved.
Page 521 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.401 Set the Sharing Attribute of an IMPU Command Name: SET HIMPUSHARE Function: This command is used to set the share attribute of the specified IMPU in the HSS service database. You can share or unshare the IMPU. If the IMPU is set to be shared, the IMPU is associated with all IMPIs in the IMS subscription to which the IMPU belongs. If the IMPU is set to be unshared, the IMPU is only associated with the IMPI to which the IMPU belongs. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
SHARED
Boolean
TRUE
Specifies the sharing attribute of an IMPU.
M
FALSE
Value:
TRUE(True): The attribute of the IMPU is set to share.
FALSE(False): The attribute of the IMPU is set to non-share.
Example: SET HIMPUSHARE: IMPU="sip:[email protected]", SHARED=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 522 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The IMPU cannot be shared when only one IMPI exists in the IMS subscription to which the IMPU belongs.
The sharing attribute of the default IMPU of an IRS cannot be set.
If an IMPU belongs to an IRS but it is not the default IMPU, the IMPU automatically disengages from the IRS after the sharing attribute of the IMPU is changed. At the same time, if only one IMPU exists in the IRS, the IRS is deleted consequently.
9.402 Add a PSI User Command Name: ADD HPSI Function: This command is used to add a PSI user data record or a PUSI data record for an existing PSI user to the HSS service database. You may perform this operation when defining a PSI user or adding a PUSI. Parameter Description: Name
Type
Range
Description
Remarks
PISI
Character string
1-127
PISI number
M
PUSI
Character string
1-127
PUSI number
M
PUSITYPE
Enumerated
DPUSI
specifies the type of the PUSI to be added.
M
WPUSI
Value:
SYSNO
Numeral
0-255
DPUSI(DPUSI): A distinct PUSI is added.
WPUSI(WPUSI): A wildcard PUSI is added.
System serial number
O
Example: ADD HPSI: PISI="pisiinfo", PUSI="sip:[email protected]", PUSITYPE=DPUSI, SYSNO=1; Output: If the operation succeeds,the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
All rights reserved.
Page 523 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.403 Remove a PSI User Command Name: RMV HPSI Function: This command is used to remove a PSI user data record or a PUSI data record from the HSS service database. You may perform this operation when deregistering a user or removing a PUSI data record. Parameter Description: Name
Type
Range
Description
Remarks
PISI
Character string
1-127
PISI number
C
PUSI
Character string
1-127
PUSI number
C
Example: RMV HPSI: PISI="pisiinfo"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters PISI and PUSI must be specified.
9.404 List PSI User Associations Command Name: LST HPSI Function: This command is used to query association between the PISIs and PUSIs of a specified PSI user in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
PISI
Character string
1-127
PISI number
C
PUSI
Character string
1-127
PUSI number
C
Example: LST HPSI: PISI="pisiinfo"; Output: Success output: Horizontal format
All rights reserved.
Page 524 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: PISI
PUSI
IRSID
PUSITYPE
SYSNO
Parameter description: PISI: PISI Number PUSI: PUSI Number IRSID: IRS ID PUSITYPE: 1 | 2 Remark: 1 represents DISTINCT, 2 represents WILDCARDED SYSNO: System Serial Number If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters PISI and PUSI must be specified.
9.405 Set an IRS Command Name: SET HIRS Function: This command is used to set an Implicitly Registered Set (IRS) for multiple IP Multimedia Public Identities (IMPUs) or Public Service Identities (PUSIs) in the Home Subscriber Server (HSS) database. Run SET HIRS when you need to:
Add an IRS.
Add IMPUs or PUSIs to an existing IRS.
Remove IMPUs or PUSIs from an existing IRS or remove an IRS.
The IMPUs or PUSIs in the same IRS share the same registration or unregistration permissions. The default IMPU in the new IRS is the first IMPU in the IMPU list. You can also run SET HDEFIMPU to set the default IMPU for an existing IRS. Parameter Description: Name
Type
Range
Description
Remarks
IRSID
Numeral
0-255
IRS ID
M
IMPULIST
Character string
1-1300
IMPU list
C
PUSILIST
Character string
1-1300
PUSI list
C
Example:
All rights reserved.
Page 525 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
1. SET HIRS: IRSID=1, IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\"&\"sip:imp [email protected]\""; 2. SET HIRS: IRSID=1, IMPULIST="\"sip:[email protected]\""; 3. SET HIRS: IRSID=0, IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\"&\"sip:imp [email protected]\""; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Either IMPU list or PUSI list must be specified.
The IMPUs specified by IMPU list or the PUSIs specified by PUSI list must be different from each other.
The IMPUs specified by IMPU list must be associated with the same IP Multimedia Private Identity (IMPI).
The PUSIs specified by PUSI list must be associated with the same Private Service Identity (PISI).
The IMPUs specified by IMPU list must share the same roaming permissions.
The IMPUs specified by IMPU list must share the same registration permissions.
The IMPUs specified by IMPU list must share the same sharing attributes.
When adding an IRS, ensure that IMPU list or PUSI list contains at least two IMPUs or PUSIs.
9.406 Set the Default IMPU of an IRS Command Name: SET HDEFIMPU Function: This command is used to set the default IP Multimedia Public Identity (IMPU) for an Implicitly Registered Set (IRS) in the Home Subscriber Server (HSS) database. After SET HDEFIMPU is executed, the specified IMPU becomes the default IMPU and the original default IMPU becomes invalid. The default IMPU is used by the Serving Call Session Control Function (S-CSCF) to control calls and sessions. After the S-CSCF sends a request for subscription information, the HSS includes the default IMPU in the Server Assignment Answer (SAA) message sent to the SCSCF. Parameter Description: Name
Type
Range
Description
Remarks
IRSID
Numeral
1-255
IRS ID
M
IMPU
Character string
1-127
IMPU number
M
Example:
All rights reserved.
Page 526 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SET HDEFIMPU: IRSID=2, IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.407 Add an IMSI Command Name: ADD HIMSI Function: This command is used to add IMSI data (IMSI number, MSISDN number, and the associate IMPI) to the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
C
IMSI
Character string
6-15
IMSI number
M
ISDN
Character string
1-15
MSISDN number
O
Example: ADD HIMSI: IMSI="460001234567890", ISDN="8613988888888"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
If the IMPI is specified, the IMPI cannot associate other IMSIs. Otherwise, the HSS displays that the operation has failed.
If the IMPI is specified, an IMSI-IMPI mapping is added in the operation.
If the IMPI is not specified, only the IMSI is added in the operation.
9.408 Remove an IMSI Command Name: RMV HIMSI
All rights reserved.
Page 527 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to remove an IMSI data record from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
M
Example: RMV HIMSI: IMSI="460001234567890"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.409 Modify an IMSI Command Name: MOD HIMSI Function: This command is used to modify an IMSI data record in the HSS service database. The IMSI is the key parameter used to determine the data record to be modified. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
M
NEWIMSI
Character string
6-15
New IMSI number
M
Example: MOD HIMSI: IMSI="460001234567890", NEWIMSI="460001234567891"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
All rights reserved.
Page 528 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.410 Modify Subscriber Identities Using One Command Command Name: MOD HHSSIMSI Function: This command is used to change subscribers' IMPIs or IMPUs and IMPIassociated IMSIs, MSISDNs, and authentication data. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
IMPU
Character string
1-127
IMPU number
C
NEWIMPI
Character string
1-127
New IMPI number
M
NEWIMPIAUTHT YPE
Enumerated
EAA
M
TAA
Specifies the authentication scheme for the new IMPI. Value:
EAA: Early AKA
TAA: Trusted Access
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
NEWIMPU
Character string
1-127
New IMPU number
C
IMPI2
Character string
1-127
IMPI2 number
C
IMPU2
Character string
1-127
IMPU2 number
C
NEWIMPI2
Character string
1-127
New IMPI2 number
C
NEWIMPI2AUTHT YPE
Enumerated
EAA TAA
Specifies the authentication scheme for new IMPI2.
C
Value:
EAA: Early AKA
TAA: Trusted Access
IMSI2
Character string
6-15
IMSI2 number
C
ISDN2
Character string
1-15
MSISDN2 number
C
NEWIMPU2
Character string
1-127
New IMPU2 number
C
Example: MOD HHSSIMSI: IMPI="impiinfo", IMPU="sip:[email protected]", NEWIMPI="new_impiinfo", NEWIMPIAUTHTYPE=EAA, IMSI="460001234567890", ISDN="8613977777777", NEWIMPU="sip:[email protected]", IMPI2="impi2info", IMPU2="sip:[email protected]", NEWIMPI2="new_impi2info", NEWIMPI2AUTHTYPE=TAA, NEWIMPU2="sip:[email protected]"; Output:
All rights reserved.
Page 529 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
IMPI, IMPU, IMPI2, and IMPU2 must be associated with the same subscriber.
Specify both IMPU and NEWIMPU or neither of them. Similarly, specify both IMPU2 and NEWIMPU2 or neither of them.
Assign different values to the following parameters:
-
IMPI and IMPI2
-
IMPU and IMPU2
-
NEWIMPI and NEWIMPI2
-
NEWIMPU and NEWIMPU2
When setting parameter IMPU, note the following: -
The IMPU must be in SIP URI or TEL URI format.
-
The IMPU must be a distinct IMPU.
-
IMPUs are classified into wildcard IMPUs and distinct IMPUs. A wildcard IMPU represents a group of IMPUs whereas a distinct IMPU represents only one IMPU.
-
If the IMPU is not associated with an IMPI, you cannot change the IMPU unless the IMPU has the sharing attribute. To set the sharing attribute for the IMPU, run SET HIMPUSHARE.
When setting parameter NEWIMPU, note the following: -
The NEWIMPU must be in SIP URI or TEL URI format.
-
The NEWIMPU must be a distinct IMPU.
When setting parameter IMPU2, note the following: -
The IMPU2 must be in SIP URI or TEL URI format.
-
The IMPU2 must be a distinct IMPU.
When setting parameter NEWIMPU2, note the following: -
The NEWIMPU2 must be in SIP URI or TEL URI format.
-
The NEWIMPU2 must be a distinct IMPU.
The IMPI, NEWIMPI, IMPI2 and NEWIMPI2 are case-sensitive and must be in NAI format.
9.411 Add an MSISDN Command Name: ADD HISDN Function: This command is used to add an MSISDN data record to the HSS service database and build an association between the MSISDN and the specified IMSI. The data record may be used during 2G subscriber authentication. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
M
ISDN
Character string
1-15
MSISDN number
M
All rights reserved.
Page 530 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: ADD HISDN: IMSI="861381234567890", ISDN="861381234567890"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.412 Remove an MSISDN Command Name: RMV HISDN Function: This command is used to remove an MSISDN data record and the association between the MSISDN and the IMSI from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
M
Example: RMV HISDN: ISDN="861381234567890"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.413 Modify an MSISDN Command Name: MOD HISDN Function: This command is used to modify an MSISDN data record in the HSS service database. The MSISDN is the key parameter used to determine the data record to be modified. Parameter Description:
All rights reserved.
Page 531 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
M
NEWISDN
Character string
1-15
New MSISDN number
M
Example: MOD HISDN: ISDN="8613988888888", NEWISDN="8613977777777"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.414 Modify MSISDNs and IMPUs Using One Command Command Name: MOD HHSSTN Function: This command is used to change subscribers' MSISDNs and IMPUs while keeping their IMSIs and IMPIs. After this command is executed, the HSS9860 sends the new MSISDN to the VLR or SGSN. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
M
NEWISDN
Character string
1-15
New MSISDN number
M
IMPU
Character string
1-127
IMPU number
C
NEWIMPU
Character string
1-127
New IMPU number
C
IMPU2
Character string
1-127
IMPU2 number
C
NEWIMPU2
Character string
1-127
New IMPU2 number
C
Example: MOD HHSSTN: ISDN="8613988888888", NEWISDN="8613977777777", IMPU="sip:[email protected]", NEWIMPU="sip:[email protected]", IMPU2="sip:[email protected]", NEWIMPU2="sip:[email protected]"; Output:
All rights reserved.
Page 532 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
MSISDN, IMPU, and IMPU2 must be associated with the same subscriber.
Set different values for IMPU and IMPU2 as well as NEWIMPU and NEWIMPU2.
Specify both IMPU and NEWIMPU or neither of them. Similarly, specify both IMPU2 and NEWIMPU2 or neither of them.
When setting parameter IMPU, note the following: -
The IMPU must be in SIP URI or TEL URI format.
-
The IMPU must be a distinct IMPU.
When setting parameter NEWIMPU, note the following:
-
The NEWIMPU must be in SIP URI or TEL URI format.
-
The NEWIMPU must be a distinct IMPU.
When setting parameter IMPU2, note the following:
-
The IMPU2 must be in SIP URI or TEL URI format.
-
The IMPU2 must be a distinct IMPU.
When setting parameter NEWIMPU2, note the following:
-
The NEWIMPU2 must be in SIP URI or TEL URI format.
-
The NEWIMPU2 must be a distinct IMPU.
9.415 List the IMSI Data Associated with an IMPI Command Name: LST HMSID Function: This command is used to query IMSI data associated with the IMPI through the IMPI, IMSI or MSISDN. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
C
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST HMSID: IMSI="8613988888888"; Output: Success output: Horizontal format Output:
All rights reserved.
Page 533 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMPI
IMSI
ISDN
Parameter description: IMPI: IMPI Number IMSI: IMSI Number ISDN: MSISDN Number If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the IMPI, IMSI, and ISDN must be specified.
9.416 Add an IMPI-IMSI Association Command Name: ADD HASSOC Function: This command is used to add an association between the IMPI and the IMSI to the HSS service database. If the user does not have an IMPU, the IMSI and the IMPI of the user should be bound to complete the authentication based on the IMPI. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
IMSI
Character string
6-15
IMSI number
M
Example: ADD HASSOC: IMPI="impiinfo", IMSI="460001234567890"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.417 Remove an IMPI-IMSI Association Command Name: RMV HASSOC
All rights reserved.
Page 534 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to remove the association between the IMPI and the IMSI from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
IMSI
Character string
6-15
IMSI number
M
Example: RMV HASSOC: IMPI="impiinfo", IMSI="460001234567890"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.418 List IMPI-IMSI Associations Command Name: LST HASSOC Function: This command is used to query the association between the IMPI and the IMSI in the HSS service database. The IMPI or the IMSI is the key parameter used to determine the data record to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
C
IMSI
Character string
6-15
IMSI number
C
Example: LST HASSOC: IMPI="impiinfo"; Output: Success output: Horizontal format Output: IMPI
IMSI
All rights reserved.
Page 535 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter description: IMPI: IMPI Number IMSI: IMSI Number If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Either IMPI or IMSI must be specified.
9.419 Modify the Multi-SIM Service for VoLTE Command Name: MOD HMSIM Function: This command is used to provide or withdraw the Multi-SIM service as well as modify Multi-SIM subscription data for VoLTE subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
M
MASTERFLAG
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 sets the IMSI of the VoLTE subscriber as the primary one in the Multi-SIM group. Value:
FALSE: The HSS9860 withdraws the Multi-SIM service from the VoLTE subscriber.
TRUE: The HSS9860 provides the Multi-SIM service for the VoLTE subscriber and sets the IMSI of the VoLTE subscriber as the primary one in the Multi-SIM group.
Example: MOD HMSIM: IMSI="1234567891", MASTERFLAG=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
All rights reserved.
Page 536 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.420 List the VoLTE Multi-SIM Service Command Name: LST HMSIM Function: This command is used to query the subscription data of the Multi-SIM service of a VoLTE subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
SUBID
Character string
1-127
Subscription ID
C
Example: LST HMSIM:SUBID="subinfo"; Output: Success output: Mixed format Output: {SUBID}=< Subscription ID > IMSI
MASTERFLAG
Parameter description: SUBID: Subscription ID IMSI: IMSI Number MASTERFLAG: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either SUBID or IMSI.
9.421 List IMS Subscription Information in Batches Command Name: LST HSUBBAT Function: This command is used to query subscription IDs as well as IMPIs and IMPUs associated with the subscription IDs in the HSS database.
To query all IMS subscription information, do not specify any parameter.
All rights reserved.
Page 537 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
To query subscription information associated with a specified subscription ID, specify Fuzzy IMPU.
Parameter Description: Name
Type
Range
Description
Remarks
FUZZYIMPU
Character string
1-122
Specifies the IMPU prefix based on which the HSS queries subscription data records.
C
Example: 1.LST HSUBBAT:; 2.LST HSUBBAT: FUZZYIMPU="+86134"; Output: Success output: Horizontal format Output: SUBID
IMPI
IMPU
Parameter description: SUBID: Subscription ID IMPI: IMPI Number IMPU: IMPU Number If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The query result contains subscriber data such as IMSI and MSISDN. To ensure the security of subscriber data, you must comply with the law and subscriber privacy protection regulations. Besides, you must strictly control the access to the query results.
Before you obtain required data from the carrier's network, the carrier's maintenance personnel must anonymize personal data in the required data and approve the anonymized data to prevent the user data from being disclosed. The anonymization tool can be obtained from the following path at the website http://support.huawei.com/support/: Software Center > Controlled Tool (Mini-tool Software) > Core Network Product Line > Core Network IMS > IMS MT Solution > Log Anonymity Tool.
A maximum of 1000 records can be displayed even if more than 1000 data records are matched.
9.422 Set Mandatory or Optional Capabilities Command Name: SET HMOCAP Function: This command is used to set the mandatory and optional service capabilities for the specified subscription or PSI user in the HSS service database.
All rights reserved.
Page 538 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
C
PISI
Character string
1-127
PISI number
C
MCAP
Character string
1-352
Mandatory capability set
C
OCAP
Character string
1-352
Optional capability set
C
Example: SET HMOCAP: SUBID="subinfo", MCAP="1&2", OCAP="3&4"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters SUBID or PISI must be specified.
At least one of the parameters MCAP and OCAP must be specified.
The parameter values available for MCAP and OCAP are as follows: -
0: indicates an invalid ID.
-
Integer set: consists of 1 to 32 integers combined by &. Each integer ranges from 1 to 4294967295. The integers in each set cannot be duplicated. If both MCAP and OCAP are specified and their values are integer sets, the integers in both sets cannot be duplicated.
9.423 List Mandatory or Optional Capabilities Command Name: LST HMOCAP Function: This command is used to query the mandatory and optional service capabilities of the specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
C
PISI
Character string
1-127
PISI number
C
Example: LST HMOCAP: SUBID="subinfo"; Output:
All rights reserved.
Page 539 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Success output: Horizontal format Output: MCAP
OCAP
Parameter description: MCAP: Mandatory Capability Set OCAP: Optional Capability Set If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters SUBID and PISI must be specified.
9.424 List Subscriber Capabilities Command Name: LST CAP Function: This command is used to query the mandatory and optional capabilities required to satisfy subscribers' service requirements. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST CAP: IMSI="123456789"; Output: If the operation succeeds, the system displays an output with the following format: {MCAP}=< Mandatory Capability Set > {OCAP}=< Optional Capability Set > {SCSCF}=< S-CSCF Name > If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either IMSI or MSISDN.
All rights reserved.
Page 540 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.425 Modify Subscriber Capabilities Command Name: MOD CAP Function: This command is used to configure mandatory and optional capabilities required to satisfy subscribers' service requirements. After receiving a SIP registration request from a subscriber, the I-CSCF queries the HSS for the S-CSCF capability set, which is necessary for the I-CSCF to select an appropriate S-CSCF to fulfill the subscriber's service requirements. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
MCAP
Character string
1-352
Mandatory capability set
C
OCAP
Character string
1-352
Optional capability set
C
SCSCFLIST
Character string
1-649
S-CSCF list
C
Example: MOD CAP: IMSI="123456789", MCAP="1&2", OCAP="3&4", SCSCFLIST="\"sip:scscf1.huawei.com\"&\"sip:scscf2.huawei.com\""; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 541 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Specify either IMSI or MSISDN.
Specify at least one of the following parameters: Mandatory capability set, Optional capability set, or S-CSCF list.
MCAP specifies the mandatory capabilities required to satisfy the subscriber's service requirements. A mandatory capability set contains a maximum of 32 unique integers, each of which is a value ranging from 1 to 4294967295 and is separated by an ampersand (&). For example, 1&2. Meanings of the integers are planned by carriers.
OCAP specifies the optional capabilities required to satisfy the subscriber's service requirements. An optional capability set contains a maximum of 32 unique integers, each of which is a value ranging from 1 to 4294967295 and is separated by an ampersand (&). For example, 3&4. Meanings of the integers are planned by carriers.
SCSCFLIST specifies the S-CSCFs to be associated with the capability set. An S-CSCF list contains 1 to 5 S-CSCFs, each of which is a string of 1 to 127 characters, enclosed in quotation marks ("), and is separated by an ampersand (&). In addition, an escape character (\) is added before each quotation mark ("). For example, \"sip:scscf1.huawei.com\"&\"sip:scscf2.huawei.com\".
9.426 Add an S-CSCF Name Command Name: ADD HCAPSCSCF Function: This command is used to add an S-CSCF to the capability set of the specified subscription or PSI user in the HSS service database. When a user initiates a registration request using the IMPU, the I-CSCF can select the S-CSCF based on the S-CSCF name in the capability set of the user. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
C
PISI
Character string
1-127
PISI number
C
SCSCF
Character string
1-127
S-CSCF name
M
Example: ADD HCAPSCSCF: SUBID="subinfo", SCSCF="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters SUBID and PISI must be specified.
All rights reserved.
Page 542 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.427 Remove an S-CSCF Name Command Name: RMV HCAPSCSCF Function: This command is used to remove an S-CSCF from the capability set of the specified subscription or PSI user in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
C
PISI
Character string
1-127
PISI number
C
SCSCF
Character string
1-127
S-CSCF name
M
Example: RMV HCAPSCSCF: SUBID="subinfo", SCSCF="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters SUBID and PISI must be specified.
9.428 List S-CSCF Names Command Name: LST HCAPSCSCF Function: This command is used to query all the S-CSCF names in the capacity set of the specified subscription or PSI user in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
C
PISI
Character string
1-127
PISI number
C
Example: LST HCAPSCSCF: SUBID="subinfo"; Output:
All rights reserved.
Page 543 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Success output: Horizontal format Output: SCSCF
Parameter description: SCSCF: S-CSCF Name If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters SUBID and PISI must be specified.
9.429 Set a Charging Address ID for an IMPI or a PISI Command Name: SET HCHARGID Function: This command is used to set the charging address ID for the specified IMPI or PISI in the HSS service database. You can run MOD HCHGTPL to modify the address mapping the charging address ID on the client. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
C
PISI
Character string
1-127
PISI number
C
CHARGTPLID
Numeral
0-254
Charging address template ID
M
Example: SET HCHARGID: IMPI="impiinfo", CHARGTPLID=10; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 544 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Only one of the parameters IMPI and PISI must be specified.
The IMPI value must be in NAI format. The value of the parameter is case-sensitive.
The PISI value must be in NAI format. The value of the parameter is case-sensitive.
9.430 List Charging Address IDs of an IMPI or a PISI Command Name: LST HCHARGID Function: This command is used to query the ID mapping the charging address of the specified IMPI or PISI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
C
PISI
Character string
1-127
PISI number
C
Example: LST HCHARGID: PISI="pisiinfo"; Output: Success output: Horizontal format Output: CHARGTPLID
Parameter description: CHARGTPLID: Charging Address Template ID If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPI and PISI must be specified.
The IMPI value must be in NAI format. The value of the parameter is case-sensitive.
The PISI value must be in NAI format. The value of the parameter is case-sensitive.
9.431 Set the Registration Authority of an IMPU Command Name: SET HREGAUTH
All rights reserved.
Page 545 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to set the registration authority for the specified IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
REGAUTH
Boolean
TRUE
Specifies the registration authority.
M
FALSE
Value:
TRUE(True): The registration is allowed.
FALSE(False): The registration is not allowed.
Example: SET HREGAUTH:IMPU="sip:[email protected]", REGAUTH=FALSE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is case-sensitive.
9.432 List the Registration Authority of an IMPU Command Name: LST HREGAUTH Function: This command is used to query the registration authority of the specified IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example: LST HREGAUTH: IMPU="sip:[email protected]"; Output: Success output: Horizontal format
All rights reserved.
Page 546 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: REGAUTH Parameter description: REGAUTH: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is case-sensitive.
9.433 Set the Roaming Authority Check Flag for an IMPU Command Name: SET HVNCFLAG Function: This command is used to set the IMS roaming authority check flag for the specified IMPU in the HSS service database. The flag determines whether to check the roaming authority of the user. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
VNCFLAG
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 checks the visited network check flag. Value:
TRUE(True): The HSS9860 checks the visited network check flag.
FALSE(False):The HSS9860 does not check the visited network check flag.
Example: SET HVNCFLAG: IMPU="sip:[email protected]", VNCFLAG=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is case-sensitive.
All rights reserved.
Page 547 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.434 List the Roaming Authority Check Flag of an IMPU Command Name: LST HVNCFLAG Function: This command is used to query the IMS roaming authority check flag of the specified IMPU in the HSS service database. You can set the IMS roaming authority check flag for an IMPU using SET HVNCFLAG. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example: LST HVNCFLAG: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: VNCFLAG
Parameter description: VNCFLAG: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is case-sensitive.
9.435 Set a Visited Network Template ID for an IMPU Command Name: SET HVNTPLID Function: This command is used to set the visited network template ID for the specified IMPU in the HSS service database. If the IMPU belongs to an IRS, the other IMPUs in the IRS are automatically registered with the same visited network template ID. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
VNTPLID
Numeral
0-255
Visited network template ID
M
All rights reserved.
Page 548 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: SET HVNTPLID: IMPU="sip:[email protected]", VNTPLID=10; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
VNTPLID specifies a visited network template ID. If Visited network template ID is set to 255, the original roaming authority for the specified IMPU is disabled. The parameter must be defined by running ADD HVNTPL before being referenced here.
9.436 List the Visited Network Template ID of an IMPU Command Name: LST HVNTPLID Function: This command is used to query the visited network template ID of the specified IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example: LST HVNTPLID: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: TPLID
Parameter description: TPLID: Visited Network Template ID If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is case-sensitive.
All rights reserved.
Page 549 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.437 Set the NASS Nomadism Control Flag for an IMPU Command Name: SET HNNCFLAG Function: This command is used to set the NASS nomadism control flag for the specified IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
NNCFLAG
Enumerated
ACTIVE DEACTIVE
Specifies whether the HSS9860 activates the nomadism control function of the IMPU.
M
Value:
ACTIVE(Active): The HSS9860 activates the nomadism control function.
DEACTIVE(Deactive): The HSS9860 deactivates the nomadism control function.
Example: SET HNNCFLAG: IMPU="sip:[email protected]", NNCFLAG=ACTIVE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.438 List the NASS Nomadism Control Flag of an IMPU Command Name: LST HNNCFLAG Function: This command is used to query the NASS nomadism control flag of the specified IMPU in the HSS service database. The IMPU is the key parameter used to determine the data record to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
All rights reserved.
Page 550 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: LST HNNCFLAG: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: NNCFLAG
Parameter description: NNCFLAG: 1 | 0 Remark: 1 represents ACTIVE, 0 represents DEACTIVE If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.439 Set a NASS Nomadism Template ID for an IMPU Command Name: SET HNATPLID Function: This command is used to set the NASS nomadism template for the specified IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
NATPLID
Numeral
0-67108863
NASS nomadism template ID
C
TPLNAME
Character string
1-64
NASS nomadism template name
C
Example: 1. SET HNATPLID: IMPU="sip:[email protected]", NATPLID=10; 2. SET HNATPLID: IMPU="sip:[email protected]", TPLNAME="07550011"; 3. SET HNATPLID: IMPU="sip:[email protected]", NATPLID=255; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful
All rights reserved.
Page 551 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Either NASS nomadism template ID parameter or NASS nomadism template name parameter must be specified.
9.440 List the NASS Nomadism Template ID of an IMPU Command Name: LST HNATPLID Function: This command is used to query the NASS nomadism template information of the specified IMPU in the HSS service database. The IMPU is the key parameter used to determine the data record to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example: LST HNATPLID: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: NATPLID
TPLNAME
Parameter description: NATPLID: NASS Nomadism Template ID TPLNAME: NASS Nomadism Template Name If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
If the NASS nomadism template data record identified by the specified IMPU does not exist, the HSS does not display any information.
9.441 Set the Sharing of a Service Profile Command Name: SET HSPSHARE
All rights reserved.
Page 552 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to share a service profile between an IMPU and a base IMPU in the Home Subscriber Server (HSS) database. A service profile is a collection of service and subscriber data. When multiple IMPUs associated with the same IMS subscription share the same service profile, you can run SET HSPSHARE to share the service profile among the IMPUs. Parameter Description: Name
Type
Range
Description
Remarks
BASEIMPU
Character string
1-127
Base IMPU number
M
IMPU
Character string
1-127
IMPU number
M
Example: SET HSPSHARE: BASEIMPU="sip:[email protected]", IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMPU and Base IMPU must have been defined and associated with the same IMS subscription.
If a service profile associated with a specified IMPU is not shared by other IMPUs, the service profile is removed after SET HSPSHARE is executed to associate this IMPU with the same service profile as the base IMPU.
9.442 Remove the Sharing of a Service Profile Command Name: RMV HSPSHARE Function: This command is used to unshare the service profile for one or multiple IP Multimedia Public Identities (IMPUs). Parameter Description: Name
Type
Range
Description
Remarks
IMPULIST
Character string
1-1300
IMPU list
M
Example: 1. RMV HSPSHARE: IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\"";
All rights reserved.
Page 553 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
2. RMV HSPSHARE: IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\""; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
After the service profile shared by one or more IMPUs is unshared, the IMPUs will be automatically associated with a new service profile. The new service profile includes the same subscription data as the originally shared service profile.
To automatically associate the IMPUs whose service profiles are unshared with different service profiles, run RMV HSPSHARE with only one IMPU specified for IMPU list each time.
9.443 List the Sharing Information of a Service Profile Command Name: LST HSPSHARE Function: This command is used to query the IP Multimedia Public Identities (IMPUs) that share the same service profile as an IMPU in the Home Subscriber Server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example: LST HSPSHARE: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: IMPU
Parameter description: IMPU: IMPU Number If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
All rights reserved.
Page 554 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.444 Add Reference Location Information for an IMPU Command Name: ADD HNNRLI Function: This command is used to add a reference location data record for an IMPU to the IMS-HSS database. If the access network cannot inform the IMS network of the location information of a fixedline subscriber who requests an access to the IMS network, the IMS network can use the location information specified during subscription, known as the reference location information,to provide location services for the subscriber. After a reference location data record is added for an IMPU, the IMS-HSS preferentially checks the subscriber's location infor mation carried in an access request against the subscriber's reference location to determine whether the subscriber has NASS nomadism permissions. When multiple reference location data records have been added for an IMPU,the first added reference location data record in which Reference location information type is not set to IPRANGE(IPRANGE) is considered as the default reference location data record. You can run MOD HNNRLI to change an IMPU's default reference location data record. Parameter Description: Name
Type
Range
IMPU
Character string
1-127
IMPU number
M
RLINDEX
Numeral
1-5
Reference location Index
M
RLI
Character string
1-127
Reference location information
M
RLT
Enumerated
IEEE-802.11
M
IEEE-802.11a
IEEE-802.11b
Specifies the fixed-line network type of a subscriber for which the IMS-HSS provides location services.
IEEE-802.11g
ADSL
ADSL2
ADSL2+
RADSL
SDSL
HDSL
HDSL2
G.SHDSL
VDSL
IDSL
IPRANGE
TRUE
Modify All the IMPUs of an IRS
C
FALSE
MODALLIM PUSINIRS
Boolean
Description
Remarks
Example:
All rights reserved.
Page 555 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
ADD HNNRLI: IMPU="sip:[email protected]", RLINDEX=1, RLI="shenzhen", RLT=IEEE-802.11; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMS-HSS includes location reference information of an IMPU in an SAA sent to the S-CSCF only after checking that:
The RLI deliver switch software parameter is set to 1.
The IMPU is the default IMPU in an implicitly registered set (IRS).
9.445 Remove the Reference Location Information of an IMPU Command Name: RMV HNNRLI Function: This command is used to remove the reference location information of a specified IMPU from the IMS-HSS database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
RLINDEX
Numeral
1-5
Reference location index
C
MODALLIMPUSINIRS
Boolean
TRUE
FALSE
Specifies whether the HSS9860 removes the reference location information of all the other IMPUs in the same IRS as the specified IMPU.
C
Value:
TRUE(True): The IMS-HSS removes the reference location information of all the other IMPUs in the same IRS as the specified IMPU.
FALSE(False): The IMS-HSS does not remove the reference location information of any other IMPUs in the same IRS as the specified IMPU.
Example:
All rights reserved.
Page 556 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
1. RMV HNNRLI: IMPU="sip:[email protected]", RLINDEX=1; 2. RMV HNNRLI: IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
After the reference location information of an IMPU is removed, the HSS9860 does not send the reference location information to the S-CSCF, resulting in failures to provide location services for the fixed-line subscriber. Exercise caution when deciding to run this command.
The default reference location data record cannot be removed. (To query the default reference location data record, run LST HNNRLI. The reference location data record whose DEFRLI is 1 in the output is the default reference location data record.)
9.446 Modify the Reference Location Information of an IMPU Command Name: MOD HNNRLI Function: This command is used to modify the reference location information of a specified IMPU in the IMS-HSS database. The following key parameters collectively identify a reference location data record:
IMPU
Reference location index
Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
RLINDEX
Numeral
1-5
Reference location index
M
RLI
Character string
1-127
Reference location information
C
RLT
Enumerated
IEEE-802.11
C
IEEE-802.11a
Specifies the type of the reference location data record.
IEEE-802.11b
IEEE-802.11g
ADSL
ADSL2
ADSL2+
RADSL
SDSL
All rights reserved.
Page 557 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
HDSL
HDSL2
G.SHDSL
VDSL
IDSL
SETDRLI
Boolean
TRUE
MODALLIM PUSINIRS
Boolean
TRUE
FALSE
Description
Remarks
Set default reference location information
C
Specifies whether the IMS-HSS synchronizes the reference location information for an IMPU to all the other IMPUs in the same IRS.
O
Value:
TRUE(True): The IMS-HSS synchronizes the reference location information for an IMPU to all the other IMPUs in the same IRS. After this command is executed with this parameter set to TRUE(True), reference information of all IMPUs in the same IRS becomes the same.
FALSE(False): The IMS-HSS does not synchronize the reference location information for an IMPU to any other IMPUs in the same IRS.
Example: MOD HNNRLI: IMPU="sip:[email protected]", RLINDEX=1, RLI="huawei", RLT=IEEE-802.11b; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 558 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Specify at least one of the following parameters: Reference location information, Reference location information type, and Set default reference location information.
The IMS-HSS delivers the reference location information only for the default IMPU in an IRS. Therefore, make sure to add reference location information for the default IMPU in an IRS.
Reference location information type cannot be modified if it has been set to IPRANGE(IPRANGE). You can run LST HNNRLI to query the value of Reference location information type configured for an IMPU.
9.447 List the Reference Location Information of an IMPU Command Name: LST HNNRLI Function: This command is used to query the reference location information of a specified IMPU in the IMS-HSS database.
To query all reference location data records of an IMPU, specify IMPU.
To query a certain reference location data record of an IMPU, specify IMPU and Reference location index.
Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
RLINDEX
Numeral
1-5
Reference location index
C
Example: 1. LST HNNRLI: IMPU="sip:[email protected]"; 2. LST HNNRLI: IMPU="sip:[email protected]", RLINDEX=1; Output: Success output: Horizontal format Output: RLINDEX
RLI
RLT
DEFRLI
Parameter description: RLINDEX: Reference Location Index RLI: Reference Location Information RLT: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 |11 | 12 | 13 | 14 Remark: 0 represents IEEE-802.11, 1 represents IEEE-802.11a, 2 represents IEEE-802.11b, 3 represents IEEE-802.11g, 4 represents ADSL, 5 represents ADSL2, 6 represents ADSL2+, 7 represents RADSL, 8 represents SDSL, 9 represents HDSL, 10 represents HDSL2, 11 represents G.SHDSL, 12 represents VDSL, 13 represents IDSL, 14 represents IPRANGE
All rights reserved.
Page 559 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
DEFRLI: 1 | 0 Remark: 1 means the reference location data record is the default one, 0 means the reference location data record is not the default one. If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.448 Set the Barring Indication of an IMPU or a PUSI Command Name: SET HBAR Function: This command is used to set the barring indication of the IMPU or the PUSI in the HSS service database. When the barring indication is set to TRUE, IMS services are not available for the IMPU. At present, the barring state of the PUSI does not affect the PUSI processing. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
BAR
Boolean
TRUE FALSE
Specifies the barring indication of the IMPU. At present, the barring state of the PUSI does not affect the PUSI processing.
M
Value:
TRUE(True): The IMPU is barred.
FALSE(False): The IMPU is not barred.
Example: SET HBAR: IMPU="sip:[email protected]", BAR=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
All rights reserved.
Page 560 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.449 List the Barring Indication of an IMPU or a PUSI Command Name: LST HBAR Function: This command is used to query the barring indication of the specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
Example: LST HBAR: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: BAR
Parameter description: BAR: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
9.450 Set a Subscribed Media Profile ID Command Name: SET HMEDIAID Function: This command is used to set the subscription media information to be inclusive in the service profile of the specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
MEDIAID
Numeral
0-4294967295
Subscribed media pofile ID
M
All rights reserved.
Page 561 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: SET HMEDIAID: PUSI="sip:[email protected]", MEDIAID=4294967293; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
9.451 List Subscribed Media Profile IDs Command Name: LST HMEDIAID Function: This command is used to query the subscription media information inclusive in the service profile of the specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
Example: LST HMEDIAID: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: MEDIAID
Parameter description: MEDIAID: Subscribed Media Pofile ID If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
All rights reserved.
Page 562 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.452 Add an iFC Command Name: ADD HIFC Function: This command is used to add initial filter criteria (iFC) to the service profile of the specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
PRIORITY
Numeral
0-65535
Priority
M
PARTIND
Enumerated
REGISTERED
C
UNREGISTERED
PARTIND_DEFAUL T
Specifies whether an iFC data is related to registered services or to unregistered services.
SERVER
Character string
1-127
DEFHND
Enumerated
Value:
REGISTERED(Registered): The iFC data is related to registered services.
UNREGISTERED(Unregiste red): The iFC data is related to unregistered services.
PARTIND_DEFAULT(Defau lt): The iFC data is related to registered services and unregistered services.
AS address
M
SESSION_CONTIN UED
Specifies the handling upon the failure to trigger an AS:
C
SESSION_TERMIN ATED
Value:
SESSION_CONTINUED(Se ssion continued): The session continues.
SESSION_TERMINATED(S ession terminated): The session is terminated.
DEFHANDLING_DEFAUL T(Default handling): The AS determines how to handle the session.
DEFHANDLING_D EFAULT
SERVINFO
Character string
1-127
INCLUDERE GREQ
Enumerated
YES
NO
Service information
C
Specifies whether the HSS9860 includes the requested information contained in a firstparty registration request in a third-party registration request
C
All rights reserved.
Page 563 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
initiated by the S-CSCF. Value:
TRIGPT
Character string
1-3072
NO(No): The HSS9860 does not include the requestion information.
YES(Yes): The HSS9860 includes the requeset information.
Trigger Point
C
Example: ADD HIFC: IMPU="sip:[email protected]", PRIORITY=1, PARTIND=REGISTERED, SERVER="sip:[email protected]", DEFHND=SESSION_CONTINUED, SERVINFO="Service Information", INCLUDEREGREQ=NO, TRIGPT="Triffer point"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
9.453 Remove an iFC Command Name: RMV HIFC Function: This command is used to remove the initial filter criteria (iFC) of the specified priority from the service profile of the specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
PRIORITY
Numeral
0-65535
Priority
M
Example: RMV HIFC: IMPU="sip:[email protected]", PRIORITY=1; Output: If the operation succeeds, the system displays the following message:
All rights reserved.
Page 564 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
9.454 Modify an iFC Command Name: MOD HIFC Function: This command is used to modify the initial filter criteria (iFC) information to be inclusive in the service profile of the specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU Number
C
PUSI
Character string
1-127
PUSI Number
C
PRIORITY
Numeral
0-65535
Priority
M
NEWPRI
Numeral
0-65535
New Priority
C
PARTIND
Enumerated
REGISTERED
C
UNREGISTERED
PARTIND_DEFAU LT
Specifies whether an iFC data is related to registered services or to unregistered services.
SERVER
Character string
1-127
DEFHND
Enumerated
Value:
REGISTERED(Registered ): The iFC data is related to registered services.
UNREGISTERED(Unregi stered): The iFC data is related to unregistered services.
PARTIND_DEFAULT(Def ault): The iFC data is related to registered services and unregistered services.
AS address
C
SESSION_CONTI NUED
Specifies the handling upon the failure to trigger an AS.
C
SESSION_TERMI NATED
Value:
SESSION_CONTINUED( Session continued): The session continues.
SESSION_TERMINATED (Session terminated): The
DEFHANDLING_ DEFAULT
All rights reserved.
Page 565 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
session is terminated.
SERVINFO
Character string
1-127
INCLUDEREGR EQ
Enumerated
YES
NO
DEFHANDLING_DEFAU LT(Default handling): The AS determines how to handle the session.
Service Information
C
Specifies whether the HSS8960 includes the requested information contained in a first-party registration request in a thirdparty registration request initiated by the S-CSCF.
C
Value:
TRIGPT
Character string
1-3072
NO(No): The HSS8960 does not include the requested information.
YES(Yes): The HSS8960 includes the requested information.
Trigger Point
C
Example: MOD HIFC: IMPU="sip:[email protected]", PRIORITY=1, NEWPRI=3; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU or PUSI must be specified.
One of the parameters NEWPRI, PARTIND, SERVER, DEFHND, SERVINFO, INCLUDEREGREQ, or TRIGPT must be specified.
9.455 List iFCs Command Name:LST HIFC Function: This command is used to query the initial filter criteria (iFC) information inclusive in the service profile of the specified IMPU or PUSI in the HSS service database. You can fulfill either of the following tasks using the operation:
All rights reserved.
Page 566 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Query the iFC of the specified priority. The PRIORITY parameter must be present in this case.
Query all the iFC in the service profile. The PRIORITY parameter must not be present in this case
Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
PRIORITY
Numeral
0-65535
Priority
C
Example: LST HIFC: IMPU="sip:[email protected]", PRIORITY=1; Output: Success output: Horizontal format Output: PRIORIT Y
PARTIN D
SERVE R
DEFHN D
SERVINF O
INCLUDEREGR EQ
TRIGP T
Parameter description: PRIORITY: Priority PARTIND: 0 | 1 | 2 Remark: 0 represents REGISTERED, 1 represents UNREGISTERED, 2 represents PARTIND_DEFAULT SERVER: AS Address DEFHND: 0 | 1 | 2 Remark: 0 represents SESSION_CONTINUED, 1 represents SESSION_TERMINATED, 2 represents DEFHANDLING_DEFAULT SERVINFO: Service Information INCLUDEREGREQ: 0 | 1 Remark: 1 represents YES, 0 represents NO TRIGPT: Trigger Point If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
All rights reserved.
Page 567 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.456 Remove All iFC Data Command Name: RMV HALLIFC Function: This command is used to delete all the iFC data in a service profile for an IMPU. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example: RMV HALLIFC: IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is case-sensitive.
9.457 Remove the iFC of an IMPU by AS Address Command Name: RMV HASIFC Function: This command is used to delete the iFC data that contains the same AS address for an IMPU. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
SERVER
Character string
1-127
AS address
M
Example: RMV HASIFC: IMPU="sip:[email protected]", SERVER="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 568 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
None.
9.458 Add a Shared iFC Set Command Name: ADD HSIFC Function: This command is used to add a shared initial filter criteria (iFC) data record for the service profile used by an IP Multimedia Public Identity (IMPU) or Public Service Identity (PUSI) to the Home Subscriber Server (HSS) database. When multiple service profiles share the same iFC data records, you can run ADD HSIFCTPL to add a shared iFC template and then run ADD HSIFC to associate the shared iFC template with the IMPU or PUSI that use the service profile to manage service triggering conditions. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
SIFCID
Numeral
0-65535
Shared iFC template ID
M
Example: ADD HSIFC: IMPU="sip:[email protected]", SIFCID=10; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Each IMPU or PUSI can be configured with a maximum of eight shared iFC templates.
Either IMPU or PUSI must be specified.
When setting parameter SIFCID, note the following: -
The shared iFC template ID must be different from any existing shared iFC template ID associated with the IMPU or PUSI.
-
The parameter must be defined by running ADD HSIFCTPL before being referenced.
All rights reserved.
Page 569 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
The PUSI value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
9.459 Remove a Shared iFC Set Command Name: RMV HSIFC Function: This command is used to remove a shared initial filter criteria (iFC) data record in the service profile used by an IP Multimedia Public Identity (IMPU) or a Public Service Identity (PUSI) from the Home Subscriber Server (HSS) database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
SIFCID
Numeral
0-65535
Shared iFC template ID
M
Example: RMV HSIFC: IMPU="sip:[email protected]", SIFCID=10; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only IMPU or PUSI must be specified.
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
The PUSI value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
9.460 Modify a Shared iFC Set Command Name: MOD HSIFC Function: This command is used to modify a shared initial filter criteria (iFC) data record in the service profile used by an IP Multimedia Public Identity (IMPU) or a Public Service Identity (PUSI) in the Home Subscriber Server (HSS) database. The following key parameters collectively identify a shared iFC data record:
All rights reserved.
Page 570 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMPU or PUSI
Old shared iFC template ID Parameter Description:
Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
OSIFCID
Numeral
0-65535
Old shared iFC template ID
M
NSIFCID
Numeral
0-65535
New shared iFC template ID
M
Example: MOD HSIFC: IMPU="sip:[email protected]", OSIFCID=10, NSIFCID=11; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only IMPU or PUSI must be specified.
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
The PUSI value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
9.461 List Shared iFC Sets Command Name: LST HSIFC Function: This command is used to query the shared initial filter criteria (iFC) data records in the service profile used by an IP Multimedia Public Identity (IMPU) or a Public Service Identity (PUSI) in the Home Subscriber Server (HSS) database.
To query information about the shared iFC data records in the service profile used by an IMPU or a PUSI, specify IMPU only.
To query information about a shared iFC data record in the service profile used by an IMPU or a PUSI, specify IMPU or PUSI and Shared iFC template ID.
Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
All rights reserved.
Page 571 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
SIFCID
Numeral
0-65535
Shared iFC template ID
O
Example: 1. LST HSIFC: IMPU="sip:[email protected]"; 2. LST HSIFC: IMPU="sip:[email protected]", SIFCID=11; Output: Success output: Horizontal format Output: SIFCID
Parameter description: SIFCID: Shared iFC Template ID If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Either IMPU or PUSI must be specified.
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
The PUSI value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
9.462 Add a Service Provider ID Command Name: ADD HSERPRV Function: This command is used to add the Service Provider ID for a specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
SERPRVID
Character string
1-39
Service provider ID
M
Example:
All rights reserved.
Page 572 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
ADD HSERPRV: IMPU="sip:[email protected]", SERPRVID="huawei"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the IMPU and PUSI must be specified.
The service provider ID to be added for an IMPU or PUSI cannot be the same as the existing service provider IDs of the IMPU or PUSI. Otherwise, the HSS displays that the operation has failed.
9.463 Remove a Service Provider ID Command Name: RMV HSERPRV Function: This command is used to delete Service provider ID for a specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
Example: RMV HSERPRV: IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU or PUSI must be specified.
Before the Service provider ID of a specified IMPU or PUSI is deleted, the Service provider ID must be specified. Otherwise, the HSS displays that the operation failed.
9.464 Modify a Service Provider ID Command Name: MOD HSERPRV
All rights reserved.
Page 573 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to modify the Service provider ID for a specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
SERPRVID
Character string
1-39
Service provider ID
M
Example: MOD HSERPRV: IMPU="sip:[email protected]", SERPRVID="huawei"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the IMPU and PUSI must be specified.
A service provider ID can be modified only after the service provider ID is added.
9.465 List the Service Provider ID Command Name: LST HSERPRV Function: This command is used to query the Service provider ID for a specified IMPU or PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
Example: LST HSERPRV: IMPU="sip:[email protected]"; Output: Success output: Horizontal format
All rights reserved.
Page 574 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: SERPRVID
Parameter description: SERPRVID: Service provider ID If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the IMPU and PUSI must be specified.
9.466 Set the Priority of an IMPU or a PUSI Command Name: SET HUSRPRIOR Function: This command is used to set the priority of the IMPU or the PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
USRPRIOR
Enumerated
HIGH MIDDLE
Specifies the priority of the IMPU or PUSI.
M
LOW
Value:
HIGH(HIGH): The IMPU or PUSI has a high priority.
MIDDLE(MIDDLE): The IMPU or PUSI has a middle priority.
LOW(LOW): The IMPU or PUSI has a low priority.
Example: SET HUSRPRIOR: IMPU="sip:[email protected]", USRPRIOR=HIGH; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful
All rights reserved.
Page 575 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the IMPU and PUSI must be specified.
9.467 List the Priority of an IMPU or a PUSI Command Name: LST HUSRPRIOR Function: This command is used to query the priority of the IMPU or the PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
Example: LST HUSRPRIOR: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: USRPRIOR
Parameter description: USRPRIOR: 0 | 1 | 2 Remark: 0 represents HIGH, 1 represents MIDDLE, 2 represents LOW If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the IMPU and PUSI must be specified.
9.468 Set 3GPP-Defined Priority of an IMPU or a PUSI Command Name: SET HSTDPRIOR Function: This command is used to set the 3GPP-defined priority of an IMPU or a PUSI. Priority data in the HSS can be classified into standard priority data and extended priority
All rights reserved.
Page 576 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
data. Standard priority is identified by parameter Standard priority and extended priority is identified by parameters Extended Priority Namespace and Extended priority. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
STDPRIOR
Enum-
HIGH-PRIORITY
Standard priority
C
eration
MIDDLE-PRIORITY
LOW-PRIORITY
LOWEST-PRIORITY
INVALID-PRIORITY
WPS
Extended priority namespace
C
NAMESPACE
Enumeration
EXTPRIOR
Numeral
0-4 or 255
Extended priority
C
CNAMESP
Character string
1-31
Custom-built priority namespace
C
Example: 1. SET HSTDPRIOR: IMPU="sip:[email protected]", STDPRIOR=MIDDLEPRIORITY, NAMESPACE=WPS, EXTPRIOR=2; 2. SET HSTDPRIOR: IMPU="tel:+123", NAMESPACE=WPS, EXTPRIOR=255; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the IMPU and PUSI must be specified.
Specify Extended priority and either Extended Priority Namespace or Custom-built Priority Namespace, or leave these three parameters all unspecified.
Specify either Standard priority or Extended Priority Namespace and Extended priority or all of them.
Specify either Extended Priority Namespace or Custom-built Priority Namespace.
9.469 List 3GPP-Defined Priority of an IMPU or a PUSI Command Name: LST HSTDPRIOR Function: This command is used to query the 3GPP-defined priority of an IMPU or a PUSI.
All rights reserved.
Page 577 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
Example: LST HSTDPRIOR: IMPU="sip:[email protected]"; Output: Success output: Mixed format Output: STDPRIOR NAMESPACE
EXTPRIOR
CNAMESP
Parameter description: STDPRIOR: 0 | 1 | 2 | 3 | 4 Remark: 0 represents HIGHEST-PRIORITY, 1 represents HIGH-PRIORITY , 2 represents MIDDLE-PRIORITY, 3 represents LOW-PRIORITY, 4 represents LOWEST-PRIORITY NAMESPACE: 0 Remark: 0 represents WPS EXTPRIOR: Extended Priority CNAMESP: Custom-built Priority Namespace If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the IMPU and PUSI must be specified.
9.470 Set the loose route indication of an IMPU or a PUSI Command Name: SET HLRI Function: This command is used to set the loose route indication for an IMPU or a PUSI. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
All rights reserved.
Page 578 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
LRI
Enumerated
LOOSE_ROUTE_N OT_REQUIRED
LOOSE_ROUTE_R EQUIRED
Description
Remarks
Specifies whether the HSS9860 provides or withdraws the loose route indication for an IMPU or a PUSI.
M
Value:
LOOSE_ROUTE_REQUIRED (Loose route required): The HSS9860 provides the loose route indication for an IMPU or a PUSI.
LOOSE_ROUTE_NOT_REQUI RED (Loose route not required): The HS9860 withdraws the loose route indication for an IMPU or a PUSI.
Example: SET HLRI: IMPU="sip:[email protected]", LRI=LOOSE_ROUTE_REQUIRED; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only the IMPU or the PUSI must be specified.
9.471 List the loose route indication of an IMPU or a PUSI Command Name: LST HLRI Function: This command is used to query the loose route indication configured for an IMPU or a PUSI. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
Example:
All rights reserved.
Page 579 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
LST HLRI: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: LRI
Parameter description: LRI: 0 | 1 Remark: 0 represents LOOSE_ROUTE_NOT_REQUIRED, 1 represents LOSE_ROUTE_REQUIRED If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only the IMPU or the PUSI must be specified.
9.472 Add an AS Service Profile ID for an IMPU or a PUSI Command Name: ADD HASSPID Function: This command is used to add an AS-ServiceProfileId data record associated with the specified IMPU or the PUSI to the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
ASSPID
Numeral
0-255
AS service profile ID
M
Example: ADD HASSPID: IMPU="sip:[email protected]", ASSPID=1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 580 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Only one of the parameters IMPU and PUSI must be specified.
One IMPU or PUSI can be associated with up to 32 AS service profile IDs.
9.473 Remove an AS Service Profile ID of an IMPU or a PUSI Command Name: RMV HASSPID Function: This command is used to remove the AS-ServiceProfileId data record associated with the specified IMPU or the PUSI from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
ASSPID
Numeral
0-255
AS service profile ID
C
Example: RMV HASSPID: IMPU="sip:[email protected]", ASSPID=10; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
If AS service profile ID is not specified, all the AS service profile IDs associated with the IMPU or PUSI are removed.
Only one of the parameters IMPU and PUSI must be specified.
9.474 List the AS Service Profile IDs of an IMPU or a PUSI Command Name: LST HASSPID Function: This command is used to query the AS-ServiceProfileId data record associated with the specified IMPU or the PUSI in the HSS service database. The IMPU or the PUSI is the key parameter used to determine the data record to be queried. Parameter Description:
All rights reserved.
Page 581 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
Example: LST HASSPID: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: ASSPID
Parameter description: ASSPID: AS Service Profile ID If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
9.475 Set an Alias Group ID Command Name: SET HALIASPU Function: This command is An alias IP Multimedia Public Identity (IMPU) group is a collection of IMPUs that belong to the same Implicitly Registered Set (IRS) and share the same service profile. SET HALIASPU is used to configure multiple IMPUs as an alias group in the Home Subscriber Server (HSS) database. Run SET HALIASPU when you need to:
Add an alias IMPU group.
Add IMPUs to the alias IMPU group with an existing alias group ID.
Remove IMPUs from an existing alias IMPU group or remove the alias IMPU group.
Parameter Description: Name
Type
Range
Description
Remarks
ALIASID
Numeral
0-255
Alias group ID
M
IMPULIST
Character string
1-1300
IMPU list
M
Example:
All rights reserved.
Page 582 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
1. SET HALIASPU: ALIASID=1, IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\""; 2. SET HALIASPU: ALIASID=1, IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\""; 3. SET HALIASPU: ALIASID=0, IMPULIST="\"sip:[email protected]\""; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
When adding an alias IMPU group, ensure that Alias group ID is not 0 and is not being used in the IP Multimedia Subsystem (IMS) subscription with which the IMPU list is associated. The IMPU list must contain two or more IMPUs. IMPUs specified by IMPU list must belong to the same IRS and share the same service profile.
When adding an IMPU to an existing alias IMPU group, ensure that Alias group ID is not 0 and it exists in the IMS subscription with which the IMPU list is associated. The IMPU list must contain at least one IMPU. The IMPUs specified by IMPU list must belong to the same IRS and share the same service profile as the IMPUs in the alias IMPU group.
When removing an IMPU or all IMPUs from an existing alias IMPU group, ensure that Alias group ID is 0 and the IMPUs in the IMPU list belong to the same alias IMPU group. When an alias IMPU group does not contain any IMPU or contains only one IMPU, the alias IMPU group is automatically removed.
An IMPU can belong to only one alias IMPU group.
9.476 Set the Repository Data Command Name: SET HREPDATA Function: This command is used to set, modify, or delete the repository data of the specified IMPU or PUSI in the HSS service database. Repository data is classified into repository data and alias repository data. The IMPU mapping the alias repository data must belong to an alias group. You can check whether the IMPU belongs to an alias group using the LST HSUB operation. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
REPDATA
Character string
1-16380
Repository data
C
SERVICEID
Character string
1-127
Service indication
C
SERVICEDATA
Character string
1-7718
Service data
C
REPTYPE
Enum
Specifies the type of the repository data to be set.
C
ALIASREPDA TA
All rights reserved.
Page 583 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
DATASOURCE
Summary of CommandsSummary of Commands
Type
Range
eration
REPDATA
Enum
PROV
eration
SH
CSSYNDATA Prov
Description
Remarks
Value:
ALIASREPDATA(Aliasrepositor y data): The repository data is the alias repository data.
REPDATA(repository data): The repository data is the normal repository data.
Specifies the source of the Repository data specified. This parameter is valid only when Repository data is specified.
O
Value:
PROV(Provisioning system): The source of the repository data is the provisioning system.
SH(Sh interface): The source of the repository data is the service layer redundancy system.
CSSYNDATAProv(CS domain synchronization data): The source of the repository data is the provisioning system. The HSS automatically synchronizes the repository data to the CS domain.
Example: 1. SET HREPDATA: IMPU="sip:[email protected]", SERVICEID="3", SERVICEDATA="SH_RSI_DATA", REPTYPE=REPDATA; 2. SET HREPDATA: IMPU="sip:[email protected]", SERVICEID="3", SERVICEDATA="SH_STR_DATA", REPTYPE=REPDATA; 3. SET HREPDATA: IMPU="sip:[email protected]", SERVICEID="3", REPTYPE=REPDATA; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 584 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Only one of the parameters IMPU and PUSI must be specified.
If IMPU is specified, Type of repository data must be specified; if PUSI is specified, Type of repository data cannot be specified.
If REPDATA is specified, SERVICEID and SERVICEDATA cannot be specified; if REPDATA is not specified, SERVICEID must be specified.
If SH_ALIASREPDATA_SUPPORT_DATAREFERENCE0 is set to TRUE, set REPDATA to repository data and REPTYPE to REPDATA(repository data). You can query the value of SH_ALIASREPDATA_SUPPORT_DATAREFERENCE0 by running LST HSYSTEMPARA.
9.477 List the Repository Data Command Name: LST HREPDATA Function: This command is used to query the repository data of the IMPU based on the specified type or service indication or query the repository data of the PUSI based on the specified service indication in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
REPTYPE
Enum
ALIASREPDATA
eration
REPDATA
Specifies the type of the repository data to be set.
C
Value:
SRVIND
Character string
1-127
ALIASREPDATA(Aliasrepositor y data): The repository data is the alias repository data.
REPDATA(repository data): The repository data is the normal repository data.
Service indication
M
Example: LST HREPDATA:IMPU="sip:[email protected]", REPTYPE=ALIASREPDATA, SRVIND="10"; Output: Success output: Horizontal format Output: REPDATA
REPTYPE
Parameter description:
All rights reserved.
Page 585 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
REPDATA: Repository data REPTYPE: 0 | 1 Remark: 0 represents ALIASREPDATA, 1 represents REPDATA If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
If IMPU is specified, Repository data type must be specified; if PUSI is specified, Repository data type cannot be specified.
If SH_ALIASREPDATA_SUPPORT_DATAREFERENCE0 is set to TRUE, set REPTYPE to REPDATA(repository data). You can query the value of SH_ALIASREPDATA_SUPPORT_DATAREFERENCE0 by running LST HSYSTEMPARA.
9.478 Add an Extended Service Data Command Name: ADD HPREPDATA Function: This command is used to add the extended service data for the specified IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
IMSI
Character string
6-15
IMSI number
M
SELFSERVICE
Boolean
TRUE
Self service
M
FALSE
SMSCADDRESS
Character string
1-40
SMSC address
C
LOCATIONINFOR MATION
Character string
9-10 or 13-14
Location information
C
NPINDICATOR
Boolean
TRUE
M
FALSE
Specifies the numbering plan identity of an IMPU. Value:
CICINDICATOR
Boolean
TRUE
FALSE
TRUE(True): The numbering plan is supported.
FALSE(False): The numbering plan is not supported.
Specifies whether the HSS9860 implements the equal access service through the carrier identification code.
M
Value:
TRUE(True): The HSS9860 supports the equal access service to be implemented through the
All rights reserved.
Page 586 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
carrier identification code.
BINDINDICATOR
Boolean
TRUE
FALSE
FALSE(False): The HSS9860 does not support the equal access service to be implemented through the carrier identification code.
Specifies the CS binding indicator of an IMPU.
C
Value:
TRUE(True): The CS Binding is supported.
FALSE(False):The CS Binding is not supported.
Example: ADD HPREPDATA: IMPU="sip:[email protected]", IMSI="12345678", SELFSERVICE=TRUE, SMSCADDRESS="67896789", LOCATIONINFORMATION="460004777", NPINDICATOR=TRUE, CICINDICATOR=TRUE; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The extended service data is encrypted before it is stored in the database. Therefore, the extended service data stored in the database is different from the actual input data.
9.479 Remove an Extended Service Data Command Name: RMV HPREPDATA Function: This command is used to remove the extended service data of the specified IMPU from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example:
All rights reserved.
Page 587 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
RMV HPREPDATA:IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.480 Modify an Extended Service Data Command Name: MOD HPREPDATA Function: This command is used to modify the extended service data of the specified IMPU in the HSS service database. The IMPU is the key parameter used to determine the data record to be modified. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
IMSI
Character string
6-15
IMSI number
C
SELFSERVICE
Boolean
TRUE FALSE
Specifies the self service identity of the IMPU.
C
Value:
TRUE(True): The self service is supported.
FALSE(False):The self service is not supported.
SMSCADDRESS
Character string
1-40
SMSC address
C
LOCATIONINFORM ATION
Character string
9-10 or 1314
Location information
C
NPINDICATOR
Boolean
TRUE
C
FALSE
Specifies the numbering plan identify to be modified. Value:
CICINDICATOR
Boolean
TRUE
FALSE
TRUE(True): The numbering plan is supported.
FALSE(False):The numbering plan is not supported.
Specifies whether the HSS8960 implements the equal access service through the carrier identification code.
All rights reserved.
C
Page 588 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
Value:
BINDINDICATOR
Boolean
TRUE
FALSE
TRUE(True): The HSS8960 implements the equal access service.
FALSE(False): The HSS8960 does not implement the equal access service.
Specifies the CS binding indicator of the IMPU.
C
Value:
TRUE(True): The CS binding is supported.
FALSE(False): The CS binding is not supported.
Example: MOD HPREPDATA: IMPU="sip:[email protected]", IMSI="400612345678"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
One of the parameters IMSI, SELFSERVICE, SMSCADDRESS, LOCATIONINFORMATION, NPINDICATOR, CICINDICATOR and BINDINDICATOR must be specified. If the result report of this command is "decrypted failed", it This parameter indicates that the data is repository data, and use SET HREPDATA command to modify.
9.481 List an Extended Service Data Command Name: LST HPREPDATA Function: This command is used to query the extended service data of the specified IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example:
All rights reserved.
Page 589 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
LST HPREPDATA: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output:
IM PU
IM SI
SELFSE RVICE
SMSCAD DRESS
LOCATIONINF ORMATION
NPINDIC ATOR
CICIN DICAT OR
BINDIN DICATO R
Parameter description: IMPU: IMPU Number IMSI: IMSI Number SELFSERVICE: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE SMSCADDRESS: SMSC Address LOCATIONINFORMATION: Location Information NPINDICATOR: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE CICINDICATOR: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE BINDINDICATOR: 1 | 0 Remark: 1 represents TRUE, 0 represents FALSE If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
If the result report of this command is "decrypted failed", it This parameter indicates that the data is repository data, and use LST HREPDATA command to query.
9.482 List the Service Indication of the Repository Data Command Name: LST HSRVIND Function: This command is used to query the Service Indication of the repository data associated with the specified IMPU or the PUSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character
1-127
IMPU number
C
All rights reserved.
Page 590 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
PUSI number
C
Specifies the type of the repository data. The service indication of the repository data is to be queried.
C
string PUSI
Character string
1-127
REPTYPE
Enum-
ALIASREPDATA
eration
REPDATA
Value:
ALIASREPDATA(Aliasreposito ry data): The repository data is alias repository data.
REPDATA(repository data): The repository data is common repository data.
Example: LST HSRVIND: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: SRVIND
REPTYPE
Parameter description: SRVIND: Service Indication REPTYPE: 0 | 1 Remark: 0 represents ALIASREPDATA, 1 represents REPDATA If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Either IMPU or PUSI must be specified.
If IMPU and Repository data type are specified, the service indication of the repository data of the specified type is queried.
If IMPU is specified and Repository data type is not specified, the service indications of the repository data of all types are queried. If PUSI is specified, Repository data type cannot be specified.
9.483 Set an AS Address for a PUSI Command Name: SET HAS
All rights reserved.
Page 591 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to set the application server (AS) address for the specified PUSI in the HSS service database. The AS address must be in SIP format. Parameter Description: Name
Type
Range
Description
Remarks
PUSI
Character string
1-127
PUSI number
M
AS
Character string
1-127
AS
C
Example: SET HAS: PUSI="sip:[email protected]", AS="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.484 List the AS Address of a PUSI Command Name: LST HAS Function: This command is used to query the application server (AS) address of the specified PUSI in the HSS service database. You can set the AS address of the PUSI using SET HAS. Parameter Description: Name
Type
Range
Description
Remarks
PUSI
Character string
1-127
PUSI number
M
Example: LST HAS: PUSI="sip:[email protected]"; Output: Success output: Horizontal format Output: AS
All rights reserved.
Page 592 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter description: AS: AS Address
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.485 Set the CAMEL Subscription Information Command Name: SET HCSI Function: This command is used to set the Customized Applications for Mobile network Enhanced Logic (CAMEL) subscription information for a specified IMSI in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
M
ISDN
Character string
1-15
MSISDN number
M
CSITYPE
Enum-
O-CSI
CSI type
M
eration
T-CSI
Numeral
0-255
CSI template ID
M
CSITPLID
Example: SET HCSI: IMSI="125353", ISDN="86137565425", CSITYPE=O-CSI, CSITPLID=10; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.486 List the CAMEL Subscription Information Command Name: LST HCSI
All rights reserved.
Page 593 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to query the Customized Applications for Mobile network Enhanced Logic (CAMEL) subscription information for a specified IMSI from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
M
CSITYPE
Enumerated
O-CSI
CSI type
C
T-CSI
Example: LST HCSI: IMSI="125353", CSITYPE=O-CSI; Output: Success output: Horizontal format Output: IMSI
ISDN
CSITYPE
CSITPLID
Parameter description: IMSI: IMSI Number ISDN: MSISDN Number CSITYPE: 0 | 1
Remark: 0 represents O-CSI , 1 represents T-CSI
CSITPLID: CSI Template ID If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.487 List the Dynamic Location Information of an IMPU Command Name: LST HDALI Function: This command is used to query the dynamic access location of the specified IMPU in the HSS service database. The IMPU is the key parameter used to determine the data record to be queried. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
All rights reserved.
Page 594 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
Example: LST HDALI: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: IMSALI
NASSALI
IPV4ADDR
IPV6ADDR
SIPADDR
NASSSTATUS
Parameter description: IMSALI: IMS Access Location Information NASSALI: NASS Access Location Information IPV4ADDR: IPV4 Address IPV6ADDR: IPV6 Address SIPADDR: SIP Address NASSSTATUS: NASS Nomadism Status If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.488 List the AS Subscription Data of Subscribers Command Name: LST HASSUBDATA Function: This command is used to query the IMPU or PUSI data subscribed by an AS. The AS sends messages to the HSS to subscribe to subscriber data. If the IMPU is specified, you can query the following data:
IMSUserState subscription data
S-CSCFName subscription data
InitialFilterCriteria subscription data
RepositoryData subscription data
AliasesRepositoryData subscription data
Aliases IMPU subscription data
All rights reserved.
Page 595 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
IMSI subscription data
UE-SRVCC- Capability subscription data
ChargingInformation subscription data
Expiry time
If the PUSI is specified, you can query the following data:
S-CSCFName subscription data
InitialFilterCriteria subscription data
RepositoryData subscription data
PSIActivation subscription notification
ChargingInformation subscription data
Expiry time
Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
Example: LST HASSUBDATA: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: SUBASID DATATYPE ASNAME SRVIND ALIASID IMPI ExpiryTime Parameter description: SUBASID: The ID of an AS DATATYPE: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 Remark: 0 represents IMSUserState, 1 represents S-CSCFName, 2 represents InitialFilterCriteria, 3 represents RepositoryData, 4 represents PSIActivation, 5 represents AliasesRepositoryData,6 represents AliasesIMPU, 7 represents IMSI, 8 represents UESRVCC- Capability,9 represents ChargingInformation ASNAME: AS Name SRVIND: Service Information ALIASID: The ID of an Alias Group IMPI: IMS private user identity ExpiryTime: The Time When the Subscribed Data Expires If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 596 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Only one of the two parameters IMPU and PUSI needs to be specified.
9.489 List the Dynamic Data of an IMS Subscriber Command Name: LST HDYNDATA Function: This command is used to query the dynamic data of the specified IMS Subscriber in the HSS service database. You can query a group of data records or a single data record. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
C
IMPU
Character string
1-127
IMPU number
C
Example: LST HDYNDATA: IMPI="impiinfo", IMPU="sip:[email protected]"; Output: Output: IMPI
IMPU
IMSUSERST
PENDINGFLAG
SERVER
ISEXISTRESTOREDATA
Parameter description: IMPI: IMPI Number IMPU: IMPU Number IMSUSERST: 0 | 1 | 2 Remark: 0 represents NOTREGISTERED, 1 represents UNREGISTERED, 2 represents REGISTERED PENDINGFLAG: 0 | 1 Remark: 0 represents FALSE, 1 represents TRUE SERVER: Current SCSCF Name ISEXISTRESTOREDATA: 0 | 1 | 2 | 3 Remark: 0 represents NODATA, 1 represents STDDATA, 2 represents PRVTDATA, 3 represents STDPRVTDATA. Furthermore, 0: S-CSCF Restoration Information does not exist. 1: 3GPP-defined S-CSCF Restoration Information exists. 2: Huawei proprietary S-CSCF Restoration Information exists.
All rights reserved.
Page 597 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
3: Both 3GPP-defined and Huawei proprietary S-CSCF Restoration Information exists. If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
One of the parameters IMPI and IMPU must be specified.
The IMPI value must be in NAI format. The value of the parameter is case-sensitive.
The IMPU value must be in SIP URI or TEL URI format. The value of the parameter is casesensitive.
9.490 List the Dynamic Data of a PSI User Command Name: LST HPSIDYND Function: This command is used to query the dynamic data of the specified PSI user in the HSS service database. You can specify the PISI, PUSI, or both. Parameter Description: Name
Type
Range
Description
Remarks
PISI
Character string
1-127
PISI number
C
PUSI
Character string
1-127
PUSI number
C
Example: LST HPSIDYND: PUSI="sip:[email protected]"; Output: Success output: Horizontal format Output: PISI
PUSI
ACTSTATE
REGSTATE
SERVER
Parameter description: PISI: PISI Number PUSI: PUSI Number ACTSTATE: 0 | 1 Remark: 0 represents INACTIVE, 1 represents ACTIVE REGSTATE: 0 | 1 Remark: 0 represents NOTREGISTERED, 1 represents UNREGISTERED SERVER: Current SCSCF Name
All rights reserved.
Page 598 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
If only PISI is specified, the dynamic data of all the PUSI-PISI pairs is queried.
If only PUSI is specified, the dynamic data of the PUSI-PISI pair is queried.
If PISI and PUSI are specified, the dynamic data of the PUSI-PISI pair is queried.
9.491 Deregister Subscribers Command Name: DRG HUSER Function: This command is used to enable the Provisioning System to send a deregistration notification. The operation applies to a single user or a group of users. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
C
IMPU
Character string
1-127
IMPU number
C
Example: DRG HUSER: IMPI="impiinfo", IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
One of the parameters IMPI and IMPU must be specified.
9.492 Set the Emergency Service Routing Number Command Name: SET HESRN Function: This command is used to set an emergency service routing number (ESRN) for an IMPU. If the IMPU associates with an IRS, the ESRN is automatically configured for the other IMPUs in the IRS after this command is executed. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
All rights reserved.
Page 599 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ESRN
Character string
1-127
Emergency service routing number
C
Example: SET HESRN: IMPU="sip:[email protected]", ESRN=shenzhenbantian; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
If ESRN is not specified, all the ESRN associated with the IMPU is removed.
9.493 List the Emergency Service Routing Number Command Name: LST HESRN Function: This command is used to query the emergency service routing number of the specified IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example: LST HESRN: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: ESRN
Parameter description: ESRN: Emergency Service Routing Number If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 600 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
None.
9.494 Add the OneKey Data for an IMPU Command Name: ADD HONEKEY Function: This command is used to add a piece of OneKey data for an IMPU to the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
WUSERNAME
Character string
1-127
Web user name
M
HTOKEN
Character string
1-15
HTTP token
M
AP
Character string
1-255
Aggregation proxy
M
Example: ADD HONEKEY: IMPU="sip:[email protected]", WUSERNAME="WUSERNAME", HTOKEN="HTOKEN", AP="AP"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.495 Remove the OneKey Data of an IMPU Command Name: RMV HONEKEY Function: This command is used to delete the OneKey data of an IMPU from the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
All rights reserved.
Page 601 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: RMV HONEKEY: IMPU="sip:[email protected]"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.496 Modify the OneKey Data of an IMPU Command Name: MOD HONEKEY Function: This command is used to modify the OneKey data of an IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
WUSERNAME
Character string
1-127
Web user name
C
HTOKEN
Character string
1-15
HTTP token
C
AP
Character string
1-255
Aggregation proxy
C
Example: MOD HONEKEY: IMPU="sip:[email protected]", WUSERNAME="WUSERNAME", HTOKEN="HTOKEN", AP="AP"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
At least one of the parameters Web user name, HTTP token, and Aggregation proxy must be specified.
All rights reserved.
Page 602 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.497 List the OneKey Data of an IMPU Command Name: LST HONEKEY Function: This command is used to query the OneKey data of an IMPU in the HSS service database. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
M
Example: LST HONEKEY: IMPU="sip:[email protected]"; Output: Success output: Horizontal format Output: WUSERNAME
HTOKEN
AP
Parameter description: WUSERNAME: Web User Name HTOKEN: HTTP Token AP: Aggregation Proxy If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.498 Add GUSS for an IMPI Command Name: ADD HGUSS Function: This command is used to configure GBA user security settings (GUSS) for an IMPI. GUSS data is used to authenticate users on the HSS in the Generic Bootstrapping Architecture (GBA) when users use UEs to manage services. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
All rights reserved.
Page 603 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
GSID
Enum
UNSPECIFIC_SERVICE
eration
PKI-PORTAL
AUTHENTICATION_PR OXY
PRESENCE
MBMS
LIBERTY_ALLIANCE_P ROJECT
UICCTERMINAL_KEY_EST ABLISHMENT
TERMINALREMOTE_DEVICE_KE Y_ESTABLISHMENT
ANDSF
GBA_PUSH
IMS_BASED_PSS_MBM S
OPENID_GBA_INTERW ORKING
GENERIC_PUSH_LAYE R
OPENID_INTERWORKI NG
Description
Remarks
GAA service identifier
M
GAAAUTHFLAG
Numeral
0-2
GAA authorization flag
C
NAFGROUP
Character string
1-127
NAF grouping
C
UICCTYPE
Enum
GBA
C
eration
GBA_U
Specifies the type of the key that can be generated in the GUSS when users want to use UEs to manage services. Value:
KEYCHOICE
Enum
ME-based-key
eration
UICC-based-key
ME-UICC-based-keys
All rights reserved.
GBA(GBA): Only the Ks_NAF type of key can be generated.
GBA_U(GBA_U): Both the Ks_NAF and Ks_int_NAF types of key can be generated.
Specifies the policy to be used by the HSS9860 to select a key to authenticate users in the GBA when users use UEs
C
Page 604 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
to manage services. Value:
LIFETIME
Numeral
1-4294967295
ME-based-key(MEbased-key): Only the Ks_NAF type of key can be used.
UICC-basedkey(UICC-basedkey): Only the Ks_int_NAF type of key can be used.
ME-UICC-basedkeys(ME-UICCbased-keys): Either the Ks_NAF or Ks_int_NAF type of key can be used.
Key validity duration
C
Example: ADD HGUSS: IMPI="impiinfo", GSID=PKI-PORTAL, GAAAUTHFLAG=1, NAFGROUP="nafgroup"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
This parameter specifies the GAA authorization flag of the GUSS.
This parameter is available only when GAA Service Identifier is PKI-PORTAL, ANDSF, or OPENID_INTERWORKING. Value: -
If GAA Service Identifier is PKI-PORTAL, the value is 1 (Authentication allowed) or 2 (Non-repudiation allowed).
-
If GAA Service Identifier is ANDSF, the value is 0 (Not authorized) or 1 (Authorized according to policy stored in ANDSF server).
-
If GAA Service Identifier is OPENID_INTERWORKING, the value is 0 (Not authorized) or 1 (Authorized).
The IMPI must be in NAI format. The value of this parameter is case-sensitive.
UICCTYPE specifies the type of the key that can be generated in the GUSS when users want to use UEs to manage services. Value: -
GBA(GBA): Only the Ks_NAF type of key can be generated.
-
GBA_U(GBA_U): Both the Ks_NAF and Ks_int_NAF types of key can be generated.
All rights reserved.
Page 605 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
KEYCHOICE parameter specifies the policy to be used by the HSS9860 to select a key to authenticate users in the GBA when users use UEs to manage services. Value: -
ME-based-key(ME-based-key): Only the Ks_NAF type of key can be used.
-
UICC-based-key(UICC-based-key): Only the Ks_int_NAF type of key can be used.
-
ME-UICC-based-keys(ME-UICC-based-keys): Either the Ks_NAF or Ks_int_NAF type of key can be used.
LIFETIME parameter specifies the validity duration of a cipher key in the GUSS information that the HSS9860 sends to the BSF over the Zh interface for a subscriber requesting to configure services on the AS. The BSF checks this parameter to determine whether a subscriber's cipher key is valid. Value: -
1-4294967295.
-
9.499 Remove GUSS from an IMPI Command Name: RMV HGUSS Function: This command is used to delete GBA user security settings from an IMPI. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
GSID
Enum
UNSPECIFIC_SERVICE
C
eration
PKI-PORTAL
GAA service identifier
AUTHENTICATION_PROXY
PRESENCE
MBMS
LIBERTY_ALLIANCE_PROJECT
UICCTERMINAL_KEY_ESTABLISHM ENT
TERMINALREMOTE_DEVICE_KEY_ESTAB LISHMENT
ANDSF
GBA_PUSH
IMS_BASED_PSS_MBMS
OPENID_GBA_INTERWORKING
GENERIC_PUSH_LAYER
OPENID_INTERWORKING
Example: RMV HGUSS: IMPI="impiinfo", GSID=PKI-PORTAL; Output:
All rights reserved.
Page 606 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
To delete GUSS of a specified GAA service type, specify GAA Service Identifier.
To delete GUSS of all GAA service types, do not specify GAA Service Identifier.
The IMPI must be in NAI format. The value of this parameter is case-sensitive.
9.500 Modify GUSS of an IMPI Command Name: MOD HGUSS Function: This command is used to modify the GUSS of an IMPI. The GUSS data to be modified can be GAA authorization flag, NAF grouping, UICC type, Key choice or Key validity duration. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
GSID
Enum-
UNSPECIFIC_SERVICE
GAA service identifier
C
eration
PKI-PORTAL
AUTHENTICATION_PROXY
PRESENCE
MBMS
LIBERTY_ALLIANCE_PROJ ECT
UICCTERMINAL_KEY_ESTABL ISHMENT
TERMINALREMOTE_DEVICE_KEY_E STABLISHMENT
ANDSF
GBA_PUSH
IMS_BASED_PSS_MBMS
OPENID_GBA_INTERWOR KING
GENERIC_PUSH_LAYER
OPENID_INTERWORKING
GAAAUTHFLAG
Numeral
0-2
GAA authorization flag
C
NAFGROUP
Character string
1-127
NAF grouping
C
All rights reserved.
Page 607 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Range
UICCTYPE
Enum-
GBA
eration
GBA_U
Summary of CommandsSummary of Commands
Description
Remarks
Specifies the type of the key that can be generated in the GUSS when users want to use UEs to manage services.
C
Value:
KEYCHOIC E
Enum-
ME-based-key
eration
UICC-based-key
ME-UICC-based-keys
GBA(GBA): Only the Ks_NAF type of key can be generated.
GBA_U(GBA_U): Both the Ks_NAF and Ks_int_NAF types of key can be generated.
Specifies the policy to be used by the HSS9860 to select a key to authenticate users in the GBA when users use UEs to manage services.
C
Value:
LIFETIME
Numeral
0-4294967295
ME-based-key(MEbased-key): Only the Ks_NAF type of key can be used.
UICC-basedkey(UICC-basedkey): Only the Ks_int_NAF type of key can be used.
ME-UICC-basedkeys(ME-UICCbased-keys): Either the Ks_NAF or Ks_int_NAF type of key can be used.
Key validity duration
C
Example: MOD HGUSS: IMPI="impiinfo", GSID=PKI-PORTAL, GAAAUTHFLAG=1, NAFGROUP="nafgroup"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful
All rights reserved.
Page 608 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify GAA Service Identifier or UICC type or both of them.
When GAA Service Identifier is specified, at least one of GAA authorization flag, NAF grouping, and Key choice must be specified.
When GAA Service Identifier is not specified, neither NAF grouping nor Key choice can be specified.
This parameter specifies the GAA authorization flag of the GUSS.
This parameter is available only when GAA Service Identifier is PKI-PORTAL, ANDSF, or OPENID_INTERWORKING. Value:
-
If GAA Service Identifier is PKI-PORTAL, the value is 1 (Authentication allowed) or 2 (Non-repudiation allowed).
-
If GAA Service Identifier is ANDSF, the value is 0 (Not authorized) or 1 (Authorized according to policy stored in ANDSF server).
-
If GAA Service Identifier is OPENID_INTERWORKING, the value is 0 (Not authorized) or 1 (Authorized).
UICCTYPE specifies the type of the key that can be generated in the GUSS when users want to use UEs to manage services. Value: -
GBA(GBA): Only the Ks_NAF type of key can be generated.
-
GBA_U(GBA_U): Both the Ks_NAF and Ks_int_NAF types of key can be generated.
KEYCHOICE specifies the policy to be used by the HSS9860 to select a key to authenticate users in the GBA when users use UEs to manage services. Value: -
ME-based-key(ME-based-key): Only the Ks_NAF type of key can be used.
-
UICC-based-key(UICC-based-key): Only the Ks_int_NAF type of key can be used.
-
ME-UICC-based-keys(ME-UICC-based-keys): Either the Ks_NAF or Ks_int_NAF type of key can be used.
LIFETIME parameter specifies the validity duration of a cipher key in the GUSS information that the HSS9860 sends to the BSF over the Zh interface for a subscriber requesting to configure services on the AS. The BSF checks this parameter to determine whether a subscriber's cipher key is valid. Value: -
0-4294967295.
9.501 List GUSS of an IMPI Command Name: LST HGUSS Function: This command is used to query GBA user security settings (GUSS) of an IMPI. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
Example: LST HGUSS: IMPI="impiinfo"; Output:
All rights reserved.
Page 609 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Success output: Horizontal format Output: GSID
GAAAUTHFLAG
NAFGROUP
UICCTYPE
KEYCHOICE
TIMESTAMP
LIFETIME
Parameter description: GSID: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 Remark: 0 represents UNSPECIFIC_SERVICE, 1 represents PKI-PORTAL, 2 represents AUTHENTICATION_PROXY, 3 represents PRESENCE, 4 represents MBMS, 5 represents LIBERTY_ALLIANCE_PROJECT, 6 represents UICCTERMINAL_KEY_ESTABLISHMENT, 7 represents TERMINALREMOTE_DEVICE_KEY_ESTABLISHMENT, 8 represents ANDSF, 9 represents GBA_PUSH, 10 represents IMS_BASED_PSS_MBMS, 11 represents OPENID_GBA_INTERWORKING, 12 represents GENERIC_PUSH_LAYER, 13 represents OPENID_INTERWORKING GAAAUTHFLAG: GAA Authorization Flag NAFGROUP: NAF Grouping UICCTYPE: 0 | 1 Remark: 0 represents GBA, 1 represents GBA_U KEYCHOICE: 0 | 1 | 2 Remark: 0 represents ME-based-key, 1 represents UICC-based-key, 2 represents ME-UICCbased-keys TIMESTAMP: Time stamp LIFETIME: Key validity duration If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMPI must be in NAI format. The value of this parameter is case-sensitive.
9.502 Add RCS Service Command Name: ADD HRCSSERVICE Function: This command is used to add Rich Communication Suite (RCS) subscription data for an IMS subscriber. After RCS subscription data is added, subscribers' SIP Digest authentication passwords and shared initial filter criteria (SiFC) in the HSS are automatically shared by the RCS service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
M
All rights reserved.
Page 610 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
M
WHOLESALEID
Character string
1-128
Wholesale ID
M
SEGMENTID
Numeral
0-1
Segment ID
M
ACPTTERMSTATUS
Enum-
NOTPROCESSED
eration
TCACCEPTED
TCDENIED
Specifies the status of RCS terms and conditions acceptance.
M
TCPENDING
NOPERMISSION
Example: ADD HRCSSERVICE: IMSI="460009876543210", ISDN="8613955555555", WHOLESALEID="1234", SEGMENTID=0, ACPTTERMSTATUS=TCACCEPTED; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Before running ADD HRCSSERVICE to add RCS data for an IMS subscriber, run ADD HSIFCTPL to add shared iFC templates with IDs 4097, 4099, 4353, and 4609.
All the IMPUs of the subscriber must be configured to share a service profile by running SET HSPSHARE.
Before running ADD HRCSSERVICE to add RCS data for an IMS subscriber, run ADD HIMSI and ADD HISDN to associate the subscriber's IMSI and MSISDN with their IMPI.
The subscriber's IMPI must be registered with the SIP Digest authentication scheme using a user name and a password by running ADD HSDAINF.
9.503 Remove RCS Service Command Name: RMV HRCSSERVICE Function: This command is used to delete Rich Communication Suite (RCS) subscription data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
All rights reserved.
Page 611 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
Example: RMV HRCSSERVICE: IMSI="460009876543210"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either IMSI or MSISDN.
9.504 Modify RCS Service Status Command Name: MOD HRCSSTATUS Function: This command is used to change the status of RCS terms and conditions acceptance requests. After you run MOD HRCSSTATUS to change the status, the HSS updates the subscriber's SiFC data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
ACPTTERMST ATUS
Enum-
NOTPROCESSED
M
eration
TCACCEPTED
TCDENIED
TCPENDING
Specifies the status of RCS terms and conditions acceptance.
NOPERMISSION
Example: MOD HRCSSTATUS: IMSI="460009876543210", ACPTTERMSTATUS=NOTPROCESSED; Output: If the operation succeeds, the system displays the following message:
All rights reserved.
Page 612 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either IMSI or MSISDN.
9.505 List RCS Service Command Name: LST HRCSSERVICE Function: This command is used to query Rich Communication Suite (RCS) subscription data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST HRCSSERVICE: IMSI="460009876543210"; Output: Success output: Horizontal format Output: IMSI
ISDN
IMPROVISIONINGSTATUS
IMACTIVATIONSTATUS
FSPROVISIONINGSTATUS
FSACTIVATIONSTATUS
VSPROVISIONINGSTATUS
VSACTIVATIONSTATUS
RCSTCACCEPTTS
RCSTCREQSTATUS
WHOLESALEID
SEGMENTID
RCSWELCOMEMSGSENT
SIFCID1
SIFCID2
SIFCID3
DEVICE_CN
IMEI
FIRSTIMSREGTS
LASTIMSREGTS
FIRSTRCSCONFIGTS
LASTRCSCONFIGTS
PWASSIGNDATE
SERVICESATTR
DEVICESATTR_CN
DEVICESATTR
Parameter description: IMSI: IMSI Number
All rights reserved.
Page 613 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
ISDN: MSISDN Number IMPROVISIONINGSTATUS: Whether the subscriber is provided with the chat service IMACTIVATIONSTATUS: Whether the chat service is active for the subscriber FSPROVISIONINGSTATUS: Whether the subscriber is provided with the file share service FSACTIVATIONSTATUS: Whether the file share service is active for the subscriber VSPROVISIONINGSTATUS: Whether the subscriber is provided with the video share service VSACTIVATIONSTATUS: Whether the video share service is active for the subscriber RCSTCACCEPTTS: The time when the subscriber accepted the terms and conditions of RCS in the network RCSTCREQSTATUS: The status of RCS terms and conditions acceptance requests WHOLESALEID: The wholesale used to differentiate RCS service characteristics and service branding SEGMENTID: The charging method assigned to the subscriber RCSWELCOMEMSGSENT: Whether a plain RCS welcome message has been sent to the subscriber SIFCID1: The SiFC of the subscriber SIFCID2: The SiFC of the subscriber SIFCID3: The SiFC of the subscriber DEVICE_CN: The device's connection node IMEI: The IMEI of the latest used device FIRSTIMSREGTS: The timestamps of the first device management activity for the private user ID (SIM) LASTIMSREGTS: The timestamps of the latest device management activity for the private user ID (SIM) FIRSTRCSCONFIGTS: The timestamps of the first IMS/RCS registration activity of the private user ID (SIM) LASTRCSCONFIGTS: The timestamps of the latest IMS/RCS registration activity of the private user ID (SIM) PWASSIGNDATE: The time when the user password was assigned SERVICESATTR: The additional and available multi-valued attributes of services DEVICESATTR_CN: the additional and available multi-valued attributes of the device's connection node DEVICESATTR: The additional and available multi-valued attributes of the device If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 614 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Specify either IMSI or MSISDN.
9.506 Set an SMSC Address Command Name: SET HSMSCADDR Function: This command is used to configure an SMSC addresses for a subscriber. At present, SMSC addresses are configured on application servers (AS) for subscribers by number segment. This brings maintenance difficulties for carriers. Now the HSS is developed to configure SMSC addresses for specified subscribers on GSM/UMTS/EPS/IMS networks. After the HSS receives User Data Request (UDR) messages from the AS to obtain subscriber data, the HSS includes the SMSC address in User Data Answer (UDA) messages sent to the AS. This helps carriers to facilitate SMSC address management, save maintenance cost, and improve the competitive edge. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
M
SMSCADDR
Character string
1-20
SMSCADDR
M
Example: SET HSMSCADDR: ISDN="4600000091234", SMSCADDR="1234567890"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.507 Remove an SMSC Address Command Name: RMV HSMSCADDR Function: This command is used to delete the SMSC address provided to a specific subscriber. Parameter Description:
All rights reserved.
Page 615 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
M
Example: RMV HSMSCADDR: ISDN="4600000091234"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
After the SMSC address of a subscriber is deleted, the HSS will not include the SMSC address in UDA messages sent to the AS.
9.508 List an SMSC Address Command Name: LST HSMSCADDR Function: This command is used to query the SMSC address provided to a specific subscriber. Parameter Description: Name
Type
Range
Description
Remarks
ISDN
Character string
1-15
MSISDN number
M
Example: LST HSMSCADDR: ISDN="4600000091234"; Output: Success output: Horizontal format Output: ISDN
SMSCADDR
Parameter description: ISDN: MSISDN Number SMSCADDR: Short Message Center Address
All rights reserved.
Page 616 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.509 Add the AKA Information by Template Command Name: ADD HTPLKI Function: This command is used to add an AKA authentication data record for the specified IMPI to the HSS service database by using the AKA template. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
K
Character string
32
KI value
M
AKATPLID
Numeral
0-254
AKA template ID
M
Example: ADD HTPLKI: IMPI="impiinfo", K="1234567890abcdef1234567890ABCDEF ", AKATPLID=1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
If you enter the command in the command input pane and then specify the related parameters, the KI value is displayed as a string of asterisks (*).
If you enter the command with the related parameters in the MML command line input pane, the KI value is displayed in plain text.
9.510 Add an IMS Subscription by Template Command Name: ADD HTPLSUB Function: This command is used to add an IP Multimedia Subscription (IMS) subscription to the Home Subscriber Server (HSS) database by using the capability template, charging address template, service profile template, and IMPU template related to the IMS subscription. Parameter Description:
All rights reserved.
Page 617 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
IMPI
Character string
1-127
IMPI number
C
IMPU
Character string
1-127
IMPU number
C
IMPUTYPE
Enum-
DIMPU
Specifies the type of the IMPU.
C
eration
WIMPU
Value:
DIMPU(DIMPU): The IMPU is a distinct IMPU.
WIMPU(WIMPU): The IMPU is a wildcarded IMPU.
CAPTPLID
Numeral
0-254
Capability set template ID
C
CHARGTPLID
Numeral
0-254
Charging address template ID
C
SPTPLID
Numeral
0-254
Service profile template ID
C
IMPUTPLID
Numeral
0-254
IMPU template ID
C
PBXUSERFLAG
Boolean
TRUE FALSE
Species whether the IMS subscriber is a private branch exchange (PBX) user.
C
Value:
SYSNO
Numeral
0-255
TRUE(TRUE): The IMS subscriber is a PBX user.
FALSE(FALSE): The IMS subscriber is not a PBX user.
System serial number
O
Example: 1. ADD HTPLSUB: SUBID="subinfo", IMPI="impiinfo", IMPU="sip:[email protected]", CAPTPLID=1, CHARGTPLID=1, SPTPLID=1, IMPUTPLID=1, PBXUSERFLAG=TRUE; 2. ADD HTPLSUB: SUBID="subinfo", IMPI="impiinfo", IMPU="tel:+33145297![247].*!", IMPUTYPE=WIMPU, CAPTPLID=1, CHARGTPLID=1, SPTPLID=1, IMPUTPLID=1, PBXUSERFLAG=TRUE, SYSNO=10; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 618 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
When Service profile template ID or IMPU template ID is specified, IMPU must be specified.
When Charging template ID, Capability template ID, or IMPU is specified, IMPI must be specified.
9.511 Add an IMPI by Template Command Name: ADD HTPLIMPI Function: This command is used to add an IP Multimedia Private Identity (IMPI) data record to the Home Subscriber Server (HSS) database by using the charging address template, service profile template, and IP Multimedia Public Identity (IMPU) template related to the IMPI. Parameter Description: Name
Type
Range
Description
Remarks
SUBID
Character string
1-127
Subscription ID
M
IMPI
Character string
1-127
IMPI number
M
IMPU
Character string
1-127
IMPU number
C
IMPUTYPE
Enum-
DIMPU
IMPU type
O
eration
WIMPU
CHARGTPLID
Numeral
0-254
Charging address template ID
O
SPTPLID
Numeral
0-254
Service profile template ID
O
IMPUTPLID
Numeral
0-254
IMPU template ID
O
Example: 1. ADD HTPLIMPI: SUBID="subinfo", IMPI="impiinfo", IMPU="sip:[email protected]", CHARGTPLID=1, SPTPLID=1, IMPUTPLID=1; 2. ADD HTPLIMPI: SUBID="subinfo", IMPI="impiinfo", IMPU="tel:+33145297![247].*!", IMPUTYPE=WIMPU, CHARGTPLID=1, SPTPLID=1, IMPUTPLID=1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
When Service profile template ID or IMPU template ID is specified, IMPU must be specified.
All rights reserved.
Page 619 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.512 Add an IMPU by Template Command Name: ADD HTPLIMPU Function: This command is used to add an IP Multimedia Public Identity (IMPU) data record to the Home Subscriber Server (HSS) database by using the service profile template and IMPU template. Parameter Description: Name
Type
Range
Description
Remarks
IMPI
Character string
1-127
IMPI number
M
IMPU
Character string
1-127
IMPU number
M
IMPUTYPE
Enum-
DIMPU
Specifies the type of the IMPU.
C
eration
WIMPU
Value:
DIMPU(DIMPU): The IMPU is a distinct IMPU.
WIMPU(WIMPU): The IMPU is a wildcarded IMPU.
SPTPLID
Numeral
0-254
Service profile template ID
O
IMPUTPLID
Numeral
0-254
IMPU template ID
O
Example: 1. ADD HTPLIMPU: IMPI="impiinfo", IMPU="sip:[email protected]", SPTPLID=1, IMPUTPLID=1; 2. ADD HTPLIMPU: IMPI="impiinfo", IMPU="tel:+33145297![247].*!", IMPUTYPE=WIMPU, SPTPLID=1, IMPUTPLID=1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.513 Add a PSI User by Template Command Name: ADD HTPLPSI Function: This command is used to add a PSI user to the HSS service database by using the capability template, charging address template, service profile template, and PUSI template related to the PSI.
All rights reserved.
Page 620 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
PISI
Character string
1-127
PISI number
M
PUSI
Character string
1-127
PUSI number
M
PUSITYPE
Enum-
DPUSI
M
eration
WPUSI
Specifies the type of the PUSI to be added. Value:
DPUSI(DPUSI): A distinct PUSI is added.
WPUSI(WPUSI): A wildcard PUSI is added.
CAPTPLID
Numeral
0-254
Capability set template ID
O
CHARGTPLID
Numeral
0-254
Charging address template ID
O
SPTPLID
Numeral
0-254
Service profile template ID
O
PUSITPLID
Numeral
0-254
PUSI template ID
O
SYSNO
Numeral
0-255
System serial number
O
Example: ADD HTPLPSI: PISI="pisiinfo", PUSI="sip:[email protected]", PUSITYPE=DPUSI, CAPTPLID=1, CHARGTPLID=1, SYSNO=1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.514 Add a PUSI by Template Command Name: ADD HTPLPUSI Function: This command is used to add a PUSI to the HSS service database by using the service profile template and PUSI template related to the PUSI. Parameter Description: Name
Type
Range
Description
Remarks
PISI
Character string
1-127
PISI number
M
All rights reserved.
Page 621 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
PUSI
Character string
1-127
PUSI number
M
PUSITYPE
Enum-
DPUSI
Specifies the type of the PUSI to be added.
M
eration
WPUSI
Value:
DPUSI(DPUSI): A distinct PUSI is added.
WPUSI(WPUSI): A wildcard PUSI is added.
SPTPLID
Numeral
0-254
Service profile template ID
O
PUSITPLID
Numeral
0-254
PUSI template ID
O
Example: ADD HTPLPUSI: PISI="pisiinfo", PUSI="sip:[email protected]", PUSITYPE=DPUSI, SPTPLID=1, PUSITPLID=1; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
None.
9.515 Add an iFC by Template Command Name: ADD HTPLIFC Function: This command is used to add an iFC service for the specified IMPU or PUSI to the HSS service database by using the iFC template. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
PUSI
Character string
1-127
PUSI number
C
IFCTPLID
Numeral
0-1024
iFC template ID
M
Example: ADD HTPLIFC: IMPU="sip:[email protected]", IFCTPLID=1;
All rights reserved.
Page 622 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Only one of the parameters IMPU and PUSI must be specified.
9.516 Add an IMS Subscriber Using a Template Command Name: ADD TPLIMSSUB Function: This command is used to provide IMS services for GSM/UMTS subscribers, EPS subscribers, or GSM/UMTS/EPS subscribers using a template on the convergent HLR/HSS on GSM/UMTS/EPS/IMS networks. Parameter Description: Name
Type
Range
Description
Remarks
HLRSN
Numeral
0-255
HLR serial number
O
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
IMPI
Character string
1-127
IMPI number
M
IMPULIST
Character string
1-1300
IMPU list
M
BARIMPULIST
Character string
1-1300
Barring IMPU list
O
VOLTETAG
Boolean
TRUE
O
FALSE
Specifies whether the subscriber to be provided with IMS services is a VoLTE subscriber. Value:
IMSTPLID
Numeral
1-1024
TRUE(TRUE): The subscriber is a VoLTE subscriber.
FALSE(FALSE): The subscriber is not a VoLTE subscriber.
IMS subscription template ID
O
Example: ADD TPLIMSSUB: HLRSN=1, IMSI="460001234567890", IMPI="impiinfo", IMPULIST="\"sip:[email protected]\"&\"sip:[email protected]\"", VOLTETAG=TRUE, IMSTPLID=1; Output:
All rights reserved.
Page 623 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either IMSI or MSISDN.
When setting parameter IMPI, note the following:
-
The IMPI is case-sensitive and must be in NAI format.
-
The IMPI does not have any authentication data configured.
When setting parameter IMPULIST, note the following: -
An IMPU list contains a maximum of 10 IMPUs, each of which is enclosed in quotation marks (") and is separated by an ampersand (&). In addition, an escape character (\) is added before each quotation mark ("). For example, \"sip:[email protected]\"&\"sip:[email protected]"\.
-
The IMPUs are case-sensitive and must be in SIP URI or TEL URI format.
-
Consisting of only letters, digits, periods (.), ampersands (&), and colons (:).
-
The IMPUs must be distinct IMPUs.
-
The subscriber's IMPUs are configured to belong to the same implicitly registered set (IRS) and the same alias group, both of which has the default ID 1.
When setting parameter BARIMPULIST, note the following: -
An IMPU list contains a maximum of 10 IMPUs, each of which is enclosed in quotation marks (") and is separated by an ampersand (&). In addition, an escape character (\) is added before each quotation mark ("). For example, \"sip:[email protected]\"&\"sip:[email protected]"\.
-
The IMPUs are case-sensitive and must be in SIP URI or TEL URI format.
-
Consisting of only letters, digits, periods (.), ampersands (&), and colons (:).
-
The IMPUs must be distinct IMPUs and must be included in the IMPU list. The default IMPU of an IRS cannot be included in the Barring IMPU list.
When setting parameter IMSTPLID, note the following: -
If IMS subscription template ID is not specified, the HSS associates the default values in the IMS service templates with the subscriber. You can run LST IMSTPL to query information about an IMS service template.
-
If IMS subscription template ID is specified, the HSS associates the IMS services in the template with the subscriber and all the IMPUs of the subscriber share the same services.
9.517 Set Emergency Service Routing Numbers in Batches Command Name: SET HESRNBAT Function: This command is used to set emergency service routing numbers for multiple IMPU. Parameter Description: Name
Type
Range
Description
Remarks
ESRN
Character string
1-127
Emergency service routing number
C
BATTYPE
Enum
Specifies the type of
C
DISCONTINUOUS
All rights reserved.
Page 624 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Summary of CommandsSummary of Commands
Type
Range
Description
eration
IMPU
Character string
1-133
IMPU number
C
IMPUFILE
Character string
1-127
IMPU file
C
CONTINUOUS
Remarks
the batch operation.
Example: 1. SET HESRNBAT: ESRN="shenzhenbantian", BATTYPE=CONTINUOUS, IMPU="sip:hello![0-9]{2}[email protected]"; 2. SET HESRNBAT: ESRN="shenzhenbantian", BATTYPE=DISCONTINUOUS, IMPUFILE="impu.txt"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Either IMPU or IMPUFILE must be specified.
The parameter IMPUFILE is visible and IMPU is not visible when the parameter BATTYPE is set to DISCONTINUOUS.
The parameter IMPUFILE is not visible and IMPU is visible when the parameter BATTYPE is set to CONTINUOUS.
Running this command will delete the SIP digest authentication data of multiple IMPIs at a time. Use this command unless necessary.
This parameter specifies the IMPU to be configured with an emergency service routing number. The IMPU must be in SIP URI or TEL URI format. The value of the IMPU is case-sensitive. The IMPU supports the regular expression. The regular expression can be used to specify multiple consecutive IMPUs. A regular expression begins and ends with an exclamatory mark (!) and consists of two fields. The field enclosed in square brackets [] This parameter indicates the value range. The field enclosed in curly brackets {} This parameter indicates the length of the digits to be generated. The remaining digits constitute a 1-4 digit number. When a regular expression is used in a batch operation, the value of IMPU cannot contain any other exclamatory mark (!) besides those contained in the regular expression.
9.518 Modify Shared iFC Sets in Batches Command Name: MOD HSIFCBAT Function: This command is used to modify shared iFC sets provided for multiple IMPUs. Parameter Description: Name
Type
Range
BATTYPE
Enum-
DISCONTINUOUS
eration
CONTINUOUS
All rights reserved.
Description
Remarks
Specifies the type of the batch operation.
C
Page 625 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMPU
Character string
1-133
IMPU number
C
OSIFCID
Numeral
0-65535
Shared iFC template ID
M
NSIFCID
Numeral
0-65535
New shared iFC template ID
M
IMPUFILE
Character string
1-127
IMPU file
C
Example: 1. MOD HSIFCBAT: OSIFCID=1, NSIFCID=2, BATTYPE=CONTINUOUS, IMPU="sip:hello![0-9]{2}[email protected]"; 2. MOD HSIFCBAT: OSIFCID=1, NSIFCID=2, BATTYPE=DISCONTINUOUS, IMPUFILE="impu.txt"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Either IMPU or IMPUFILE must be specified.
The parameter IMPUFILE is visible and IMPU is not visible when the parameter BATTYPE is set to DISCONTINUOUS.
The parameter IMPUFILE is not visible and IMPU is visible when the parameter BATTYPE is set to CONTINUOUS.
Running this command will delete the SIP digest authentication data of multiple IMPIs at a time. Use this command unless necessary.
This parameter specifies the IMPU whose shared iFC set is to be modified. The IMPU must be in SIP URI or TEL URI format. The value of the IMPU is case-sensitive. The IMPU supports the regular expression. The regular expression can be used to specify multiple consecutive IMPUs. A regular expression begins and ends with an exclamatory mark (!) and consists of two fields. The field enclosed in square brackets ([]). This parameter indicates the value range. The field enclosed in curly brackets ({}) This parameter indicates the length of the digits to be generated. The remaining digits constitute a 1-4 digit number. When a regular expression is used in a batch operation, the value of IMPU cannot contain any other exclamatory mark (!) besides those contained in the regular expression.
9.519 Remove IMS Subscription in Batches Command Name: RMV HSUBBAT Function: This command is used to remove IMS subscriptions in batches. Parameter Description: Name
Type
Range
BATTYPE
Enum-
DISCONTINUOUS
Description
Remarks
Specifies the type of the
C
All rights reserved.
Page 626 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Summary of CommandsSummary of Commands
Type
Range
Description
eration
SUBID
Character string
1-133
Subscription ID
C
SUBIDFILE
Character string
1-127
Subscription ID file
C
CONTINUOUS
Remarks
batch operation.
Example: 1. RMV HSUBBAT: BATTYPE=CONTINUOUS, SUBID="test![0-9]{2}!"; 2. RMV HSUBBAT: BATTYPE=DISCONTINUOUS, SUBIDFILE="SUBID_LIST.txt"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The parameter SUBIDFILE is visible and SUBID is not visible when the parameter BATTYPE is set to DISCONTINUOUS.
The parameter SUBIDFILE is not visible and SUBID is visible when the parameter BATTYPE is set to CONTINUOUS.
Running this command will delete the SIP digest authentication data of multiple IMPIs at a time. Use this command unless necessary.
This parameter specifies the SUBID whose subscription will be removed. The value of the SUBID is case-sensitive. The SUBID supports the regular expression. The regular expression can be used to specify multiple consecutive SUBIDs. A regular expression begins and ends with an exclamatory mark (!) and consists of two fields. The field enclosed in square brackets ([]). This parameter indicates the value range. The field enclosed in curly brackets ({}). This parameter indicates the length of the digits to be generated. The remaining digits constitute a 1-4 digit number. When a regular expression is used in a batch operation, the value of SUBID cannot contain any other exclamatory mark (!) besides those contained in the regular expression.
9.520 Remove the SIP Digest Authentication Information of IMPI in Batches Command Name: RMV HSDABAT Function: This command is used to delete the SIP digest authentication information provided for multiple IMPIs. Parameter Description: Name
Type
Range
BATTYPE
Enum
DISCONTINUOUS
eration
CONTINUOUS
Character string
1-133
IMPI
All rights reserved.
Description
Remarks
Specifies the type of the batch operation.
C
IMPI number
C
Page 627 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMPIFILE
Character string
1-127
IMPI file
C
Example: 1. RMV HSDABAT: BATTYPE=CONTINUOUS, IMPI="test![0-9]{2}!"; 2. RMV HSDABAT: BATTYPE=DISCONTINUOUS, IMPIFILE="IMPI_LIST.txt"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either IMPI or IMPI file.
The parameter IMPI file is present and IMPI is not present when BATTYPE is set to DISCONTINUOUS.
The parameter IMPI file is not present and IMPI is present when the parameter BATTYPE is set to CONTINUOUS.
Running this command will delete the SIP digest authentication data of multiple IMPIs at a time. Use this command unless necessary.
This parameter specifies the IMPI whose SIP digest authentication information is to be removed. The value of the IMPI is case-sensitive. The IMPI supports the regular expression. The regular expression can be used to specify multiple consecutive IMPIs. A regular expression begins and ends with ! and consists of two fields. The field enclosed in square brackets [] This parameter indicates the value range. The field enclosed in curly brackets {} This parameter indicates the length of the digits to be generated. The remaining digits constitute a 1-4 digit number. When a regular expression is used in a batch operation, the value of IMPI cannot contain any other ! besides those contained in the regular expression.
9.521 Modifying the M2MCISDN Service Command Name: MOD M2MCISDN Function: This command is used to provide, change, or remove a common MSISDN for an M2M subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE FALSE
Specifies the operation to be performed on a common MSISDN.
M
All rights reserved.
Page 628 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
Remarks
Value:
M2MCISDN
Character string
1-15
TRUE: The HSS9860 adds or changes the common MSISDN.
FALSE: The HSS9860 removes the common MSISDN.
Specifies the new common MSISDN.
C
Example: MOD M2MCISDN: IMSI="460000009123456", PROV=TRUE, M2MCISDN="460000001111111"; Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them. They cannot be present together .
9.522 Listing the M2MCISDN Service Command Name: LST M2MCISDN Function: This command is used to query the common MSISDN of an M2M subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST M2MCISDN: IMSI="460000009012345"; Output If the operation succeeds, the format of the returned message is as follows: {IMSI}=
All rights reserved.
Page 629 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{ISDN}= { M2MCISDN}=, If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.523 Modify the ODB-POS Service for EPS Subscribers Command Name: MOD EPSODB Function: This command is used to modify ODB-POS service data for EPS subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
EPSODBPOS
Enumerated
NOBPOS BAPOS
BHPLMNAPROAM
Specifies whether the HSS9860 bars packet oriented services (POS) from EPS subscribers.
O
BALLAPROAM
Value:
NOBPOS: The HSS9860 does not bar POS services from EPS subscribers.
BAPOS: The HSS9860 bars all POS services from subscribers.
BHPLMNAPROAM: The HSS9860 bars POS services when subscribers are roaming in a VPLMN but still connect to the network from an access point within the HPLMN.
BALLAPROAM: The HSS9860 bars POS services when subscribers are roaming in a VPLMN and connect to the network from an access point within the VPLMN.
Example: MOD EPSODB: IMSI="461111111111111", EPSODBPOS=BAPOS;
All rights reserved.
Page 630 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them. They cannot be present together .
9.524 List the ODB-POS Service for EPS Subscribers Command Name: LST EPSODB Function: This command is used to query ODB-POS service data of EPS subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST EPSODB="460000009012345"; Output If the operation succeeds, the format of the returned message is as follows: {IMSI}= {ISDN}= { EPSODBPOS}=, If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.525 Provide or Withdraw MAP Address Restriction Template for Subscribers Command Name: MOD MAPADDRRES
All rights reserved.
Page 631 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to provide or withdraw an MAP address restriction template for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides or withdraws the MAP address restriction template for the subscriber. Value:
TPLID
Character string
1-15
TRUE(TRUE): The HSS9860 provides the MAP address restriction template for the subscriber.
FALSE(FALSE): The HSS9860 withdraws the MAP address restriction template for the subscriber.
MAP address restriction template ID
C
Example: MOD MAPADDRRES: IMSI="460000009123456", PROV=TRUE, TPLID=4; Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them. They cannot be present together.
9.526 List MAP Address Restriction Template of Subscribers Command Name: LST MAPADDRRES Function: This command is used to query information about the MAP address restriction template provided for a subscriber. Parameter Description:
All rights reserved.
Page 632 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST MAPADDRRES: IMSI="460000009123456"; Output If the operation succeeds, the system displays an output with the following format: { IMSI }=< IMSI Number>, { ISDN }=< ISDN Number>, { TPLID }=< MAP address restriction template ID > If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them. They cannot be present together .
9.527 Modify the STE Service Command Name: MOD STE Function: This command is used to modify the STE service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
STE_PROV
Boolean
TRUE
C
FALSE
Specifies whether the HSS9860 provides, modifies, or delete the STE service data for a subscriber. Value:
GMLC_ADD
Character string
1-15
TRUE(TRUE): The HSS9860 provides or modifies the STE service data for the subscriber.
FALSE(FALSE): The HSS9860 deletes the STE service data for the subscriber.
GMLC address
All rights reserved.
C
Page 633 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: MOD STE: IMSI="460000009123456", STE_PROV =TRUE, GMLC_ADD="12345"; Output: If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
9.528 List the STE Service Command Name: LST STE Function: This command is used to query the STE service data of subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST STE: IMSI="460000009123456"; Output: If the operation succeeds, the system displays an output with the following format: IMSI = MSISDN = STE_PROV = GMLC_ADD = < GMLC Address> If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The parameters IMSI and ISDN are mutually exclusive. Specify only one of them.
All rights reserved.
Page 634 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
9.529 Modify the Preferred Roaming Service for Subscribers Command Name: MOD TPLROAMPER Function: This command is used to provide or withdraw the user-level Preferred Roaming service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides or withdraws the Preferred Roaming service for subscribers. Value:
TPLTYPE TPLID
ENUM Int
CS
PS
1-999
TRUE(TRUE): The HSS9860 provides the Preferred Roaming service for the subscriber.
FALSE(FALSE): The HSS9860 withdraws the Preferred Roaming service from the subscriber.
Template type
M
Template ID
C
Example: MOD TPLROAMPER: IMSI="460000009123456", PROV=TRUE, TPLTYPE=CS, TPLID=4; Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them. They cannot be present together.
9.530 List the Preferred Roaming Service of Subscribers Command Name: LST TPLROAMPER
All rights reserved.
Page 635 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This command is used to query information about the Preferred Roaming Service for a subscriber. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI
C
ISDN
Character string
1-15
MSISDN
C
Example: LST TPLROAMPER: IMSI="460000009123456"; Output If the operation succeeds, the system displays an output with the following format: { IMSI }=< IMSI Number>, { ISDN }=< ISDN Number>, { TPLTYPE}=< CS/PS > { TPLID }=< 1-999 > If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." IMSI and ISDN are optional. Specify only one of the them. They cannot be present together .
9.531 Modify the SPN Service Command Name: MOD SPN Function: This command is used to provide, modify, or withdraw the Single Personal Number (SPN) service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
TRUE
M
FALSE
Specifies whether the HSS9860 provides, modifies, or deletes the SPN service data for a subscriber. Value:
TRUE(TRUE): The HSS9860 provides or modifies the SPN service data for the subscriber.
All rights reserved.
Page 636 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Type
Summary of CommandsSummary of Commands
Range
Description
FTN
Character string
1-16
PROPERTY
Enumerated
INTERNATION AL
NATIONAL
OFAID
Integer
0-65535
Remarks
FALSE(FALSE): The HSS9860 deletes the SPN service data for the subscriber.
Forwarded-to number
C
Specifies whether the FTN is an international number or a national number.
C
OFA template ID
C
Example: MOD SPN: IMSI="460000009123456", PROV=TRUE, FTN="8613900000", PROPERTY=INTERNATIONAL; Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." The IMSI and MSISDN parameters are optional. Specify only one of them.
9.532 List the SPN Service Command Name: LST SPN Function: This command is used to query Single Personal Number (SPN) service data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST SPN: IMSI="460000009123456"; Output If the operation succeeds, the system displays an output with the following format:
All rights reserved.
Page 637 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
{IMSI} = {ISDN} = {OFAID} = {FTN} = {STATUS} = If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." The IMSI and MSISDN parameters are optional. Specify only one of them.
9.533 Add an AS Host Name Command Name: ADD HASHOST Function: This command is used to map an AS ID to a peer AS entity. During site deployment, run ADD HASHOST after you run ADD DMPE to add a peer AS entity. An AS ID may be assigned to different peer AS entities on the active and redundancy HSS9860s. To prevent service exception caused by this inconsistency, run ADD HASHOST to uniquely map an AS ID to a peer AS entity. Parameter Description: Name
Type
Range
Description
Remarks
ASID
Integer
0-65534
ASID
M
HOSTNAME
Character string
1-127
Host name
M
REALMNAME
Character string
1-127
Realm name
M
Example: ADD HASHOST:ASID=1, HOSTNAME="as1.huawei.com", REALMNAME="huawei.com"; Output If the operation succeeds, the system displays an output with the following format: {ASID}={ASID} {HOSTNAME}={Host name} {REALMNAME}={Realm name} If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 638 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The settings in this command take effect only when AS ID management mode is set to STORE_IN_USCDB running SET HSYSTEMPARA.
A maximum of 1000 mapping records can be added.
9.534 Remove an AS Host Name Command Name: RMV HASHOST Function: This is a high-severity command. Misuse of this command will cause call loss or interruption. Consult Huawei technical support engineers before using this command. This command is used to delete the mapping between an AS ID and a peer AS entity. Parameter Description: Name
Type
Range
Description
Remarks
ASID
Integer
0-65534
ASID
C
HOSTNAME
Character string
1-127
Host name
C
Example: RMV HASHOST:ASID=1; Output If the operation succeeds, the system displays an output with the following format: {ASID}={ASID} {HOSTNAME}={Host name} If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either ASID or Host name. If both of them are specified, the system displays the error "Parameter conflict".
AS IDs are used by the HSS9860 to process PNR/PNA and SNR/SNA messages. Service exception may occur after you incorrectly delete the mapping between an AS ID and an peer AS entity.
9.535 List an AS Host Name Command Name: LST HASHOST Function:This command is used to query the mapping between an AS ID and a peer AS entity.
To query the mappings between all AS IDs and peer AS entities, do not specify any parameter.
To query a specific mapping, enter ASID or Host name.
All rights reserved.
Page 639 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
ASID
Integer
0-65534
ASID
C
HOSTNAME
Character string
1-127
Host name
C
Example: LST HASHOST:ASID=1; Output If the operation succeeds, the system displays an output with the following format: {SYSNO}={SYSNO} {ASID}={ASID} {HOSTNAME}={Host name} {REALMNAME}={Realm name} If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." Specify either ASID or Host name. If both of them are specified, the system displays the error "Parameter conflict"
9.536 Modify the NT-U-CSI Service Command Name: MOD NTUCSI Function: This command is used to provide, modify, or withdraw the NT-U-CSI Service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
ADD
Operation type
M
DELETE
DELETEALL U-CSI template ID
C
UCSIID
Integer
0-65535
Example: MOD NTUCSI: IMSI="460000009012345", PROV=ADD, UCSIID =1;
All rights reserved.
Page 640 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Output If the operation succeeds, the system displays one of the following messages:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
The IMSI and MSISDN parameters are optional. Specify only one of them.
The HSS9860 uses the MOD NTUCSI configuration only when UCSI subscription management mode in SET MAPSERV is set to NON-Template.
A maximum of 20 U-CSI templates can be associated with the same subscriber identities. When you attempt to add a U-CSI template for subscriber identities that have been associated with 20 U-CSI templates,"ERR3047 Maximum limitation exceeded" is displayed. You can run MOD NTUCSI to delete unnecessary U-CSI templates before you add one.
9.537 List the NT-U-CSI Service Command Name: LST NTUCSI Function: This command is used to query the CSI Services data. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST SPN: IMSI="460000009012345"; Output: If the operation succeeds, the system displays an output with the following format: {IMSI} = {MSISDN} = {TPLID} = “SCODE” “GSMSCFADD” “PUSSDOPTION” “FUNCTION” “MATCH_RULE” {Service code} + {gsmSCF address} + {"NONE"|"ONLY_MSISDN"|"ONLY_VLRNUM"|"BOTH_MSISDN_VLRNUM"|"NO_DE STREF"|"BSAMSISDN"|"DESTREF_MSISDN"} + {"GSMMODE"|"WAPMODE"|"GSMSCF"|"MAP"|"GSMSPECIALMODE"} + { "MAX_MATCH"|"ALL_MATCH"}
All rights reserved.
Page 641 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." The IMSI and MSISDN parameters are optional. Specify only one of them.
9.538 Modify the VMCC Service Command Name: MOD VMCC Function: MOD VMCC is used to provide or withdraw the VMCC service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
VMCC
Boolean
Provide VMCC
M
TRUE
FALSE
Example: MOD VMCC: IMSI="460000009012345", VMCC=TRUE; Response If the operation succeeds, one of the following success codes is displayed:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes." The IMSI and MSISDN parameters are optional. Specify only one of them.
9.539 List the VMCC Service Command Name: LST VMCC Function: LST VMCC is used to query the VMCC service data for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
All rights reserved.
Page 642 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
ISDN
Character string
Summary of CommandsSummary of Commands
1-15
MSISDN number
C
Example: LST VMCC: IMSI="460000009012345"; Response If the operation succeeds, the format of the returned message is as follows: {IMSI} = {MSISDN} = {VMCC} = If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes." The IMSI and MSISDN parameters are optional. Specify only one of them.
9.540 Modify the DND Service Command Name: MOD DND Function: MOD DND is used to provide or withdraw the Do Not Disturb (DND) service for subscribers. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
PROV
Boolean
Provide DND
M
TRUE
FALSE
Example: MOD DND: IMSI="460000009012345", PROV=TRUE; Response If the operation succeeds, one of the following success codes is displayed:
SUCCESS0001:Operation is successful
SUCCESS0002:Already existed, not changed
If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 643 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
The IMSI and MSISDN parameters are optional. Specify only one of them.
9.541 List the DND Service Command Name: LST DND Function: LST DND is used to query whether subscribers are provided with the Do Not Disturb (DND) service. Parameter Description: Name
Type
Range
Description
Remarks
IMSI
Character string
6-15
IMSI number
C
ISDN
Character string
1-15
MSISDN number
C
Example: LST DND: IMSI="460000009012345"; Response If the operation succeeds, the format of the returned message is as follows: {IMSI} = {MSISDN} = {PROV} = If the operation fails, the error codes will be returned. For details of the above error codes, see 11"Summary of Error Codes." The IMSI and MSISDN parameters are optional. Specify only one of them.
9.542 Set SIP FTN Suffix Command Name: SET HCFFTNPOSTFIX Function: This command is used to set the suffix to be added to the SIP URI format forwarded-to numbers (FTNs) transmitted between the HSS9860 and a third-party AS. Parameter Description: Name
Type
Range
Description
Remarks
SIPFORMA TPOSTFIX
Character string
1–127
SIP FTN suffix
M
Example:
All rights reserved.
Page 644 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
SET HCFFTNPOSTFIX: SIPFORMATPOSTFIX="ims.mnc123.mcc732.3gppnetwork.org"; Output: If the operation succeeds, the system displays an output with the following format: SUCCESS0001:Operation
is successful
If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes." Run this command when VoLTE Sh interface SS data format and FTN format are configured as follows:
VoLTE Sh interface SS data format is set to 1 by running MOD INSP.
FTN format is set to SIP_FORMAT by running SET HSYSTEMPARA.
9.543 List SIP FTN Suffix Command Name: LST HCFFTNPOSTFIX Function: This command is used to query the suffix to be added to the SIP URI format forwarded-to numbers (FTNs) transmitted between the HSS9860 and a third-party AS. Parameter Description: None Example: LST HCFFTNPOSTFIX:; Output: If the operation succeeds, the system displays an output with the following format: SIPFORMATPOSTFIX If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
9.544 List PUR Updated Repository Data Command Name: LST HPURREPDATA Function: This is a high-severity command. Misuse of the command increases traffic load on the physical database and causes system overload. Evaluate the data query range and number of query times before using this command. If you have any questions, contact Huawei technical support to determine how to perform and verify the operations and formulate recovery measures in the event of an emergency. LST HPURREPDATA is used to query IMS subscribers or PSI users repository data updated through Profile Update Request (PUR) messages in operation logs. The query result will be stored in a text file on the PGW. You can download the query result by using the file manager function of the PGW Web LMT.
All rights reserved.
Page 645 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU number
C
STARTTI ME
Character string
19-19
Start time
C
ENDTIM E
Character string
19-19
End time
C
RESULT
Enumerated
ERROR
Operation result
C
SUCCESS Name of file for saving results
M
SAVEAS
Character string
1-20
Example: 5.
LST HPURREPDATA: IMPU="sip:[email protected]", SAVEAS="lsthpurrepdata01.txt";
6.
LST HPURREPDATA: STARTTIME=2016&06&06&09&00&00, ENDTIME=2016&06&07&09&00&00, SAVEAS="lsthpurrepdata02.txt";
Output: If LST HPURREPDATA is successful, the HSS9860 displays a message indicating that the operation succeeded. Parameter description: TIME: This parameter indicates the time when the command was executed. IMPU: This parameter indicates the IMPU or PUSI of the subscriber whose repository data is queried. RESULT: This parameter indicates whether the PUR message successfully or fails to update repository data. MMLCOMMAND: This parameter indicates the operation to update repository data upon a PUR message. If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either Start time or IMPU or both of them.
When End time is specified, Start time is mandatory. Start time must be earlier than End time.
9.545 Set PUR Updated Repository Data Command Name: SET HPURREPDATA
All rights reserved.
Page 646 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Function: This is a high-severity command. Misuse of the command causes incorrect subscriber data modifications. Before using this command, confirm that the data to be used to restore repository data in the HSS9860 is correct. If you have any questions, contact Huawei technical support to determine how to perform and verify the operations and formulate recovery measures in the event of an emergency. SET HPURREPDATA is used to update the repository data of a specified IMS subscriber or PSI user in the HSS9860 based on the repository data queried by running LST HPURREPDATA. This command is used when repository data in the HSS9860 is incorrect. If this command is executed with time-specific parameters (Start time, End time, and Speed) specified, the system counts the number of successful PUR operations in this time period and stores the operation result in a text file on the PGW. The file name is in the SET_HPURREPDATA_yyyy-mm-dd-hh-mm-ss.txt format. You can download the operation result by using the file manager function of the PGW Web LMT. Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU
C
REPDATA
Character string
1-65000
Repository data
C
REPTYPE
Enumerated
ALIASREPDA TA
Repository data type
C
REPDATA
AS
Character string
1-127
AS host name
C
STARTTIME
Character string
19-19
Start time
C
ENDTIME
Character string
19-19
End time
C
SPEED
Integer
0-65535
Speed
C
INCRSQN
Integer
0-65535
Increased SQN
C
Example: 7.
SET HPURREPDATA: IMPU="sip:[email protected]", REPDATA="30 ", REPTYPE=ALIASREPDATA, AS="as1.huawei.com";
8.
SET HPURREPDATA: STARTTIME=2016&05&31&09&00&00, ENDTIME=2016&06&01&09&00&00;
Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
All rights reserved.
Page 647 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Specify either subscriber-specific parameters (IMPU, Repository data, Repository data type, and AS host name) or time-specific parameters (Start time, End time, and Speed). In subscriberspecific parameters, IMPU and Repository data are mandatory. In time-specific parameters, Start time is mandatory.
When End time is specified, Start time is mandatory. Start time must be earlier than End time.
9.546 Send Simulated PNR Message Command Name: SND HPNR Function: This is a high-severity command. Misuse of the command causes service failures. Before using this command, confirm that the subscriber data to be sent to the AS is correct. If you have any questions, contact Huawei technical support to determine how to perform and verify the operations and formulate recovery measures in the event of an emergency. SND HPNR is used to configure the HSS9860 to send Push Notification Request (PNR) messages to notify AS devices of changes in subscribed data and send updated data to AS devices. This command is used when subscriber data in an AS is incorrect. If this command is executed with time-specific parameters (Start time, End time, and Speed) specified, the system counts the number of successful simulated PNR operations in this time period and stores the operation result in a text file on the PGW. The file name is in the SND_HPNR_yyyy-mm-dd-hh-mm-ss.txt format. You can download the operation result by using the file manager function of the PGW Web LMT.
Parameter Description: Name
Type
Range
Description
Remarks
IMPU
Character string
1-127
IMPU
C
STARTTI ME
Character string
19-19
Start time
C
ENDTIM E
Character string
19-19
End time
C
SPEED
Integer
0-65535
Speed
C
AS
Character string
1-127
AS host name
C
WAITRSP
Boolean
FALSE
Wait for a response
C
TRUE
DATAREF
Enumerated
REPDATA
Notification data type
M
CHECKE XIST
Boolean
FALSE
Check data existence
C
TRUE
SERVICEI D
Character string
Service indication
C
1-127
All rights reserved.
Page 648 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of CommandsSummary of Commands
Example: 1. SND HPNR: IMPU="sip:[email protected]", AS="123", DATAREF=RepositoryData; 2.SND HPNR: STARTTIME=2016&05&31&09&00&00, ENDTIME=2016&06&01&09&00&00, AS="as1.huawei.com", DATAREF=RepositoryData; 3. SND HPNR: IMPU="sip:[email protected]", AS="as1.huawei.com", DATAREF=RepositoryData, CHECKEXIST=FALSE, SERVICEID="10"; Output: If the operation succeeds, the system displays the following message: SUCCESS0001:Operation is successful If the operation fails, the system displays an error code. For details of the above error codes, see 11"Summary of Error Codes."
Specify either subscriber-specific parameters (IMPU and Service indication) or time-specific parameters (Start time, End time, and Speed). In subscriber-specific parameters, IMPU is mandatory. In time-specific parameters, Start time is mandatory.
When End time is specified, Start time is mandatory. Start time must be earlier than End time.
All rights reserved.
Page 649 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10
Common Enumerations
10.1 TSCODE (Telecommunication Service Code) Enumeration Name
Value
Description
TS11
0
Telephony (TS11)
TS21
2
Short message MT/PP (TS21)
TS22
3
Short message MO/PP (TS22)
TS61
5
Alternate speech and facsimile group 3 (TS61)
TS62
6
Alternate facsimile group 3 (TS62)
10.2 BSG (Basic Service Group for all Supplementary) Enumeration Name
Value
Description
ALL
0
All applicable services (TS1X, TS2X, TS6X, BS2X, BS3X)
TS1X
1
Telephony service
TS2X
2
Short message service
TS6X
3
Facsimile service group
BS2X
4
Asynchronous bearer service
BS3X
5
Synchronous bearer service
All rights reserved.
Page 650 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.3 CBBSG (Basic Service Group for Call Barring) Enumeration Name
Value
Description
ALL
0
All applicable services(TS1X, TS2X, TS6X, BS2X, BS3X)
TS1X
1
Telephony service
TS2X
2
Short message service
TS6X
3
Facsimile service group
BS2X
4
Asynchronous bearer service
BS3X
5
Synchronous bearer service
10.4 CFBSG (Basic Service Group for Call Forwarding) Enumeration Name
Value
Description
ALL
0
All applicable services(TS1X, TS6X, BS2X, BS3X)
TS1X
1
Telephony service
TS6X
3
Fax service
BS2X
4
Asynchronous bearer service
BS3X
5
Synchronous bearer service
10.5 CWBSG (Basic Service Group for Call Waiting) Enumeration Name
Value
Description
ALL
0
All applicable services(TS1X, TS6X, BS2X, BS3X)
TS1X
1
Telephony service
TS6X
3
Fax service
BS2X
4
Asynchronous bearer service
BS3X
5
Synchronous bearer service
TSDX
6
Custom supplementary service
All rights reserved.
Page 651 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Value
Common EnumerationsCommon Enumerations
Description
10.6 BSCODE (Bearer Service Code) Enumeration Name
Value
Description
BS20
20
Bearer service code 20, circuit duplex asynchronous (CDA) data service
BS21
21
Bearer service code 21 CDA-300 bps
BS22
22
Bearer service code 22 CDA-1200 bps
BS23
23
Bearer service code 23 CDA-1200-75 bps
BS24
24
Bearer service code 24 CDA-2400 bps
BS25
25
Bearer service code 25 CDA-4800 bps
BS26
26
Bearer service code 26 CDA-9600 bps
BS30
30
Bearer service code 30, circuit duplex synchronous (CDS) data service
BS31
31
Bearer service code 31 CDS-1200 bps
BS32
32
Bearer service code 32 CDS-2400 bps
BS33
33
Bearer service code 33 CDS-4800 bps
BS34
34
Bearer service code 34 CDS-9600 bps
BS41
41
Bearer service code 41 PAD access CA-300 bps
BS42
42
Bearer service code 42 PAD access CA-1200 bps
BS43
43
Bearer service code 43 PAD access CA-1200-75 bps
BS44
44
Bearer service code 44 PAD access CA-2400 bps
BS45
45
Bearer service code 45 PAD access CA-4800 bps
BS46
46
Bearer service code 46 PAD access CA-9600 bps
BS51
51
Bearer service code 51 PDS-2400 bps
BS52
52
Bearer service code 52 PDS-4800 bps
BS53
53
Bearer service code 53 PDS-9600 bps
BS61
61
Bearer service code 61 Alternate speech and data service
BS81
81
Bearer service code 81 Speech followed by data service (can be any kind of data service)
All rights reserved.
Page 652 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.7 BASCODE (Basic Service Code) Enumeration Name
Value
Description
TS11
0
Telephony (TS11)
TS12
1
Emergency call (TS12)
TS21
2
Short message MT/PP (TS21)
TS22
3
Short message MO/PP (TS22)
TS23
4
Short message CB
TS61
5
Alternate speech and facsimile group 3 (TS61)
TS62
6
Alternate facsimile group 3 (TS62)
TS91
7
Voice group call service (TS91)
TS92
8
Voice broadcast service (TS92)
BS20
20
Bearer service code 20, circuit duplex asynchronous (CDA) data service
BS21
21
Bearer service code 21 CDA-300 bps
BS22
22
Bearer service code 22 CDA-1200 bps
BS23
23
Bearer service code 23 CDA-1200-75 bps
BS24
24
Bearer service code 24 CDA-2400 bps
BS25
25
Bearer service code 25 CDA-4800 bps
BS26
26
Bearer service code 26 CDA-9600 bps
BS30
30
Bearer service code 30, circuit duplex synchronous (CDS) data service
BS31
31
Bearer service code 31 CDS-1200 bps
BS32
32
Bearer service code 32 CDS-2400 bps
BS33
33
Bearer service code 33 CDS-4800 bps
BS34
34
Bearer service code 34 CDS-9600 bps
BS41
41
Bearer service code 41 PAD access CA-300 bps
BS42
42
Bearer service code 42 PAD access CA-1200 bps
BS43
43
Bearer service code 43 PAD access CA-1200-75 bps
BS44
44
Bearer service code 44 PAD access CA-2400 bps
BS45
45
Bearer service code 45 PAD access CA-4800 bps
BS46
46
Bearer service code 46 PAD access CA-9600 bps
BS51
51
Bearer service code 51 PDS-2400 bps
BS52
52
Bearer service code 52 PDS-4800 bps
All rights reserved.
Page 653 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
BS53
53
Bearer service code 53 PDS-9600 bps
BS61
61
Bearer service code 61 Alternate speech and data service
BS81
81
Bearer service code 81 Speech followed by data service (can be any kind of data service)
10.8 DSCODE (Data Service Code) Enumeration Name
Value
Description
TS61
5
Alternate speech and facsimile group 3 (TS61)
TS62
6
Alternate facsimile group 3 (TS62)
BS20
20
Bearer service code 20, circuit duplex asynchronous (CDA) data service
BS21
21
Bearer service code 21 CDA-300 bps
BS22
22
Bearer service code 22 CDA-1200 bps
BS23
23
Bearer service code 23 CDA-1200-75 bps
BS24
24
Bearer service code 24 CDA-2400 bps
BS25
25
Bearer service code 25 CDA-4800 bps
BS26
26
Bearer service code 26 CDA-9600 bps
BS30
30
Bearer service code 30, circuit duplex synchronous (CDS) data service
BS31
31
Bearer service code 31 CDS-1200 bps
BS32
32
Bearer service code 32 CDS-2400 bps
BS33
33
Bearer service code 33 CDS-4800 bps
BS34
34
Bearer service code 34 CDS-9600 bps
BS41
41
Bearer service code 41 PAD access CA-300 bps
BS42
42
Bearer service code 42 PAD access CA-1200 bps
BS43
43
Bearer service code 43 PAD access CA-1200-75 bps
BS44
44
Bearer service code 44 PAD access CA-2400 bps
BS45
45
Bearer service code 45 PAD access CA-4800 bps
BS46
46
Bearer service code 46 PAD access CA-9600 bps
BS51
51
Bearer service code 51 PDS-2400 bps
BS52
52
Bearer service code 52 PDS-4800 bps
All rights reserved.
Page 654 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
BS53
53
Bearer service code 53 PDS-9600 bps
BS61CDA
61
Bearer service code 61 Alternate speech and data service/circuit duplex asynchronous (CDA)
BS61CDS
62
Bearer service code 61 Alternate speech and data service/Data circuit duplex synchronous (CDS)
BS81CDA
81
Bearer service code 81 Speech followed by data service (can be any kind of data service)/Data circuit duplex asynchronous (CDA)
BS81CDS
82
Bearer service code 81 Speech followed by data service (can be any kind of data service)/Data circuit duplex synchronous (CDS)
10.9 CAMEL Phase Enumeration Name
Value
Description
PHASE1
1
CAMEL phase 1
PHASE2
2
CAMEL phase 2
PHASE3
3
CAMEL phase 3
10.10 TSCODE and DSCODE Enumeration Name
Value
Description
TS11
0
Telephony (TS11)
TS12
1
Emergency call (TS12)
TS21
2
Short message MT/PP (TS21)
TS22
3
Short message MO/PP (TS22)
TS61
5
Alternate speech and facsimile group 3 (TS61)
TS62
6
Alternate facsimile group 3 (TS62)
BS20
16
Bearer service code 20, circuit duplex asynchronous (CDA) data service
BS21
17
Bearer service code 21 CDA-300 bps
BS22
18
Bearer service code 22 CDA-1200 bps
BS23
19
Bearer service code 23 CDA-1200-75 bps
BS24
20
Bearer service code 24 CDA-2400 bps
All rights reserved.
Page 655 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
BS25
21
Bearer service code 25 CDA-4800 bps
BS26
22
Bearer service code 26 CDA-9600 bps
BS30
24
Bearer service code 30, circuit duplex synchronous (CDS) data service
BS31
26
Bearer service code 31 CDS-1200 bps
BS32
28
Bearer service code 32 CDS-2400 bps
BS33
29
Bearer service code 33 CDS-4800 bps
BS34
30
Bearer service code 34 CDS-9600 bps
BS41
33
Bearer service code 41 CDS-300 bps
BS42
34
Bearer service code 42 PAD access CA-1200 bps
BS43
35
Bearer service code 43 PAD access CA-1200-75 bps
BS44
36
Bearer service code 44 PAD access CA-2400 bps
BS45
37
Bearer service code 45 PAD access CA-4800 bps
BS46
38
Bearer service code 46 PAD access CA-9600 bps
BS51
44
Bearer service code 51 PDS-2400 bps
BS52
45
Bearer service code 52 PDS-4800 bps
BS53
46
Bearer service code 53 PDS-9600 bps
BS61
48
Bearer service code 61 Alternate speech and data service/Circuit duplex asynchronous (CDA)
BS81
64
Bearer service code 81 Speech followed by data service (can be any kind of data service)/Data circuit duplex synchronous (CDS)
10.11 Basic Service Code Enumeration Name
Value
Description
All Teleservices
0
All teleservices
All Speech Transmission Services
16
All speech transmission services
Telephony (TS11)
17
Telephony (TS11)
Emergency Call (TS12)
18
Emergency call (TS12)
All Short Message Services
32
All short message services
Short Message MT_PP (TS21)
33
Mobile terminated point-to-point short message service (TS21)
All rights reserved.
Page 656 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
Short Message MO_PP (TS22)
34
Mobile originated point-to-point short message service (TS22)
All Facsimile Transmission Services
96
All facsimile transmission services
Alternate Speech and Facsimile Group 3 (TS61)
97
Alternate speech and facsimile group 3 (TS61)
AutomaticFacsimileGroup3 (TS62)
98
Automatic facsimile group3 (TS62)
All Data Teleservices
112
All data teleservices
All Teleservices_ExceptSMS
128
All teleservices_except SMS
AllVoiceGroupCallServices
144
All voice group call services
VoiceGroupCall
145
Voice group call
All PLMN_SpecificTS
208
All PLMN_specific TS
Plmn_SpecificTS_1
209
Plmn_SpecificTS_1
Plmn_SpecificTS_2
210
Plmn_SpecificTS_2
Plmn_SpecificTS_3
211
Plmn_SpecificTS_3
Plmn_SpecificTS_4
212
Plmn_SpecificTS_4
Plmn_SpecificTS_5
213
Plmn_SpecificTS_5
Plmn_SpecificTS_6
214
Plmn_SpecificTS_6
Plmn_SpecificTS_7
215
Plmn_SpecificTS_7
Plmn_SpecificTS_8
216
Plmn_SpecificTS_8
Plmn_SpecificTS_9
217
Plmn_SpecificTS_9
Plmn_SpecificTS_A
218
Plmn_SpecificTS_A
Plmn_SpecificTS_B
219
Plmn_SpecificTS_B
Plmn_SpecificTS_C
220
Plmn_SpecificTS_C
Plmn_SpecificTS_D
221
Plmn_SpecificTS_D
Plmn_SpecificTS_E
222
Plmn_SpecificTS_E
Plmn_SpecificTS_F
223
Plmn_SpecificTS_F
All Bearer Services
1000
All bearer services
General-dataCDA (BS20)
1016
General-data CDA (BS20)
Data CDA-300bps (BS21)
1017
Data CDA-300 bps (BS21)
Data CDA-1200 bps (BS22)
1018
Data CDA-1200 bps (BS22)
Data CDA-1200-75 bps (BS23)
1019
Data CDA-1200-75 bps (BS23)
Data CDA-2400 bps (BS24)
1020
Data CDA-2400 bps (BS24)
All rights reserved.
Page 657 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
Data CDA-4800 bps (BS25)
1021
Data CDA-4800 bps (BS25)
Data CDA-9600 bps (BS26)
1022
Data CDA-9600 bps (BS26)
General-DataCDA
1023
General-data CDA
General-DataCDS (BS30)
1024
General-data CDS (BS30)
Data CDS-1200bps (BS31)
1026
Data CDS-1200 bps (BS31)
Data CDS-2400bps (BS32)
1028
Data CDS-2400 bps (BS32)
Data CDS-4800bps (BS33)
1029
Data CDS-4800 bps (BS33)
Data CDS-9600bps (BS34)
1030
Data CDS-9600 bps (BS34)
General Data CDS
1031
General data CDS
All Pad Access CA Services
1032
All PAD access CA services
Pad Access CA-300bps (BS41)
1033
PAD access CA-300 bps (BS41)
Pad Access CA-1200bps (BS42)
1034
PAD access CA-1200 bps (BS42)
Pad Access CA-1200-75bps (BS43)
1035
PAD access CA-1200-75 bps (BS43)
Pad Access CA-2400bps (BS44)
1036
PAD access CA-2400 bps (BS44)
Pad Access CA-4800bps (BS45)
1037
PAD access CA-4800 bps (BS45)
Pad Access CA-9600bps (BS46)
1038
PAD access CA-9600 bps (BS46)
General Pad Access CA
1039
General PAD access CA
AllDataPDS_Services
1040
All data PDS_services
Data PDS-2400bps (BS51)
1044
Data PDS-2400 bps (BS51)
Data PDS-4800bps (BS52)
1045
Data PDS-4800 bps (BS52)
Data PDS-9600bps (BS53)
1046
Data PDS-9600 bps (BS53)
General Data PDS
1047
General data PDS
AllAlternateSpeech_DataCDA (BS61)
1048
All alternate speech data CDA (BS61)
All Alternate Speech Data CDS (BS61)
1056
All alternate speech data CDS (BS61)
AllSpeechFollowedByDataCDA (BS81)
1064
All speech followed by data CDA (BS81)
All Speech Followed By Data CDS (BS81)
1072
All speech followed by data CDS (BS81)
AllDataCircuitAsynchronous
1080
All data circuit asynchronous
AllDataCircuitSynchronous
1088
All data circuit synchronous
AllAsynchronousServices
1096
All asynchronous services
AllSynchronousServices
1104
All synchronous services
All PLMN Specific BS
1209
All PLMN specific BS
All rights reserved.
Page 658 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
Plmn_SpecificBS_1
1210
Plmn_SpecificBS_1
Plmn_SpecificBS_2
1211
Plmn_SpecificBS_2
Plmn_SpecificBS_3
1212
Plmn_SpecificBS_3
Plmn_SpecificBS_4
1213
Plmn_SpecificBS_4
Plmn_SpecificBS_5
1214
Plmn_SpecificBS_5
Plmn_SpecificBS_6
1215
Plmn_SpecificBS_6
Plmn_SpecificBS_7
1216
Plmn_SpecificBS_7
Plmn_SpecificBS_8
1217
Plmn_SpecificBS_8
Plmn_SpecificBS_9
1218
Plmn_SpecificBS_9
Plmn_SpecificBS_A
1219
Plmn_SpecificBS_A
Plmn_SpecificBS_B
1220
Plmn_SpecificBS_B
Plmn_SpecificBS_C
1221
Plmn_SpecificBS_C
Plmn_SpecificBS_D
1222
Plmn_SpecificBS_D
Plmn_SpecificBS_E
1223
Plmn_SpecificBS_E
Plmn_SpecificBS_F
1224
Plmn_SpecificBS_F
10.12 ODB (Operator Determined Barring) Enumeration ODBBIC Name
Value
Description
NOBIC
0
No barring of incoming calls
BAIC
1
Barring of all incoming calls
BICROAM
2
Barring of all incoming calls when roaming outside the home PLMN country
ODBBOC Name
Value
Description
NOBOC
0
No barring of outgoing calls
BAOC
1
Barring of all outgoing calls
BOIC
2
Barring of all outgoing international calls
All rights reserved.
Page 659 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
BOICEXHC
3
Barring of all outgoing calls except those directed to home PLMN country
BOCROAM
4
Barring of all outgoing calls when roaming outside home PLMN country
ODBROAM Name
Value
Description
NOBAR
0
No Barring
BROHPLMN
1
Barring of roaming outside the home PLMN
BROHPLMNC
2
Barring of roaming outside the home PLMN country
BROHPLMNCGPRS
3
Barring GPRS of roaming outside the home PLMN country
10.13 NAM (Network Access Mode) Enumeration Name
Value
Description
BOTH
0
Allows traditional CS and PS network access mode
MSC
1
Allows traditional CS network access mode
SGSN
2
Allows PS network access mode
NONE
3
Allows EPS network access mode
10.14 SMDP (Short Message Delivery Path) Enumeration Name
Value
Description
MSC
0
Allows traditional CS network access mode
SGSN
1
Allows PS network access mode
All rights reserved.
Page 660 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.15 CSITYPE (CAMEL Subscription Information Type) Enumeration Name
Value
Description
ALL
0
All kinds of CSI (CAMEL subscription information)
OCSI
1
O-CSI (originating CAMEL subscription information)
TCSI
2
T-CSI (terminating CAMEL subscription information)
VTCSI
3
VT-CSI (VMSC terminating CAMEL subscription information)
TiFCSI
4
TIF-CSI (translation information flag CAMEL subscription information)
UCSI
5
U-CSI (USSD CAMEL subscription information)
SSCSI
6
SS-CSI (supplementary service invocation notification CAMEL subscription information)
MCSI
7
M-CSI (mobility management CAMEL subscription information)
SMSCSI
8
SMS-CSI (short message service CAMEL subscription information)
GPRSCSI
9
GPRS-CSI (GPRS CAMEL subscription information)
D-CSI
10
D-CSI (dialed services CAMEL subscription information)
10.16 SERVICE_PROPERTY (Service Property Enumeration List for Called Number Analysis) Enumeration Name
Value
Description
SP_LOCAL
0
Local number
SP_NATIONAL_TOLL
1
National toll number
SP_PLMN
2
Mobile number
Other
3
Others
10.17 Priority Locate Flag (PLF) Enumeration Name
Value
Description
MSC
0
The MSC has the higher priority.
All rights reserved.
Page 661 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
SGSN
1
The SGSN has the higher priority.
10.18 Privacy Exception1-SS Code (LCSPCODE) Enumeration Name
Value
Description
Universal
0
All LCS clients can request the location of MSs/UEs.
Callrelated
1
Only the LCS client involved in a temporary session with MSs/UEs can request the location of the MSs/UEs. The session is initiated by the MSs/UEs (without parameters.)
Callunrelated
2
Only the LCS clients specified in the LCS template can request the location of MSs/UEs.
plmnoperator
3
All PLMN LCS clients can request the location of MSs/UEs.
10.19 Privacy Exception1-SS Status (LCSSTATUS) Enumeration Name
Value
Description
provisioned
0
-
active
1
-
10.20 Privacy Exception1-NotificationToMsUser (LCSNOTIFY) Enumeration Name
Value
Description
notifyLocationAllowed
0
The MSC/SGSN/MME processes the LCS service request from such an LCS client and sends a notification to the MS/UE before it obtains MS/UE's location information.
notifyAndVerifyLocationAllowedIfNoResp onse
1
The MSC/SGSN/MME sends a notification to an MS/UE before it obtains MS/UE's location information. If the MS/UE does not respond, the MSC/SGSN/MME continues processing the LCS
All rights reserved.
Page 662 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Value
Common EnumerationsCommon Enumerations
Description service request.
notifyAndVerifyLocationNotAllowedIfNoR esponse
2
The MSC/SGSN/MME sends a notification to an MS/UE before it obtains MS/UE's location information. If the MS/UE does not respond, the LCS service procedure ends.
locationNotAllowed
3
The MSC/SGSN/MME does not process the LCS service request sent from such an LCS client.
10.21 PrivacyException1-ExceptionClientList1-GMLCRestrict(LCSPGMLCR) Enumeration Name
Value
Description
hplmn
0
The gateway mobile location center (GMLC) must reside in the HPLMN.
home-country
1
The GMLC must reside in the home country.
10.22 Privacy Exception1-PlmnClientList (LCSPLMNCL) Enumeration Name
Value
Description
BroadCastService
1
A location service (LCS) client broadcasting location-related information
O-and M-HPLMN
2
An LCS client who conducts the operation and maintenance in the HPLMN, such as operating and maintaining the system
O-and M-VPLMN
4
An LCS client who conducts the operation and maintenance in the VPLMN, such as operating and maintaining the system
anonymousLocation
8
An LCS client who records the location information automatically
targetMSsubscribed Service
16
An LCS client (subscribed by the mobile station) who supports or enhances the supplementary services, intelligent services, bearer services, or telecom services
All rights reserved.
Page 663 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.23 Mobile Originated Location Request Supplementary Service Code (LCSMOLRCODE) Enumeration Name
Value
Description
all-MOLR-SS
0
All location request classes
BasicSelfLocation
1
An MS needs to interact with the network for every independent location request.
AutonomousSelfLocation
2
An MS does not need to interact with the network for every location request, and it can obtain multiple location-related messages by interacting with the network once within the predefined time.
TransferToThirdParty
3
The location information of an MS will be transmitted to the designated LCS client as required by the MS.
10.24 Mobile Originated Location Request Supplementary Service Status (LCSMOLRSTATUS) Enumeration Name
Value
Description
provisioned
0
The service has been provisioned.
active
1
The service is active.
10.25 Category Enumeration Name
Value
Description
UNKNOWN
0x00
-
FRENCH
0x01
-
ENGLISH
0x02
-
GERMAN
0x03
-
RUSSIAN
0x04
-
SPANISH
0x05
-
SPECIAL1
0x06
-
SPECIAL2
0x07
-
SPECIAL3
0x08
-
All rights reserved.
Page 664 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Value
Description
RESERVE
0x09
-
COMMON
0x0a
-
SUPERIOR
0x0b
-
DATACALL
0x0c
-
TESTCALL
0x0d
-
SPARE
0x0e
-
PAYPHONE
0x0f
-
16
0x10
-
17
0x11
-
…
…
…
31
0x1f
-
COIN
0x20
-
33
0x21
-
…
…
…
254
0xfe
-
MNP
0xff
Common EnumerationsCommon Enumerations
10.26 GPRS QoS Enumeration Value for GPRS_BIT_RATE Name
Value
Description
1K
1
1 Kbps
2K
2
2 kbit/s
3K
3
3 kbit/s
4K
4
4 kbit/s
5K
5
5 kbit/s
6K
6
6 kbit/s
7K
7
7 kbit/s
8K
8
8 kbit/s
9K
9
9 kbit/s
All rights reserved.
Page 665 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
10K
10
10 kbit/s
11K
11
11 kbit/s
12K
12
12 kbit/s
13K
13
13 kbit/s
14K
14
14 kbit/s
15K
15
15 kbit/s
16K
16
16 kbit/s
17K
17
17 kbit/s
18K
18
18 kbit/s
19K
19
19 kbit/s
20K
20
20 kbit/s
21K
21
21 kbit/s
22K
22
22 kbit/s
23K
23
23 kbit/s
24K
24
24 kbit/s
25K
25
25 kbit/s
26K
26
26 kbit/s
27K
27
27 kbit/s
28K
28
28 kbit/s
29K
29
29 kbit/s
30K
30
30 kbit/s
31K
31
31 kbit/s
32K
32
32 kbit/s
33K
33
33 kbit/s
34K
34
34 kbit/s
35K
35
35 kbit/s
36K
36
36 kbit/s
37K
37
37 kbit/s
38K
38
38 kbit/s
39K
39
39 kbit/s
40K
40
40 kbit/s
All rights reserved.
Page 666 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
41K
41
41 kbit/s
42K
42
42 kbit/s
43K
43
43 kbit/s
44K
44
44 kbit/s
45K
45
45 kbit/s
46K
46
46 kbit/s
47K
47
47 kbit/s
48K
48
48 kbit/s
49K
49
49 kbit/s
50K
50
50 kbit/s
51K
51
51 kbit/s
52K
52
52 kbit/s
53K
53
53 kbit/s
54K
54
54 kbit/s
55K
55
55 kbit/s
56K
56
56 kbit/s
57K
57
57 kbit/s
58K
58
58 kbit/s
59K
59
59 kbit/s
60K
60
60 kbit/s
61K
61
61 kbit/s
62K
62
62 kbit/s
63K
63
63 kbit/s
64K
64
64 kbit/s
72K
65
72 kbit/s
80K
66
80 kbit/s
88K
67
88 kbit/s
96K
68
96 kbit/s
104K
69
104 kbit/s
112K
70
112 kbit/s
120K
71
120 kbit/s
All rights reserved.
Page 667 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
128K
72
128 kbit/s
136K
73
136 kbit/s
144K
74
144 kbit/s
152K
75
152 kbit/s
160K
76
160 kbit/s
168K
77
168 kbit/s
176K
78
176 kbit/s
184K
79
184 kbit/s
192K
80
192 kbit/s
200K
81
200 kbit/s
208K
82
208 kbit/s
216K
83
216 kbit/s
224K
84
224 kbit/s
232K
85
232 kbit/s
240K
86
240 kbit/s
248K
87
248 kbit/s
256K
88
256 kbit/s
264K
89
264 kbit/s
272K
90
272 kbit/s
280K
91
280 kbit/s
288K
92
288 kbit/s
296K
93
296 kbit/s
304K
94
304 kbit/s
312K
95
312 kbit/s
320K
96
320 kbit/s
328K
97
328 kbit/s
336K
98
336 kbit/s
344K
99
344 kbit/s
352K
100
352 kbit/s
360K
101
360 kbit/s
368K
102
368 kbit/s
All rights reserved.
Page 668 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
376K
103
376 kbit/s
384K
104
384 kbit/s
392K
105
392 kbit/s
400K
106
400 kbit/s
408K
107
408 kbit/s
416K
108
416 kbit/s
424K
109
424 kbit/s
432K
110
432 kbit/s
440K
111
440 kbit/s
448K
112
448 kbit/s
456K
113
456 kbit/s
464K
114
464 kbit/s
472K
115
472 kbit/s
480K
116
480 kbit/s
488K
117
488 kbit/s
496K
118
496 kbit/s
504K
119
504 kbit/s
512K
120
512 kbit/s
520K
121
520 kbit/s
528K
122
528 kbit/s
536K
123
536 kbit/s
544K
124
544 kbit/s
552K
125
552 kbit/s
560K
126
560 kbit/s
568K
127
568 kbit/s
576K
128
576 kbit/s
640K
129
640 kbit/s
704K
130
704 kbit/s
768K
131
768 kbit/s
832K
132
832 kbit/s
896K
133
896 kbit/s
All rights reserved.
Page 669 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
960K
134
960 kbit/s
1024K
135
1024 kbit/s
1088K
136
1088 kbit/s
1152K
137
1152 kbit/s
1216K
138
1216 kbit/s
1280K
139
1280 kbit/s
1344K
140
1344 kbit/s
1408K
141
1408 kbit/s
1472K
142
1472 kbit/s
1536K
143
1536 kbit/s
1600K
144
1600 kbit/s
1664K
145
1664 kbit/s
1728K
146
1728 kbit/s
1792K
147
1792 kbit/s
1856K
148
1856 kbit/s
1920K
149
1920 kbit/s
1984K
150
1984 kbit/s
2048K
151
2048 kbit/s
2112K
152
2112 kbit/s
2176K
153
2176 kbit/s
2240K
154
2240 kbit/s
2304K
155
2304 kbit/s
2368K
156
2368 kbit/s
2432K
157
2432 kbit/s
2496K
158
2496 kbit/s
2560K
159
2560 kbit/s
2624K
160
2624 kbit/s
2688K
161
2688 kbit/s
2752K
162
2752 kbit/s
2816K
163
2816 kbit/s
2880K
164
2880 kbit/s
All rights reserved.
Page 670 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
2944K
165
2944 kbit/s
3008K
166
3008 kbit/s
3072K
167
3072 kbit/s
3136K
168
3136 kbit/s
3200K
169
3200 kbit/s
3264K
170
3264 kbit/s
3328K
171
3328 kbit/s
3392K
172
3392 kbit/s
3456K
173
3456 kbit/s
3520K
174
3520 kbit/s
3584K
175
3584 kbit/s
3648K
176
3648 kbit/s
3712K
177
3712 kbit/s
3776K
178
3776 kbit/s
3840K
179
3840 kbit/s
3904K
180
3904 kbit/s
3968K
181
3968 kbit/s
4032K
182
4032 kbit/s
4096K
183
4096 kbit/s
4160K
184
4160 kbit/s
4224K
185
4224 kbit/s
4288K
186
4288 kbit/s
4352K
187
4352 kbit/s
4416K
188
4416 kbit/s
4480K
189
4480 kbit/s
4544K
190
4544 kbit/s
4608K
191
4608 kbit/s
4672K
192
4672 kbit/s
4736K
193
4736 kbit/s
4800K
194
4800 kbit/s
4864K
195
4864 kbit/s
All rights reserved.
Page 671 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
4928K
196
4928 kbit/s
4992K
197
4992 kbit/s
5056K
198
5056 kbit/s
5120K
199
5120 kbit/s
5184K
200
5184 kbit/s
5248K
201
5248 kbit/s
5312K
202
5312 kbit/s
5376K
203
5376 kbit/s
5440K
204
5440 kbit/s
5504K
205
5504 kbit/s
5568K
206
5568 kbit/s
5632K
207
5632 kbit/s
5696K
208
5696 kbit/s
5760K
209
5760 kbit/s
5824K
210
5824 kbit/s
5888K
211
5888 kbit/s
5952K
212
5952 kbit/s
6016K
213
6016 kbit/s
6080K
214
6080 kbit/s
6144K
215
6144 kbit/s
6208K
216
6208 kbit/s
6272K
217
6272 kbit/s
6336K
218
6336 kbit/s
6400K
219
6400 kbit/s
6464K
220
6464 kbit/s
6528K
221
6528 kbit/s
6592K
222
6592 kbit/s
6656K
223
6656 kbit/s
6720K
224
6720 kbit/s
6784K
225
6784 kbit/s
6848K
226
6848 kbit/s
All rights reserved.
Page 672 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
6912K
227
6912 kbit/s
6976K
228
6976 kbit/s
7040K
229
7040 kbit/s
7104K
230
7104 kbit/s
7168K
231
7168 kbit/s
7232K
232
7232 kbit/s
7296K
233
7296 kbit/s
7360K
234
7360 kbit/s
7424K
235
7424 kbit/s
7488K
236
7488 kbit/s
7552K
237
7552 kbit/s
7616K
238
7616 kbit/s
7680K
239
7680 kbit/s
7744K
240
7744 kbit/s
7808K
241
7808 kbit/s
7872K
242
7872 kbit/s
7936K
243
7936 kbit/s
8000K
244
8000 kbit/s
8064K
245
8064 kbit/s
8128K
246
8128 kbit/s
8192K
247
8192 kbit/s
8256K
248
8256 kbit/s
8320K
249
8320 kbit/s
8384K
250
8384 kbit/s
8448K
251
8448 kbit/s
8512K
252
8512 kbit/s
8576K
253
8576 kbit/s
8640K
254
8640 kbit/s
0K
255
0 kbit/s
All rights reserved.
Page 673 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.27 GPRS QoS Enumeration Value for GPRS_EXT_BIT_RATE Name
Value
Description
NOExtend
0
NOExtend
8700K
1
8700 kbit/s
8800K
2
8800 kbit/s
8900K
3
8900 kbit/s
9000K
4
9000 kbit/s
9100K
5
9100 kbit/s
9200K
6
9200 kbit/s
9300K
7
9300 kbit/s
9400K
8
9400 kbit/s
9500K
9
9500 kbit/s
9700K
11
9700 kbit/s
9800K
12
9800 kbit/s
9900K
13
9900 kbit/s
10000K
14
10000 kbit/s
10100K
15
10100 kbit/s
10200K
16
10200 kbit/s
10300K
17
10300 kbit/s
10400K
18
10400 kbit/s
10500K
19
10500 kbit/s
10600K
20
10600 kbit/s
10700K
21
10700 kbit/s
10800K
22
10800 kbit/s
10900K
23
10900 kbit/s
11000K
24
11000 kbit/s
11100K
25
11100 kbit/s
11200K
26
11200 kbit/s
11300K
27
11300 kbit/s
11400K
28
11400 kbit/s
All rights reserved.
Page 674 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
11500K
29
11500 kbit/s
11600K
30
11600 kbit/s
11700K
31
11700 kbit/s
11800K
32
11800 kbit/s
11900K
33
11900 kbit/s
12000K
34
12000 kbit/s
12100K
35
12100 kbit/s
12200K
36
12200 kbit/s
12300K
37
12300 kbit/s
12400K
38
12400 kbit/s
12500K
39
12500 kbit/s
12600K
40
12600 Kbps
12700K
41
12700 kbit/s
12800K
42
12800 kbit/s
12900K
43
12900 kbit/s
13000K
44
13000 kbit/s
13100K
45
13100 kbit/s
13200K
46
13200 kbit/s
13300K
47
13300 kbit/s
13400K
48
13400 kbit/s
13500K
49
13500 kbit/s
13600K
50
13600 kbit/s
13700K
51
13700 kbit/s
13800K
52
13800 kbit/s
13900K
53
13900 kbit/s
14000K
54
14000 kbit/s
14100K
55
14100 kbit/s
14200K
56
14200 kbit/s
14300K
57
14300 kbit/s
14400K
58
14400 kbit/s
14500K
59
14500 kbit/s
All rights reserved.
Page 675 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
14600K
60
14600 kbit/s
14700K
61
14700 kbit/s
14800K
62
14800 kbit/s
14900K
63
14900 kbit/s
15000K
64
15000 kbit/s
15100K
65
15100 kbit/s
15200K
66
15200 kbit/s
15300K
67
15300 kbit/s
15400K
68
15400 kbit/s
15500K
69
15500 kbit/s
15600K
70
15600 kbit/s
15700K
71
15700 kbit/s
15800K
72
15800 kbit/s
15900K
73
15900 kbit/s
16000K
74
16000 kbit/s
17M
75
17 Mbps
18M
76
18 Mbps
19M
77
19 Mbps
20M
78
20 Mbps
21M
79
21 Mbps
22M
80
22 Mbps
23M
81
23 Mbps
24M
82
24 Mbps
25M
83
25 Mbps
26M
84
26 Mbps
27M
85
27 Mbps
28M
86
28 Mbps
29M
87
29 Mbps
30M
88
30 Mbps
31M
89
31 Mbps
32M
90
32 Mbps
All rights reserved.
Page 676 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
33M
91
33 Mbps
34M
92
34 Mbps
35M
93
35 Mbps
36M
94
36 Mbps
37M
95
37 Mbps
38M
96
38 Mbps
39M
97
39 Mbps
40M
98
40 Mbps
41M
99
41 Mbps
42M
100
42 Mbps
43M
101
43 Mbps
44M
102
44 Mbps
45M
103
45 Mbps
46M
104
46 Mbps
47M
105
47 Mbps
48M
106
48 Mbps
49M
107
49 Mbps
50M
108
50 Mbps
51M
109
51 Mbps
52M
110
52 Mbps
53M
111
53 Mbps
54M
112
54 Mbps
55M
113
55 Mbps
56M
114
56 Mbps
57M
115
57 Mbps
58M
116
58 Mbps
59M
117
59 Mbps
60M
118
60 Mbps
61M
119
61 Mbps
62M
120
62 Mbps
63M
121
63 Mbps
All rights reserved.
Page 677 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
64M
122
64 Mbps
65M
123
65 Mbps
66M
124
66 Mbps
67M
125
67 Mbps
68M
126
68 Mbps
69M
127
69 Mbps
70M
128
70 Mbps
71M
129
71 Mbps
72M
130
72 Mbps
73M
131
73 Mbps
74M
132
74 Mbps
75M
133
75 Mbps
76M
134
76 Mbps
77M
135
77 Mbps
78M
136
78 Mbps
79M
137
79 Mbps
80M
138
80 Mbps
81M
139
81 Mbps
82M
140
82 Mbps
83M
141
83 Mbps
84M
142
84 Mbps
85M
143
85 Mbps
86M
144
86 Mbps
87M
145
87 Mbps
88M
146
88 Mbps
89M
147
89 Mbps
90M
148
90 Mbps
91M
149
91 Mbps
92M
150
92 Mbps
93M
151
93 Mbps
94M
152
94 Mbps
All rights reserved.
Page 678 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
95M
153
95 Mbps
96M
154
96 Mbps
97M
155
97 Mbps
98M
156
98 Mbps
99M
157
99 Mbps
100M
158
100 Mbps
101M
159
101 Mbps
102M
160
102 Mbps
103M
161
103 Mbps
104M
162
104 Mbps
105M
163
105 Mbps
106M
164
106 Mbps
107M
165
107 Mbps
108M
166
108 Mbps
109M
167
109 Mbps
110M
168
110 Mbps
111M
169
111 Mbps
112M
170
112 Mbps
113M
171
113 Mbps
114M
172
114 Mbps
115M
173
115 Mbps
116M
174
116 Mbps
117M
175
117 Mbps
118M
176
118 Mbps
119M
177
119 Mbps
120M
178
120 Mbps
121M
179
121 Mbps
122M
180
122 Mbps
123M
181
123 Mbps
124M
182
124 Mbps
125M
183
125 Mbps
All rights reserved.
Page 679 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
126M
184
126 Mbps
127M
185
127 Mbps
128M
186
128 Mbps
130M
187
130 Mbps
132M
188
132 Mbps
134M
189
134 Mbps
136M
190
136 Mbps
138M
191
138 Mbps
140M
192
140 Mbps
142M
193
142 Mbps
144M
194
144 Mbps
146M
195
146 Mbps
148M
196
148 Mbps
150M
197
150 Mbps
152M
198
152 Mbps
154M
199
154 Mbps
156M
200
156 Mbps
158M
201
158 Mbps
160M
202
160 Mbps
162M
203
162 Mbps
164M
204
164 Mbps
166M
205
166 Mbps
168M
206
168 Mbps
170M
207
170 Mbps
172M
208
172 Mbps
174M
209
174 Mbps
176M
210
176 Mbps
178M
211
178 Mbps
180M
212
180 Mbps
182M
213
182 Mbps
184M
214
184 Mbps
All rights reserved.
Page 680 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
186M
215
186 Mbps
188M
216
188 Mbps
190M
217
190 Mbps
192M
218
192 Mbps
194M
219
194 Mbps
196M
220
196 Mbps
198M
221
198 Mbps
200M
222
200 Mbps
202M
223
202 Mbps
204M
224
204 Mbps
206M
225
206 Mbps
208M
226
208 Mbps
210M
227
210 Mbps
212M
228
212 Mbps
214M
229
214 Mbps
216M
230
216 Mbps
218M
231
218 Mbps
220M
232
220 Mbps
222M
233
222 Mbps
224M
234
224 Mbps
226M
235
226 Mbps
228M
236
228 Mbps
230M
237
230 Mbps
232M
238
232 Mbps
234M
239
234 Mbps
236M
240
236 Mbps
238M
241
238 Mbps
240M
242
240 Mbps
242M
243
242 Mbps
244M
244
244 Mbps
246M
245
246 Mbps
All rights reserved.
Page 681 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
248M
246
248 Mbps
250M
247
250 Mbps
252M
248
252 Mbps
254M
249
254 Mbps
256M
250
256 Mbps
224M
234
224 Mbps
226M
235
226 Mbps
228M
236
228 Mbps
230M
237
230 Mbps
232M
238
232 Mbps
234M
239
234 Mbps
236M
240
236 Mbps
238M
241
238 Mbps
240M
242
240 Mbps
242M
243
242 Mbps
244M
244
244 Mbps
246M
245
246 Mbps
248M
246
248 Mbps
250M
247
250 Mbps
252M
248
252 Mbps
254M
249
254 Mbps
256M
250
256 Mbps
10.28 GPRS QoS Enumeration Value for GPRS_MEAN_THROUGHPUT Name
Value
Description
100 OCT
1
100 octet/h
200 OCT
2
200 octet/h
500 OCT
3
500 octet/h
All rights reserved.
Page 682 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
1000 OCT
4
1,000 octet/h
2000 OCT
5
2,000 octet/h
5000 OCT
6
5,000 octet/h
10000 OCT
7
10,000 octet/h
20000 OCT
8
20,000 octet/h
50000 OCT
9
50,000 octet/h
100000 OCT
10
100,000 octet/h
200000 OCT
11
200,000 octet/h
500000 OCT
12
500,000 octet/h
1000000 OCT
13
1,000,000 octet/h
2000000 OCT
14
2,000,000 octet/h
5000000 OCT
15
5,000,000 octet/h
10000000 OCT
16
10,000,000 octet/h
20000000 OCT
17
20,000,000 octet/h
50000000 OCT
18
50,000,000 octet/h
BEST_EFFORT
31
Best effort
10.29 GPRS QoS Enumeration Value for GPRS_PEAK_THROUGHPUT Name
Value
Description
1000 OCT
1
Up to 1,000 octet/s
2000 OCT
2
Up to 2,000 octet/s
4000 OCT
3
Up to 4,000 octet/s
8000 OCT
4
Up to 8,000 octet/s
16000 OCT
5
Up to 16,000 octet/s
32000 OCT
6
Up to 32,000 octet/s
64000 OCT
7
Up to 64,000 octet/s
128000 OCT
8
Up to 128,000 octet/s
256000 OCT
9
Up to 256,000 octet/s
All rights reserved.
Page 683 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.30 GPRS QoS Enumeration Value for GPRS_SDU_SIZE Name
Value
Description
10 OCT
1
10 octet/s
20 OCT
2
20 octet/s
30 OCT
3
30 octet/s
40 OCT
4
40 octet/s
50 OCT
5
50 octet/s
60 OCT
6
60 octet/s
70 OCT
7
70 octet/s
80 OCT
8
80 octet/s
90 OCT
9
90 octet/s
100 OCT
10
100 octet/s
110 OCT
11
110 octet/s
120 OCT
12
120 octet/s
130 OCT
13
130 octet/s
140 OCT
14
140 octet/s
150 OCT
15
150 octet/s
160 OCT
16
160 octet/s
170 OCT
17
170 octet/s
180 OCT
18
180 octet/s
190 OCT
19
190 octet/s
200 OCT
20
200 octet/s
210 OCT
21
210 octet/s
220 OCT
22
220 octet/s
230 OCT
23
230 octet/s
240 OCT
24
240 octet/s
250 OCT
25
250 octet/s
260 OCT
26
260 octet/s
270 OCT
27
270 octet/s
280 OCT
28
280 octet/s
All rights reserved.
Page 684 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Value
Description
290 OCT
29
290 octet/s
300 OCT
30
300 octet/s
310 OCT
31
310 octet/s
320 OCT
32
320 octet/s
330 OCT
33
330 octet/s
340 OCT
34
340 octet/s
350 OCT
35
350 octet/s
360 OCT
36
360 octet/s
370 OCT
37
370 octet/s
380 OCT
38
380 octet/s
390 OCT
39
390 octet/s
400 OCT
40
400 octet/s
410 OCT
41
410 octet/s
420 OCT
42
420 octet/s
430 OCT
43
430 octet/s
440 OCT
44
440 octet/s
450 OCT
45
450 octet/s
460 OCT
46
460 octet/s
470 OCT
47
470 octet/s
480 OCT
48
480 octet/s
490 OCT
49
490 octet/s
500 OCT
50
500 octet/s
510 OCT
51
510 octet/s
520 OCT
52
520 octet/s
530 OCT
53
530 octet/s
540 OCT
54
540 octet/s
550 OCT
55
550 octet/s
560 OCT
56
560 octet/s
570 OCT
57
570 octet/s
580 OCT
58
580 octet/s
590 OCT
59
590 octet/s
Common EnumerationsCommon Enumerations
All rights reserved.
Page 685 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Value
Description
600 OCT
60
600 octet/s
610 OCT
61
610 octet/s
620 OCT
62
620 octet/s
630 OCT
63
630 octet/s
640 OCT
64
640 octet/s
650 OCT
65
650 octet/s
660 OCT
66
660 octet/s
670 OCT
67
670 octet/s
680 OCT
68
680 octet/s
690 OCT
69
690 octet/s
700 OCT
70
700 octet/s
710 OCT
71
710 octet/s
720 OCT
72
720 octet/s
730 OCT
73
730 octet/s
740 OCT
74
740 octet/s
750 OCT
75
750 octet/s
760 OCT
76
760 octet/s
770 OCT
77
770 octet/s
780 OCT
78
780 octet/s
790 OCT
79
790 octet/s
800 OCT
80
800 octet/s
810 OCT
81
810 octet/s
820 OCT
82
820 octet/s
830 OCT
83
830 octet/s
840 OCT
84
840 octet/s
850 OCT
85
850 octet/s
860 OCT
86
860 octet/s
870 OCT
87
870 octet/s
880 OCT
88
880 octet/s
890 OCT
89
890 octet/s
900 OCT
90
900 octet/s
Common EnumerationsCommon Enumerations
All rights reserved.
Page 686 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Value
Description
910 OCT
91
910 octet/s
920 OCT
92
920 octet/s
930 OCT
93
930 octet/s
940 OCT
94
940 octet/s
950 OCT
95
950 octet/s
960 OCT
96
960 octet/s
970 OCT
97
970 octet/s
980 OCT
98
980 octet/s
990 OCT
99
990 octet/s
1000 OCT
100
1000 octet/s
1010 OCT
101
1010 octet/s
1020 OCT
102
1020 octet/s
1030 OCT
103
1030 octet/s
1040 OCT
104
1040 octet/s
1050 OCT
105
1050 octet/s
1060 OCT
106
1060 octet/s
1070 OCT
107
1070 octet/s
1080 OCT
108
1080 octet/s
1090 OCT
109
1090 octet/s
1100 OCT
110
1100 octet/s
1110 OCT
111
1110 octet/s
1120 OCT
112
1120 octet/s
1130 OCT
113
1130 octet/s
1140 OCT
114
1140 octet/s
1150 OCT
115
1150 octet/s
1160 OCT
116
1160 octet/s
1170 OCT
117
1170 octet/s
1180 OCT
118
1180 octet/s
1190 OCT
119
1190 octet/s
1200 OCT
120
1200 octet/s
1210 OCT
121
1210 octet/s
Common EnumerationsCommon Enumerations
All rights reserved.
Page 687 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Value
Description
1220 OCT
122
1220 octet/s
1230 OCT
123
1230 octet/s
1240 OCT
124
1240 octet/s
1250 OCT
125
1250 octet/s
1260 OCT
126
1260 octet/s
1270 OCT
127
1270 octet/s
1280 OCT
128
1280 octet/s
1290 OCT
129
1290 octet/s
1300 OCT
130
1300 octet/s
1310 OCT
131
1310 octet/s
1320 OCT
132
1320 octet/s
1330OCT
133
1330 octet/s
1340 OCT
134
1340 octet/s
1350 OCT
135
1350 octet/s
1360 OCT
136
1360 octet/s
1370 OCT
137
1370 octet/s
1380 OCT
138
1380 octet/s
1390 OCT
139
1390 octet/s
1400OCT
140
1400 octet/s
1410 OCT
141
1410 octet/s
1420 OCT
142
1420 octet/s
1430 OCT
143
1430 octet/s
1440 OCT
144
1440 octet/s
1450 OCT
145
1450 octet/s
1460 OCT
146
1460 octet/s
1470 OCT
147
1470 octet/s
1480 OCT
148
1480 octet/s
1490 OCT
149
1490 octet/s
1500 OCT
150
1500 octet/s
1502 OCT
151
1502 octet/s
1510 OCT
152
1510 octet/s
Common EnumerationsCommon Enumerations
All rights reserved.
Page 688 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Value
Description
1520 OCT
153
1520 octet/s
Common EnumerationsCommon Enumerations
10.31 GPRS QoS Enumeration Value for GPRS_RESIDUAL_BER Name
Value
Description
0.05
1
0.05
0.01
2
0.01
0.005
3
0.005
0.004
4
0.004
0.001
5
0.001
0.0001
6
0.0001
0.00001
7
0.00001
0.000001
8
0.000001
0.00000006
9
0.00000006
10.32 GPRS QoS Enumeration Value for GPRS_SDU_ERROR_RATE Name
Value
Description
0.01
1
0.01
0.007
2
0.007
0.001
3
0.001
0.0001
4
0.0001
0.00001
5
0.00001
0.000001
6
0.000001
0.1
7
0.1
All rights reserved.
Page 689 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.33 GPRS QoS Enumeration Value for GPRS_TRANSFER_DELAY Name
Value
Description
10MS
1
10 ms
20MS
2
20 ms
30MS
3
30 ms
40MS
4
40 ms
50MS
5
50 ms
60MS
6
60 ms
70MS
7
70 ms
80MS
8
80 ms
90MS
9
90 ms
100MS
10
100 ms
110MS
11
110 ms
120MS
12
120 ms
130MS
13
130 ms
140MS
14
140 ms
150MS
15
150 ms
200MS
16
200 ms
250MS
17
250 ms
300MS
18
300 ms
350MS
19
350 ms
400MS
20
400 ms
450MS
21
450 ms
500MS
22
500 ms
550MS
23
550 ms
600MS
24
600 ms
650MS
25
650 ms
700MS
26
700 ms
750MS
27
750 ms
800MS
28
800 ms
All rights reserved.
Page 690 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
850MS
29
850 ms
900MS
30
900 ms
950MS
31
950 ms
1000MS
32
1000 ms
1100MS
33
1100 ms
1200MS
34
1200 ms
1300MS
35
1300 ms
1400MS
36
1400 ms
1500MS
37
1500 ms
1600MS
38
1600 ms
1700MS
39
1700 ms
1800MS
40
1800 ms
1900MS
41
1900 ms
2000MS
42
2000 ms
2100MS
43
2100 ms
2200MS
44
2200 ms
2300MS
45
2300 ms
2400MS
46
2400 ms
2500MS
47
2500 ms
2600MS
48
2600 ms
2700MS
49
2700 ms
2800MS
50
2800 ms
2900MS
51
2900 ms
3000MS
52
3000 ms
3100MS
53
3100 ms
3200MS
54
3200 ms
3300MS
55
3300 ms
3400MS
56
3400 ms
3500MS
57
3500 ms
3600MS
58
3600 ms
3700MS
59
3700 ms
All rights reserved.
Page 691 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
3800MS
60
3800 ms
3900MS
61
3900 ms
4000MS
62
4000 ms
10.34 Authentication Algorithm Type Enumeration Value for AUTH_ALOGRITHM Name
Value
Description
COMP128_1
1
COMP128_1 2G algorithm for SIM card
COMP128_2
2
COMP128_2 2G algorithm for SIM card
COMP128_3
3
COMP128_3 2G algorithm for SIM card
CUSTOM_1
127
CUSTOM_1 private custom-built algorithm
MILENAGE
128
Milenage 3G algorithm for SIM card or USIM card
MILENAGE_2
129
Milenage_2 3G algorithm for SIM card
XOR
5
XOR algorithm for SIM card
CAVE38
6
CAVE38 private custom-built algorithm
CUSTOM_2
7
CUSTOM_2 private custom-built algorithm
10.35 Advice of Charge Service Enumeration Value for AOC_ENU Name
Value
Description
NONE
0
No advice of charge service
AOCI
1
Advice of charge information
AOCC
2
Advice of charge charging
All rights reserved.
Page 692 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.36 CUG Intra-Restriction Enumeration Value for INTRACUG_OPTION Name
Value
Description
NO_CUGBAR
0
There is no intra-CUG call restriction. That is, the intra-CUG subscriber can originate and terminate calls.
IC_CUGBAR
1
Incoming lock of CUG calls. That is, the intra-CUG subscriber can only originate calls.
OC_CUGBAR
2
Outgoing lock of CUG calls. That is, the intra-CUG subscriber can only terminate calls.
10.37 CUG Inter-Restriction Enumeration Value for INTERCUG_RESTRICTION Name
Value
Description
ONLY_CUG
0
A subscriber can only originate calls within the CUG.
OA_CUG
1
Outgoing access. The subscriber can originate calls to a subscriber in another CUG, but cannot receive calls from a subscriber in another CUG.
IA_CUG
2
Incoming access. The subscriber can receive calls from a subscriber in another CUG, but cannot originate calls to a subscriber in another CUG.
IOA_CUG
3
Outgoing and incoming access. Subscribers in different CUGs can originate calls to or receive calls from each other.
10.38 PLMN Client Enumeration Value for PLMN_CLIENT_LIST Name
Value
Description
BROADCAST
1
Broadcast service
HPLMN
2
O-and M-HPLMN
VPLMN
4
O-and M-VPLMN
ANONYMOUS
8
Anonymous location of privacy
TARGET
16
Target MS subscribed service
All rights reserved.
Page 693 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.39 CBCODE (CB Service Code) Enumeration Name
Value
Description
BAOC
1
Barring of all outgoing calls (BAOC) supplementary service
BOIC
2
Barring of outgoing international calls (BOIC) supplementary service
BOICEXHC
3
Barring of outgoing international calls except those directed to the home PLMN country (BOIC-exHC) supplementary service
BAIC
4
Barring of all incoming calls (BAIC) supplementary service
BICROAM
5
Barring of incoming calls when roaming outside the home PLMN country (BIC-Roam) supplementary service
10.40 ODBPLMNCODE (ODBPLMN Service Code) Enumeration Name
Value
Description
ODBPB1
1
Operator determined barring of PLMN-specific barring type 1
ODBPB2
2
Operator determined barring of PLMN-specific barring type 2
ODBPB3
3
Operator determined barring of PLMN-specific barring type 3
ODBPB4
4
Operator determined barring of PLMN-specific barring type 4
10.41 PLMN-SS-CODE (PLMN Specific-SS Code) Enumeration Name
Value
Description
PLMN-SS-1
1
PLMN specific-SS 1
PLMN-SS-2
2
PLMN specific-SS 2
PLMN-SS-3
3
PLMN specific-SS 3
PLMN-SS-4
4
PLMN specific-SS 4
All rights reserved.
Page 694 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
Name
Value
Description
PLMN-SS-5
5
PLMN specific-SS 5
PLMN-SS-6
6
PLMN specific-SS 6
PLMN-SS-7
7
PLMN specific-SS 7
PLMN-SS-8
8
PLMN specific-SS 8
PLMN-SS-9
9
PLMN specific-SS 9
PLMN-SS-A
10
PLMN specific-SS 10
PLMN-SS-B
11
PLMN specific-SS 11
PLMN-SS-C
12
PLMN specific-SS 12
PLMN-SS-D
13
PLMN specific-SS 13
PLMN-SS-E
14
PLMN specific-SS 14
PLMN-SS-F
15
PLMN specific-SS 15
10.42 ODBPOS Enumeration Name
Value
Description
NOBPOS
0
The HSS9860 does not bar the PS services.
BAPOS
1
The HSS9860 bars all the PS services.
BHPLMNAPROAM
2
The HSS9860 bars PS services when subscribers are roaming in a VPLMN but still connect to the network from an access point within the HPLMN.
BALLAPROAM
3
The HSS9860 bars PS services when subscribers are roaming in a VPLMN and connect to the network from an access point within the VPLMN.
10.43 ODBPOSTYPE Enumeration Name
Value
Description
BOTH
1
Both the MS-originated and network-originated PDP context activations are valid.
MSInit
2
Only MS-originated PDP context activations are valid.
NetworkInit
3
Only network-originated PDP context activations are valid.
All rights reserved.
Page 695 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.44 DEFAULTCALL Enumeration Name
Value
Description
TS11
0
Telephony service
TS61
5
Alternate speech facsimile group 3
TS62
6
Automatic facsimile group 3
BS20
20
Data circuit duplex asynchronous (data-CDA) service
BS21
21
CDA-300 bps
BS22
22
CDA-1200 bps
BS23
23
CDA-1200-75 bps
BS24
24
CDA-2400 bps
BS25
25
CDA-4800 bps
BS26
26
CDA-9600 bps
BS30
30
Data circuit duplex synchronous (data-CDS) service
BS31
31
Data CDS-1200 bps
BS32
32
Data CDS-2400 bps
BS33
33
Data CDS-4800 bps
BS34
34
Data CDS-9600 bps
BS41
41
Asynchronous PAD access CA-300 bps
BS42
42
PAD access CA-1200 bps
BS43
43
PAD access CA-1200-75 bps
BS44
44
PAD access CA-2400 bps
BS45
45
PAD access CA-4800 bps
BS46
46
PAD access CA-9600 bps
BS51
51
Data service of PDS-2400 bps
BS52
52
Data service of PDS-4800 bps
BS53
53
Data service of PDS-9600 bps
BS61
61
Alternate speech/data service
BS81
81
Speech followed by data (can be any kind of data service)
All rights reserved.
Page 696 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.45 OPTIONTYPE (M2M Binding Operation Type)Enumeration Name
Value
Description
PROVIDE
1
Provide an IMSI-IMEI binding for a subscriber
MODIFY
2
Change the IMEI bound to an IMSI
WITHDRAW
3
Remove an IMSI-IMEI binding
DELETEIMEI
4
Remove the IMEI bound to an IMSI
10.46 GPRSOPTYPE (Operation Type of MOD OPTGPRS) Enumeration Name
Value
Description
ADDPDPCNTX
0
Add a PDP/PDN context
MODPDPCNTX
1
Modify a PDP/PDN context
RMVPDPCNTX
2
Delete a PDP/PDN context
RMVALLCNTX
3
Withdraw the GPRS service
MODGLOBALCH ARING
4
Modify the global charging characteristic
10.47 APN_TYPE (APN Type of MOD OPTGPRS) Enumeration Name
Value
Description
PS_APN
1
The APN belongs to the packet switched (PS) domain.
EPS_APN
2
The APN belongs to the evolved packet system (EPS).
BOTH
3
The APN belongs to both the PS domain and the EPS.
All rights reserved.
Page 697 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.48 PDPTYPE (Data Service Type of MOD OPTGPRS) Enumeration Name
Value
Description
X25
0
X.25 data service type
PPP
1
PPP data service type
OCSIHOSS
2
OCSIHOSS data service type
IPV4
3
IPv4 data service type
IPV6
4
IPv6 data service type
IPV4IPV6
5
IPv4 and IPv6 data service type
IPV4_OR_IPV6
6
IPv4 or IPv6 data service type
10.49 DP (DP Value) Enumeration Name
Value
Description
MO
0
The IN service is triggered when the SMS is originated.
MT
1
The IN service is triggered when the SMS is terminated.
SR
2
The IN service is triggered when the status report is delivered.
10.50 NONARD (Restriction on Non-3GPP Wireless Access) Enumeration Name
Value
Description
WLANNOTALLOWED
0
Wireless local area network is not allowed
CDMA2000_1XNOTALLOWED
1
CDMA2000_1X access network is not allowed
HRPDNOTALLOWED
2
High-speed data packet is not allowed
UMBNOTALLOWED
3
Super mobile broadband is not allowed
EHRPDNOTALLOWED
4
Extended high-speed data packet is not allowed
All rights reserved.
Page 698 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.51 MIP6FEAVEC (Mobile IP support of NONSUB) Enumeration Name
Value
Description
MIP6_INTEGRATED
1
Supports mobile IPv6 integrated scenario bootstrapping functionality
PMIP6_SUPPORTED
2
Instruct the non-3GPP GW to use PMIPv6
IP4_HOA_SUPPORTED
4
Instruct the non-3GPP GW to authorize the UE to use IPv4-HOA
ASSIGN_LOCAL_IP
8
Instruct the non-3GPP GW to assign local IP addresses to subscribers
MIP4_SUPPORTED
16
Instruct the non-3GPP GW to use MIPv4
GTPv2_SUPPORTED
32
Instruct the non-3GPP GW to use GTPv2
10.52 MSIMTYPE (GROUPSIM Type of MOD GROUPSIM) Enumeration Name
Value
Description
Sequential
3
The subscribers are alerted in sequence.
Parallel
4
The subscribers are alerted simultaneously.
Parallel_Prefered
5
The sequential ringing takes precedence over the simultaneous ringing when the MSC supports both ringing solutions. The subscribers are alerted in sequence.
10.53 TONETYPE (Tone Type of MOD GROUPSIM) Enumeration Name
Value
Description
Basic_Tone
1
The same ringback tone is played when the group members are alerted simultaneously.
Intelligent_Tone
2
The ringback tone of each group member is played when the group members are alerted simultaneously.
All rights reserved.
Page 699 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.54 CONTENT (Content of LST DYNSUB) Enumeration Name
Value
Description
ALL
0
Query all types of dynamic data
GSM
1
Query the dynamic information related to the GSM
GPRS
2
Query the dynamic information related to the GPRS
SM
3
Query the dynamic information related to the short message
ODB
4
Query the dynamic information related to the ODB
UNSP
5
Query the services that are not supported by the MSC/VLR
LCS
6
Query the dynamic information related to the LCS
ALLSM
7
Query all the dynamic information related to the short message
EPS
8
Query the dynamic information related to the EPS
10.55 DEST (Destination of SND CANCELC) Enumeration Name
Value
Description
VLR
0
Send the Cancel Location message to the VLR.
SGSN
1
Send the Cancel Location message to the Gn/Gp SGSN.
MME
3
Send the Cancel Location message to the MME.
S4SGSN
4
Send the Cancel Location message to the S4 SGSN.
AAA
5
Send the Cancel Location message to the AAA.
ALL
6
Send the Cancel Location message to the VLR, Gn/Gp SGSN, MME, S4 SGSN, and AAA at the same time.
10.56 GROUPSIMOPTYPE (Operation Type of MOD GROUPSIM) Enumeration Name
Value
Description
ADD
0
The HSS9860 provides the GROUPSIM service for a subscriber.
RMV
1
The HSS9860 withdraws the GROUPSIM service for a subscriber.
MOD
2
The HSS9860 modifies the GROUPSIM service for a subscriber.
All rights reserved.
Page 700 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Name
Value
Common EnumerationsCommon Enumerations
Description
10.57 PRIORITY_LEVEL (PRIORITY_LEVEL of MOD OPTGPRS) Enumeration Name
Value
Description
LOW
0
Low priority
HIGH
1
High priority
10.58 UserCategory (User category) Enumeration Name
Value
Description
NORMAL
0
Common user
M2M
1
M2M user
10.59 GTYPE (Multi-number user group) Enumeration Name
Value
Description
MISDN
1
Multi-MSISDN multi-profile subscriber group
EIMSI
3
LINKED SIM subscriber group
10.60 TCR (Terminating call right) Enumeration Name
Value
Description
NCALL
0
A member MSISDN cannot receive calls or short messages.
PCALL
1
A member MSISDN can receive calls or short messages.
All rights reserved.
Page 701 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.61 MSIMTYPE (Multi-SIM service type) Enumeration Name
Value
Description
ActiveByUPL
1
The HLR considers the subscriber who performs the latest location update as an activated subscriber.
ActiveByUSSD
2
The HLR considers the subscriber who conducts a USSD operation for activating itself as an activated subscriber.
10.62 CAMELTYPE (CAMEL type) Enumeration Name
Value
Description
OCSI
0
OCSI data
TCSI
1
TCSI data
Extended_Information
2
Extended CAMEL information
10.63 PROV (Operation) Enumeration Name
Value
Description
ADD
0
Add the CSI data
MOD
1
Modify the CSI data
DELETE
2
Delete the CSI data
10.64 OCSIDP (O-CSI DP value) Enumeration Name
Value
Description
COLLECTINFO
2
Collected_Info (DP2) is a point at which the dialed number is collected.
ROUTESELFAIL
4
Route_Select_Failure (DP4) is a point at which a route selection fails.
All rights reserved.
Page 702 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.65 TCSIDP (T-CSI DP value) Enumeration Name
Value
Description
TAA
12
Terminating_Attempt_Authorised (DP12) is a point at which a called subscriber attempts to be authenticated.
TBUSY
13
T_Busy (DP13) is a point at which a subscriber is found busy when the GMSC attempts to route a call to the subscriber.
TNOANSWER
14
T_No_Answer (DP14) is a point at which a called subscriber does not answer a call.
10.66 CAMEL (CAMEL phase) Enumeration Name
Value
Description
PHASE1
1
Required for the gsmSCF to process mobile originated calls or mobile terminated calls.
PHASE2
2
Required for the gsmSCF to invoke supplementary services. Phase 2 enhances the capabilities of phase1.
PHASE3
3
Required for the gsmSCF to process mobile originated short message services (MO SMS), general packet radio service (GPRS) sessions, packet data protocol (PDP) contexts, to control subscriber data in the HLR, and to control network signaling load. Phase 3 enhances the capabilities of phase 2.
PHASE4
4
Required for the gsmSCF to process mobile terminated short message services (MT SMS). Phase 4 enhances the capabilities of phase 3.
10.67 DEFCALL (Default call handling) Enumeration Name
Value
Description
continueCall
0
The gsmSCF instructs the MSC to continue a call.
releaseCall
1
The gsmSCF instructs the MSC to release a call.
All rights reserved.
Page 703 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.68 VLR_NOTSUPPHASE1 (MSC/VLR does not support CAMEL) Enumeration Name
Value
Description
AllowLocationUpdateWithMOCall
0
The HLR replies with a successful location update response message and delivers voice service data.
AllowLocationUpdateWithODBBAOC
1
The HLR replies with a successful location update response message and delivers BAOC data for all basic services.
DenyLocationUpdate
2
The HLR replies with a location update failure response.
10.69 VLR_NOTSUPPHASE2 (MSC/VLR does not support CAMEL phase2) Enumeration Name
Value
Description
ReturnLPO-CSI
0
The HLR compares the CAMEL phase supported by the MSC/VLR with the CAMEL phase configured in this template and delivers the O-CSI carrying a lower CAMEL phase.
AllowLocationUpdateWithODB BAOC
1
The HLR replies with a successful location update response message and delivers BAOC data for all basic services.
DenyLocationUpdate
2
The HLR replies with a location update failure response.
10.70 VLR_NOTSUPPHASE3 (MSC/VLR does not support CAMEL phase3) Enumeration Name
Value
Description
ReturnLPO-CSI
0
The HLR compares the CAMEL phase supported by the MSC/VLR with the CAMEL phase configured in this template and delivers the O-CSI carrying a lower CAMEL phase.
AllowLocationUpdateWithOD BBAOC
1
The HLR replies with a successful location update response message and delivers BAOC data for all basic services.
DenyLocationUpdate
2
The HLR replies with a location update failure response.
All rights reserved.
Page 704 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.71 VLR_NOTSUPPHASE4 (MSC/VLR does not support CAMEL phase4) Enumeration Name
Value
Description
ReturnLPO-CSI
0
The HLR compares the CAMEL phase supported by the MSC/VLR with the CAMEL phase configured in this template and delivers the O-CSI carrying a lower CAMEL phase.
AllowLocationUpdateWithODBBAOC
1
The HLR replies with a successful location update response message and delivers BAOC data for all basic services.
DenyLocationUpdate
2
The HLR replies with a location update failure response.
10.72 GMSC_NOTSUPPHASE1 (GMSC does not support CAMEL) Enumeration Name
Value
Description
AllowMTCall
0
The HLR delivers voice service data.
ReturnBAIC
1
The HLR delivers BAIC data for all basic services.
10.73 GMSC_NOTSUPPHASE2 (GMSC does not support CAMEL phase2) Enumeration Name
Value
Description
ReturnLP-CSI
0
The HLR compares the CAMEL phase supported by the GMSC with the CAMEL phase configured in this template and delivers the CSI data carrying a lower CAMEL phase.
AllowMTCall
1
The HLR delivers voice service data.
ReturnBAIC
2
The HLR delivers BAIC data for all basic services.
All rights reserved.
Page 705 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.74 GMSC_NOTSUPPHASE3 (GMSC does not support CAMEL phase3) Enumeration Name
Value
Description
ReturnLP-CSI
0
The HLR compares the CAMEL phase supported by the GMSC with the CAMEL phase configured in this template and delivers the CSI data carrying a lower CAMEL phase.
AllowMTCall
1
The HLR delivers voice service data.
ReturnBAIC
2
The HLR delivers BAIC data for all basic services.
10.75 VLR_NOTSUPPHASE4 (GMSC does not support CAMEL phase4) Enumeration Name
Value
Description
ReturnLPO-CSI
0
The HLR compares the CAMEL phase supported by the GMSC with the CAMEL phase configured in this template and delivers the CSI data carrying a lower CAMEL phase.
AllowLocationUpdateWith ODBBAOC
1
The HLR delivers voice service data.
DenyLocationUpdate
2
The HLR delivers BAIC data for all basic services.
10.76 AVAILABLE_PLMN (Available PLMN) Enumeration Name
Value
Description
HPLMN
0
The HLR delivers the SMS-CSI data only when the subscriber is roaming within the home Public Land Mobile Network (HPLMN).
FPLMN
1
The HLR delivers the SMS-CSI data only when the subscriber is roaming within the forbidden Public Land Mobile Network (FPLMN).
INTERNATIONAL
4
The HLR delivers the SMS-CSI data only when the subscriber is roaming outside the home country.
HPLMNC
3
The HLR delivers the SMS-CSI data only when the subscriber is roaming outside the home country.
ALL_PLMN
2
The HLR delivers the SMS-CSI data wherever the subscriber is roaming.
All rights reserved.
Page 706 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.77 SYNC (Synchronization in group) Enumeration Name
Value
Description
Denied
0
The HLR does not synchronize modifications.
Allowed
1
The HLR synchronizes modifications.
10.78 MBRSYNC (Synchronization among members) Enumeration Name
Value
Description
Denied
0
The HLR does not synchronize modifications.
Allowed
1
The HLR synchronizes modifications.
10.79 DENYUSSD (Support USSD operation of members) Enumeration Name
Value
Description
Denied
0
GROUPSIM members are only allowed to change or query its order in the group by a USSD operation.
Not_Denied
1
GROUPSIM members are allowed to change or query all members' order by USSD operations.
Not_Support
255
GROUPSIM members are not allowed to change or query other members' order by USSD operations.
10.80 MBRDC (Restrict calls terminated to Multi-SIM group members) Enumeration Name
Value
Description
Not_Denied
0
The HLR restricts the calls destined for a GROUPSIM member.
Denied
1
The HLR does not restrict the calls destined for a GROUPSIM member.
All rights reserved.
Page 707 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Common EnumerationsCommon Enumerations
10.81 MBRSMS (Restrict messages terminated to MultiSIM group members) Enumeration Name
Value
Description
Not_Denied
0
The HLR restricts the calls destined for a GROUPSIM member.
Denied
1
The HLR does not restrict the calls destined for a GROUPSIM member.
10.82 ODBPOS (ODB of packet oriented service) Enumeration Name
Value
Description
NOBPOS
0
The HSS9860 does not bar packet oriented services.
BAPOS
1
The HSS9860 bars all packet-oriented services.
BHPLMNAPROAM
2
The HSS9860 bars packet oriented services from access points that are within the HPLMN while the subscriber is roaming in a VPLMN.
BALLAPROAM
3
The HSS9860 bars packet-oriented services from access points that are within the roamed-to VPLMN.
10.83 TPLTYPE(type of the preferred roaming template) Enumeration Name
Value
Description
CS
0
CS preferred roaming template
PS
1
PS preferred roaming template
All rights reserved.
Page 708 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
11
Summary of Error Codes
Error codes can either contain RETCODE= or ERR, or contain both of them.
11.1 Effectiveness Error RETCODE
Error code
Error message
1001
ERR1001
Invalid command
1002
ERR1002
Invalid command format
1003
ERR1003
Invalid parameter name
1004
ERR1004
Invalid parameter value for
1005
ERR1005
File not found
1006
ERR1006
No rights to execute this command
1007
ERR1007
Value threshold exceeded
1008
ERR1008
Maximum number of batch operation commands exceeded
1009
ERR1009
Parameter missing. ( will be shown only when mandatory or conditional parameters are absent in command.)
1010
ERR1010
Parameter conflict
1011
ERR1011
Operator already exist
1012
ERR1012
Operator not defined
1013
ERR1013
Username or password incorrect
1014
ERR1014
Role not defined
1015
ERR1015
Role already in use
1016
ERR1016
Operator not logged in
1017
ERR1017
Invalid password
All rights reserved.
Page 709 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
1018
ERR1018
Password doesn't match
1019
ERR1019
Time out
1020
ERR1020
HDU unavailable
1021
ERR1021
SMU database access fail
1022
ERR1022
Batch Command /Query Command inside the batch file is not allowed
1023
ERR1023
Unable to transfer the batch file
1024
ERR1024
Maximum number of commands allowed for the batch operation exceeded
1025
ERR1025
Invalid format in batch file
1026
ERR1026
End parameter should be bigger/later than begin parameter
1027
ERR1027
Password is null
1028
ERR1028
Invalid date format
1029
ERR1029
Accessible number range not defined
1030
ERR1030
No such batch operation
1031
ERR1031
Number range already exists
1032
ERR1032
Saveas file already exists
1033
ERR1033
Number threshold exceeded
1034
ERR1034
Unmatched HLR serial number
1037
ERR1037
The record already exists
1038
ERR1038
The record does not exist
1060
ERR1060
Default admin operator can not be deleted/modified
1062
ERR1062
Maximum clients are connected. No more connection
1063
ERR1063
Default role can not be assigned to others
1070
ERR1070
The operator is not activated
1077
ERR1077
The password does not meet the complexity requirement
1078
ERR1078
The number of login attempts with the incorrect password exceeds that of the allowed attempts, and the account is locked
1079
ERR1079
The user's current operation is beyond time limit
1080
ERR1080
The password expired
1107
ERR1107
Database access failed
1145
ERR1145
The partition information about the subscriber cannot be obtained
1157
ERR1157
The number of login attempts with the incorrect username or password exceeds,
All rights reserved.
Page 710 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
RETCODE
Error code
Summary of Error CodesSummary of Error Codes
Error message and the accout is locked
11.2 Execution Error RETCODE
Error code
Error message
3000
ERR3000
HDU internal error
3001
ERR3001
Subscriber not defined
3002
ERR3002
Subscriber already exists
3003
ERR3003
Template not defined
3004
ERR3004
Template already exists
3005
ERR3005
Template already in use
3006
ERR3006
Record already exists
3007
ERR3007
Record not defined
3008
ERR3008
Bearer capability alias not defined
3009
ERR3009
Bearer capability alias already exists
3010
ERR3010
Incompatible bearer capability for data service
3011
ERR3011
PDP data not defined
3012
ERR3012
DP data not defined
3013
ERR3013
K4 serial number not defined
3014
ERR3014
Ki already in use
3015
ERR3015
Service not provisioned
3016
ERR3016
Basic service not provisioned
3017
ERR3017
Only for master-MSISDN
3018
ERR3018
SS incompatible
3019
ERR3019
HOLD not provisioned
3020
ERR3020
ECT provisioned
3021
ERR3021
MTPY provisioned
3023
ERR3023
AOCC and AOCI incompatible
3025
ERR3025
Only for UMTS subscriber
3026
ERR3026
Only for GSM subscriber
All rights reserved.
Page 711 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
3027
ERR3027
Invalid NAM
3028
ERR3028
User locked
3029
ERR3029
Subscriber applied barring
3032
ERR3032
FTN incompatible with OFA template
3033
ERR3033
FTN same as MSISDN
3034
ERR3034
Forbidden FTN
3035
ERR3035
Invalid FTN
3036
ERR3036
HDU database access failed
3037
ERR3037
Database updated but network update failure. Indication: operator should send cancellocation
3038
ERR3038
Network update failure
3039
ERR3039
Invalid batch file format
3040
ERR3040
Batch file not found
3041
ERR3041
Maximum number of batch operation tasks exceeded
3042
ERR3042
Reset is already going on
3043
ERR3043
OP in use
3044
ERR3044
Invalid parameter value
3045
ERR3045
Conditional parameter missing
3046
ERR3046
Time out
3047
ERR3047
Maximum limitation exceeded
3048
ERR3048
KI not loaded
3049
ERR3049
New IMSI same as old, please change it by loading KI
3050
ERR3050
New IMSI in use
3051
ERR3051
New ISDN in use
3052
ERR3052
K4 in use
3053
ERR3053
ODB conflict
3055
ERR3055
CallWaiting provisioned
3056
ERR3056
LCS parameter values conflict
3057
ERR3057
The preferential CUG is invalid
3058
ERR3058
The BSG is invalid
3059
ERR3059
The CUG index is used
All rights reserved.
Page 712 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
3060
ERR3060
The BSG is not in any CUG
3061
ERR3061
Unmatchable card type
3062
ERR3062
Invalid card type
3063
ERR3063
Statistic task already exists
3064
ERR3064
Same criteria exists in the detection point
3065
ERR3065
Invalid criteria for the detection point
3066
ERR3066
NAM and NLRInd conflicting
3067
ERR3067
Database updated but network update failure for NLR. Suggestion: Delete GSM/GPRS location information in previous GSM HLR.
3068
ERR3068
Service conflict with NLR
3069
ERR3069
OP serial number not defined
3088
ERR3088
FTN has not been registered
3090
ERR3090
Overlapping between the new one and the old ones
3092
ERR3092
Unmatched HLR serial number
3094
ERR3094
FTP service has not been provided
3095
ERR3095
FTP User cannot log in
3096
ERR3096
Template could not be empty
3097
ERR3097
HLR serial number not defined
3098
ERR3098
The data to be verified is different from that in the HLR database
3099
ERR3099
MAP version in NCC configuration could not be higher than that in system MAP configuration
3100
ERR3100
Database updated but network update failure. And HLR is re-updating network once
3110
ERR3110
Record can not be modified to be empty
3111
ERR3111
Function not supported
3115
ERR3115
COR in use
3116
ERR3116
CORs of subscriber and remote party do not match
3117
ERR3117
FFNAddress not allowed to change
3118
ERR3118
Unknown remote party
3119
ERR3119
Unknown initiating party
3120
ERR3120
Request own MSISDN not allowed
3122
ERR3122
Remote party already registered to an initiating subscriber
All rights reserved.
Page 713 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
3123
ERR3123
Remote party authorization failed
3124
ERR3124
Call barred
3125
ERR3125
Service conflict
3126
ERR3126
Initiating subscriber not reachable
3128
ERR3128
Camel parameter values conflict
3129
ERR3129
Parameters of COR for subscriber cannot exceed five
3130
ERR3130
Record already exists
3131
ERR3131
Record not defined
3132
ERR3132
Support for MAPV2
3133
ERR3133
COR not subscribed
3136
ERR3136
The number of defined subscribers reaches the maximum License capacity of the HLR
3137
ERR3137
The number of OCSI subscribers reaches the maximum License capacity of the HLR
3138
ERR3138
The number of TCSI subscribers reaches the maximum License capacity of the HLR
3139
ERR3139
The number of subscribers in the HLRSN reaches the maximum License capacity of the HLR
3140
ERR3140
The total number of subscribers defined in the HLR reaches the maximum License capacity of the HLR
3141
ERR3141
Remote party is not a subscriber of the local HLR
3164
ERR3164
The ODBIC of the subscriber is locked, and it cannot be modified
3165
ERR3165
The ODBOC of the subscriber is locked, and it cannot be modified
3166
ERR3166
The OCSI template ID is not defined
3167
ERR3167
The TCSI template ID is not defined
3168
ERR3168
The VTCSI template ID is not defined
3169
ERR3169
The UCSI template ID is not defined
3170
ERR3170
The SSCSI template ID is not defined
3171
ERR3171
The MCSI template ID is not defined
3172
ERR3172
The MOSMSCSI template ID is not defined
3173
ERR3173
The MTSMSCSI template ID is not defined
3174
ERR3174
The GPRSCSI template ID is not defined
3175
ERR3175
The DCSI template ID is not defined
All rights reserved.
Page 714 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
3176
ERR3176
Global template data being loaded from the DS. HDU cannot handle other messages for the moment
3177
ERR3177
Data consistency check of subscriber fail
3178
ERR3178
Number of static subscribers exceeds the maximum
3179
ERR3179
Number of dynamic subscribers exceeds the maximum
3180
ERR3180
Number of OCSI subscribers exceeds the maximum
3181
ERR3181
Number of TCSI subscribers exceeds the maximum
3183
ERR3183
Insufficient DB space
3184
ERR3184
Number of Subscribers exceeds the limitation of DB
3185
ERR3185
SMF resources restricted
3186
ERR3186
NBRUSER conflicted with NBRSB
3187
ERR3187
Provided with the SMSCF service. TS2X cannot be withdrawn
3188
ERR3188
The subscriber is absent
3189
ERR3189
The operation through the MS fails
3190
ERR3190
MSC does not support ISTCommand
3191
ERR3191
IMSI and MSISDN SITE mismatched
3192
ERR3192
Remote DRU not found
3193
ERR3193
Local DRU not found
3194
ERR3194
IMSI or MSISDN Key Prefix not found
3196
ERR3196
Parameters conflict
3197
ERR3197
Pivotal parameters already exists
3198
ERR3198
The ContextId does not exist
3210
ERR3210
Does not support ACC
3211
ERR3211
PLMNSS Conflict With ACC
3212
ERR3212
PLMNSS1 Conflict with ACC Code
3213
ERR3213
PLMNSS2 Conflict with ACC Code
3214
ERR3197
Pivotal parameters already exists
3198
ERR3198
The ContextId does not exist
3210
ERR3210
Does not support ACC
3211
ERR3211
PLMNSS Conflict With ACC
3212
ERR3212
PLMNSS1 Conflict with ACC Code
All rights reserved.
Page 715 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
3213
ERR3213
PLMNSS2 Conflict with ACC Code
3214
ERR3214
PLMNSS3 Conflict with ACC Code
3215
ERR3215
PLMNSS4 Conflict with ACC Code
3216
ERR3216
PLMNSS5 Conflict with ACC Code
3217
ERR3217
PLMNSS6 Conflict with ACC Code
3218
ERR3218
PLMNSS7 Conflict with ACC Code
3219
ERR3219
PLMNSS8 Conflict with ACC Code
3220
ERR3220
PLMNSS9 Conflict with ACC Code
3221
ERR3221
PLMNSSA Conflict with ACC Code
3222
ERR3222
PLMNSSB Conflict with ACC Code
3223
ERR3223
PLMNSSC Conflict with ACC Code
3224
ERR3224
PLMNSSD Conflict with ACC Code
3225
ERR3225
PLMNSSE Conflict with ACC Code
3226
ERR3226
PLMNSSF Conflict with ACC Code
3227
ERR3227
Call index repeat
3228
ERR3228
Assigned SMS card does not exist
3229
ERR3229
Assigned VOBB card does not exist
3230
ERR3230
KI not in the same site
3231
ERR3231
The auxiliary IMSI is already in use
3232
ERR3232
IMSI parameter repeat
3233
ERR3233
Modifying SMS Card for OneLive is not allowed
3234
ERR3234
The number of MPTY subscribers reaches the maximum License capacity of the HLR
3235
ERR3235
The number of LCS subscribers reaches the maximum License capacity of the HLR
3236
ERR3236
The number of RBT subscribers reaches the maximum License capacity of the HLR
3237
ERR3237
The number of EMLPP subscribers reaches the maximum License capacity of the HLR
3238
ERR3238
The number of ECT subscribers reaches the maximum License capacity of the HLR
3239
ERR3239
The number of PLMNSS subscribers reaches the maximum License capacity of the HLR
All rights reserved.
Page 716 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
3240
ERR3240
The number of 3G subscribers reaches the maximum License capacity of the HLR
3241
ERR3241
The number of MIMSI subscribers reaches the maximum License capacity of the HLR
3242
ERR3242
The number of ACC subscribers reaches the maximum License capacity of the HLR
3243
ERR3243
The user's data is Incomplete
3244
ERR3244
The number of loaded KIs exceeds the maximum
3246
ERR3246
The number of CCBS subscribers reaches the maximum License capacity of the HLR
3247
ERR3247
Subscriber type not matched
3248
ERR3248
Cannot modify the MSISDN associated with the main IMSI
3249
ERR3249
MSISDN not provided
3250
ERR3250
Not support auxiliary IMSIs
3251
ERR3251
Not support the main MSISDN
3256
ERR3256
Initiating Number not registered
3263
ERR3263
The record is not unique
3264
ERR3264
CLIP not provisioned
3267
ERR3267
PLMNSS Conflict With ACR
3278
ERR3278
Expiry Date is invalid
3279
ERR3279
Standby IMSI not exit
4000
ERR4000
AMF in use
4001
ERR4001
AMF serial number not defined
4003
ERR4003
The subscriber has registered a same type of remote party
3281
ERR3281
Not Support Sms Route
3282
ERR3282
The input RN is in conflict with local RN
3283
ERR3283
Updating Location fails. You must manually send Update Location
3284
ERR3284
Acquiring IMSI fails. You must manually send Update Location
3285
ERR3285
Number of NP Donor subscribers reaches the maximum License capacity
3286
ERR3286
Number of NP Recipient subscribers in Other PLM reaches the maximum License capacity
3301
ERR3301
Number of SMSROUTE subscribers exceeds the maximum
3330
ERR3330
Forbid modifying MSISDN of the subscriber used for COMMON ISDN
All rights reserved.
Page 717 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
3303
ERR3303
The Key not encrypt, please check and input again
3331
ERR3331
Forbid removing the subcriber used for COMMON ISDN
3332
ERR3332
Forbid activating MSISDN of ALS
3333
ERR3333
Forbid activating MSISDN of VVDN
3335
ERR3335
Forbid removing the primary subscriber in a Multi-SIM group
3340
ERR3340
The number of IMEIBIND subscribers reaches the maximum License capacity of the HLR
3343
ERR3343
PLMNSS6 Conflict with CA service
3344
ERR3344
The template does not contain EPS subscription data
3345
ERR3345
The number of EGR subscribers exceeds the maximum
3346
ERR3346
Multi-SIM Subscriber Group does not exist
3349
ERR3349
MEMBERISDN parameter repeat
3350
ERR3350
The Sms activation isdn must be a member isdn
3351
ERR3351
The Voice activation isdn must be a member isdn
4009
ERR4009
Number of LINKSIM subscribers exceeds the maximum
4010
ERR4010
Number of M2M static subscribers exceeds the maximum
4011
ERR4011
Number of M2M dynamic subscribers exceeds the maximum
3360
ERR3360
K7 serial number not defined
3076
ERR3076
Request own MSISDN not possible
3269
ERR3269
A group member associated with multiple profiles cannot be deleted independently
3270
ERR3270
The group does not exist
3271
ERR3271
The number of group members exceeds the maximum
3272
ERR3272
The group member number cannot be a special number
3273
ERR3273
The group member must be defined
3274
ERR3274
A number can belong to only one group
3275
ERR3275
The entered number is not a group pilot number
3276
ERR3276
The group member number cannot be a special number
3277
ERR3277
Sending Cancelocation fails during active number change. You must manually send Cancelocation
3336
ERR3336
COMISDN number is not the primary subscriber in a Multi-SIM group
3337
ERR3337
Forbid deactivating the primary subscriber in a Multi-SIM group
All rights reserved.
Page 718 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
3338
ERR3338
Forbid modifying MSISDN of the primary subscriber used for Multi-SIM
3353
ERR3353
Forbid modifying the order of the primary subscriber in a Multi-SIM group
3354
ERR3354
Forbid removing an auxiliary subscriber in a Multi-SIM group
3355
ERR3355
The MMS activation isdn must be a member isdn
3356
ERR3356
The LCS activation isdn must be a member isdn
3357
ERR3357
Updating a group MSISDN's data succeeds but updating a GROUPSIM member's data fails
3358
ERR3358
K2 serial number not defined
3375
ERR3375
The operation failed because the HSM is unreachable
3376
ERR3376
This command can be executed only on a convergent site
3380
ERR3380
Unmatched Partition ID
3381
ERR3381
The total number of IMS subscribers defined in the HLR has reached the license threshold
3382
ERR3382
The number of IMS subscribers with the HLRSN has reached the license threshold
3383
ERR3383
The subscriber is not Non-3GPP or not defined
3800
ERR3800
The wildcard APN cannot be used as the default APN of a subscriber.
3801
ERR3801
The first APN of an EPS subscriber cannot be a wildcard APN.
3802
ERR3802
The default APN of a subscriber cannot be deleted.
3803
ERR3803
The APNs that have been defined for a subscriber cannot be changed to a nondefault APN.
3804
ERR3804
The parameter value can not be same.
3805
ERR3805
The PS APN can not be specified as default APN.
3806
ERR3806
Paramter APN_TYPE and PDPTYPE conflict.
3807
ERR3807
The paramter APN_TYPE can not be modified.
3808
ERR3808
The subscriber is not registered.
3810
ERR3810
The subscriber is not EPS or not defined.
3812
ERR3812
There is no UE level AMBR data for EPS subscriber.
3813
ERR3813
The number of EPS subscribers reaches the maximum License capacity of the HLR
3814
ERR3814
Operation not allowed by the security policy
3815
ERR3815
The Subscriber is an EPS subscriber
3900
ERR3900
Writing the message to the resending queue successfully.
All rights reserved.
Page 719 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
3901
ERR3901
The message is successfully resent.
3902
ERR3902
Writing the message to the resending queue fails.
3903
ERR3903
Resending the message fails because the queue is full.
3904
ERR3904
Resending the message fails because the resending times have exceeded the threshold.
3905
ERR3905
The message resending function is disabled. The message does not need to be resent.
3906
ERR3906
The UDCD function is disabled. The message does not need to be resent.
3907
ERR3907
Resending the message fails because message construction failed.
3908
ERR3908
The message is invalid and does not need to be resent.
3909
ERR3909
The message conflicts with another message in the queue and does not need to be resent.
4052
ERR4052
Home HLRSN must be specified
4053
ERR4053
An M2M Common MSISDN cannot be set for a non-M2M subscriber
4054
ERR4054
Service Conflict. The subscriber has subscribed to the MSISDN-Less service
4055
ERR4055
Service Conflict. The subscriber has subscribed to the M2M Common MSISDN service
4056
ERR4056
Service Conflict. The subscriber has subscribed to the Multi-IMSI service.
4057
ERR4057
Service Conflict. The subscriber has subscribed to the Multi-SIM service.
4058
ERR4058
Service Conflict. The subscriber has subscribed to the COMISDN service.
4059
ERR4059
Service Conflict. The subscriber has subscribed to the GROUPSIM service.
4060
ERR4060
Service Conflict. The subscriber has subscribed to the multi-MSISDN multiprofile service.
4061
ERR4061
Service Conflict. The subscriber has subscribed to the ALS service.
4062
ERR4062
Service Conflict. The subscriber has subscribed to the FM service.
4063
ERR4063
Service conflict. The IMSI and MSISDN are the same
4064
ERR4064
Service Conflict. The subscriber has subscribed to the Home Zone service
4065
ERR4065
Forwarded-to number and Property of FTN cannot be specified for the current forwarding mode
4066
ERR4066
Service types for the same main MSISDN are different.
4067
ERR4067
The default roaming restriction rule is RESTRICT. Run SET DEFHLRRR to modify the default roaming restriction rule to PERMISSION or run RMV HLRRR with CHKDFT set to FALSE
4068
ERR4068
Partition ID is invalid
All rights reserved.
Page 720 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
4071
ERR4071
Number of MAP Address Restriction subscribers exceeds the maximum
4072
ERR4072
Registering EPS services fails. The subscriber's MSISDN is on the EPS service blacklist
4073
ERR4073
Changing the EPS subscriber's MSISDN fails. The new MSISDN is on the EPS service blacklist
4074
ERR4074
If the MSISDN specified does not exist in the HSS, the HSS cannot distribute the subscriber to a service partition based on the license balancing policy in the one-logical deployment
4078
ERR4078
Auto-provisioning notification timeout
4079
ERR4079
Auto-provisioning notification failure
900001007
ERR900001007
The value is invalid.
900001008
ERR900001008
Parameter is not specified.
900001009
ERR900001009
Parameter conflict
900001016
ERR900001016
The sub-element number of %s exceeds the maximum number.
900001019
ERR900001019
The sub-elements are repeated in the %s
900005001
ERR900005001
System failure
900003025
ERR900003025
The OP serial number does not exist
900003028
ERR900003028
The AMF serial number does not exist
900003034
ERR900003034
The K4 serial number does not exist
900003052
ERR900003052
The new subscription already exists
900003057
ERR900003057
The New IMPI is already allocated to another subscription
900003059
ERR900003059
The value to be specified for the New IMPU is already used by an IMPU or PUSI
900003061
ERR900003061
The new MSISDN already exists
900003051
ERR900003051
The subscription does not exist
900003058
ERR900003058
The IMPI does not exist
900003060
ERR900003060
The IMPU does not exist
900003062
ERR900003062
The MSISDN does not exist
900003001
ERR900003001
The user does not exist
900003007
ERR900003007
The IMPUs, IMPIs, and MSISDNs do not belong to the same subscription.
900003050
ERR900003050
The IMPU and the IMPI are not associated
900003063
ERR900003063
The number of IMPIs in the subscription already reaches the maximum
900003064
ERR900003064
The number of IMPUs in the subscription already reaches the maximum
All rights reserved.
Page 721 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
900003065
ERR900003065
The number of MSISDNs associated with the IMSI already reaches the maximum
900003046
ERR900003046
Only one IMPI exists in the subscription. The IMPU cannot be set to a shared IMPU
900003053
ERR900003053
The IMPU does not belong to the IRS
900003066
ERR900003066
The IRSIDs of IMPUs in the IMPU list are not the same
900003015
ERR900003015
The IMPIs that the IMPUs are associated with are not the same
900003016
ERR900003016
The roaming template IDs of the IMPUs are not the same
900003017
ERR900003017
The registration authorities of the IMPUs are not the same
900003020
ERR900003020
The IFC of the specified priority does not exist
900003021
ERR900003021
The number of IFCs already reaches the maximum
900003023
ERR900003023
Priority conflict
900003054
ERR900003054
The number of S-CSCFs in the capability set already reaches the maximum
900003055
ERR900003055
The S-CSCF already exists in the capability set
900003056
ERR900003056
The S-CSCF does not exist in the capability set
900003024
ERR900003024
The service profiles of the IMPUs in the IMPU list are not shared
900003049
ERR900003049
The service profiles associated with the IMPI already reaches the maximum
900003047
ERR900003047
The user is not registered
90000369
ERR900003069
The IMPU is the default IMPU of an IRS
900003070
ERR900003070
The default IMPU cannot be barred
900003072
ERR900003072
The user name supporting the Digest authentication already exists
900003074
ERR900003074
Invalid IRS ID
900003077
ERR900003077
The number of IMPUs in a new IRS is insufficient
900003078
ERR900003078
The capabilities in the mandatory capability set conflict with those in the optional capability set
900003089
ERR900003089
The PISI already exists
900003090
ERR900003090
The value to be specified for the PUSI is already used by a PUSI or IMPU
900003091
ERR900003091
The PISI does not exist
900003092
ERR900003092
The PUSI does not exist
900003095
ERR900003095
The PUSIs do not belong to the same PSI
900003096
ERR900003096
The IRS IDs of PUSIs in the PUSI list are not the same
900003097
ERR900003097
The number of PUSIs in a new IRS is insufficient
All rights reserved.
Page 722 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
900003098
ERR900003098
The PUSI format does not match with PUSITYPE
900003099
ERR900003099
The IMPI is already allocated to another subscription
900003100
ERR900003100
The value to be specified for the IMPU is already used by an IMPU or PUSI.
900003101
ERR900003101
The number of PUSIs of a PSI user reaches the maximum
900003102
ERR900003102
The PUSI to be deleted is the last one
900003104
ERR900003104
The IMPI is not associated with any IMPU
900003105
ERR900003105
The number of PUSIs in an IRS exceeds the maximum number
900003112
ERR900003112
The new IMSI already exists
900003113
ERR900003113
The IMSI does not exist
900003114
ERR900003114
The IMPI is already associated with another IMSI
900003115
ERR900003115
The IMPI is not associated with the IMSI
900003117
ERR900003117
The association between IMPI and IMSI does not exist
900003118
ERR900003118
The IMPI does not support the HTTP Digest authentication scheme
900003120
ERR900003120
The IMSI is already associated with another IMPI
900003121
ERR900003121
The IMPI does not support the Early IMS security
900003123
ERR900003123
The IMPI already supports the AKA scheme
900003124
ERR900003124
The IMPI already supports the HTTP Digest authentication scheme
900003125
ERR900003125
The IMPI does not support the AKA scheme
900003126
ERR900003126
Authentication information does not exist
900003127
ERR900003127
The IMPI supports only one authentication scheme
900003128
ERR900003128
The association already exists
900003131
ERR900003131
Capability ID 0 stands for invalid capability, and it cannot be set together with other capability IDs
900003132
ERR900003132
The user name does not exist
900003133
ERR900003133
The line ID index of the IMPI already exists.
900003134
ERR900003134
The line ID index of the IMPI does not exist
900003135
ERR900003135
The IMPI does not support the NBA scheme
900003137
ERR900003137
The OPC K4 index does not exist
900003138
ERR900003138
The line ID of the IMPI already exists
900003139
ERR900003150
The new PUSI type conflicts with the existing PUSI type
900003155
ERR900003155
The HSS ID does not exist
All rights reserved.
Page 723 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
900003173
ERR900003173
The IMPU template ID does not exist
900003179
ERR900003179
The NASS access address already exists
900003180
ERR900003180
The number of NASS access addresses in the NASS access template already reaches the maximum
900003182
ERR900003182
The reference location index of the IMPU does not exist
900003183
ERR900003183
The reference location index of the IMPU already exists
900003185
ERR900003185
The number of IMPIs supporting the EIA authentication exceeds the upper threshold of License
900003187
ERR900003187
The number of IMPIs supporting the EAA authentication exceeds the upper threshold of License
900003188
ERR900003188
The PUSIs and PISI do not belong to the same subscription
900003190
ERR900003190
The IMPUs do not belong to the same IRS
900003191
ERR900003191
The IMPUs do not share the same service profile
900003192
ERR900003192
The alias IDs of IMPUs in the IMPU list are not the same
900003193
ERR900003193
The number of IMPUs specified for the new alias ID is insufficient
900003194
ERR900003194
Invalid alias ID
900003195
ERR900003195
Invalid sequence number
900003196
ERR900003196
Invalid REPDATA format
900003197
ERR900003197
The Repository Data of specified service indication does not exist
900003198
ERR900003198
The number of repository data records in the IMPU or PUSI already reaches the maximum
900003200
ERR900003200
The number of IMPIs supporting the NBA authentication exceeds the upper threshold of License
900003202
ERR900003202
The number of IMPIs supporting the AKA authentication exceeds the upper threshold of License
900003204
ERR900003204
The number of IMPIs supporting the Digest authentication exceeds the upper threshold of License
900003206
ERR900003206
The number of IMS subscribers exceeds the upper threshold of License
900003208
ERR900003208
The number of SLF subscribers exceeds the upper threshold of License
900003209
ERR900003209
The number of SLF subscribers exceeds the default upper threshold of License
900003216
ERR900003216
The License does not support the NBA authentication scheme
900003217
ERR900003217
The License does not support the AKA authentication scheme
900003218
ERR900003218
The License does not support the SIP Digest authentication scheme
All rights reserved.
Page 724 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
900003219
ERR900003219
The License does not support IMS subscribers
900003220
ERR900003220
The License does not support SLF subscribers
900003231
ERR900003231
The capability template ID already exists
900003232
ERR900003232
The service profile template ID already exists
900003233
ERR900003233
The iFC template ID already exists
900003234
ERR900003234
The AKA authentication template ID already exists
900003236
ERR900003236
The NASS access template already exists
900003238
ERR900003238
The PUSI template ID does not exist
900003239
ERR900003239
The capability template ID does not exist
900003240
ERR900003240
The service profile template ID does not exist
900003241
ERR900003241
The iFC template ID does not exist
900003242
ERR900003242
The AKA authentication template ID does not exist
900003243
ERR900003243
The charging template ID does not exist
900003244
ERR900003244
The NASS access template does not exist
900003245
ERR900003245
The visited template ID does not exist
900003246
ERR900003246
The specified IMPU does not belong to alias IMPUs
900003249
ERR900003249
This is the last NASS access address and cannot be deleted. A NASS access template must contain at least one record
900003250
ERR900003250
The length of Repository Data exceeds the max Limitation
900003251
ERR900003251
The IMPU is one of Alias IMPUs
900003252
ERR900003252
The default NNRLI cannot be removed when there are more than one NNRLI
900003253
ERR900003253
The UserID format does not match with USERIDTYPE
900003254
ERR900003254
Priority conflict in iFC template list
900003257
ERR900003257
No matching result is found
900003263
ERR900003263
The IMPI associated with the IMSI is not defined
900003264
ERR900003264
The MSISDN and the IMSI belong to the same subscription, but they do not match with each other
900003265
ERR900003265
The O-CSI template ID does not exist
900003266
ERR900003266
The T-CSI template ID does not exist
900003268
ERR900003268
Different types of CSIs must be provided to the same MSISDN associated with the IMSI
900003269
ERR900003269
The values of vncflag fields of the IMPUs in the IMPU list are inconsistent
All rights reserved.
Page 725 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
900003270
ERR900003270
The IMPI associated with the IMSI already supports EAA,EIA or CAVEAKA
900003271
ERR900003271
The IMPI is not defined
900003275
ERR900003275
The number of IMPIs supporting the TAA authentication exceeds the upper threshold of License
900003279
ERR900003279
The value to be specified for the IMPI is already used by a PISI
900003280
ERR900003280
The value to be specified for the PISI is already used by an IMPI
900003281
ERR900003281
The value to be specified for the IMPI is already used by an IMPI or PISI
900003282
ERR900003282
The value to be specified for the PISI is already used by a PISI or IMPI
900003283
ERR900003283
The IMSI already exists
900003284
ERR900003284
The MSISDN already exists
900003285
ERR900003285
The loose route indication of the IMPUs are not the same
900003286
ERR900003286
The IMPU format does not match with IMPU type
900003288
ERR900003288
The IMPI already supports the SIP Digest authentication scheme
900003289
ERR900003289
The IMPI does not support the SIP Digest authentication scheme
900003287
ERR900003287
The IMPU is not associated with the specified shared iFC
900003291
ERR900003291
The SiFC template ID does not exist
900003292
ERR900003292
The IMPU already associate with the specified shared iFC
900003295
ERR900003295
The number of shared iFC sets assigned to an IMPU or PUSI reaches the maximum
900003296
ERR900003296
The one key information of IMPU does not exist
900003298
ERR900003298
The IMPU is not associated with the specified iFC
900003299
ERR900003299
Invalid IMPI format, only IMPI derived from IMSI is allowed
900003301
ERR900003301
UIMID must exist when CAVEAKAFLG is True
900003302
ERR900003302
The IMPI associated with the IMSI already supports EAA or EIA
900003303
ERR900003303
The IMPI does not support the Cave AKA authentication scheme
900003305
ERR900003305
The number of IMPIs supporting the CAVEAKA authentication exceeds the upper threshold of License
900003307
ERR900003307
The I-U pairs exceed the Maximun
900003400
ERR900003400
The IMPU does not exist or no matching result is found
900003401
ERR900003401
The visited template ID or the visited network address does not exist
900003402
ERR900003402
The SiFC template ID or the IFC of the specified priority does not exist or no matching result is found
900003403
ERR900003403
The IMPI or PISI does not exist or the IMPI is not defined
All rights reserved.
Page 726 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
900003404
ERR900003404
The IMPU or PUSI does not exist or a service provider ID is already set for the user
900003405
ERR900003405
The IMPU or PUSI does not exist or the user is not associated with the specified shared iFC
900003406
ERR900003406
Data to be verified is different from that in the database
900003407
ERR900003407
The IMPU is not associated with the visited network template
900003408
ERR900003408
The IMPU is not associated with the subscribed media profile ID
900003409
ERR900003409
The subscription or PISI does not exist or no matching result is found
900003410
ERR900003410
The IMPU or PUSI does not exist or no matching result is found
900003411
ERR900003411
The IMPU is not associated with the NASS access template
900003412
ERR900003412
The IMPU or the reference location index of the IMPU does not exist or no matching result is found
900003413
ERR900003413
The IMPU or the reference location index of the IMPU does not exist
900003415
ERR900003415
Database updated but network update failure
900003416
ERR900003416
The NASS access template or the NASS access address does not exist
900003308
ERR900003308
The extended service data already exist
900003309
ERR900003309
The extended service data does not exist
900003310
ERR900003310
The extended service data is decrypted failed
900003311
ERR900003311
The value of location information is invalid
900003312
ERR900003312
SYSNO does not match HLR serial number of KI data
900003420
ERR900003420
The IMPU or PUSI already associate with the specified shared iFC
900003422
ERR900003422
The USERTYPE of IMPU or PUSI is different from that in the database
900003423
ERR900003423
The IMPU or PUSI is not associated with the specified shared iFC
900003426
ERR900003426
The number of records reaches the maximum
900003427
ERR900003427
The number of wildcard IMPU or PUSI records reaches the maximum
900003428
ERR900003428
The wildcard IMPU or PUSI overlaps with an existing wildcard IMPU or PUSI
900003429
ERR900003429
ENDIP must be higher than or equal to BEGINIP for the address of the NASS nomadism template
900003430
ERR900003430
IP address segments of the NASS nomadism template conflict
900003476
ERR900003431
The parameter used to specify the NASS nomadism address is inconsistent with MATCHTYPE in the NASS nomadism template
All rights reserved.
Page 727 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
900003432
ERR900003432
The number of PSI subscribers exceeds the upper threshold of License
900003434
ERR900003434
Not allowed to modify MATCHTYPE from IPsegment to Back or Front
900003435
ERR900003435
Several NASS nomadism templates have identical names. Please use template IDs to identify the templates
900003440
ERR900003440
Database updated but network update failure because of system error
900003441
ERR900003441
Database updated but network update failure because of subscriber data error
900003442
ERR900003442
The barred IMPU could not be found in IMPULIST
900003443
ERR900003443
The IMPI2 is already allocated to another subscription
900003444
ERR900003444
The value to be specified for the IMPI2 is already used by a PISI
900003445
ERR900003445
The IMPI2 is not defined but have authentication data
900003446
ERR900003446
The IMPI2 is not defined but associated with the IMSI
900003447
ERR900003447
The IMSI2 already exists
900003448
ERR900003448
The MSISDN2 already exists
900003449
ERR900003449
The user name2 supporting the Digest authentication already exists
900003450
ERR900003450
The IMPI is not defined but have authentication data
900003451
ERR900003451
The IMPI is not defined but associated with the IMSI
900003454
ERR900003454
The IMPI does not exist or the IMPI is not defined or the GSID of the IMPI does not exist
900003455
ERR900003455
The GSID of the IMPI already exists
900003463
ERR900003463
The new IMPI already exists
900003464
ERR900003464
The new IMPI2 already exists
900003465
ERR900003465
The value to be specified for the New IMPU2 is already used by an IMPU or PUSI
900003466
ERR900003466
The IMSI or MSISDN is not associated with any IMPI or the IMPI is not defined
900003467
ERR900003467
The MSISDN does not exist or is not associated with the IMSI
900003468
ERR900003468
The Password of digest does not exist
900003469
ERR900003469
The SPID does not exist
900003470
ERR900003470
This command cannot be executed because RCS service already exists
900003471
ERR900003471
The RCS service already exists
900003472
ERR900003472
The RCS service not exists
900003473
ERR900003473
The associated subscriber is not defined
900003474
ERR900003474
The length of wildcard record prefix is less than the route prefix length
All rights reserved.
Page 728 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
RETCODE
Error code
Summary of Error CodesSummary of Error Codes
Error message configured
900003475
ERR900003475
The route prefix length is not configured
900003476
ERR900003476
Incorrect repository data type
900003477
ERR900003477
The auxiliary subscriber must be a VoLTE or VoWiFi subscriber
900003478
ERR900003478
IMPUs associated with the main card do not belong to any IRS
900003479
ERR900003479
IMPUs associated with the main card do not belong to any alias set
900003480
ERR900003480
IMPUs associated with the main card do not share any service profile
900003481
ERR900003481
IMPUs associated with the main card do not belong to the same IRS
900003482
ERR900003482
IMPUs associated with the main card do not belong to the same alias set
900003483
ERR900003483
IMPUs associated with the main card do not share the same service profile
900003484
ERR900003484
PECF and PCCF addresses cannot be simultaneously removed from a charging template
900003485
ERR900003485
The authentication status of synchronized CS domain repository data cannot be changed
900003486
ERR900003486
Either a PECF or PCCF address must exist in the charging template
900003487
ERR900003487
The partition information about the subscriber cannot be obtained in IMSHSS
900003488
ERR900003488
The command output exceeds the maximum length allowed
900003489
ERR900003489
The password length does not meet password strength requirements
900003490
ERR900003490
The password cannot contain a user name
900003491
ERR900003491
The password cannot contain an incremental sequence of 3 or more consecutive numbers or letters
900003492
ERR900003492
The characters contained in the password do not meet password strength requirements
900003493
ERR900003493
The AS ID already exists
900003494
ERR900003494
The host name already exists
900003495
ERR900003495
The AS information does not exist
900003496
ERR900003496
The number of AS records has reached the maximum limit
900003497
ERR900003497
Authentication information of IMPI2 does not exist
900003498
ERR900003498
Other authentication schemes have been provided for the IMPI
900003499
ERR900003499
Other authentication schemes have been provided for IMPI2
900003500
ERR900003500
ADD HHSSSUB failed to add a convergent 2G/3G/4G subscriber to use AKA for authenticating IMPI
All rights reserved.
Page 729 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Summary of Error CodesSummary of Error Codes
RETCODE
Error code
Error message
900003501
ERR900003501
ADD HHSSSUB failed to add a convergent 2G/3G/4G subscriber to use AKA for authenticating IMPI2
900003514
ERR900003514
A process is still running, please try later.
11.3 System Error RETCODE
Error code
Error message
5001
ERR5001
Internal error
5002
ERR5002
Flow control enabled
5003
ERR5003
HLR serial number not defined
5006
ERR5006
Command can not be allow to execute in this station
All rights reserved.
Page 730 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Abbreviations:Abbreviations:
12
Abbreviations:
Abbreviations
Full spelling
MML
Man-machine language
HLR
Home location register
OMC
Operation & maintenance center
OAM
Operation, administration & maintenance
HDU
HLR database unit
PGW
Provision gateway
FTP
File Transfer Protocol
CLI
Client
OFFICE
Office
LOK
Lock UI
RECON
Reconnect
PRO
Process
PAR
Parameter
GEN
Generative
AoCC
Advice of charge charging
AoCI
Advice of charge information
AuC
Authentication center
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
All rights reserved.
Page 731 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Abbreviations:Abbreviations:
Abbreviations
Full spelling
BOIC-exHC
Barring of outgoing international calls except those directed to the home PLMN country
CB
Call barring
CF
Call forwarding
CFB
Call forwarding on mobile subscriber busy
CFNRc
Call forwarding on mobile subscriber not reachable
CFNRy
Call forwarding on no reply
CFU
Call forwarding unconditional
CLIP
Calling line identification presentation
CLIR
Calling line identification restriction
COLP
Connected line identification presentation
COLR
Connected line identification restriction
CW
Call waiting
ECT
Explicit call transfer
GMSC
Gateway mobile-services switching center
GPRS
General packet radio service
GSM
Global System for Mobile Communications
HOLD
Call hold
IMSI
International mobile subscriber identity
ISDN
integrated Services digital network
LCS
Location service
MPTY
MultiParty (Multi Party)
MSC
Mobile switching center
MSISDN
Mobile station international ISDN number
MSRN
Mobile station roaming number
RSZI
Regional Subscription Zone Identity
PGW
Provisioning Gateway
USSD
Unstructured supplementary service data
VLR
Visitor location register
VMSC
Visited mobile switching center
WPA
Wi-Fi Protected Access
All rights reserved.
Page 732 of 787
HUAWEI HSS9860 V900R010C00 PGW MML Command Protocol
Abbreviations:Abbreviations:
Abbreviations
Full spelling
VBS
Voice broadcast service
VGCS
Voice group call service
RBT
Ring back tone
VVDN
Voice & Videophone Dual Number
ARD
Access restriction data
CARP
CS allocation/retention priority
ALS
Alternative line service
EMLPP
Enhanced multi-level precedence and pre-emption
ECATEGORY
Enhanced category
NRBT
National ring back tone
ACR
Anonymous call rejection
GSMR
Global System for Mobile Communications Railway
IMPU
IP multimedia public identity
PISI
Private service identity
PUSI
Public service identity
AS
Application server
IMPI
IP multimedia private identity
All rights reserved.
Page 733 of 787