REST Resource: brands.agents

Tài nguyên: Nhân viên hỗ trợ

Một thực thể trò chuyện đại diện cho một thương hiệu.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "displayName": string,

  // Union field detail_info can be only one of the following:
  "businessMessagesAgent": {
    object (BusinessMessagesAgent)
  }
  // End of list of possible types for union field detail_info.
}
Các trường
name

string

Mã nhận dạng riêng biệt của nhân viên hỗ trợ.

Chỉ đọc. Do nền tảng xác định.
displayName

string

Bắt buộc. Tên mà nhân viên hỗ trợ sẽ hiển thị với người dùng. Tối đa 100 ký tự.

Bạn không thể sửa đổi sau khi xác minh nhân viên hỗ trợ.

Trường nhóm detail_info. Chứa các trường bắt buộc của sản phẩm cụ thể.

Bắt buộc. detail_info chỉ có thể là một trong những trạng thái sau đây:
businessMessagesAgent

object (BusinessMessagesAgent)

Thông tin chi tiết về nhân viên hỗ trợ của Business Messages.

BusinessMessagesAgent

Thông tin của nhân viên hỗ trợ dành riêng cho Business Messages.

Biểu diễn dưới dạng JSON 
{
  "logoUrl": string,
  "entryPointConfigs": [
    {
      object (BusinessMessagesEntryPointConfig)
    }
  ],
  "conversationalSettings": {
    string: {
      object (ConversationalSetting)
    },
    ...
  },
  "defaultLocale": string,
  "primaryAgentInteraction": {
    object (SupportedAgentInteraction)
  },
  "additionalAgentInteractions": [
    {
      object (SupportedAgentInteraction)
    }
  ],
  "customAgentId": string,
  "agentTestUrl": string,
  "testUrls": [
    {
      object (TestUrl)
    }
  ],
  "phone": {
    object (Phone)
  },
  "authorizationConfig": {
    object (AuthorizationConfig)
  },
  "nonLocalConfig": {
    object (NonLocalConfig)
  },
  "surveyConfig": {
    object (SurveyConfig)
  }
}
Các trường
logoUrl

string

Không bắt buộc. URL công khai của biểu trưng cho nhân viên hỗ trợ. Tối đa 50 KB.

Bạn không thể sửa đổi sau khi xác minh nhân viên hỗ trợ.
entryPointConfigs[]

object (BusinessMessagesEntryPointConfig)

Không bắt buộc. Danh sách cấu hình điểm truy cập.

Bạn không thể sửa đổi sau khi xác minh nhân viên hỗ trợ.
conversationalSettings

map (key: string, value: object (ConversationalSetting))

Bắt buộc. Chế độ cài đặt cuộc trò chuyện cho một nhân viên hỗ trợ, được liên kết với một ngôn ngữ. Ngôn ngữ được biểu thị bằng thẻ ngôn ngữ IETF BCP 47 được định dạng hợp lý.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
defaultLocale

string

Bắt buộc. Ngôn ngữ mặc định cho tác nhân. Phải khớp với ngôn ngữ được xác định trong conversationalSettings.
primaryAgentInteraction

object (SupportedAgentInteraction)

Bắt buộc. Thông tin về hoạt động tương tác của tác nhân chính. Được dùng khi người dùng bắt đầu một cuộc trò chuyện.
additionalAgentInteractions[]

object (SupportedAgentInteraction)

Không bắt buộc. Thông tin bổ sung về hoạt động tương tác của nhân viên hỗ trợ. Cho phép tác nhân hỗ trợ nhiều loại tương tác.
customAgentId

string

Không bắt buộc. Giá trị nhận dạng do đối tác chỉ định cho tác nhân. Mã nhận dạng này được truyền cùng với mọi tin nhắn gửi đến nhân viên hỗ trợ.
agentTestUrl
(deprecated)

string

Chỉ có đầu ra. URL để kiểm tra trải nghiệm trò chuyện của nhân viên hỗ trợ.

Do nền tảng xác định.
testUrls[]

object (TestUrl)

Chỉ có đầu ra. URL để kiểm tra trải nghiệm trò chuyện của nhân viên hỗ trợ.

Do nền tảng xác định.
phone

object (Phone)

Không bắt buộc. Số điện thoại để nhân viên hỗ trợ hiển thị. Nếu bạn không chỉ định, nhân viên hỗ trợ sẽ hiển thị số điện thoại của thương hiệu có trong Sơ đồ tri thức của Google (nếu có).
authorizationConfig

