Registrar webhook

Registra una nueva URL de endpoint de webhook para recibir notificaciones por callback.

POST https://api.getincloud.ai/v1/webhooks

Registra una nueva URL de endpoint de webhook para recibir notificaciones por callback.

Para más información sobre casos de uso de los Webhooks y ejemplos de integración, lee aquí el tutorial de Webhooks.

Si no sabes qué son los webhooks, lee este artículo.

Nota: la URL del endpoint del webhook debe ser accesible desde la Internet pública

y usar un dominio válido con resolución DNS correcta. Por ejemplo: https://mycompany.com/webhook

Nuestro sistema realizará una petición HTTP

a la URL del endpoint remoto que indiques cada vez que ocurra un nuevo evento de mensaje o de dispositivo.

La información se codificará en formato JSON como parte de los datos del cuerpo HTTP.

Tu servidor debe aceptar y leer el cuerpo de la petición HTTP POST y procesarlo en consecuencia.

Tu servidor debe responder con un código de estado HTTP 200-209. De lo contrario, se considerará una

notificación fallida y se reintentará.

Preguntas

Consulta las preguntas y respuestas frecuentes en este artículo del Centro de ayuda.

Recomendación de seguridad

Recomendamos encarecidamente usar HTTPS en lugar de HTTP, ya que la comunicación estaría cifrada de extremo a extremo.

Eventos de webhook

Los eventos de webhook compatibles son:

• deal:stage:changed: Cuando un negocio del embudo de ventas se mueve a otra etapa (disponible en el plan Platform Professional y superiores)
• deal:won: Cuando un negocio del embudo de ventas se cierra como ganado (disponible en el plan Platform Professional y superiores)
• deal:lost: Cuando un negocio del embudo de ventas se cierra como perdido (disponible en el plan Platform Professional y superiores)
• deal:assigned: Cuando un negocio del embudo de ventas se asigna a un agente o se desasigna (disponible en el plan Platform Professional y superiores)
• deal:updated: Cuando cambia el título o el importe de un negocio del embudo de ventas (disponible en el plan Platform Professional y superiores)
• deal:archived: Cuando un negocio del embudo de ventas se archiva (disponible en el plan Platform Professional y superiores)
• deal:reopened: Cuando un negocio del embudo de ventas cerrado o archivado se reabre (disponible en el plan Platform Professional y superiores)
• message:in:new: En cada nuevo mensaje entrante enviado por usuarios o grupos a tu dispositivo (restringido a los planes Platform)
• message:out:new: En cada mensaje saliente entregado desde el número de WhatsApp conectado a otros usuarios (restringido a los planes Platform)
• message:out:sent: En cada mensaje entregado correctamente (restringido a los planes Gateway)
• message:out:ack: En cada actualización de estado de un mensaje saliente: recibido o leído por el usuario (restringido a los planes Platform Business y Enterprise)
• message:update: Notifica cuando se actualiza el contenido de un mensaje existente: en nuevos votos de encuestas, en confirmación o cancelación de asistencia a eventos, en edición de mensajes
• message:reaction: Notifica cuando se añade o se elimina una reacción a un mensaje. Solo es compatible con los planes Business y Enterprise
• status:update: En cada nueva publicación de estado de usuario realizada por cualquiera de tus contactos guardados
• channel:in: En cada mensaje recién recibido en cualquier canal que estés siguiendo
• message:out:failed: En cada entrega de mensaje fallida (se superó el máximo de reintentos, multimedia no válido o número de teléfono no encontrado)
• number:session: Se notifica cuando la sesión de WhatsApp del número se conecta, se desconecta o pierde la conexión
• group:update: En cada actualización de grupo: nuevo grupo, cambio de nombre, cambio de asunto, participante añadido o eliminado, participante promovido o degradado, cambio de configuración del grupo
• chat:update: En cada actualización de chat: cambios de estado del chat, el chat se asigna o se desasigna, el chat se resuelve o se reabre como no resuelto, el chat se archiva, el chat se elimina
• contact:update: En cada actualización de contacto: se actualiza la información o los metadatos

A continuación encontrarás más detalles y ejemplos JSON de los distintos eventos de webhook.

Ejemplos de webhook

Explora decenas de ejemplos de payloads JSON de eventos de webhook y casos de uso reales en el artículo del Centro de ayuda.

