USSD Inbound
GET https://ClientApplicationURL.com/
When the mobile user dials your USSD code, e.g *4441#, the USSD Gateway will automatically invoke your URL and pass all the pre-defined parameters.
You are required to provide your application URL for the USSD inbound (MO) messages.
Query Parameters
- Name
session_msisdn- Type
- integer
- Description
Mobile number (must be in international format e.g. 234819*)
- Name
session_operation- Type
- string
- Description
USSD Operation Category
begin: New USSD session with the USSDC continue: To continue a USSD session with the USSDC for the specified session_id end: Used to indicate the end of a USSD session
- Name
session_msg- Type
- string
- Description
USSD message (max 160 chars).
- Name
session_id- Type
- string
- Description
A unique identifier for a menu interaction. You will indicate this in your response to the user so as to maintain the same menu communication..
- Name
session_from- Type
- string
- Description
Originating USSD code
- Name
session_type- Type
- integer
- Description
1: Require input or reply from the user 2: Notify user without any response required. 3: When responding to a request from msisdn. 4: Notify user and end interaction.
- Name
session_mno- Type
- string
- Description
Originating mobile network. MTN, 9MOBILE, AIRTEL, GLO
Request
curl --location --request GET 'https://ClientApplicationURL.com/' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'session_msisdn=2347000000000' \
--data-urlencode 'session_operation=begin' \
--data-urlencode 'session_msg=Hello, this is a test message' \
--data-urlencode 'session_id=5456657676' \
--data-urlencode 'session_from=*7006#' \
--data-urlencode 'session_type=1' \
--data-urlencode 'session_mno=MTN'
Response
{
"session_operation": "continue",
"session_type": 1,
"session_id": "5456657676",
"session_msg": "Welcome to Holla tags ticket\r\n1: Book Bus Tickets\r\n2: Terms & Condition"
}
USSD Outbound
GET https://sms.hollatags.com/api/ussd/push/
The POST parameters should be sent as x-www-form-urlencoded
Query Parameters
- Name
user- Type
- integer
- Description
Account username
- Name
Pass- Type
- integer
- Description
Account Password
- Name
session_from- Type
- integer
- Description
Originating USSD code
- Name
session_msisdn- Type
- integer
- Description
Mobile number (must be in international format e.g. 234819*)
- Name
session_msg- Type
- string
- Description
USSD message (max 160 chars).
- Name
session_type- Type
- integer
- Description
1: Require input or reply from the user
2: Notify user without any response required.
Request
curl --location --request GET 'https://sms.hollatags.com/api/ussd/push/' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'user={USERNAME}' \
--data-urlencode 'pass={PASSWORD}' \
--data-urlencode 'session_from=*7006#' \
--data-urlencode 'session_msisdn=2347000000000' \
--data-urlencode 'session_msg=Hello, this is a test message' \
--data-urlencode 'session_type=1'
Response
{
Status: OK
}