Síntoma / Necesidad

Configurar y utilizar el componente REST API dentro de los flujos de Wolkvox Studio para consumir APIs mediante métodos como GET, POST, PUT y DELETE.

Contexto / Escenarios

El componente REST API permite conectar aplicaciones entre sí a través del protocolo HTTP para compartir información y realizar tareas en tiempo real. Este componente es esencial para integraciones eficientes y escalables, y está disponible en todos los tipos de routing (Voice, Interaction, Chat, CRM + webhook) y Agent Scripting en Wolkvox Studio.

Respuesta (Solución / Recomendación)

El componente REST API de Wolkvox Studio permite consumir APIs mediante los siguientes métodos:

• Método PUT: Actualiza información de un recurso existente. Sobrescribe el recurso con la nueva información enviada en la solicitud.
• Método POST: Envía información al servidor, como archivos o datos de formularios.
• Método GET: Obtiene información de un recurso existente y devuelve una respuesta con los datos solicitados.
• Método DELETE: Elimina un recurso en el servidor.

Formatos del cuerpo de la solicitud (body):

1. form-data: Para enviar datos de formulario o incluir archivos adjuntos.
2. raw: Para enviar datos en formatos específicos como JSON, XML o texto plano.

Control de timeout:

El componente esperará una respuesta del API en un máximo de 60 segundos. Si este tiempo se excede, se devuelve un mensaje de error: “Error consuming www.apidelcliente.com”.

Límite de longitud del token de autorización:

El token de autorización no debe superar los 257 caracteres. Si lo hace:

1. Asigne el token como una variable en Wolkvox Studio.
2. Ejemplo: Authorization: '.$token
3. Calcule el valor de la variable previamente usando el componente “Computo de Variables”.

Esta práctica permite manejar tokens largos y garantiza el correcto funcionamiento del componente.

Ejemplo de uso:

Escenario: Realizar un cambio de estado auxiliar del agente (de Break/Capacitación/Pausa Activa a Ready).

1. Definir el API a utilizar:
   • Ejemplo: Cambiar estado del agente.

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?status={{status}}&api=change_status&agent_id={{agent_id}}

URL ejemplo:

https://wv0003.wolkvox.com/api/v2/agentbox.php?status=302&api=change_status&agent_id=12613

2. Configurar el componente REST API:
   • URL: La del API a utilizar.
   • Método: GET, POST, PUT o DELETE según el caso.
   • Headers: Incluir el token de autorización.
   • Cuerpo: Definir si es form-data o raw.
   • Timeout: Tiempo máximo de espera (por ejemplo, 300 segundos o 5 minutos).
3. Ejemplo de variable para almacenar el resultado:
   • Variables precedidas por el signo “$”.

Conclusión:

El componente REST API es una herramienta poderosa en Wolkvox Studio que permite realizar integraciones eficientes y personalizadas con otros sistemas, facilitando la automatización y la autogestión en los flujos de trabajo.