¿Qué son las solicitudes API?
API es un método a través del cual un programa puede «negociar» con otro. Puedes pedirle a Oki-Toki que transfiera o reciba los datos necesarios. Por ejemplo, enviar automáticamente la información del cliente a tu CRM o cargar datos de vuelta en Oki-Toki.
¿Cuál es el beneficio de la API para centros de contacto?
- Automatización: La API asume tareas rutinarias. Por ejemplo, un nuevo contacto se envía a tu CRM, actualizando automáticamente los datos;
- Datos integración: con la ayuda de la API, es fácil vincular Oki-Toki con otros sistemas – CRM, análisis, chatbots, etc. Todas las herramientas trabajan juntas como un todo, lo que hace que los procesos comerciales sean más simples y rápidos.
- Datos en tiempo real: el sistema envía o recibe información tan pronto como aparece. Esto es conveniente para análisis, monitoreo;
- Escalabilidad fácil: puedes agregar nuevas funciones y herramientas sin cambios complejos. Esto es especialmente conveniente si tu proyecto está creciendo;
- Reducción del número de errores: menos trabajo manual — menor riesgo de cometer errores. Todo sucede automáticamente, rápidamente y con precisión.
Tipos de solicitudes API en Oki-Toki
Oki-Toki utiliza el método estándar de interacción con servicios web – API REST. El sistema recibe información a pedido y proporciona una respuesta en el formato deseado, más a menudo JSON. En Oki-Toki están disponibles los siguientes métodos API REST:
- GET – se usa para recuperar información, como los contactos del CRM o estadísticas de llamadas;
- POST – envía nuevos datos al sistema, como la adición masiva o eliminación de tareas del marcador, encendiendo/apagando el marcador.
Para probar una solicitud, verificar la corrección de los datos o encontrar un error, Postman es adecuado.
Documentación y configuración de API en Oki-Toki
Documentación de API de oki-toki es tu guía para trabajar, describiendo métodos de solicitud, ejemplos de uso y estructura de datos. Para comodidad, la documentación técnica de API está dividida en secciones basadas en las principales funciones y herramientas de Oki-Toki.
Acceso a API
El acceso a API se realiza utilizando tokens – estas son llaves que permiten al sistema entender quién está accediendo a él. Con ellos, es fácil trabajar con la API y transferir datos de forma segura.
En Oki-Toki, un usuario puede crear su token cuando tiene el derecho de «Gestionar usuarios» en su Rol. Tal derecho está disponible en roles predeterminados «Admin» y «Supervisor» , pero también puede agregarse a cualquier rol que crees.
«Gestionar recursos externos, integraciones y eventos (Webhook)» es otro derecho necesario para trabajar con API. Sin él, crear una integración o agregar un Webhook no será posible.Aprende más sobre roles en un artículo separado en el blog.
¿Cómo obtener una clave API?
Para crear cualquier solicitud API, necesitas un token. Para generararlo, ve a la sección Lista de usuarios. Selecciona el elemento «Seguridad» en la configuración del perfil. Aquí puedes crear, ver o eliminar un token.
Códigos de error de solicitud API
Todos pueden cometer errores, incluso los profesionales encuentran dificultades en la transferencia de datos o la ejecución de tareas. Lo importante es saber cómo solucionarlo. Hemos preparado una lista de los errores más comunes al hacer una solicitud api:
- 401 (No Autorizado) – la solicitud especifica un objeto inexistente o tu token es incorrecto;
- 403 (Prohibido) – significa que el servidor entendió la solicitud pero se niega al acceso. Puede que no tengas los derechos y permisos para ejecutar esta solicitud;
- 404 (No Encontrado) – en el enlace URL hay errores, verifica la precisión de los datos ingresados;
- 405 Método No Permitido – tipo de solicitud incorrecto. Por ejemplo, intentaste usar el método POST en lugar de GET;
- 422 (Entidad No Procesable) – la solicitud es aceptada, pero no se procesó debido a un error semántico en el «cuerpo» de los datos;
- 429 Demasiadas Solicitudes – excediendo el límite de solicitudes;
- 500 (Error Interno del Servidor)– problemas con el funcionamiento del servidor o el procesamiento de tu solicitud.
Cada error de API viene acompañado por un código y un mensaje que ayudará a determinar la causa del problema y corregirlo.
Ejemplos de uso de API en Oki-Toki
La API de oki-toki es una herramienta para resolver muchas tareas en un call center. Aquí hay algunos ejemplos donde su uso puede ahorrar tiempo y simplificar procesos:
- Agregar clientes a un marcador para el post-procesamiento de llamadas entrantes/base fría – después de una conexión exitosa con un agente, los datos se transfieren automáticamente para su marcación posterior. Esto ahorra tiempo y reduce el riesgo de errores eliminando el procesamiento manual;
- Eliminar tareas de un marcador – tareas que han sido procesadas y ya no son relevantes porque los clientes han declinado serán eliminadas de la lista de marcadores;
- Transferir datos de llamada al CRM – todos los datos necesarios de la llamada necesarios para el trabajo posterior con el cliente se transferirán al CRM;
- Actualizar contacto en CRM – Por ejemplo, cambiando el estado de las tareas o agregando nuevos parámetros para análisis.
¿Cómo crear una solicitud API?
Para crear una solicitud para trabajar con datos en Oki-Toki, primero familiarízate con la documentación de API. Aquí se recopila información sobre qué datos pueden transferirse o recibirse. Elige la solicitud necesaria y ve qué información adicional puede ser necesaria, por ejemplo, ID del marcador.
Para encontrar estos datos, ve al marcador requerido. El ID se indicará en el enlace en la barra de direcciones del navegador — este es el número después del nombre de la herramienta.
Ejemplo de una solicitud API en Postman: añadiendo a la lista negra
Formularemos un enlace de solicitud en el programa Postman, que deberá estar instalado en tu dispositivo. Encontramos en la Documentación la sección «Listas», seleccionamos la solicitud » Añadiendo un valor a una lista» .
La solicitud agrega datos a tus Listas. No necesariamente tiene que ser la «Lista Negra», tal vez quieras complementar la «lista de clientes VIP» o cualquier otra que se adapte a tus procesos comerciales.
Procedemos a formular el enlace API:
- busca en la documentación el tipo de solicitud – en nuestro caso, es post y copia el enlace URL https://home.oki-toki.net/api/v1/lists/add. Ve a Postman, establece el tipo e inserta el enlace.
- el siguiente paso – tu token. Cómo generar un token lo describimos arriba en el artículo;
- en la solicitud, es necesario especificar el parámetro ID de la lista. Para hacerlo, ve a la sección Listas, encuentra la requerida, copia el número de la barra de direcciones y transfiérelo a Postman.
- El parámetro “valores” necesita ser complementado con los datos que terminarán en la lista, por ejemplo, un número de teléfono;
Después de ingresar todos los parámetros, formulamos un enlace en esta forma: https://home.oki-toki.net/api/v1/lists/add?api_token=(TU TOKEN)list_id=101&values=(NÚMERO DE TELÉFONO)Generamos una solicitud, si todo está correcto recibimos una respuesta – 200 OK. Ahora el número requerido se añade a la lista negra.
Para configurar diferentes condiciones para que se activen las solicitudes, utiliza eventos. Estos permiten no solo transmitir datos sobre llamadas y clientes, sino también información sobre infracciones, estados de usuario y el desencadenamiento de análisis de voz. Esto permite monitorear indicadores clave de desempeño de agentes, su actividad, registrar desviaciones de scripts o infracciones disciplinarias para mantener un alto nivel de calidad de servicio.
¿Cómo configurar la integración API?
Si necesitas conectar oki-toki con un recurso externo, la integración API puede ayudar. Por ejemplo, transferir datos del cliente o añadir un número al marcador se puede automatizar a través de la API. La configuración consta de dos etapas:
Etapa 1. Creación de un webhook
Primero, necesitas crear un webhook en la sección Recursos externos:
- Especificar el nombre;
- En la línea de URL, transferir el enlace, dependiendo de la tarea en cuestión. Por ejemplo, para añadir una tarea al marcador, necesitas encontrar la solicitud de API «Añadir una tarea (número) a una llamada» en la documentación técnica, copiar el enlace y pegarlo en la línea de URL;
- Elige el método de transferencia de datos de la lista: GET, POST, JSON;
- En la línea «Parámetros comunes de solicitud», introduce tu clave de acceso en el formato: api_token=TU TOKEN.
El ejemplo muestra cómo crear un webhook para automatizar tareas dentro de Oki-Toki. Si la línea URL especifica un enlace a un sistema externo, entonces Oki-Toki se integrará con él. Lee cómo integrar un chatbot con Telegram en nuestro blog.
Etapa 2. Creación de un evento
Ve a la sección Eventos e Integraciones y crea una nueva vinculación.
- Indica el nombre y tipo de evento (acciones del usuario, llamadas, infracciones);
- Integración externa – selecciona de la lista o añade un nuevo recurso externo;
- Condiciones del disparador – establece un disparador para que ocurra el evento. La lista de condiciones depende del tipo de evento;
- Parámetros de acción – esta línea debe contener datos para detallar la solicitud. Los parámetros disponibles que pueden usarse en la solicitud se indican en la documentación;
- Variables se enumeran. Al hacer clic en la necesaria se copiará para llenar en parámetros de acción.
Reportes y costos por solicitudes API
Puedes monitorear cómo se ejecutan las solicitudes usando registro de llamadas API. El informe se genera por fecha, usuarios, duración de ejecución y tipo de solicitud – selecciona API. El informe listo contiene información sobre la fecha, hora, duración y el nombre del usuario que creó la solicitud, así como la URL y los parámetros de la solicitud. La exportación está disponible en formatos HTML, Google Sheets y Microsoft Excel.
En el registro de eventos encontrarás información sobre cuáles eventos fueron procesados y con qué resultado. El informe contiene el nombre, tipo de evento, integración, fecha de creación y procesamiento, estado actual (exitoso, no exitoso o pendiente), así como datos involucrados en la creación de eventos e integraciones usando API.
Las solicitudes API son una característica de pago, puedes encontrar información sobre el costo en la sección Gestión de Servicios. Puedes rastrear convenientemente tus débitos diarios en el Registro de Saldo.
Siguiendo esta guía y utilizando la documentación de Oki-Toki, puedes configurar la transferencia de datos y solicitudes API. Las integraciones y webhooks de Oki-Toki resolverán la mayoría de las tareas prácticas de manera rápida, eficiente y sin esfuerzo extra. Esto optimizará muchos de los procesos comerciales de tu empresa y te permitirá enfocarte en lo principal: el trabajo de calidad con los clientes.
