🟢 Aspectos clave sobre la API de Whaticket
Antes de comenzar, es importante tener en cuenta algunos puntos fundamentales sobre el funcionamiento de la API.
▪️ La API de Whaticket está diseñada únicamente para el envío de mensajes.
▪️ Para utilizarla correctamente se requieren conocimientos técnicos.
▪️ Se recomienda contar con un profesional de tecnología de la información con experiencia en integraciones.
▪️ Para realizar envíos por medio de la API es necesario contar con créditos de campaña.
Estas consideraciones te ayudarán a comprender mejor el alcance de la herramienta antes de iniciar la configuración.
🟢 Cómo generar un token de acceso
Para poder utilizar la API, primero debes crear un token de acceso dentro de la plataforma.
1. Acceder a la sección de tokens
- Ingresa a tu cuenta de Whaticket.
- Dirígete a la opción Tokens.
2. Crear un nuevo token
- Haz clic en el botón Nuevo Token.
- Asigna un nombre al token.
- Selecciona los permisos que deseas otorgarle.
3. Guardar el token generado
- Copia el token generado.
- Guárdalo en un lugar seguro, ya que lo necesitarás para autorizar las solicitudes de la API.
4. Autorizar el uso del token en la documentación
- Dirígete al campo Documentación.
- Haz clic en el botón Authorize.
- Pega allí el token generado.
🟢 Métodos disponibles en la API
La API de Whaticket cuenta con distintos métodos para consultar información, reconectar conexiones y enviar mensajes.
🟢 Método GET para obtener información
El método GET permite consultar información clave de una conexión.
Con este método podrás obtener:
▪️ ID de la conexión
▪️ Nombre de la conexión
▪️ Estado de la conexión
Estos datos son necesarios para realizar otras acciones, como el envío de mensajes o la reconexión de una línea.
🟢 Método PATCH para reconectar una conexión
Si una conexión de WhatsApp se desconecta y deseas restablecerla sin escanear un nuevo código QR, puedes utilizar el método PATCH.
1. Obtener el identificador de la conexión
Antes de reconectar la línea, necesitas el ID de conexión.
Puedes encontrarlo:
▪️ Mediante el método GET
▪️ Desde la configuración de conexiones en Whaticket
2. Ejecutar la reconexión
- Haz clic en Try it out.
- Ingresa el ID de conexión en el campo correspondiente.
- Presiona Execute para reconectar la línea.
🟢 Método POST para enviar mensajes
El método POST permite enviar mensajes a uno o varios contactos.
1. Enviar un mensaje personalizado
Para enviar un mensaje individual:
- Haz clic en Try it out.
- Completa los campos con la siguiente información:
▪️ ID de conexión
▪️ Número del contacto con código de país
▪️ Nombre del destinatario
▪️ Mensaje - Haz clic en Execute.
2. Enviar mensajes masivos
También puedes utilizar la API para enviar mensajes a múltiples contactos.
En este caso:
▪️ Repite los pasos del envío individual
▪️ Utiliza la variable globalBody si deseas enviar el mismo mensaje a todos los destinatarios
🟢 Cómo convertir una imagen en mediaKey
Si deseas enviar archivos multimedia, primero debes convertir la imagen en un mediaKey.
1. Generar el mediaKey
- Haz clic en Try it out.
- Selecciona la imagen desde tu computadora.
- Copia el código generado.
🟢 Cómo enviar archivos multimedia a múltiples contactos
Una vez generado el mediaKey, podrás utilizarlo para enviar archivos a varios contactos.
1. Completar los datos del envío
- Autoriza el uso de Try it out.
- Ingresa el ID de conexión que será utilizado para el envío.
- Pega el mediaKey generado previamente.
🟢 Cómo enviar un mensaje y asignarlo a un usuario y departamento
La API también permite enviar un mensaje y asignar automáticamente el chat a un usuario y a un departamento.
En este caso se utiliza una variable adicional llamada ticketData.
Esta variable permite definir el estado del chat.
Los valores disponibles son:
▪️ open
▪️ closed
▪️ pending
Además, deberás completar otros campos:
▪️ userId: corresponde al identificador del usuario, disponible en la sección Equipo
▪️ queueId: corresponde al identificador del departamento
También existe la variable force, que admite solo dos valores:
▪️ true
▪️ false
Se recomienda dejarla en true si el contacto ya existe y deseas actualizar la información con los nuevos identificadores.
🟢 Cómo configurar “Mantener conmigo” o “Mantener conmigo hasta”
La API ahora también permite configurar desde sistemas externos las opciones Mantener conmigo y Mantener conmigo hasta.
1. Mantener conmigo
Esta opción permite retener el chat de forma indefinida.
2. Mantener conmigo hasta
Esta opción permite retener el chat hasta una fecha específica.
Para ello, la API solo acepta el formato de fecha:
▪️ YYYY-MM-DD
Es importante tener en cuenta que la liberación se calcula según el momento exacto en que se activa la retención.
Por ejemplo:
▪️ Si activas la retención el día 9 a las 12:36
▪️ Y configuras como fecha final el día 11
▪️ El chat se liberará automáticamente el día 11 a las 12:36
3. Reglas de superposición
▪️ Si se envía una nueva fecha mediante la API, la fecha anterior será reemplazada.
▪️ Si se envía una solicitud sin fecha, la retención será interpretada como Mantener conmigo de forma indefinida.
🟢 Información importante sobre el límite de uso
La API de Whaticket tiene un límite máximo de uso para evitar sobrecargas.
▪️ El máximo permitido es de 600 solicitudes por minuto
Si encuentras errores durante el proceso, es recomendable revisar cuidadosamente cada uno de los pasos y validar que todos los campos estén completos correctamente.
¿Tienes dudas adicionales? No te preocupes, estamos aquí para ayudarte.
Entra en contacto con nuestro equipo presionando el botón de "Soporte" ubicado en el menú izquierdo de nuestra plataforma.