Evento de nuevo mensaje entrante

Evento: message:in:new

Nota: este tipo de evento solo está disponible en los planes Platform. Más abajo encontrarás los eventos de webhook específicos de los planes Gateway.

Ejemplo de evento de webhook de nuevo mensaje de texto entrante (payload JSON)

<details>

<summary>Haz clic para mostrar el ejemplo de payload JSON</summary>

{
  "id": "3EB03EBAF8863B70BA00AF",
  "object": "message",
  "event": "message:in:new",
  "created": 1671225190,
  "device": {
      "id": "61b37a069cba0c15d6c89757",
      "phone": "+4412345678",
      "alias": "Demo",
      "plan": "io-enterprise",
      "version": 1
  },
  "data": {
      "id": "3EB03EBAF8863B70BA00AF",
      "type": "text",
      "flow": "inbound",
      "status": "active",
      "ack": "delivered",
      "from": "+4412345678@c.us",
      "fromNumber": "+4412345678",
      "to": "1234567890@c.us",
      "toNumber": "+1234567890",
      "date": "2022-12-15T20:00:00.000Z",
      "timestamp": 1671225190,
      "body": "This is a sample inbound text message webhook event",
      "chat": {
          "id": "1234567890@c.us",
          "name": "John Wick",
          "date": "2022-12-15T20:00:00.000Z",
          "type": "chat",
          "status": "active",
          "waStatus": "active",
          "statusUpdatedAt": "2022-08-23T08:40:45.722Z",
          "deletedAt": "2022-08-24T13:28:25.033Z",
          "firstMessageAt": "2022-08-19T10:59:08.000Z",
          "lastMessageAt": "2022-12-15T20:00:00.000Z",
          "lastOutboundMessageAt": "2022-12-15T20:00:00.000Z",
          "lastInboundMessageAt": "2022-12-15T22:00:00.000Z",
          "lastReactionAt": "2022-12-15T03:00:13.662Z",
          "lastReactionEmoji": "",
          "stats": {
              "notes": 0,
              "localMessages": 53,
              "inboundMessages": 0,
              "outboundMessages": 0
          },
          "labels": [
              "sales",
              "new-customer"
          ],
          "owner": {
              "agent": "5f71e36254800f533ab79148",
              "assigner": "5f71e36254800f533ab79148",
              "assignedAt": "2022-11-15T23:53:00.439Z"
          },
          "contact": {
              "wid": "1234567890@c.us",
              "name": "John",
              "shortName": "Wick",
              "displayName": "John Wick",
              "formattedName": "John Wick",
              "formattedShortName": "John Wick",
              "syncedAt": "2022-12-16T21:47:03.206Z",
              "phone": "+1234567890",
              "image": {
                  "url": "https://pps.whatsapp.net/v/t61.1111-1/1234567_1234567_1234567_n.jpg?oe=1234567&oh=123456712345671234567"
              }
          }
      },
      "events": {
          "sent": {
              "date": "2022-12-15T20:00:00.000Z"
          }
      },
      "meta": {
          "rtl": false,
          "containsEmoji": false,
          "isGif": false,
          "isStar": false,
          "isGroup": false,
          "isForwarded": false,
          "isEphemeral": false,
          "isNotification": false,
          "isLive": false,
          "isBroadcast": false,
          "isBizNotification": false,
          "isDoc": false,
          "isLinkPreview": false,
          "isPSA": false,
          "isRevoked": false,
          "isUnreadType": false,
          "isFailed": false,
          "notifyName": "Support Team",
          "source": "android"
      }
  }
}

</details>

Ejemplo de evento de webhook de nuevo mensaje multimedia entrante (payload JSON)

<details>

<summary>Haz clic para mostrar el ejemplo de payload JSON</summary>

