Dokumentation

Call Recording API

Die Call Recording API erlaubt es Aufzeichnungen von laufenden Anrufen flexibel zu starten und zu stoppen. Es ist möglich eine Aufnahme bei dem selben Anruf mehrmals zu starten und zu stoppen. Somit können bestimmte Abschnitte eines Anrufs aufgezeichnet werden. Die Audio-Files werden an den SFTP-Server des Kunden übertragen. siehe: www.tenios.de/doc/recordings

Aufzeichnung eines Anrufs starten:

Diese Methode startet die Aufzeichnung des Anrufs mit der angegebenen call_uuid.

POST	https://api.tenios.com/record-call/start

Anfrageparameter:

access_key String	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.
call_uuid String	Die uuid des Anrufs der aufgezeichnet werden soll.
record_caller String	Ein boolscher Wert der angibt ob der Sprachkanal des Anrufers aufgezeichnet werden soll. Optional. Default: true
record_callee String	Ein boolscher Wert der angibt ob der Sprachkanal des Angerufenen aufgezeichnet werden soll. Optional. Default: true

Beispiel für eine erfolgreiche Anfrage:

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "e3163745-1fbe-4b28-bf58-6e6030ca8ace"
}

API Response:

HTTP Status Code: 200 (OK)

{
   "recording_uuid": "8101fcb3-3843-4db3-9829-f7ab586625fe"
}

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "1f9ff5f2-06a6-4d71-bc6a-3dd32b36f84f",
   "record_caller": false,
   "record_callee": true
   
}

API Response:

HTTP Status Code: 200 (OK)

{
   "recording_uuid": "f57135d7-2e5c-44dd-bd82-bc1693596260"
}

Beispiele für fehlerhafte Anfragen:

INVALID_VALUE

Dieser Fehler wird zurückgegeben wenn eine falsche oder ungültige call_uuid angegeben wurde.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "a"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_VALUE",
   "error_message": "Invalid parameter type or format",
   "fields": [
      "call_uuid" 
	 ] 
}

Aufzeichnung eines Anrufs stoppen:

Stoppt die Aufzeichnung des Anrufs mit der angegebenen call_uuid.

POST	https://api.tenios.com/record-call/stop

Anfrageparameter:

access_key String	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.
recording_uuid String	Die uuid der Aufzeichnung, die gestoppt werden soll.

Beispiel für eine erfolgreiche Anfrage:

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "e3163745-1fbe-4b28-bf58-6e6030ca8ace",
   "recording_uuid": "1f92df20-f643-4105-bdbf-104c98aba611"
}

API Response:

HTTP Status Code: 200 (OK)

{
   "success": "true"
}

Beispiele für fehlerhafte Anfragen:

INVALID_VALUE

Dieser Fehler wird zurückgegeben, wenn eine falsche oder ungültige recording_uuid angegeben wurde.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "e3163745-1fbe-4b28-bf58-6e6030ca8ace",
   "recording_uuid": "a"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_VALUE",
   "error_message": "Invalid parameter type or format",
   "fields": [
      "recording_uuid"
   ]
}

RECORDINGS_LIMIT_EXCEEDED

Dieser Fehler wird zurückgegeben, wenn zu viele Aufnahmen mit der gleichen recording_uuid gestartet wurden.

{
   "error_code": "RECORDINGS_LIMIT_EXCEEDED",
   "error_message": "Recordings limit exceeded.",
   "fields": []
}

Aufzeichnung eines Anrufs abrufen:

Ruft die Aufzeichnung des Anrufs mit der angegebenen call_uuid ab.

POST	https://api.tenios.com/record-call/retrieve

Anfrageparameter:

access_key String	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.
recording_uuid String	Die uuid der Aufzeichnung, die abgerufen werden soll.

Beispiel für eine erfolgreiche Anfrage:

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "recording_uuid": "1f92df20-f643-4105-bdbf-104c98aba611"
}

API Response:

HTTP Status Code: 200 (OK)

Die Antwort ist ein Octet-Stream mit dem Content-Type application/octet-stream; charset=UTF-8

Beispiele für fehlerhafte Anfragen:

INVALID_VALUE

Dieser Fehler wird zurückgegeben, wenn eine falsche oder ungültige recording_uuid angegeben wurde.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX", 
   "recording_uuid": "a"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_VALUE",
   "error_message": "Invalid parameter type or format",
   "fields": [
      "recording_uuid"
   ]
}

Wenn die Aufzeichnungs-UUID syntaktisch korrekt ist, aber keine Aufzeichnung gefunden werden konnte, lautet der HTTP-Statuscode:

HTTP Status Code: 404 (Not found)