Aquí aprenderemos cómo utilizar la API de Botmaker para activar notificaciones de WhatsApp a través de una integración.

Lectura estimada: 10 minutos

¿Cómo obtener credenciales para acceder a la API?

Si no tiene credenciales de Botmaker API para su proyecto, deberá obtener un token de acceso siguiendo estos pasos:

• Acceda a Configuración>integraciones>API de Botmaker.
• Genera las credenciales o utiliza una ya generada.
• Introduzca el token de acceso en el header de su solicitud HTTP.

Cuando haga clic en Botmaker API Docs, será redirigido a Botmaker API swagger para conocer y probar todos los módulos API.

Plantillas de mensajes de WhatsApp

WhatsApp permite a las empresas enviar mensajes hasta 24 horas después del último mensaje enviado por el usuario. Fuera de este plazo, la empresa deberá utilizar plantillas de mensajes para retomar la conversación. Para enviar nuevos modelos para su aprobación, puede ir a Menú> Notifications Engine> Plantillas. Aquí puedes crearlos haciendo clic“+”" en la parte superior de la pantalla.

Para obtener información detallada sobre la creación de plantillas de WhatsApp, consulte nuestro artículo relacionado.¿Cómo crear plantillas de WhatsApp a través de Notifications Engine?

Una vez aprobada la plantilla (puedes comprobarlo en Menú> Notifications Engine> Plantillas), puedes activar esta plantilla a través de la API.

Envío de plantillas utilizando la API intent/v2 de Botmaker.

Campos API

• chatPlatform - siempre será “Whatsapp”;
• chatChannelNumber - corresponde al WhatsApp del que se originó la notificación, es decir, el WhatsApp de su empresa;
• platformContactId - corresponde al número de WhatsApp del destinatario, es decir, su nombre de usuario. No olvides incluir siempre el DDI y el DDD;
• ruleNameOrId - corresponde al nombre de su plantilla;
• parámetros - corresponde a las variables de su plantilla.

Ejemplo de llamada

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'access-token: token' -d '{ \ 

   "chatPlatform": "whatsapp", \ 

   "chatChannelNumber": "551132303506", \ 

   "platformContactId": "5511983812119", \ 

   "ruleNameOrId": "confirmacao_pedido", \ 

   "clientPayload": "string", \ 

   "params": {"nome":"Gabriel", "nroPedido":"11234", "totalPedido":"R$ 404,00", "nroBoleto":"1232131232131"} \ 

 }' 'https://go.botmaker.com/api/v1.0/intent/v2'

Si su plantilla contiene un encabezado multimedia, agregue los siguientes parámetros en parámetros:

Documento

• headerDocumentUrl: corresponde a una URL pública donde está alojado tu documento;
• headerDocumentCaption: corresponde al nombre del documento que será presentado al usuario.

Imagen

• headerImageUrl: corresponde a una URL pública donde está alojada tu imagen;

Video

• headerImageUrl: corresponde a una URL pública donde está alojado tu vídeo. Presta atención al límite de 16mb que impone WhatsApp.

Escrito por Equipo Botmaker

Actualizado el: 05/02/2024