Navigation :

ProcessUnstructuredSSRequest

Overview

This message is sent by the IN Tester when it is simulating the role of a Home Location Register (HLR). This causes the tester to generate the effect of a MS (mobile handset) initiating a USSD interaction to the SCP.

Direction: OUTBOUND
From: HLR (IN Tester)
To: SCP (Application Under Test)

Attributes

The operation attributes are as follows.

Attribute	Type	Description
`type`	String	`map.hlr_to_scp.ProcessUnstructuredSSRequest`
`label`	String	An optional label for this node if it is to be the target of a `branch` operation.
`tcap_ac`	`null` / TCAP alias / Hex String	Specifies the TCAP Application Context to be sent for this outbound TCAP_BEGIN. May be null, a well-known TCAP alias, or a free-form hex string, e.g `04000101010003`. (Default = `null`).
`send_with_next`	Boolean	Request that this MAP operation should be bundled with the next outbound TCAP. (Default = `false`).
`send_and_close`	Boolean	Request that this MAP operation should be sent as TCAP END. (Default = `false`).
`arguments`	Object	[Required] The structure of the MAP USSD-Arg to construct and send. Expressions may be supplied within this structure.

Example

This is an example entry within the operations array:

{
  "type": "map.hlr_to_scp.ProcessUnstructuredSSRequest",
  "arguments": {
    "tcap": {
      "map_open": {
        "destination_reference_digits": "655011420096316",
        "destination_reference_noa": 1,
        "destination_reference_npi": 6,
        "origination_reference_digits": "64221420001",
        "origination_reference_noa": 1,
        "origination_reference_npi": 1,
      }
    },
    "ussdString_text": "*#101#",
    "msisdn_digits": "27761485722",
    "msisdn_npi": 1,
    "msisdn_noa": 1
  }
}

Arguments

The following outbound arguments are supported.

Argument	Type	Notes
`tcap`	Object	Specify additional parameters for the TCAP Dialogue.
.`map_open`	Object	Specify additional parameters for the MAP-Open.
.`destination_reference`	Binary String	This attribute can be specified as binary data. Alternatively, specify the individual components below.
`.destination_reference_digits` `.destination_reference_noa` `.destination_reference_npi`	Digit String Integer Integer	Hexadecimal Digits 0-9/A-F Range 0..1, default = 0 [complete] Range 0..15, default = 1 [ITU-T E.164] All ignored if `destination_reference` is defined.
.`origination_reference`	Binary String	This attribute can be specified as binary data. Alternatively, specify the individual components below.
`.origination_reference_digits` `.origination_reference_noa` `.origination_reference_npi`	Digit String Integer Integer	Hexadecimal Digits 0-9/A-F Range 0..1, default = 0 [complete] Range 0..15, default = 1 [ITU-T E.164] All ignored if `origination_reference` is defined.
`ussdDataCodingScheme`	Binary String	This attribute can be specified as binary data. Alternatively, specify the individual components below, or allow the defaults to apply. Note that the value of the group component determines which other components are applicable.
`ussdDataCodingScheme_group` `ussdDataCodingScheme_language` `ussdDataCodingScheme_is_compressed` `ussdDataCodingScheme_message_class` `ussdDataCodingScheme_encoding`	Integer Integer Boolean Integer Integer	Range 0..15, default = 0 [GSM 7-bit] Range 0..15, default = 15 [Unspecified] Default = false Range 0..3, default = [Not Defined] Range 0..15, default = 0 [GSM 7-bit] All ignored if `ussdDataCodingScheme` is defined.
`ussdString`	Binary String	[Required] This attribute can be specified as encoded binary data. Alternatively, specify `ussdString_text`. Exactly one of these values is required.
`ussdString_text`	String	[Required] Will be encoded according to the value of `ussdDataCodingScheme`. Note: Not all encoding groups are supported.
`msisdn`	Binary String	This attribute can be specified as binary data. Alternatively, specify the individual components below.
`msisdn_digits` `msisdn_noa` `msisdn_npi`	Digit String Integer Integer	Hexadecimal Digits 0-9/A-F Range 0..1, default = 0 [complete] Range 0..15, default = 1 [ITU-T E.164] All ignored if `msisdn` is defined.