USSD

For information on creating USSD processes, refer to the USSD Editor documentation.

Getting information about USSD sessions billing

To get an information about USSD sessions billing:

1. Click the USSD in menu or click the tab Billing.
2. All detailed information about USSD sessions are placed in table. For more information on individual parts of the table see the USSD Billing view section.

Getting detailed information about USSD single billing session

To get an detailed information about USSD single billing session:

1. Click the USSD in menu or click the tab Billing.
2. Click the "Info" icon in the actions column.

3. You should see dialog window with all information about this operation
4. You can also find information about USSD session events. We can distinguish the following event types:

• User input (5) - the event contains a text entered by the customer on the phone
• USSD application response (6) - the event contains a text returned to the customer's phone by the USSD application
• System information (7) - misc system events that contain information about USSD session states and errors that occurred during the session

Searching for single USSD session with session id

To find specific session having operation id only, you need to:

1. Click the USSD in menu or click the tab Billing in submenu.
2. Click the "Search" button under the table.

3. Provide operation id
4. Click "Next"

5. If operation exist you will see all information about it.
6. You can also find information about USSD session events. We can distinguish the following event types:

• User input (7) - the event contains a text entered by the customer on the phone
• USSD application response (8) - the event contains a text returned to the customer's phone by the USSD application
• System information (9) - misc system events that contain information about USSD session states and errors that occurred during the session

USSD Apps management

It's a place where you can check and manage your USSD apps. The USSD application's profile is information stored on the QRIOS platform used to identify and call developer's integrations implementing the USSD API.

Getting information about existing USSD apps

To get information about existing USSD apps:

1. Click the USSD in menu and then click the Apps tab in submenu.
2. All detailed information about USSD apps are placed in table. For more information on individual parts of the table see the USSD Apps view section.

Create new USSD app

To create a new USSD app:

1. Click the Apps tab in submenu.
2. Click the "Create app" button.
3. Fill the form:

• App Id is a string which uniquely identifies a developer's application in Qrios API. It's passed in each request body, and it's also used in USSD push request.

• App URL - it's a web address of the application e.g. https://example-developer-ussd-app.com/ussd. The developer's USSD application has to be accessible through Internet, so Qrios platform could reach it. Your service should be exposed by this address and implement the USSD API. To find out how to use Qrios USSD API check the guide.

tip

We encourage you to use HTTPS to secure access to your application through the Internet.

• Status - with this setting you can toggle traffic to the application. When 'Offline' is set, dialing any shortcode string of your USSD application will result in returning 'App in currently under maintenance. Please, come back later' to the customer who dials it.

• Debug mode - if debug mode is enabled, then additional information for developer will be added to USSD message when error occurs (should be disabled on production). It can be useful to debug issues with the USSD application. But we recommend using Detailed USSD session view instead.

• Authorization method - configuration used to authorize the incoming request to the developer's application. The authorization secret value is passed in each request in the Authorization header.

tip

The authorization can be disabled, but we encourage you to enable authorization - the secret check in the developer's USSD app will make the API exposed by your system more secure for unauthorized access. After picking the proper option and generating a secret (e.g. API key), you are supposed to use this value and check if an incoming request to your system contains it in the Authorization header.

4. Click the "Apply" button.

Edit existing USSD app

To edit existing USSD app:

1. Click the Apps tab in submenu.
2. Click the "Pencil" icon next to app you want to edit.
3. Change fields in the form.
4. Click the "Apply" button.

Open existing USSD app in embedded editor

To open existing USSD app in embedded editor:

1. Click the Apps tab in submenu.
2. Click the icon next to app you want to open.

Check if the USSD app limit has been reached

You have a limited pool of app available to create. To check if the limit has been reached:

1. Click the Apps tab in submenu.
2. If you see in the lower left corner below the table the message: "Apps created: 3 of 3" it means that you reached the limit. You can always check here the current and max number of available apps to create.

USSD reports management

It's a place where you can check and manage your USSD reports.

Check reports list

To check reports:

1. Click the USSD in menu and then click the Reports tab in submenu. You should see table with columns:
2. Name - Name of your exported report
3. Size - Rounded to the largest unit, available for created and expired reports
4. Status - Current state of the report:

• Pending - All reports have this state right after start generating, this status will change automatically, into a Created or Failed after a specific amount of time, depends on the size of the report.
• Created - Report is ready to download.
• Failed - Something went wrong during a report generation.
• Expired - All reports expired after 30 days

5. Time due to expire - a time until report will expire, in case of a created report, or time after report expired in case of expired report
6. Actions - List of actions based on report status:

• Pending - You can perform Details and Cancel actions
• Created - You can perform Download, Recreate, Details and Delete actions
• Failed - You can perform Retry, Details and Delete actions
• Expired - You can perform Recreate, Details and Delete actions

Generate new USSD report

To create a new USSD report:

1. Click the Reports tab in USSD submenu.

2. Click the "Create report" button.

3. Provide report name and Click "Next".

4. Provide filters to apply and click "Generate report".

5. When everything is correct, you should see a success message.

Generate new USSD report with a predefined data

1. Click the Billing tab in USSD submenu.

2. If you want to change data scope click "Filters" button.

3. When everything is correct click "Create report" button.

4. You will be redirected to the USSD Reports page and asked for the report name.

5. Form is filled by options you choose in Billing Filters. You can update them if needed.

6. Click "Generate report" to finish.

7. When everything is correct, you should see a success message.

Retry report

Can be performed only for the "Failed" report. To retry report:

1. Click the Reports tab in USSD submenu.

2. Click retry action to open the retry dialog window

3. Click "Retry report generation" to try to generate a report again

4. When everything is correct, you should see the success message

Regenerate report

Can be performed for "Created" and "Expired" reports. To regenerate report:

1. Click the Reports tab in USSD submenu.

2. Click regenerate action to open the regenerate dialog window

3. Click "Regenerate report" to create a new report with predefined data scope

4. When everything is correct, you should see the success message

Cancel report

Can be performed for "Pending" report. To cancel report:

1. Click the Reports tab in USSD submenu.

2. Click cancel action to open the cancel dialog window

3. Click "Cancel report generation" to cancel generating the report

4. When everything is correct, you should see the success message

Delete report

Can be performed for "Created", "Failed" and "Expired" reports. To delete a report:

1. Click the Reports tab in USSD submenu.

2. Click delete action to open the delete dialog window

3. Click "Delete" to delete the report

4. When everything is correct, you should see the success message

Check report details

Every report has details, there are depending on the report status. To check report details:

1. Click the Reports tab in USSD submenu.

2. Click details action to open the details dialog window

3. You should see the status of selected report

4. And you can perform available actions

5. And you can see base details information

6. And which filters was applied

Check if the report limit has been reached

You have a limited pool of reports available to generate. To check if the limit has been reached:

1. Click the Reports tab in USSD submenu.
2. If you see the warning message in the lower left corner below the table it means that you reached the limit. You can always check here the active and pending number of the current and max number of reports.