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.
}
Trường
name

string

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

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

string

Bắt buộc. Tên mà nhân viên hỗ trợ 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 kết hợp detail_info. Chứa các trường bắt buộc đối với một 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ợ cho Business Messages.

BusinessMessagesAgent

Thông tin về 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)
  }
}
Trường
logoUrl

string

Không bắt buộc. URL công khai của biểu trưng dành 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 trò chuyện của 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 một thẻ ngôn ngữ IETF BCP 47 được định dạng đúng.

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 một 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 khác về việc tương tác với 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 nhân viên hỗ trợ. Giá trị nhận dạng này được chuyển cùng với mọi tin nhắn gửi cho 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 không được 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 để 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)
}
Trường
allowedEntryPoint

enum (EntryPoint)

Bắt buộc. Google sẽ cho phép nhân viên hỗ trợ xuất hiện trên đó.

EntryPoint

Google sẽ cho phép nhân viên hỗ trợ xuất hiện trên đó.

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

SupportedAgentInteraction

Các hoạt động tương tác được một 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.
}
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 kết hợp 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 của 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 Tương tác không xác định.
BOT Tương tác với bot.
HUMAN Sự tương tác của con người.

BotRepresentative

Thông tin chi tiết cho người đại diện của bot.

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

object (MessagingAvailability)

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

MessagingAvailability

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

Nếu bị gián đoạn về tình trạng rảnh/bận, chẳng hạn như không được chỉ định thời gian rả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ỉ bot luôn hiển thị tin nhắn chào mừng, trong khi các nhân viên hỗ trợ có cả chế độ cài đặt của cả người dùng lẫn bot đại diện chỉ xem xét những người đại diện là con người khi xác định tình trạng rảnh/bận.

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

object (Hours)

Bắt buộc. Giờ hỗ trợ nhắn tin.

Giờ

Tính năng nhắn tin trong phạm vi giờ hoạt động.

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

object (TimeOfDay)

Bắt buộc. Thời gian bắt đầu cho mỗi ngày 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 trong phạm vi ngày trong tuần.
timeZone

string

Bắt buộc. Múi giờ IANA cho giờ. Ví dụ: "America/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 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
}
Trường
hours

integer

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

integer

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

integer

Số giây của thời gian. Giá trị thường phải từ 0 đến 59. Một API có thể cho phép giá trị 60 nếu cho phép bật-giây.
nanos

integer

Các phân số của giây tính bằng nano giây. Giá trị phải nằm trong khoảng từ 0 đến 999.999.999.

DayOfWeek

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

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

HumanRepresentative

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

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

object (MessagingAvailability)

Bắt buộc. Phạm vi cung cấp tính năng nhắn tin do con người thực hiện.

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
}
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
  ]
}
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ả khu vực đã thiết lập.
callDeflectionPhoneNumbers[]

object (Phone)

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

string

Bắt buộc. Danh sách mã vùng CLDR của những quốc gia mà nhân viên hỗ trợ được phép triển khai 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ệ sẽ xuất hiện ngoài nút nhắn tin.

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

string

Bắt buộc. URL có các tùy 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 đã chỉ định.

Phương thức

Lựa chọn 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 Câu hỏi thường gặp.
TWITTER Tùy 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)
    },
    ...
  }
}
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 một bản khảo sát.
customSurveys

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

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

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 dành cho một nhân viên hỗ trợ.

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

object (SurveyQuestion)

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

SurveyQuestion

Nội dung chi tiết của mỗi 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)
    }
  ]
}
Trường
name

string

Bắt buộc. Giá trị 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ự đối với các câu hỏi tuỳ chỉnh.
responseOptions[]

object (SurveyResponse)

Bắt buộc. Danh sách câu trả lời xuất hiện kèm theo 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 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
}
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à nhân viên hỗ trợ 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á một nhân viên hỗ trợ.

get

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

getLaunch

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

getVerification

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

list

 Liệt kê tất cả nhân viên hỗ trợ 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 cho một nhân viên hỗ trợ.

requestVerification

 Bắt đầu 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 cho 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ợ.