API Reference Send SMS

Send SMS

POST

Reliable service for sending SMS with ease.

Service Information

baseUrl/api/v1/sendsms
POST
application/json

Single SMS

Send SMS to a single recipient

Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchants (public) key
senderId String M Sender Id for the send SMS request.
msisdn String M Recipient / phone number. Ex: 09062120000
amount Numeric M Amount with which to top-up amount customers phone Maximum 100000
messageBody Text M Message body for send SMS request
transactionRef String M Unique transaction Id for the request. Maxlength (35characters)
checksum String M Checksum computed for the request. See "Security: Checksum" section for hash computation steps
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
cost Numeric M Cost of sent SMS (in naira)
tranxReference Numeric M Merchant/client’s initial transaction reference
transactionId Numeric M Creditswitch’s unique id generated for the transaction 

{
    "loginId": "{{loginId}}",
    "key": "{{publicKey}}",
    "senderId": "{{yourRegisteredSenderId}}",
    "msisdn": "08134045387",
    "messageBody": "Loads of Love From Us!",
    "transactionRef": "{{random12digit}}",
    "checksum": "{{checkSum}}"
}
                            
{
    "statusCode": "00",
    "statusDescription": "Successful",
    "cost": "6.00",
    "transactionRef": "8bfj9db9acf2",
    "transactionId": "3250920170668966089"
}

Bulk SMS

Send SMS to a bulk recipients

Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchants (public) key
senderId String M Sender Id for the send SMS request.
msisdn String M An array of Recipient / phone number. Ex: 09062120000
amount Numeric M Amount with which to top-up amount customers phone Maximum 100000
messageBody Text M Message body for send SMS request
transactionRef String M Unique transaction Id for the request. Maxlength (35characters)
checksum String M Checksum computed for the request. See "Security: Checksum" section for hash computation steps
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
cost Numeric M Cost of sent SMS (in naira)
tranxReference Numeric M Merchant/client’s initial transaction reference
transactionId Numeric M Creditswitch’s unique id generated for the transaction 

{
    "loginId":"60789","key":"$2y$10$J39dLRgZ5vsIhu0030YVjuaSMirHalM8b0JBIpG0Jt9RCcOH1KEEu","senderId":"Creditswtch", 
    "msisdn":[09034575188","08123748177"], "messageBody":"Testing", "transactionRef":"12ddsa73sde2hsdkklo7"
    "checksum":"JDJ5JDEwJGNZVHUuQ2l4SkVsV0VsaTVwSi9GYnUubEM4eFdOcHR0SERRLmJ2ZFdxQko0STloNC5hSEJ1"
}
{
    {"statusCode":"00","statusDescription":"successful","cost":2.5,
    "transactionRef":"pp0p88097976 58891","transactionId":"167241535005733"}
}