QM-Chat-Sitzungsereignisdaten

Auf dieser Seite werden die Ereignisdaten für Chatsitzungen beschrieben, die von Contact Center AI Platform (CCAI Platform) in Ihre QM-Anwendung (Quality Management) exportiert werden können. QM-Chat-Ereignisdaten werden vom Web-SDK und den mobilen SDKs unterstützt. Weitere Informationen zur Integration von CCAI Platform in Ihre QM-Anwendung finden Sie unter QM- und SIPREC-Integration.

Informationen zu Anrufsitzungsereignisdaten finden Sie unter QM-Anrufsitzungsereignisdaten.

Ereignisse und Trigger für Chatsitzungen

Bestimmte Sitzungsereignisse lösen den Export von Chat-Sitzungsdaten in Ihre QM-Anwendung aus. In diesem Abschnitt werden die Chat-Ereignistypen aufgeführt und für jeden Typ ein Beispiel für die Nutzlast eines Sitzungsereignisses angegeben.

Chat gestartet

Dieses Ereignis wird ausgelöst, wenn ein menschlicher oder virtueller Kundenservicemitarbeiter einen Chat startet. Die Ereignisnutzlast enthält den ursprünglichen Status des Chats, einschließlich Informationen zur Warteschlange, zu den Teilnehmern und zum Initiator.

Das folgende Codebeispiel zeigt die Ereignisnutzlast:

{
  "queue_path_ids": "7/26",
  "queue_path_names": "Test/calls",
  "language": "en",
  "support_number": null,
  "session_type_v2": "In-web",
  "chat_id": 138,
  "state": "waiting",
  "direction": "incoming",
  "initiator": "end_user_5",
  "participants": [
    {
      "state": "connected",
      "type": "external",
      "dn": "end_user_5"
    }
  ]
}

Chat wartet auf Zuweisung

Dieses Ereignis wird ausgelöst, wenn eine Chatsitzung in eine Warteschlange aufgenommen wird und auf die Zuweisung wartet.

Das folgende Codebeispiel zeigt die Ereignisnutzlast:

{
  "queue_path_ids": "7/23",
  "queue_path_names": "Test/virtual",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 196,
  "state": "waiting",
  "direction": "incoming",
  "initiator": "end_user_5",
  "participants": [
    {
      "state": "connected",
      "type": "external",
      "dn": "end_user_5"
    }
  ]
}

Chat akzeptiert

Dieses Ereignis wird ausgelöst, wenn ein menschlicher oder virtueller Kundenservicemitarbeiter einen Chat annimmt. Dies ist ein optionales Zwischenereignis, bevor ein Kundenservicemitarbeiter mit einem Chat verbunden wird.

Das folgende Codebeispiel zeigt eine Ereignisnutzlast für einen Kundenservicemitarbeiter:

{
  "queue_path_ids": "7/26",
  "queue_path_names": "Test/calls",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 167,
  "state": "connected",
  "direction": "incoming",
  "initiator": "agent_1",
  "participants": [
    {
      "state": "connected",
      "type": "external",
      "media_id": "MB0d0540e638354714a43d64e9be9677b6",
      "dn": "end_user_5"
    },
    {
      "state": "accepted",
      "type": "agent",
      "media_id": "MBd9670cb0cddd424c814194795527ae3a",
      "agent_number": "Uno numero",
      "name": "Admin UJET",
      "alias": "super_agent",
      "dn": "agent_1"
    }
  ]
}

Das folgende Codebeispiel zeigt eine Ereignisnutzlast für einen virtuellen Agenten:

{
  "queue_path_ids": "7/23",
  "queue_path_names": "Test/virtual",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 196,
  "state": "connected",
  "direction": "incoming",
  "initiator": "virtual_agent_2",
  "participants": [
    {
      "state": "connected",
      "type": "external",
      "media_id": "MBdfcdab9220f94f1486008a165db3f31a",
      "dn": "end_user_5"
    },
    {
      "state": "accepted",
      "type": "virtual_agent",
      "media_id": "MBea10421d150b4d22b675de17070bc383",
      "dn": "virtual_agent_2"
    }
  ]
}

Chat verbunden

Dieses Ereignis wird ausgelöst, wenn ein Chat mit einem menschlichen oder virtuellen Kundenservicemitarbeiter verbunden wird. Das kann eine automatische Verbindung oder eine manuelle Verbindung durch einen Kundenservicemitarbeiter sein.

