Webhook SMS
Webhook allows you to get callback push API to your server, whenever there is an incoming message for your verified number.
You need to set the Webhook URL within the 99 Digital dashboard.
Incoming message
This will be triggered every time new message arrive to your SMS number.
Settings:
URL | Your URL |
Method | JSON via POST |
With every incoming message, you will receive the following:
{
"event": "incoming",
"message": "Reply back",
"date": "09/03/21 10:25:32",
"from": "0501234567",
"to": "0534444323"
}Response-Explain:
Parameter | Description / Example |
|---|---|
event | incoming |
message | The message that was sent from the user |
date | The time it was sent |
from | Sender number. |
to | The number it was sent to (your verified number). |
Status message
This will be triggered every time you deliver a message, with the message status information
Settings:
URL | Your URL |
Method | JSON via POST |
With every outgoing message you send, you will receive the following back:
{
"event": "status",
"status": 0,
"date": "26/08/26 09:45:47",
"he_message": "הגיע ליעד",
"en_message": "Delivered",
"from": "972535355499",
"to": "0507139996",
"operator": "Pelephone",
"unique": 3683442114
}Response-Explain:
Parameter | Description / Example | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
event | status | ||||||||||||
status |
| ||||||||||||
date | The time when this message arrived or failed to arrive | ||||||||||||
he_message | Hebrew text of the status: נמסר, נכשל, מספר כשר, מספר חסום, תקלה | ||||||||||||
en_message | English text of the status: delivered, failed, kosher, blocked, error | ||||||||||||
from | Your SMS api number. | ||||||||||||
to | The number you sent the message to. | ||||||||||||
operator | The mobile operator of the end user. | ||||||||||||
unique | The unique message ID that you received when sending the message from sendMessage api endpoint. |