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)
  },
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}
Trường
name

string

Giá trị nhận dạng duy nhấ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ợ hiển thị cho 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 hợp detail_info. Chứa các trường bắt buộc đối với 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:
businessMessagesAgent

object (BusinessMessagesAgent)

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

object (RcsBusinessMessagingAgent)

Thông tin chi tiết về nhân viên hỗ trợ cho RCS Business Messaging.

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 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ác 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. Các chế độ cài đặt cuộc trò chuyện của một nhân viên hỗ trợ, được ánh xạ theo 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 đúng.

Đố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 nhân viên hỗ trợ 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 được chuyển cùng với tất cả tin nhắn gửi đến nhân viên hỗ trợ.
agentTestUrl
(deprecated)

string

Chỉ có đầu ra. URL để kiểm thử 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 mà nhân viên hỗ trợ sẽ hiển thị. Nếu 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 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. Định 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. Nền tảng của Google mà nhân viên hỗ trợ được cho phép xuất hiện trên đó.

EntryPoint

Nền tảng của Google mà nhân viên hỗ trợ được cho phép xuất hiện trê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 Business Messages cho các điểm truy cập không phải tạ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.
}
Trường
interactionType

enum (InteractionType)

Bắt buộc. Loại tương tác được nhân viên hỗ trợ hỗ trợ.
Trường 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:
botRepresentative

object (BotRepresentative)

Chi tiết về đạ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 của bot.
HUMAN Hoạt động tương tác của con người.

BotRepresentative

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

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

object (MessagingAvailability)

Bắt buộc. Tính năng nhắn tin bot.

MessagingAvailability

Giờ mỗi ngày trong tuần có thể sử dụng tính năng nhắn tin. Bạn có thể nhóm 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ứ 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ó thời gian rảnh đượ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ị thông báo chào mừng, trong khi nhân viên hỗ trợ có cả cài đặt người đại diện và người đại diện bot 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)
    }
  ]
}
Trường
hours[]

object (Hours)

Bắt buộc. Những giờ hỗ trợ bạn qua tin nhắn.

Giờ

Tính năng nhắn tin có thể được hỗ trợ 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)
}
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ụ: "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 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 nằm trong khoảng từ 0 đến 23. 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

Phút trong giờ trong ngày. Giá trị phải nằm trong khoảng từ 0 đến 59.
seconds

integer

Số giây trong phút của thời gian. 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. 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 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 của người đại diện.

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

object (MessagingAvailability)

Bắt buộc. Khả 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
}
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 mọi khu vực đã thiết lập.
callDeflectionPhoneNumbers[]

object (Phone)

Bắt buộc. Danh sách số điện thoại để thay đổi 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 chạy điểm truy cập NON_LOCAL. Bắt buộc đối với NON_LOCAL điểm truy cập.

ContactOption

Thông tin liên hệ hiển thị 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 lựa chọn liên hệ.
options[]

enum (Option)

Bắt buộc. Danh sách cách 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 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 Twitter.
WHATSAPP Tuỳ chọn WhatsApp.

SurveyConfig

Chi tiết 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 đưa vào 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 theo 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 đúng.

Đố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 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 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)
    }
  ]
}
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. Giới hạn trong 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 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 một 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ản 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.

RcsBusinessMessagingAgent

Thông tin về nhân viên hỗ trợ có liên quan cụ thể đến RCS Business Messaging.

Biểu diễn dưới dạng JSON 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion)
}
Trường
description

string

Bắt buộc. Nội dung mô tả về tác nhân mà người dùng nhìn thấy. Tối đa 100 ký tự.
logoUri

string

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ợ.
heroUri

string

Bắt buộc. URL công khai của hình ảnh chính cho nhân viên hỗ trợ. Tối đa 200 KB.

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

object (PhoneEntry)

Bắt buộc. Số điện thoại liên kết với nhân viên hỗ trợ.
emails[]

object (EmailEntry)

Không bắt buộc. Địa chỉ email liên kết với nhân viên hỗ trợ.
websites[]

object (WebEntry)

Không bắt buộc. Các trang web được liên kết với nhân viên hỗ trợ đó. Tối đa 3.
privacy

object (WebEntry)

Bắt buộc. Chính sách quyền riêng tư liên kết với nhân viên hỗ trợ.
termsConditions