Das folgende Codebeispiel zeigt eine Ereignisnutzlast für einen Kundenservicemitarbeiter:

{
  "queue_path_ids": "7/26",
  "queue_path_names": "Test/calls",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 114,
  "state": "connected",
  "direction": "incoming",
  "initiator": "end_user_5",
  "participants": [
    {
      "state": "connected",
      "type": "external",
      "media_id": "MB7a504ce7f418447bb4a48b8f3fa609d0",
      "dn": "end_user_5"
    },
    {
      "state": "connected",
      "type": "agent",
      "agent_number": "Uno numero",
      "name": "Admin UJET",
      "alias": "super_agent",
      "dn": "agent_1"
    }
  ]
}

Das folgende Codebeispiel zeigt eine Ereignisnutzlast für einen virtuellen Agenten:

{
  "queue_path_ids": "7/23",
  "queue_path_names": "Test/virtual",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 196,
  "state": "connected",
  "direction": "incoming",
  "initiator": "virtual_agent_2",
  "participants": [
    {
      "state": "connected",
      "type": "external",
      "dn": "end_user_5"
    },
    {
      "state": "connected",
      "type": "virtual_agent",
      "dn": "virtual_agent_2"
    }
  ],
  "connected_at": "2024-09-13T14:04:17.000-07:00"
}

Chat geschlossen

Dieses Ereignis wird ausgelöst, wenn eine Chatsitzung abgebrochen oder beendet wird, bevor eine vollständige Verbindung hergestellt wurde. Das kann z. B. der Fall sein, wenn die Sitzung nicht akzeptiert wurde oder vorzeitig beendet wurde.

Das folgende Codebeispiel zeigt die Ereignisnutzlast:

{
  "queue_path_ids": "7/26",
  "queue_path_names": "Test/calls",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 197,
  "state": "dismissed",
  "direction": "incoming",
  "initiator": "agent_1",
  "participants": [
    {
      "state": "dismissed",
      "type": "external",
      "media_id": "MB444f542e9b9c4f89a8369bb2430357ad",
      "dn": "end_user_5"
    },
    {
      "state": "dismissed",
      "type": "agent",
      "media_id": "MB7e657411b2284f95b2cf31ef5e6dc83c",
      "agent_number": "Uno numero",
      "name": "Admin UJET",
      "alias": "super_agent",
      "dn": "agent_1"
    }
  ]
}

Chat fortgesetzt

Dieses Ereignis wird ausgelöst, wenn eine zuvor pausierte oder gesperrte Chatsitzung fortgesetzt wird. Die Nutzlast enthält den Status des Chats, wenn er fortgesetzt wird.

Das folgende Codebeispiel zeigt die Ereignisnutzlast:

{
  "session_type_v2": "In-web",
  "chat_id": 198,
  "state": "resumed",
  "direction": "incoming",
  "initiator": "end_user_5",
  "participants": [
    {
      "state": "resumed",
      "type": "external",
      "media_id": "MB320da61121bc4fc48ea099759f679333",
      "dn": "end_user_5"
    },
    {
      "state": "resumed",
      "type": "agent",
      "media_id": "MBbe5db89a01ab4814a8e7830daf3d30fa",
      "agent_number": "Uno numero",
      "name": "Admin UJET",
      "alias": "super_agent",
      "dn": "agent_1"
    }
  ]
}

Teilnehmer hat den Chat verlassen

Dieses Ereignis wird ausgelöst, wenn ein oder mehrere Teilnehmer eine Chatsitzung verlassen. Das kann ein Endnutzer, ein menschlicher Kundenservicemitarbeiter oder ein virtueller Kundenservicemitarbeiter sein, der den Chat verlässt. Die Nutzlast enthält den Status des Chats, als die Teilnehmer ihn verlassen haben.

Das folgende Codebeispiel zeigt die Ereignisnutzlast für einen Endnutzer, der einen Chat verlässt:

{
  "session_type_v2": "In-web",
  "chat_id": 169,
  "state": "participantDisconnect",
  "direction": "incoming",
  "initiator": "end_user_5",
  "participants": [
    {
      "state": "disconnected",
      "type": "external",
      "media_id": "MB4dd73370bc564cf18f5347233523ef44",
      "dn": "end_user_5"
    },
    {
      "state": "disconnected",
      "type": "agent",
      "media_id": "MBba370f84cf914992b05e9aab03730c4b",
      "agent_number": "Uno numero",
      "name": "Admin UJET",
      "alias": "super_agent",
      "dn": "agent_1"
    }
  ]
}

