Skip to content

Receiving SMS

API URL: https://client-dlr-api/receive-sms

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

Note

Client must provide relevant end-point to receive SMS

Receive SMS

  • Method: POST

  • Request:

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

Body:

  • client_code: Client identifier to be provided by outlier
  • key: To be shared by Qlick on successful account opening
  • short_code: Recipient of message
  • from: Number/msisdn value of the recipient of the message
  • message: message received from the recipient
  • reference: Message identifier (Will be unique for every message)

Sample Request:

{
  "short_code": "40720",
  "client_code":"A1001",
  "from":"254726986944",
  "reference": "82829381391273123-128",
  "message": "This is a test message sent to 40720",     
  "key":"5612bngtE$56^9i12pue91ne12k1664a120-=1edmb nvqy51637816137812kncjgqau2638129201ownm21b423ui5p4214kb"
}

Expected Client Response

Response (200):

  • Headers: 
    {
     "headers": "Content-Type: application/json"
}
  • Body: Expected Response 
    {
  "code": "200",
  "data": {
    "ref":"82829381391273123-128"
    "total":1, 
    "message" :"Message received success"
  }
}