API de devolución de llamada de mensajes

Visión general

Los datos de "estado del mensaje" y "respuesta del mensaje" se devuelven mediante callback al sistema empresarial de la empresa, y esta información se puede utilizar para realizar acciones como estadísticas y respuesta a usuarios.

Los callbacks de estado del mensaje y de mensajes entrantes de usuarios pueden incluir un identificador de usuario de ámbito empresarial (Business-Scoped User ID, BSUID) para identificar al usuario de WhatsApp correspondiente. El BSUID se devuelve mediante nuevos campos opcionales y no afecta a los campos ni a los eventos de callback existentes.

Dirección de callback

Las empresas deben configurar direcciones de callback para recibir el estado del mensaje y la respuesta del mensaje. Para obtener más información, consulte configuración de callback.

Formato de callback

El método de solicitud es POST, el cuerpo de la solicitud es JSON y el tipo de datos es "Content-Type: application/json"
Se devuelven varios registros de datos a la vez.

Mecanismo de seguridad

Próximamente. En la actualidad, el callback no contiene información de autenticación, por lo que no se debe configurar verificación de permisos para la API con la que el desarrollador recibe el callback.

Mecanismo de respuesta

Después de recibir el callback de Engagelab, el servicio del desarrollador debe responder en un plazo de 3 segundos de la siguiente manera:
recepción correcta: el código de estado de la respuesta HTTP debe devolver 200 y no se requiere ningún mensaje de respuesta.

Mecanismo de reintento

Próximamente.

Parámetros de solicitud

Los parámetros de solicitud de EngageLab a la dirección de callback del sistema empresarial son los siguientes:

Los parámetros de rows son los siguientes:

Campos BSUID

El BSUID se devuelve mediante los siguientes campos opcionales del payload de callback existente:

• Si el BSUID no está disponible, se omite el campo correspondiente. Los analizadores del cliente deben admitir que el campo no esté presente.
• Para mostrar tanto el número como el BSUID, utilice to junto con status_data.recipient_user_id en los callbacks de estado, o contact.wa_id junto con contact.user_id en los callbacks de mensajes entrantes.
• Los campos BSUID solo identifican usuarios en los callbacks. Actualmente, la API de envío no permite utilizar un BSUID como destinatario.

Estado del mensaje (status)

Parámetros de callback

Respuesta de message_status

status_data

recipient_user_id suele devolverse en los callbacks sent, delivered y read una vez que el BSUID del destinatario está disponible. Puede omitirse en estados de preprocesamiento o error, mensajes históricos o datos generados mediante flujos de procesamiento antiguos.

conversation

pricing

error_detail

loss

Ejemplo de callback

              
              {"total":1,"rows":[{"status":{"status_data":{"recipient_user_id":"ID.1234567890123456"}}}]}

            

Respuesta del mensaje

Parámetros de callback

event

response_data

contact

contact.wa_id conserva su significado original como campo de número, mientras que contact.user_id contiene el BSUID. Para identificar al usuario mediante el BSUID, lea contact.user_id; no trate from, to ni contact.wa_id como BSUID.

message

message_context

Ejemplo de callback

              
              {"total":1,"rows":[{"response":{"response_data":{"contact":{"wa_id":"6281000000000","user_id":"ID.1234567890123456"}}}}]}

            

Notificación de mensajes - Notification

Parámetros de callback

event

Ejemplo de callback

              
              {"total":1, 
  "rows":[{
  "server": "whatsapp", 
  "itime":1640707579,
  "notification":{
      "event":"insufficient_balance",
    "notification_data":{
      "whatsapp_business_account_id":"",
      "remain_balance": 5.1234,					
      "balance_threshold": 10
    }
  }
}]
}