Das folgende Codebeispiel zeigt die Ereignisnutzlast für einen Kundenservicemitarbeiter, der einen Chat verlässt:

{
  "queue_path_ids": "7/26",
  "queue_path_names": "Test/calls",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 169,
  "state": "participantDisconnect",
  "direction": "incoming",
  "initiator": "agent_1",
  "participants": [
    {
      "state": "connected",
      "type": "external",
      "media_id": "MB4dd73370bc564cf18f5347233523ef44",
      "dn": "end_user_5"
    },
    {
      "state": "disconnected",
      "type": "agent"
      "media_id": "MBba370f84cf914992b05e9aab03730c4b",
      "agent_number": "Uno numero",
      "name": "Admin UJET",
      "alias": "super_agent",
      "dn": "agent_1"
    }
  ]
}

Das folgende Codebeispiel zeigt die Ereignisnutzlast für einen virtuellen Agenten, der einen Chat verlässt:

{
  "queue_path_ids": "7/23",
  "queue_path_names": "Test/virtual",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 196,
  "state": "participantDisconnect",
  "direction": "incoming",
  "initiator": "virtual_agent_2",
  "participants": [
    {
      "state": "disconnected",
      "type": "external",
      "media_id": "MBdfcdab9220f94f1486008a165db3f31a",
      "dn": "end_user_5"
    },
    {
      "state": "disconnected",
      "type": "virtual_agent",
      "media_id": "MBea10421d150b4d22b675de17070bc383",
      "dn": "virtual_agent_2"
    }
  ]
}

Chat beendet

Dieses Ereignis wird ausgelöst, wenn eine Chatsitzung beendet wird. Das kann ein Endnutzer, ein menschlicher Kundenservicemitarbeiter oder ein virtueller Kundenservicemitarbeiter sein. Die Nutzlast enthält den Status des Chats, wenn er beendet wird, einschließlich der Teilnehmer und der Zeitstempel für den Beginn und das Ende des Chats.

Das folgende Codebeispiel zeigt die Ereignis-Payload für einen Kundenservicemitarbeiter und einen Endnutzer, die einen Chat verlassen:

{
  "queue_path_ids": "7/26",
  "queue_path_names": "Test/calls",
  "language": "en",
  "support_number": null,
  "session_type_v2": "In-web",
  "chat_id": 127,
  "state": "disconnected",
  "direction": "incoming",
  "initiator": "end_user_5",
  "participants": [
    {
      "state": "disconnected",
      "type": "external",
      "media_id": "MB4a0a435e759c43369098ee7f2d0271f0",
      "dn": "end_user_5"
    },
    {
      "state": "disconnected",
      "type": "agent",
      "media_id": "MBa4afeafb5bcc4a279f51db76f3b98deb",
      "agent_number": "Uno numero",
      "name": "Admin UJET",
      "alias": "super_agent",
      "dn": "agent_1"
    }
  ],
  "connected_at": "2024-08-27T17:06:37.000-07:00",
  "ends_at": "2024-08-27T17:06:59.000-07:00"
}

Das folgende Codebeispiel zeigt die Ereignisnutzlast für einen virtuellen Agenten und einen Endnutzer, die einen Chat verlassen:

{
  "queue_path_ids": "7/23",
  "queue_path_names": "Test/virtual",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 190,
  "state": "disconnected",
  "direction": "incoming",
  "initiator": "end_user_5",
  "participants": [
    {
      "state": "disconnected",
      "type": "external",
      "media_id": "MB6ea6204b6a0448428d88e9976fd856d4",
      "dn": "end_user_5"
    },
    {
      "state": "disconnected",
      "type": "virtual_agent",
      "media_id": "MBc6a2b72c99534a68990caf622b65571a",
      "dn": "virtual_agent_2"
    }
  ],
  "connected_at": "2024-09-12T10:50:51.000-07:00",
  "ends_at": "2024-09-12T11:54:08.000-07:00"
}

Das folgende Codebeispiel zeigt die Ereignisnutzlast für einen Chat, der beendet wurde, während der Nutzer in der Warteschlange war:

{
  "queue_path_ids": "7/26",
  "queue_path_names": "Test/calls",
  "language": "en",
  "support_number": null,
  "session_type_v2": "In-web",
  "chat_id": 141,
  "state": "disconnected",
  "direction": "incoming",
  "initiator": "end_user_5",
  "participants": [
    {
      "state": "disconnected",
      "type": "external",
      "media_id": "MB65670b2c44534af3860fad35be88ac41",
      "dn": "end_user_5"
    }
  ],
  "connected_at": "",
  "ends_at": "2024-08-29T14:41:16.000-07:00"
}

