Données d'événement de session de chat QM

Cette page décrit les données d'événement de session de chat que Contact Center AI Platform peut exporter vers votre application de gestion de la qualité (QM). Les données d'événement de chat QM sont compatibles avec le SDK Web et les SDK mobiles. Pour en savoir plus sur l'intégration de la plate-forme CCAI à votre application QM, consultez Intégration de QM et SIPREC.

Pour les données d'événements de session d'appel, consultez Données d'événements de session d'appel QM.

Événements et déclencheurs de session de chat

Certains événements de session déclenchent l'exportation des données de session de chat vers votre application QM. Cette section liste les types d'événements de chat et inclut un exemple de charge utile d'événement de session pour chacun d'eux.

Discussion commencée

Cet événement est déclenché lorsqu'un agent humain ou un agent virtuel démarre un chat. La charge utile de l'événement contient l'état initial du chat, y compris des informations sur la file d'attente, les participants et l'initiateur.

L'exemple de code suivant montre la charge utile de l'événement :

{
  "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"
    }
  ]
}

Discussion en attente d'attribution

Cet événement est déclenché lorsqu'une session de chat est placée dans une file d'attente et attend d'être attribuée.

L'exemple de code suivant montre la charge utile de l'événement :

{
  "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 accepté

Cet événement est déclenché lorsqu'un agent humain ou virtuel accepte un chat. Il s'agit d'un événement intermédiaire facultatif qui se produit avant qu'un agent ne se connecte à un chat.

L'exemple de code suivant montre une charge utile d'événement pour un agent humain :

{
  "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"
    }
  ]
}

L'exemple de code suivant montre une charge utile d'événement pour un agent virtuel :

{
  "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"
    }
  ]
}

Discussion connectée

Cet événement est déclenché lorsqu'une discussion est associée à un agent humain ou virtuel. Il peut s'agir d'une connexion automatique ou d'un agent humain qui se connecte manuellement.

L'exemple de code suivant montre une charge utile d'événement pour un agent humain :

{
  "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"
    }
  ]
}

L'exemple de code suivant montre une charge utile d'événement pour un agent virtuel :

{
  "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"
}

Discussion ignorée

Cet événement est déclenché lorsqu'une session de chat est annulée ou interrompue avant qu'une connexion complète ne soit établie (par exemple, si elle n'a pas été acceptée ou si elle s'est terminée prématurément).

L'exemple de code suivant montre la charge utile de l'événement :

{
  "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"
    }
  ]
}

Discussion reprise

Cet événement est déclenché lorsqu'une session de chat précédemment mise en veille ou suspendue est reprise. La charge utile contient l'état du chat lorsqu'il est repris.

L'exemple de code suivant montre la charge utile de l'événement :

{
  "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"
    }
  ]
}

Un participant a quitté le chat

Cet événement est déclenché lorsqu'un ou plusieurs participants quittent une session de chat. Il peut s'agir d'un utilisateur final, d'un agent humain ou d'un agent virtuel qui quitte le chat. La charge utile contient l'état du chat lorsque les participants l'ont quitté.

L'exemple de code suivant montre la charge utile d'événement pour un utilisateur final qui quitte une discussion :

{
  "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"
    }
  ]
}

L'exemple de code suivant montre la charge utile d'événement lorsqu'un agent humain quitte une discussion :

{
  "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"
    }
  ]
}

L'exemple de code suivant montre la charge utile d'événement pour un agent virtuel qui quitte une discussion :

{
  "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"
    }
  ]
}

Discussion terminée

Cet événement est déclenché lorsqu'une session de chat se termine. Il peut s'agir d'un utilisateur final, d'un agent humain ou d'un agent virtuel qui met fin à la discussion. La charge utile contient l'état du chat à la fin de la session, y compris les participants et les codes temporels indiquant le début et la fin du chat.

L'exemple de code suivant montre la charge utile de l'événement lorsqu'un agent humain et un utilisateur final quittent une discussion :

{
  "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"
}

L'exemple de code suivant montre la charge utile d'événement pour un agent virtuel et un utilisateur final quittant une discussion :

{
  "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"
}

L'exemple de code suivant montre la charge utile d'événement pour une discussion instantanée terminée en attendant dans la file d'attente :

{
  "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"
}

Champs d'événement de session de chat

Les tableaux suivants décrivent les champs des données de session que Contact Center AI Platform exporte vers votre application QM.

Champs généraux

Nom de champ

Valeurs

Description

Condition

type

  • AgentState
  • ChatState

Type d'événement de la charge utile JSON globale.

  • Transmet AgentState pour les événements liés à l'agent.
  • Transmet ChatState pour les événements liés au chat.

item

Objet contenant des informations sur l'événement.

Champs d'état du chat

Field Name (Nom du champ)

Valeurs

Description

Condition

chat_id

  • ID du chat

Disponible dans l'objet item.

Identifiant de la session de chat dans le système Contact Center AI Platform.

  • Transmet la valeur du champ "ID" dans l'objet principal des métadonnées de session Contact Center AI Platform.

state

  • waiting
  • connected
  • disconnected
  • dismissed
  • resumed
  • participantDisconnect
  • transferred

Disponible dans l'objet item.

État actuel de la session de chat.

direction

  • incoming

Disponible dans l'objet item.

Direction de la session de chat du point de vue du centre de contact.

  • Transmet incoming lorsque la session de chat est entrante.

initiator

  • agent_1
  • virtual_agent_2
  • end_user_5

