API-Dokumentation-Dokumentation
API-Dokumentation
API-Dokumentation
Die SparkTG-APIs wechseln zu v2
Diese Seiten beschreiben API v1. Alle SparkTG-APIs wechseln zu API v2 – mit signierten API-Tokens statt Benutzername und Passwort: Nutzen Sie v2, wo immer sie verfügbar ist.
Wechsel zu API v2API-Dokumentation
Referenz der SparkTG-Cloud-Telefonie-API
SparkTG Cloud-Telefonie-API
Einführung
SparkTG ist ein Anbieter von Cloud-Telefonie-Diensten. Cloud-Telefonie ist ein On-Demand-Service, der Organisationen, die Produkte und Dienstleistungen anbieten, leistungsstarke und zuverlässige Telefoniefunktionen bereitstellt.
Netzwerkzugriff: Die Funktionen sind über das Netzwerk verfügbar und werden über Standardmechanismen genutzt. Nutzer können sich von überall anmelden und ihren Dienst steuern.
Ressourcen-Pooling: Die Telekommunikationsressourcen werden in einem Multi-Tenant-Modell gebündelt, um mehrere Kunden zu bedienen. Physische und virtuelle Ressourcen werden dabei je nach Bedarf dynamisch zugewiesen und neu zugewiesen. Dies senkt die Kosten für den Aufbau eines eigenen Telefoniedienstes und ermöglicht es, nur für die tatsächlich genutzten Ressourcen zu zahlen.
Elastizität: Telefonieports können schnell und elastisch, teilweise automatisch, bereitgestellt werden, um rasch nach oben zu skalieren, und ebenso schnell wieder freigegeben werden, um nach unten zu skalieren.
Nutzungsbasierte Abrechnung: Das Cloud-System steuert und optimiert die Ressourcennutzung automatisch über eine Messfunktion mit einem für die jeweilige Serviceart passenden Abstraktionsgrad (z. B. Anzahl eingehender Anrufe, ausgehender Anrufe und Spam-Anrufe). Die Ressourcennutzung kann überwacht, gesteuert und berichtet werden, was sowohl dem Anbieter als auch dem Nutzer des Dienstes Transparenz bietet. Vor diesem Hintergrund stellt SparkTG für die meisten seiner Dienste APIs bereit, damit Kunden sie einfach testen und in ihre Anwendungen (Web, Desktop oder mobil) integrieren können.
Voraussetzungen
Dieses Dokument richtet sich an Entwickler und setzt grundlegende Kenntnisse der SparkTG-Cloud-Telefonie-Plattform voraus. SparkTG muss den API-Dienst für jeden Kunden im Voraus bereitstellen, bevor dieser ihn in seinen Anwendungen nutzen kann.
Senden von Basic-Authentication-Headern: Wir bieten REST-basierte APIs mit Basic Authentication. Die Basic-Authentication-Header müssen Sie selbst senden. Übergeben Sie dazu eine Zeichenfolge im Format username:password.
Cloud-Telefonie
Telefoniedienst auf Abruf, der Organisationen zuverlässig leistungsstarke Funktionen bereitstellt. Zugriff auf alle Funktionen über das Netzwerk von überall.
Ressourcen-Pooling
Mandantenfähiges Modell mit dynamischer Ressourcenzuweisung. Sie zahlen nur für das, was Sie nutzen, und senken so Ihre Entwicklungskosten im eigenen Haus.
Elastizität
Telefonieanschlüsse werden automatisch und schnell bereitgestellt, um zu skalieren, und bei Bedarf rasch wieder freigegeben.
Gemessener Dienst
Automatische Ressourcensteuerung mit Messfunktionen. Die Nutzung wird für Anbieter und Nutzer transparent überwacht.
Basic-Authentifizierung
Wir verwenden REST-basierte APIs mit Basic Authentication. Die Basic-Authentication-Header müssen Sie selbst senden. Übergeben Sie dazu eine Zeichenfolge im Format username:password.
Authentifizierungsformat:
username:passwordÜbergeben Sie dies im Authorization-Header oder verwenden Sie die curl-Option -u
Anforderungen an Entwickler
• Grundkenntnisse der SparkTG Cloud-Telefonie-Plattform erforderlich
• SparkTG muss den API-Dienst für jeden Kunden im Voraus bereitstellen
• REST-basierte APIs mit Unterstützung für Basic-Authentifizierung
• Kompatibel mit Web-, Desktop- und mobilen Anwendungen
Erste Schritte
1. API-Zugang anfordern
Kontaktieren Sie SparkTG, um den API-Dienst für Ihr Kundenkonto bereitstellen zu lassen.
2. Zugangsdaten erhalten
Sie erhalten Ihre Zugangsdaten im Format Benutzername:Passwort für die Basic-Authentifizierung.
3. APIs auswählen
Wählen Sie aus Anrufverwaltung, Agenten-APIs, Messaging und mehr.
4. Integrieren
Nutzen Sie REST-Endpunkte in Ihren Web-, Desktop- oder mobilen Anwendungen.
Verfügbare API-Kategorien
Agentenverwaltung
Anmeldung, Status, Pausen und Agentenkonfiguration
Anrufverwaltung
Anrufe tätigen, Weiterleitungen, Terminplanung und Anrufsteuerung
Messaging & OTP
SMS- und OTP-Verifizierungsdienste
Analysen
Anrufverlauf, Berichte und Dashboard-Daten
Echtzeit-Ereignisse
WebSocket-Ereignisse und Webhook-Integration
Konfiguration
Weiterleitungseinstellungen und Dienstkonfiguration