{
  "id": "3EB03EBAF8863B70BA001A",
  "object": "message",
  "event": "message:out:new",
  "created": 1671225190,
  "device": {
      "id": "61b37a069cba0c15d6c89757",
      "phone": "+4412345678",
      "alias": "Demo",
      "plan": "io-enterprise",
      "version": 1
  },
  "data": {
      "id": "3EB03EBAF8863B70BA001A",
      "type": "image",
      "flow": "outbound",
      "status": "active",
      "ack": "delivered",
      "from": "+4412345678@c.us",
      "fromNumber": "+4412345678",
      "to": "1234567890@c.us",
      "toNumber": "+1234567890",
      "date": "2022-12-15T20:00:00.000Z",
      "timestamp": 1671225190,
      "body": "This is a sample inbound image message webhook event",
      "chat": {
          "id": "1234567890@c.us",
          "name": "Mike",
          "date": "2022-12-15T20:00:00.000Z",
          "type": "chat",
          "status": "active",
          "waStatus": "active",
          "statusUpdatedAt": "2022-08-23T08:40:45.722Z",
          "deletedAt": "2022-08-24T13:28:25.033Z",
          "firstMessageAt": "2022-08-19T10:59:08.000Z",
          "lastMessageAt": "2022-12-15T20:00:00.000Z",
          "lastOutboundMessageAt": "2022-12-15T20:00:00.000Z",
          "lastInboundMessageAt": "2022-12-15T22:00:00.000Z",
          "lastReactionAt": "2022-12-15T03:00:13.662Z",
          "lastReactionEmoji": "",
          "stats": {
              "notes": 0,
              "localMessages": 53,
              "inboundMessages": 0,
              "outboundMessages": 0
          },
          "labels": [
              "sales",
              "new-customer"
          ],
          "owner": {
              "agent": "5f71e36254800f533ab79148",
              "assigner": "5f71e36254800f533ab79148",
              "assignedAt": "2022-11-15T23:53:00.439Z"
          },
          "contact": {
              "wid": "1234567890@c.us",
              "name": "Mike",
              "shortName": "Mike",
              "displayName": "Mike",
              "formattedName": "Mike",
              "formattedShortName": "Mike",
              "syncedAt": "2022-12-16T21:47:03.206Z",
              "phone": "+1234567890",
              "image": {
                  "url": "https://pps.whatsapp.net/v/t61.1111-1/1234567_1234567_1234567_n.jpg?oe=1234567&oh=123456712345671234567"
              }
          }
      },
      "media": {
          "id": "639ce7571e6e11586eb6ccb6",
          "message": "3EB03EBAF8863B70BA00",
          "chat": "1234567890@c.us",
          "flow": "out",
          "status": "available",
          "caption": null,
          "type": "image",
          "size": 196851,
          "mime": "image/jpeg",
          "extension": "jpeg",
          "filename": "image_out_4412345678@c.us_3EB03EBAF8863B70BA00.jpeg",
          "createdAt": "2022-12-16T21:47:03.814Z",
          "expiresAt": "2022-12-23T21:47:03.809Z",
          "meta": {
              "hasPreview": true,
              "aspectRatio": 0.75
          },
          "stats": {
              "downloads": 0
          },
          "preview": {
              "image": "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAApgAAAKYB3X3=",
              "width": 47,
              "height": 63,
              "mime": "image/jpeg"
          },
          "links": {
              "resource": "/v1/chat/61b37a069cba0c15d6c89757/files/639ce7571e6e11586eb6ccb6",
              "download": "/v1/chat/61b37a069cba0c15d6c89757/files/639ce7571e6e11586eb6ccb6/download",
              "chat": "/v1/chat/61b37a069cba0c15d6c89757/chats/1234567890@c.us",
              "contact": "/v1/chat/61b37a069cba0c15d6c89757/contacts/1234567890@c.us",
              "message": "/v1/chat/61b37a069cba0c15d6c89757/messages/3EB03EBAF8863B70BA00"
          }
      },
      "events": {
          "sent": {
              "date": "2022-12-15T20:00:00.000Z"
          }
      },
      "meta": {
          "rtl": false,
          "containsEmoji": false,
          "isGif": false,
          "isStar": false,
          "isGroup": false,
          "isForwarded": false,
          "isEphemeral": false,
          "isNotification": false,
          "isLive": false,
          "isBroadcast": false,
          "isBizNotification": false,
          "isDoc": false,
          "isLinkPreview": false,
          "isPSA": false,
          "isRevoked": false,
          "isUnreadType": false,
          "isFailed": false,
          "notifyName": "Support Team"
      }
  }
}

</details>

Evento de nuevo mensaje saliente

Evento: message:out:new