Felder für Ereignisse in Chatsitzungen

In den folgenden Tabellen werden die Felder in den Sitzungsdaten beschrieben, die von Contact Center AI Platform in Ihre QM-Anwendung exportiert werden.

Allgemeine Felder

Feldname	Werte	Beschreibung	Bedingung
type	AgentState ChatState	Der Ereignistyp der gesamten JSON-Nutzlast.	Übergibt AgentState für agentenbezogene Ereignisse. Übergibt ChatState für chatbezogene Ereignisse.
item		Das Objekt mit Ereignisinformationen.

Felder für den Chatstatus

Feldname	Werte	Beschreibung	Bedingung
chat_id	Die Chat-ID	Verfügbar im item-Objekt. Die Kennung der Chatsitzung im Contact Center AI Platform-System.	Übergibt den Wert des ID-Felds im Hauptobjekt in den Metadaten der Contact Center AI Platform-Sitzung.
state	waiting connected disconnected dismissed resumed participantDisconnect transferred	Verfügbar im item-Objekt. Der aktuelle Status der Chatsitzung.
direction	incoming	Verfügbar im item-Objekt. Die Richtung der Chatsitzung aus der Perspektive des Contact Centers.	Wird incoming übergeben, wenn die Chatsitzung eingehend ist.
initiator	agent_1 virtual_agent_2 end_user_5	Verfügbar im item-Objekt. Die Kennung der Partei, die den Chatstatus initialisiert.	Für Kundenservicemitarbeiter Übergibt den Wert des ID-Felds im agent_info-Objekt in den Sitzungsmetadaten. Für virtuelle Kundenservicemitarbeiter Übergibt den Wert des Felds virtual_agent_id im Objekt participants in den Sitzungsmetadaten. Für Nutzer*innen Übergibt den Wert des ID-Felds im end_user-Objekt in den Sitzungsmetadaten.
queue_path_ids	Ein Pfad mit Warteschlangen-IDs	Verfügbar im item-Objekt. Der Warteschlangenpfad, den der Endnutzer durchlaufen hat, bevor er den ersten Kundenservicemitarbeiter des Anrufs erreicht hat. Dieser Wert wird aus den Warteschlangen-IDs der aufgerufenen Warteschlange erstellt.	Das gilt nur für eingehende Chats.
queue_path_names	Ein Pfad mit Warteschlangennamen	Verfügbar im item-Objekt. Der Warteschlangenpfad, den der Endnutzer durchlaufen hat, bevor er den ersten Kundenservicemitarbeiter des Anrufs erreicht hat. Dieser Wert wird aus den Warteschlangennamen der aufgerufenen Warteschlange erstellt.	Das gilt nur für eingehende Chats.
language	Der Sprachcode	Verfügbar im item-Objekt. Der Sprachcode der vom Endnutzer ausgewählten Sprache.	Das gilt nur für eingehende Chats.
queue_uuid	Die Warteschlangen-ID	Verfügbar im item-Objekt. Die UUID der Warteschlange, an die der Chat weitergeleitet wurde.	Das gilt nur für eingehende und in die Warteschlange übertragene Chats.
tenant	Der Name der Instanz	Verfügbar im item-Objekt. Der Name der Instanz, auf der der Chat gehostet wird.
event_id	Die Ereignis-ID	Verfügbar im item-Objekt. Eine Kennung für die Chatsitzung.
timestamp	Ein UNIX-Zeitstempel	Verfügbar im item-Objekt. Ein Zeitstempel für den Chat in Unix-Epochenzeit
session_type_v2	In-web	Verfügbar im item-Objekt. Gibt eine Chat-Sitzung im Web-SDK an.
support_number	NULL		Nicht für den Chat anwendbar.
connected_at	Datum und Uhrzeit	Verfügbar im item-Objekt. Das Datum und die Uhrzeit, zu der die Chatsitzung begonnen hat.
ends_at	Datum und Uhrzeit	Verfügbar im item-Objekt. Das Datum und die Uhrzeit, zu der die Chatsitzung beendet wurde.
participants		Verfügbar im item-Objekt. Ein Objekt mit Informationen zum Anrufteilnehmer.
participant_id	agent_id virtual_agent_id	Verfügbar im participants-Objekt. Die ID des Chat-Teilnehmers.	Für Kundenservicemitarbeiter Übergibt den Wert des ID-Felds im agent_info-Objekt in den Sitzungsmetadaten. Für virtuelle Kundenservicemitarbeiter Übergibt den Wert im Feld virtual_agent_id im Objekt participants in den Sitzungsmetadaten. Für Nutzer*innen Übergibt den Wert des ID-Felds im end_user-Objekt in den Sitzungsmetadaten. Für Drittanbieter Gibt die Telefonnummer des Drittanbieters weiter, sofern verfügbar. Andernfalls wird der Wert null übergeben.
type	external agent virtual_agent	Verfügbar im participants-Objekt. Der Typ des Anrufteilnehmers.	Wird agent übergeben, wenn der Chatteilnehmer ein Kundenservicemitarbeiter ist. Wird für external übergeben, wenn der Chatteilnehmer ein Endnutzer oder ein Drittanbieter ist. Wird übergeben, wenn der Chatteilnehmer ein virtueller Kundenservicemitarbeiter ist.virtual_agent
state	connected disconnected accepted dismissed resumed	Verfügbar im participants-Objekt. Der aktuelle Status des Teilnehmers in der Chatkonferenz.
media_id	twilio_mediaID nexmo_mediaID	Verfügbar im participants-Objekt. Die Kennung für Medien aus der Chat-Sitzung vom Mobilfunkanbieter.	Wird an twilio_mediaID übergeben, wenn der Initiator über eine Twilio-Nummer chattet. Wird an nexmo_mediaID übergeben, wenn der Initiator über eine Nexmo-Nummer chattet.
dn	end_user_1 agent_1	Verfügbar im participants-Objekt. Die Rufnummer des Teilnehmers.
agent_number		Verfügbar im participants-Objekt. Die Nummer des Kundenservicemitarbeiters.
name		Verfügbar im participants-Objekt. Der Name des Agents.
alias		Verfügbar im participants-Objekt. Der Alias des Agents.

