Dokumentation
Voice-API Übersicht
Die Voice-API von TENIOS ermöglicht den Betrieb Ihrer eigenen Sprachapplikationen über gängige Web-Technologien (http(s) , REST) in der TENIOS Cloud Communications Plattform. Mit der TENIOS Voice API stehen Ihnen zahlreiche Funktionen zur Verfügung: Empfang von Anrufen, Generierung von abgehenden Anrufen, Verbinden von Anrufern, Sprachaufzeichnung , IVR- Menüs, SIP- Trunks, Chatbot-Telefonie (VBC), Spracherkennung (ASR) und Sprachsynthese (TTS).
Voraussetzungen für die Verbindung zur TENIOS VOICE API
- Die TENIOS Voice API wird nur über HTTPS bereitgestellt. Um den Datenschutz zu gewährleisten, wird unverschlüsseltes HTTP nicht unterstützt
- Die TENIOS Voice API unterstützt derzeit nur Verbindungen über TLS 1.2
- Um eine sichere Verbindung herzustellen, müssen Sie sicherstellen, dass die Vertrauenskette (Chain of trust) intakt ist.
Base URL
Alle URLs, auf die in der Dokumentation verwiesen wird, haben die folgende Basis:
| POST | https://api.tenios.com/ |
Authentifizierung
Alle Anfragen an die TENIOS-API werden unter Verwendung des access_key authentifiziert. Der Schlüssel finden Sie im Portal unter My Account/General Settings.
{
"access_key": "c0b93a5e-4ce0-4adb-940e-5079f2abbcb4"
}
Content-Type
Die TENIOS REST-API wird über HTTPS bereitgestellt. Grundsätzlich sind alle Anfragen HTTP-POST Anfragen. Alle POST Anfragen müssen ein gültiges Objekt gemäß der JSON Notation beinhalten und der Header Content-Type muss auf den Wert application/json gesetzt sein. Alle TENIOS API-Endpunkte geben eine Antwort im JSON-Format zurück und haben den Header Content-Type auf den Wert application/json gesetzt.
API Response
In der folgenden Tabelle ist aufgelistet mit welchen HTTP-Codes die API auf gültige bzw. ungültige Anfragen antwortet.
| Code | Nachricht | Anmerkungen |
|---|---|---|
| 200 | OK | Erfolgreiche Anfrage |
| 400 | Bad Request | Anfrage mit ungültigen Daten (z.B. fehlerhaftes JSON object, etc.) |
| 403 | Forbidden | Anfrage mit einem ungültigen access key |
| 404 | Not Found | Anfragen an unbekannte Methoden |
| 500 | Internal Server Error | Anfragen die aufgrund eines internen Fehlers in der TENIOS API fehlschlagen |
Datenformate
Datum & Zeitzone
Die TENIOS Voice API akzeptiert Datumsparameter im UTC Format. Die folgende Tabelle zeigt gültige Datumsformate die in einer Anfrage verwendet werden können:
| Format | Anmerkung |
|---|---|
| 2016-04-11T09:00:00.000Z | Datum ohne Zeitzone, UTC |
| 2016-04-11T09:00:00.000+10:00 | Datum mit Zeitzone |
| 2016-04-11T09:00:00.000-06:00 | Datum mit Zeitzone |
Der Server antwortet immer mit einem Datumsformat im UTC Format ohne Zeitzone:
2016-04-11T09:00:00.000Z
Wenn ein Datumsparameter ein ungültiges Datumsformat beinhaltet, antwortet der Server mit einem CDR_DATE_PARSE_ERROR Fehler.
Beispiel Anfrage:
{
"access_key": "c0b93a5e-4ce0-4adb-940e-5079f2abbcb4",
"start_date_from": "2015-05-01T00:00:00.001Z",
"start_date_to": "2016-09-02T00:00:00.001Z"
}Funktionen
Die TENIOS Voice API verfügt über die folgenden Funktionen. Klicken Sie auf einen Link, um weitere Informationen zur Interaktion mit der REST API zu lesen.