Nota: este tipo de evento solo está disponible en los planes Platform. Más abajo encontrarás los eventos de webhook específicos de los planes Gateway.

Ejemplo de evento de webhook de nuevo mensaje de texto saliente (payload JSON)

<details>

<summary>Haz clic para mostrar el ejemplo de payload JSON</summary>

{
  "id": "3EB004B1D010CA0EF6A201",
  "object": "message",
  "event": "message:out:new",
  "created": 1671220018,
  "device": {
      "id": "61b37a069cba0c15d6c89757",
      "phone": "+44123456789",
      "alias": "Demo-2",
      "plan": "io-enterprise",
      "version": 1
  },
  "data": {
      "id": "3EB004B1D010CA0EF6A201",
      "type": "text",
      "flow": "outbound",
      "status": "active",
      "ack": "delivered",
      "agent": "5f71e36254800f533ab79148",
      "from": "44123456789@c.us",
      "fromNumber": "+44123456789",
      "to": "1234567890@c.us",
      "toNumber": "+1234567890",
      "date": "2022-12-15T22:00:00.000Z",
      "timestamp": 1671220018,
      "body": "Hello! This is a sample outbound text message webhook event",
      "chat": {
          "id": "1234567890@c.us",
          "name": "John",
          "date": "2022-12-15T22:00:00.000Z",
          "type": "chat",
          "status": "active",
          "waStatus": "active",
          "statusUpdatedAt": "2022-08-23T08:40:45.722Z",
          "deletedAt": "2022-08-24T13:28:25.033Z",
          "firstMessageAt": "2022-08-19T10:59:08.000Z",
          "lastMessageAt": "2022-12-15T22:06:32.000Z",
          "lastOutboundMessageAt": "2022-12-15T22:06:32.000Z",
          "lastInboundMessageAt": "2022-12-15T22:02:58.000Z",
          "lastReactionAt": "2022-12-15T03:39:03.000Z",
          "lastReactionEmoji": "",
          "stats": {
              "notes": 0,
              "localMessages": 234,
              "inboundMessages": 0,
              "outboundMessages": 0
          },
          "labels": [
              "sales",
              "customer"
          ],
          "owner": {
              "agent": "5f71e36254800f533ab79148",
              "assigner": "5f71e36254800f533ab79148",
              "assignedAt": "2022-11-15T23:53:00.439Z"
          },
          "contact": {
              "wid": "1234567890@c.us",
              "name": "John",
              "shortName": "John",
              "displayName": "John",
              "formattedName": "John",
              "formattedShortName": "John",
              "syncedAt": "2022-12-15T22:06:32.952Z",
              "phone": "+1234567890",
              "image": {
                  "url": "https://pps.whatsapp.net/v/t61.123456-24/12345678_00011112222233334444_100135239294920312_n.jpg"
              }
          }
      },
      "events": {
          "sent": {
              "date": "2022-12-15T22:06:33.108Z"
          }
      },
      "meta": {
          "rtl": false,
          "containsEmoji": false,
          "isGif": false,
          "isStar": false,
          "isGroup": false,
          "isForwarded": false,
          "isEphemeral": false,
          "isNotification": false,
          "isLive": false,
          "isBroadcast": false,
          "isBizNotification": false,
          "isDoc": false,
          "isLinkPreview": false,
          "isPSA": false,
          "isRevoked": false,
          "isUnreadType": false,
          "isFailed": false,
          "notifyName": "Support Team"
      }
  }
}

</details>

El mensaje es recibido y leído por el destinatario

Evento: message:out:ack

Nota: este tipo de evento solo está disponible en los planes Platform. Más abajo encontrarás los eventos de webhook específicos de los planes Gateway.

Ejemplo de evento de webhook de nuevo mensaje de texto saliente (payload JSON)

<details>

<summary>Haz clic para mostrar el ejemplo de payload JSON</summary>

