¿Cómo funciona nuestra API?
Ariel
Última actualización hace 3 meses
Antes de explicar cómo funciona nuestra API, hay TRES puntos que es muy importante aclarar:
¡El primer punto es que nuestra API dentro de Whaticket es solo para enviar mensajes!
La segunda es que usar la API necesita conocimientos técnicos, por lo que le recomendamos que tenga un profesional de TI que tenga una comprensión mínima del tema para ayudarlo.
Y la tercera es que para enviar estos mensajes a través de la API necesitas comprarlos por separado y tener créditos de campaña.
Ahora que esos dos puntos han sido aclarados, ¡vamos!
Te enseñaremos paso a paso cómo utilizar la API dentro de la plataforma by SWAGGER.
1.0 Debe generar un token de acceso para poder realizar envíos dentro de la API.
Para ello, debe hacer clic en TOKENS, allí encontrará un botón llamado NUEVO TOKEN.
1.1 Al hacer clic en él, aparecerá una pantalla, con un campo para que nombre el componente y seleccione los permisos que desea darle.
1.2 Copie el TOKEN generado y vaya al siguiente paso.
2.0 Ahora debes ir a la documentación, insertar el token generado dentro del candado y autorizar los permisos.
2.1 Hablemos del método GET. En su interior obtendrás 3 datos: El ID para poder enviar, el nombre de tu conexión para identificar y su estado (si está conectado o desconectado).
Dentro de cada modalidad se menciona la autorización que se debe otorgar.
Es bueno prestar atención al candado en la esquina superior izquierda, si está cerrado significa que su clave ha dado autorización está funcionando, pero recuerde siempre verificar si ha dado autorización para este método.
Después de eso, debe hacer clic en try it out y aparecerá un gran botón azul con EXECUTE, haga clic en él para que se publique la información. En caso de error, revise los pasos.
2.1.1 ¡Atención! Si no desea utilizar este método, también puede obtener el ID de conexión dentro de la propia conexión junto a la conexión de edición.
2.2 El siguiente método es el PATCH. Se usa en caso de que se caiga tu conexión y quieras reconectarte sin leer un nuevo código qr, necesitarás el ID generado en el primer método o tomado en el paso 2.1, primero debes hacer clic en try it out, luego de poner el ID en el lugar indicado.
3.0 El siguiente método es POST. Lo cual te ayudará a enviar los mensajes, tiene algunas plantillas diferentes, para el tipo de imagen que quieras enviar.
3.1 Envía un mensaje personalizado: Para enviar debes hacer clic en try it out y llenar los campos de valor con ID (te enseñamos cómo obtenerlo en el método 2.1) y dentro de la variable messages debes poner el contacto (recordando siempre ingresar el código del país), el nombre de este contacto y el mensaje personalizado que deseas enviar. ¡Después de hacer esto, haga clic en EXECUTE y su mensaje será enviado!
3.2 Envía varios mensajes: solo sigue los consejos del punto anterior, recordando siempre volver a poner el ID de conexión dentro del Example Value. Si quieres puedes enviar un mensaje personalizado a cada cliente, si no quieres puedes usar el globalBody que está dentro del propio código y enviar un mensaje igual a todos los clientes.
3.3 Carga de medios a múltiples contactos: antes de comenzar este paso, debe pasar a nuestro paso 4.0 para ver cómo carga (Upload) una imagen y la convierte en una clave de medios mediaKey, después de lo cual debe volver a ingresar la ID de conexión.
La mediaKey que obtuvo en el paso 4.0 es para cambiar los números a los que desea enviar esta imagen.
3.4 Enviar un mensaje y asignarlo a un usuario ya un departamento: Lo que cambiará dentro de este paso es que tenemos nuestra primera variable extra además de la variable que cuenta en todos los pasos que es 'mensajes'.
La nueva variable se llama ticketData, tu eliges el estado del chat entre: open, closed ou pending.
En los siguientes dos campos, debe colocar el userId que obtiene dentro de la parte del equipo en su usuario y el queueId que es la ID de su departamento, que obtiene dentro.
Ver imágenes con ejemplos a continuación.
Y por ultimo tenemos la Force esta tiene solo dos estados los cuales son: true o false. Déjalo siempre en verdadero en caso de que este contacto ya esté creado y quieras cambiar la información de los ID anteriores.
3.5 Envíe un mensaje y complete el contacto con información personalizada: como se muestra en nuestro último paso, este también tiene variables adicionales además de messages, tenemos 2 contactData que serían los datos de contacto como nombre y correo electrónico y en el La variable customFields sería la información adicional que desea poner en ese contacto, como el país de origen, el color favorito, un segundo correo electrónico, etc.
4.0 Cómo convertir tu imagen en una mediaKey. Después de ir a try it out debe ir al campo de elección de archivo, hacer clic en él y elegir y buscar la imagen deseada en su computadora. ¡Después de eso se generará un código! Simplemente copie el código entre comillas y péguelo dentro del paso 3.3.
Importante:Tenemos un número máximo de request por minuto, que es de 600 por minuto.
Espero que este artículo te ayude con tu duda. Si tienes más preguntas, no dudes en llamarnos haciendo clic en el botón "Soporte" en la plataforma, que se encuentra dentro de la misma. A través de este botón, te pondrás en contacto con nuestro equipo de Whaticket.🩵