object (WebEntry)

Bắt buộc. Điều khoản và điều kiện liên quan đến nhân viên hỗ trợ.
color

string

Bắt buộc. Màu giao diện của tác nhân mà người dùng nhìn thấy ở định dạng hệ thập lục phân. Ví dụ: #FF6347.
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

Bắt buộc. Cấu hình mục thanh toán cho nhân viên hỗ trợ.
agentUseCase

enum (AgentUseCase)

Không bắt buộc. Trường hợp sử dụng bot.
hostingRegion

enum (HostingRegion)

Bắt buộc. Khu vực lưu trữ của một nhân viên hỗ trợ.

PhoneEntry

Số điện thoại liên kết với nhân viên hỗ trợ.

Biểu diễn dưới dạng JSON 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
Trường
phoneNumber

object (Phone)

Bắt buộc. Số điện thoại ở định dạng E.164. Ví dụ: +12223334444.
label

string

Bắt buộc. Nhãn cho số điện thoại.

EmailEntry

Email liên kết với nhân viên hỗ trợ.

Biểu diễn dưới dạng JSON 
{
  "address": string,
  "label": string
}
Trường
address

string

Bắt buộc. Địa chỉ email.
label

string

Bắt buộc. Nhãn cho địa chỉ email.

WebEntry

Tài nguyên dựa trên nền tảng web được liên kết với tác nhân.

Biểu diễn dưới dạng JSON 
{
  "uri": string,
  "label": string
}
Trường
uri

string

Bắt buộc. URI có thể truy cập công khai được liên kết với tác nhân. Phải sử dụng giao thức HTTP hoặc HTTPS.
label

string

Không bắt buộc. Nhãn cho URI.

RcsBusinessMessagingAgentBillingConfig

Cấu hình mục thanh toán cho nhân viên hỗ trợ.

Biểu diễn dưới dạng JSON 
{
  "billingCategory": enum (BillingCategory)
}
Trường
billingCategory

enum (BillingCategory)

Danh mục thanh toán cho nhân viên hỗ trợ.

BillingCategory

Danh mục thanh toán được hỗ trợ.

Enum
BILLING_CATEGORY_UNSPECIFIED Chưa chỉ định danh mục.
CONVERSATIONAL_LEGACY Danh mục cũ để hỗ trợ cấu hình thanh toán của nhân viên hỗ trợ hiện có.
CONVERSATIONAL Được thiết kế cho các phiên dài hơn, phức tạp hơn khi người dùng và thương hiệu trao đổi một loạt tin nhắn.
SINGLE_MESSAGE Thay thế SMS bằng trải nghiệm nhắn tin phong phú hơn. Không bao giờ tính phí dưới dạng CONVERSATIONAL.
BASIC_MESSAGE Mô hình thanh toán tương tự như SMS. Không bao giờ tính phí dưới dạng CONVERSATIONAL.

AgentUseCase

Các loại trường hợp sử dụng của tác nhân được dùng trong bộ nhớ.

Enum
AGENT_USE_CASE_UNSPECIFIED Chưa chỉ định trường hợp sử dụng.
TRANSACTIONAL Nhân viên hỗ trợ chỉ gửi những tin nhắn cần thiết, cần thiết và cần xử lý kịp thời.
PROMOTIONAL Đại lý gửi thư bán hàng, tiếp thị và quảng cáo. Loại mặc định.
OTP Nhân viên hỗ trợ chỉ gửi mật khẩu một lần.
MULTI_USE Tác nhân có nhiều trường hợp sử dụng.

HostingRegion

Các khu vực lưu trữ có thể có của một nhân viên hỗ trợ, dùng để định tuyến tin nhắn P2A đến máy chủ được phân vùng một cách chính xác.

Enum
HOSTING_REGION_UNSPECIFIED Khu vực lưu trữ chưa được chỉ định.
NORTH_AMERICA Bắc Mỹ.
EUROPE Châu Âu.
ASIA_PACIFIC Châu Á Thái Bình Dương.

Phương thức

create

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

delete
(deprecated)

 Không dùng nữa: tính năng xoá nhân viên hỗ trợ không còn được dùng nữa.

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

getVerification

 Lấy thông tin xác minh của 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ề 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 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ợ.