Documentación de Pasar a la API v2
Pasar a la API v2
Pasar a la API v2
Pasar a la API v2
Autenticación con tokens para tu integración actual
Tu integración llama a la API de SparkTG en /api/v1 enviando un usuario y una contraseña de SparkTG en cada solicitud. La autenticación de la API pasa a tokens de API firmados, disponibles para los mismos endpoints en /api/v2. Los endpoints, parámetros y respuestas no cambian: en la mayoría de las integraciones solo cambian la URL base y la cabecera Authorization.
Por qué pasar a v2
Generar un token de API
- 1Abre Admin → Settings → API Access Tokens en el panel de SparkTG.
- 2En Generate a new token, elige dónde recibir la contraseña de un solo uso (SMS, WhatsApp o Email) y solicítala.
- 3Introduce el OTP, añade una etiqueta si quieres (por ejemplo, el nombre de tu integración) y genera el token.
- 4Copia el token y guárdalo de forma segura. Solo se muestra una vez y es válido durante un año.
El token lo genera el administrador de tu servicio. En esa misma pantalla aparecen tus tokens y puedes revocar cualquiera. Antes de que un token caduque, genera uno nuevo y cambia tu integración a él.
Qué cambia
Las respuestas correctas y los errores propios de cada endpoint son los mismos que en v1. Cada solicitud v2 se registra para facturar el uso de la API.
Ejemplos
curl -u '<username>:<password>' \
'https://telephonycloud.co.in/api/v1/calls?service-id=<SERVICE_ID>&number=9XXXXXXXXX&agent-id=<AGENT_ID>'curl -H 'Authorization: Bearer <YOUR_TOKEN>' \
'https://telephonycloud.co.in/api/v2/calls?number=9XXXXXXXXX&agent-id=<AGENT_ID>'Sustituye <YOUR_TOKEN> por tu token de API
Errores del token
El token se comprueba antes de ejecutar el endpoint, así que cualquier solicitud v2 puede devolverlos.
{"status":"error","code":401,"message":"invalid or missing JWT"}{"status":"error","code":401,"message":"token revoked or unknown"}{"status":"error","code":403,"message":"service inactive (svcId=<id>)"}{"status":"error","code":403,"message":"svc-id does not match token's service"}Endpoints de v2
Estas API ya están disponibles en v2. El resto de las API de SparkTG pasará a la v2 pronto.
Hacer una llamada (v2)
Inicia una llamada saliente o programada
Click to call (v2)
Solicitudes de devolución de llamada verificadas por OTP
Eliminar llamadas programadas (v2)
Cancela llamadas programadas
Crear llamadas programadas en lote (v2)
Programa hasta 500 llamadas en una solicitud
Enviar un mensaje de WhatsApp (v2)
Envía un mensaje desde tu servicio
Obtener detalles de llamadas en bloque (v2)
Registros de llamadas de un intervalo de tiempo
Informe de inicio / cierre de sesión (v2)
Horas de inicio y cierre de sesión de los agentes
Listar agentes (v2)
Todos los agentes del servicio del token
Actualizar un agente (v2)
Inicio y cierre de sesión, pausas y cambios de perfil
Obtener pausas efectivas (v2)
Estados de pausa que pueden usar los agentes, opcionalmente para un agente
Informe CDR (v2)
Registros de detalle de llamadas para un intervalo de tiempo
Informe de rendimiento de agentes (v2)
Conteo de llamadas por agente y tiempos de conversación, gestión, espera y contestación
Informe sin procesar de login / logout (v2)
Cronología de login y pausas, una fila por segmento de estado
Informe resumen de login / logout (v2)
Duraciones de inactividad, conversación, pausa y logout por agente
Listar servicios (v2)
El servicio del token
Lista de DID de LeadSquared (v2)
DID para la integración con LeadSquared