object (AuthorizationConfig)

Không bắt buộc. Cấu hình uỷ quyền cho việc hỗ trợ OAuth.
nonLocalConfig

object (NonLocalConfig)

Không bắt buộc. Cấu hình cho các điểm truy cập không phải cục bộ.
surveyConfig

object (SurveyConfig)

Không bắt buộc. Cấu hình để bật bản khảo sát tuỳ chỉnh.

BusinessMessagesEntryPointConfig

Cấu hình điểm truy cập cho một nhân viên hỗ trợ.

Biểu diễn dưới dạng JSON 
{
  "allowedEntryPoint": enum (EntryPoint)
}
Các trường
allowedEntryPoint

enum (EntryPoint)

Bắt buộc. Các nền tảng của Google mà nhân viên hỗ trợ được phép xuất hiện.

EntryPoint

Các nền tảng của Google mà nhân viên hỗ trợ được phép xuất hiện.

Enum
ENTRY_POINT_UNSPECIFIED Điểm truy cập chưa được chỉ định.
LOCATION Bật vị trí cho nhân viên hỗ trợ này.
NON_LOCAL Bật tính năng Business Messages cho các điểm truy cập không phải ở địa phương.

SupportedAgentInteraction

Các hoạt động tương tác được nhân viên hỗ trợ hỗ trợ.

Biểu diễn dưới dạng JSON 
{
  "interactionType": enum (InteractionType),

  // Union field representative can be only one of the following:
  "botRepresentative": {
    object (BotRepresentative)
  },
  "humanRepresentative": {
    object (HumanRepresentative)
  }
  // End of list of possible types for union field representative.
}
Các trường
interactionType

enum (InteractionType)

Bắt buộc. Loại tương tác mà nhân viên hỗ trợ hỗ trợ.
Trường nhóm representative. Thông tin chi tiết về loại cấu hình. Bắt buộc. representative chỉ có thể là một trong những trạng thái sau đây:
botRepresentative

object (BotRepresentative)

Thông tin chi tiết về người đại diện bot.
humanRepresentative

object (HumanRepresentative)

Thông tin chi tiết về nhân viên đại diện.

InteractionType

Loại tương tác được hỗ trợ cho nhân viên hỗ trợ.

Enum
INTERACTION_TYPE_UNSPECIFIED Lượt tương tác không xác định.
BOT Tương tác bot.
HUMAN Tương tác giữa con người.

BotRepresentative

Thông tin chi tiết về người đại diện bot.

Biểu diễn dưới dạng JSON 
{
  "botMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Các trường
botMessagingAvailability

object (MessagingAvailability)

Bắt buộc. Khả năng sử dụng tính năng nhắn tin bot.

MessagingAvailability

Giờ mỗi ngày trong tuần mà tính năng nhắn tin khả dụng. Bạn có thể nhóm các giờ cho nhiều ngày với nhau. Ví dụ: * 08:00–16:00 giờ PDT thứ Hai–thứ Tư * 10:00–14:00 giờ PDT thứ Năm–thứ Sáu * 15:00–18:00 giờ PDT thứ Năm–thứ Sáu * 10:00–14:00 giờ PDT thứ Bảy–thứ Sáu * 10:00–14:00 giờ PDT thứ Bảy–thứ Sáu

Nếu bị gián đoạn về tình trạng rảnh/bận, chẳng hạn như không có tình trạng rảnh/bận được chỉ định vào Chủ Nhật, thì tính năng nhắn tin sẽ không hoạt động trong những khoảng thời gian đó.

Giờ bot không ảnh hưởng đến tình trạng rảnh/bận. Nhân viên hỗ trợ chỉ dành cho bot luôn hiển thị tin nhắn chào mừng, còn nhân viên hỗ trợ có cả chế độ cài đặt đại diện cho bot và người đại diện chỉ xem xét người đại diện khi xác định tình trạng rảnh/bận.

Biểu diễn dưới dạng JSON 
{
  "hours": [
    {
      object (Hours)
    }
  ]
}
Các trường
hours[]

object (Hours)

Bắt buộc. Số giờ hỗ trợ qua tin nhắn.

Giờ

Khách hàng có thể nhắn tin trong một khoảng thời gian.

Biểu diễn dưới dạng JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "endTime": {
    object (TimeOfDay)
  },
  "timeZone": string,
  "startDay": enum (DayOfWeek),
  "endDay": enum (DayOfWeek)
}
Các trường
startTime

object (TimeOfDay)

