Documentación de Documentación de la API
Documentación de la API
Documentación de la API
Las API de SparkTG pasan a la v2
Estas páginas describen la API v1. Todas las API de SparkTG pasan a la API v2, con tokens de API firmados en lugar de usuario y contraseña: usa la v2 donde esté disponible.
Pasar a la API v2Documentación de la API
Referencia de la API de telefonía en la nube de SparkTG
API de telefonía en la nube de SparkTG
Introducción
SparkTG es un proveedor de servicios de telefonía en la nube. La telefonía en la nube es un servicio bajo demanda que ofrece funciones de telefonía robustas y confiables a las organizaciones que prestan productos y servicios.
Acceso por red: Las capacidades están disponibles a través de la red y se acceden mediante mecanismos estándar. Los usuarios pueden iniciar sesión desde cualquier lugar y controlar su servicio.
Agrupación de recursos: Los recursos de telecomunicaciones se agrupan para atender a varios clientes mediante un modelo multiinquilino, con recursos físicos y virtuales que se asignan y reasignan dinámicamente según la demanda. Esto reduce el costo de desarrollar un servicio de telefonía propio y permite pagar solo por los recursos que se utilizan.
Elasticidad: Los puertos de telefonía pueden aprovisionarse de forma rápida y elástica, en algunos casos de manera automática, para escalar hacia arriba con agilidad y liberarse rápidamente para escalar hacia abajo.
Servicio medido: El sistema en la nube controla y optimiza automáticamente el uso de recursos mediante una capacidad de medición, con un nivel de abstracción adecuado al tipo de servicio (por ejemplo, número de llamadas entrantes, de llamadas salientes y de llamadas spam). El uso de los recursos puede monitorearse, controlarse e informarse, lo que brinda transparencia tanto al proveedor como al consumidor del servicio. Con estos objetivos en mente, SparkTG introduce API para la mayoría de sus servicios, para que los clientes puedan probarlas e integrarlas fácilmente en sus aplicaciones (web, de escritorio o móviles).
Supuestos
Este documento está dirigido a desarrolladores y requiere conocimientos básicos de la plataforma de telefonía en la nube de SparkTG. SparkTG deberá aprovisionar con anticipación el servicio de API para cada cliente antes de que pueda usarlo en sus aplicaciones.
Envío de encabezados de autenticación básica: Contamos con API basadas en REST que utilizan autenticación básica. Usted debe enviar los encabezados de autenticación básica por su cuenta. Para ello, debe pasar una cadena con el formato username:password.
Telefonía en la nube
Servicio de telefonía bajo demanda que ofrece funciones robustas y fiables a las organizaciones. Accede a las capacidades a través de la red desde cualquier lugar.
Agrupación de recursos
Modelo multiinquilino con asignación dinámica de recursos. Paga solo por lo que usas y reduce los costos de desarrollo interno.
Elasticidad
Aprovisiona puertos de telefonía automáticamente y con rapidez para escalar, y libéralos al instante para reducir la escala según sea necesario.
Servicio medido
Control automático de recursos con capacidades de medición. Supervisa el uso con transparencia tanto para el proveedor como para el consumidor.
Autenticación básica
Utilizamos API basadas en REST con autenticación básica. Usted debe enviar los encabezados de autenticación básica por su cuenta. Para ello, debe pasar una cadena con el formato username:password.
Formato de autenticación:
username:passwordEnvíalo en el encabezado Authorization o usa la opción curl -u
Requisitos para desarrolladores
• Se requieren conocimientos básicos de la plataforma de telefonía en la nube de SparkTG
• SparkTG debe aprovisionar el servicio de API con antelación para cada cliente
• APIs basadas en REST con compatibilidad con autenticación básica
• Compatible con aplicaciones web, de escritorio y móviles
Primeros pasos
1. Solicita acceso a la API
Contacta con SparkTG para aprovisionar el servicio de API en tu cuenta de cliente.
2. Obtén las credenciales
Recibe tus credenciales username:password para la autenticación básica.
3. Elige las API
Elige entre gestión de llamadas, API de agentes, mensajería y más.
4. Integra
Usa los endpoints REST en tus aplicaciones web, de escritorio o móviles.
Categorías de API disponibles
Gestión de agentes
Inicio de sesión, estado, descansos y configuración de agentes
Gestión de llamadas
Realizar llamadas, transferencias, programación y control de llamadas
Mensajería y OTP
Servicios de SMS y verificación OTP
Analítica
Historial de llamadas, informes y datos del panel
Eventos en tiempo real
Eventos WebSocket e integración de webhooks
Configuración
Ajustes de transferencia y configuración del servicio