{
  "id": "3EB004B1D010CA0EF6A205",
  "object": "message",
  "event": "message:out:ack",
  "created": 1671220018,
  "ack": "read",
  "device": {
      "id": "61b37a069cba0c15d6c89757",
      "phone": "+44123456789",
      "alias": "Demo",
      "plan": "io-enterprise",
      "version": 1
  },
  "data": {
      "id": "3EB004B1D010CA0EF6A205",
      "type": "text",
      "flow": "outbound",
      "status": "active",
      "ack": "read",
      "from": "44123456789@c.us",
      "fromNumber": "+44123456789",
      "to": "1234567890@c.us",
      "toNumber": "+1234567890",
      "date": "2022-12-15T20:00:00.000Z",
      "timestamp": 1671220018,
      "body": "This is a sample message read ack webhook event",
      "chat": {
          "id": "1234567890@c.us",
          "name": "John",
          "date": "2022-12-15T21:00:00.000Z",
          "type": "chat",
          "status": "active",
          "waStatus": "active",
          "statusUpdatedAt": "2022-08-23T08:40:45.722Z",
          "deletedAt": "2022-08-24T13:28:25.033Z",
          "firstMessageAt": "2022-08-19T10:59:08.000Z",
          "lastMessageAt": "2022-12-16T21:25:38.000Z",
          "lastOutboundMessageAt": "2022-12-16T21:25:38.000Z",
          "lastInboundMessageAt": "2022-12-15T22:02:58.000Z",
          "lastReactionAt": "2022-12-15T03:43:13.662Z",
          "lastReactionEmoji": "",
          "stats": {
              "notes": 0,
              "localMessages": 52,
              "inboundMessages": 0,
              "outboundMessages": 0
          },
          "labels": [
              "sales",
              "new-customer"
          ],
          "owner": {
              "agent": "5f71e36254800f533ab79148",
              "assigner": "5f71e36254800f533ab79148",
              "assignedAt": "2022-11-15T23:53:00.439Z"
          },
          "contact": {
              "wid": "1234567890@c.us",
              "name": "John",
              "shortName": "John",
              "displayName": "John",
              "formattedName": "John",
              "formattedShortName": "John",
              "syncedAt": "2022-12-16T21:26:37.821Z",
              "phone": "+1234567890",
              "image": {
                  "url": "https://pps.whatsapp.net/v/t61.123456-24/12345678_00011112222233334444_100135239294920312_n.jpg"
              }
          }
      },
      "events": {
          "sent": {
              "date": "2022-12-16T21:26:43.215Z"
          },
          "delivered": {
              "date": "2022-12-16T21:26:43.216Z"
          }
      },
      "meta": {
          "rtl": false,
          "containsEmoji": false,
          "isGif": false,
          "isStar": false,
          "isGroup": false,
          "isForwarded": false,
          "isEphemeral": false,
          "isNotification": false,
          "isLive": false,
          "isBroadcast": false,
          "isBizNotification": false,
          "isDoc": false,
          "isLinkPreview": false,
          "isPSA": false,
          "isRevoked": false,
          "isUnreadType": false,
          "isFailed": false,
          "notifyName": "Support Team"
      }
  }
}

</details>

Evento de mensaje enviado (solo planes Gateway)

Importante: los siguientes eventos de webhook solo están disponibles en los planes Gateway y están obsoletos en los demás planes.

Si usas un plan diferente, utiliza en su lugar el siguiente evento de webhook:

• Usa message:out:new en lugar de message:out:sent

Este evento usa un payload JSON estructurado como un arreglo de objetos, por lo que se pueden notificar varios mensajes en la misma petición HTTP POST, hasta 25 elementos por notificación.

Ejemplo de estructura de datos del payload JSON

<details>

<summary>Haz clic para mostrar el ejemplo de payload JSON</summary>

[
  {
    "event": "<event type>",
    "date": "2022-12-08T15:01:48.518Z",
    "entity": "message",
    "entityId": "<Message ID>",
    "entityUrl": "https://api.getincloud.ai/v1/messages/<Message ID>",
    "user": "<User ID>",
    "data": { ... }
  },
  {
    "event": "<event type>",
    "date": "2022-12-08T15:01:48.518Z",
    "entity": "message",
    "entityId": "<Message ID>",
    "entityUrl": "https://api.getincloud.ai/v1/messages/<Message ID>",
    "user": "<User ID>",
    "data": { ... }
  },
  ...
]

</details>

Ejemplo de cuerpo JSON de un POST para un evento específico de mensaje enviado

<details>

<summary>Haz clic para mostrar el ejemplo de payload JSON</summary>