Disponible dans l'objet item.

Identifiant de la partie qui initialise l'état du chat.

  • Pour les agents humains

    Transmet la valeur du champ "ID" dans l'objet agent_info des métadonnées de la session.

  • Pour les agents virtuels

    Transmet la valeur du champ virtual_agent_id dans l'objet participants des métadonnées de session.

  • Pour les utilisateurs finaux

    Transmet la valeur du champ "ID" dans l'objet end_user des métadonnées de la session.

queue_path_ids

  • Chemin d'ID de file d'attente

Disponible dans l'objet item.

Chemin de file d'attente emprunté par l'utilisateur final avant d'être mis en relation avec le premier agent de l'appel.

Cette valeur est construite à l'aide des ID de file d'attente de la file d'attente consultée.

  • Cela ne s'applique qu'aux discussions entrantes.

queue_path_names

  • Chemin d'accès aux noms de files d'attente

Disponible dans l'objet item.

Chemin de file d'attente emprunté par l'utilisateur final avant d'être mis en relation avec le premier agent de l'appel.

Cette valeur est construite à partir des noms de files d'attente de la file d'attente consultée.

  • Cela ne s'applique qu'aux discussions entrantes.

language

  • Code de langue

Disponible dans l'objet item.

Code de langue sélectionné par l'utilisateur final.

  • Cela ne s'applique qu'aux discussions entrantes.

queue_uuid

  • ID de la file d'attente

Disponible dans l'objet item.

UUID de la file d'attente vers laquelle la discussion a été redirigée.

  • Cela ne s'applique qu'aux discussions entrantes et transférées vers une file d'attente.

tenant

  • Nom de l'instance

Disponible dans l'objet item.

Nom de l'instance hébergeant le chat.

event_id

  • ID de l'événement

Disponible dans l'objet item.

Identifiant de la session de chat.

timestamp

  • Code temporel UNIX

Disponible dans l'objet item.

Code temporel du chat au format epoch Unix

session_type_v2

  • In-web

Disponible dans l'objet item.

Indique une session de chat du SDK Web.

support_number

  • NULL

  • Non applicable au chat.

connected_at

  • La date et l'heure

Disponible dans l'objet item.

Date et heure de début de la session de chat.

ends_at

  • La date et l'heure

Disponible dans l'objet item.

Date et heure de fin de la session de chat.

participants

Disponible dans l'objet item.

Objet contenant les informations sur le participant à l'appel.

participant_id

  • agent_id
  • virtual_agent_id

Disponible dans l'objet participants.

Identifiant du participant au chat.

  • Pour les agents humains

    Transmet la valeur du champ "ID" dans l'objet agent_info des métadonnées de la session.

  • Pour les agents virtuels

    Transmet la valeur du champ virtual_agent_id dans l'objet participants des métadonnées de la session.

  • Pour les utilisateurs finaux

    Transmet la valeur du champ "ID" dans l'objet end_user des métadonnées de la session.

  • Pour les tiers

    Transmet le numéro de téléphone du tiers, le cas échéant.

    Sinon, transmet la valeur null.

type

  • external
  • agent
  • virtual_agent

Disponible dans l'objet participants.

Type de participant à l'appel.

  • Transmet agent lorsque le participant au chat est un agent.
  • Transmet external lorsque le participant à la discussion est un utilisateur final ou un tiers.
  • Le test est réussi virtual_agent lorsque le participant au chat est un agent virtuel.

state

  • connected
  • disconnected
  • accepted
  • dismissed
  • resumed

Disponible dans l'objet participants.

État actuel du participant dans la conférence de chat.

media_id

  • twilio_mediaID
  • nexmo_mediaID

Disponible dans l'objet participants.

Identifiant du contenu multimédia de la session de chat fourni par l'opérateur.

  • Transmet le twilio_mediaID lorsque l'initiateur discute dans ou depuis un numéro Twilio.
  • Transmet le nexmo_mediaID lorsque l'initiateur discute dans ou depuis un numéro Nexmo.

dn

  • end_user_1
  • agent_1

Disponible dans l'objet participants.

Numéro de répertoire du participant.

agent_number

Disponible dans l'objet participants. Numéro de l'agent.

name

Disponible dans l'objet participants. Nom de l'agent.

alias

Disponible dans l'objet participants. Alias de l'agent.

Transferts de sessions de chat

Les transferts de sessions de chat ne sont pas des événements de chat distincts. Il s'agit plutôt de charges utiles qui indiquent qu'un transfert de session de chat a eu lieu. Cette section présente une charge utile de transfert de session de chat qui est déclenchée lorsqu'un agent quitte un chat. Dans cet exemple, la valeur du champ initiator est agent_1, ce qui indique que l'agent 1 a initié le transfert. Dans le tableau participants, agent_1 est à l'état disconnected et agent_2 est à l'état connected. Cela indique que la session a été transférée de l'agent 1 à l'agent 2, l'agent 1 ayant quitté le chat et l'agent 2 l'ayant rejoint. Dans cet exemple, la valeur du champ state global est participantDisconnect, mais vous pouvez modéliser votre système pour qu'il ait un état global de transferred ou connected si vous préférez. Vous pouvez également modéliser votre système pour qu'il comporte des champs supplémentaires afin de représenter plus explicitement un transfert de session, par exemple transfer_id ou un type d'événement de transfert dédié.

L'exemple de code suivant montre une charge utile d'événement pour un transfert de session :

{
  "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"
    }
  ]
}