Parloa RBA Register

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

POST /api/v1/Parloa/register

JSON

{
  "input": {
    "callId": "string",
    "callingNumber": "string",
    "voiceBotId": "string",
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string",
  },
  "context": {
    "releaseId": "string",
    "userContextId": "string",
    "conversationId": "string",
    "dialogId": "string",
    "dialogVersion": "string",
    "fovConversationId": "string",
    "platform": "string"
  }
}

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

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

callId: Die von der IVR generierte eineindeutige ID des Anrufs

callingNumber: Beinhaltet die Rufnummer des Anrufers

voiceBotId: Die von Parloa generierte eineindeutige ID des Flows

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

JSON

{
  "choice": "parameter",
  "output": {
    "sessionId": null,
    "callId": null,
    "voicebotId": null,
    "conversationId": null,
    "responseCode": 406,
    "responseText": "Missing paramater callId!"
  }
}

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

JSON

{
  "choice": "success",
  "output": {
    "sessionId": "ac1f31af-f35f-4f28-a862-37471eebf334",
    "callId": "string",
    "voicebotId": "string",
    "conversationId": "string",
    "responseCode": 200,
    "responseText": null
  }
}