Bulk SMS
- Simple Get Request
- Post Request
- Endpoints
- Headers
- Parameters
- Sample Request
- Response
- Sample Response
Simple Get Request
To send an sms you need to send a HTTP GET
as below:
Endpoints
The Api Key and Auth Key are found on your profile
NOTE: The Auth Key is generated using your credentials, anytime you change your credentials the Auth key will be different
Production Endpoint: https://sms.suntech-solutions.net/gw/send
Mandatory Params: apikey={APIKEY}&auth={AUTHKEY}&from={FROM}&to={RECIPIENT}&sms={MESSAGE TO SEND}&ref={REFERENCE}
Optional Params: appcode={APPCODE}
Post Request
To send an sms you need to send a HTTP POST
to the endpoints below:
Endpoints
Production: https://sms.suntech-solutions.net/sms/serve
Required headers
Header Name | Value |
---|---|
Content-Type: |
application/json |
Parameters
Name | Parameter Type | Description | Required | Default Value |
---|---|---|---|---|
countrycode |
String |
Destination country for the sms recipient. | Optional |
|
operation |
String |
The current operation code(case sensitive). | Required |
sendsms |
auth |
String |
Suntech authentication.
This is generated as per request. You sha256 encrypt the combination of Clientkey which shall be a preshared key issued and the recipient msisdn param below
Auth = sha256(ClientKey + Msisdn) |
Required |
|
apikey |
String |
Suntech Api Key on Api Settings. | Required |
|
reference |
String |
Unique transaction reference for the transaction, you can use guid. | Required |
|
operator |
String |
The mobile network to send from. | Optional |
|
from |
String |
The sender name to send the sms from, Must be approved and registered on the suntech platform. | Required |
|
msisdn |
String |
The recipient of the sms. | Required |
|
sms |
String |
The content of the sms to be sent. | Required |
Sample request
{
"countrycode": "ke",
"apikey": "3wea6yshd8",
"auth": "ltn3g2q6f37yhlglfhmn",
"operation": "sendsms",
"operator": "safaricom",
"from": "Suntech",
"msisdn": "254710000000",
"sms": "Test sms to the mobile",
"reference": "SBQAVTBJK"
}
Response
Response comes as a JSON string with the following fields:
Parameter | Parameter Type | Description | Values |
---|---|---|---|
status | string |
The status code of the transaction | 200 |
message | string |
The description of the status code of the transaction | Successful |
Sample Reponse
Below is a sample send sms response for a successful request:
{
"status":"200",
"message":"Successful"
}