Dokumentation

Refer Call API

Mit der Refer Call API ist es möglich Anrufe nach Durchlaufen des Routingplans auf der TENIOS Cloud Communications Plattform an die Telefonanlage des Kunden zurückzugeben.

Refer call starten:

Mit dieser Methode wird das Silent Monitoring gestartet.

POSThttps://api.tenios.com/refer-call

 

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, der weitergeleitet werden soll.
sip_uriDie SIP URI, die in der entsprechenden REFER-Nachricht in den Refer-To-Header eingefügt wird.

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",
   "sip_uri": "sip:4044@8.8.8.8:5060;user=phone"
}

 

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",
   "sip_uri": ""
}

 

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_FIELD",
   "error_message": "Invalid 'sip_uri' input parameter. Invalid value - '' .",
   "fields": [
      "sip_uri"
   ]
}

 

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 Pramenter 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": []
}

 

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

Request:

{
   "access_key": "c0b93a5e-4ce0-4adb-940e-5079f2abbcb4",
   "call_uuid": "39d3f096-ad39-4fb1-a666-8353b27e2a8b",
   "sip_uri": "8.8.8.8:5060;user=phone"
}

 

API Response:

HTTP Status Code: 400 (Bad Request)

{
   "error_code": "INVALID_SIP_URI",
   "error_message": "Invalid URI. Valid format is like 'sip:<USER>@<DOMAIN>[:<PORT>][<ATTRIBUTES>]'",
   "fields": [
      "sip_uri"
   ]
}