Événements et payloads des webhooks SMS

Les cinq événements et la forme de ce que vous recevez pour chacun.

Dernière mise à jour 18 octobre 2026

SMS reçu

Se déclenche quand l’appareil Android reçoit un SMS. C’est la base des chatbots et des réponses automatiques.

{
  "event": "received",
  "createdAt": "2026-08-14T10:30:45.123Z",
  "data": {
    "id": "msg_01H8Z",
    "from": "+14155550100",
    "message": "Jeudi matin, si possible.",
    "receivedAt": "2026-08-14T10:30:44.000Z",
    "conversationId": "conv_9f21",
    "deviceId": "dev_oppo_cph2577",
    "inReplyTo": {
      "id": "msg_01H8X",
      "reference": "appointment_8841",
      "body": "Votre rendez-vous du 10/08 à 11h15 est confirmé.",
      "sentAt": "2026-08-14T09:02:11.000Z"
    }
  }
}

SMS envoyé

Se déclenche quand le téléphone transmet le message au réseau. sent, delivered et failed ont tous la même forme.

{
  "event": "sent",
  "createdAt": "2026-08-14T10:31:02.400Z",
  "data": {
    "id": "msg_01H8X",
    "status": "sent",
    "to": "+14155550100",
    "deviceId": "dev_oppo_cph2577",
    "segments": 1,
    "encoding": "GSM-7",
    "reference": "appointment_8841",
    "createdAt": "2026-08-14T09:02:10.000Z",
    "deliveredAt": null,
    "error": null
  }
}

SMS remis

Se déclenche quand l’opérateur confirme la remise au destinataire. C’est l’événement qui confirme vraiment que le message est arrivé.

SMS en échec

Se déclenche quand l’envoi échoue. Le champ error contient la raison.

{
  "event": "failed",
  "createdAt": "2026-08-14T10:31:15.789Z",
  "data": {
    "id": "msg_01H8Y",
    "status": "failed",
    "to": "+14155550188",
    "deviceId": "dev_oppo_cph2577",
    "segments": 1,
    "encoding": "GSM-7",
    "reference": null,
    "createdAt": "2026-08-14T10:30:02.000Z",
    "deliveredAt": null,
    "error": "invalid number"
  }
}

Se déclenche quand quelqu’un se désinscrit. Le message entier doit être l’un de ces mots-clés, sans distinction entre majuscules et minuscules : STOP, STOPALL, UNSUBSCRIBE, CANCEL, END, QUIT, SAIR ou PARAR. « Stop merci » ne compte pas. Dès lors, tout envoi vers ce numéro renvoie 403 recipient_opted_out.

{
  "event": "opted_out",
  "createdAt": "2026-08-14T10:32:00.000Z",
  "data": {
    "phoneNumber": "+14155550100",
    "at": "2026-08-14T10:32:00.000Z",
    "keyword": "STOP"
  }
}