Reporting Attach

Mit diesem Aufruf können Daten an eine Session hinzugefügt und aktualisiert werden.

Die Schnittstelle bietet die Möglichkeit zusätzliche Daten mit verschiedenen Aktionen zu definieren.
Diese können dann gesondert, über eine Drittanwendung, ausgelesen und bearbeitet werden.

Daten können nur an eine noch “offene” Session angefügt werden!

POST /api/v1/Reporting/attach

JSON

{
  "sessionId": "7b5a9479-7b43-4059-91c9-262959b25f64",
  "createdAt": null,
  "action": "REP_DATA",
  "key": "Validation",
  "value": "User is validated"
}

Wert

Beschreibung

sessionId

Die Session ID zu der Daten hinzugefügt werden soll.

createdAt

Das Datum, an dem der Eintrag erstellt wurde.

Der Zeit Stempel muss immer im UTC Format übergeben werden.

Wenn der Zeit Stempel als NULL Wert übergeben wird, wir die aktuelle Zeit gesetzt.

action

Der Bezeichner für die Aktion.

Folgende Werte werden vom Connector benutzt:

Wert	Beschreibung
ADD_SESSION	Wird geschrieben, sobald eine Session erstellt wurde.
REM_SESSION	Wir geschrieben, sobald eine Session beendet wurde.
GET_SESSION	Wird geschrieben, wenn eine Session abgerufen wird.
ADD_DATA	Wird geschrieben, wenn ein neuer Schlüssel mit seinem Wert erstellt wird.
UPD_DATA	Wird geschrieben, wenn ein bestehender Schlüssel mit einem neuen Wert überschrieben wird.
ADD_DATA_E	Wird geschrieben, wenn ein neuer Schlüssel mit seinem Wert erstellt wird.
UPD_DATA_E	Wird geschrieben, wenn ein bestehender Schlüssel mit einem neuen Wert überschrieben wird.
TRANS_DATA	Wird geschrieben, wenn eine neue Transkription geschrieben wird.

key

Der Schlüssel für die Aktion.

Folgende Werte werden vom Connector benutzt, sollte die Aktion vom Typ “TRANS_DATA” sein:

Wert	Beschreibung
bot	Signalisiert, dass der Eintrag von einem Bot erstellt wurde.
customer	Signalisiert, dass der Eintrag von einer Gegenstelle erstellt wurde.
summary	Beinhaltet eine Zusammenfassung der Unterhaltung.
info	Dienst als Informationselement und kann verwendet werden, um Zwischenschritte festzuhalten.

value

Der Wert zur Aktion.

Die Länge der Eingabe ist nicht beschränkt und kann komplexe Daten, wie JSON und XML Objekte als String, enthalten.

Sollte die Session nicht existieren, wird mit einem Status 404 geantwortet:

JSON

{
  "statusText": "Session was not found!",
  "statusCode": 404,
  "item": {}
}

Bei erfolgreichem Aufruf, wird ein Status 200 mit folgendem Inhalt zurückgegeben:

JSON

{
  "statusText": "OK",
  "statusCode": 200,
  "item": {}
}