Bắt buộc. Thời gian bắt đầu mỗi ngày nằm trong phạm vi ngày trong tuần.
endTime

object (TimeOfDay)

Bắt buộc. Thời gian kết thúc cho mỗi ngày nằm trong phạm vi ngày trong tuần.
timeZone

string

Bắt buộc. Múi giờ IANA cho giờ. Ví dụ: "Châu Mỹ/Los_Angeles".
startDay

enum (DayOfWeek)

Bắt buộc. Ngày bắt đầu.
endDay

enum (DayOfWeek)

Bắt buộc. Ngày kết thúc. Bao gồm ngày được chỉ định.

TimeOfDay

Đại diện cho thời gian trong ngày. Ngày và múi giờ không quan trọng hoặc được chỉ định ở nơi khác. API có thể chọn cho phép giây nhuận. Các loại có liên quan là google.type.Date và google.protobuf.Timestamp.

Biểu diễn dưới dạng JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Các trường
hours

integer

Giờ trong ngày ở định dạng 24 giờ. Nên ở trong khoảng từ 0 đến 23. API có thể chọn cho phép giá trị "24:00:00" trong các trường hợp như thời gian đóng cửa của doanh nghiệp.
minutes

integer

Số phút trong giờ trong ngày. Phải từ 0 đến 59.
seconds

integer

Số giây trong phút. Thông thường phải từ 0 đến 59. API có thể cho phép giá trị 60 nếu cho phép giây nhuận.
nanos

integer

Phân số giây tính bằng nano giây. Phải từ 0 đến 999.999.999.

DayOfWeek

Đại diện cho một ngày trong tuần.

Enum
DAY_OF_WEEK_UNSPECIFIED Chưa xác định ngày trong tuần.
MONDAY Thứ Hai
TUESDAY Thứ Ba
WEDNESDAY Thứ Tư
THURSDAY Thursday (thứ Năm)
FRIDAY Thứ Sáu
SATURDAY Saturday (thứ Bảy)
SUNDAY Chủ Nhật

HumanRepresentative

Thông tin chi tiết dành cho người đại diện.

Biểu diễn dưới dạng JSON 
{
  "humanMessagingAvailability": {
    object (MessagingAvailability)
  }
}
Các trường
humanMessagingAvailability

object (MessagingAvailability)

Bắt buộc. Khả năng sử dụng tính năng nhắn tin thủ công.

AuthorizationConfig

Thông tin chi tiết về cấu hình để hỗ trợ OAuth trên Business Messages.

Biểu diễn dưới dạng JSON 
{
  "endpointUrl": string
}
Các trường
endpointUrl

string

URL điểm cuối mà người dùng đăng nhập.

NonLocalConfig

Cấu hình để bật các điểm truy cập không phải cục bộ.

Biểu diễn dưới dạng JSON 
{
  "contactOption": {
    object (ContactOption)
  },
  "enabledDomains": [
    string
  ],
  "phoneNumber": {
    object (Phone)
  },
  "callDeflectionPhoneNumbers": [
    {
      object (Phone)
    }
  ],
  "regionCodes": [
    string
  ]
}
Các trường
contactOption

object (ContactOption)

Bắt buộc. Thông tin liên hệ của nhân viên hỗ trợ hiển thị bằng nút nhắn tin.
enabledDomains[]

string

Bắt buộc. Các miền cần bật cho điểm truy cập đường liên kết của trang web.
phoneNumber

object (Phone)

Bắt buộc. Số điện thoại của nhân viên hỗ trợ. Ghi đè trường phone cho các cuộc trò chuyện bắt đầu từ các điểm truy cập không phải cục bộ. Số điện thoại này sẽ được dùng cho tất cả các khu vực đã thiết lập.
callDeflectionPhoneNumbers[]

object (Phone)

Bắt buộc. Danh sách số điện thoại có thể dùng để chuyển hướng cuộc gọi.
regionCodes[]

string

Bắt buộc. Danh sách mã vùng CLDR cho những quốc gia mà nhân viên hỗ trợ được phép khởi chạy NON_LOCAL điểm truy cập. Bắt buộc đối với NON_LOCAL điểm truy cập.

ContactOption

Thông tin liên hệ hiển thị cùng với nút nhắn tin.

Biểu diễn dưới dạng JSON 
{
  "url": string,
  "options": [
    enum (Option)
  ]
}
Các trường
url

string

Bắt buộc. URL có các lựa chọn liên hệ.
options[]

enum (Option)

Bắt buộc. Danh sách tuỳ chọn liên hệ có sẵn cho URL được chỉ định.

