Webhooks

Receive delivery receipts and click information to your platform

Webhooks allow our platform to post information back to your platform. Such information can be DLRs, incoming SMSs or clicks.

All webhooks can be set in the account preferences page.



Receive DLR information

This event will be fired after an SMS DLR is received by the telecom provider. Learn more about DLRs here.

{
  "id": 19591,
  "created": "2018-02-14 17:35:40",
  "from": "smsapi",
  "to": 6598943560,
  "country_id": 192,
  "country_name": "Singapore",
  "country_iso": "SG",
  "verify_local": 1,
  "shorten_url": 1,
  "list_id": 2070,
  "reference": null,
  "transactional": 0,
  "preferred_route_id": 431,
  "campaign_id": 2044,
  "delay_time": "2018-02-14 17:35:40",
  "clicked": false,
  "cost": 0.0238,
  "parts": 1,
  "original_url": "http://page.com/",
  "shortened_url": "https://apis.com/Sde",
  "text": "Dear John ([email protected]), please visit my page http://page.com/",
  "status": "sent",
  "dlr_status": "DELIVERED"
}

📘

DLRs are not always accurate

Telecoms reserve the right to filter the SMS even after a DLR was sent. That's why in SMSEdge we rely heavily on CTR information to route messages properly.



Receive incoming SMS

The inbound SMS webhook will be fired when an SMS is received to one of your virtual numbers.

{
   "id": 3724,
   "from": 1234567890,
   "message": "stop",
   "received": "2020-08-06 12:00:00"
}


Clicks webhook

he clicks webhook url will be fired when a click is made on an SMS sent by you.

  • Only the initial click per message will trigger the webhook.
  • If SMSEdge detects the click as a bot or a preview, the webhook will not be fired
{
  "id": 19591,
  "created": "2018-02-14 17:35:40",
  "from": "smsapi",
  "to": 6598943560,
  "country_id": 192,
  "country_name": "Singapore",
  "country_iso": "SG",
  "verify_local": 1,
  "shorten_url": 1,
  "list_id": 2070,
  "reference": null,
  "transactional": 0,
  "preferred_route_id": 431,
  "campaign_id": 2044,
  "delay_time": "2018-02-14 17:35:40",
  "clicked": true,
  "cost": 0.0238,
  "parts": 1,
  "original_url": "http://page.com/",
  "shortened_url": "https://apis.com/Sde",
  "text": "Dear John ([email protected]), please visit my page http://page.com/",
  "status": "sent",
  "dlr_status": "DELIVERED"
}