Dokumentation

Transfer Call API

Mit der Transfer Call API ist es möglich Anrufe zu transferieren. Ein Anruf kann z.B. zunächst an ein Call Center weitergeleitet, und danach bei Bedarf an einen Spezialisten transferiert werden.

Transfer call einleiten:

Mit dieser Methode wird ein Anruf transferiert. Damit ein Anruf transferiert werden kann, muss dieser bereits an ein Ziel weitergeleitet und verbunden sein.

POST	https://api.tenios.com/transfer-call

Anfrageparameter:

access_key	Der 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_uuid	Die UUID des Anrufs, der transferiert werden soll.
destinationn_type	Der Typ des Ziels and den der Anruf transferiert werden soll. Die möglichen Werte sind EXTERNALNUMBER – Für den Transfer an eine Rufnummer im PSTN. SIP_USER – Für den Transfer an einen SIP-Account. SIP_TRUNK – Für den Transfer an einen SIP-Trunk.
destination	Das Ziel, abhängig vom destination_type. EXTERNALNUMBER – Eine Rufnummer im internationalen Format (E.164), mit führendem Pluszeichen, z.B. +492215540030 SIP_USER – Der Benutzername des SIP-Accounts. SIP_TRUNK – Der Benutzername des SIP-Trunks.

Antwortparameter:

success boolean	true bei Erfolg, ansonsten eine Fehlermeldung.

Beispiel für eine erfolgreiche Anfrage:

Request:

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

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 sip_uri 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_FILED_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",
   "destination_type": "EXTERNALNUMBER",
   "destination": "+4922155400300"
}

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"
   ]
}