Dokumentation

Call Control Voice API

Mit der Call Control Voice API ist es möglich Anrufe, die über die Call Control API gesteuert werden, mit zusätzlichen Methoden zu steuern. Die HTTPS-POST-Requests werden von der IP-Adresse 80.239.139.193 gesendet. Bitte stellen Sie sicher, dass diese IP-Adresse in Ihrer Firewall freigegeben ist, damit die Anrufdaten Ihr System erreichen können.

Aktuellen Block unterbrechen:

Mit dieser Methode wird der Block der aktuell ausgeführt wird unterbrochen. Nicht alle Blöcke können unterbrochen werden, falls dies nicht möglich ist, wird eine entsprechende Fehlermeldung zurückgeliefert.

POSThttps://api.tenios.com/interrupt-ecc-block

 

Anfrageparameter:

access_keyDer Zugriffsschlüssel (Access Key) für das API. Dieser kann im Kundenportal unter dem Menüpunkt MY ACCOUNT/ Allgemeine Einstellungen im Abschnitt API gefunden werden.
call_uuidDie UUID des Anrufs, bei dem der aktuell ausgeführte Block unterbrochen werden soll.

Antwortparameter:

success booleantrue bei Erfolg, ansonsten eine Fehlermeldung.

 

Beispiel für eine erfolgreiche Anfrage:

Request:

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

API Response:

HTTP Status Code: 200 (OK)

{
   "success": true
}

 

Beispiele für fehlerhafte Anfragen:

INVALID_FIELD_1
Dieser Fehler wird zurückgegeben, wenn eine ungültige Eingabe beim Parameter angegeben wurde.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "XXXXX-XXXX-XXXXXX",
   "destination_type": "EXTERNAL",
   "destination": "+4922155400300"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "success": false,
   "error_code": "INVALID_VALUE",
   "error_message": "Invalid parameter type or format",
   "fields": [
      "destination_type"
   ]
}
INVALID_FIELD_2
Dieser Fehler wird zurückgegeben, wenn eine falsche oder ungültige Eingabe beim Parametercall_uuid angegeben wurde.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "123456789",
   "sip_uri": "sip:4044@8.8.8.8:5060;user=phone"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_FIELD",
   "error_message": "Invalid 'call_uuid' input parameter. Invalid value - '1234567890'.",
   "fields": [
      "call_uuid"
   ]
}
INVALID_JSON
Dieser Fehler wird zurückgegeben, wenn ein Parameter fehlt.

Request:

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

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_JSON",
   "error_message": "An invalid JSON object was provided in the request body.",
   "fields": []
}
CALL_UUID_NOT_FOUND
Dieser Fehler wird zurückgegeben, wenn die uuid des Anrufes nicht gefunden wurde.

Request:

{
   "access_key": "XXXXX-XXXX-XXXXXX",
   "call_uuid": "c0b93a5e-4ce0-4adb-940e-5079f2abbcb4"
}

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "success": false,
   "error_code": "CALL_UUID_NOT_FOUND",
   "error_message": "The call wasn't found",
   "fields": [
      "call_uuid"
   ]
}