Lựa chọn

Cách liên hệ.

Enum
OPTION_UNSPECIFIED Không xác định
WEB_CHAT Tùy chọn Trò chuyện trên web.
PHONE Tuỳ chọn điện thoại.
EMAIL Tuỳ chọn email.
FAQS Tuỳ chọn Câu hỏi thường gặp.
TWITTER Tuỳ chọn Twitter.
WHATSAPP Tuỳ chọn WhatsApp.

SurveyConfig

Thông tin chi tiết về cấu hình để hỗ trợ các câu hỏi khảo sát tuỳ chỉnh.

Biểu diễn dưới dạng JSON 
{
  "templateQuestionIds": [
    string
  ],
  "customSurveys": {
    string: {
      object (CustomSurveyConfig)
    },
    ...
  }
}
Các trường
templateQuestionIds[]

string

Danh sách mã câu hỏi mẫu cho các câu hỏi mẫu có trong bản khảo sát.
customSurveys

map (key: string, value: object (CustomSurveyConfig))

Câu hỏi khảo sát tuỳ chỉnh cho một nhân viên hỗ trợ, được liên kết với một ngôn ngữ. Ngôn ngữ được biểu thị bằng thẻ ngôn ngữ IETF BCP 47 được định dạng hợp lý.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

CustomSurveyConfig

Cấu hình khảo sát tuỳ chỉnh cho một nhân viên hỗ trợ.

Biểu diễn dưới dạng JSON 
{
  "customQuestions": [
    {
      object (SurveyQuestion)
    }
  ]
}
Các trường
customQuestions[]

object (SurveyQuestion)

Danh sách câu hỏi tuỳ chỉnh.

SurveyQuestion

Nội dung chi tiết của từng câu hỏi khảo sát.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "questionType": enum (Type),
  "questionContent": string,
  "responseOptions": [
    {
      object (SurveyResponse)
    }
  ]
}
Các trường
name

string

Bắt buộc. Mã nhận dạng duy nhất của câu hỏi.
questionType

enum (Type)

Chỉ có đầu ra. Loại câu hỏi.
questionContent

string

Bắt buộc. Nội dung câu hỏi. Tối đa 200 ký tự cho các câu hỏi tuỳ chỉnh.
responseOptions[]

object (SurveyResponse)

Bắt buộc. Danh sách câu trả lời hiển thị cùng với câu hỏi. Tối đa 12 ký tự.

Loại

Loại câu hỏi khảo sát.

Enum
TYPE_UNSPECIFIED Loại câu hỏi khảo sát không xác định.
GOOGLE_STANDARD_QUESTION Câu hỏi khảo sát tiêu chuẩn của Google.
GOOGLE_TEMPLATE_QUESTION Câu hỏi khảo sát mẫu do Google cung cấp.
PARTNER_CUSTOM_QUESTION Câu hỏi khảo sát tuỳ chỉnh dành cho đối tác.

SurveyResponse

Nội dung của một câu trả lời cho câu hỏi khảo sát.

Biểu diễn dưới dạng JSON 
{
  "content": string,
  "postbackData": string
}
Các trường
content

string

Bắt buộc. Văn bản xuất hiện trong bài khảo sát và được gửi lại cho nhân viên hỗ trợ khi người dùng nhấn vào văn bản đó. Tối đa 35 ký tự.
postbackData

string

Chuỗi mà tác nhân nhận được khi người dùng nhấn vào câu trả lời cho câu hỏi.

Phương thức

create

 Tạo nhân viên hỗ trợ mới để đại diện cho một thương hiệu.

delete

 Xoá nhân viên hỗ trợ.

get

 Nhận thông tin về một nhân viên hỗ trợ.

getLaunch

 Lấy thông tin ra mắt một nhân viên hỗ trợ.

getVerification

 Lấy thông tin xác minh cho một nhân viên hỗ trợ.

list

 Liệt kê tất cả các nhân viên hỗ trợ có liên kết với một thương hiệu.

patch

 Cập nhật thông tin về một nhân viên hỗ trợ.

requestLaunch

 Bắt đầu quy trình ra mắt một nhân viên hỗ trợ.

requestVerification

 Bắt đầu quy trình xác minh thông tin doanh nghiệp cho một nhân viên hỗ trợ.

updateLaunch

 Cập nhật thông tin ra mắt một nhân viên hỗ trợ.

updateVerification

 Cập nhật trạng thái xác minh cho một nhân viên hỗ trợ.