Onurix - Api

Estado de Mensajes message_status

Estos eventos notifican el ciclo de vida de cada mensaje enviado a través de WhatsApp. Tu servidor recibirá una solicitud POST cada vez que el estado de un mensaje cambie.

Usa el campo event para identificar qué ocurrió y actuar en consecuencia.

Enviado

Confirma que el mensaje salió exitosamente de los servidores de Onurix hacia Meta. Aún no garantiza que llegó al dispositivo del destinatario.

Campos del payload.

Campo	Tipo	Descripción
event	string	Valor fijo: message_status.sent
messageId	string	ID único del mensaje (formato wamid.*)
fromWhatsAppNumberId	string	ID del número de WhatsApp Business remitente
fromWhatsAppNumber	string	Número remitente en formato E.164
toWhatsAppNumber	string	Número destinatario en formato E.164
receivedAt	string (ISO 8601)	Fecha y hora del evento
conversationId	string	ID de la conversación de Meta
conversationExpireAt	string (ISO 8601)	Expiración de la ventana de conversación

Payload de ejemplo.

{
  "event": "message_status.sent",
  "messageId": "wamid.HBjLMTY1NTU1MDExM18xX-GGLmVBQkZGRjg0QzQ4NkFENEUwRAA=",
  "fromWhatsAppNumberId": "109876543210987",
  "fromWhatsAppNumber": "+15550987654",
  "toWhatsAppNumber": "+573001234567",
  "receivedAt": "2024-10-21T18:35:01Z",
  "conversationId": "CONVERSATION_ID_123",
  "conversationExpireAt": "2024-10-22T18:35:01Z"
}

Entregado

Confirma que el mensaje fue recibido en el dispositivo del destinatario. No implica que el usuario lo haya leído.

Campos del payload.

Campo	Tipo	Descripción
event	string	Valor fijo: message_status.delivered
messageId	string	ID único del mensaje (formato wamid.*)
fromWhatsAppNumberId	string	ID del número de WhatsApp Business remitente
fromWhatsAppNumber	string	Número remitente en formato E.164
toWhatsAppNumber	string	Número destinatario en formato E.164
receivedAt	string (ISO 8601)	Fecha y hora del evento
conversationId	string	ID de la conversación de Meta
conversationExpireAt	string (ISO 8601)	Expiración de la ventana de conversación

Payload de ejemplo.

{
  "event": "message_status.delivered",
  "messageId": "wamid.HBjLMTY1NTU1MDExM18xX-GGLmVBQkZGRjg0QzQ4NkFENEUwRAA=",
  "fromWhatsAppNumberId": "109876543210987",
  "fromWhatsAppNumber": "+15550987654",
  "toWhatsAppNumber": "+573001234567",
  "receivedAt": "2024-10-21T18:35:02Z",
  "conversationId": "CONVERSATION_ID_123",
  "conversationExpireAt": "2024-10-22T18:35:01Z"
}

Leído

Confirma que el destinatario abrió y leyó el mensaje. Solo se dispara si el usuario tiene activadas las confirmaciones de lectura en WhatsApp.

Campos del payload.

Campo	Tipo	Descripción
event	string	Valor fijo: message_status.read
messageId	string	ID único del mensaje (formato wamid.*)
fromWhatsAppNumberId	string	ID del número de WhatsApp Business remitente
fromWhatsAppNumber	string	Número remitente en formato E.164
toWhatsAppNumber	string	Número destinatario en formato E.164
receivedAt	string (ISO 8601)	Fecha y hora del evento
conversationId	string	ID de la conversación de Meta
conversationExpireAt	string (ISO 8601)	Expiración de la ventana de conversación

Payload de ejemplo.

{
  "event": "message_status.read",
  "messageId": "wamid.HBjLMTY1NTU1MDExM18xX-GGLmVBQkZGRjg0QzQ4NkFENEUwRAA=",
  "fromWhatsAppNumberId": "109876543210987",
  "fromWhatsAppNumber": "+15550987654",
  "toWhatsAppNumber": "+573001234567",
  "receivedAt": "2024-10-21T18:35:05Z",
  "conversationId": "CONVERSATION_ID_123",
  "conversationExpireAt": "2024-10-22T18:35:01Z"
}

Fallido

Notifica que el mensaje no pudo ser entregado. El campo errorDetails incluye el código y descripción del error reportado por Meta.

Campos del payload.

Campo	Tipo	Descripción
event	string	Valor fijo: message_status.failed
messageId	string	ID único del mensaje (formato wamid.*)
fromWhatsAppNumberId	string	ID del número de WhatsApp Business remitente
fromWhatsAppNumber	string	Número remitente en formato E.164
toWhatsAppNumber	string	Número destinatario en formato E.164
receivedAt	string (ISO 8601)	Fecha y hora del evento
conversationId	string	ID de la conversación de Meta
conversationExpireAt	string (ISO 8601)	Expiración de la ventana de conversación
errorDetails.errorCode	integer	Código de error de Meta (ej. 131026)
errorDetails.errorTitle	string	Descripción del error (ej. Message Undeliverable)

Payload de ejemplo.

{
  "event": "message_status.failed",
  "messageId": "wamid.HBjLMTY1NTU1MDExM18xX-GGLmVBQkZGRjg0QzQ4NkFENEUwRAA=",
  "fromWhatsAppNumberId": "109876543210987",
  "fromWhatsAppNumber": "+15550987654",
  "toWhatsAppNumber": "+573001234567",
  "receivedAt": "2024-10-21T18:35:03Z",
  "conversationId": "CONVERSATION_ID_123",
  "conversationExpireAt": "2024-10-22T18:35:01Z",
  "errorDetails": {
    "errorCode": 131026,
    "errorTitle": "Message Undeliverable"
  }
}

Si requiere asistencia o tiene un problema, envienos un mensaje para poder ayudarlo

soporte@onurix.com