Datenmodell

Event-Tabelle

event_id

type

timestamp

bot_id

conversation_id

contact_id

version_id

payload

environment

channel_type

channel_id

Beschreibung

ID des Events die festlegt, dass jeder Eintrag einzigartig ist

Der Typ des Events legt fest, welche Art von Event stattfand

Zeitpunkt des Events

ID des Bots

ID der Konversation

ID des Kontakts

ID der Bot-Version

Der aufgefasste Inhalt des Events

Umgebung, in der das Event stattfand (Test, Produktion oder Entwicklung)

Typ des verwendeten Channels

ID des verwendeten Channels

Datentyp

uuid

CALL_START | CALL_END | CONTACT_CREATE | CONVERSATION_CREATE | ENTITY_DETECT | INTENT_DETECT | MESSAGE_SEND | MESSAGE_RECEIVE | MESSAGE_STATUS_UPDATE | ORGANIZATION_CREATE | CALL_TRANSFER | INTERACTION | STEP_EXECUTE | STEP_CONDITION_EXECUTE | STEP_SPLIT_EXECUTE | STEP_CONTEXT_EXECUTE | STEP_APP_MODULE_EXECUTE | CONVERSATION_TAG_ADDED

timestamp

string

string

string

string

JSON string

string

string

string

Beschreibung des Event-Typen und des Payloads

Dokumentiert den Start eines Anrufs.

Beinhaltet:

  • die Rufnummer inklusive Ländervorwahl

  • ob es sich um eine mobile Nummer handelt

CALL_START

{
  "callStart": {
    "countryCode": "number",
    "isMobile": "boolean",
    "calledNumber": "string"
  },
}

Dokumentiert das Ende eines Anrufs. Beinhaltet auch den Grund und die Art des Anruf-Endes. Falls es sich um einen Transfer handelte, wird das Transferziel angegeben.

CALL_END

{
  "callEnd": {
    "reason": "string",
    "disconnectedBy": "string",
    "transferTarget": "string"
  }
}

Dokumentiert das Erstellen eines Kontakts und legt dessen ID fest.

CONTACT_CREATE

/

Dokumentiert die Erstellung einer Konversation und deren Sprache.

CONVERSATION_CREATE

{
  "conversationCreate": {
    "language": "string"
  }
}

Dokumentiert die Erkennung einer Entität und deren ID. Gibt Auskunft, mit welcher Genauigkeit diese getroffen wurde.

ENTITY_DETECT

{
  "entityDetect": {
    "entityId": "string",
    "score": "number"
  }
}

Dokumentiert die Erkennung einer Intention und deren ID. Gibt Auskunft, mit welcher Genauigkeit diese getroffen wurde.

INTENT_DETECT

{
  "intentDetect": {
    "intentId": "string",
    "score": "number"
  }
}

Dokumentiert den Versand einer Nachricht vom Agenten oder Bot.

Beinhaltet:

  • die ID der Nachricht

  • die Länge der Nachricht

  • die Größe (falls Datei)

  • die ID des Agenten (falls null, dann ist die Nachricht vom Bot)

  • den Typ der Nachricht

MESSAGE_SEND

{
  "messageSend": {
    "messageId": "string",
    "type": "string",
    "operatorId": "string",
    "length": "number",
    "size": "number"
  }
}

Dokumentiert den Empfang einer Nachricht vom User.

Beinhaltet:

  • die ID der Nachricht

  • die Länge der Nachricht

  • die Größe (falls Datei)

  • den Typ der Nachricht

MESSAGE_RECEIVE

{
  "messageReceive": {
    "messageId": "string",
    "type": "string",
    "length": "number",
    "size": "number"
  }
}

Dokumentiert den Status einer Nachricht: 0 = SENT 1 = READ 2 = DELIVERED 3 = FAILED -1 = UNRECOGNIZED

MESSAGE_STATUS_UPDATE

{
  "messageStatusUpdate": {
    "messageId": "string",
    "status": "string"
  }
}

Dokumentiert das Erstellen einer Organisation und deren ID.

ORGANIZATION_CREATE

 {
  "organizationCreate": {
    "organizationId": "string"
  }
}

Dokumentiert den Transfer eines Anrufs und das Transferziel.

CALL_TRANSFER

 {
  "callTransfer": {
    "target": "string"
  }
}

/

INTERACTION

/

Dokumentiert die Ausführung von Schritten im Bot.

Beinhaltet:

  • die ID des Flows

  • die ID des Schrittes

  • den Typ des Schrittes

STEP_EXECUTE

{
  "stepExecute": {
    "flowId": "string",
    "stepId": "string",
    "type": "string"
  }
}

Dokumentiert die Ausführung eines Bedingungs-Schrittes.

Beinhaltet:

  • die ID des Flows

  • die ID des Schrittes

  • das Resultat der Bedingung, wobei “t” für wahr und “f” für falsch steht

STEP_CONDITION_EXECUTE

{
  "stepConditionExecute": {
    "flowId": "string",
    "stepId": "string",
    "result": "string"
  }
}

Dokumentiert die Ausführung eines A/B-Split-Schrittes.

Beinhaltet:

  • die ID des Flows

  • die ID des Schrittes

  • das Resultat des Splits, welches entweder “a” oder “b” ist

STEP_SPLIT_EXECUTE

{
  "stepSplitExecute": {
    "flowId": "string",
    "stepId": "string",
    "result": "string"
  }
}

Dokumentiert die Ausführung eines Kontext-Schrittes.

Beinhaltet:

  • die ID des Flows

  • die ID des Schrittes

  • den verwendeten Ausstieg

  • die ID der wahrscheinlichsten Intention

STEP_CONTEXT_EXECUTE

 {
  "stepContextExecute": {
    "flowId": "string",
    "stepId": "string",
    "outlet": "string",
    "topIntent": "string"
  }
}

Dokumentiert die Ausführung eines App-Modul-Schrittes.

Beinhaltet:

  • die ID des Flows

  • die ID des Schritts

  • die ID der App

  • die ID des App-Moduls

  • den Status-Code

  • die Dauer bis zur Antwort

  • ob die Ausführung erfolgreich war

STEP_APP_MODULE_EXECUTE

{
  "stepAppModuleExecute": {
    "flowId": "string",
    "stepId": "string",
    "appId": "string",
    "moduleId": "string",
    "statusCode": "number",
    "responseTime": "number",
    "responseOk": "boolean"
  }
}

Dokumentiert das Hinzufügen eines “Tags” zur Konversation und die ID des “Tags”.

CONVERSATION_TAG_ADDED

{
  "conversationTagAdded": {
    "tagId": "string"
  }
}

PreviousExportNextChat-Kanäle

Last updated