https://ss7api.null.ro/api.php?action=feedcontributions&feedformat=atom&user=Oana 2026-04-27T17:49:59Z User contributions MediaWiki 1.20.2 https://ss7api.null.ro/index.php/Cx/Dx 2022-03-10T14:28:19Z

<p>Oana: /* LocationInfo command */</p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt;<br /> Application id: 16777216&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with CSCF/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;<br /> <br /> == UserAuthorization Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot; code=&quot;600&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot; code=&quot;637&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=emergency-register&lt;/dictionary_bits&gt;<br /> &lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;6578616d706c652e636f6d&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;register&lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot;&gt;emergency-register&lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot; code=&quot;603&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot; code=&quot;604&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot; code=&quot;605&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> Example:<br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot;&gt;0&lt;/MandatoryCaps&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot;&gt;0&lt;/OptionalCaps&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> <br /> == ServerAssignment Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot; code=&quot;614&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=none 1=register 2=re-register 3=unregistered-user 4=timeout-unregister 5=unregistered 6=timeout-unregister-store-server 7=unregistered-store-server 8=admin-unregister 9=noauth 10=auth-timeout 11=unregister-too-much-data 12=aaa-user-data-request 13=pgw-update 14=restoration&lt;/dictionary&gt;<br /> &lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot; code=&quot;624&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot; code=&quot;648&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot; code=&quot;650&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot;&gt;register&lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot;&gt;true&lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot;&gt;false&lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot;&gt;0&lt;/SessionPriority&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot; code=&quot;606&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot; code=&quot;618&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot; code=&quot;619&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot; code=&quot;620&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;621&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;622&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot; code=&quot;638&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot; code=&quot;647&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot; code=&quot;652&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot;&gt;&lt;IMSSubscription/&gt;&lt;/UserData&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryEventChargingFN&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryEventChargingFN&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryChargingCollectionFN&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryChargingCollectionFN&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot;&gt;true&lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot;&gt;true&lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> == LocationInfo Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;LocationInfoRequest appid=&quot;16777216&quot; code=&quot;302&quot; shortName=&quot;LIR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginatingRequest vendor=&quot;10415&quot; code=&quot;633&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot; code=&quot;650&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/LocationInfoRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;LocationInfoRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;OriginatingRequest vendor=&quot;10415&quot;&gt;0&lt;/OriginatingRequest&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;unregister&lt;/UserAuthzType&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot;&gt;0&lt;/SessionPriority&gt;<br /> &lt;/LocationInfoRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;LocationInfoAnswer appid=&quot;16777216&quot; code=&quot;302&quot; shortName=&quot;LIA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot; code=&quot;603&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot; code=&quot;604&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot; code=&quot;605&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LIAFlags vendor=&quot;10415&quot; code=&quot;653&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=psi-direct-routing&lt;/dictionary_bits&gt;<br /> &lt;/LIAFlags&gt;<br /> &lt;/LocationInfoAnswer&gt;<br /> <br /> <br /> Example:<br /> <br /> &lt;LocationInfoAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot;&gt;0&lt;/MandatoryCaps&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot;&gt;0&lt;/OptionalCaps&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;LIAFlags vendor=&quot;10415&quot;&gt;psi-direct-routing&lt;/LIAFlags&gt;<br /> &lt;/LocationInfoAnswer&gt;<br /> <br /> == MultimediaAuth Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;<br /> <br /> <br /> == RegistrationTermination Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> &lt;RegistrationTerminationRequest appid=&quot;16777216&quot; code=&quot;304&quot; shortName=&quot;RTR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;DeregistrationReason vendor=&quot;10415&quot; code=&quot;615&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;ReasonCode vendor=&quot;10415&quot; code=&quot;616&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=permanent 1=new-server-assigned 2=server-change 3=remove-s-cscf&lt;/dictionary&gt;<br /> &lt;/ReasonCode&gt;<br /> &lt;ReasonInfo vendor=&quot;10415&quot; code=&quot;617&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/DeregistrationReason&gt;<br /> &lt;/RegistrationTerminationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;RegistrationTerminationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;DeregistrationReason vendor=&quot;10415&quot;&gt;<br /> &lt;ReasonCode vendor=&quot;10415&quot;&gt;server-change&lt;/ReasonCode&gt;<br /> &lt;ReasonInfo vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ReasonInfo&gt;<br /> &lt;/DeregistrationReason&gt;<br /> &lt;/RegistrationTerminationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema: <br /> <br /> &lt;RegistrationTerminationAnswer appid=&quot;16777216&quot; code=&quot;304&quot; shortName=&quot;RTA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;IdentityWithEmergencyReg vendor=&quot;10415&quot; code=&quot;651&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/IdentityWithEmergencyReg&gt;<br /> &lt;/RegistrationTerminationAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;RegistrationTerminationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;IdentityWithEmergencyReg vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;/IdentityWithEmergencyReg&gt;<br /> &lt;/RegistrationTerminationAnswer&gt;<br /> <br /> <br /> == PushProfile Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;PushProfileRequest appid=&quot;16777216&quot; code=&quot;305&quot; shortName=&quot;PPR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot; code=&quot;606&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot; code=&quot;618&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot; code=&quot;619&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot; code=&quot;620&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;621&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;622&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/PushProfileRequest&gt;<br /> <br /> <br /> Example:<br /> <br /> &lt;PushProfileRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot;&gt;&lt;IMSSubscription/&gt;&lt;/UserData&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryEventChargingFN&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryEventChargingFN&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryChargingCollectionFN&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryChargingCollectionFN&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/PushProfileRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;PushProfileAnswer appid=&quot;16777216&quot; code=&quot;305&quot; shortName=&quot;PPA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;/PushProfileAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;PushProfileAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;/PushProfileAnswer&gt;</div>

Oana https://ss7api.null.ro/index.php/Cx/Dx 2022-03-10T14:28:04Z

<p>Oana: /* Answer */</p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt;<br /> Application id: 16777216&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with CSCF/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;<br /> <br /> == UserAuthorization Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot; code=&quot;600&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot; code=&quot;637&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=emergency-register&lt;/dictionary_bits&gt;<br /> &lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;6578616d706c652e636f6d&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;register&lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot;&gt;emergency-register&lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot; code=&quot;603&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot; code=&quot;604&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot; code=&quot;605&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> Example:<br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot;&gt;0&lt;/MandatoryCaps&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot;&gt;0&lt;/OptionalCaps&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> <br /> == ServerAssignment Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot; code=&quot;614&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=none 1=register 2=re-register 3=unregistered-user 4=timeout-unregister 5=unregistered 6=timeout-unregister-store-server 7=unregistered-store-server 8=admin-unregister 9=noauth 10=auth-timeout 11=unregister-too-much-data 12=aaa-user-data-request 13=pgw-update 14=restoration&lt;/dictionary&gt;<br /> &lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot; code=&quot;624&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot; code=&quot;648&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot; code=&quot;650&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot;&gt;register&lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot;&gt;true&lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot;&gt;false&lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot;&gt;0&lt;/SessionPriority&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot; code=&quot;606&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot; code=&quot;618&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot; code=&quot;619&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot; code=&quot;620&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;621&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;622&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot; code=&quot;638&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot; code=&quot;647&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot; code=&quot;652&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot;&gt;&lt;IMSSubscription/&gt;&lt;/UserData&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryEventChargingFN&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryEventChargingFN&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryChargingCollectionFN&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryChargingCollectionFN&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot;&gt;true&lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot;&gt;true&lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> == LocationInfo command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;LocationInfoRequest appid=&quot;16777216&quot; code=&quot;302&quot; shortName=&quot;LIR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginatingRequest vendor=&quot;10415&quot; code=&quot;633&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot; code=&quot;650&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/LocationInfoRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;LocationInfoRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;OriginatingRequest vendor=&quot;10415&quot;&gt;0&lt;/OriginatingRequest&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;unregister&lt;/UserAuthzType&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot;&gt;0&lt;/SessionPriority&gt;<br /> &lt;/LocationInfoRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;LocationInfoAnswer appid=&quot;16777216&quot; code=&quot;302&quot; shortName=&quot;LIA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot; code=&quot;603&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot; code=&quot;604&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot; code=&quot;605&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LIAFlags vendor=&quot;10415&quot; code=&quot;653&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=psi-direct-routing&lt;/dictionary_bits&gt;<br /> &lt;/LIAFlags&gt;<br /> &lt;/LocationInfoAnswer&gt;<br /> <br /> <br /> Example:<br /> <br /> &lt;LocationInfoAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot;&gt;0&lt;/MandatoryCaps&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot;&gt;0&lt;/OptionalCaps&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;LIAFlags vendor=&quot;10415&quot;&gt;psi-direct-routing&lt;/LIAFlags&gt;<br /> &lt;/LocationInfoAnswer&gt;<br /> <br /> == MultimediaAuth Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;<br /> <br /> <br /> == RegistrationTermination Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> &lt;RegistrationTerminationRequest appid=&quot;16777216&quot; code=&quot;304&quot; shortName=&quot;RTR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;DeregistrationReason vendor=&quot;10415&quot; code=&quot;615&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;ReasonCode vendor=&quot;10415&quot; code=&quot;616&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=permanent 1=new-server-assigned 2=server-change 3=remove-s-cscf&lt;/dictionary&gt;<br /> &lt;/ReasonCode&gt;<br /> &lt;ReasonInfo vendor=&quot;10415&quot; code=&quot;617&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/DeregistrationReason&gt;<br /> &lt;/RegistrationTerminationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;RegistrationTerminationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;DeregistrationReason vendor=&quot;10415&quot;&gt;<br /> &lt;ReasonCode vendor=&quot;10415&quot;&gt;server-change&lt;/ReasonCode&gt;<br /> &lt;ReasonInfo vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ReasonInfo&gt;<br /> &lt;/DeregistrationReason&gt;<br /> &lt;/RegistrationTerminationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema: <br /> <br /> &lt;RegistrationTerminationAnswer appid=&quot;16777216&quot; code=&quot;304&quot; shortName=&quot;RTA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;IdentityWithEmergencyReg vendor=&quot;10415&quot; code=&quot;651&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/IdentityWithEmergencyReg&gt;<br /> &lt;/RegistrationTerminationAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;RegistrationTerminationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;IdentityWithEmergencyReg vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;/IdentityWithEmergencyReg&gt;<br /> &lt;/RegistrationTerminationAnswer&gt;<br /> <br /> <br /> == PushProfile Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;PushProfileRequest appid=&quot;16777216&quot; code=&quot;305&quot; shortName=&quot;PPR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot; code=&quot;606&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot; code=&quot;618&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot; code=&quot;619&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot; code=&quot;620&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;621&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;622&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/PushProfileRequest&gt;<br /> <br /> <br /> Example:<br /> <br /> &lt;PushProfileRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot;&gt;&lt;IMSSubscription/&gt;&lt;/UserData&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryEventChargingFN&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryEventChargingFN&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryChargingCollectionFN&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryChargingCollectionFN&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/PushProfileRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;PushProfileAnswer appid=&quot;16777216&quot; code=&quot;305&quot; shortName=&quot;PPA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;/PushProfileAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;PushProfileAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;/PushProfileAnswer&gt;</div>

Oana https://ss7api.null.ro/index.php/Cx/Dx 2022-03-10T14:22:50Z

<p>Oana: /* Answer */</p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt;<br /> Application id: 16777216&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with CSCF/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;<br /> <br /> == UserAuthorization Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot; code=&quot;600&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot; code=&quot;637&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=emergency-register&lt;/dictionary_bits&gt;<br /> &lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;6578616d706c652e636f6d&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;register&lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot;&gt;emergency-register&lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot; code=&quot;603&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot; code=&quot;604&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot; code=&quot;605&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> Example:<br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot;&gt;0&lt;/MandatoryCaps&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot;&gt;0&lt;/OptionalCaps&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> <br /> == ServerAssignment Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot; code=&quot;614&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=none 1=register 2=re-register 3=unregistered-user 4=timeout-unregister 5=unregistered 6=timeout-unregister-store-server 7=unregistered-store-server 8=admin-unregister 9=noauth 10=auth-timeout 11=unregister-too-much-data 12=aaa-user-data-request 13=pgw-update 14=restoration&lt;/dictionary&gt;<br /> &lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot; code=&quot;624&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot; code=&quot;648&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot; code=&quot;650&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot;&gt;register&lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot;&gt;true&lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot;&gt;false&lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot;&gt;0&lt;/SessionPriority&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot; code=&quot;606&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot; code=&quot;618&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot; code=&quot;619&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot; code=&quot;620&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;621&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;622&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot; code=&quot;638&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot; code=&quot;647&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot; code=&quot;652&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot;&gt;&lt;IMSSubscription/&gt;&lt;/UserData&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryEventChargingFN&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryEventChargingFN&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryChargingCollectionFN&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryChargingCollectionFN&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot;&gt;true&lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot;&gt;true&lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> <br /> == MultimediaAuth Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;<br /> <br /> <br /> == RegistrationTermination Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> &lt;RegistrationTerminationRequest appid=&quot;16777216&quot; code=&quot;304&quot; shortName=&quot;RTR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;DeregistrationReason vendor=&quot;10415&quot; code=&quot;615&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;ReasonCode vendor=&quot;10415&quot; code=&quot;616&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=permanent 1=new-server-assigned 2=server-change 3=remove-s-cscf&lt;/dictionary&gt;<br /> &lt;/ReasonCode&gt;<br /> &lt;ReasonInfo vendor=&quot;10415&quot; code=&quot;617&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/DeregistrationReason&gt;<br /> &lt;/RegistrationTerminationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;RegistrationTerminationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;DeregistrationReason vendor=&quot;10415&quot;&gt;<br /> &lt;ReasonCode vendor=&quot;10415&quot;&gt;server-change&lt;/ReasonCode&gt;<br /> &lt;ReasonInfo vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ReasonInfo&gt;<br /> &lt;/DeregistrationReason&gt;<br /> &lt;/RegistrationTerminationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema: <br /> <br /> &lt;RegistrationTerminationAnswer appid=&quot;16777216&quot; code=&quot;304&quot; shortName=&quot;RTA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;IdentityWithEmergencyReg vendor=&quot;10415&quot; code=&quot;651&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/IdentityWithEmergencyReg&gt;<br /> &lt;/RegistrationTerminationAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;RegistrationTerminationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;IdentityWithEmergencyReg vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;/IdentityWithEmergencyReg&gt;<br /> &lt;/RegistrationTerminationAnswer&gt;<br /> <br /> <br /> == PushProfile Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;PushProfileRequest appid=&quot;16777216&quot; code=&quot;305&quot; shortName=&quot;PPR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot; code=&quot;606&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot; code=&quot;618&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot; code=&quot;619&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot; code=&quot;620&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;621&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;622&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/PushProfileRequest&gt;<br /> <br /> <br /> Example:<br /> <br /> &lt;PushProfileRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot;&gt;&lt;IMSSubscription/&gt;&lt;/UserData&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryEventChargingFN&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryEventChargingFN&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryChargingCollectionFN&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryChargingCollectionFN&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/PushProfileRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;PushProfileAnswer appid=&quot;16777216&quot; code=&quot;305&quot; shortName=&quot;PPA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;/PushProfileAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;PushProfileAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;/PushProfileAnswer&gt;</div>

Oana https://ss7api.null.ro/index.php/Cx/Dx 2022-03-10T14:16:44Z

<p>Oana: /* Answer */</p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt;<br /> Application id: 16777216&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with CSCF/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;<br /> <br /> == UserAuthorization Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot; code=&quot;600&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot; code=&quot;637&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=emergency-register&lt;/dictionary_bits&gt;<br /> &lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;6578616d706c652e636f6d&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;register&lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot;&gt;emergency-register&lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot; code=&quot;603&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot; code=&quot;604&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot; code=&quot;605&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> Example:<br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot;&gt;0&lt;/MandatoryCaps&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot;&gt;0&lt;/OptionalCaps&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> <br /> == ServerAssignment Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot; code=&quot;614&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=none 1=register 2=re-register 3=unregistered-user 4=timeout-unregister 5=unregistered 6=timeout-unregister-store-server 7=unregistered-store-server 8=admin-unregister 9=noauth 10=auth-timeout 11=unregister-too-much-data 12=aaa-user-data-request 13=pgw-update 14=restoration&lt;/dictionary&gt;<br /> &lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot; code=&quot;624&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot; code=&quot;648&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot; code=&quot;650&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot;&gt;register&lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot;&gt;true&lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot;&gt;false&lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot;&gt;0&lt;/SessionPriority&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot; code=&quot;606&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot; code=&quot;618&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot; code=&quot;619&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot; code=&quot;620&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;621&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;622&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot; code=&quot;638&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot; code=&quot;647&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot; code=&quot;652&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot;&gt;&lt;IMSSubscription/&gt;&lt;/UserData&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryEventChargingFN&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryEventChargingFN&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryChargingCollectionFN&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryChargingCollectionFN&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot;&gt;true&lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot;&gt;true&lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> <br /> == MultimediaAuth Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;<br /> <br /> <br /> == RegistrationTermination Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> &lt;RegistrationTerminationRequest appid=&quot;16777216&quot; code=&quot;304&quot; shortName=&quot;RTR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;DeregistrationReason vendor=&quot;10415&quot; code=&quot;615&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;ReasonCode vendor=&quot;10415&quot; code=&quot;616&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=permanent 1=new-server-assigned 2=server-change 3=remove-s-cscf&lt;/dictionary&gt;<br /> &lt;/ReasonCode&gt;<br /> &lt;ReasonInfo vendor=&quot;10415&quot; code=&quot;617&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/DeregistrationReason&gt;<br /> &lt;/RegistrationTerminationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;RegistrationTerminationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;DeregistrationReason vendor=&quot;10415&quot;&gt;<br /> &lt;ReasonCode vendor=&quot;10415&quot;&gt;server-change&lt;/ReasonCode&gt;<br /> &lt;ReasonInfo vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ReasonInfo&gt;<br /> &lt;/DeregistrationReason&gt;<br /> &lt;/RegistrationTerminationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema: <br /> <br /> &lt;RegistrationTerminationAnswer appid=&quot;16777216&quot; code=&quot;304&quot; shortName=&quot;RTA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;IdentityWithEmergencyReg vendor=&quot;10415&quot; code=&quot;651&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/IdentityWithEmergencyReg&gt;<br /> &lt;/RegistrationTerminationAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;RegistrationTerminationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;IdentityWithEmergencyReg vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;/IdentityWithEmergencyReg&gt;<br /> &lt;/RegistrationTerminationAnswer&gt;</div>

Oana https://ss7api.null.ro/index.php/Cx/Dx 2022-03-10T14:11:55Z

<p>Oana: /* Answer */</p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt;<br /> Application id: 16777216&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with CSCF/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;<br /> <br /> == UserAuthorization Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot; code=&quot;600&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot; code=&quot;637&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=emergency-register&lt;/dictionary_bits&gt;<br /> &lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;6578616d706c652e636f6d&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;register&lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot;&gt;emergency-register&lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot; code=&quot;603&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot; code=&quot;604&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot; code=&quot;605&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> Example:<br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot;&gt;0&lt;/MandatoryCaps&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot;&gt;0&lt;/OptionalCaps&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> <br /> == ServerAssignment Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot; code=&quot;614&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=none 1=register 2=re-register 3=unregistered-user 4=timeout-unregister 5=unregistered 6=timeout-unregister-store-server 7=unregistered-store-server 8=admin-unregister 9=noauth 10=auth-timeout 11=unregister-too-much-data 12=aaa-user-data-request 13=pgw-update 14=restoration&lt;/dictionary&gt;<br /> &lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot; code=&quot;624&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot; code=&quot;648&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot; code=&quot;650&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot;&gt;register&lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot;&gt;true&lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot;&gt;false&lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot;&gt;0&lt;/SessionPriority&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot; code=&quot;606&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot; code=&quot;618&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot; code=&quot;619&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot; code=&quot;620&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;621&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;622&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot; code=&quot;638&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot; code=&quot;647&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot; code=&quot;652&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot;&gt;&lt;IMSSubscription/&gt;&lt;/UserData&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryEventChargingFN&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryEventChargingFN&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryChargingCollectionFN&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryChargingCollectionFN&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot;&gt;true&lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot;&gt;true&lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> <br /> == MultimediaAuth Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/MultimediaAuthRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; code=&quot;303&quot; shortName=&quot;MAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot; code=&quot;607&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot; code=&quot;612&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot; code=&quot;613&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot; code=&quot;609&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot; code=&quot;610&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot; code=&quot;611&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot; code=&quot;625&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot; code=&quot;626&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot; code=&quot;635&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;DigestRealm code=&quot;104&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestAlgorithm code=&quot;111&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestQop code=&quot;110&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DigestHA1 code=&quot;121&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr code=&quot;8&quot; format=&quot;ipv4&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIPv6Prefix code=&quot;97&quot; format=&quot;raw&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FramedIfaceId code=&quot;96&quot; format=&quot;uint64&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot; code=&quot;500&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;<br /> <br /> Example:<br /> <br /> &lt;MultimediaAuthAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;SipNumberAuthItems vendor=&quot;10415&quot;&gt;0&lt;/SipNumberAuthItems&gt;<br /> &lt;SipAuthDataItem vendor=&quot;10415&quot;&gt;<br /> &lt;SipItemNumber vendor=&quot;10415&quot;&gt;0&lt;/SipItemNumber&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;SipAuthenticate vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthenticate&gt;<br /> &lt;SipAuthorization vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthorization&gt;<br /> &lt;SipAuthContext vendor=&quot;10415&quot;&gt;00554433aa&lt;/SipAuthContext&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;00554433aa&lt;/IntegrityKey&gt;<br /> &lt;SipDigestAuthenticate vendor=&quot;10415&quot;&gt;<br /> &lt;DigestRealm&gt;utf-8.string&lt;/DigestRealm&gt;<br /> &lt;DigestAlgorithm&gt;utf-8.string&lt;/DigestAlgorithm&gt;<br /> &lt;DigestQop&gt;utf-8.string&lt;/DigestQop&gt;<br /> &lt;DigestHA1&gt;utf-8.string&lt;/DigestHA1&gt;<br /> &lt;/SipDigestAuthenticate&gt;<br /> &lt;FramedIpAddr&gt;1.2.3.4&lt;/FramedIpAddr&gt;<br /> &lt;FramedIPv6Prefix&gt;1122554433aa22&lt;/FramedIPv6Prefix&gt;<br /> &lt;FramedIfaceId&gt;0&lt;/FramedIfaceId&gt;<br /> &lt;LineIdentifier vendor=&quot;13019&quot;&gt;00554433aa&lt;/LineIdentifier&gt;<br /> &lt;/SipAuthDataItem&gt;<br /> &lt;/MultimediaAuthAnswer&gt;</div>

Oana https://ss7api.null.ro/index.php/Cx/Dx 2022-03-10T14:06:19Z

