USSD Call Back Service Configuration Properties

You configure Unstructured Supplementary Service Data (USSD) call back (CB) services using CAMEL Gateway USSD configuration properties in the create_config.py configuration file.

USSD Call Back Services General Configuration

USSD CB Services Configuration Properties describes the create_config.py properties for configuring the general behavior of USSD call back services, and shows default values for each property.

For information about service-specific properties for the USSD call back default service and for additional USSD call back services, see USSD Call Back Service-Specific Properties.

Table 1. USSD CB Services Configuration Properties
Property Description Default Value
USSD CB Service Subscriber Source Specifies a list of subscriber sources to search for in the incoming USSD message. The first source that is found in the list is used to determine the primary subscriber (the A-party) for the InitiateCallAttempt operation. Enter a comma-eparated list of subscriber sources in search order priority. Valid values are:
  • MsisdnFromUssdParameter
  • DestinationReferenceId
  • MsisdnFromDatabase

create_config.info question: Camel Gateway:What subscriber sources are required for the USSD call back service?

MsisdnFromDatabase
USSD CB Service Rule Set The name of the rule set that the USSD call back service uses for number normalization or denormalization. To use the default rule set, enter default.

create_config.info question: Camel Gateway:What rule set should be use for number normalization for the USSD call back service?

default
USSD CB Default Service options Options for configuring the behavior of the USSD call back default service, such as the IDP service key, service codes, voice service ID, and call initiation SCCP address. The USSD call back default service is used unless an additional USSD call back service has been configured for the voice service. For details, see USSD Call Back Service-Specific Properties.
USSD call back default service configuration questions are prefixed with the following text: 
Camel Gateway:USSDCB default_ussd_incoming:
Number of Additional USSD CB Services The number of USSD call back services required in addition to the default call back service. Enter 0 if no additional services are required, otherwise enter a value between 1 and 999. You must answer additional questions to configure the additional call back services.

create_config.info question: Camel Gateway:How many additional USSD Call back services do you wish to create?

0
Additional USSD CB Services options Options for configuring the behavior of each additional call back service such as the IDP service key, service codes, voice service ID, and call initiation SCCP address. These questions are asked only if you set the number of additional USSD call back services to 1 or more. Additional USSD call back service questions are prefixed with the following text: 
Camel Gateway:USSDCB Additional n:
where n is the additional service number. For details, see the discussion about USSD call back service specific properties.

USSD Call Back Service-Specific Properties

Call Control Framework (CCF) provides configuration options for configuring service-specific properties for the USSD call back default service, and for each additional USSD call back service that you create.

USSD CB Default Service Configuration describes the create_config.py parameters for configuring the USSD call back default service and shows default values for each parameter. The create_config.info questions for the USSD call back default service and for each additional USSD call back service are the same, except that:
  • For the USSD call back default service, create_config.info questions begin: "Camel Gateway:USSDCB default_ussd_incoming:", for example: 
    Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back idp service key?
  • For each additional service, create_config.info questions begin: "Camel Gateway:USSDCB Additonal n:", for example: 
    Camel Gateway:USSDCB Additional 1:Enter the USSD call back idp service key?
Table 2. USSD CB Default Service Configuration
Parameter Description Example Value
USSD CB Service: IDP Service Key The IDP service key of the voice service to use for the USSD call back service. This service key value is entered into the IDP that triggers the voice call between the A-party and the B-party. It has a minimum value of 0 (zero).

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back idp service key?

222
USSD CB Service: Service Code The operator-defined USSD service code to use for the call back service. The minimum value is 0 (zero).
Note: The USSD call back service code prefixes the destination number in the USSD message, for example, in the following sequences, 124 is the service code (or Service Access Number (SAN)) and 0722724681234 is the B-number for the destination:
  • *124*0722724681234
  • *124#0722724681234

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back service code?

124
USSD CB Service: Voice Service ID The ID of the existing voice service to use when connecting the A-party with the B-party. The minimum value is 0 (zero).

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back voice service id?

1
USSD CB Service: Call Initiation SCCP Address Type The call initiation SCCP address type in the incoming USSD message for the call back service. Valid values are:
  • 1.pc — To specify a point code as the SCCP calling address, you must answer an additional question.
  • 2.gt — To specify a global title as the SCCP calling address, you must answer additional questions.

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP address type (pc/gt)?

1 for pc
USSD CB Service: Call Initiation SCCP Point Code If Call Initiation SCCP Address Type for the USSD call back service is set to point code (PC), specifies the PC to use in the SCCP calling address. The minimum point code value is 0 (zero).

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP point code?

