Wechsel zu API v2-Dokumentation
Wechsel zu API v2
Wechsel zu API v2
Wechsel zu API v2
Token-basierte Authentifizierung für Ihre bestehende Integration
Ihre Integration ruft die SparkTG-API unter /api/v1 auf und sendet bei jeder Anfrage einen SparkTG-Benutzernamen und ein Passwort. Die API-Authentifizierung wird auf signierte API-Tokens umgestellt, die für dieselben Endpunkte unter /api/v2 verfügbar sind. Endpunkte, Parameter und Antworten bleiben gleich: Bei den meisten Integrationen ändern sich nur die Basis-URL und der Authorization-Header.
Warum zu v2 wechseln
API-Token erzeugen
- 1Öffnen Sie im SparkTG-Dashboard Admin → Settings → API Access Tokens.
- 2Wählen Sie unter Generate a new token, wo Sie das Einmalpasswort erhalten möchten (SMS, WhatsApp oder Email), und fordern Sie es an.
- 3Geben Sie das OTP ein, fügen Sie optional eine Bezeichnung hinzu (zum Beispiel den Namen Ihrer Integration) und erzeugen Sie das Token.
- 4Kopieren Sie das Token und bewahren Sie es sicher auf. Es wird nur einmal angezeigt und ist ein Jahr gültig.
Das Token erzeugt Ihr Service-Admin. Dieselbe Seite listet Ihre Tokens und ermöglicht das Widerrufen. Erzeugen Sie vor Ablauf eines Tokens ein neues und stellen Sie Ihre Integration darauf um.
Was sich ändert
Erfolgreiche Antworten und endpunktspezifische Fehler sind dieselben wie in v1. Jede v2-Anfrage wird für die Abrechnung der API-Nutzung erfasst.
Beispiele
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>'Ersetzen Sie <YOUR_TOKEN> durch Ihr API-Token
Token-Fehler
Das Token wird geprüft, bevor der Endpunkt läuft – jede v2-Anfrage kann diese Fehler liefern.
{"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"}v2-Endpunkte
Diese APIs sind schon heute über v2 verfügbar. Die übrigen SparkTG-APIs wechseln bald zu v2.
Anruf starten (v2)
Einen ausgehenden oder geplanten Anruf starten
Click to Call (v2)
Per OTP bestätigte Rückrufanfragen
Geplante Anrufe entfernen (v2)
Geplante Anrufe stornieren
Geplante Anrufe im Stapel erstellen (v2)
Bis zu 500 Anrufe in einer Anfrage planen
WhatsApp-Nachricht senden (v2)
Eine Nachricht aus Ihrem Service senden
Anrufdetails gesammelt abrufen (v2)
Anrufdatensätze für einen Zeitraum
Login-/Logout-Bericht (v2)
Login- und Logout-Zeiten der Agenten
Agenten auflisten (v2)
Alle Agenten des Services des Tokens
Einen Agenten aktualisieren (v2)
An- und Abmelden, Pausen und Profiländerungen
Effektive Pausen abrufen (v2)
Pausenstatus, die Agenten nutzen können, optional für einen Agenten
CDR-Bericht (v2)
Anrufdetaildatensätze für einen Zeitraum
Agent-Performance-Bericht (v2)
Anzahl der Anrufe pro Agent sowie Gesprächs-, Bearbeitungs-, Halte- und Annahmezeiten
Login-/Logout-Rohbericht (v2)
Login- und Pausen-Zeitleiste, eine Zeile pro Statussegment
Login-/Logout-Zusammenfassungsbericht (v2)
Leerlauf-, Gesprächs-, Pausen- und Logout-Dauer pro Agent
Services auflisten (v2)
Der Service des Tokens
LeadSquared-DID-Liste (v2)
DIDs für die LeadSquared-Integration