<p>Oana: /* UserAuthorization */</p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt;<br /> Application id: 16777216&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with CSCF/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;<br /> <br /> == UserAuthorization Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot; code=&quot;600&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot; code=&quot;637&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=emergency-register&lt;/dictionary_bits&gt;<br /> &lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;6578616d706c652e636f6d&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;register&lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot;&gt;emergency-register&lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot; code=&quot;603&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot; code=&quot;604&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot; code=&quot;605&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> Example:<br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot;&gt;0&lt;/MandatoryCaps&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot;&gt;0&lt;/OptionalCaps&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> <br /> == ServerAssignment Command ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot; code=&quot;614&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=none 1=register 2=re-register 3=unregistered-user 4=timeout-unregister 5=unregistered 6=timeout-unregister-store-server 7=unregistered-store-server 8=admin-unregister 9=noauth 10=auth-timeout 11=unregister-too-much-data 12=aaa-user-data-request 13=pgw-update 14=restoration&lt;/dictionary&gt;<br /> &lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot; code=&quot;624&quot; format=&quot;enum&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot; code=&quot;648&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot; code=&quot;650&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerAssignType vendor=&quot;10415&quot;&gt;register&lt;/ServerAssignType&gt;<br /> &lt;UserDataAlreadyAvailable vendor=&quot;10415&quot;&gt;true&lt;/UserDataAlreadyAvailable&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;MultipleReg vendor=&quot;10415&quot;&gt;false&lt;/MultipleReg&gt;<br /> &lt;SessionPriority vendor=&quot;10415&quot;&gt;0&lt;/SessionPriority&gt;<br /> &lt;/ServerAssignmentRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; code=&quot;301&quot; shortName=&quot;SAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot; code=&quot;606&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot; code=&quot;618&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot; code=&quot;619&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot; code=&quot;620&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;621&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot; code=&quot;622&quot; format=&quot;diamuri&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot; code=&quot;632&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot; code=&quot;638&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot; code=&quot;639&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot; code=&quot;649&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot; code=&quot;640&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot; code=&quot;642&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot; code=&quot;643&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot; code=&quot;644&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot; code=&quot;645&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot; code=&quot;646&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Contact vendor=&quot;10415&quot; code=&quot;641&quot; format=&quot;raw&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot; code=&quot;608&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot; code=&quot;647&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot; code=&quot;634&quot; format=&quot;str&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot; code=&quot;652&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=no 1=yes&lt;/dictionary&gt;<br /> &lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;<br /> <br /> Example:<br /> &lt;ServerAssignmentAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;UserData vendor=&quot;10415&quot;&gt;&lt;IMSSubscription/&gt;&lt;/UserData&gt;<br /> &lt;ChargingInfo vendor=&quot;10415&quot;&gt;<br /> &lt;PrimaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryEventChargingFN&gt;<br /> &lt;SecondaryEventChargingFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryEventChargingFN&gt;<br /> &lt;PrimaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/PrimaryChargingCollectionFN&gt;<br /> &lt;SecondaryChargingCollectionFN vendor=&quot;10415&quot;&gt;aaa://host.example.com;transport=tcp&lt;/SecondaryChargingCollectionFN&gt;<br /> &lt;/ChargingInfo&gt;<br /> &lt;AssociatedIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedIdentities&gt;<br /> &lt;LooseRoute vendor=&quot;10415&quot;&gt;true&lt;/LooseRoute&gt;<br /> &lt;ScscfRestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;RestorationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;Path vendor=&quot;10415&quot;&gt;00554433aa&lt;/Path&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;SubscriptionInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CallIdSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/CallIdSipHdr&gt;<br /> &lt;FromSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/FromSipHdr&gt;<br /> &lt;ToSipHdr vendor=&quot;10415&quot;&gt;00554433aa&lt;/ToSipHdr&gt;<br /> &lt;RecordRoute vendor=&quot;10415&quot;&gt;00554433aa&lt;/RecordRoute&gt;<br /> &lt;Contact vendor=&quot;10415&quot;&gt;00554433aa&lt;/Contact&gt;<br /> &lt;/SubscriptionInfo&gt;<br /> &lt;/RestorationInfo&gt;<br /> &lt;SipAuthScheme vendor=&quot;10415&quot;&gt;utf-8.string&lt;/SipAuthScheme&gt;<br /> &lt;/ScscfRestorationInfo&gt;<br /> &lt;AssociatedRegisteredIdentities vendor=&quot;10415&quot;&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;/AssociatedRegisteredIdentities&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;WildcardedPublicIdentity vendor=&quot;10415&quot;&gt;utf-8.string&lt;/WildcardedPublicIdentity&gt;<br /> &lt;PriviledgedSender vendor=&quot;10415&quot;&gt;true&lt;/PriviledgedSender&gt;<br /> &lt;/ServerAssignmentAnswer&gt;</div>

Oana https://ss7api.null.ro/index.php/Cx/Dx 2022-03-10T13:57:45Z

<p>Oana: /* UserAuthorization */</p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt;<br /> Application id: 16777216&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with CSCF/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;<br /> <br /> == UserAuthorization ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot; code=&quot;600&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot; code=&quot;637&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=emergency-register&lt;/dictionary_bits&gt;<br /> &lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;6578616d706c652e636f6d&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;register&lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot;&gt;emergency-register&lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> === Answer ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAA&quot; flags=&quot;proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,need-result,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode code=&quot;268&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ExperimentalResult code=&quot;297&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ExperimentalResultCode code=&quot;298&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot; code=&quot;603&quot; format=&quot;grouped&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot; code=&quot;604&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot; code=&quot;605&quot; format=&quot;uint32&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;ServerName vendor=&quot;10415&quot; code=&quot;602&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;<br /> <br /> Example:<br /> &lt;UserAuthorizationAnswer appid=&quot;16777216&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId flags=&quot;mandatory&quot;&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState flags=&quot;mandatory&quot;&gt;${session_state}&lt;/AuthSessionState&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;ServerCaps vendor=&quot;10415&quot;&gt;<br /> &lt;MandatoryCaps vendor=&quot;10415&quot;&gt;0&lt;/MandatoryCaps&gt;<br /> &lt;OptionalCaps vendor=&quot;10415&quot;&gt;0&lt;/OptionalCaps&gt;<br /> &lt;ServerName vendor=&quot;10415&quot;&gt;utf-8.string&lt;/ServerName&gt;<br /> &lt;/ServerCaps&gt;<br /> &lt;/UserAuthorizationAnswer&gt;</div>

Oana https://ss7api.null.ro/index.php/Cx/Dx 2022-03-10T13:54:48Z

<p>Oana: </p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt;<br /> Application id: 16777216&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with CSCF/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;<br /> <br /> == UserAuthorization ==<br /> <br /> === Request ===<br /> <br /> General schema:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; code=&quot;300&quot; shortName=&quot;UAR&quot; flags=&quot;request,proxiable&quot; internal_flags=&quot;add-session-id,no-session-state,auth-app&quot; vendor=&quot;10415&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;SessionId code=&quot;263&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;fixed,required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VendorSpecificApplicationId code=&quot;260&quot; format=&quot;grouped&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot; have_unk_avps=&quot;false&quot;&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;4294967295&quot;/&gt;<br /> &lt;AcctApplicationId code=&quot;259&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;AuthApplicationId code=&quot;258&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;AuthSessionState code=&quot;277&quot; format=&quot;enum&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginHost code=&quot;264&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;OriginRealm code=&quot;296&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationHost code=&quot;293&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;DestinationRealm code=&quot;283&quot; format=&quot;diamident&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;Username code=&quot;1&quot; format=&quot;str&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot; code=&quot;628&quot; format=&quot;grouped&quot; flags_must=&quot;vendor&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;4294967295&quot; have_unk_avps=&quot;true&quot;&gt;<br /> &lt;dictionary_bits&gt;<br /> &lt;list_id_1&gt;0=sifc 1=alias 2=ims-restoration&lt;/list_id_1&gt;<br /> &lt;/dictionary_bits&gt;<br /> &lt;VendorId code=&quot;266&quot; format=&quot;uint32&quot; flags_must=&quot;mandatory&quot; flags_must_not=&quot;vendor&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureListId vendor=&quot;10415&quot; code=&quot;629&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;FeatureList vendor=&quot;10415&quot; code=&quot;630&quot; format=&quot;uint32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot; code=&quot;601&quot; format=&quot;str&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot; code=&quot;600&quot; format=&quot;raw&quot; flags_must=&quot;vendor,mandatory&quot; occurence=&quot;required&quot; minOccurs=&quot;1&quot; maxOccurs=&quot;1&quot;/&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot; code=&quot;623&quot; format=&quot;enum&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary&gt;0=register 1=unregister 2=register-and-caps&lt;/dictionary&gt;<br /> &lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot; code=&quot;637&quot; format=&quot;flags32&quot; flags_must=&quot;vendor&quot; flags_must_not=&quot;mandatory&quot; minOccurs=&quot;0&quot; maxOccurs=&quot;1&quot;&gt;<br /> &lt;dictionary_bits&gt;0=emergency-register&lt;/dictionary_bits&gt;<br /> &lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;<br /> <br /> Example:<br /> <br /> &lt;UserAuthorizationRequest appid=&quot;16777216&quot; flags=&quot;request&quot;&gt;<br /> &lt;DestinationHost&gt;destination.ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;ims.mnc001.mcc001.3gppnetwork.org&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;0010100000000001@ims.mnc001.mcc001.3gppnetwork.org&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;sifc,alias,ims-restoration&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;PublicIdentity vendor=&quot;10415&quot;&gt;tel:+882800001&lt;/PublicIdentity&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;6578616d706c652e636f6d&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;UserAuthzType vendor=&quot;10415&quot;&gt;register&lt;/UserAuthzType&gt;<br /> &lt;UARFlags vendor=&quot;10415&quot;&gt;emergency-register&lt;/UARFlags&gt;<br /> &lt;/UserAuthorizationRequest&gt;</div>

Oana https://ss7api.null.ro/index.php/Cx/Dx 2022-03-10T13:47:39Z

<p>Oana: Created page with &quot;== General == This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt; Application id: 16777216&lt;br&gt; Vendor id: 10415 '''NOTES:''': * The examples below are not ...&quot;</p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the Cx/Dx interface&lt;br&gt;<br /> Application id: 16777216&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with CSCF/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;</div>

Oana https://ss7api.null.ro/index.php/MediaWiki:Sidebar 2022-03-10T13:43:32Z

<p>Oana: </p> <hr /> <div><br /> * MAP &amp; CAMEL XML Interface<br /> ** Introduction|Introduction<br /> ** Connection|Connection<br /> ** Common features|Common features<br /> ** Transport|Transport<br /> ** Application|Application<br /> ** Components|Components<br /> ** Operation codes|Operation codes<br /> ** Error codes|Error codes<br /> ** Latency determination|Latency determination<br /> <br /> * Diameter XML Interface<br /> ** Diameter Introduction|Introduction<br /> ** Diameter Connection|Connection<br /> ** Diameter Common features|Common features<br /> ** Diameter Transport|Transport<br /> ** Diameter Commands|Commands<br /> ** Diameter Latency determination|Latency determination<br /> <br /> *MAP and CAMEL operations<br /> ** Authentication and security|Authentication and security<br /> ** HLR functions|HLR functions<br /> ** SMS functions|SMS functions<br /> ** CAMEL operations|CAMEL operations<br /> <br /> * Diameter interfaces<br /> **S6a/Sad|S6a/S6d<br /> **Cx/Dx|Cx/Dx<br /> <br /> *Examples<br /> ** CRBT logic|CRBT logic<br /> ** CAMEL proxy|CAMEL proxy<br /> ** MSC simulator|MSC simulator<br /> ** USSD GW|USSD GW<br /> ** SIM Cards|SIM Cards<br /> <br /> *Resources<br /> ** Standards|Standards<br /> <br /> * navigation<br /> ** mainpage|mainpage-description<br /> ** recentchanges-url|recentchanges<br /> <br /> * SEARCH<br /> * TOOLBOX<br /> * LANGUAGES</div>

Oana https://ss7api.null.ro/index.php/Diameter_Transport 2016-09-23T07:47:36Z

<p>Oana: </p> <hr /> <div>The transport part of the message contains parameters related to identifying a message and controlling the transmission of a Diameter message. For requests from application serves, these parameters are combined with parameters from the Diameter command to configure the handling and routing of the message.<br /> <br /> This part of the message is marked by the '''&lt;diameter/&gt;''' tag and contains information related to sending/receiving messages, but are not part of the Diameter command. <br /> <br /> These are the parameters for sending a message (bold means mandatory, italic - optional):<br /> * '''trans_id''': Unique identifier per direction used to match requests and answers and identify a certain Diameter transaction. In Diameter -&gt; TCP application direction, this is set by the YATE Diameter level and it must be returned in the answer sent by the TCP application. In the TCP application -&gt; Diameter direction, the TCP application sets it in the request and the Diameter level will return in the answer. The identifier has no required format, must be only a uniquely generated string per Diameter transaction.<br /> * '''local_node''': Identifier of the local node (${realm}/${host}) to use for sending a request from the TCP application. If not present, one must be set in ''connection.'' configuration of the listener. The one present in XML will override the configured one. <br /> * ''timeout'': setting the timeout for a request in the TCP application -&gt; Diameter direction. This allows overriding the configured Diameter timeout setting (optional). It can also be set in ''connection.'' configuration or in diameter configuration. This is in milliseconds.<br /> <br /> <br /> Example:<br /> <br /> &lt;m&gt;<br /> ...<br /> &lt;diameter&gt;<br /> &lt;timeout&gt;60000&lt;/timeout&gt;<br /> &lt;local_node&gt;example.com/hss.example.com&lt;/local_node&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> ....<br /> &lt;/m&gt;</div>

Oana https://ss7api.null.ro/index.php/Diameter_Commands 2016-09-12T08:57:55Z

<p>Oana: /* Parameters */</p> <hr /> <div>This is the main part of the message holding the data specific to each Diameter interface.<br /> <br /> The Diameter command is wrapped in a XML element marked by ''&lt;operation/&gt;'' to make it easy to find the information in the XML. The child of the ''&lt;operation/&gt;'' is an XML describing the Diameter command decoded/to be encoded. The tag of the child element is the name of the command.<br /> <br /> Each message can only contain a single Diameter command message.<br /> <br /> &lt;m&gt;<br /> .... <br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> ==Parameters==<br /> <br /> For the XML child containing the command, the following parameters appear as attributes (bold - mandatory, italic - optional)<br /> * '''appid''': Numeric identifier of the interface to which this message belongs to<br /> * ''flags'' : Diameter flags for the message. For messages on direction TCP aplication -&gt; Diameter translator, flags are optional in requests/answers(they will be added automatically by Diameter), but if they are added, they must be correctly correlated with the tag. An error answer must set flags to error.<br /> * ''hhident'': Hop-to-hop identifier. Present in messages received by an application server. When an application sends a request, the Diameter translator automatically adds it<br /> * ''eeident'': End-to-End identifier. Present in messages received by an application server. When an application sends a request, the Diameter translator automatically adds it<br /> <br /> For S6a messages, the application ID is 16777251. See [[S6a/Sad|S6a/S6d interface]].<br /> <br /> Non-base protocol Diameter AVPs must have '''vendor''' identifier set. For 3GPP AVPs this is 10415.<br /> <br /> ==Examples==<br /> <br /> * Request (HSS -&gt; MME &amp; TCP -&gt; Diameter):<br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;timeout&gt;60000&lt;/timeout&gt;<br /> &lt;local_node&gt;example.com/hss.example.com&lt;/local_node&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Answer (MME -&gt; HSS &amp; Diameter -&gt; TCP):<br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;IMSVOPSSS vendor=&quot;10415&quot;&gt;yes&lt;/IMSVOPSSS&gt;<br /> &lt;LastUEActivityTime vendor=&quot;10415&quot;&gt;12345678&lt;/LastUEActivityTime&gt;<br /> &lt;RATType vendor=&quot;10415&quot;&gt;e-utran&lt;/RATType&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;EpsUserState vendor=&quot;10415&quot;&gt;<br /> &lt;MmeUserState vendor=&quot;10415&quot;&gt;<br /> &lt;UserState vendor=&quot;10415&quot;&gt;attached-reachable-for-paging&lt;/UserState&gt;<br /> &lt;/MmeUserState&gt;<br /> &lt;/EpsUserState&gt;<br /> &lt;EpsLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;MmeLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;EutranCellGlobalIdentity vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;123456&lt;/PlmnIdentity&gt;<br /> &lt;CellIdentity&gt;1234567&lt;/CellIdentity&gt;<br /> &lt;/EutranCellGlobalIdentity&gt;<br /> &lt;GeographicalInfo vendor=&quot;10415&quot;&gt;0001020304050607&lt;/GeographicalInfo&gt;<br /> &lt;GeodeticInfo vendor=&quot;10415&quot;&gt;00010203040506070809&lt;/GeodeticInfo&gt;<br /> &lt;CurrentLocationRetrieved vendor=&quot;10415&quot;&gt;active-loc-retrieval&lt;/CurrentLocationRetrieved&gt;<br /> &lt;AgeOfLocationInfo vendor=&quot;10415&quot;&gt;7&lt;/AgeOfLocationInfo&gt;<br /> &lt;UserCsgInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CsgId vendor=&quot;10415&quot;&gt;345&lt;/CsgId&gt;<br /> &lt;CsgAccessMode vendor=&quot;10415&quot;&gt;closed&lt;/CsgAccessMode&gt;<br /> &lt;CsgMembershipInd vendor=&quot;10415&quot;&gt;yes&lt;/CsgMembershipInd&gt;<br /> &lt;/UserCsgInfo&gt;<br /> &lt;/MmeLocationInfo&gt;<br /> &lt;SgsnLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;SAI vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;12345&lt;/PlmnIdentity&gt;<br /> &lt;LAC&gt;1122&lt;/LAC&gt;<br /> &lt;SAC&gt;99&lt;/SAC&gt;<br /> &lt;/SAI&gt;<br /> &lt;/SgsnLocationInfo&gt;<br /> &lt;/EpsLocationInfo&gt;<br /> &lt;LocalTimeZone vendor=&quot;10415&quot;&gt;<br /> &lt;TimeZone vendor=&quot;10415&quot;&gt;+2&lt;/TimeZone&gt;<br /> &lt;DaylightSavingTime vendor=&quot;10415&quot;&gt;1&lt;/DaylightSavingTime&gt;<br /> &lt;/LocalTimeZone&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;/InsertSubscriberDataAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Error (local host -&gt; TCP application)<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;error&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&gt;<br /> &lt;OriginHost&gt;hss.example.com&lt;/OriginHost&gt;<br /> &lt;OriginRealm&gt;example.com&lt;/OriginRealm&gt;<br /> &lt;ResultCode&gt;3002&lt;/ResultCode&gt;<br /> &lt;ErrorMessage&gt;timeout&lt;/ErrorMessage&gt;<br /> &lt;/InsertSubscriberDataAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> * Request (MME -&gt; HSS &amp; Diameter -&gt; TCP)<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;2&quot;&gt;sms-in-mme&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;RequestedEutranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;5&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ImmediateResponsePreferred vendor=&quot;10415&quot;/&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedEutranAuthInfo&gt;<br /> &lt;RequestedUtranGeranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;3&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedUtranGeranAuthInfo&gt;<br /> &lt;VisitedPlmnId vendor=&quot;10415&quot;&gt;040100&lt;/VisitedPlmnId&gt;<br /> &lt;/AuthenticationInfoRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> * Answer (HSS -&gt; MME &amp; TCP -&gt; Diameter):<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;VendorSpecificApplicationId&gt;<br /> &lt;value vendor=&quot;10415&quot; auth=&quot;true&quot;&gt;16777251&lt;/value&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode&gt;2001&lt;/ResultCode&gt;<br /> &lt;ErrorDiagnostic vendor=&quot;10415&quot;&gt;odb-HPLMN-APN&lt;/ErrorDiagnostic&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;baoc,boic&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;AuthenticationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;EutranVector vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber vendor=&quot;10415&quot;&gt;1&lt;/ItemNumber&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;12345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;12345678&lt;/AUTN&gt;<br /> &lt;KASME vendor=&quot;10415&quot;&gt;12345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;EutranVector vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber vendor=&quot;10415&quot;&gt;2&lt;/ItemNumber&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;00345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;00345678&lt;/AUTN&gt;<br /> &lt;KASME vendor=&quot;10415&quot;&gt;00345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;UtranVector vendor=&quot;10415&quot;&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;22345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;22345678&lt;/AUTN&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;22345678&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;22345678&lt;/IntegrityKey&gt;<br /> &lt;/UtranVector&gt;<br /> &lt;GeranVector vendor=&quot;10415&quot;&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;SRES vendor=&quot;10415&quot;&gt;34567811&lt;/SRES&gt;<br /> &lt;Kc vendor=&quot;10415&quot;&gt;34567811&lt;/Kc&gt;<br /> &lt;/GeranVector&gt;<br /> &lt;/AuthenticationInfo&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Error (HSS -&gt; MME &amp; TCP -&gt; Diameter, failure, auth data not found):<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;ExperimentalResult&gt;<br /> &lt;value vendor=&quot;10415&quot;&gt;auth-data-unavailable&lt;/value&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;</div>

Oana https://ss7api.null.ro/index.php/Diameter_Commands 2016-09-12T08:53:45Z

<p>Oana: /* Examples */</p> <hr /> <div>This is the main part of the message holding the data specific to each Diameter interface.<br /> <br /> The Diameter command is wrapped in a XML element marked by ''&lt;operation/&gt;'' to make it easy to find the information in the XML. The child of the ''&lt;operation/&gt;'' is an XML describing the Diameter command decoded/to be encoded. The tag of the child element is the name of the command.<br /> <br /> Each message can only contain a single Diameter command message.<br /> <br /> &lt;m&gt;<br /> .... <br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> ==Parameters==<br /> <br /> For the XML child containing the command, the following parameters appear as attributes (bold - mandatory, italic - optional)<br /> * '''appid''': Numeric identifier of the interface to which this message belongs to<br /> * ''flags'' : Diameter flags for the message. For messages on direction TCP aplication -&gt; Diameter translator, flags are optional in requests/answers(they will be added automatically by Diameter), but if they are added, they must be correctly correlated with the tag. An error answer must set flags to error.<br /> * ''hhident'': Hop-to-hop identifier. Present in messages received by an application server. When an application sends a request, the Diameter translator automatically adds it<br /> * ''eeident'': End-to-End identifier. Present in messages received by an application server. When an application sends a request, the Diameter translator automatically adds it<br /> <br /> For S6a messages, the application ID is 16777251.<br /> <br /> Non-base protocol Diameter AVPs must have '''vendor''' identifier set. For 3GPP AVPs this is 10415.<br /> <br /> ==Examples==<br /> <br /> * Request (HSS -&gt; MME &amp; TCP -&gt; Diameter):<br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;timeout&gt;60000&lt;/timeout&gt;<br /> &lt;local_node&gt;example.com/hss.example.com&lt;/local_node&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Answer (MME -&gt; HSS &amp; Diameter -&gt; TCP):<br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;IMSVOPSSS vendor=&quot;10415&quot;&gt;yes&lt;/IMSVOPSSS&gt;<br /> &lt;LastUEActivityTime vendor=&quot;10415&quot;&gt;12345678&lt;/LastUEActivityTime&gt;<br /> &lt;RATType vendor=&quot;10415&quot;&gt;e-utran&lt;/RATType&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;EpsUserState vendor=&quot;10415&quot;&gt;<br /> &lt;MmeUserState vendor=&quot;10415&quot;&gt;<br /> &lt;UserState vendor=&quot;10415&quot;&gt;attached-reachable-for-paging&lt;/UserState&gt;<br /> &lt;/MmeUserState&gt;<br /> &lt;/EpsUserState&gt;<br /> &lt;EpsLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;MmeLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;EutranCellGlobalIdentity vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;123456&lt;/PlmnIdentity&gt;<br /> &lt;CellIdentity&gt;1234567&lt;/CellIdentity&gt;<br /> &lt;/EutranCellGlobalIdentity&gt;<br /> &lt;GeographicalInfo vendor=&quot;10415&quot;&gt;0001020304050607&lt;/GeographicalInfo&gt;<br /> &lt;GeodeticInfo vendor=&quot;10415&quot;&gt;00010203040506070809&lt;/GeodeticInfo&gt;<br /> &lt;CurrentLocationRetrieved vendor=&quot;10415&quot;&gt;active-loc-retrieval&lt;/CurrentLocationRetrieved&gt;<br /> &lt;AgeOfLocationInfo vendor=&quot;10415&quot;&gt;7&lt;/AgeOfLocationInfo&gt;<br /> &lt;UserCsgInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CsgId vendor=&quot;10415&quot;&gt;345&lt;/CsgId&gt;<br /> &lt;CsgAccessMode vendor=&quot;10415&quot;&gt;closed&lt;/CsgAccessMode&gt;<br /> &lt;CsgMembershipInd vendor=&quot;10415&quot;&gt;yes&lt;/CsgMembershipInd&gt;<br /> &lt;/UserCsgInfo&gt;<br /> &lt;/MmeLocationInfo&gt;<br /> &lt;SgsnLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;SAI vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;12345&lt;/PlmnIdentity&gt;<br /> &lt;LAC&gt;1122&lt;/LAC&gt;<br /> &lt;SAC&gt;99&lt;/SAC&gt;<br /> &lt;/SAI&gt;<br /> &lt;/SgsnLocationInfo&gt;<br /> &lt;/EpsLocationInfo&gt;<br /> &lt;LocalTimeZone vendor=&quot;10415&quot;&gt;<br /> &lt;TimeZone vendor=&quot;10415&quot;&gt;+2&lt;/TimeZone&gt;<br /> &lt;DaylightSavingTime vendor=&quot;10415&quot;&gt;1&lt;/DaylightSavingTime&gt;<br /> &lt;/LocalTimeZone&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;/InsertSubscriberDataAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Error (local host -&gt; TCP application)<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;error&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&gt;<br /> &lt;OriginHost&gt;hss.example.com&lt;/OriginHost&gt;<br /> &lt;OriginRealm&gt;example.com&lt;/OriginRealm&gt;<br /> &lt;ResultCode&gt;3002&lt;/ResultCode&gt;<br /> &lt;ErrorMessage&gt;timeout&lt;/ErrorMessage&gt;<br /> &lt;/InsertSubscriberDataAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> * Request (MME -&gt; HSS &amp; Diameter -&gt; TCP)<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;2&quot;&gt;sms-in-mme&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;RequestedEutranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;5&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ImmediateResponsePreferred vendor=&quot;10415&quot;/&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedEutranAuthInfo&gt;<br /> &lt;RequestedUtranGeranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;3&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedUtranGeranAuthInfo&gt;<br /> &lt;VisitedPlmnId vendor=&quot;10415&quot;&gt;040100&lt;/VisitedPlmnId&gt;<br /> &lt;/AuthenticationInfoRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> * Answer (HSS -&gt; MME &amp; TCP -&gt; Diameter):<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;VendorSpecificApplicationId&gt;<br /> &lt;value vendor=&quot;10415&quot; auth=&quot;true&quot;&gt;16777251&lt;/value&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode&gt;2001&lt;/ResultCode&gt;<br /> &lt;ErrorDiagnostic vendor=&quot;10415&quot;&gt;odb-HPLMN-APN&lt;/ErrorDiagnostic&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;baoc,boic&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;AuthenticationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;EutranVector vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber vendor=&quot;10415&quot;&gt;1&lt;/ItemNumber&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;12345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;12345678&lt;/AUTN&gt;<br /> &lt;KASME vendor=&quot;10415&quot;&gt;12345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;EutranVector vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber vendor=&quot;10415&quot;&gt;2&lt;/ItemNumber&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;00345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;00345678&lt;/AUTN&gt;<br /> &lt;KASME vendor=&quot;10415&quot;&gt;00345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;UtranVector vendor=&quot;10415&quot;&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;22345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;22345678&lt;/AUTN&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;22345678&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;22345678&lt;/IntegrityKey&gt;<br /> &lt;/UtranVector&gt;<br /> &lt;GeranVector vendor=&quot;10415&quot;&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;SRES vendor=&quot;10415&quot;&gt;34567811&lt;/SRES&gt;<br /> &lt;Kc vendor=&quot;10415&quot;&gt;34567811&lt;/Kc&gt;<br /> &lt;/GeranVector&gt;<br /> &lt;/AuthenticationInfo&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Error (HSS -&gt; MME &amp; TCP -&gt; Diameter, failure, auth data not found):<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;ExperimentalResult&gt;<br /> &lt;value vendor=&quot;10415&quot;&gt;auth-data-unavailable&lt;/value&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;</div>

