Dokumentation

Callback API

Die Callback API erlaubt die Integration eines Rückrufdienstes in Ihr Projekt. Die folgenden URLs stehen zur Verfügung:

Rückruf initiieren:

Eine Methode, um einen Rückruf zu initiieren. Dabei wird die HTTP-POST Methode verwendet.

POST	https://api.tenios.com/callback/init

Anfrageparameter:

access_key String Obligatorisch	Der Zugriffsschlüssel (Access Key) für die API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT/Allgemeine Einstellungen im Abschnitt API gefunden werden.
callback_config_id String Obligatorisch	Die ID der Rückruf-Konfiguration. Diesen Parameter finden Sie ebenfalls im Kundenportal auf der Callback Konfigurationsseite.
callback_number String Obligatorisch	Die Rückruf-Telefonnummer, die angerufen werden soll.
agent_announcement String Optional	Ein Text für eine Ansage die dem Agenten vorgelesen werden soll. Zur Sprachgenerierung wird ein Model verwendet, dass multiple Sprachen unterstützt. Die zur erkannten Spache passende Stimme wird automatisch gesetzt.
dtmf_key_to_trigger_customer_call String Optinal	Die DTMF-Taste die gedrückt werden soll, um den Anruf zu starten.
delay String Obligatorisch	Verzögerug in Sekunden, bevor der Anruf angewählt wird.

Beispiel für eine erfolgreiche Anfragen:

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "callback_config_id": "XXXXX-XXXX-XXXXXX",
   "callback_number": "+491234567890",
   "delay": 30
}

API Response:

HTTP Status Code: 200 (OK)

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "callback_config_id": "XXXXX-XXXX-XXXXXX",
   "callback_number": "+491234567890",
   "agent_announcement" : "Der Kunde Peter Müller wird jetzt angerufen, bitte drücken sie 1 um den Anruf zu starten",
   "dtmf_key_to_trigger_customer_call" : "1", 
   "delay": 30
}

API Response:

HTTP Status Code: 200 (OK)

{
   "id": 10
}

Beispiele für fehlerhafte Anfragen:

BAD_CREDENTIALS_1

Dieser Fehler wird zurückgegeben, wenn ein ungültiger access_key angegeben wurde.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "callback_config_id": "XXXXX-XXXX-XXXXXX",
   "callback_number": "+491234567890",
   "delay": 30
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "BAD_CREDENTIALS",
   "error_message": "Bad credentials",
   "fields": []
}

BAD_CREDENTIALS_2

Dieser Fehler wird zurückgegeben, wenn die callback_config_id falsch ist.

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "callback_config_id": "xxx-xxx-xxx",
   "callback_number": "+491234567890",
   "delay": 30
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "BAD_CREDENTIALS",
   "error_message": "Bad credentials",
   "fields": []
}

Status eines Rückrufs abfragen

Eine Methode, um den Status eines existierenden Rückrufs abzufragen.

POST	https://api.tenios.com/callback/status

access_key String Obligatorisch	Der Zugriffsschlüssel (Access Key) für die API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT /Allgemeine Einstellungen im Abschnitt API gefunden werden.
id String Obligatorisch	Die id der Callback Anfrage. Diese ID wird gesendet im Antwort-Body der zugehörigen Init Callback-Anfrage.

Der Rückruf kann die folgenden Status haben:

REQUESTED	Rückruf angefragt.
ACCEPTED	Rückrufanfrage akzeptiert.
CALLING_A	Teilnehmer A wird angerufen.
CALL_A_FAILED	Anruf von Teilnehmer A nicht erfolgreich.
CALLING_B	Teilnehmer B wird angerufen.
CALL_B_FAILED	Anruf von Teilnehmer B nicht erfolgreich.
CONNECTED	Anruf verbunden (zwischen Teilnehmer A und B).
DISCONNECTED	Anruf getrennt (nach erfolgreichem Anruf von A und B).

Beispiel für eine erfolgreiche Anfrage:

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "id": 10
}

API Response:

HTTP Status Code: 200 (OK)

{
   "status": "REQUESTED"
}

Beispiele für fehlerhafte Anfragen:

Dieser Code wird zurückgegeben, wenn der bereitgestellte access_key und die id nicht gefunden wurden.

Anfrage:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "id": "xxx"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "CALLBACK_NOT_FOUND",
   "error_message": "Callback id not found",
   "fields": [
      "id"
   ]
}