Gửi và nhận sự kiện để làm phong phú các cuộc trò chuyện

Trong các cuộc trò chuyện trên Business Messages, các sự kiện cung cấp thông tin và làm phong phú thêm nội dung trò chuyện trải nghiệm của cả người dùng và nhân viên hỗ trợ bằng cách truyền đạt nội dung không phải là tin nhắn. Cho người dùng, sự kiện sẽ hiển thị dưới dạng thông báo trong cuộc trò chuyện và kích hoạt dựa trên các thao tác khác nhau mà người dùng có thể thực hiện. Nhân viên hỗ trợ nhận sự kiện tại webhook và gửi sự kiện bằng lệnh gọi API.

Nhân viên hỗ trợ phải biết về các sự kiện do người dùng khởi tạo và có thể phản hồi cho phù hợp. Ví dụ: nếu người dùng yêu cầu một nhân viên hỗ trợ trực tiếp, nhưng nhân viên hỗ trợ đó không thể phản hồi tích cực hoặc tiêu cực với yêu cầu, điều này sẽ dẫn đến người dùng xấu của bạn.

Loại sự kiện

Mỗi sự kiện thuộc một loại cụ thể:

  • Các sự kiện được yêu cầu bởi nhân viên hỗ trợ trực tiếp cho biết rằng người dùng muốn nói trực tiếp cho nhân viên hỗ trợ.

    Nếu nhân viên hỗ trợ có thể chuyển cuộc trò chuyện sang một nhân viên đại diện, hãy gửi sự kiện Tham gia đại diện, sau đó gửi tin nhắn tiếp theo từ một do con người thực hiện.

    Nếu nhân viên hỗ trợ không thể chuyển cuộc trò chuyện sang một nhân viên hỗ trợ, gửi tin nhắn để thông báo cho người dùng và cho họ biết khi nào một nhân viên hỗ trợ trực tiếp sẽ được sẵn có.

  • Sự kiện Tham gia đại diện/đã rời khỏi cho người dùng biết khi nhân viên hỗ trợ tham gia hoặc rời khỏi cuộc trò chuyện. Những sự kiện này hiển thị thông báo trong cuộc trò chuyện đồng thời giúp người dùng đặt ra kỳ vọng về khả năng phản hồi cũng như các loại những câu hỏi mà các em có thể đặt ra.

    Người đại diện đã tham gia/rời khỏi

  • Sự kiện Nhập cho biết người dùng hoặc tác nhân đang nhập.

    Đối với người dùng, giá trị boolean isTyping cho biết trạng thái nhập của họ. Mỗi trạng thái thay đổi sẽ kích hoạt một sự kiện mới.

    Nhân viên hỗ trợ có thể gửi các sự kiện TYPING_STARTED và TYPING_STOPPED để hiển thị các dấu hiệu đang soạn tin nhắn trong cuộc trò chuyện. Sự kiện nhập từ nhân viên hỗ trợ sẽ cho người dùng biết một người đại diện đang soạn một phản hồi hoặc phần phụ trợ tự động hoá là xử lý câu hỏi hoặc yêu cầu của họ.

    Chỉ báo nhập

Gửi một sự kiện

Để gửi một sự kiện, hãy chạy lệnh sau. Thay thế các mục sau:

  • CONVERSATION_ID kèm theo giá trị nhận dạng của cuộc trò chuyện mà bạn muốn để gửi bản khảo sát
  • EVENT_ID kèm theo một giá trị nhận dạng duy nhất của sự kiện
  • PATH_TO_SERVICE_ACCOUNT_KEY có đường dẫn đến tài khoản dịch vụ của bạn chìa khoá trên máy của bạn
  • EVENT_TYPE với giá trị từ EventType
  • REPRESENTATIVE_NAME kèm theo tên của nhân viên hỗ trợ mà người dùng nhìn thấy hoặc tự động tạo sự kiện
  • REPRESENTATIVE_TYPE với giá trị từ 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',
  },
}"

Để biết các lựa chọn về định dạng và giá trị, hãy xem conversations.events.

Ví dụ: Gửi một người đại diện đã tham gia sự kiện

# 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

Nhận sự kiện

Khi người dùng kích hoạt một sự kiện trên thiết bị của họ, nhân viên hỗ trợ của bạn sẽ nhận được sự kiện đó tại webhook của nó. Nhận và xử lý các sự kiện giống như cách bạn nhận tin nhắn.

Sự kiện do người dùng thực hiện có định dạng như sau.

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

Để biết các lựa chọn về định dạng và giá trị, hãy xem UserMessage.