Indicadores de lectura y escritura

Last update: 4 days ago by Irais Aguirre

El servicio de indicadores de lectura y escritura marca los mensajes recibidos como leídos y muestra el indicador de "escribiendo…" en una conversación.

Resumen para integración
Endpoint: POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging/status
Token: de mensajería, en el encabezado Authorization: Bearer {{wa-msg-api-token}} (cómo generarlo)
Respuesta: ver la sección Respuesta de esta página

El servicio de indicadores de lectura y escritura permitirá:

Marcar un mensaje recibido como leído, usando el valor de message.id recibido en el webhook (ver Recepción de Notificaciones). Los mensajes anteriores también se marcarán como leídos.
Mostrar en la conversación el indicador de "escribiendo", con el fin de hacerle saber al usuario que su mensaje está siendo atendido.

Marcar como leído

Petición


URL	https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging/status
Método	POST
Tipo	application/json

Encabezados

Nombre	Descripción	Tipo	Requerimientos
Content-Type	application/json	String	Obligatorio
Authorization	Token de mensajería en el formato `Bearer {token}` (con un espacio). Consulta Generar Token de Autenticación.	String	Obligatorio
Accept	application/json	String	Opcional

Cuerpo

Campos de Marcar como leído:

Nombre	Descripción	Tipo	Requerimientos
from	Teléfono (con código de país) del que se enviará el mensaje.	String	Obligatorio.
messageId	Id del mensaje que se desea marcar como leído. Se marcarán como leídos los mensajes anteriores.	String	Obligatorio. El mensaje no debe de tener más de 30 días de recibido.
typingIndicator	Bandera que define si se mostrará o no el indicador de "escribiendo". El indicador se mostrará por 25 segundos a partir del envío de la petición y se puede usar las veces que se necesite. Cualquier valor distinto de `true`/`false` se rechaza con el código 1009 "Parameter value is not valid".	String	Opcional. El valor por defecto es false.

Ejemplo

Ejemplo completo de Marcar como leído (petición HTTP y cuerpo JSON):

Marcar como leído con indicador de escritura

curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging/status' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
    "from": "5215500000001",
    "messageId": "wamid.HBgTTVguM…TVEODhERDAwMDYxMTdEQ0MA",
    "typingIndicator": true
}'

Body:

{
    "from": "5215500000001",
    "messageId": "wamid.HBgTTVguM…TVEODhERDAwMDYxMTdEQ0MA",
    "typingIndicator": true
}

Respuesta

Respuesta de Marcar como leído:

Nombre	Descripción	Tipo
success	Indica que la petición se procesó correctamente.	Boolean
code	Código de respuesta en caso de error. Para mayor detalle, ver sección Códigos de Error	Number
detail	Mensaje descriptivo del código de respuesta recibido.	String

Ejemplo respuesta exitosa

{
    "success": true
}

Ejemplo respuesta errónea

{
    "code": 3010,
    "detail": "Invalid From Phone number"
}

Mensajes de grupos

Descarga de archivos