0
USSD CB Service: Call Initiation SCCP GT Type The the global title (GT) type to use for the USSD call back service in the SCCP calling address.
Note: The specified GT is also used to set the gsmScfAddress. You must configure the GT even if you are using a point code for the SCCP address.
Valid values are:
  • 1 — Use digits and nature of address.
  • 2 — Use digits and translation type.
  • 3 — Use digits, translation type, and numbering plan.
  • 4 — Use digits, translation type, numbering plan, and nature of address.

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title type?

4
USSD CB Service: Call Initiation SCCP GT Translation Type The call initiation SCCP global title translation type for the USSD call back service. Enter a value in the range: 0 to 255.

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title translation type?

1
USSD CB Service: Call Initiation SCCP GT Number Plan The call inititiation SCCP global title number plan for the USSD call back service. Enter a value in the range: 0 to 15.
Valid values are:
  • 0 — Unknown.
  • 1 — ISDN/telephony numbering plan (ITU-T E.163 and E.164).
  • 2 — Generic numbering plan.
  • 3 — Data numbering plan (ITU-T X.121).
  • 4 — Telex numbering plan (ITU-T F.69).
  • 5 — Maritime mobile numbering plan (ITU-T E.210, E.211).
  • 6 — Land mobile numbering plan (ITU-T E.212).
  • 7 — ISDN/mobile numbering plan (ITU-T E.214).
All other values are spare or reserved.

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title number plan?

1
USSD CB Service: SCCP GT Nature of Address The nature of address of the global title to use in the call initiation SCCP address for the USSD call back service. Enter a value in the range: 0 to 127. All other values are spare or reserved.
Valid values are:
  • 0 — Unknown
  • 1 — Subscriber
  • 3 — National
  • 4 — International
All other values are spare or reserved.

create_config.info question: Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title Nature of Address?

4
USSD CB Service: Call Inititiation SCCP GT Digits The global title digits to use in the call initiation SCCP calling party address for the USSD call back service. Enter the phone number digits, or enter "none".

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title digits?

12345678
USSD CB Service: Call Initiation SCCP SSN The sub-system number (SSN) to use in the call inititation SCCP calling address for the USSD call back service. Leave blank for no SSN. The minimum value is 0.

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming: Enter the USSD call back call initiation SCCP subsystem number (ssn)?

0
USSD CB Service: CB String Format The call back string format for the USSD call back service. One of:
  • *SAN*B_NUMBER
  • *SAN#B_NUMBER
where the B_NUMBER for the destination is substituted in the call back string.

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back format of the USSD call back string?

*SAN*B_NUMBER
USSD CB Service: CB Response Type The call back response type for the USSD call back service. Valid values are:
  • respond_before_call_initiation
  • respond_after_b_party_initiation
  • respond_after_a_answer
  • respond_after_connection

create_config.info question: Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back response type?

respond_before_call_initiation

USSD Call Back Service Example Configuration

The following create_config.info section shows a configuration for USSD call back services:
Camel Gateway:What subscriber sources are required for the USSD call back service? DestinationReferenceId
Camel Gateway:What rule set should be use for number normalization for the USSD call back service?default
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back idp service key?989
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back service code?124
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back voice service id? 1
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP address type (pc/gt)?2
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP point code?0
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title type? 
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title translation type? 
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title number plan? 
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title Nature of Address?4
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP global title digits?12345678
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back call initiation SCCP subsystem number (ssn)?146
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back format of the USSD call back string?*SAN*B_NUMBER 
Camel Gateway:USSDCB default_ussd_incoming:Enter the USSD call back response type?respond_before_call_initiation
Camel Gateway:How many additional USSD Call back services do you wish to create?1
Camel Gateway:USSDCB Additional 1:Enter the USSD call back idp service key? 888
Camel Gateway:USSDCB Additional 1:Enter the USSD call back service code?1244
Camel Gateway:USSDCB Additional 1:Enter the USSD call back voice service id?1
Camel Gateway:USSDCB Additional 1:Enter the USSD call back call initiation SCCP address type (pc/gt)?2
Camel Gateway:USSDCB Additional 1:Enter the USSD call back call initiation SCCP point code? 
Camel Gateway:USSDCB Additional 1:Enter the USSD call back call initiation SCCP global title type? 
Camel Gateway:USSDCB Additional 1:Enter the USSD call back call initiation SCCP global title translation type? 
Camel Gateway:USSDCB Additional 1:Enter the USSD call back call initiation SCCP global title number plan? 
Camel Gateway:USSDCB Additional 1:Enter the USSD call back call initiation SCCP global title Nature of Address? 
Camel Gateway:USSDCB Additional 1:Enter the USSD call back call initiation SCCP global title digits? 
Camel Gateway:USSDCB Additional 1:Enter the USSD call back call initiation SCCP subsystem number (ssn)? 
Camel Gateway:USSDCB Additional 1:Enter the USSD call back format of the USSD call back string? 
Camel Gateway:USSDCB Additional 1:Enter the USSD call back response type?