Skip to content

Receiving DLR

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

This section will provide details to assist SMS users receive DLR messages for messages sent via API. Below are the requirements to enable one successfully complete this operation.

Note

Client must provide relevant end-point to receive DLR (Delivery Reports)

Receive DLR

  • 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: Original sender of the message
  • to: 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_ode": "A1001",
  "to": "254726986944",
  "reference": "82829381391273123-128",
  "message": "DeliveredToTerminal",     
  "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" :"Dlr Received Success"
  }
}