Send SMS
Sends a text message via SMS to your customer.
Once completed, it sends an Instant Transaction Notification or webhook event to your callback URL for you to process the transaction.
Endpoints
https://developer.lipisha.com/index.php/v2/api/send_sms TEST
https://api.lipisha.com/v2/send_sms LIVE
Request POST application/x-www-form-urlencoded
| Parameter |
Description |
Example |
| api_key |
Your Lipisha API key. |
3aa67677e8bf1d4c8fe886a38c03a860 |
| api_signature |
Your Lipisha API signature. |
SYetmwsNnb5bwaZRyeQKhZNNkCoEx+5x= |
| account_number |
Account number of the transaction account |
00700 |
| mobile_number |
Mobile number of the customer |
254712345678 |
| message |
Text message to be sent |
Dear John, thank you for repaying your loan. Your next payment is due Thursday next week. |
| reference |
Your identifier for the transaction |
SMS000001 |
Example Request
curl "https://developer.lipisha.com/index.php/v2/api/send_sms" \
-X POST \
--data-urlencode "api_key=3aa67677e86a38c03a860" \
--data-urlencode "api_signature=SYetmwsNnb5bwaZRyeQKhZNNkCoEx+5x=" \
--data-urlencode "account_number=00600" \
--data-urlencode "mobile_number=254712345678" \
--data-urlencode "message=Dear John, thank you for repaying your loan. Your next payment is due Thursday next week." \
--data-urlencode "reference=SMS000001"
Response application/json
| Parameter |
Description |
Example |
| Status |
| status |
Status of the API call |
SUCCESS |
| status_code |
Status code of the API call |
0000 |
| status_description |
Description of the API call |
Balance Found |
| Content |
| transaction |
Lipisha identifier for the transaction |
ABC12345QR |
| account_number |
Account number of the transaction account |
00700 |
| mobile_number |
Mobile number of the customer |
254712345678 |
| message |
Text message to be sent |
Dear John, thank you for repaying your loan. Your next payment is due Thursday next week. |
| reference |
Your identifier for the transaction |
SMS000001 |
Example Response
{
"status": {
"status_code": "0000",
"status_description": "Message Submitted",
"status": "SUCCESS"
},
"content": {
"transaction": "ABC12345QR",
"account_number": "00700",
"mobile_number": "254712345678",
"message": "Dear John, thank you for repaying your loan. Your next payment is due Thursday next week.",
"reference": "SMS000001"
}
}