Oana https://ss7api.null.ro/index.php/Diameter_Commands 2016-09-12T08:51:15Z

<p>Oana: /* Parameters */</p> <hr /> <div>This is the main part of the message holding the data specific to each Diameter interface.<br /> <br /> The Diameter command is wrapped in a XML element marked by ''&lt;operation/&gt;'' to make it easy to find the information in the XML. The child of the ''&lt;operation/&gt;'' is an XML describing the Diameter command decoded/to be encoded. The tag of the child element is the name of the command.<br /> <br /> Each message can only contain a single Diameter command message.<br /> <br /> &lt;m&gt;<br /> .... <br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> ==Parameters==<br /> <br /> For the XML child containing the command, the following parameters appear as attributes (bold - mandatory, italic - optional)<br /> * '''appid''': Numeric identifier of the interface to which this message belongs to<br /> * ''flags'' : Diameter flags for the message. For messages on direction TCP aplication -&gt; Diameter translator, flags are optional in requests/answers(they will be added automatically by Diameter), but if they are added, they must be correctly correlated with the tag. An error answer must set flags to error.<br /> * ''hhident'': Hop-to-hop identifier. Present in messages received by an application server. When an application sends a request, the Diameter translator automatically adds it<br /> * ''eeident'': End-to-End identifier. Present in messages received by an application server. When an application sends a request, the Diameter translator automatically adds it<br /> <br /> For S6a messages, the application ID is 16777251.<br /> <br /> Non-base protocol Diameter AVPs must have '''vendor''' identifier set. For 3GPP AVPs this is 10415.<br /> <br /> ==Examples==<br /> <br /> * Request (HSS -&gt; MME &amp; TCP -&gt; Diameter):<br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;timeout&gt;60000&lt;/timeout&gt;<br /> &lt;local_node&gt;example.com/hss.example.com&lt;/local_node&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Answer (MME -&gt; HSS):<br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;IMSVOPSSS vendor=&quot;10415&quot;&gt;yes&lt;/IMSVOPSSS&gt;<br /> &lt;LastUEActivityTime vendor=&quot;10415&quot;&gt;12345678&lt;/LastUEActivityTime&gt;<br /> &lt;RATType vendor=&quot;10415&quot;&gt;e-utran&lt;/RATType&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;EpsUserState vendor=&quot;10415&quot;&gt;<br /> &lt;MmeUserState vendor=&quot;10415&quot;&gt;<br /> &lt;UserState vendor=&quot;10415&quot;&gt;attached-reachable-for-paging&lt;/UserState&gt;<br /> &lt;/MmeUserState&gt;<br /> &lt;/EpsUserState&gt;<br /> &lt;EpsLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;MmeLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;EutranCellGlobalIdentity vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;123456&lt;/PlmnIdentity&gt;<br /> &lt;CellIdentity&gt;1234567&lt;/CellIdentity&gt;<br /> &lt;/EutranCellGlobalIdentity&gt;<br /> &lt;GeographicalInfo vendor=&quot;10415&quot;&gt;0001020304050607&lt;/GeographicalInfo&gt;<br /> &lt;GeodeticInfo vendor=&quot;10415&quot;&gt;00010203040506070809&lt;/GeodeticInfo&gt;<br /> &lt;CurrentLocationRetrieved vendor=&quot;10415&quot;&gt;active-loc-retrieval&lt;/CurrentLocationRetrieved&gt;<br /> &lt;AgeOfLocationInfo vendor=&quot;10415&quot;&gt;7&lt;/AgeOfLocationInfo&gt;<br /> &lt;UserCsgInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CsgId vendor=&quot;10415&quot;&gt;345&lt;/CsgId&gt;<br /> &lt;CsgAccessMode vendor=&quot;10415&quot;&gt;closed&lt;/CsgAccessMode&gt;<br /> &lt;CsgMembershipInd vendor=&quot;10415&quot;&gt;yes&lt;/CsgMembershipInd&gt;<br /> &lt;/UserCsgInfo&gt;<br /> &lt;/MmeLocationInfo&gt;<br /> &lt;SgsnLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;SAI vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;12345&lt;/PlmnIdentity&gt;<br /> &lt;LAC&gt;1122&lt;/LAC&gt;<br /> &lt;SAC&gt;99&lt;/SAC&gt;<br /> &lt;/SAI&gt;<br /> &lt;/SgsnLocationInfo&gt;<br /> &lt;/EpsLocationInfo&gt;<br /> &lt;LocalTimeZone vendor=&quot;10415&quot;&gt;<br /> &lt;TimeZone vendor=&quot;10415&quot;&gt;+2&lt;/TimeZone&gt;<br /> &lt;DaylightSavingTime vendor=&quot;10415&quot;&gt;1&lt;/DaylightSavingTime&gt;<br /> &lt;/LocalTimeZone&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;/InsertSubscriberDataAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Error (local host -&gt; TCP application)<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;error&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&gt;<br /> &lt;OriginHost&gt;hss.example.com&lt;/OriginHost&gt;<br /> &lt;OriginRealm&gt;example.com&lt;/OriginRealm&gt;<br /> &lt;ResultCode&gt;3002&lt;/ResultCode&gt;<br /> &lt;ErrorMessage&gt;timeout&lt;/ErrorMessage&gt;<br /> &lt;/InsertSubscriberDataAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> * Request (MME -&gt; HSS &amp; Diameter -&gt; TCP)<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;2&quot;&gt;sms-in-mme&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;RequestedEutranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;5&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ImmediateResponsePreferred vendor=&quot;10415&quot;/&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedEutranAuthInfo&gt;<br /> &lt;RequestedUtranGeranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;3&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedUtranGeranAuthInfo&gt;<br /> &lt;VisitedPlmnId vendor=&quot;10415&quot;&gt;040100&lt;/VisitedPlmnId&gt;<br /> &lt;/AuthenticationInfoRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> * Answer (HSS -&gt; MME &amp; TCP -&gt; Diameter):<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;VendorSpecificApplicationId&gt;<br /> &lt;value vendor=&quot;10415&quot; auth=&quot;true&quot;&gt;16777251&lt;/value&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode&gt;2001&lt;/ResultCode&gt;<br /> &lt;ErrorDiagnostic vendor=&quot;10415&quot;&gt;odb-HPLMN-APN&lt;/ErrorDiagnostic&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;baoc,boic&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;AuthenticationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;EutranVector vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber vendor=&quot;10415&quot;&gt;1&lt;/ItemNumber&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;12345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;12345678&lt;/AUTN&gt;<br /> &lt;KASME vendor=&quot;10415&quot;&gt;12345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;EutranVector vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber vendor=&quot;10415&quot;&gt;2&lt;/ItemNumber&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;00345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;00345678&lt;/AUTN&gt;<br /> &lt;KASME vendor=&quot;10415&quot;&gt;00345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;UtranVector vendor=&quot;10415&quot;&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;22345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;22345678&lt;/AUTN&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;22345678&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;22345678&lt;/IntegrityKey&gt;<br /> &lt;/UtranVector&gt;<br /> &lt;GeranVector vendor=&quot;10415&quot;&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;SRES vendor=&quot;10415&quot;&gt;34567811&lt;/SRES&gt;<br /> &lt;Kc vendor=&quot;10415&quot;&gt;34567811&lt;/Kc&gt;<br /> &lt;/GeranVector&gt;<br /> &lt;/AuthenticationInfo&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Error (HSS -&gt; MME &amp; TCP -&gt; Diameter, failure, auth data not found):<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;ExperimentalResult&gt;<br /> &lt;value vendor=&quot;10415&quot;&gt;auth-data-unavailable&lt;/value&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;</div>

Oana https://ss7api.null.ro/index.php/Diameter_Transport 2016-09-12T08:48:50Z

<p>Oana: </p> <hr /> <div>The transport part of the message contains parameters related to identifying a message and controlling the transmission of a Diameter message. For requests from application serves, these parameters are combined with parameters from the Diameter command to configure the handling and routing of the message.<br /> <br /> This part of the message is marked by the '''&lt;diameter/&gt;''' tag and contains information related to sending/receiving messages, but are not part of the Diameter command. <br /> <br /> These are the parameters for sending a message (bold means mandatory, italic - optional):<br /> * '''trans_id''': Unique identifier per direction used to match requests and answers and identify a certain Diameter transaction. In Diameter -&gt; TCP application direction, this is set by the YATE Diameter level and it must be returned in the answer sent by the TCP application. In the TCP application -&gt; Diameter direction, the TCP application sets it in the request and the Diameter level will return in the answer. The identifier has no required format, must be only a uniquely generated string per Diameter transaction.<br /> * '''local_node''': Identifier of the local node (${realm}/${host}) to use for sending a request from the TCP application. If not present, one must be set in ''connection.'' configuration of the listener. The one present in XML will override the configured one. <br /> * ''timeout'': setting the timeout for a request in the TCP application -&gt; Diameter direction. This allows overriding the configured Diameter timeout setting (optional). It can also be set in ''connection.'' configuration or in diameter configuration.<br /> <br /> <br /> Example:<br /> <br /> &lt;m&gt;<br /> ...<br /> &lt;diameter&gt;<br /> &lt;timeout&gt;60000&lt;/timeout&gt;<br /> &lt;local_node&gt;example.com/hss.example.com&lt;/local_node&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> ....<br /> &lt;/m&gt;</div>

Oana https://ss7api.null.ro/index.php/Diameter_Connection 2016-09-12T08:30:44Z

<p>Oana: /* Announcing capabilities */</p> <hr /> <div>The connection used for exchange of XML formatted messages is a TCP socket. As an option TLS can be used to protect the information. In that case the information on this page applies only to the unencrypted data, the certificate check and establishment of encryption are outside the scope of this page.<br /> <br /> ==Establishing the connection==<br /> <br /> A connection is established from the application to the Diameter translator. Each translator is associated with a TCP listener. Each TCP listener is associated with a certain Diameter interface. An application can establish multiple connections to the Diameter translator. Each connection is independent from the others. To establish the connection a TCP socket must be connected to the agreed listening port of the translator. Upon a successful connection XML messages exchange can start.<br /> <br /> The XML declaration &lt;?xml … ?&gt; must be present in the first exchanged message. On further messages the declaration may be omitted.<br /> <br /> All messages must have a root &lt;m&gt; element. The optional xmlns attribute must be &quot;http://yate.null.ro/xml/diameter/v1&quot; (note that the URL doesn't point to a valid location).<br /> <br /> The closing tag &lt;/m&gt; can be used to look up for the end of XML in the stream.<br /> <br /> ==Announcing capabilities==<br /> <br /> After connection on the TCP socket, the application will announce its capabilities. Otherwise, it will not be considered a valid connection for Diameter messages and it will be ignored.<br /> <br /> This initial XML message must have both an XML declaration and an xmlns in the root element indicating the correct version of the protocol is being spoken.<br /> <br /> Each supported capability will be announced in a &lt;c&gt; element placed in the root element.<br /> &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;<br /> &lt;m xmlns=&quot;http://yate.null.ro/xml/diameter/v1&quot;&gt;<br /> &lt;c&gt;HSSMobility&lt;/c&gt;<br /> &lt;c&gt;MMEMobility&lt;/c&gt;<br /> ...<br /> &lt;/m&gt;<br /> <br /> On success the translator will confirm and indicate the application is active (receives messages):<br /> &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;<br /> &lt;m xmlns=&quot;http://yate.null.ro/xml/diameter/v1&quot;&gt;<br /> &lt;state&gt;active&lt;/state&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> On failure the converter may return an error text and will close the socket after that. In case of XML error or xmlns mismatch no error is returned.<br /> &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;<br /> &lt;m xmlns=&quot;http://yate.null.ro/xml/tcap/v1&quot;&gt;<br /> &lt;state&gt;inactive&lt;/state&gt;<br /> &lt;error&gt;Unsupported: Charging&lt;/error&gt;<br /> &lt;/m&gt;<br /> <br /> For S6a interface, the capabilities are organized by the entity that can handle the requests. Capability - operations associations are: <br /> * HSSMobility : UpdateLocationRequest, UpdateLocationAnswer, PurgeUERequest, PurgeUEAnswer, NotifyRequest, NotifyAnswer<br /> * MMEMobility :CancelLocationRequest, CancelLocationAnswer, InsertSubscriberDataRequest, InsertSubscriberDataAnswer, DeleteSubscriberDataRequest, DeleteSubscriberDataAnswer, ResetRequest, ResetAnswer<br /> * HSSAuthentication : AuthenticationInfoRequest, AuthenticationInfoAnswer<br /> <br /> ==Generating and processing Diameter messages==<br /> <br /> While in active state, the application will receive XML Diameter-specific formatted messages for handling. It can also send messages, either as an answer to a previous incoming request or to generate a new outbound request.<br /> <br /> ==Preparing shutdown==<br /> <br /> <br /> When an application wishes to stop processing it should indicate to the translator to stop delivering messages for new requests/sessions. Messages for currently running requests will still be delivered.<br /> <br /> This is done by indicating lack of all capabilities in an empty &lt;c/&gt; element:<br /> &lt;m&gt;<br /> &lt;c/&gt;<br /> &lt;/m&gt;<br /> <br /> The converter will not answer at once, instead it will continue to deliver messages for existing requests/sessions. Eventually these requests will dry up and the new state will be applied:<br /> &lt;m&gt;<br /> &lt;state&gt;inactive&lt;/state&gt;<br /> &lt;/m&gt;<br /> <br /> At this point it is safe to close the socket.</div>

Oana https://ss7api.null.ro/index.php/S6a/Sad 2016-09-09T14:44:08Z