Übertragung von Chatsitzungen

Chat-Sitzungsübertragungen sind keine separaten Chat-Ereignisse. Stattdessen handelt es sich um Nutzlasten, die darauf hinweisen, dass eine Chatsitzung übertragen wurde. In diesem Abschnitt sehen Sie die Nutzlast für die Übertragung einer Chatsitzung, die ausgelöst wird, wenn ein Kundenservicemitarbeiter einen Chat verlässt. In diesem Beispiel ist der Wert des Felds initiator agent_1. Das bedeutet, dass Agent 1 die Übertragung initiiert hat. Im Array participants hat agent_1 den Status disconnected und agent_2 den Status connected. Das bedeutet, dass die Sitzung von Agent 1 an Agent 2 übertragen wurde. Agent 1 hat den Chat verlassen und Agent 2 ist beigetreten. Der Wert des Gesamtfelds state in diesem Beispiel ist participantDisconnect. Sie können Ihr System aber auch so modellieren, dass es einen Gesamtzustand von transferred oder connected hat. Sie können Ihr System auch so modellieren, dass es zusätzliche Felder enthält, um eine Sitzungsübertragung expliziter darzustellen, z. B. transfer_id oder ein dedizierter Übertragungsereignistyp.

Das folgende Codebeispiel zeigt eine Ereignisnutzlast für eine Sitzungsübertragung:

{
  "queue_path_ids": "7/26",
  "queue_path_names": "Test/calls",
  "language": "en",
  "session_type_v2": "In-web",
  "chat_id": 208,
  "state": "participantDisconnect",
  "direction": "incoming",
  "initiator": "agent_1",
  "participants": [
    {
      "state": "connected",
      "type": "external",
      "media_id": "MBed9193af0a82486cbad069925b5a0b18",
      "dn": "end_user_5"
    },
    {
      "state": "disconnected",
      "type": "agent",
      "media_id": "MB05685c80e6af444faa1de5c5e48a26c7",
      "agent_number": "Uno numero",
      "name": "Admin UJET",
      "alias": "super_agent",
      "dn": "agent_1"
    },
    {
      "state": "connected",
      "type": "agent",
      "media_id": "MB5caad80c7d94477d9db9c5f1c3662768",
      "agent_number": "420",
      "name": "ajay1 ujet",
      "alias": "ajay1-alias",
      "dn": "agent_2"
    }
  ]
}