[
  {
    "event": "message:out:sent",
    "date": "2018-12-08T15:01:48.518Z",
    "entity": "message",
    "entityId": "5bf612faa893b00016c0f13d",
    "entityUrl": "https://api.getincloud.ai/v1/messages/5bf612faa893b00016c0f13d",
    "user": "5bd75ab235623e00162a73dc",
    "data": {
      "id": "5bf612faa893b00016c0f13d",
      "phone": "+1234567890",
      "status": "processed",
      "deliveryStatus": "delivered",
      "createdAt": "2022-11-22T02:22:50.955Z",
      "sentAt": "2022-11-22T02:29:29.254Z",
      "failedAt": null,
      "processedAt": "2022-11-22T02:28:54.818Z",
      "webhookStatus": "pending",
      "message": "This is an automated message sent from getincloud API",
      "priority": "normal",
      "schedule": {
        "enabled": false
      },
      "retry": {
        "count": 1,
        "lastRetryAt": "2022-11-22T02:25:58.414Z"
      },
      "device": {
        "id": "3bf5d1ff2ff2bd001696ac42",
        "phone": "+1234567890",
        "alias": "My WA Delivery Device",
        "description": "Device 1 for customer support and product notifications",
        "status": "verified",
        "session": {
          "status": "online",
          "error": false,
          "lastSyncAt": "2018-12-02T10:11:16.008Z"
        },
        "createdAt": "2018-11-20T09:21:03.898Z",
        "queue": {
          "total": 100,
          "size": 0,
          "available": 100
        },
        "profile": {
          "name": "+1234567890",
          "info": null,
          "lastSyncAt": "2022-11-22T22:14:33.334Z",
          "imagePath": "/v1/devices/3bf5d1ff2ff2bd001696ac42/profile/image"
        },
        "links": {
          "device": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42"
          },
          "scan": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42/scan"
          },
          "sync": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42/sync"
          },
          "health": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42/health"
          },
          "profileImage": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42/profile/image"
          },
          "messages": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/messages?devices=3bf5d1ff2ff2bd001696ac42"
          }
        },
        "stats": {
          "total": {
            "sent": 565,
            "failed": 103,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 13331,
            "totalUpstreamSpeed": 0
          },
          "minutes": {
            "sent": 4,
            "failed": 0,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 48,
            "totalUpstreamSpeed": 0
          },
          "quarter": {
            "sent": 4,
            "failed": 0,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 48,
            "totalUpstreamSpeed": 0
          },
          "hour": {
            "sent": 10,
            "failed": 1,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 114,
            "totalUpstreamSpeed": 0
          },
          "day": {
            "sent": 10,
            "failed": 1,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 114,
            "totalUpstreamSpeed": 0
          },
          "week": {
            "sent": 10,
            "failed": 1,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 114,
            "totalUpstreamSpeed": 0
          },
          "month": {
            "sent": 565,
            "failed": 103,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 13331,
            "totalUpstreamSpeed": 0
          },
          "year": {
            "sent": 565,
            "failed": 103,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 13331,
            "totalUpstreamSpeed": 0
          }
        }
      }
    }
  }
]

</details>

Evento de fallo en la entrega del mensaje

Evento: message:out:failed

Este evento usa un payload JSON estructurado como un arreglo de objetos, por lo que se pueden notificar varios mensajes en la misma petición HTTP POST, hasta 25 elementos por notificación.

<details>

<summary>Haz clic para mostrar el ejemplo de payload JSON</summary>

[
  {
    "event": "<event type>",
    "date": "2022-12-08T15:01:48.518Z",
    "entity": "message",
    "entityId": "<Message ID>",
    "entityUrl": "https://api.getincloud.ai/v1/messages/<Message ID>",
    "user": "<User ID>",
    "data": { ... }
  },
  {
    "event": "<event type>",
    "date": "2022-12-08T15:01:48.518Z",
    "entity": "message",
    "entityId": "<Message ID>",
    "entityUrl": "https://api.getincloud.ai/v1/messages/<Message ID>",
    "user": "<User ID>",
    "data": { ... }
  },
  ...
]

</details>

Ejemplo de cuerpo JSON de un POST para un evento de webhook de mensaje fallido

<details>

<summary>Haz clic para mostrar el ejemplo de payload JSON</summary>