<p>Oana: Created page with &quot;== General == This page shows as examples Diameter XMLs for the S6a/S6d interface (3GPP MME/SGSN to HSS interface)&lt;br&gt; Application id: 16777251&lt;br&gt; Vendor id: 10415 '''NOTES...&quot;</p> <hr /> <div>== General ==<br /> <br /> This page shows as examples Diameter XMLs for the S6a/S6d interface (3GPP MME/SGSN to HSS interface)&lt;br&gt;<br /> Application id: 16777251&lt;br&gt;<br /> Vendor id: 10415<br /> <br /> '''NOTES:''':<br /> * The examples below are not consistent with MME/SGSN/HSS functionality. Their parameters are present here to be seen.<br /> * In the following examples a ''${str}'' means its value must be reflected from received message. E.g. ''${hhident}'' must be set from received message ''hhident'' parameter.&lt;br&gt;<br /> <br /> == Update Location Command ==<br /> <br /> Direction: MME/SGSN -&gt; HSS&lt;br&gt;<br /> <br /> Request:<br /> <br /> &lt;UpdateLocationRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;1&quot;&gt;0x03&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;2&quot;&gt;sms-in-mme&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;TerminalInfo vendor=&quot;10415&quot;&gt;<br /> &lt;IMEI vendor=&quot;10415&quot;&gt;1234567890&lt;/IMEI&gt;<br /> &lt;/TerminalInfo&gt;<br /> &lt;RATType vendor=&quot;10415&quot;&gt;e-utran&lt;/RATType&gt;<br /> &lt;ULRFlags vendor=&quot;10415&quot;&gt;s6a&lt;/ULRFlags&gt;<br /> &lt;UESRVCCCapability vendor=&quot;10415&quot;&gt;yes&lt;/UESRVCCCapability&gt;<br /> &lt;VisitedPlmnId vendor=&quot;10415&quot;&gt;040100&lt;/VisitedPlmnId&gt;<br /> &lt;SgsnNumber vendor=&quot;10415&quot;&gt;123&lt;/SgsnNumber&gt;<br /> &lt;HSoIMSVOPSS vendor=&quot;10415&quot;&gt;yes&lt;/HSoIMSVOPSS&gt;<br /> &lt;GMLCAddress vendor=&quot;10415&quot;&gt;192.168.168.12&lt;/GMLCAddress&gt;<br /> &lt;ActiveAPN vendor=&quot;10415&quot;&gt;<br /> &lt;MIP6AgentInfo&gt;<br /> &lt;MIPHomeAgentAddress&gt;fe80::2&lt;/MIPHomeAgentAddress&gt;<br /> &lt;MIP6HomeLinkPrefix&gt;001122&lt;/MIP6HomeLinkPrefix&gt;<br /> &lt;/MIP6AgentInfo&gt;<br /> &lt;ContextIdentifier vendor=&quot;10415&quot;&gt;100&lt;/ContextIdentifier&gt;<br /> &lt;ServiceSelection&gt;*&lt;/ServiceSelection&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;998877&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;SpecificAPNInfo vendor=&quot;10415&quot;&gt;<br /> &lt;MIP6AgentInfo&gt;<br /> &lt;MIPHomeAgentAddress&gt;fe80::2&lt;/MIPHomeAgentAddress&gt;<br /> &lt;MIP6HomeLinkPrefix&gt;001122&lt;/MIP6HomeLinkPrefix&gt;<br /> &lt;/MIP6AgentInfo&gt;<br /> &lt;ServiceSelection&gt;*&lt;/ServiceSelection&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;001122&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;/SpecificAPNInfo&gt;<br /> &lt;/ActiveAPN&gt;<br /> &lt;EquivalentPlmnList vendor=&quot;10415&quot;&gt;<br /> &lt;VisitedPlmnId vendor=&quot;10415&quot;&gt;004001&lt;/VisitedPlmnId&gt;<br /> &lt;VisitedPlmnId vendor=&quot;10415&quot;&gt;004002&lt;/VisitedPlmnId&gt;<br /> &lt;/EquivalentPlmnList&gt;<br /> &lt;MmeNumberForMTSms vendor=&quot;10415&quot;&gt;1000&lt;/MmeNumberForMTSms&gt;<br /> &lt;SMSRegisterRequest vendor=&quot;10415&quot;&gt;no-preferrence&lt;/SMSRegisterRequest&gt;<br /> &lt;/UpdateLocationRequest&gt;<br /> <br /> Answer, success:<br /> <br /> &lt;UpdateLocationAnswer appid=&quot;${appid}&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;ULAFlags vendor=&quot;10415&quot;&gt;mme-reg-mt-sms,64&lt;/ULAFlags&gt;<br /> &lt;ErrorDiagnostic vendor=&quot;10415&quot;&gt;odb-all-apn&lt;/ErrorDiagnostic&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;1&quot;&gt;boic,baoc,regsub&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;SubscriberStatus vendor=&quot;10415&quot;&gt;serviceGranted&lt;/SubscriberStatus&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;AMSISDN vendor=&quot;10415&quot;&gt;40700100101&lt;/AMSISDN&gt;<br /> &lt;STNSR vendor=&quot;10415&quot;&gt;40700100102&lt;/STNSR&gt;<br /> &lt;ICSIndicator vendor=&quot;10415&quot;&gt;yes&lt;/ICSIndicator&gt;<br /> &lt;NetworkAccessMode vendor=&quot;10415&quot;&gt;only-packet&lt;/NetworkAccessMode&gt;<br /> &lt;OperatorDeterminedBarring vendor=&quot;10415&quot;&gt;odb-all-apn,odb-intrn-og&lt;/OperatorDeterminedBarring&gt;<br /> &lt;HPlmnODB vendor=&quot;10415&quot;&gt;type1,type3&lt;/HPlmnODB&gt;<br /> &lt;RegionalSubscriptionZoneCode vendor=&quot;10415&quot;&gt;1122330101&lt;/RegionalSubscriptionZoneCode&gt;<br /> &lt;RegionalSubscriptionZoneCode vendor=&quot;10415&quot;&gt;1122330102&lt;/RegionalSubscriptionZoneCode&gt;<br /> &lt;AccessRestrictionData vendor=&quot;10415&quot;&gt;geran,gan,i-hspa-evolution,ho-to-non-3gpp&lt;/AccessRestrictionData&gt;<br /> &lt;APNOIReplacement vendor=&quot;10415&quot;&gt;apn.example.com&lt;/APNOIReplacement&gt;<br /> &lt;LCSInfo vendor=&quot;10415&quot;&gt;<br /> &lt;GMLCNumber vendor=&quot;10415&quot;&gt;40700100000&lt;/GMLCNumber&gt;<br /> &lt;GMLCNumber vendor=&quot;10415&quot;&gt;40700100001&lt;/GMLCNumber&gt;<br /> &lt;LCSPrivacyException vendor=&quot;10415&quot;&gt;<br /> &lt;SSCode vendor=&quot;10415&quot;&gt;allLineIdentificationSS&lt;/SSCode&gt;<br /> &lt;SSStatus vendor=&quot;10415&quot;&gt;active,registered&lt;/SSStatus&gt;<br /> &lt;NotificationToUEUser vendor=&quot;10415&quot;&gt;locationNotAllowed&lt;/NotificationToUEUser&gt;<br /> &lt;ExternalClient vendor=&quot;10415&quot;&gt;<br /> &lt;ClientIdentity vendor=&quot;10415&quot;&gt;40700200000&lt;/ClientIdentity&gt;<br /> &lt;GMLCRestriction vendor=&quot;10415&quot;&gt;home-Country&lt;/GMLCRestriction&gt;<br /> &lt;NotificationToUEUser vendor=&quot;10415&quot;&gt;notifyLocationAllowed&lt;/NotificationToUEUser&gt;<br /> &lt;/ExternalClient&gt;<br /> &lt;ExternalClient vendor=&quot;10415&quot;&gt;<br /> &lt;ClientIdentity vendor=&quot;10415&quot;&gt;40700300000&lt;/ClientIdentity&gt;<br /> &lt;/ExternalClient&gt;<br /> &lt;PlmnClient vendor=&quot;10415&quot;&gt;anonymousLocation&lt;/PlmnClient&gt;<br /> &lt;ServiceType vendor=&quot;10415&quot;&gt;<br /> &lt;ServiceTypeIdentity vendor=&quot;10415&quot;&gt;3&lt;/ServiceTypeIdentity&gt;<br /> &lt;GMLCRestriction vendor=&quot;10415&quot;&gt;home-Country&lt;/GMLCRestriction&gt;<br /> &lt;NotificationToUEUser vendor=&quot;10415&quot;&gt;notifyLocationAllowed&lt;/NotificationToUEUser&gt;<br /> &lt;/ServiceType&gt;<br /> &lt;ServiceType vendor=&quot;10415&quot;&gt;<br /> &lt;ServiceTypeIdentity vendor=&quot;10415&quot;&gt;4&lt;/ServiceTypeIdentity&gt;<br /> &lt;/ServiceType&gt;<br /> &lt;/LCSPrivacyException&gt;<br /> &lt;LCSPrivacyException vendor=&quot;10415&quot;&gt;<br /> &lt;SSCode vendor=&quot;10415&quot;&gt;allCallOfferingSS&lt;/SSCode&gt;<br /> &lt;SSStatus vendor=&quot;10415&quot;&gt;active,provisioned&lt;/SSStatus&gt;<br /> &lt;PlmnClient vendor=&quot;10415&quot;&gt;broadcastService&lt;/PlmnClient&gt;<br /> &lt;/LCSPrivacyException&gt;<br /> &lt;MOLR vendor=&quot;10415&quot;&gt;<br /> &lt;SSCode vendor=&quot;10415&quot;&gt;allLineIdentificationSS&lt;/SSCode&gt;<br /> &lt;SSStatus vendor=&quot;10415&quot;&gt;active,registered&lt;/SSStatus&gt;<br /> &lt;/MOLR&gt;<br /> &lt;/LCSInfo&gt;<br /> &lt;TeleserviceList vendor=&quot;10415&quot;&gt;<br /> &lt;TSCode vendor=&quot;10415&quot;&gt;allDataTeleservices&lt;/TSCode&gt;<br /> &lt;TSCode vendor=&quot;10415&quot;&gt;allSpeechTransmissionServices&lt;/TSCode&gt;<br /> &lt;TSCode vendor=&quot;10415&quot;&gt;voiceGroupCall&lt;/TSCode&gt;<br /> &lt;/TeleserviceList&gt;<br /> &lt;CallBarringInfo vendor=&quot;10415&quot;&gt;<br /> &lt;SSCode vendor=&quot;10415&quot;&gt;allLineIdentificationSS&lt;/SSCode&gt;<br /> &lt;SSStatus vendor=&quot;10415&quot;&gt;active,registered&lt;/SSStatus&gt;<br /> &lt;/CallBarringInfo&gt;<br /> &lt;CallBarringInfo vendor=&quot;10415&quot;&gt;<br /> &lt;SSCode vendor=&quot;10415&quot;&gt;allForwardingSS&lt;/SSCode&gt;<br /> &lt;SSStatus vendor=&quot;10415&quot;&gt;registered&lt;/SSStatus&gt;<br /> &lt;/CallBarringInfo&gt;<br /> &lt;ChargingCharacteristics vendor=&quot;10415&quot;&gt;xbcd&lt;/ChargingCharacteristics&gt;<br /> &lt;AMBR vendor=&quot;10415&quot;&gt;<br /> &lt;MaxRequestedBandwithUL vendor=&quot;10415&quot;&gt;20000&lt;/MaxRequestedBandwithUL&gt;<br /> &lt;MaxRequestedBandwithDL vendor=&quot;10415&quot;&gt;19000&lt;/MaxRequestedBandwithDL&gt;<br /> &lt;/AMBR&gt;<br /> &lt;APNConfigurationProfile vendor=&quot;10415&quot;&gt;<br /> &lt;ContextIdentifier vendor=&quot;10415&quot;&gt;1&lt;/ContextIdentifier&gt;<br /> &lt;AllAPNConfigIncluded vendor=&quot;10415&quot;&gt;yes&lt;/AllAPNConfigIncluded&gt;<br /> &lt;APNConfiguration vendor=&quot;10415&quot;&gt;<br /> &lt;ContextIdentifier vendor=&quot;10415&quot;&gt;555&lt;/ContextIdentifier&gt;<br /> &lt;ServedPartyIPAddr vendor=&quot;10415&quot;&gt;1.2.3.4&lt;/ServedPartyIPAddr&gt;<br /> &lt;ServedPartyIPAddr vendor=&quot;10415&quot;&gt;fe80::12:4&lt;/ServedPartyIPAddr&gt;<br /> &lt;PDNType vendor=&quot;10415&quot;&gt;ipv4v6&lt;/PDNType&gt;<br /> &lt;ServiceSelection&gt;*&lt;/ServiceSelection&gt;<br /> &lt;EpsSubscribedQosProfile vendor=&quot;10415&quot;&gt;<br /> &lt;QosClassIdentifier vendor=&quot;10415&quot;&gt;5&lt;/QosClassIdentifier&gt;<br /> &lt;AllocationRetentionPriority vendor=&quot;10415&quot;&gt;<br /> &lt;PriorityLevel vendor=&quot;10415&quot;&gt;2&lt;/PriorityLevel&gt;<br /> &lt;PreemptionCapability vendor=&quot;10415&quot;&gt;yes&lt;/PreemptionCapability&gt;<br /> &lt;PreemptionVulnerability vendor=&quot;10415&quot;&gt;no&lt;/PreemptionVulnerability&gt;<br /> &lt;/AllocationRetentionPriority&gt;<br /> &lt;/EpsSubscribedQosProfile&gt;<br /> &lt;VPlmnDynamicAddrAllowed vendor=&quot;10415&quot;&gt;yes&lt;/VPlmnDynamicAddrAllowed&gt;<br /> &lt;MIP6AgentInfo&gt;<br /> &lt;MIPHomeAgentAddress&gt;fe80::ad&lt;/MIPHomeAgentAddress&gt;<br /> &lt;/MIP6AgentInfo&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;1234567890&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;PDNGWAllocationType vendor=&quot;10415&quot;&gt;static&lt;/PDNGWAllocationType&gt;<br /> &lt;ChargingCharacteristics vendor=&quot;10415&quot;&gt;gigi&lt;/ChargingCharacteristics&gt;<br /> &lt;AMBR vendor=&quot;10415&quot;&gt;<br /> &lt;MaxRequestedBandwithUL vendor=&quot;10415&quot;&gt;550000&lt;/MaxRequestedBandwithUL&gt;<br /> &lt;MaxRequestedBandwithDL vendor=&quot;10415&quot;&gt;519000&lt;/MaxRequestedBandwithDL&gt;<br /> &lt;/AMBR&gt;<br /> &lt;SIPTOPermission vendor=&quot;10415&quot;&gt;yes&lt;/SIPTOPermission&gt;<br /> &lt;LIPAPermission vendor=&quot;10415&quot;&gt;lipa-only&lt;/LIPAPermission&gt;<br /> &lt;RestorationPriority vendor=&quot;10415&quot;&gt;3&lt;/RestorationPriority&gt;<br /> &lt;/APNConfiguration&gt;<br /> &lt;/APNConfigurationProfile&gt;<br /> &lt;RATFreqSelPriorityID vendor=&quot;10415&quot;&gt;5&lt;/RATFreqSelPriorityID&gt;<br /> &lt;TraceData vendor=&quot;10415&quot;&gt;<br /> &lt;TraceReference vendor=&quot;10415&quot;&gt;004011998877&lt;/TraceReference&gt;<br /> &lt;TraceDepth vendor=&quot;10415&quot;&gt;medium&lt;/TraceDepth&gt;<br /> &lt;TraceNEList vendor=&quot;10415&quot;&gt;eNB,sgw&lt;/TraceNEList&gt;<br /> &lt;TraceInterfaceList vendor=&quot;10415&quot;&gt;<br /> &lt;mme&gt;s13,s1-mme&lt;/mme&gt;<br /> &lt;eir&gt;s13&lt;/eir&gt;<br /> &lt;/TraceInterfaceList&gt;<br /> &lt;TraceEventList vendor=&quot;10415&quot;&gt;<br /> &lt;sgw&gt;pdn-connectionCreation&lt;/sgw&gt;<br /> &lt;pgw&gt;pdn-connectionTermination&lt;/pgw&gt;<br /> &lt;mme&gt;handover&lt;/mme&gt;<br /> &lt;/TraceEventList&gt;<br /> &lt;OMCId vendor=&quot;10415&quot;&gt;001122&lt;/OMCId&gt;<br /> &lt;TraceCollectionEntity vendor=&quot;10415&quot;&gt;192.168.168.1&lt;/TraceCollectionEntity&gt;<br /> &lt;MDTConfiguration vendor=&quot;10415&quot;&gt;<br /> &lt;JobType vendor=&quot;10415&quot;&gt;rlf-reports-only&lt;/JobType&gt;<br /> &lt;AreaScope vendor=&quot;10415&quot;&gt;<br /> &lt;CellGlobalIdentity vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;12345&lt;/PlmnIdentity&gt;<br /> &lt;LAC&gt;1122&lt;/LAC&gt;<br /> &lt;CI&gt;123&lt;/CI&gt;<br /> &lt;/CellGlobalIdentity&gt;<br /> &lt;EutranCellGlobalIdentity vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;123456&lt;/PlmnIdentity&gt;<br /> &lt;CellIdentity&gt;1234567&lt;/CellIdentity&gt;<br /> &lt;/EutranCellGlobalIdentity&gt;<br /> &lt;RAI vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;12345&lt;/PlmnIdentity&gt;<br /> &lt;LAC&gt;1122&lt;/LAC&gt;<br /> &lt;RAC&gt;99&lt;/RAC&gt;<br /> &lt;/RAI&gt;<br /> &lt;LAI vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;123456&lt;/PlmnIdentity&gt;<br /> &lt;LAC&gt;1122&lt;/LAC&gt;<br /> &lt;/LAI&gt;<br /> &lt;TAI vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;123456&lt;/PlmnIdentity&gt;<br /> &lt;TAC&gt;1122&lt;/TAC&gt;<br /> &lt;/TAI&gt;<br /> &lt;/AreaScope&gt;<br /> &lt;ListOfMeasurements vendor=&quot;10415&quot;&gt;<br /> &lt;lte&gt;m2&lt;/lte&gt;<br /> &lt;umts&gt;m7-for-ul,m3&lt;/umts&gt;<br /> &lt;/ListOfMeasurements&gt;<br /> &lt;ReportingTrigger vendor=&quot;10415&quot;&gt;periodical&lt;/ReportingTrigger&gt;<br /> &lt;ReportInterval vendor=&quot;10415&quot;&gt;6&lt;/ReportInterval&gt;<br /> &lt;ReportAmount vendor=&quot;10415&quot;&gt;7&lt;/ReportAmount&gt;<br /> &lt;ThresholdRSRP vendor=&quot;10415&quot;&gt;10&lt;/ThresholdRSRP&gt;<br /> &lt;ThresholdRSRQ vendor=&quot;10415&quot;&gt;10&lt;/ThresholdRSRQ&gt;<br /> &lt;LoggingInterval vendor=&quot;10415&quot;&gt;7&lt;/LoggingInterval&gt;<br /> &lt;LoggingDuration vendor=&quot;10415&quot;&gt;5&lt;/LoggingDuration&gt;<br /> &lt;MeasurementPeriodUMTS vendor=&quot;10415&quot;&gt;13&lt;/MeasurementPeriodUMTS&gt;<br /> &lt;MeasurementPeriodLTE vendor=&quot;10415&quot;&gt;6&lt;/MeasurementPeriodLTE&gt;<br /> &lt;CollectionPeriodRrmLTE vendor=&quot;10415&quot;&gt;5&lt;/CollectionPeriodRrmLTE&gt;<br /> &lt;CollectionPeriodRrmUMTS vendor=&quot;10415&quot;&gt;5&lt;/CollectionPeriodRrmUMTS&gt;<br /> &lt;PositioningMethod vendor=&quot;10415&quot;&gt;gnss,e-cell-id&lt;/PositioningMethod&gt;<br /> &lt;MeasurementQuantity vendor=&quot;10415&quot;&gt;pathloss&lt;/MeasurementQuantity&gt;<br /> &lt;EventThreshold1F vendor=&quot;10415&quot;&gt;0&lt;/EventThreshold1F&gt;<br /> &lt;EventThreshold1I vendor=&quot;10415&quot;&gt;-5&lt;/EventThreshold1I&gt;<br /> &lt;/MDTConfiguration&gt;<br /> &lt;/TraceData&gt;<br /> &lt;GPRSSubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;CompleteDataList vendor=&quot;10415&quot;&gt;yes&lt;/CompleteDataList&gt;<br /> &lt;PDPContext vendor=&quot;10415&quot;&gt;<br /> &lt;ContextIdentifier vendor=&quot;10415&quot;&gt;99&lt;/ContextIdentifier&gt;<br /> &lt;PDPType vendor=&quot;10415&quot;&gt;11223344&lt;/PDPType&gt;<br /> &lt;PDPAddress vendor=&quot;10415&quot;&gt;1.2.3.4&lt;/PDPAddress&gt;<br /> &lt;QosSubscribed vendor=&quot;10415&quot;&gt;998877&lt;/QosSubscribed&gt;<br /> &lt;ServiceSelection&gt;*.example.com&lt;/ServiceSelection&gt;<br /> &lt;ExtPDPType vendor=&quot;10415&quot;&gt;11223355&lt;/ExtPDPType&gt;<br /> &lt;ExtPDPAddress vendor=&quot;10415&quot;&gt;1.2.3.5&lt;/ExtPDPAddress&gt;<br /> &lt;/PDPContext&gt;<br /> &lt;PDPContext vendor=&quot;10415&quot;&gt;<br /> &lt;ContextIdentifier vendor=&quot;10415&quot;&gt;100&lt;/ContextIdentifier&gt;<br /> &lt;PDPType vendor=&quot;10415&quot;&gt;11223366&lt;/PDPType&gt;<br /> &lt;QosSubscribed vendor=&quot;10415&quot;&gt;998866&lt;/QosSubscribed&gt;<br /> &lt;ServiceSelection&gt;*.example.com&lt;/ServiceSelection&gt;<br /> &lt;/PDPContext&gt;<br /> &lt;/GPRSSubscriptionData&gt;<br /> &lt;CsgSubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;CsgId vendor=&quot;10415&quot;&gt;345&lt;/CsgId&gt;<br /> &lt;ExpirationDate vendor=&quot;10415&quot;&gt;1234567890&lt;/ExpirationDate&gt;<br /> &lt;ServiceSelection&gt;*&lt;/ServiceSelection&gt;<br /> &lt;VisitedPlmnId vendor=&quot;10415&quot;&gt;045500&lt;/VisitedPlmnId&gt;<br /> &lt;/CsgSubscriptionData&gt;<br /> &lt;RoamingRestrictUnsuppFeature vendor=&quot;10415&quot;/&gt;<br /> &lt;SubscribedPeriodicRAUTAUTimer vendor=&quot;10415&quot;&gt;120&lt;/SubscribedPeriodicRAUTAUTimer&gt;<br /> &lt;MPSPriority vendor=&quot;10415&quot;&gt;cs,eps&lt;/MPSPriority&gt;<br /> &lt;VPlmnLIPAAllowed vendor=&quot;10415&quot;&gt;yes&lt;/VPlmnLIPAAllowed&gt;<br /> &lt;RelayNodeIndicator vendor=&quot;10415&quot;&gt;no&lt;/RelayNodeIndicator&gt;<br /> &lt;MDTUserConsent vendor=&quot;10415&quot;&gt;yes&lt;/MDTUserConsent&gt;<br /> &lt;SubscribedVSRVCC vendor=&quot;10415&quot;/&gt;<br /> &lt;SubscriptionDataFlags vendor=&quot;10415&quot;&gt;ps-and-sms-only,sms-in-sgsn&lt;/SubscriptionDataFlags&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;/UpdateLocationAnswer&gt;<br /> <br /> Answer, failure, unknown subscriber:<br /> <br /> &lt;UpdateLocationAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot; flags=&quot;proxiable&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;ExperimentalResult&gt;<br /> &lt;value vendor=&quot;10415&quot;&gt;user-unknown&lt;/value&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;/UpdateLocationAnswer&gt; <br /> <br /> == Cancel Location Command ==<br /> <br /> Direction: HSS -&gt; MME/SGSN&lt;br&gt;<br /> <br /> Request:<br /> <br /> &lt;CancelLocationRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;CancellationType vendor=&quot;10415&quot;&gt;subscription-withdrawal&lt;/CancellationType&gt;<br /> &lt;CLRFlags vendor=&quot;10415&quot;&gt;s6a&lt;/CLRFlags&gt;<br /> &lt;/CancelLocationRequest&gt;<br /> <br /> Answer:<br /> <br /> &lt;CancelLocationAnswer appid=&quot;16777251&quot; flags=&quot;proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;/CancelLocationAnswer&gt;<br /> <br /> == Insert Subscriber Data Command ==<br /> <br /> Direction: HSS -&gt; MME/SGSN&lt;br&gt;<br /> <br /> Request:<br /> <br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> <br /> Answer:<br /> <br /> &lt;InsertSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;IMSVOPSSS vendor=&quot;10415&quot;&gt;yes&lt;/IMSVOPSSS&gt;<br /> &lt;LastUEActivityTime vendor=&quot;10415&quot;&gt;12345678&lt;/LastUEActivityTime&gt;<br /> &lt;RATType vendor=&quot;10415&quot;&gt;e-utran&lt;/RATType&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;EpsUserState vendor=&quot;10415&quot;&gt;<br /> &lt;MmeUserState vendor=&quot;10415&quot;&gt;<br /> &lt;UserState vendor=&quot;10415&quot;&gt;attached-reachable-for-paging&lt;/UserState&gt;<br /> &lt;/MmeUserState&gt;<br /> &lt;/EpsUserState&gt;<br /> &lt;EpsLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;MmeLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;EutranCellGlobalIdentity vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;123456&lt;/PlmnIdentity&gt;<br /> &lt;CellIdentity&gt;1234567&lt;/CellIdentity&gt;<br /> &lt;/EutranCellGlobalIdentity&gt;<br /> &lt;GeographicalInfo vendor=&quot;10415&quot;&gt;0001020304050607&lt;/GeographicalInfo&gt;<br /> &lt;GeodeticInfo vendor=&quot;10415&quot;&gt;00010203040506070809&lt;/GeodeticInfo&gt;<br /> &lt;CurrentLocationRetrieved vendor=&quot;10415&quot;&gt;active-loc-retrieval&lt;/CurrentLocationRetrieved&gt;<br /> &lt;AgeOfLocationInfo vendor=&quot;10415&quot;&gt;7&lt;/AgeOfLocationInfo&gt;<br /> &lt;UserCsgInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CsgId vendor=&quot;10415&quot;&gt;345&lt;/CsgId&gt;<br /> &lt;CsgAccessMode vendor=&quot;10415&quot;&gt;closed&lt;/CsgAccessMode&gt;<br /> &lt;CsgMembershipInd vendor=&quot;10415&quot;&gt;yes&lt;/CsgMembershipInd&gt;<br /> &lt;/UserCsgInfo&gt;<br /> &lt;/MmeLocationInfo&gt;<br /> &lt;SgsnLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;SAI vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;12345&lt;/PlmnIdentity&gt;<br /> &lt;LAC&gt;1122&lt;/LAC&gt;<br /> &lt;SAC&gt;99&lt;/SAC&gt;<br /> &lt;/SAI&gt;<br /> &lt;/SgsnLocationInfo&gt;<br /> &lt;/EpsLocationInfo&gt;<br /> &lt;LocalTimeZone vendor=&quot;10415&quot;&gt;<br /> &lt;TimeZone vendor=&quot;10415&quot;&gt;+2&lt;/TimeZone&gt;<br /> &lt;DaylightSavingTime vendor=&quot;10415&quot;&gt;1&lt;/DaylightSavingTime&gt;<br /> &lt;/LocalTimeZone&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;/InsertSubscriberDataAnswer&gt;<br /> <br /> == Delete Subscriber Data Command ==<br /> <br /> Direction: HSS -&gt; MME/SGSN&lt;br&gt;<br /> <br /> Request:<br /> <br /> &lt;DeleteSubscriberDataRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;DSRFlags vendor=&quot;10415&quot;&gt;sms-withdrawal,trace-data-withdrawal&lt;/DSRFlags&gt;<br /> &lt;TraceReference vendor=&quot;10415&quot;&gt;004011998877&lt;/TraceReference&gt;<br /> &lt;TSCode vendor=&quot;10415&quot;&gt;allDataTeleservices&lt;/TSCode&gt;<br /> &lt;TSCode vendor=&quot;10415&quot;&gt;allSpeechTransmissionServices&lt;/TSCode&gt;<br /> &lt;SSCode vendor=&quot;10415&quot;&gt;allLineIdentificationSS&lt;/SSCode&gt;<br /> &lt;SSCode vendor=&quot;10415&quot;&gt;allCallOfferingSS&lt;/SSCode&gt;<br /> &lt;/DeleteSubscriberDataRequest&gt;<br /> <br /> Answer:<br /> <br /> &lt;DeleteSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;DSAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/DSAFlags&gt;<br /> &lt;/DeleteSubscriberDataAnswer&gt;<br /> <br /> == Authentication Info Command ==<br /> <br /> Direction: MME/SGSN -&gt; HSS&lt;br&gt;<br /> <br /> Request:<br /> &lt;AuthenticationInfoRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;2&quot;&gt;sms-in-mme&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;RequestedEutranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;5&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ImmediateResponsePreferred vendor=&quot;10415&quot;/&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedEutranAuthInfo&gt;<br /> &lt;RequestedUtranGeranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;3&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedUtranGeranAuthInfo&gt;<br /> &lt;VisitedPlmnId vendor=&quot;10415&quot;&gt;040100&lt;/VisitedPlmnId&gt;<br /> &lt;/AuthenticationInfoRequest&gt;<br /> <br /> Answer, success:<br /> <br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot; flags=&quot;proxiable&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;VendorSpecificApplicationId flags=&quot;mandatory&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; auth=&quot;true&quot;&gt;16777251&lt;/value&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode flags=&quot;mandatory&quot;&gt;2001&lt;/ResultCode&gt;<br /> &lt;ErrorDiagnostic flags=&quot;vendor&quot; vendor=&quot;10415&quot;&gt;odb-HPLMN-APN&lt;/ErrorDiagnostic&gt;<br /> &lt;SupportedFeatures flags=&quot;vendor&quot; vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;baoc,boic&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;AuthenticationInfo flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;<br /> &lt;EutranVector flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;1&lt;/ItemNumber&gt;<br /> &lt;RAND flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;12345678&lt;/XRES&gt;<br /> &lt;AUTN flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;12345678&lt;/AUTN&gt;<br /> &lt;KASME flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;12345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;EutranVector flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;2&lt;/ItemNumber&gt;<br /> &lt;RAND flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;00345678&lt;/XRES&gt;<br /> &lt;AUTN flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;00345678&lt;/AUTN&gt;<br /> &lt;KASME flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;00345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;UtranVector flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;<br /> &lt;RAND flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;22345678&lt;/XRES&gt;<br /> &lt;AUTN flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;22345678&lt;/AUTN&gt;<br /> &lt;ConfidentialityKey flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;22345678&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;22345678&lt;/IntegrityKey&gt;<br /> &lt;/UtranVector&gt;<br /> &lt;GeranVector flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;<br /> &lt;RAND flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;SRES flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;34567811&lt;/SRES&gt;<br /> &lt;Kc flags=&quot;vendor,mandatory&quot; vendor=&quot;10415&quot;&gt;34567811&lt;/Kc&gt;<br /> &lt;/GeranVector&gt;<br /> &lt;/AuthenticationInfo&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> <br /> Answer, failure, auth data not found:<br /> <br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot; flags=&quot;proxiable&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;ExperimentalResult&gt;<br /> &lt;value vendor=&quot;10415&quot;&gt;auth-data-unavailable&lt;/value&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> <br /> == Purge UE Command ==<br /> <br /> Direction: MME/SGSN -&gt; HSS&lt;br&gt;<br /> <br /> Request:<br /> <br /> &lt;PurgeUERequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;PURFlags vendor=&quot;10415&quot;&gt;ue-purged-in-mme,ue-purged-in-sgsn&lt;/PURFlags&gt;<br /> &lt;/PurgeUERequest&gt;<br /> <br /> Answer, success:<br /> <br /> &lt;PurgeUEAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot; flags=&quot;proxiable&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;PUAFlags vendor=&quot;10415&quot;&gt;freeze-m-tmsi,freeze-p-tmsi&lt;/PUAFlags&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;1&quot;&gt;boic,baoc,regsub&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;/PurgeUEAnswer&gt;<br /> <br /> Answer, failure, requesting node is unknown:<br /> <br /> &lt;PurgeUEAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot; flags=&quot;proxiable&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;ExperimentalResult&gt;<br /> &lt;value vendor=&quot;10415&quot;&gt;unknown-serving-node&lt;/value&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;/PurgeUEAnswer&gt;<br /> <br /> == Reset Command ==<br /> <br /> Direction: HSS -&gt; MME/SGSN&lt;br&gt;<br /> <br /> Request:<br /> <br /> &lt;ResetRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;UserId vendor=&quot;10415&quot;&gt;004100&lt;/UserId&gt;<br /> &lt;/ResetRequest&gt;<br /> <br /> Answer:<br /> <br /> &lt;ResetAnswer appid=&quot;16777251&quot; flags=&quot;proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;/ResetAnswer&gt;<br /> <br /> == Notify Command ==<br /> <br /> Direction: MME/SGSN -&gt; HSS&lt;br&gt;<br /> <br /> Request:<br /> <br /> &lt;NotifyRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;2&quot;&gt;sms-in-mme&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;TerminalInfo vendor=&quot;10415&quot;&gt;<br /> &lt;IMEI vendor=&quot;10415&quot;&gt;1234567890&lt;/IMEI&gt;<br /> &lt;/TerminalInfo&gt;<br /> &lt;MIP6AgentInfo&gt;<br /> &lt;MIPHomeAgentAddress&gt;fe80::2&lt;/MIPHomeAgentAddress&gt;<br /> &lt;MIP6HomeLinkPrefix&gt;001122&lt;/MIP6HomeLinkPrefix&gt;<br /> &lt;/MIP6AgentInfo&gt;<br /> &lt;VisitedNetworkIdentifier vendor=&quot;10415&quot;&gt;998877&lt;/VisitedNetworkIdentifier&gt;<br /> &lt;ContextIdentifier vendor=&quot;10415&quot;&gt;100&lt;/ContextIdentifier&gt;<br /> &lt;ServiceSelection&gt;*&lt;/ServiceSelection&gt;<br /> &lt;AlertReason vendor=&quot;10415&quot;&gt;ue-memory-available&lt;/AlertReason&gt;<br /> &lt;UESRVCCCapability vendor=&quot;10415&quot;&gt;yes&lt;/UESRVCCCapability&gt;<br /> &lt;NORFlags vendor=&quot;10415&quot;&gt;ue-reachable-from-mme,ready-sm-from-mme&lt;/NORFlags&gt;<br /> &lt;HSoIMSVOPSS vendor=&quot;10415&quot;&gt;yes&lt;/HSoIMSVOPSS&gt;<br /> &lt;/NotifyRequest&gt;<br /> <br /> Answer, success:<br /> <br /> &lt;NotifyAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot; flags=&quot;proxiable&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;/NotifyAnswer&gt;<br /> <br /> Answer, failure, unknown node:<br /> <br /> &lt;NotifyAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot; flags=&quot;proxiable&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;ExperimentalResult&gt;<br /> &lt;value vendor=&quot;10415&quot;&gt;unknown-serving-node&lt;/value&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;/NotifyAnswer&gt;<br /> <br /> == References ==<br /> <br /> * RFC 3588 - Diameter Base Protocol<br /> * RFC 6733 - Diameter Base Protocol<br /> * RFC 5516 - Diameter Command Code Registration for the Third Generation Partnership Project (3GPP) Evolved Packet System (EPS)<br /> * ETSI TS 129.272 - MME and SGSN related interfaces based on Diameter protocol (S6a/S6d, S7a/S7d, S13/S13')</div>

Oana https://ss7api.null.ro/index.php/MediaWiki:Sidebar 2016-09-09T14:40:23Z

<p>Oana: </p> <hr /> <div><br /> * MAP &amp; CAMEL XML Interface<br /> ** Introduction|Introduction<br /> ** Connection|Connection<br /> ** Common features|Common features<br /> ** Transport|Transport<br /> ** Application|Application<br /> ** Components|Components<br /> ** Operation codes|Operation codes<br /> ** Error codes|Error codes<br /> ** Latency determination|Latency determination<br /> <br /> * Diameter XML Interface<br /> ** Diameter Introduction|Introduction<br /> ** Diameter Connection|Connection<br /> ** Diameter Common features|Common features<br /> ** Diameter Transport|Transport<br /> ** Diameter Commands|Commands<br /> ** Diameter Latency determination|Latency determination<br /> <br /> *MAP and CAMEL operations<br /> ** Authentication and security|Authentication and security<br /> ** HLR functions|HLR functions<br /> ** SMS functions|SMS functions<br /> ** CAMEL operations|CAMEL operations<br /> <br /> * Diameter interfaces<br /> **S6a/Sad|S6a/S6d<br /> <br /> *Examples<br /> ** CRBT logic|CRBT logic<br /> ** CAMEL proxy|CAMEL proxy<br /> ** MSC simulator|MSC simulator<br /> ** USSD GW|USSD GW<br /> ** SIM Cards|SIM Cards<br /> <br /> *Resources<br /> ** Standards|Standards<br /> <br /> * navigation<br /> ** mainpage|mainpage-description<br /> ** recentchanges-url|recentchanges<br /> <br /> * SEARCH<br /> * TOOLBOX<br /> * LANGUAGES</div>

Oana https://ss7api.null.ro/index.php/MediaWiki:Sidebar 2016-09-09T14:39:47Z

<p>Oana: </p> <hr /> <div><br /> * MAP &amp; CAMEL XML Interface<br /> ** Introduction|Introduction<br /> ** Connection|Connection<br /> ** Common features|Common features<br /> ** Transport|Transport<br /> ** Application|Application<br /> ** Components|Components<br /> ** Operation codes|Operation codes<br /> ** Error codes|Error codes<br /> ** Latency determination|Latency determination<br /> <br /> * Diameter XML Interface<br /> ** Diameter Introduction|Introduction<br /> ** Diameter Connection|Connection<br /> ** Diameter Common features|Common features<br /> ** Diameter Transport|Transport<br /> ** Diameter Commands|Commands<br /> ** Diameter Latency determination|Latency determination<br /> <br /> *MAP and CAMEL operations<br /> ** Authentication and security|Authentication and security<br /> ** HLR functions|HLR functions<br /> ** SMS functions|SMS functions<br /> ** CAMEL operations|CAMEL operations<br /> <br /> * Diameter interfaces<br /> **S6a/Sad<br /> <br /> *Examples<br /> ** CRBT logic|CRBT logic<br /> ** CAMEL proxy|CAMEL proxy<br /> ** MSC simulator|MSC simulator<br /> ** USSD GW|USSD GW<br /> ** SIM Cards|SIM Cards<br /> <br /> *Resources<br /> ** Standards|Standards<br /> <br /> * navigation<br /> ** mainpage|mainpage-description<br /> ** recentchanges-url|recentchanges<br /> <br /> * SEARCH<br /> * TOOLBOX<br /> * LANGUAGES</div>

Oana https://ss7api.null.ro/index.php/Diameter_Latency_determination 2016-09-09T14:37:17Z

<p>Oana: Created page with &quot;The purpose of latency determination is to estimate how much time takes for a message to be processed by a Diameter application. The xml_tcp module computes average applicati...&quot;</p> <hr /> <div>The purpose of latency determination is to estimate how much time takes for a message to be processed by a Diameter application.<br /> <br /> The xml_tcp module computes average application processing latency by handling timestamps from messages exchanged on that connection.<br /> * Each message sent by the module can be timestamped with the server's current time<br /> * Application copies the timestamp from the received XML to the one it responds with<br /> * If the module receives a timestamp it will compute the difference from the current time and adjust average latency<br /> <br /> The timestamps need to be enabled in the xml_tcp.conf module. This can be done per Diameter listener<br /> <br /> <br /> [listener s6a]<br /> type=diameter<br /> ...<br /> add-timestamp=yes<br /> <br /> If enabled the timestamps are added in their own XML element named timestamp-send:<br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1377071763411706&lt;/timestamp-send&gt;<br /> ...<br /> &lt;/m&gt;<br /> <br /> The application is supposed to copy the received timestamp to the response in a timestamp-recv element:<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1377071763411706&lt;/timestamp-recv&gt;<br /> ...<br /> &lt;/m&gt;<br /> <br /> These are exposed through the status of the xml_tcp module.</div>

Oana https://ss7api.null.ro/index.php/Diameter_Commands 2016-09-09T14:16:11Z

<p>Oana: &lt;</p> <hr /> <div>This is the main part of the message holding the data specific to each Diameter interface.<br /> <br /> The Diameter command is wrapped in a XML element marked by ''&lt;operation/&gt;'' to make it easy to find the information in the XML. The child of the ''&lt;operation/&gt;'' is an XML describing the Diameter command decoded/to be encoded. The tag of the child element is the name of the command.<br /> <br /> Each message can only contain a single Diameter command message.<br /> <br /> &lt;m&gt;<br /> .... <br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> ==Parameters==<br /> <br /> For the XML child containing the command, the following parameters appear as attributes (bold - mandatory, italic - optional)<br /> ** '''appid''': Numeric identifier of the interface to which this message belongs to<br /> ** ''flags'' : Diameter flags for the message. For messages on direction TCP aplication -&gt; Diameter translator, flags are optional in requests/answers(they will be added automatically by Diameter), but if they are added, they must be correctly correlated with the tag. An error answer must set flags to error.<br /> ** ''hhident'': Hop-to-hp identifier. Present in messages received by an application server. When an application sends a request, the Diameter translator automatically adds it<br /> ** ''eeident''<br /> <br /> For S6a messages, the application ID is 16777251.<br /> <br /> Non-base protocol Diameter AVPs must have '''vendor''' identifier set. For 3GPP AVPs this is 10415.<br /> <br /> ==Examples==<br /> <br /> * Request (HSS -&gt; MME &amp; TCP -&gt; Diameter):<br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;timeout&gt;60000&lt;/timeout&gt;<br /> &lt;local_node&gt;example.com/hss.example.com&lt;/local_node&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Answer (MME -&gt; HSS):<br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;IMSVOPSSS vendor=&quot;10415&quot;&gt;yes&lt;/IMSVOPSSS&gt;<br /> &lt;LastUEActivityTime vendor=&quot;10415&quot;&gt;12345678&lt;/LastUEActivityTime&gt;<br /> &lt;RATType vendor=&quot;10415&quot;&gt;e-utran&lt;/RATType&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;EpsUserState vendor=&quot;10415&quot;&gt;<br /> &lt;MmeUserState vendor=&quot;10415&quot;&gt;<br /> &lt;UserState vendor=&quot;10415&quot;&gt;attached-reachable-for-paging&lt;/UserState&gt;<br /> &lt;/MmeUserState&gt;<br /> &lt;/EpsUserState&gt;<br /> &lt;EpsLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;MmeLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;EutranCellGlobalIdentity vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;123456&lt;/PlmnIdentity&gt;<br /> &lt;CellIdentity&gt;1234567&lt;/CellIdentity&gt;<br /> &lt;/EutranCellGlobalIdentity&gt;<br /> &lt;GeographicalInfo vendor=&quot;10415&quot;&gt;0001020304050607&lt;/GeographicalInfo&gt;<br /> &lt;GeodeticInfo vendor=&quot;10415&quot;&gt;00010203040506070809&lt;/GeodeticInfo&gt;<br /> &lt;CurrentLocationRetrieved vendor=&quot;10415&quot;&gt;active-loc-retrieval&lt;/CurrentLocationRetrieved&gt;<br /> &lt;AgeOfLocationInfo vendor=&quot;10415&quot;&gt;7&lt;/AgeOfLocationInfo&gt;<br /> &lt;UserCsgInfo vendor=&quot;10415&quot;&gt;<br /> &lt;CsgId vendor=&quot;10415&quot;&gt;345&lt;/CsgId&gt;<br /> &lt;CsgAccessMode vendor=&quot;10415&quot;&gt;closed&lt;/CsgAccessMode&gt;<br /> &lt;CsgMembershipInd vendor=&quot;10415&quot;&gt;yes&lt;/CsgMembershipInd&gt;<br /> &lt;/UserCsgInfo&gt;<br /> &lt;/MmeLocationInfo&gt;<br /> &lt;SgsnLocationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;SAI vendor=&quot;10415&quot;&gt;<br /> &lt;PlmnIdentity&gt;12345&lt;/PlmnIdentity&gt;<br /> &lt;LAC&gt;1122&lt;/LAC&gt;<br /> &lt;SAC&gt;99&lt;/SAC&gt;<br /> &lt;/SAI&gt;<br /> &lt;/SgsnLocationInfo&gt;<br /> &lt;/EpsLocationInfo&gt;<br /> &lt;LocalTimeZone vendor=&quot;10415&quot;&gt;<br /> &lt;TimeZone vendor=&quot;10415&quot;&gt;+2&lt;/TimeZone&gt;<br /> &lt;DaylightSavingTime vendor=&quot;10415&quot;&gt;1&lt;/DaylightSavingTime&gt;<br /> &lt;/LocalTimeZone&gt;<br /> &lt;IDAFlags vendor=&quot;10415&quot;&gt;network-node-area-restricted&lt;/IDAFlags&gt;<br /> &lt;/InsertSubscriberDataAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Error (local host -&gt; TCP application)<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataAnswer appid=&quot;16777251&quot; flags=&quot;error&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&gt;<br /> &lt;OriginHost&gt;hss.example.com&lt;/OriginHost&gt;<br /> &lt;OriginRealm&gt;example.com&lt;/OriginRealm&gt;<br /> &lt;ResultCode&gt;3002&lt;/ResultCode&gt;<br /> &lt;ErrorMessage&gt;timeout&lt;/ErrorMessage&gt;<br /> &lt;/InsertSubscriberDataAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> * Request (MME -&gt; HSS &amp; Diameter -&gt; TCP)<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-send&gt;1470663005862835&lt;/timestamp-send&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value id=&quot;2&quot;&gt;sms-in-mme&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;RequestedEutranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;5&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ImmediateResponsePreferred vendor=&quot;10415&quot;/&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedEutranAuthInfo&gt;<br /> &lt;RequestedUtranGeranAuthInfo vendor=&quot;10415&quot;&gt;<br /> &lt;NumberOfRequestedVectors vendor=&quot;10415&quot;&gt;3&lt;/NumberOfRequestedVectors&gt;<br /> &lt;ReSynchronisationInfo vendor=&quot;10415&quot;&gt;001122&lt;/ReSynchronisationInfo&gt;<br /> &lt;/RequestedUtranGeranAuthInfo&gt;<br /> &lt;VisitedPlmnId vendor=&quot;10415&quot;&gt;040100&lt;/VisitedPlmnId&gt;<br /> &lt;/AuthenticationInfoRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> * Answer (HSS -&gt; MME &amp; TCP -&gt; Diameter):<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;VendorSpecificApplicationId&gt;<br /> &lt;value vendor=&quot;10415&quot; auth=&quot;true&quot;&gt;16777251&lt;/value&gt;<br /> &lt;/VendorSpecificApplicationId&gt;<br /> &lt;ResultCode&gt;2001&lt;/ResultCode&gt;<br /> &lt;ErrorDiagnostic vendor=&quot;10415&quot;&gt;odb-HPLMN-APN&lt;/ErrorDiagnostic&gt;<br /> &lt;SupportedFeatures vendor=&quot;10415&quot;&gt;<br /> &lt;value vendor=&quot;10415&quot; id=&quot;1&quot;&gt;baoc,boic&lt;/value&gt;<br /> &lt;/SupportedFeatures&gt;<br /> &lt;AuthenticationInfo vendor=&quot;10415&quot;&gt;<br /> &lt;EutranVector vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber vendor=&quot;10415&quot;&gt;1&lt;/ItemNumber&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;12345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;12345678&lt;/AUTN&gt;<br /> &lt;KASME vendor=&quot;10415&quot;&gt;12345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;EutranVector vendor=&quot;10415&quot;&gt;<br /> &lt;ItemNumber vendor=&quot;10415&quot;&gt;2&lt;/ItemNumber&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;00345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;00345678&lt;/AUTN&gt;<br /> &lt;KASME vendor=&quot;10415&quot;&gt;00345678&lt;/KASME&gt;<br /> &lt;/EutranVector&gt;<br /> &lt;UtranVector vendor=&quot;10415&quot;&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;XRES vendor=&quot;10415&quot;&gt;22345678&lt;/XRES&gt;<br /> &lt;AUTN vendor=&quot;10415&quot;&gt;22345678&lt;/AUTN&gt;<br /> &lt;ConfidentialityKey vendor=&quot;10415&quot;&gt;22345678&lt;/ConfidentialityKey&gt;<br /> &lt;IntegrityKey vendor=&quot;10415&quot;&gt;22345678&lt;/IntegrityKey&gt;<br /> &lt;/UtranVector&gt;<br /> &lt;GeranVector vendor=&quot;10415&quot;&gt;<br /> &lt;RAND vendor=&quot;10415&quot;&gt;01020304111213142122232441424344&lt;/RAND&gt;<br /> &lt;SRES vendor=&quot;10415&quot;&gt;34567811&lt;/SRES&gt;<br /> &lt;Kc vendor=&quot;10415&quot;&gt;34567811&lt;/Kc&gt;<br /> &lt;/GeranVector&gt;<br /> &lt;/AuthenticationInfo&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> * Error (HSS -&gt; MME &amp; TCP -&gt; Diameter, failure, auth data not found):<br /> <br /> &lt;m&gt;<br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;trans_id&gt;diam/456789&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;AuthenticationInfoAnswer appid=&quot;16777251&quot; hhident=&quot;${hhident}&quot; eeident=&quot;${eeident}&quot;&gt;<br /> &lt;SessionId&gt;${session_id}&lt;/SessionId&gt;<br /> &lt;AuthSessionState&gt;1&lt;/AuthSessionState&gt;<br /> &lt;ExperimentalResult&gt;<br /> &lt;value vendor=&quot;10415&quot;&gt;auth-data-unavailable&lt;/value&gt;<br /> &lt;/ExperimentalResult&gt;<br /> &lt;/AuthenticationInfoAnswer&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;</div>

Oana https://ss7api.null.ro/index.php/Diameter_Commands 2016-09-09T13:55:01Z

<p>Oana: </p> <hr /> <div>This is the main part of the message holding the data specific to each Diameter interface.<br /> <br /> The Diameter command is wrapped in a XML element marked by ''&lt;operation/&gt;'' to make it easy to find the information in the XML. The child of the ''&lt;operation/&gt;'' is an XML describing the Diameter command decoded/to be encoded. The tag of the child element is the name of the command.<br /> <br /> Each message can only contain a single Diameter command message.<br /> <br /> &lt;m&gt;<br /> .... <br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> ==Parameters==<br /> <br /> For the XML child containing the command, the following parameters appear as attributes (bold - mandatory, italic - optional)<br /> ** '''appid''': Numeric identifier of the interface to which this message belongs to<br /> ** ''flags'' : Diameter flags for the message. For messages on direction TCP aplication -&gt; Diameter translator, flags are optional in requests/answers(they will be added automatically by Diameter), but if they are added, they must be correctly correlated with the tag. An error answer must set flags to error.<br /> <br /> For S6a messages, the application ID is 16777251.<br /> <br /> Non-base protocol Diameter AVPs must have '''vendor''' identifier set. For 3GPP AVPs this is 10415.</div>

Oana https://ss7api.null.ro/index.php/Diameter_Commands 2016-09-09T13:40:10Z

<p>Oana: Created page with &quot;This is the main part of the message holding the data specific to each Diameter interface. The Diameter command is wrapped in a XML element marked by ''&lt;operation/&gt;'' to make...&quot;</p> <hr /> <div>This is the main part of the message holding the data specific to each Diameter interface.<br /> <br /> The Diameter command is wrapped in a XML element marked by ''&lt;operation/&gt;'' to make it easy to find the information in the XML. The child of the ''&lt;operation/&gt;'' is an XML describing the Diameter command decoded/to be encoded. The tag of the child element is the name of the command.<br /> <br /> Each message can only contain a single Diameter command message.<br /> <br /> &lt;m&gt;<br /> .... <br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;</div>

Oana https://ss7api.null.ro/index.php/Diameter_Transport 2016-09-09T11:56:13Z

<p>Oana: </p> <hr /> <div>The transport part of the message contains parameters related to identifying a message and controlling the transmission of a Diameter message. For requests from application serves, these parameters are combined with parameters from the Diameter command to configure the handling and routing of the message.<br /> <br /> This part of the message is marked by the '''&lt;diameter/&gt;''' tag and contains information related to sending/receiving messages, but are not part of the Diameter command. <br /> <br /> These are the parameters for sending a message (bold means mandatory, italic - optional):<br /> * '''trans_id''': Unique identifier per direction used to match requests and answers and identify a certain Diameter transaction. In Diameter -&gt; TCP direction, this is set by the Diameter level and it must be returned in the answer sent by the TCP application. In the TCP -&gt; Diameter direction, the TCP application sets it in the request and the Diameter level will return in the answer. The identifier has no required format, must be only a uniquely generated string per Diameter transaction.<br /> * '''local_node''': Identifier of the node (${realm}/${host}) to use for sending a request from the TCP application. If not present, one must be set in ''connection.'' configuration of the listener. The one present in XML will override the configured one. <br /> * ''timeout'': setting the timeout for a request in the TCP application -&gt; Diameter direction. This allows overriding the configured Diameter timeout setting (optional). It can also be set in ''connection.'' configuration or in diameter configuration.<br /> <br /> <br /> Example:<br /> <br /> &lt;m&gt;<br /> ...<br /> &lt;diameter&gt;<br /> &lt;timeout&gt;60000&lt;/timeout&gt;<br /> &lt;local_node&gt;example.com/hss.example.com&lt;/local_node&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> ....<br /> &lt;/m&gt;</div>

Oana https://ss7api.null.ro/index.php/Diameter_Transport 2016-09-09T11:27:20Z

<p>Oana: Created page with &quot;The transport part of the message contains parameters related to identifying a message and controlling the transmission of a Diameter message. For requests from application se...&quot;</p> <hr /> <div>The transport part of the message contains parameters related to identifying a message and controlling the transmission of a Diameter message. For requests from application serves, these parameters are combined with parameters from the Diameter command to configure the handling and routing of the message.<br /> <br /> This part of the message is marked by the '''&lt;diameter/&gt;''' tag and contains information related to sending/receiving messages, but are not part of the Diameter command. <br /> <br /> These are the parameters for sending a message (bold means mandatory, italic - optional):<br /> * '''trans_id''': Unique identifier per direction used to match requests and answers and identify a certain Diameter transaction. In Diameter -&gt; TCP direction, this is set by the Diameter level and it must be returned in the answer sent by the TCP application. In the TCP -&gt; Diameter direction, the TCP application sets it in the request and the Diameter level will return in the answer. The identifier has no required format, must be only a uniquely generated string per Diameter transaction.<br /> * '''local_node''': Identifier of the node (${realm}/${host}) to use for sending a request from the TCP application. If not present, one must be set in ''connection.'' configuration of the listener. The one present in XML will override the configured one. <br /> * ''timeout'': setting the timeout for a request in the TCP application -&gt; Diameter direction. This allows overriding the configured Diameter timeout setting (optional). It can also be set in ''connection.'' configuration or in diameter configuration.</div>

Oana https://ss7api.null.ro/index.php/Diameter_Common_features 2016-09-09T10:52:02Z

<p>Oana: Created page with &quot;Messages are represented hierarchically in XML format. There may be more parameters than described in this specification. Unknown parameters should be ignored. Each message c...&quot;</p> <hr /> <div>Messages are represented hierarchically in XML format. There may be more parameters than described in this specification. Unknown parameters should be ignored.<br /> <br /> Each message contains 3 major parts:<br /> <br /> * Latency related information<br /> * Diameter information regarding identification and transport<br /> * Diameter command<br /> <br /> In XML these map like in this example:<br /> <br /> &lt;m&gt;<br /> <br /> &lt;timestamp-recv&gt;1470663005862835&lt;/timestamp-recv&gt;<br /> &lt;diameter&gt;<br /> &lt;timeout&gt;60000&lt;/timeout&gt;<br /> &lt;local_node&gt;example.com/hss.example.com&lt;/local_node&gt;<br /> &lt;trans_id&gt;hss/123456&lt;/trans_id&gt;<br /> &lt;/diameter&gt;<br /> &lt;operation&gt;<br /> &lt;InsertSubscriberDataRequest appid=&quot;16777251&quot; flags=&quot;request,proxiable&quot;&gt;<br /> &lt;DestinationHost&gt;mme.example.com&lt;/DestinationHost&gt;<br /> &lt;DestinationRealm&gt;example.com&lt;/DestinationRealm&gt;<br /> &lt;Username&gt;004100123456789&lt;/Username&gt;<br /> &lt;SubscriptionData vendor=&quot;10415&quot;&gt;<br /> &lt;MSISDN vendor=&quot;10415&quot;&gt;40700100100&lt;/MSISDN&gt;<br /> &lt;/SubscriptionData&gt;<br /> &lt;IDRFlags vendor=&quot;10415&quot;&gt;eps-user-state-req,eps-loc-info-req,local-tz-req,rat-type-req&lt;/IDRFlags&gt;<br /> &lt;/InsertSubscriberDataRequest&gt;<br /> &lt;/operation&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> In these examples the XML is nicely indented for readability. In practice any whitespace between XML elements may be omitted.</div>

Oana https://ss7api.null.ro/index.php/Diameter_Connection 2016-09-09T10:43:36Z

<p>Oana: Created page with &quot;The connection used for exchange of XML formatted messages is a TCP socket. As an option TLS can be used to protect the information. In that case the information on this page ...&quot;</p> <hr /> <div>The connection used for exchange of XML formatted messages is a TCP socket. As an option TLS can be used to protect the information. In that case the information on this page applies only to the unencrypted data, the certificate check and establishment of encryption are outside the scope of this page.<br /> <br /> ==Establishing the connection==<br /> <br /> A connection is established from the application to the Diameter translator. Each translator is associated with a TCP listener. Each TCP listener is associated with a certain Diameter interface. An application can establish multiple connections to the Diameter translator. Each connection is independent from the others. To establish the connection a TCP socket must be connected to the agreed listening port of the translator. Upon a successful connection XML messages exchange can start.<br /> <br /> The XML declaration &lt;?xml … ?&gt; must be present in the first exchanged message. On further messages the declaration may be omitted.<br /> <br /> All messages must have a root &lt;m&gt; element. The optional xmlns attribute must be &quot;http://yate.null.ro/xml/diameter/v1&quot; (note that the URL doesn't point to a valid location).<br /> <br /> The closing tag &lt;/m&gt; can be used to look up for the end of XML in the stream.<br /> <br /> ==Announcing capabilities==<br /> <br /> After connection on the TCP socket, the application will announce its capabilities. Otherwise, it will not be considered a valid connection for Diameter messages and it will be ignored.<br /> <br /> This initial XML message must have both an XML declaration and an xmlns in the root element indicating the correct version of the protocol is being spoken.<br /> <br /> Each supported capability will be announced in a &lt;c&gt; element placed in the root element.<br /> &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;<br /> &lt;m xmlns=&quot;http://yate.null.ro/xml/diameter/v1&quot;&gt;<br /> &lt;c&gt;HSSMobility&lt;/c&gt;<br /> &lt;c&gt;MMEMobility&lt;/c&gt;<br /> ...<br /> &lt;/m&gt;<br /> <br /> On success the translator will confirm and indicate the application is active (receives messages):<br /> &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;<br /> &lt;m xmlns=&quot;http://yate.null.ro/xml/diameter/v1&quot;&gt;<br /> &lt;state&gt;active&lt;/state&gt;<br /> &lt;/m&gt;<br /> <br /> <br /> On failure the converter may return an error text and will close the socket after that. In case of XML error or xmlns mismatch no error is returned.<br /> &lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;<br /> &lt;m xmlns=&quot;http://yate.null.ro/xml/tcap/v1&quot;&gt;<br /> &lt;state&gt;inactive&lt;/state&gt;<br /> &lt;error&gt;Unsupported: Charging&lt;/error&gt;<br /> &lt;/m&gt;<br /> <br /> For S6a interface, the capabilities are organized by whom can handle the requests. Capability - operations associationsare: <br /> * HSSMobility : UpdateLocationRequest, UpdateLocationAnswer, PurgeUERequest, PurgeUEAnswer, NotifyRequest, NotifyAnswer<br /> * MMEMobility :CancelLocationRequest, CancelLocationAnswer, InsertSubscriberDataRequest, InsertSubscriberDataAnswer, DeleteSubscriberDataRequest, DeleteSubscriberDataAnswer, ResetRequest, ResetAnswer<br /> * HSSAuthentication : AuthenticationInfoRequest, AuthenticationInfoAnswer <br /> <br /> ==Generating and processing Diameter messages==<br /> <br /> While in active state, the application will receive XML Diameter-specific formatted messages for handling. It can also send messages, either as an answer to a previous incoming request or to generate a new outbound request.<br /> <br /> ==Preparing shutdown==<br /> <br /> <br /> When an application wishes to stop processing it should indicate to the translator to stop delivering messages for new requests/sessions. Messages for currently running requests will still be delivered.<br /> <br /> This is done by indicating lack of all capabilities in an empty &lt;c/&gt; element:<br /> &lt;m&gt;<br /> &lt;c/&gt;<br /> &lt;/m&gt;<br /> <br /> The converter will not answer at once, instead it will continue to deliver messages for existing requests/sessions. Eventually these requests will dry up and the new state will be applied:<br /> &lt;m&gt;<br /> &lt;state&gt;inactive&lt;/state&gt;<br /> &lt;/m&gt;<br /> <br /> At this point it is safe to close the socket.</div>

Oana https://ss7api.null.ro/index.php/Diameter_Introduction 2016-09-09T09:42:16Z

<p>Oana: </p> <hr /> <div>{{DISPLAYTITLE:Introduction}}<br /> <br /> The purpose of this document is to describe the XML based protocol used to implement communication between the YATE Diameter implementation and the Diameter application servers for mobile services so that exchange of Diameter information between YATE and application servers can be done over TCP connections.<br /> <br /> Diameter is an authentication, authorization, and accounting protocol for computer networks. In LTE, several Diameter applications are defined and used. <br /> The primary aim is to allow applications servers to handle and send Diameter commands regarding the S6a interface (MME - HSS interface).<br /> <br /> The aim of the protocol is to map Diameter commands from the interface and any other relevant information needed for the transport of the command to XML messages as transparently as possible.</div>

Oana https://ss7api.null.ro/index.php/Diameter_Introduction 2016-09-09T09:11:28Z

<p>Oana: Created page with &quot;{{DISPLAYTITLE:Introduction}} The purpose of this document is to describe the XML based protocol used to implement communication between the YATE Diameter implementation and ...&quot;</p> <hr /> <div>{{DISPLAYTITLE:Introduction}}<br /> <br /> The purpose of this document is to describe the XML based protocol used to implement communication between the YATE Diameter implementation and the Diameter application servers for mobile services.</div>

Oana https://ss7api.null.ro/index.php/MediaWiki:Sidebar 2016-09-09T09:08:49Z

<p>Oana: </p> <hr /> <div><br /> * MAP &amp; CAMEL XML Interface<br /> ** Introduction|Introduction<br /> ** Connection|Connection<br /> ** Common features|Common features<br /> ** Transport|Transport<br /> ** Application|Application<br /> ** Components|Components<br /> ** Operation codes|Operation codes<br /> ** Error codes|Error codes<br /> ** Latency determination|Latency determination<br /> <br /> * Diameter XML Interface<br /> ** Diameter Introduction|Introduction<br /> ** Diameter Connection|Connection<br /> ** Diameter Common features|Common features<br /> ** Diameter Transport|Transport<br /> ** Diameter Commands|Commands<br /> ** Diameter Latency determination|Latency determination<br /> <br /> *MAP and CAMEL operations<br /> ** Authentication and security|Authentication and security<br /> ** HLR functions|HLR functions<br /> ** SMS functions|SMS functions<br /> ** CAMEL operations|CAMEL operations<br /> <br /> *Examples<br /> ** CRBT logic|CRBT logic<br /> ** CAMEL proxy|CAMEL proxy<br /> ** MSC simulator|MSC simulator<br /> ** USSD GW|USSD GW<br /> ** SIM Cards|SIM Cards<br /> <br /> *Resources<br /> ** Standards|Standards<br /> <br /> * navigation<br /> ** mainpage|mainpage-description<br /> ** recentchanges-url|recentchanges<br /> <br /> * SEARCH<br /> * TOOLBOX<br /> * LANGUAGES</div>

Oana https://ss7api.null.ro/index.php/MediaWiki:Sidebar 2016-09-09T09:05:12Z

<p>Oana: </p> <hr /> <div><br /> * MAP &amp; CAMEL XML Interface<br /> ** Introduction|Introduction<br /> ** Connection|Connection<br /> ** Common features|Common features<br /> ** Transport|Transport<br /> ** Application|Application<br /> ** Components|Components<br /> ** Operation codes|Operation codes<br /> ** Error codes|Error codes<br /> ** Latency determination|Latency determination<br /> <br /> * Diameter XML Interface<br /> ** Diameter Introduction|Introduction<br /> <br /> *MAP and CAMEL operations<br /> ** Authentication and security|Authentication and security<br /> ** HLR functions|HLR functions<br /> ** SMS functions|SMS functions<br /> ** CAMEL operations|CAMEL operations<br /> <br /> *Examples<br /> ** CRBT logic|CRBT logic<br /> ** CAMEL proxy|CAMEL proxy<br /> ** MSC simulator|MSC simulator<br /> ** USSD GW|USSD GW<br /> ** SIM Cards|SIM Cards<br /> <br /> *Resources<br /> ** Standards|Standards<br /> <br /> * navigation<br /> ** mainpage|mainpage-description<br /> ** recentchanges-url|recentchanges<br /> <br /> * SEARCH<br /> * TOOLBOX<br /> * LANGUAGES</div>

Oana https://ss7api.null.ro/index.php/MediaWiki:Sidebar 2016-09-08T08:42:49Z

<p>Oana: Reverted edits by Oana (talk) to last revision by Andrei</p> <hr /> <div><br /> *XML Interface<br /> ** Introduction|Introduction<br /> ** Connection|Connection<br /> ** Common features|Common features<br /> ** Transport|Transport<br /> ** Application|Application<br /> ** Components|Components<br /> ** Operation codes|Operation codes<br /> ** Error codes|Error codes<br /> ** Latency determination|Latency determination<br /> <br /> *MAP and CAMEL operations<br /> ** Authentication and security|Authentication and security<br /> ** HLR functions|HLR functions<br /> ** SMS functions|SMS functions<br /> ** CAMEL operations|CAMEL operations<br /> <br /> *Examples<br /> ** CRBT logic|CRBT logic<br /> ** CAMEL proxy|CAMEL proxy<br /> ** MSC simulator|MSC simulator<br /> ** USSD GW|USSD GW<br /> ** SIM Cards|SIM Cards<br /> <br /> *Resources<br /> ** Standards|Standards<br /> <br /> * navigation<br /> ** mainpage|mainpage-description<br /> ** recentchanges-url|recentchanges<br /> <br /> * SEARCH<br /> * TOOLBOX<br /> * LANGUAGES</div>

Oana https://ss7api.null.ro/index.php/MediaWiki:Sidebar 2016-09-08T08:41:51Z

<p>Oana: </p> <hr /> <div><br /> *XML Interface<br /> ** MAP &amp; CAMEL interface<br /> *** Introduction|Introduction<br /> *** Connection|Connection<br /> *** Common features|Common features<br /> *** Transport|Transport<br /> *** Application|Application<br /> *** Components|Components<br /> *** Operation codes|Operation codes<br /> *** Error codes|Error codes<br /> *** Latency determination|Latency determination<br /> ** Diameter interface<br /> <br /> *MAP and CAMEL operations<br /> ** Authentication and security|Authentication and security<br /> ** HLR functions|HLR functions<br /> ** SMS functions|SMS functions<br /> ** CAMEL operations|CAMEL operations<br /> <br /> *Examples<br /> ** CRBT logic|CRBT logic<br /> ** CAMEL proxy|CAMEL proxy<br /> ** MSC simulator|MSC simulator<br /> ** USSD GW|USSD GW<br /> ** SIM Cards|SIM Cards<br /> <br /> *Resources<br /> ** Standards|Standards<br /> <br /> * navigation<br /> ** mainpage|mainpage-description<br /> ** recentchanges-url|recentchanges<br /> <br /> * SEARCH<br /> * TOOLBOX<br /> * LANGUAGES</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2015-09-14T14:35:09Z

<p>Oana: /* Keyword values */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information from the user it can send another ''unstructuredSS-Request'' Invoke in a TCAP CONTINUE and wait for the answer. Once the network obtains all needed information, but wants (for user friendliness) to notify the user about the result of the operations, it can send: <br /> * a TCAP CONTINUE containing a ''unstructuredSS-Notify'' Invoke. When the user side respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'', the network can close the dialog through a TCAP END<br /> * if the network is not interested in the outcome of ''unstructuredSS-Notify'' Invoke operation, it can send a TCAP END containing ''unstructuredSS-Notify'' invoke.<br /> If there is nothing to notify to the user, the network can send a TCAP END to close the TCAP dialog.<br /> <br /> <br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> ** Set to false for UCS2 encoding without language indication<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> ** Set to false for UCS2 encoding without language indication<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> ** Set to false for UCS2 encoding without language indication<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> * '''node'''<br /> ** MAP parameter for when error = system_failure <br /> ** maps to networkResource in the MAP Error.<br /> ** possible values are: plmn, hlr, vlr, pvlr, controllingMSC, vmsc, eir, rss. Defaults to plmn if not given<br /> <br /> * '''cause'''<br /> ** MAP parameter for when error = call_barred<br /> ** maps to callBarringCause in the MAP Error<br /> ** possible values are: barringServiceActive, operatorBarring. Defaults to operatorBarring if not given<br /> <br /> * '''text.encoding'''<br /> ** gsm7bit / GSM7Bit: text was encoded/is to be encoded GSM 7 Bit<br /> ** ucs2 / UCS2: text was encoded/is to be encoded UCS 2<br /> <br /> * '''text.lang'''<br /> ** two character string specifying a language according to ISO 639-1 or integer value if mapping is not provided.<br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> '''NOTE''': As of SVN revision 1285, there is a new ''camelmap'' module. For compatibility reasons, the old module, ''camel_map'', was also kept. Both modules read the same configuration file, ''camel_map.conf''. In order to avoid issues, please make sure to only enable one of these modules in the ''[postload]'' section of ''yate.conf''.<br /> <br /> The new module is the one that offers USSD UCS2 encoding without language indication, but beware that TCP functionality has been removed from it. That functionality has been moved to the ''xml_tcp'' module. The module only uses messages to communicate with applications. ''ussd_map'' uses messages, so there should be no need for TCP functionality.<br /> <br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> '''Note''' If SMPP is configured to expect decoded USSD texts (which is the default configuration), the ''ussd-decode'' configuration setting should be set to ''all''.<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type''). If you want to send GSM 7 Bit for SMPP default encoding, please see how the setting is set below.<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-11-11T10:21:26Z

<p>Oana: /* ussd.finalize */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information from the user it can send another ''unstructuredSS-Request'' Invoke in a TCAP CONTINUE and wait for the answer. Once the network obtains all needed information, but wants (for user friendliness) to notify the user about the result of the operations, it can send: <br /> * a TCAP CONTINUE containing a ''unstructuredSS-Notify'' Invoke. When the user side respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'', the network can close the dialog through a TCAP END<br /> * if the network is not interested in the outcome of ''unstructuredSS-Notify'' Invoke operation, it can send a TCAP END containing ''unstructuredSS-Notify'' invoke.<br /> If there is nothing to notify to the user, the network can send a TCAP END to close the TCAP dialog.<br /> <br /> <br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> ** Set to false for UCS2 encoding without language indication<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> ** Set to false for UCS2 encoding without language indication<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> ** Set to false for UCS2 encoding without language indication<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> * '''text.encoding'''<br /> ** gsm7bit / GSM7Bit: text was encoded/is to be encoded GSM 7 Bit<br /> ** ucs2 / UCS2: text was encoded/is to be encoded UCS 2<br /> <br /> * '''text.lang'''<br /> ** two character string specifying a language according to ISO 639-1 or integer value if mapping is not provided.<br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> '''NOTE''': As of SVN revision 1285, there is a new ''camelmap'' module. For compatibility reasons, the old module, ''camel_map'', was also kept. Both modules read the same configuration file, ''camel_map.conf''. In order to avoid issues, please make sure to only enable one of these modules in the ''[postload]'' section of ''yate.conf''.<br /> <br /> The new module is the one that offers USSD UCS2 encoding without language indication, but beware that TCP functionality has been removed from it. That functionality has been moved to the ''xml_tcp'' module. The module only uses messages to communicate with applications. ''ussd_map'' uses messages, so there should be no need for TCP functionality.<br /> <br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> '''Note''' If SMPP is configured to expect decoded USSD texts (which is the default configuration), the ''ussd-decode'' configuration setting should be set to ''all''.<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type''). If you want to send GSM 7 Bit for SMPP default encoding, please see how the setting is set below.<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-11-11T10:20:59Z

<p>Oana: /* ussd.update */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information from the user it can send another ''unstructuredSS-Request'' Invoke in a TCAP CONTINUE and wait for the answer. Once the network obtains all needed information, but wants (for user friendliness) to notify the user about the result of the operations, it can send: <br /> * a TCAP CONTINUE containing a ''unstructuredSS-Notify'' Invoke. When the user side respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'', the network can close the dialog through a TCAP END<br /> * if the network is not interested in the outcome of ''unstructuredSS-Notify'' Invoke operation, it can send a TCAP END containing ''unstructuredSS-Notify'' invoke.<br /> If there is nothing to notify to the user, the network can send a TCAP END to close the TCAP dialog.<br /> <br /> <br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> ** Set to false for UCS2 encoding without language indication<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> ** Set to false for UCS2 encoding without language indication<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> * '''text.encoding'''<br /> ** gsm7bit / GSM7Bit: text was encoded/is to be encoded GSM 7 Bit<br /> ** ucs2 / UCS2: text was encoded/is to be encoded UCS 2<br /> <br /> * '''text.lang'''<br /> ** two character string specifying a language according to ISO 639-1 or integer value if mapping is not provided.<br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> '''NOTE''': As of SVN revision 1285, there is a new ''camelmap'' module. For compatibility reasons, the old module, ''camel_map'', was also kept. Both modules read the same configuration file, ''camel_map.conf''. In order to avoid issues, please make sure to only enable one of these modules in the ''[postload]'' section of ''yate.conf''.<br /> <br /> The new module is the one that offers USSD UCS2 encoding without language indication, but beware that TCP functionality has been removed from it. That functionality has been moved to the ''xml_tcp'' module. The module only uses messages to communicate with applications. ''ussd_map'' uses messages, so there should be no need for TCP functionality.<br /> <br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> '''Note''' If SMPP is configured to expect decoded USSD texts (which is the default configuration), the ''ussd-decode'' configuration setting should be set to ''all''.<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type''). If you want to send GSM 7 Bit for SMPP default encoding, please see how the setting is set below.<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-11-11T10:19:50Z

<p>Oana: /* ussd.execute */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information from the user it can send another ''unstructuredSS-Request'' Invoke in a TCAP CONTINUE and wait for the answer. Once the network obtains all needed information, but wants (for user friendliness) to notify the user about the result of the operations, it can send: <br /> * a TCAP CONTINUE containing a ''unstructuredSS-Notify'' Invoke. When the user side respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'', the network can close the dialog through a TCAP END<br /> * if the network is not interested in the outcome of ''unstructuredSS-Notify'' Invoke operation, it can send a TCAP END containing ''unstructuredSS-Notify'' invoke.<br /> If there is nothing to notify to the user, the network can send a TCAP END to close the TCAP dialog.<br /> <br /> <br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> ** Set to false for UCS2 encoding without language indication<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> * '''text.encoding'''<br /> ** gsm7bit / GSM7Bit: text was encoded/is to be encoded GSM 7 Bit<br /> ** ucs2 / UCS2: text was encoded/is to be encoded UCS 2<br /> <br /> * '''text.lang'''<br /> ** two character string specifying a language according to ISO 639-1 or integer value if mapping is not provided.<br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> '''NOTE''': As of SVN revision 1285, there is a new ''camelmap'' module. For compatibility reasons, the old module, ''camel_map'', was also kept. Both modules read the same configuration file, ''camel_map.conf''. In order to avoid issues, please make sure to only enable one of these modules in the ''[postload]'' section of ''yate.conf''.<br /> <br /> The new module is the one that offers USSD UCS2 encoding without language indication, but beware that TCP functionality has been removed from it. That functionality has been moved to the ''xml_tcp'' module. The module only uses messages to communicate with applications. ''ussd_map'' uses messages, so there should be no need for TCP functionality.<br /> <br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> '''Note''' If SMPP is configured to expect decoded USSD texts (which is the default configuration), the ''ussd-decode'' configuration setting should be set to ''all''.<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type''). If you want to send GSM 7 Bit for SMPP default encoding, please see how the setting is set below.<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-11-11T10:14:47Z

<p>Oana: /* camel_map module */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information from the user it can send another ''unstructuredSS-Request'' Invoke in a TCAP CONTINUE and wait for the answer. Once the network obtains all needed information, but wants (for user friendliness) to notify the user about the result of the operations, it can send: <br /> * a TCAP CONTINUE containing a ''unstructuredSS-Notify'' Invoke. When the user side respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'', the network can close the dialog through a TCAP END<br /> * if the network is not interested in the outcome of ''unstructuredSS-Notify'' Invoke operation, it can send a TCAP END containing ''unstructuredSS-Notify'' invoke.<br /> If there is nothing to notify to the user, the network can send a TCAP END to close the TCAP dialog.<br /> <br /> <br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> * '''text.encoding'''<br /> ** gsm7bit / GSM7Bit: text was encoded/is to be encoded GSM 7 Bit<br /> ** ucs2 / UCS2: text was encoded/is to be encoded UCS 2<br /> <br /> * '''text.lang'''<br /> ** two character string specifying a language according to ISO 639-1 or integer value if mapping is not provided.<br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> '''NOTE''': As of SVN revision 1285, there is a new ''camelmap'' module. For compatibility reasons, the old module, ''camel_map'', was also kept. Both modules read the same configuration file, ''camel_map.conf''. In order to avoid issues, please make sure to only enable one of these modules in the ''[postload]'' section of ''yate.conf''.<br /> <br /> The new module is the one that offers USSD UCS2 encoding without language indication, but beware that TCP functionality has been removed from it. That functionality has been moved to the ''xml_tcp'' module. The module only uses messages to communicate with applications. ''ussd_map'' uses messages, so there should be no need for TCP functionality.<br /> <br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> '''Note''' If SMPP is configured to expect decoded USSD texts (which is the default configuration), the ''ussd-decode'' configuration setting should be set to ''all''.<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type''). If you want to send GSM 7 Bit for SMPP default encoding, please see how the setting is set below.<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-08-07T14:42:48Z

<p>Oana: /* Network initiated USSD requests */ Changed description as per Vladimir's notes</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information from the user it can send another ''unstructuredSS-Request'' Invoke in a TCAP CONTINUE and wait for the answer. Once the network obtains all needed information, but wants (for user friendliness) to notify the user about the result of the operations, it can send: <br /> * a TCAP CONTINUE containing a ''unstructuredSS-Notify'' Invoke. When the user side respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'', the network can close the dialog through a TCAP END<br /> * if the network is not interested in the outcome of ''unstructuredSS-Notify'' Invoke operation, it can send a TCAP END containing ''unstructuredSS-Notify'' invoke.<br /> If there is nothing to notify to the user, the network can send a TCAP END to close the TCAP dialog.<br /> <br /> <br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> * '''text.encoding'''<br /> ** gsm7bit / GSM7Bit: text was encoded/is to be encoded GSM 7 Bit<br /> ** ucs2 / UCS2: text was encoded/is to be encoded UCS 2<br /> <br /> * '''text.lang'''<br /> ** two character string specifying a language according to ISO 639-1 or integer value if mapping is not provided.<br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> '''Note''' If SMPP is configured to expect decoded USSD texts (which is the default configuration), the ''ussd-decode'' configuration setting should be set to ''all''.<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type''). If you want to send GSM 7 Bit for SMPP default encoding, please see how the setting is set below.<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-07T12:36:21Z

<p>Oana: /* ysmpp module */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> * '''text.encoding'''<br /> ** gsm7bit / GSM7Bit: text was encoded/is to be encoded GSM 7 Bit<br /> ** ucs2 / UCS2: text was encoded/is to be encoded UCS 2<br /> <br /> * '''text.lang'''<br /> ** two character string specifying a language according to ISO 639-1 or integer value if mapping is not provided.<br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> '''Note''' If SMPP is configured to expect decoded USSD texts (which is the default configuration), the ''ussd-decode'' configuration setting should be set to ''all''.<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type''). If you want to send GSM 7 Bit for SMPP default encoding, please see how the setting is set below.<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-07T12:34:52Z

<p>Oana: /* camel_map module */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> * '''text.encoding'''<br /> ** gsm7bit / GSM7Bit: text was encoded/is to be encoded GSM 7 Bit<br /> ** ucs2 / UCS2: text was encoded/is to be encoded UCS 2<br /> <br /> * '''text.lang'''<br /> ** two character string specifying a language according to ISO 639-1 or integer value if mapping is not provided.<br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> '''Note''' If SMPP is configured to expect decoded USSD texts (which is the default configuration), the ''ussd-decode'' configuration setting should be set to ''all''.<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type'').<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T16:14:12Z

<p>Oana: /* Keyword values */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> * '''text.encoding'''<br /> ** gsm7bit / GSM7Bit: text was encoded/is to be encoded GSM 7 Bit<br /> ** ucs2 / UCS2: text was encoded/is to be encoded UCS 2<br /> <br /> * '''text.lang'''<br /> ** two character string specifying a language according to ISO 639-1 or integer value if mapping is not provided.<br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type'').<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T16:09:24Z

<p>Oana: /* ysmpp module */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> <br /> '''NOTE''' The module encodes text to ASCII for default encoding (configuration parameter ''default_encoding_type'').<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> ; use GSM 7 Bit for default SMPP encoding<br /> default_encoding_type=gsm7bit<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T16:06:27Z

<p>Oana: /* ysmpp module */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> '''NOTE''' The module encodes text to ASCII for default encoding.<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345<br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T15:55:26Z

<p>Oana: /* ussd_map module */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdscf1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdscf2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdhlr2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345 <br /> <br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T15:53:39Z

<p>Oana: /* camel_map module */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdscf1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdscf2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all <br /> <br /> [local ussdhlr2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=all<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdSCF1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdSCF2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345 <br /> <br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T15:51:07Z

<p>Oana: /* ussd.finalize */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdSCF1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdSCF2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdSCF1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdSCF2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345 <br /> <br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T15:50:44Z

<p>Oana: /* ussd.update */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdSCF1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdSCF2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdSCF1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdSCF2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345 <br /> <br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T15:48:59Z

<p>Oana: /* ussd.execute */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdSCF1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdSCF2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdSCF1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdSCF2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345 <br /> <br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T15:48:35Z

<p>Oana: /* ussd.update */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdSCF1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdSCF2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdSCF1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdSCF2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345 <br /> <br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana https://ss7api.null.ro/index.php/USSD_GW 2014-02-06T15:47:56Z

<p>Oana: /* ussd.finalize */</p> <hr /> <div>This is an implementation an USSD gateway acting as a MAP Service Control Function (gsmSCF) and as a HLR at the same time. When communicating with a HLR or VLR, the YATE USSD GW acts as a gsmSCF. When communicating with a gsmSCF, the YATE USSDGW acts as a HLR.<br /> The functionality of the USSD GW allows:<br /> * redirecting of USSD requests arriving either from user side or gsmSCF side to a SMPP client where they can be altered.<br /> * acting as a proxy for requests that need not be handled by SMPP clients or when the SMPP handling fails<br /> <br /> <br /> == MAP USSD description ==<br /> <br /> In versions 2 and 3 of the GSM MAP protocol there are 3 operations used for USSD operations:<br /> * processUnstructedSS-Request<br /> * unstructuredSS-Request<br /> * unstrusturedSS-Notify<br /> <br /> The are 2 scenarios for USSD operations:<br /> * mobile initiated USSD requests<br /> * network initiated USSD requests<br /> <br /> A TCAP dialog used by USSD is always terminated by the network side.<br /> <br /> <br /> === Mobile initiated USSD requests ===<br /> <br /> <br /> Mobile initiated USSD requests are USSD requests started by the mobile subscriber. <br /> <br /> A USSD request is started when receiving a TCAP BEGIN message containing the ''processUnstructedSS-Request'' Invoke operation. The request can be handled by the VLR, HLR or a gsmSCF. If the VLR does not handle the request, it will transmit it to the HLR. The HLR can either handle it itself or it can transmit it to a gsmSCF for handling.<br /> <br /> At this point, the network can either send a response to the request immediately or request additional information. In the first case, the handler of the request will send a TCAP End with ''processUnstructuredSS-Request'' ResultLast containing the result for the request. <br /> In the latter case, the network will send a TCAP CONTINUE with ''unstructuredSS-Request'' Invoke operation. The response of the mobile subscriber to this request will be passed to the network in a TCAP CONTINUE with ''unstructuredSS-Request'' ResultLast component. At this point, if the network decides that it has enough information for providing the response to the user, it will send a TCAP END with ''processUnstructuredSS-Request'' ResultLast. Otherwise, it can request further information through another ''unstructuredSS-Request'' Invoke operation.<br /> <br /> === Network initiated USSD requests ===<br /> <br /> <br /> Network initiated USSD requests are USSD requests started by the network towards a certain subscriber.<br /> <br /> Requests made by the network can be of one of two types:<br /> * user interaction requests<br /> * network notification requests.<br /> <br /> User interaction requests are USSD requests that the network makes in which it requires some type of information back from the mobile subscriber. These are started by the network through a TCAP BEGIN containing an ''unstructuredSS-Request'' Invoke. The answer from the mobile subscriber will be received in a TCAP CONTINUE containing an ''unstructuredSS-Request'' ResultLast. If the network still wants to request further information, it will repeat the process. Otherwise, it will send a TCAP END to close the TCAP dialog.<br /> <br /> Network notification requests are USSD requests in which the network only sends a notification to the user. This is achieved by sending a TCAP BEGIN message containing a ''unstructuredSS-Notify'' Invoke. The mobile subscriber side will only respond with a TCAP CONTINUE containing an empty ''unstructuredSS-Notify'' in order to signal that the notification was received. The network will close the TCAP dialog through TCAP END.<br /> <br /> === MAP USSD parameters ===<br /> <br /> <br /> The following list describe common parameters used across all MAP USSD operations:<br /> * ''destinationReference'': this parameter will contain either an MSISDN or an IMSI. In the case of mobile originated USSD request, this will identify the user which made the request. In the case of network initiated requests, it will identify the mobile user to be contacted for this request.<br /> * ''ussd-String'': for ''processUnstructuredSS-Request'' Invoke it contains the dialed USSD code, for the result it would probably contain a message from the network detailing the result of the request. For ''unstructuredSS-Request'' Invoke it will contain a message asking for the user to choose some option and for the result it will contain the option chosen by the user. In the case of ''unstructuredSS-Notify'', this parameter will only be present in the Invoke.<br /> * ''ussd-DataCodingScheme'': this is a parameter which specifies in which way the ''ussd-String'' parameter is encoded and it is present whenever ''ussd-String'' is present. E.g., this parameter would indicate if the ''ussd-String'' is encoded using GSM7bit encoding or UCS2.<br /> <br /> == SMPP USSD description ==<br /> <br /> '''TO DO'''<br /> <br /> == System description ==<br /> <br /> <br /> === System design ===<br /> <br /> In order to provide the specified functionality, the system makes use of the following YATE components:<br /> * the SS7 stack present in YATE <br /> * the camel_map module which decodes/encodes MAP messages coming from the SS7 network to/from internal YATE messages containing MAP operations in XML form. Together with the SS7 layer this provides MAP connectivity with HLR/gsmSCF.<br /> * the ussd_map module which takes internal MAP messsages decoded by the camel_map moduled and translates them to internal USSD messages. This module acts as gsmSCF towards a HLR and as a HLR towards a gsmSCF.<br /> * the SMPP stack present in YATE (ysmpp module) which is able to catch internal USSD messages and transmit them over SMPP. It also translates SMPP messages into internal USSD messages.<br /> * requests for new USSD sessions will go through routing to decide who should handle the request.<br /> <br /> <br /> The following sections detail the behaviour of the system in the different USSD scenarios.<br /> <br /> <br /> ==== Mobile originated USSD handling ====<br /> <br /> <br /> A user initiated USSD session is handled according to the following schema:<br /> <br /> <br /> [[File:user_initiated_ussd.png]]<br /> <br /> <br /> # HLR sends a ''processUnstructuredSS-Request (Invoke)'' for code *100#. camel_map decodes the ''ussd-String'' into ''ussd-Text=*100#''.<br /> # the ussd_map module (gsmSCF side) processes the request received from the HLR and emits a ''call.route'' message with ''called=*100#''.<br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with the ''callto'' parameter set to the value returned from routing. ussd_map dispatches the ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will send it to the target specified in ''callto'' parameter after the module prefix ''ysmppserver/''.<br /> # The ysmpp module receives and process the received ''submit_sm'' message.<br /> # The ysmpp module will send a ''call.route'' message with the ''called=*100#''.<br /> # The ysmpp module emits a ''ussd.execute'' message with ''callto=retvalue from call.route'' message.<br /> # The ussd_map module (HLR part) processes the ussd.execute message and if it is the target of the message, meaning that ''callto'' starts with ''ussd_map/''. From that message it will build a map.message that it will send to the gsmSCF as a ''processUnstructuresSS-Request (Invoke)'' MAP message.&lt;br&gt;'''NOTE:''' From here on, the gsmSCF could handle the request in one of two distinguished cases: one where the gsmSCF requires interaction with the mobile subscriber and one where the gsmSCF just needs to respond to the user request. The following steps detail the former case.&lt;br&gt;<br /> # gsmSCF sends an ''unstructuredSS-Request (Invoke)'' to request further information.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits an ''ussd.update'' message.<br /> # The ysmpp module receives the ''ussd.update'' message and confirms to the SMPP client that the message sent in step 5 was processed.<br /> # The SMPP client should confirm the processing of the SMPP message sent in step 4.<br /> # The ysmpp module sends a ''deliver_sm'' message to the SMPP client with the menu received in ''ussd.update'' message.<br /> # The SMPP client should send a ''submit_sm'' message with the received menu.<br /> # The ysmpp module receives the ''submit_sm'' message from SMPP client and emits a ''ussd.update'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.update'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time in which the mobile subscribers responds can be quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway when receiving the response from the mobile subscriber.<br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 13.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 21.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 9 and 24 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''processUnstructuredSS-Request (ResultLast)'' for the initial user request.<br /> # The ussd_map module (HLR part) processes the ''processUnstructuredSS-Request (ResultLast)'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 22 or 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 21 or 4.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 31.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 29.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''processUnstructuredSS-Request (ResultLast)''.<br /> <br /> ==== Network initiated USSD Request ====<br /> <br /> A network initiated USSD session is handled as described in the following figure:<br /> <br /> [[File:network_initiated_ussd.png]]<br /> <br /> # gsmSCF sends''unstructuredSS-Request (Invoke)'' to USSD Gateway (HLR part) to present a menu for MSISDN 0015559191.<br /> # The ussd_map module (HLR part) processes the ''unstructuredSS-Request (Invoke)'' message and emits a ''call.route'' message with called=0015559191. <br /> # After ussd_map module successfully dispatched the call.route message, it generates a ''ussd.execute'' message with ''callto'' set to the route returned in the return value of the ''call.route'' message and dispatches an ''ussd.execute'' message.<br /> # The ysmpp module catches the ''ussd.execute'' message and if the ''callto'' param value starts with ''ysmppserver/'' and with it it builds a ''deliver_sm'' message that it will then send to the target specified in the ''callto'&quot; parameter after the ''ysmppserver'' module prefix.<br /> # The SMPP client should send a ''submit_sm'' message towards SMPP server.<br /> # The SMPP server processes the received ''submit_sm'' message and dispatches a ''call.route'' message.<br /> # After successfully dispatching of ''call.route'' message the SMPP server will dispatch a ''call.execute'' message.<br /> # The ussd_map module (SCF part) process the ''ussd.execute'' message and sends an ''unstructuredSS-Request (Invoke)'' towards the HLR.&lt;br&gt;The time to receiving a response from the user after gsmSCF has requested user interaction could be possibly quite long.&lt;br&gt;<br /> # The HLR sends ''unstructuredSS-Request (ResultLast)'' to USSD gateway <br /> # The ussd_map module (SCF part) processes the message and emits a ''ussd.update'' message.<br /> # ysmpp module processes the ''ussd.update'' message and sends ''submit_sm rsp'' to SMPP client to confirm the reception of the message sent on step 5.<br /> # The SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 4.<br /> # The ysmpp module will send a deliver_sm message to SMPP clients which will contain user's response.<br /> # The SMPP client should send a ''submit_sm'' message to SMPP server which will contain the message received on step 13.<br /> # The ysmpp module receives the ''submit_sm'' message and emits a ''ussd.update'' message.<br /> # The ussd_map module (HLR part) receives the ''ussd.update'' message and sends the ''unstructuredSS-Request (ResultLast)'' to gsmSCF.&lt;br&gt;'''NOTE:''' Steps between 1 and 16 can be repeated.&lt;br&gt;<br /> # The gsmSCF sends ''TCAP END'' in order to finish the USSD session.<br /> # The ussd_map module (HLR part) processes the ''TCAP END'' and sends a ''ussd.finalize'' message.<br /> # The ysmpp module receives the ''ussd.finalize'' message and sends a ''submit_sm rsp'' for the message received on point 14.<br /> # The SMPP client should send a ''deliver_sm rsp'' for the message received on point 13.<br /> # The ysmpp module sends a ''deliver sm + last message indication'' to SMPP client.<br /> # The SMPP client should send a ''submit sm + last message indication'' to SMPP server.<br /> # ysmpp module sends ''submit_sm rsp'' to confirm the message received on step 22.<br /> # SMPP client should send a ''deliver_sm rsp'' to confirm the message received on step 21.<br /> # ysmpp module receives ''submit_sm'' message and sends a ''ussd.finalize'' message.<br /> # The ussd_map module (SCF part) processes the ''ussd.finalize'' message and sends ''END''.<br /> <br /> <br /> <br /> <br /> <br /> ==== Fallback/Proxy mode ====<br /> <br /> <br /> The following images detail scenarios where the USSD GW is instructed to do failover.<br /> <br /> <br /> <br /> [[File:user_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when an HLR sends ''processUnstructuredSS-Request (Invoke)'' (1).<br /> <br /> '''NOTES:''' <br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message. <br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> <br /> Network initiated USSD session fallback.<br /> <br /> [[File:network_initiated_failover.png]]<br /> <br /> The picture above details a failover scenario for when a gsmSCF sends a &quot;unstructuredSS-Request/unstructuredSS-Notify (Invoke)'' (1).<br /> <br /> '''NOTES:'''<br /> * The read circles in the above picture represent points in handling where a fallback decision can be made.<br /> * A fallback decision can be made only if in all previous fallback decision points the necessity for failover was determined to be false.<br /> * '''U1''' and '''U2''' represent SMPP message responses.<br /> <br /> Decision points where ''ussd_map'' will determine the need for failover:<br /> *'''E1''': Routing procedure does not return a valid route (''call.route'' returns with false or an error) or routing decision indicates a failover route (routing return a route starting with prefix ''ussd_map/'')<br /> *'''E2''': ''ussd.execute'' message fails to be processed (in this case by the ysmpp module)<br /> *'''E3''': SMPP server received an SMPP error for ''deliver_sm'' message.<br /> *'''E4''': SMPP client received an SMPP error for ''submit_sm'' message.<br /> *'''E5''': The ''call.route'' message emitted by ''ysmpp'' does not return a valid route (''call.route'' returns with false or an error).<br /> *'''E6''': ''ussd.execute'' message fails to be processed (in this case by the ussd_map module).<br /> <br /> <br /> The SMPP USSD gateway will also be bypassed when the ''ussd_map'' module is configured to do failover for all requests.<br /> <br /> Any type of SMPP error received either in the result for the ''ussd.execute'' or in the first message back from SMPP that does not have a mapping on MAP will lead to the ''ussd_map'' module doing failover. Errors that would generate a failover are errors like timeout, session ended abnormally, unknown errors, congestion errors.<br /> <br /> <br /> Once ''ussd_map'' decides that failover should be done, it will use the original received message from the HLR (MO case)/gsmSCF (MT case) and it will only alter the called address to be the one of the gsmSCF/HLR set for the failover.. The calling address will remain the one received from HLR/gsmSCF, the idea being that for the first message we want to pretend that we are the original gsmSCF/HLR. When the receiving end of this message will want to respond, it will use the calling address from the message. Seeing that the ''ussd_map'' module set it to the original calller's address, further messages exchanged in that dialog between HLR and gsmSCF will not pass through USSD GW again.<br /> <br /> <br /> <br /> ==== Internal message API ====<br /> <br /> This section documents the YATE messages used internally by the USSD GW.<br /> <br /> ===== call.route =====<br /> <br /> <br /> This message is used by ussd_map and ysmpp module to determine a destination where a new USSD session should be sent for further processing.<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module when receiving a request for a new USSD session on MAP for ''ussd_map'' or on SMPP for ''ysmpp''.<br /> ''ussd_map'' will only send this message if default routing is not enabled from configuration.<br /> <br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> * module<br /> ** type: string <br /> ** Name of the module which requested routing<br /> * application<br /> ** type: string<br /> ** Name of the ussd_map application which sent this routing request<br /> * route_type<br /> ** type: keyword, value: ussd <br /> ** Specifies routing type, in this case it'll be USSD routing<br /> * smpp_session_id<br /> ** type: string<br /> ** TODO<br /> * smpp_system_id<br /> ** type: string<br /> ** TODO<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * if the message was processed, the return value of the message indicates the destination of the subsequent ''ussd.execute'' message.<br /> * if the message was not processed or it returned with error (signaled by the return value being either &quot;-&quot; or &quot;error&quot;)<br /> ** ''ussd_map'' will do failover<br /> ** ysmpp will close the SMPP session, indicating an error either set by the call.route or either set to the default unknown error indication.<br /> <br /> ===== ussd.execute =====<br /> <br /> This message is used to begin a new USSD session:<br /> * on SMPP, if the message is directed to the ''ysmpp'' module<br /> * on MAP if the message is directed to the ''ussd_map'' module<br /> <br /> This message is sent by either ''ussd_map'' module or ''ysmpp'' module after successful routing stage. In case of the ''ussd_map'' module, this is message is sent if the routing stage did not indicate failover necessity.<br /> <br /> <br /> <br /> Parameters:<br /> * callto: <br /> ** type : string<br /> ** It specifies the target module to process the message. The string should start with 'ysmppserver/' for the ''ysmpp&quot; module and with ''ussd_map/'' for the ''ussd_map'' module.<br /> * id:<br /> ** type: string<br /> ** Identifier for the USSD session used by the dispatcher of the message.<br /> * called:<br /> ** type: string<br /> ** It specifies the value on which destination is determined. For a MO USSD session, this parameter will contain the decoded USSD string (USSD request code). For a MT USSD sessions, this parameter will contain the destination MSISDN.<br /> * callednumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the called parameter. It is used only when called is a MSISDN<br /> * callednumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the called parameter. It is used only when called is a MSISDN.<br /> * caller:<br /> ** type: string:<br /> ** Identifies the caller in this USSD session. For MO USSD it can be the MSISDN (if present) . ''ussd_map'' will set the the calling party address GT in this parameter for MT case or if MSISDN is not specified for MO case.<br /> * callernumtype:<br /> ** type: keyword<br /> ** It specifies type (NAI) of the caller parameter.<br /> * callernumplan:<br /> ** type: keyword<br /> ** Numbering plan for the number specified by the caller parameter.<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of USSD operation that fired this message.<br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> ** '''NOTE''': If YATE uses in the internal messages the decoded text, this parameter should not be set (it has higher priority in ussd_map).<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * imsi:<br /> ** type: string<br /> ** IMSI value if available.<br /> * hlr:<br /> ** type: string<br /> ** It specifies the HLR GTT if that information was available.<br /> * hlr.nature:<br /> ** type: keyword<br /> ** It specifies HLR GTT nature (NAI)<br /> * hlr.plan:<br /> ** type: keyword<br /> ** It specifies HLR GTT numbering plan<br /> * vlr:<br /> ** type: string<br /> ** It specifies the VLR GTT if that information was available.<br /> * vlr.nature:<br /> ** type: keyword<br /> ** It specifies VLR GTT nature (NAI)<br /> * vlr.plan:<br /> ** type: keyword<br /> ** It specifies VLR GTT numbering plan<br /> * gsmscf:<br /> ** type: string<br /> ** It specifies the gsmSCF GTT if that information was available.<br /> * gsmscf.nature:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT nature (NAI)<br /> * gsmscf.plan:<br /> ** type: keyword<br /> ** It specifies gsmSCF GTT numbering plan<br /> * destination_reference:<br /> ** type: string<br /> ** MSISDN or IMSI specified in the DestinationReference TCAP MAP parameter.<br /> * destination_reference.nature:<br /> ** type: keyword<br /> ** It specifies DestinationReference nature (NAI)<br /> * destination_reference.plan:<br /> ** type: keyword<br /> ** It specifies DestinationReference numbering plan<br /> * msisdn:<br /> ** type: string<br /> ** MSISDN <br /> * alert_pattern:<br /> ** type: string<br /> ** Alert Pattern parameter as received in the USSD MAP message.<br /> <br /> Note:<br /> * The hlr/vlr address represents:<br /> ** the address from which the message was received (if it can be determined) for MO USSD session.<br /> ** the address where the message should be sent for MT USSD session.<br /> <br /> Returned parameters:<br /> * peerid:<br /> ** type: string<br /> ** Identifier assigned for this USSD session by the entity that processed this message.<br /> * error:<br /> ** type: keyword<br /> ** Error returned if the message was not processed.<br /> <br /> Processing of this message will return failure:<br /> * if the message will not be processed<br /> * if the 'id' parameter is missing.<br /> * in case of processing error <br /> * in case of congestion<br /> <br /> ===== ussd.update =====<br /> <br /> <br /> This message is used for transmitting USSD messages during a USSD session. This type of message will be used after the initial stage of creating the session through ''ussd.execute'' has succeeded.<br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP CONTINUE message <br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client.<br /> <br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by peerid parameter cannot be found by the processing side.<br /> * Processing of this message will be refused if it is received after a ''ussd.finalize'' message.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a values not allowed in the context of the USSD session (e.g., sending a ''processUnstructuredSS-Request inside a ''ussd.update'' message)<br /> <br /> ===== ussd.finalize =====<br /> <br /> This message is used to signal the termination of the USSD session. Successful processing of this message means that the USSD session was terminated and is no longer available. <br /> <br /> When receiving this message:<br /> * the ''ussd_map'' module will generate a TCAP END/ABORT message depending upon the parameters received. A message containing an error that does not map to a MAP error will generate a TCAP ABORT.<br /> * the ''ysmpp'' module will generate a SMPP ''deliver_sm'' if it acts as a server (as in the case of the USSD GW) or ''submit_sm'' if it acts as a SMPP client, a message that will usually contain a last message indication.<br /> <br /> Parameters:<br /> * id:<br /> ** type: string<br /> ** USSD session identifier of the sending side of the message<br /> * peerid:<br /> ** type: string<br /> ** USSD session identifier for the module that should process this message<br /> * operation_type:<br /> ** type: keyword<br /> ** The type of operation that fired this message. <br /> * text_encoding:<br /> ** type: hexified string<br /> ** The MAP USSD data coding scheme<br /> * text_encoded:<br /> ** type: hexified string<br /> ** The encoded USSD string<br /> * text:<br /> ** type: string<br /> ** The decoded USSD string conforming to the USSD data coding scheme.<br /> * text.encoding:<br /> ** type: keyword<br /> ** The USSD data coding scheme.<br /> * text.lang:<br /> ** type: keyword<br /> ** The language of the decoded text as obtained from the data coding scheme on MAP or from language indicator on SMPP.<br /> * text.lang_indication:<br /> ** type: boolean<br /> ** True if the language was decoded from the USSD string and not from the data coding scheme or if should be encoded on MAP in the USSD string payload.<br /> * error:<br /> ** type: keyword<br /> ** Error received from one the USSD session endpoints. It might be a MAP error when HLR/gsmSCF/ failed to process a request or SMPP error when the SMPP client failed to process a request.<br /> <br /> Returned parameters:<br /> * error:<br /> ** type: keyword<br /> ** Error code if this message failed to be processed.<br /> <br /> Points of failure:<br /> * The USSD session specified by 'peerid parameter cannot be found by the processing side.<br /> * Processing of this message will return an error if there are mandatory parameters missing of if the parameters specify a value not allowed in the context of the USSD session<br /> <br /> ===== Keyword values =====<br /> <br /> This section details acceptable values for parameters listed as having type ''keyword''.<br /> <br /> * '''hlr.nature/vlr.nature/gsmscf.nature/destination_reference.nature'''<br /> ** unknown<br /> ** international<br /> ** national<br /> ** network-specific<br /> ** subscriber<br /> ** abbreviated<br /> <br /> * '''hlr.plan/vlr.plan/gsmscf.plan/destination_reference.plan'''<br /> ** unknown<br /> ** isdn<br /> ** data<br /> ** telex<br /> ** land-mobile<br /> ** national<br /> ** private<br /> <br /> * '''operation_type'''<br /> ** pssd: mapping of MAP v1 USSD operation ''processUnstructuredSS-Data'' and of SMPP operation ''PSSD''. <br /> ** pssr: mapping of MAP v2 USSD operation ''processUnstructuredSS-Request'' and of SMPP operation ''PSSR''.<br /> ** ussr: mapping of MAP v2 USSD operation ''unstructuredSS-Request'' and of SMPP operation ''USSR&quot;.<br /> ** ussn: mapping of MAP v2 USSD operation ''unstructuredSS-Notify'' and of SMPP operation ''USSN''.<br /> <br /> * '''error'''<br /> ** invalid_logic: error reported when required processing does not follow USSD rules (e.g., MT request starting with ''processUnstructuredSS-Requests'')<br /> ** system_failure: error mapping for MAP error ''systemFailure''.<br /> ** data_missing: error mapping for MAP error ''dataMissing''.<br /> ** unexpected_data: error mapping for MAP error ''unexpectedDataValue''.<br /> ** unknown_alphabet: error mapping for MAP error ''unknownAlphabet''.<br /> ** absent_subscriber: error mapping for MAP error ''absentSubscriber''.<br /> ** illegal_subscriber: error mapping for MAP error ''illegalSubscriber''.<br /> ** illegal_equipment: error mapping for MAP error ''illegalEquipment''.<br /> ** ussd_busy: error mapping for MAP error ''ussd-Busy''.<br /> ** call_barred: error mapping for MAP error ''callBarred''.<br /> ** network_failure: error signaling message transmission failure due to connectivity issues either on the SS7 side or SMPP side.<br /> ** timeout_expired: error signaling a request timeout occurrence.<br /> ** ussd_sess_end_abnormally: error signaling USSD session termination due to an unknown cause. Mapping for this error implies a TCAP Abort either being generated of received. <br /> ** unknown_error: error specified when there is no available mapping for an errror from SMPP to MAP or vice versa.<br /> ** throttling_error: error signaling that a message failed to be processed due to processing side being in congestion state.<br /> ** protocol_error: SMPP generic error. This error is put whenever there is a SMPP specific error that cannot be mapped into one of the other errors.<br /> <br /> <br /> ==== SMPP custom parameters ====<br /> <br /> * 0x1502 =&gt; IMSI;<br /> * 0x1503 =&gt; VLR Type of Number;<br /> * 0x1504 =&gt; VLR Numbering Plan Indicator;<br /> * 0x1505 =&gt; VLR address;<br /> * 0x1506 =&gt; GSM SCF Type of Number;<br /> * 0x1507 =&gt; GSM SCF Numbering Plan Indicator;<br /> * 0x1508 =&gt; GSM_SCF address;<br /> * 0x1509 =&gt; Destination Reference Type of Number;<br /> * 0x150a =&gt; Destination Reference Numbering Plan Indicator;<br /> * 0x150b =&gt; Destination Reference;<br /> * 0x150c =&gt; MSISDN<br /> * 0x150d =&gt; Alerting Pattern<br /> * 0x1800 =&gt; HLR Type of Number;<br /> * 0x1801 =&gt; HLR Numbering Plan Indicator;<br /> * 0x1802 =&gt; HLR address.<br /> <br /> === Configuration ===<br /> <br /> ==== ysigchan module ====<br /> <br /> In order to have MAP connectivity, TCAP instances must be configured in ''ysigchan.conf'': <br /> <br /> ; Example of a SS7 Transaction Capabilities Application Part<br /> ; This component is created when encountering a section of this kind<br /> ;[ss7tcap]<br /> ; type: keyword: identifies the component as a SS7 Transfer Capabilities Application Part<br /> ; type = ss7-tcap-ansi for ANSI TCAP<br /> ; type = ss7-tcap-itu for ITU TCAP<br /> ;type=<br /> <br /> ; local_SSN: local SubSystem Number. Mandatory<br /> ;local_SSN=<br /> <br /> ; default_remote_SSN: remote SubSystem Number to provide to SCCP if the application does not provide one<br /> ;default_remote_SSN=<br /> <br /> ; default_remote_pointcode: remote Point Code to provide to SCCP if the application does not provide one<br /> ;default_remote_pointcode=<br /> <br /> ; pointcodetype: remote Point Code type. See above documentation for available types<br /> ;pointcodetype=<br /> <br /> ; sccp: Name of the SCCP component to create and be used by this TCAP<br /> ; A section with the name given here must exist in order to configure the SCCP level<br /> ;sccp=<br /> <br /> ; default_hopcounter: HopCounter provided to SCCP if the application does not provide one<br /> ; Values range 1-15, 0 or boolean false disables, boolean true sets to 15<br /> ; A non-zero value will force using XUDT or LUDT instead of UDT messages<br /> ;default_hopcounter=false<br /> <br /> ; transact_timeout: Time in seconds to timeout a TCAP transaction after no more activity was registered on it<br /> ; NOTE: Values below 15 seconds will be ignored and the timer will assume the default value.<br /> ; Defaults to 300 seconds<br /> ;transact_timeout=300<br /> <br /> ; max_timeout_checks: integer: Maximum number of timeout checks done on a transaction without starting the transaction<br /> ; timer before forcefully starting the transaction timer<br /> ; Defaults to 10<br /> ;max_timeout_checks=10 <br /> <br /> ; timeout_check: Time interval in milliseconds to check for timeouts.<br /> ; Default to 100 ms<br /> ;timeout_check=100 <br /> <br /> ; floodevents: int: How many queued incoming TCAP messages trigger a congestion warning and the drop mechanism<br /> ; for Unidirectional/Begin/QueryWithPermission/QueryWithoutPermission messages.<br /> ; Exit from congestion will take place when there are less the floodevents/4 messages in the queue<br /> ; NOTE! Setting this parameter to 0 will disable the congestion warning and protection. Setting it to one will <br /> ; be overriden and floodevents will be set to 2.<br /> ;floodevents=1000<br /> <br /> ;print-messages: Boolean to enable/disable printing of decoding/encoding of TCAP messages<br /> ; This option applies on reload<br /> ;print-messages=false<br /> <br /> ;extended-debug: Boolean to enable/disable printing of the step-by-step decoding/encoding of TCAP messages<br /> ; This option applies on reload. print-messages must be true.<br /> ;extended-debug=false<br /> <br /> ; hash_list_size: integer: Size of HashList used for keeping the list of current transactions<br /> ;hash_list_size=17<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> [tcap-scf] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=147 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> floodevents=1000 <br /> <br /> <br /> [tcap-hlr] <br /> ;enable=no <br /> type=ss7-tcap-itu <br /> sccp=sccp <br /> local_SSN=7 <br /> pointcodetype=ITU <br /> print-messages=false <br /> extended-debug=false <br /> transact_timeout=600 <br /> <br /> <br /> Further configuration for SS7 connectivity is required (SCCP, MTP3, etc.).<br /> <br /> ==== camel_map module ====<br /> <br /> Configuring of tracking IDs is done in the ''general'' section:<br /> <br /> [general]<br /> <br /> ;track_id: string: Shared engine variable name used to obtain a unique tracking ID for TCAP transactions<br /> ; If not set, the module will not set a tracking ID for the TCAP transaction<br /> ;track_id=<br /> <br /> ;track_id_base: string: Optional string with which to prefix the tracking ID<br /> ; This setting has no effect if track_id is not set<br /> ;track_id_base=<br /> <br /> In order to allow communication over MAP through SS7, sections configurating application should exist for each role of the ussd_map module (gsmSCF/HLR). A ''camel_map.conf'' section configuring an application looks like this:<br /> <br /> ;[local appName]<br /> ; This section configures a local application which transmits the XML messages as internal Yate messages<br /> <br /> ; translator: string: name of translator to be used by this application.<br /> ; Must be one one the [tcap ...] sections configured in the camel_map.conf file.<br /> ;translator=<br /> <br /> ; capabilities: string: List of capabilities separated by commas which this application supports<br /> ;capabilities=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into a Yate message<br /> ; Allowed values are:<br /> ; - string: pass the XML as a string<br /> ; - object: pass the XML as an object<br /> ; - both: pass the XML as a string and object<br /> ;export_xml_as=object<br /> <br /> ; enable: bool: Enable this application<br /> ;enable=yes<br /> <br /> The translator setting refers to a section of the type defined below which configures atachement to a TCAP instance<br /> <br /> ;[tcap map]<br /> ; This section configures a TCAP User MAP/CAMEL protocol translator<br /> <br /> ; enable: bool: Enable this translator<br /> ;enable=yes<br /> <br /> ; type: string: Type of TCAP User <br /> ; Allowed values are MAP or CAMEL<br /> ;type=MAP<br /> <br /> ; host: IP address: Address on which the TCP listener should bind on for XML communication<br /> ;host=127.0.0.1 <br /> <br /> ; port: integer: Port on which the TCP listener should bind on for XML communication<br /> ; Note: setting port to 0 will disable the listener, so it will not accept TCP applications<br /> ;port=5555<br /> <br /> ; tcap: string: Name of TCAP to which this TCAP user should attach itself to for the SS7 communication<br /> ;tcap=<br /> <br /> ; add-encoding: bool: Always add encoding attribute to XML elements for decoded parameters<br /> ;add-encoding=default from [general]<br /> <br /> ; add-timestamp: bool: Add to XML timestamps used for estimating application latency<br /> ;add-timestamp=default from [general] <br /> <br /> ; print-messages: bool: Debug option to print TCAP and XML messages. This option is applicable on reload.<br /> ;print-messages=false<br /> <br /> ; ussd-string: string: Specifies what the ussd-String parameter will contain as data<br /> ; Allowed values are:<br /> ; - octets: ussd-String will contain the octets as they were received<br /> ; - text: ussd-String will contain the GSM7Bit decoded text<br /> ; This can be overriden in application sections<br /> ;ussd-string=text<br /> <br /> ; ussd-decode: string: Specifies what ussd-String parameters should be decoded into text<br /> ; Allowed values are:<br /> ; - none: ussd-String parameters will never be decoded into text<br /> ; - first: ussd-String in a TCAP Begin message will be decoded into text<br /> ; - all: all ussd-String parameters will be decoded into text<br /> ; This can be overriden in application sections<br /> ;ussd-decode=all<br /> <br /> ; hash_list_size: integer: Size of HashList used for mapping of TCAP transactions to applications<br /> ;hash_list_size=17<br /> <br /> <br /> For load sharing (especially in cases of high loads), you can configure multiple applications using the same translator.<br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 applications acting as a gsmSCF, each one attached to the TCAP instance with gsmSCF SSN, and 2 applications as HLR, each one attached to the TCAP instance with HLR SSN 6:<br /> <br /> [general]<br /> track_id=ussdgw<br /> track_id_base=ussdgw/<br /> <br /> [tcap scf] <br /> ;enable=no <br /> tcap=tcap-scf <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [tcap hlr] <br /> ;enable=no <br /> tcap=tcap-hlr <br /> host=0.0.0.0 <br /> port=0 <br /> type=MAP <br /> print-messages=false <br /> add-encoding=false <br /> <br /> [local ussdSCF1] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdSCF2] <br /> translator=scf <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR1]<br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first <br /> <br /> [local ussdHLR2] <br /> translator=hlr <br /> capabilities=USSD <br /> export_xml_as=object <br /> ussd-string=octets <br /> ussd-decode=first<br /> <br /> ==== ussd_map module ====<br /> <br /> The module is configured through ''ussd_map.conf''. The configuration file sets timeout parameters and processing threads parameters in the ''general'' section:<br /> <br /> [general]<br /> <br /> ; hash_list_size: integer: Size of HashList for keeping dialogs<br /> ;hash_list_size=17<br /> <br /> ; component_ttl: integer: Component time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; Defaults to 600000 (10 minutes)<br /> ;component_ttl=600000<br /> <br /> ; dialog_idle_ttl: integer: Dialog idle (nothing sent/received) time to live in milliseconds<br /> ; Minimum allowed value is 1000<br /> ; It can be set to 0 to keep it alive until the remote party terminates the dialog<br /> ; Defaults to 86400000 (1 day)<br /> ;dialog_idle_ttl=86400000<br /> <br /> ; dialog_ended_ttl: integer: Ended dialog time to live in milliseconds<br /> ; Minimum allowed value is 1000.<br /> ; It can be set to 0 to remove the dialog after termination<br /> ; Defaults to 0<br /> ;dialog_ended_ttl=0<br /> <br /> ; dispatcher_maxthreads: integer: Maximum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ; NOTE: if the value is set to 0, the module will enqueue the messages into YATE's engine.<br /> ;dispatcher_maxthreads=0<br /> <br /> ; dispatcher_minthreads: integer: Minimum number of message dispatch threads to use<br /> ; Minimum value is 1 for use of dispatching threads.<br /> ;dispatcher_minthreads=1<br /> <br /> ;dispatcher_priority: string: Default priority of message dispatch threads<br /> ;dispatcher_priority=normal<br /> <br /> ; floodevents: integer: Threshold for signaling congestion when the number of messages waiting to be dispatched exceeds it.<br /> ; When entering congestion, all new MAP dialogs and USSD sessions will be refused.<br /> ; 0 disables the mechanism<br /> ;floodevents=0<br /> <br /> ; congestion_exit_factor: double: Factor used to calculate the exit congestion threshold<br /> ; NOTE: if the factor results in a exit congestion threshold of 0 or greater than floodevents, <br /> ; the setting will be overriden and the exit congestion threshold will be set to 1.<br /> ;congestion_exit_factor=0.5<br /> <br /> <br /> Timeout settings should be correlated with timeout settings in TCAP and SMPP, each having its own timeout mechanism.<br /> <br /> <br /> Gateway applications which do the MAP &lt;-&gt; USSD translation are configured through section like the one below:<br /> <br /> [appName]<br /> ; section name is the name of the camel_map application, it must correspond to a [local appName] section in camel_map <br /> <br /> ; enable: boolean: Enable this application<br /> ; Defaults to yes<br /> ;enable=yes<br /> <br /> ; type: string: Type of MAP &lt;-&gt; USSD translator: <br /> ; - SCF means that is the part that receives new dialogs from the HLR (user initiated USSD)<br /> ; - HLR is the part that receives new dialogs from gsmSCF (network initiated USSD)<br /> ; This setting cannot be changed on reload.<br /> ;type=<br /> <br /> ; export_xml_as: string: Specify in which way the XML will be passed along into <br /> ;export_xml_as=object<br /> <br /> ; print_msg: boolean: Print sent/received messages to output<br /> ;print_msg=no<br /> <br /> ; print_xml: boolean: Print sent/received XML data to output<br /> ;print_xml=no<br /> <br /> ; local_addr. : prefix: Parameters prefixed with this set the local SCCP address of this application <br /> ; Meaningful values are:<br /> ; local_addr.CallingPartyAddress.route=<br /> ; local_addr.CallingPartyAddress.ssn=<br /> ; local_addr.CallingPartyAddress.pointcode=<br /> ; local_addr.CallingPartyAddress.gt=<br /> ; local_addr.CallingPartyAddress.gt.nature=<br /> ; local_addr.CallingPartyAddress.gt.plan=<br /> ; local_addr.CallingPartyAddress.gt.translation=<br /> ; local_addr.CallingPartyAddress.gt.encoding= <br /> <br /> ; default_routing: bool : Do routing to default address for all messages<br /> ; default_routing=no<br /> <br /> ; default_addr. : prefix: parameters prefixed with this will be used as the default SCCP called address<br /> ; Meaningful values are:<br /> ; default_addr.application=<br /> ; default_addr.CalledPartyAddress.route=<br /> ; default_addr.CalledPartyAddress.ssn=<br /> ; default_addr.CalledPartyAddress.pointcode=<br /> ; default_addr.CalledPartyAddress.gt=<br /> ; default_addr.CalledPartyAddress.gt.nature=<br /> ; default_addr.CalledPartyAddress.gt.translation=<br /> ; default_addr.CalledPartyAddress.gt.encoding=<br /> <br /> ; hlr_ssn: integer: The SSN expected in the calling address from a HLR.<br /> ; This setting has significance only for SCF type applications<br /> ;hlr_ssn=6<br /> <br /> ; vlr_ssn: integer: The SSN expected in the calling address from a VLR.<br /> ; This setting has significance only for SCF type applications<br /> ;vlr_ssn=7<br /> <br /> <br /> <br /> Each section should have its own equivalent in ''camel_map.conf''.<br /> In the USSD GW scenario, at least tho applications are needed, one acting as SCF, one as HLR. For load sharing multiple gsmSCF and HLR applications can be configured (see the configuration example below).<br /> <br /> <br /> <br /> '''Configuration Example'''<br /> <br /> The example below configures 2 gsmSCF applications and 2 HLR applications, each one corresponding with a application section in the ''camel_map.conf'' example:<br /> <br /> [general] <br /> <br /> component_ttl=600000 <br /> dialog_ended_ttl=0 <br /> dispatcher_maxthreads=10 <br /> dispatcher_minthreads=5 <br /> ;dispatcher_priority=normal <br /> floodevents=1000 <br /> <br /> [ussdSCF1] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdSCF2] <br /> ;enable=no <br /> type=SCF <br /> export_xml_as=object <br /> print_msg=no <br /> print_xml=no <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdHLR <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820723 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR1] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd <br /> <br /> [ussdHLR2] <br /> ;enable=no <br /> type=HLR <br /> print_msg=no <br /> print_xml=no <br /> export_xml_as=object <br /> <br /> local_addr.CallingPartyAddress.route=gt <br /> local_addr.CallingPartyAddress.gt=8828723 <br /> local_addr.CallingPartyAddress.gt.nature=international <br /> local_addr.CallingPartyAddress.gt.plan=isdn <br /> local_addr.CallingPartyAddress.gt.translation=0 <br /> local_addr.CallingPartyAddress.gt.encoding=bcd <br /> <br /> default_routing=no <br /> default_addr.application=ussdSCF <br /> default_addr.CalledPartyAddress.route=gt <br /> default_addr.CalledPartyAddress.gt=8820457 <br /> default_addr.CalledPartyAddress.gt.nature=international <br /> default_addr.CalledPartyAddress.gt.plan=isdn <br /> default_addr.CalledPartyAddress.gt.translation=0 <br /> default_addr.CalledPartyAddress.gt.encoding=bcd<br /> <br /> ==== ysmpp module ====<br /> <br /> TODO - configuration explanations<br /> <br /> '''Configuration Example''''<br /> <br /> [general] <br /> server=smpp-server <br /> track_id=ussdgw <br /> track_id_base=ussdgw/ <br /> <br /> [smpp-server] <br /> enable=true <br /> session_responseinterval=600000 <br /> sessionset_process_max=1 <br /> codec_warndefaults=false <br /> print-messages=no <br /> <br /> [listenerserver server] <br /> ;enable=yes <br /> addr=0.0.0.0 <br /> port=12345 <br /> <br /> <br /> === Monitoring ===<br /> <br /> This section details comands through which the state of the USSD GW can be monitored.<br /> <br /> ==== ussd_map module ====<br /> <br /> * '''Congestion state monitoring'''<br /> <br /> The ''ussd_map'' module will generate an alarm when entering/exiting a congestion state. If SNMP support is enabled, this will generate a trap on SNMP.<br /> The congestion status is also reported in the ''state'' entry in the result of the module status command.<br /> <br /> * '''Module status'''<br /> <br /> The module reports its status through the following command in the YATE telnet console:<br /> <br /> status ussd_map<br /> <br /> The command will print the following information:<br /> <br /> workers=count_of_dispatching_threads,messages=count_msg,dialogs=count_of_dialogs,state=normal,count=count_of_applications;format=Type | CurrentDlgs| MAPCreated | UssdCreated |DefaultRouted | MAPSent | MapRecv | USSDSent | USSDRecv | MAPAbort | USSDAbort | BuiltAbort | MAPTimeouts | USSDTimeouts<br /> <br /> <br /> <br /> where:<br /> * workers: current number of used dispatching threads from the maximum configured pool (e.g., 3/10 means 3 threads are used of a pool of 10)<br /> * messages: count of messages waiting on the dispatching queue of the engine<br /> * dialogs: total number of USSD sessions currently handled by all applications<br /> * state of the engine: normal/congestion<br /> * count: number of applications acting either as gsmSCF, either as HLR<br /> * format: name of the application for which the following data is reported:<br /> ** Type: role of the application: SCF (communicates with real HLR), HLR (communicates with real gsmSCF)<br /> ** CurrentDlgs: number of current MAP dialogs handled by this application<br /> ** MAPCreated: number of sessions (dialogs) started by the MAP side<br /> ** UssdCreated: number of sessions (dialogs) started by the SMPP side<br /> ** DefaultRouted: number of dialogs for which failover took place<br /> ** MAPSent: number of MAP messages sent to gsmSCF/HLR. It doesn't count the ones sent via failover routing.<br /> ** MAPRecv: number of MAP messages received from gsmSCF/HLR<br /> ** USSDSent: number of sent ussd.execute/ussd.update/ussd.finalize messages towards the SMPP side.<br /> ** USSDRecv: number of received ussd.execute/ussd.update/usdd.notify messages from SMPP side.<br /> ** MAPAbort: number of dialog aborts generated by MAP side<br /> ** USSDAbort: number of dialog aborts generated by USSD side<br /> ** BuiltAbort: number of dialog aborts generated by the ussd_map module (e.g., not having a ussd.update message processed by anyone will cause ussd_map to generate session abort)<br /> ** MAPTimeouts: number of dialog timeouts generated by MAP side<br /> ** USSDTimeouts: number of timeouts reported by USSD side<br /> <br /> <br /> * '''Module control commands'''<br /> <br /> The module offers the following control commands through the telnet console:<br /> * ''control ussd_map appName print-msg [yes|no|verbose]'' : enable printing of received/sent map./ussd./messages.<br /> * ''control ussd_map appName print-xml [yes|no|verbose]'' : enable printing of received/sent XMLs.<br /> * ''control ussd_map appName export-xml-as [string|object|both]'' : change the way XML is set in the internal messages<br /> * ''control ussd_map start_stats'' : begin gathering data for statistics<br /> * ''control ussd_map stop_stats'' : stop gathering data for statistics<br /> * ''control usdd_map stats'' : print statistic data per engine and each application in part. Data contains number of MAP messages handled per second, number of USSD messages handled per second, maximum number of current dialogs, number of timeouts and number of aborts.<br /> <br /> ==== ysmpp module ====<br /> <br /> The ysmpp module provides the following options for status command:<br /> <br /> 'NOTE' the module_name can take the following values: smppserver or smppclient.<br /> <br /> * status module_name listeners<br /> Prints the module listeners status in format: Address|Status|Reason.<br /> <br /> * status module_name sessions<br /> Prints the status of the sessions in format: Id|State|BindMode|SystemId|IpAddress:Port|Congested|Incoming Queue|Outgoing Queue;<br /> <br /> ** Id: The ID of the SMPP session. Can be used for routing.<br /> ** State: The state of the SMPP session.<br /> ** BindMode: The mode in which the session was bound. (Send/Recv/SendRecv)<br /> ** SystemId: The id with which the session has been authenticated. Can be used in routing.<br /> ** IpAddress:Port: The Ip Address and port of the remote end of the session.<br /> ** Congested: True if this session is in congestion state.<br /> ** Incoming Queue: The number of messages not processed in the incoming queue.<br /> ** Outgoing Queue: The number of messages not processed in the outgoing queue.<br /> <br /> *status module_name ussd overview<br /> Prints the stats of the USSD sessions in format: Total|Active|Average Duration|Total Sent|Total Received|AverageTrafficPerSecond|EndedWithErrors|CongestionRefused<br /> <br /> ** Total: the number of USSD sessions created since the starting of the program.<br /> ** Active: the number of USSD sessions currently active.<br /> ** Average Duration: average duration of a ussd session.<br /> ** Total Sent: total number of SMPP messages sent for USSD sessions.<br /> ** Total Received: total number of SMPP messages received for USSD sessions.<br /> ** AverageTrafficPerSecond: average traffic per second for USSD sessions.<br /> ** EndedWithErrors: the number of USSD sessions that ended with error.<br /> ** CongestionRefused: the number of USSD sessions refused because the server was overloaded.<br /> <br /> == References ==<br /> <br /> * Mobile Application Part (MAP) specification: ETSI TE 129 002</div>

Oana