Configuring USSD Query Services

Configure Unstructured Supplementary Service Data (USSD) query services to enable subscribers to request information about their account status by sending a USSD query request to MATRIXX.

The USSD query service returns the results of a USSD query in a USSD query notification. To enable USSD query notifications, you must configure USSD notifications and the USSD query service. For information about configuring USSD notifications, see the discussion about configuring USSD notifications.

Configuring the USSD query service involves:

Configuring USSD Query Service Properties

During MATRIXX Engine configuration, system administrators can set the following properties for USSD query services:
  • A comma-separated list of up to 20 operator-defined service codes for USSD queries.
    Note: In the USSD string, the service code prefixes the ID of the item to be queried. For example, a subscriber could enter *123*12 on their handset, where 123 is the service code for USSD balance queries and 12 identifies the balance to query.
  • The list of subscriber sources to search for in the incoming network request. When processing a USSD query, the subscriber source determines the primary subscriber to associate the call with. The subscriber source list can include the following values:
    • UssdParameterMsisdn
    • MapOpenMsisdn
    • MapOpenImsi
    Note: The MapOpenMsisdn or MapOpenImsi is derived from the MAP-OPEN destinationReference parameter.
  • The name of the rule set to be used by the USSD query service for number normalization or denormalization (set to "default" by default).
The following create_config.info question sets the USSD service codes: 
Enter a list of USSD query service codes?
The following create_config.info question sets the list of subscriber sources for the USSD query service: 
What subscriber sources are required for the USSD query service?
The following create_config.info question sets the rule set for the USSD query service: 
What rule set should be used for number normalization for the USSD query service?

Enabling the USSD Query Notification Type

To enable USSD query processing, during pricing configuration, you must enable the ussd_query Notification Type and configure which custom information to include when the USSD Query notification is generated.

For more information about pricing configuration for notification types, see the discussion about Notification Types in My MATRIXX Help.

Configuring the USSD Query Result Delivery Method

The sendAsNotify flag determines, for a USSD query that was generated by the network or the subscriber (for example, when a subscriber submits a USSD query request from their handset), whether the query results are:
  • Sent in a USSD notification
  • Returned in the Process-UnstructuredSS-Request result
By default, the sendAsNotify flag is set to false, meaning that the USSD query results are returned in the Process-UnstructuredSS-Request result. You can override the sendAsNotify default value in the USSD query notification template. For information, see the discussion about USSD query Apache FreeMarker template configuration.

Configuring the USSD Query Notification Template

Configure the /opt/mtx/notifier/templates/ussd/ussd-query/mtxUssdQueryNotification.ftl template file to define the queries for the configured USSD query service codes, and to define the mapping between the USSD query codes and MATRIXX balances. For information, see the discussion about USSD query Apache FreeMarker template configuration.