[
  {
    "event": "message:out:failed",
    "date": "2018-12-08T15:01:48.518Z",
    "entity": "message",
    "entityId": "5bf612faa893b00016c0f13d",
    "entityUrl": "https://api.getincloud.ai/v1/messages/5bf612faa893b00016c0f13d",
    "user": "5bd75ab235623e00162a73dc",
    "data": {
      "id": "5bf612faa893b00016c0f13d",
      "phone": "+1234567890",
      "status": "failed",
      "deliveryStatus": "failed",
      "createdAt": "2022-11-22T02:22:50.955Z",
      "sentAt": "2022-11-22T02:29:29.254Z",
      "failedAt": null,
      "processedAt": "2022-11-22T02:28:54.818Z",
      "webhookStatus": "pending",
      "message": "This is an automated message sent from the API",
      "priority": "normal",
      "schedule": {
        "enabled": false
      },
      "retry": {
        "count": 1,
        "lastRetryAt": "2022-11-22T02:25:58.414Z"
      },
      "device": {
        "id": "3bf5d1ff2ff2bd001696ac42",
        "phone": "+1234567890",
        "alias": "My WA Delivery Device",
        "description": "Device 1 for customer support and product notifications",
        "status": "verified",
        "session": {
          "status": "online",
          "error": false,
          "lastSyncAt": "2022-12-02T10:11:16.008Z"
        },
        "createdAt": "2022-11-20T09:21:03.898Z",
        "queue": {
          "total": 100,
          "size": 0,
          "available": 100
        },
        "profile": {
          "name": "+1234567890",
          "info": null,
          "lastSyncAt": "2022-11-22T22:14:33.334Z",
          "imagePath": "/v1/devices/3bf5d1ff2ff2bd001696ac42/profile/image"
        },
        "links": {
          "device": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42"
          },
          "scan": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42/scan"
          },
          "sync": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42/sync"
          },
          "health": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42/health"
          },
          "profileImage": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/devices/3bf5d1ff2ff2bd001696ac42/profile/image"
          },
          "messages": {
            "method": "GET",
            "url": "https://api.getincloud.ai/v1/messages?devices=3bf5d1ff2ff2bd001696ac42"
          }
        },
        "stats": {
          "total": {
            "sent": 565,
            "failed": 103,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 13331,
            "totalUpstreamSpeed": 0
          },
          "minutes": {
            "sent": 4,
            "failed": 0,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 48,
            "totalUpstreamSpeed": 0
          },
          "quarter": {
            "sent": 4,
            "failed": 0,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 48,
            "totalUpstreamSpeed": 0
          },
          "hour": {
            "sent": 10,
            "failed": 1,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 114,
            "totalUpstreamSpeed": 0
          },
          "day": {
            "sent": 10,
            "failed": 1,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 114,
            "totalUpstreamSpeed": 0
          },
          "week": {
            "sent": 10,
            "failed": 1,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 114,
            "totalUpstreamSpeed": 0
          },
          "month": {
            "sent": 565,
            "failed": 103,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 13331,
            "totalUpstreamSpeed": 0
          },
          "year": {
            "sent": 565,
            "failed": 103,
            "media": 0,
            "totalUpstreamSize": 0,
            "totalDeliveryTime": 13331,
            "totalUpstreamSpeed": 0
          }
        }
      }
    }
  }
]

</details>

Prueba este endpoint en el probador de API en vivo

>¿Necesitas ayuda? Explora todos los tutoriales, más de 100 ejemplos de casos de uso y juega con el probador de API en vivo con ejemplos de código listos para usar en más de 15 lenguajes de programación, incluidos JavaScript/Node.js, PHP, Python, C#, Java, Ruby, Swift, Kotlin, Powershell, cURL y más.

Autenticación

Envía tu API key en el encabezado Token en cada petición.

Cuerpo de la petición

Respuestas

// This code example requires you to have installed curl package
// Installation instructions here: https://curl.haxx.se/download.html

// Create new webhooks endpoint
curl --request POST \
  --url https://api.getincloud.ai/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"name":"My webhook server","url":"http://webhooks.company.com"}'


// Create new webhooks endpoint that accepts only certain events
curl --request POST \
  --url https://api.getincloud.ai/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'Token: <api token goes here>' \
  --data '{"name":"My webhook server","url":"http://webhooks.company.com","events":["message:out:sent","message:out:failed"]}'