IVR Register

Mit diesem Aufruf wird ein Anruf für die Voicebot Kommunikation registriert.

POST /api/v1/Ivr/register

JSON

{
  "input": {
    "callingNumber": "string",
    "callId": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string",
    ...
  }
}

Das “input” Objekt kann eine beliebige Anzahl an Schlüssel/Wert-Paaren beinhalten.

Folgende Schlüssel müssen immer übergeben werden:

callingNumber: Beinhaltet die Rufnummer des Anrufers

callId: Die von der IVR generierte eineindeutige ID des Anrufs

Sollte einer der Parameter fehlen, wird mit einem Status 400 geantwortet:

JSON

{
  "responseCode": 406,
  "responseText": "Missing paramater callId!",
  "sessionId": null,
  "callId": null
}

Bei erfolgreicher Registrierung des Anrufs, wird ein Status 200 mit folgendem Inhalt zurückgegeben:

JSON

{
  "responseCode": 200,
  "responseText": null,
  "sessionId": "4804d948-ff36-4036-a5f8-c363f99189b0",
  "callId": ""
}