Introducción

Las APIs de wolkvox permiten conectar tu operación con sistemas externos para automatizar tareas, extraer datos o ejecutar acciones directamente desde tus propias aplicaciones.

Todas las APIs del ecosistema wolkvox siguen una estructura común basada en peticiones HTTPS seguras, autenticación por token y respuestas en formato JSON.

Cada API puede variar ligeramente según su función: algunas requieren más o menos parámetros en la URL, otras necesitan enviar información en el cuerpo de la solicitud (form-data o raw JSON), y el método de consumo puede ser GET, POST, PUT o DELETE.

Este artículo explica los elementos generales que debes conocer para consumir correctamente cualquier API de wolkvox.

Acceso a la lista de APIs disponibles

1. Ingresa al portal de desarrolladores de wolkvox: [Clic aquí]
2. En el menú lateral izquierdo, encontrarás agrupadas las APIs por categorías (Agent, Reportes, Tiempo Real, Campañas, Configuración, Facturación, WhasApp, Información, Quality Analyzer, Speech Analytics, Gamificación, Listenvox, etc.).
3. También puedes explorar y probar las APIs desde la colección oficial de Postman: [Clic aquí]
4. Allí encontrarás cada API con sus variables, parámetros, ejemplos de código y estructura de respuesta, listas para usar.

Elementos básicos de una API de wolkvox

Generar y usar el token de autenticación

1. Ingresa a wolkvox Manager.
   1. Haz clic en el ícono de Configuración (engranaje), ubicado en el menú superior derecho de la aplicación.
2. En la ventana emergente de "Configuración", navega y selecciona la pestaña principal de Integraciones.
3. Dentro de esta sección, haz clic en la sub-pestaña Tokens.
4. En el campo "Descripción del token", escribe un nombre o descripción clara que te permita identificar el uso del token. Este campo es obligatorio.
5. Presiona el botón “Adicionar token”.
6. Inmediatamente, el nuevo token se listará en la tabla inferior, mostrando el token mismo, su descripción, el conteo de uso del día y el límite total de consumo.
7. Copia el valor dando clic derecho sobre él y seleccionado la opción “Copiar Token” y añádelo en el encabezado de tu solicitud como:
   1. wolkvox-token: {{token}}
   2. Importante: un mismo token no puede ser usado simultáneamente en varias solicitudes. Espera la respuesta de una API antes de hacer la siguiente llamada.

Estructura general de una solicitud

Ejemplo de API en formato GET (solo URL)

API de tipo lectura, como “Agente tiempo por estado”:

GET https://wv01.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini=20250101000000&date_end=20250101235959

Header

wolkvox-token: {{token}}

Ejemplo de API en formato POST con form-data

API de tipo carga, como “Subir audio”:

POST https://wv01.wolkvox.com/api/v2/configuration.php?api=upload_audio

Header

wolkvox-token: {{token}}

Body (form-data)

Ejemplo en formato PUT con parámetros

API de tipo actualización, como “Iniciar campaña”:

PUT https://wv0001.wolkvox.com/api/v2/campaign.php?api=start&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}

Header

wolkvox-token: {{token}}

Interpretar la respuesta de la API

Cada página de API contiene la respectiva documentación de cada campo del response de la API.

Buenas prácticas de consumo

• Programa tus consumos en intervalos regulares (por ejemplo, cada 5 minutos).
• Mantén tus tokens seguros y evita compartirlos.
• Respeta los límites de consumo por API (60.000 registros por solicitud o 256 MB de resultado).
• No ejecutes consumos simultáneos con el mismo token.
• Usa entornos de prueba (Postman Workspace de wolkvox) antes de integrar en producción.