API Documentation Documentation
API Documentation
API Documentation
SparkTG APIs are moving to v2
These pages describe API v1. All SparkTG APIs are moving to API v2, with signed API tokens instead of a username and password: use v2 wherever it's available.
Moving to API v2API Documentation
SparkTG Cloud Telephony API Reference
SparkTG Cloud Telephony API
Introduction
SparkTG is a Cloud Telephony service provider. Cloud Telephony is an on-demand service to provide the robust telephony features, reliably to organisations providing products and services.
Network Access: Capabilities are available over the network and accessed through standard mechanisms. Consumers should be able to login from anywhere and control their service.
Resource Pooling: The telecom resources are pooled to serve multiple consumers using a multi-tenant model, with different physical and virtual resources dynamically assigned and reassigned according to consumer demand. This reduces consumer's cost of developing in-house telephony service and they pay only for the resource they use.
Elasticity: Telephony Ports can be rapidly and elastically provisioned, in some cases automatically, to quickly scale out and rapidly released to quickly scale in.
Measured Service: Cloud system automatically control and optimize resource use by leveraging a metering capability at some level of abstraction appropriate to the type of service (e.g., number of inbound calls, number of outbound calls, and number of spam calls). Resource usage can be monitored, controlled, and reported providing transparency for both the provider and consumer of the utilized service. With these objectives in perspective, Spark TG is introducing APIs for most of its services for customer to easily test and integrate them with their applications (web or desktop or mobile).
Assumptions
This document is intended for the developers and requires basic knowledge of Spark TG Cloud Telephony platform. Spark TG will need to provision API service in advance for each customer before they can use it in their applications.
Supplying Basic Auth Headers: We have REST based API's in which we use basic authentication. You have to send basic auth headers yourself. To do this you have to pass a string of the form username:password.
Cloud Telephony
On-demand telephony service providing robust features reliably to organizations. Access capabilities over the network from anywhere.
Resource Pooling
Multi-tenant model with dynamic resource allocation. Pay only for what you use, reducing in-house development costs.
Elasticity
Rapidly provision telephony ports automatically to scale out, and release quickly to scale in as needed.
Measured Service
Automatic resource control with metering capabilities. Monitor usage with transparency for both provider and consumer.
Basic Authentication
We have REST based API's in which we use basic authentication. You have to send basic auth headers yourself. To do this you have to pass a string of the form username:password.
Authentication Format:
username:passwordPass this in the Authorization header or use curl -u flag
Developer Requirements
• Basic knowledge of SparkTG Cloud Telephony platform required
• SparkTG must provision API service in advance for each customer
• REST-based APIs with basic authentication support
• Compatible with web, desktop, and mobile applications
Getting Started
1. Request API Access
Contact SparkTG to provision API service for your customer account.
2. Get Credentials
Receive your username:password credentials for basic authentication.
3. Choose APIs
Select from call management, agent APIs, messaging, and more.
4. Integrate
Use REST endpoints in your web, desktop, or mobile applications.
Available API Categories
Agent Management
Login, status, breaks, and agent configuration
Call Management
Make calls, transfers, scheduling, and call control
Messaging & OTP
SMS and OTP verification services
Analytics
Call history, reports, and dashboard data
Real-time Events
WebSocket events and webhook integration
Configuration
Transfer settings and service configuration
