Mensajes de texto
Resumen para integración
- Endpoint:
POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging- Token: de mensajería, en el encabezado
Authorization: Bearer {{wa-msg-api-token}}(cómo generarlo)- Campos comunes:
from,to(teléfono o BSUID) ytype(detalle)- Valores de
typeen esta página:"text"- Respuesta: la misma para todos los mensajes (ver respuesta)
Mensajes de texto libre, con o sin vista previa de URL. Todos se envían con POST /v1/messaging; los encabezados, los campos comunes y la respuesta están en Conexión HTTP.
Texto
Envía un mensaje de texto. El campo type debe ser "text".
Cuerpo
Campos de Texto, además de los campos comunes:
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| text | Texto del mensaje | String |
|
Ejemplo
Ejemplo completo de Texto (petición HTTP y cuerpo JSON):
Petición HTTP
curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \-H 'Authorization: Bearer {{wa-msg-api-token}}' \-H 'Content-Type: application/json' \-d '{"from": "5215500000001","to": "5215500000002","type": "text","text": "~Texto tachado~ \n _Texto en cursivas_ \n *Texto en negritas* \n Emojis 😋"}'
Body
{"from": "5215500000001","to": "5215500000002","type": "text","text": "~Texto tachado~ \n _Texto en cursivas_ \n *Texto en negritas* \n Emojis 😋"}
Texto con vista previa de URL
Envía un mensaje de texto con una vista previa de la URL que contiene. El campo type debe ser "text".
Cuerpo
Campos de Texto con vista previa de URL, además de los campos comunes:
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| text | Texto del mensaje. | String |
|
| preview_url | true para mostrar la vista previa de la primera URL contenida en text. Por defecto false. | Boolean | Opcional. |
Ejemplo
Ejemplo completo de Texto con vista previa de URL (petición HTTP y cuerpo JSON):
Petición HTTP
curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \-H 'Authorization: Bearer {{wa-msg-api-token}}' \-H 'Content-Type: application/json' \-d '{"from": "5215500000001","to": "5215500000002","type": "text","text": "https://www.ejemplo.com","preview_url": true}'
Body
{"from": "5215500000001","to": "5215500000002","type": "text","text": "https://www.ejemplo.com","preview_url": true}
Texto con BSUID
Envía el mensaje al BSUID del usuario en el campo to. Consulta Nombres de usuario y BSUID.
Usa los mismos campos que Texto; el campo type debe ser "text".
Ejemplo
Ejemplo completo de Texto con BSUID (petición HTTP y cuerpo JSON):
Petición HTTP
curl --location 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \-H 'Authorization: Bearer {{wa-msg-api-token}}' \-H 'Content-Type: application/json' \-d '{"from": "5215500000001","to": "US.13491208655302741918","type": "text","text": "Hola"}'
