Webhooks
Reciba devoluciones de llamadas en tiempo real sobre actualizaciones en Smstools.
¿Qué son los webhooks?
Los webhooks son una extensión de una API, pero en lugar de que su código solicite datos a Smstools, Smstools le envía datos. Los datos llegan en una solicitud web a su aplicación. Los webhooks también se utilizan para notificar a su aplicación eventos como una llamada entrante o un mensaje. Dado que los servidores de Smstools necesitan poder enviar datos a su aplicación a través de webhooks, debe configurar un servidor web para recibir las solicitudes HTTP entrantes. También necesita especificar la URL de cada webhook en su servidor web para que los datos puedan ser enviados a cada uno.
Resumen de los webhooks disponibles
| Tipo | Descripción |
|---|---|
| delivery_report | Informe de entrega después de cada mensaje enviado. A veces puede haber 2 webhooks: primero un estado de 'enviado' y luego un estado de 'entregado' o 'no entregado'. A veces hay detalles adicionales disponibles cuando el mensaje no fue entregado. |
| read_report | Confirmación de lectura después de que se lee el mensaje. Una confirmación de lectura solo está disponible para Mensajes Sociales o mediante el uso del enlace 'Solicitar un informe de lectura'. |
| inbox_message | Mensaje entrante. Solo disponible si está utilizando Mensajes Sociales o un número virtual. |
Códigos de informe de entrega
| Códigos de detalle del informe de entrega | Estado | Explicación |
|---|---|---|
| 0 | SUBMITTED | Este mensaje fue entregado con el operador pero no recibimos ningún informe de entrega. |
| 1 | DELIVERED | Este mensaje se entregó correctamente. |
| 2 | NOT DELIVERED | Este mensaje no fue entregado. Razón posible: el receptor está fuera del alcance de la red, problemas de red, receptor en país extranjero. |
| 3 | BUFFERED | Este mensaje se entregó con el operador pero no se entregó al receptor. |
| 4 | REJECTED | Este mensaje es rechazado por el operador. |
| 5 | REJECTED | ¡Información extendida a continuación! |
| 9 | UNKNOWN | No hay informes de entrega disponibles para este mensaje. |
Códigos de detalle del informe de entrega
| Estado | Explicación |
|---|---|
| 10 | El número de receptor es inválido o desconocido |
| 11 | El receptor está temporalmente fuera del alcance del operador de red |
| 12 | Problema relacionado con el teléfono. |
| 13 | Problema de red del operador |
| 14 | Mensaje caducado - razón desconocida |
| 15 | El receptor está en una lista negra |
| 16 | Problema de contenido del mensaje |
| 17 | El receptor no puede ser liquidado |
| 18 | El operador rechazó esto debido a spam |
| 19 | El suscriptor no puede recibir mensajes premium (bloqueado por el operador) |
Códigos de detalle del informe de entrega en el código de respuesta 5
| Estado | Explicación |
|---|---|
| 2000 | INSUFFICIENT_FUNDS |
| 2001 | TOO_LONG |
| 2002 | TOO_SHORT |
| 2003 | TIMEOUT |
| 2004 | GATEWAY_ISSUES |
| 2005 | INVALID_SENDER |
| 2006 | INVALID_NUMBER |
| 4000 | UNKNOWN |
| 4001 | EMPTY_MESSAGE |
| 4002 | EMPTY_CLIENT |
| 4003 | LOCKED |
| 4004 | BLOCKED |
| 4005 | JOB_FAILED |
| 4006 | DUPLICATE |
| 4007 | INVALID_CONTENT |
Ejemplo: informe de entrega
[
{
"webhook_id": "svt1jtrmekgb67ratwa31ptupc",
"webhook_type": "delivery_report",
"username": "myusername",
"message": {
"messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
"datetime": "2019-01-01 00:00:00",
"content": "here comes your message body",
"sender": "yoursender",
"receiver": "32470123456",
"reference": "yourref",
"delivery_code": "1", [Possible values: 0,1,2,3,4,9]
"delivery_status": "delivered" [code explanation]
"delivery_code_detail": "10", [delivery code with additional details]
"delivery_code_detail_description": "Unknown Subscriber" [detailed explanation]
}
}
]
Ejemplo: mensaje entrante
[
{
"webhook_id": "xvt1jtrrekgb67ratwa31ptuzp",
"webhook_type": "inbox_message",
"username": "myusername",
"message": {
"id": "12345678",
"date": "2019-01-01 00:00:00",
"sender": "sendernumber",
"receiver": "12345678",
"content": "message content",
"type": "sms" [Possible values: sms,whatsapp]
}
"isreply": { [The isreply content will only be added when the message was replied to another message]
"reply": true,
"orig_message_content": "original message content",
"orig_messageid": "985zvqipp73csuuha2079fbshx",
"orig_messagedate": "2019-01-01 00:00:00",
"orig_sender": "32471123456",
"orig_receiver": "12345678",
"orig_reference": ""
}
}
]
Ejemplo: informe de confirmación de lectura
[
{
"webhook_id": "xvt1jtrrekgb67ratwa31ptuzp",
"webhook_type": "read_report",
"username": "myusername",
"message": {
"messageid": "e1qk89exbzgf6fzfunceym2sd67h88",
"datetime": "2019-01-01 00:00:00",
"content": "here comes your message body",
"sender": "yoursender",
"receiver": "32470123456",
"reference": "yourref",
"delivery_code": "1",
"delivery_status": "delivered"
"read_status": "message_read",
"read_datetime": "2019-01-01 00:01:00"
}
}
]
Webhooks
5 de 5 basado en 2439 valoraciones de los usuarios.