Conexión HTTP

Last update: 4 days ago by Irais Aguirre

Todos los mensajes sin plantilla, con plantilla e interactivos se envían con este endpoint. Aquí se describen, una sola vez, la petición, los encabezados, los campos comunes del cuerpo y la respuesta. Los campos propios de cada tipo de mensaje están en su página.

Petición


URL	https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging
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
Msg-Priority	Prioridad del mensaje en la cola de envío. Los valores pueden ser: LOW MEDIUM HIGH Si se envía un valor distinto, se usa MEDIUM.	String	Opcional. El valor por defecto es MEDIUM.

Campos comunes

Todos los mensajes incluyen estos campos en el cuerpo de la petición:

Nombre	Descripción	Tipo	Requerimientos
from	Teléfono (con código de país) del que se enviará el mensaje.	String	Obligatorio.
to	Teléfono (con código de país) del cliente al que se le envía el mensaje. De 7 a 20 caracteres; el signo `+` solo se admite como primer carácter. También se admiten guiones (-), paréntesis ((,)) y espacios. Acepta además el BSUID del usuario, por ejemplo, US.13491208655302741918. La validación de formato de teléfono no aplica cuando `recipient_type` es `group`.	String	Obligatorio.
type	Tipo de mensaje. Los valores pueden ser: text image audio video document sticker location contacts reaction template interactive pin (solo en Grupos) Cada tipo de mensaje indica el valor que debe usar.	String	Obligatorio.
recipient_type	Tipo de destinatario. Los valores pueden ser `individual` o `group`. Consulta la sección de Grupos para más detalle.	String	Opcional. El valor por defecto es `individual`.

Campos de Marketing Messages Lite (MM Lite)

Estos campos aplican solo a los mensajes enviados desde WABAs con Marketing Messages Lite (MM Lite) habilitado. Se reenvían a Meta.

Nombre	Descripción	Tipo	Requerimientos
category	Categoría del mensaje, por ejemplo `UTILITY` o `MARKETING`. Es obligatoria para que `ttl_seconds` y `direct_send_config` surtan efecto.	String	Opcional.
ttl_seconds	Tiempo de vida del mensaje en segundos. Solo se aplica cuando se establece `category`. Se valida contra el mínimo y el máximo permitidos.	Integer	Opcional.
direct_send_config.template_name	Nombre de la plantilla usada para el envío directo de MM Lite. Solo se aplica cuando se establece `category`.	String	Opcional.
bid_spec.per_message_bid_multiplier	Multiplicador de puja por mensaje para los mensajes de marketing de MM Lite.	Number	Opcional.

Respuesta

Códigos de estado HTTP: 200 en caso de éxito, 400 ante errores de validación, 401 ante errores de autenticación y 500 ante errores internos.

Nombre	Descripción	Tipo
id	Identificador del mensaje enviado.	String
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

[
    {
        "id": "gBGHUhVUByKUHwIJCSIVo3YWvs8i"
    }
]

Ejemplo respuesta errónea

{
    "code": 3009,
    "detail": "JWT token expired"
}

Whatsapp — Anterior

Mensajería

Siguiente — Whatsapp

Mensajes sin plantilla