שליחה וקבלה של אירועים כדי להעשיר את השיחות

בשיחות ב-Business Messages, האירועים מספקים מידע עשיר ומעשירים את השיחה של המשתמשים וגם של הסוכנים באמצעות העברת תוכן שאינו הודעות. עבור משתמשים, אירועים מוצגים כהתראות בשיחות שלהם ומופעלים על סמך פעולות שונות שהמשתמשים עשויים לבצע. הנציגים מקבלים אירועים אצל webhooks ושליחת אירועים עם קריאות ל-API.

הסוכנים צריכים להיות מודעים לאירועים ביוזמת המשתמש ולהיות מסוגלים להגיב בהתאם. לדוגמה, אם משתמש מבקש נציג תמיכה אנושי, אבל הנציג לא יכול מגיבים בצורה חיובית או שלילית לבקשה, התוצאה עלולה להיות שימוש לא בטיחותי חוויה אישית.

סוגי אירועים

כל אירוע שייך לסוג מסוים:

אירועים של בקשה לנציג תמיכה מציינים שהמשתמש רוצה לדבר ישירות לנציג תמיכה.

אם הנציג יכול להעביר את השיחה לנציג אנושי, אפשר לשלוח אירוע הצטרפות לנציג, ולאחר מכן לשלוח את ההודעות הבאות נציג אנושי.

אם הנציג לא יכול להעביר את השיחה לנציג אנושי, אפשר לשלוח הודעה למשתמש ולהודיע לו מתי נציג תמיכה אנושי יתקשר זמינים.
אירועים שהצטרפו לנציגים או עזבו את הארגון לעזוב את השיחה. באירועים האלה מוצגות התראות בשיחה ולעזור להגדיר ציפיות של המשתמשים לגבי רספונסיביות וסוגי המודעות שאלות שהם יכולים לשאול.
אירועי הקלדה מציינים שהמשתמש או הנציג מקלידים.

אצל משתמשים, הערך הבוליאני isTyping מציין את סטטוס ההקלדה שלהם. כל סטטוס לחיצה על השינוי תפעיל אירוע חדש.

נציגים יכולים לשלוח אירועים TYPING_STARTED ו-TYPING_STOPPED להצגה סימנים ויזואליים להקלדה בשיחה. כשקל להקליד על אירועים מנציגי תמיכה, אנחנו מודיעים למשתמשים שנציג אנושי כותב תשובה או את הקצה העורפי הזה מעבדים את השאלה או הבקשה.

איך שולחים אירועים

כדי לשלוח אירוע, מריצים את הפקודה הבאה. מחליפים את הפריטים הבאים:

CONVERSATION_ID במזהה השיחה הרצויה כדי לשלוח את הסקר
EVENT_ID במזהה ייחודי של האירוע
PATH_TO_SERVICE_ACCOUNT_KEY בנתיב לחשבון השירות שלכם מפתח במחשב שלך
EVENT_TYPE עם ערך מ- EventType
REPRESENTATIVE_NAME בשם שגלוי למשתמש של הנציג בשידור החי או פעולה אוטומטית שיוצרים את האירוע
REPRESENTATIVE_TYPE עם ערך מ- 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',
  },
}"

לאפשרויות עיצוב וערך: conversations.events

דוגמה: שליחת אירוע הצטרפות של נציג

# 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

איך מקבלים אירוע

כשמשתמש מפעיל אירוע במכשיר שלו, הנציג מקבל את האירוע ב- התגובה לפעולה מאתר אחר (webhook). קבלה ועיבוד של אירועים באותו אופן שבו אתם מקבלים הודעות.

אירועים ביוזמת המשתמש הם בפורמט הבא.

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

לאפשרויות עיצוב וערך: UserMessage