Skip to content

Sending SMS

API URL: https://peasms.qlick.africa/api/send-sms

This section will provide details to assist SMS users send text messages to their respective recipients. Below are the requirements to enable one successfully complete this operation.

Request:

  • Method: POST

  • Headers: 

    {
     "headers": "Content-Type: application/json"
}

  • Body:

  • customer_account: Client identifier to be provided by outlier
  • client_code: unique client identifier to be provided by outlier
  • key: To be shared by Qlick on successful account opening
  • short_code: sender that will appear as the originator of the message, this is optional and applies to cases where the client has multiple short codes integrated
  • bulk: whether the message being sent is short code or bulk (0 or 1)
  • recipients: List of numbers/msisdn value of the recipient of the message
  • message: message that is to be sent to the recipient. (160 characters = 1 SMS)
  • reference: Client message identifier (Must be unique for every message)
  • call_back_url: callback url where a delivery report will be sent (optional)
  • link_id: Request message identifier. Required form OnDemand messages

Sample Request:

{
    "customer_account": "PEASMS",
    "client_code": "71459998",
    "short_code": "PEASMS", //optional
    "recipients": [
        "254714855623",
        "254769019569"
    ],
    "message": "This is a test message to the sms api",
    "call_back": "http://cleint.dlr-url.com",
    "bulk": 1,
    "key": "8jsp(NiaKS8Uof4v%JjY(6qlNFyq22kyQkWKHUOIR$esXgBvSz..."
}

Response (201):

  • Headers: 
    {
     "headers": "Content-Type: application/json"
}
  • Body:

Sample Response :

{
  "code": "201",
  "data": {
    "alert_id":"562761785261",
    "total":2, 
    "message" :"Message queued success"
  }
}