Envoyez et recevez des événements pour enrichir les conversations

Dans les conversations Business Messages, les événements éclairent et enrichissent la conversation l'expérience des utilisateurs et des agents en leur communiquant du contenu autre que des messages. Pour utilisateurs, les événements s'affichent sous forme de notifications dans leurs conversations et déclenchent en fonction des différentes actions que les utilisateurs peuvent effectuer. Les agents reçoivent des événements les webhooks et d'envoyer des événements avec des appels d'API.

Les agents doivent être informés des événements déclenchés par l'utilisateur et être en mesure de répondre en conséquence. Par exemple, si un utilisateur demande l'intervention d'un agent, mais que celui-ci ne peut pas répondre positivement ou négativement à la requête, cela nuit à l'expérience expérience.

Types d'événement

Chaque événement appartient à un type particulier:

  • Les événements Réquisitionnés par un agent en direct indiquent que l'utilisateur souhaite parler directement à un agent.

    Si l'agent peut transférer la conversation à un représentant humain, envoyez d'un événement Representative join, puis envoyez les messages suivants à partir d'un représentant humain.

    Si l'agent ne peut pas transférer la conversation à un représentant humain, Envoyer un message pour avertir l'utilisateur et l'informer de la disponibilité d'un agent disponibles.

  • Les événements de membres désignés comme ayant rejoint/quitte le réseau indiquent aux utilisateurs quand des agents réels rejoignent ou quitter une conversation. Ces événements affichent des notifications dans la conversation et permettent de définir les attentes des utilisateurs concernant la réactivité et les types questions qu'ils peuvent poser.

    Le représentant a rejoint/a quitté le groupe

  • Les événements de typage indiquent que l'utilisateur ou l'agent est en train d'écrire.

    Pour les utilisateurs, la valeur booléenne isTyping indique leur état de saisie. Chaque état la modification déclenche un nouvel événement.

    Les agents peuvent envoyer des événements TYPING_STARTED et TYPING_STOPPED à afficher des indicateurs de saisie dans la conversation. Saisir des événements à partir d'agents indique aux utilisateurs qu'un représentant humain compose une réponse ou que le backend l'automatisation traite sa question ou sa demande.

    Indicateur de saisie

Envoyer un événement

Pour envoyer un événement, exécutez la commande suivante. Remplacez les éléments suivants:

  • CONVERSATION_ID par l'identifiant de la conversation souhaitée ; pour envoyer l'enquête
  • EVENT_ID par l'identifiant unique de l'événement ;
  • PATH_TO_SERVICE_ACCOUNT_KEY par le chemin d'accès à votre compte de service ; sur votre machine
  • EVENT_TYPE avec une valeur de EventType
  • REPRESENTATIVE_NAME par le nom de l'agent réel visible par l'utilisateur. ou l'automatisation qui crée l'événement
  • REPRESENTATIVE_TYPE avec une valeur de RepresentativeType
curl -X POST "https://businessmessages.googleapis.com/v1/conversations/CONVERSATION_ID/events?eventId=EVENT_ID" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-messages" \
-H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businessmessages`" \
-d "{
  'eventType': 'EVENT_TYPE',
  'representative': {
    'avatarImage': 'REPRESENTATIVE_AVATAR_URL',
    'displayName': 'REPRESENTATIVE_NAME',
    'representativeType': 'REPRESENTATIVE_TYPE',
  },
}"

Pour connaître les options de mise en forme et de valeur, consultez conversations.events

Exemple: Envoyer un événement auquel un représentant participe

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     https://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This code sends a REPRESENTATIVE_JOINED event to the user.
# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/events#send

# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
# Make sure a service account key file exists at ./service_account_key.json

curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/events?eventId=6a0af2c6-787d-4097-870d-93fe20351747" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-messages" \
-H "$(oauth2l header --json ./service_account_key.json businessmessages)" \
-d "{
  'eventType': 'REPRESENTATIVE_JOINED',
  'representative': {
    'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
    'displayName': 'Chatbot',
    'representativeType': 'HUMAN'
  }
}"
send-event-representative-joined.sh

Recevoir un événement

Lorsqu'un utilisateur déclenche un événement sur son appareil, votre agent le reçoit à l'adresse son webhook. Recevez et traitez les événements de la même manière que vous recevez messages.

Les événements déclenchés par l'utilisateur se présentent comme suit :

{
  "agent": "brands/BRAND_ID/agents/AGENT_ID",
  "requestId": "REQUEST_ID",
  "conversationId": "CONVERSATION_ID",
  "customAgentId": "CUSTOM_AGENT_ID",
  "sendTime": "SEND_TIME",
  "userStatus": {
    "isTyping": "BOOLEAN",
    "requestedLiveAgent": "BOOLEAN",
    "createTime": "CREATION_TIME",
  }
}

Pour connaître les options de mise en forme et de valeur, consultez UserMessage