Enviar Templates de Whatsapp

Aquí encontrarás información de cómo realizar envíos de mensajes de tipo plantilla de WhatsApp Business a usuarios específicos, estos envíos son de uno en uno.

Endpoint de envio de templates

https://api.b2chat.io/broadcast

Envio de templates

POST https://api.b2chat.io/broadcast

Este servicio te permitirá enviar una notificacion de WhatsApp a un contacto.

Headers

NameTypeDescription

Content-Type*

application/json

Authorization*

Bearer {{token}}

Request Body

NameTypeDescription

from *

Numero movil

Número valido y operativo de una cuenta de WhatsApp Business, el formato debe ser +<codigo del país><movil del usuario> Por ejemplo +57300274206.

to *

Numero movil

Número valido y operativo de una WhatsApp account

template_name*

String

Nombre del template configurado previamente en B2Chat.

contact_name

String

Nombre del contacto al que se le enviará el template

campaign_name

String

Se utiliza para agrupar el envío de plantillas.

header_url

URL jpg/png/ pdf

URL de una imagen (jpg, png) , o pdf dependiendo de la configuración de la plantilla que vayas a enviar. Asegúrate de enviar la url correcta con el tipo de contenido esperado.

button_url_suffix

String

Cuando la plantilla configurada contiene un botón dentro de una url, un fragmento de esta puede ser variable por ejemplo:

https://www.merriam-webster.com/dictionary/${button_url_suffix} El fragmento será sustituido por el valor enviado. Si envía la palabra template como valor para button_url_suffix la url se enviará como https://www.merriam-webster.com/dictionary/template

values

Array

Array de valores de plantilla en el mismo orden registrado en las variables de template registrado en B2Chat.

broadcast_target

JSON

Este campo permite direccionar la respuesta al template por parte del contacto a un departamento configurado en B2Chat o un agente en específico, debe tener dos campos:

*target: puede tener dos valores, AGENT o DEPARTAMENT

*target_id: debe incluir el ID del departamento o agente a donde deseas redirigir la respuesta del contacto. Para conocer estos IDs, ya sean de departamentos o agentes solicitalos directamente al equipo de soporte.

Ejemplo 1: Enviar template de solo texto plano

curl --location --request POST 'https://api.b2chat.io/broadcast' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
	"from":"+57300xxxxxxx",
	"to":"+57300xxxxxxx",
	"template_name":"christmas_evening",
	"contact_name":"Mark",	
	"campaign_name":"christmas campaign",
	"values": []
}'

Ejemplo 2: Enviar template con texto que incluye variables

curl --location --request POST 'https://api.b2chat.io/broadcast' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
	"from":"+57300xxxxxxx",
	"to":"+57300xxxxxxx",
	"template_name":"christmas_evening",
	"contact_name":"Mark",	
	"campaign_name":"christmas campaign",
	"values": ["Agent John","Contact Mark"]
}'

Ejemplo 3: Enviar template con texto con variables e imagen en el encabezado.

curl --location --request POST 'https://api.b2chat.io/broadcast' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
	"from":"+57300xxxxxxx",
	"to":"+57300xxxxxxx",
	"template_name":"christmas_evening",
	"contact_name":"Mark",	
	"campaign_name":"christmas campaign",
  	"header_url": "http://www.africau.edu/images/default/sample.pdf",
	"values": ["Agent John","Contact Mark"]
}'

Ejemplo 4: Enviar template con texto con variables, imagen en el encabezado y boton de tipo URL con sufijo.

curl --location --request POST 'https://api.b2chat.io/broadcast' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
	"from":"+57300xxxxxxx",
	"to":"+57300xxxxxxx",
	"template_name":"christmas_evening",
	"contact_name":"Mark",	
	"campaign_name":"christmas campaign",
  	"header_url": "http://www.africau.edu/images/default/sample.pdf",
  	"button_url_suffix": "template",
	"values": ["Agent John","Contact Mark"]
}'

Ejemplo 5: Enviar template de solo texto plano con redirección en la respuesta a un agente.

curl --location --request POST 'https://api.b2chat.io/broadcast' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
	"from":"+57300xxxxxxx",
	"to":"+57300xxxxxxx",
	"template_name":"christmas_evening",
	"contact_name":"Mark",	
	"campaign_name":"christmas campaign",
	"values": ["Agent John","Contact Mark"],
	
}'

Last updated