SparkTG

Documentación de Obtener pausas efectivas (v2)

Obtener pausas efectivas (v2)

v2

Obtener pausas efectivas (v2)

Estados de pausa que pueden usar los agentes, opcionalmente para un agente

API v2v21 endpoint

Descripción general

Lista los estados de pausa que los agentes pueden usar en su servicio, por ejemplo para llenar el desplegable de estado de un agente en un CRM o CTI. "Efectivas" significa las pausas que los agentes pueden usar actualmente: las pausas predeterminadas que su administrador no ha desactivado, más las pausas personalizadas que haya activado. Las pausas desactivadas para todo el servicio no aparecen en la lista. La lista siempre corresponde al servicio del token. Envíe agent-id para ver además qué pausas ha ocultado un administrador para ese agente. No se factura.

Endpoints disponibles

GET/api/v2/effective-breaks

Parámetros clave

agent-id(Integer)

El ID del agente (el id que devuelve GET /api/v2/agents). Si lo envía, las pausas que un administrador ha ocultado para este agente vuelven con "disabled": true. Omítalo, o envíelo vacío, para obtener la lista del servicio sin indicadores por agente. El agente debe estar activo y pertenecer al servicio del token.

Escenarios de uso

Pausas de todo el servicio

Sin parámetros. Úselo cuando no tenga un agente concreto en mente, por ejemplo para mostrar nombres de pausas en un informe. Respuesta abreviada; un servicio típico tiene alrededor de una docena de pausas.

0 parámetrosDisponible en Ejemplos

Pausas de un agente

Envíe agent-id. Aquí un administrador ha ocultado Leave para el agente 319, así que vuelve con "disabled": true. La pausa sigue en la lista para que pueda mostrar su nombre y color; simplemente no deje que el agente la elija.

0 parámetrosDisponible en Ejemplos

Ejemplo rápido

Prueba esta API con un sencillo comando cURL

Llamada básica a la API
curl 'https://telephonycloud.co.in/api/v2/effective-breaks' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'
💡 Sustituye <YOUR_TOKEN> por tu token de API

Vista previa de la respuesta

Respuesta de ejemplo de esta API

Respuesta de ejemplo
[{"break_id":0,"label":"Available","icon":"available","color":"#5ccc56","is_system":true,"sort_order":1,"is_deleted":false,"category":"SYSTEM"},{"break_id":1,"label":"Meal","icon":"lunch","color":"#F4...
Consulta el formato completo de la respuesta en la sección Respuesta