Un webhook (o llamada de retorno) permite a nuestra plataforma enviar a tu aplicación información sobre un evento determinado (como un nuevo SMS entrante recibido). Esto ocurre en tiempo real, lo que te permite aprovechar la plataforma para crear tus propias soluciones de mensajería bidireccional enviando SMS a través de la API y procesando cualquier respuesta mediante webhooks.
Acontecimientos comunes que querrás registrar:
- SMS -> Recibir SMS
- SMS -> Se produjo un opt out
- Informes de entrega -> Mensaje entregado
- Informes de entrega -> El mensaje ha caducado
Para crear un webhook, inicia sesión, ve a Ajustes > API y selecciona la pestaña Webhooks. A continuación, haz clic en "Nuevo webhook":
Configura los aspectos básicos de tu webhook:
- Selecciona el evento o eventos que quieres registrar, (p. ej. SMS -> Recibir SMS).
- Selecciona el método HTTP que quieres que enviemos a tu aplicación (p. ej. POST).
- Introduce la URL donde quieres procesar el evento (p. ej. https://tuaplicacion.com/sms/sms-entrantes).
A continuación, especifica las cabeceras que quieras presentar en tu solicitud. Para añadir filas de cabecera adicionales, simplemente haz clic en "Añadir cabecera":
A continuación, especifica el contenido que se pasará en el contenido de la petición al punto de conexión especificado.
Unos buenos valores por defecto para especificar serían los siguientes:
|
id |
$mtID |
|
accountId |
$accountId |
|
sourceAddress |
$sourceAddress |
|
destinationAddress |
$destinationAddress |
|
messageContent |
$mtContent |
|
replyContent |
$moContent |
Por último, haz clic en "Guardar webhook" en la parte inferior derecha de la pantalla.
En este ejemplo, hemos creado un webhook que hará un POST a https://tuaplicacion.com/sms/sms-entrantes cuando reciba un SMS, como una petición JSON con la siguiente información en el cuerpo JSON: id, accountId, sourceAddress, destinationAddress, messageContent, replyContent.