¡Cómo funciona nuestra API!

Ariel

Última actualización hace 11 días

En este artículo, te explicaremos paso a paso el funcionamiento de nuestra API dentro de Whaticket, cómo generar un token de acceso y los diferentes métodos disponibles para enviar mensajes.

Aspectos clave sobre nuestra API

Antes de explicar el funcionamiento de nuestra API, hay tres puntos fundamentales que debes conocer:

● Nuestra API dentro de Whaticket solo permite el envío de mensajes.

● Para utilizar la API, se requieren conocimientos técnicos. Es recomendable contar con un profesional de TI con experiencia en el tema.

● Para enviar mensajes mediante la API, es necesario comprar créditos de campaña por separado.

1. Generación del Token de Acceso

Para poder realizar envíos a través de la API, sigue estos pasos:

  1. Accede a la opción "Tokens" dentro de la plataforma.

  1. Haz clic en el botón "Nuevo Token".

  2. Asigna un nombre al token y selecciona los permisos que deseas otorgarle.

  1. Copia el token generado y guárdalo, ya que lo necesitarás en los siguientes pasos.

     5. Ve al campo de ‘Documentación’, haz clic en el botón ‘Authorize’ y pega el código del toke
2. Autorización y Métodos de la API
Método GET - Obtención de Información

Este método permite obtener tres datos importantes:

● ID de conexión: Necesario para enviar mensajes.

● Nombre de conexión: Para identificar la conexión.

● Estado de conexión: Indica si está conectada o desconectada.

Método PATCH - Reconectar Conexión

Si la conexión se cae y deseas restablecerla sin escanear un nuevo código QR, sigue estos pasos:

Obtén el ID de conexión a través del método GET o desde la configuración de conexiones.

1. Haz clic en "Try it out".

2. Introduce el ID de conexión en el campo correspondiente.

3. Presiona "EXECUTE" para reconectar.
3. Enviar Mensajes con la API (Método POST)
Enviar un mensaje personalizado

1. Haz clic en ‘Try it out’.

2. Completa los campos con el ID de conexión, el número de contacto (incluyendo el código de país), el nombre del destinatario y el mensaje.

3. Haz clic en "EXECUTE" para enviar el mensaje.
3.2 Enviar mensajes masivos

Replica los pasos anteriores y usa la variable globalBody si deseas enviar el mismo mensaje a todos.

Convertir una imagen en mediaKey

Haz clic en ‘Try it out’ y selecciona la imagen desde tu computadora

Copia el código generado (mediaKey).

4. Enviar archivos multimedia a múltiples contactos

1. Autoriza Try It Out.

2. Ingresa el ID de la conexión que se utilizará para el envío masivo.

3. Pega el ID de la imagen generada en el paso anterior.

5. Enviar un mensaje y asignarlo a un usuario y departamento
Enviar un mensaje y asignarlo a un usuario y un departamento: En este paso, agregamos una nueva variable adicional, además de la variable presente en todos los pasos, que es "mensajes".La nueva variable se llama ticketData, y te permite elegir el STATUS del chat entre: open, closed o pending.
En los siguientes dos campos, debes ingresar el userId, que puedes encontrar en la sección de equipo dentro de tu usuario
El queueId, que corresponde al ID de tu departamento.
Por último, tenemos la variable Force, que solo admite dos valores: true o false. Déjala siempre en true si el contacto ya está creado y deseas actualizar la información con los nuevos ID.
¡Importante!

El límite máximo de peticiones es de 600 requests por minuto.

Si encuentras errores, revisa los pasos detalladamente.

¿Tienes dudas adicionales? No te preocupes, estamos aquí para ayudarte. Entra en contacto con nuestro equipo presionando el botón de "Soporte" ubicado en la parte inferior izquierda de nuestra plataforma o aquí para hacerlo desde WhatsApp.

¿Te ha sido útil el artículo?

A 10 de 25 les gusta este artículo