Webhooks

Manage the statuses and replies of your SMS campaigns

Reply on a short number

After sending a campaign from our short number, SMS Partner lets you receive replies. For more information, contact us.

Please note

To receive replies, you must set your reply reception URL

in your SMS API tab

Example of JSON response sent via POST

{
"type":"response",
"phone_number":"+336....",
"text":"test",
"message_id":1111111
}

For a STOP SMS the webhook response will be

{
"type":"stop",
"phone_number":"+336...",
"text":"Stop",
"message_id":111111
}

Reply on a long number (virtual number)

SMS Partner offers the rental of a long number (example: 06 XX XX XX XX) To learn more about creating a dedicated long number, contact us.

Example of a simple response (160 characters maximum)

{
  "msisdn": "33xxxxxxxxx",
  "to": "33xxxxxxxxx",
  "messageId": "1235-1234-1233-4665",
  "text": "Test",
  "type": "text",
  "keyword": "Test",
  "message-timestamp": "2016-03-10 09:51:46"
}

Example of a response for a long SMS (+160 characters)

{
  "msisdn": "33xxxxxxxxx",
  "to": "33xxxxxxxxx",
  "messageId": "a1b2c3d4-e5f6-40a1-80b2-c9d0e1f....", //in UUID format
  "concat": "true",
  "concat-ref": "171",
  "concat-total": "2",
  "concat-part": "1",
  "text": "   Long message....",
  "type": "text",
  "keyword": "MESSAGELONG",
  "message-timestamp": "2016-03-09 16:00:30"
}
 
{
  "msisdn": "33xxxxxxxxx",
  "to": "33xxxxxxxxx",
  "messageId": "a1b2c3d4-e5f6-40a1-80b2-c9d0e1...", //in UUID format
  "concat": "true",
  "concat-ref": "171",
  "concat-total": "2",
  "concat-part": "2",
  "text": "....very long",
  "type": "text",
  "keyword": "TRESLONG",
  "message-timestamp": "2016-03-09 16:00:31"
}

DLR - retrieving SMS statuses

The SMS delivery status can be sent via the webhook using POST

{
"status":"delivered",
"msgId":"11111111",
"date":1764768485,
"phone":"+336.......",
"cost":"0.049",
"currency":"EUR",
"tag":"...."
}

The possible statuses are

• delivered: The SMS was delivered

• not delivered: The SMS was not delivered

• waiting: The SMS is pending at the operator