Tài nguyên: AgentMessage
Tin nhắn do nhân viên hỗ trợ gửi cho người dùng.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
Trường | |
---|---|
name |
Trường này do nền tảng RBM đặt. Đừng thêm thông tin này khi tạo tin nhắn của nhân viên hỗ trợ. Trường này phân giải "phones/{E.164}/agentMessages/{messageId}", trong đó {E.164} là số điện thoại của người dùng ở định dạng E.164 và {messageId} là mã nhận dạng do nhân viên hỗ trợ chỉ định cho thông báo của nhân viên hỗ trợ. |
sendTime |
Trường này do nền tảng RBM đặt. Đừng thêm thông tin này khi tạo tin nhắn của nhân viên hỗ trợ. Trường này phân giải thời gian gửi tin nhắn cho người dùng. Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: |
contentMessage |
Nội dung của tin nhắn do nhân viên hỗ trợ gửi. |
messageTrafficType |
Loại lưu lượng truy cập của thông báo. |
Trường nhóm
|
|
expireTime |
Không bắt buộc. Dấu thời gian theo giờ UTC cho biết thời điểm tài nguyên này được coi là hết hạn. Giá trị này được cung cấp trên đầu ra nếu được đặt hoặc nếu trường TTL được đặt. Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: |
ttl |
Không bắt buộc. Chỉ có đầu vào. Khoảng thời gian tin nhắn tồn tại trước khi tự động bị thu hồi. Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng " |
AgentContentMessage
Nội dung của một tin nhắn do nhân viên hỗ trợ gửi cho người dùng.
Biểu diễn dưới dạng JSON |
---|
{ "suggestions": [ { object ( |
Trường | |
---|---|
suggestions[] |
Một danh sách các câu trả lời và hành động đề xuất xuất hiện dưới dạng danh sách các đề xuất dạng chip sau tin nhắn của nhân viên hỗ trợ được liên kết. Tối đa 11 đề xuất. Các nút này chỉ xuất hiện khi tin nhắn liên quan của nhân viên hỗ trợ là tin nhắn gần đây nhất trong cuộc trò chuyện (bao gồm cả tin nhắn của nhân viên hỗ trợ và người dùng). Người dùng có thể nhấn vào một câu trả lời đề xuất để gửi câu trả lời bằng văn bản cho nhân viên hỗ trợ hoặc nhấn vào một hành động đề xuất để bắt đầu một hành động gốc trên thiết bị. Tối đa 11 đề xuất. |
Trường nhóm content . Nội dung của thông báo từ nhân viên hỗ trợ content chỉ có thể là một trong những nội dung sau: |
|
text |
Văn bản được mã hoá bằng UTF-8. Tối đa 3.072 ký tự. |
fileName |
Tên duy nhất của một tệp. Nền tảng RBM trả về tên tệp khi một nhân viên hỗ trợ tải tệp lên. Ngừng sử dụng và thay bằng uploadedRbmFile bên dưới |
uploadedRbmFile |
Chứa giá trị nhận dạng cho một tệp và hình thu nhỏ được tải lên và phân phát bởi máy chủ RBM |
richCard |
Thẻ thông tin chi tiết độc lập. |
contentInfo |
Thông tin về một tệp, bao gồm URL của tệp và URL của hình thu nhỏ của tệp. Nền tảng RBM phân phát nội dung từ bộ nhớ đệm, nhưng một nhân viên hỗ trợ có thể buộc nền tảng RBM tìm nạp phiên bản mới của nội dung và làm mới bộ nhớ đệm. |
UploadedRbmFile
Thông báo chứa thông tin về tệp và hình thu nhỏ
Biểu diễn dưới dạng JSON |
---|
{ "fileName": string, "thumbnailName": string } |
Trường | |
---|---|
fileName |
Tên của tệp do nền tảng RBM trả về khi tệp được tải lên. |
thumbnailName |
Tên của hình thu nhỏ, do nền tảng RBM trả về khi hình thu nhỏ được tải lên. |
RichCard
Một thẻ thông tin chi tiết độc lập hoặc một nhóm thẻ thông tin chi tiết do nhân viên hỗ trợ gửi cho người dùng.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường nhóm card . Thẻ độc lập hoặc băng chuyền thẻ. card chỉ có thể là một trong những trạng thái sau: |
|
carouselCard |
Băng chuyền thẻ. |
standaloneCard |
Thẻ độc lập. |
CarouselCard
Băng chuyền thẻ.
Biểu diễn dưới dạng JSON |
---|
{ "cardWidth": enum ( |
Trường | |
---|---|
cardWidth |
Chiều rộng của các thẻ trong băng chuyền. |
cardContents[] |
Danh sách nội dung cho từng thẻ trong băng chuyền. Băng chuyền có thể có tối thiểu 2 thẻ và tối đa 10 thẻ. |
CarouselCard.CardWidth
Chiều rộng của các thẻ trong băng chuyền.
Enum | |
---|---|
CARD_WIDTH_UNSPECIFIED |
Chưa chỉ định. |
SMALL |
120 DP. Xin lưu ý rằng bạn không thể sử dụng nội dung nghe nhìn dọc. |
MEDIUM |
232 DP. |
CardContent
Nội dung thẻ
Biểu diễn dưới dạng JSON |
---|
{ "title": string, "description": string, "media": { object ( |
Trường | |
---|---|
title |
(Không bắt buộc) Tiêu đề của thẻ. Tối đa 200 ký tự. |
description |
(Không bắt buộc) Nội dung mô tả thẻ. Tối đa 2.000 ký tự. |
media |
(Không bắt buộc) Nội dung nghe nhìn (hình ảnh, GIF, video, PDF) để đưa vào thẻ. |
suggestions[] |
(Không bắt buộc) Danh sách các đề xuất cần đưa vào thẻ. Tối đa 4 đề xuất. |
Nội dung nghe nhìn
Một tệp đa phương tiện trong thẻ thông tin chi tiết.
Biểu diễn dưới dạng JSON |
---|
{ "height": enum ( |
Trường | |
---|---|
height |
Chiều cao của nội dung nghe nhìn trong thẻ thông tin nhiều định dạng có bố cục dọc. Đối với thẻ độc lập có bố cục ngang, bạn không thể tuỳ chỉnh chiều cao và trường này sẽ bị bỏ qua. |
Trường nhóm content . Nội dung nghe nhìn content chỉ có thể là một trong những nội dung sau: |
|
fileName |
Tên duy nhất của tệp, do nền tảng RBM trả về khi tệp được tải lên. Ngừng sử dụng và thay bằng uploadedRbmFile bên dưới |
uploadedRbmFile |
Chứa giá trị nhận dạng cho một tệp và hình thu nhỏ được tải lên và phân phát bởi máy chủ RBM |
contentInfo |
Thông tin về một tệp, bao gồm URL của tệp và URL của hình thu nhỏ của tệp. Nền tảng RBM phân phát nội dung từ bộ nhớ đệm, nhưng một nhân viên hỗ trợ có thể buộc nền tảng RBM tìm nạp phiên bản mới của nội dung và làm mới bộ nhớ đệm. |
ContentInfo
Thông báo chứa thông tin về nội dung.
Biểu diễn dưới dạng JSON |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
Trường | |
---|---|
fileUrl |
URL có thể truy cập công khai của tệp. Nền tảng RBM xác định loại MIME của tệp từ trường content-type trong tiêu đề HTTP khi nền tảng tìm nạp tệp. Trường content-type phải có và chính xác trong phản hồi HTTP từ URL. Kích thước tệp tối đa được đề xuất là 100 MB. Lưu ý: URL tệp không hỗ trợ lệnh chuyển hướng. Vui lòng sử dụng CreateFileRequest nếu cần chuyển hướng. |
thumbnailUrl |
(Không bắt buộc, chỉ dành cho tệp hình ảnh, âm thanh và video) URL công khai có thể truy cập của hình thu nhỏ. Kích thước tối đa là 100 kB. Nếu bạn không cung cấp URL hình thu nhỏ, nền tảng RBM sẽ hiển thị một hình thu nhỏ phần giữ chỗ trống cho đến khi thiết bị của người dùng tải tệp xuống. Tuỳ thuộc vào chế độ cài đặt của người dùng, tệp có thể không tự động tải xuống và có thể yêu cầu người dùng nhấn vào nút tải xuống. Lưu ý: URL tệp không hỗ trợ lệnh chuyển hướng. Vui lòng sử dụng CreateFileRequest nếu cần chuyển hướng. |
forceRefresh |
Nếu được đặt, nền tảng RBM sẽ tìm nạp tệp và hình thu nhỏ từ các URL được chỉ định, ngay cả khi nền tảng có bản sao được lưu vào bộ nhớ đệm của tệp (và/hoặc của hình thu nhỏ). |
Media.Height
Chiều cao phương tiện
Enum | |
---|---|
HEIGHT_UNSPECIFIED |
Chưa chỉ định. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 DP. Không dùng được cho băng chuyền thẻ đa dạng khi chiều rộng thẻ được đặt thành nhỏ. |
Đề xuất
Câu trả lời hoặc hành động được đề xuất có trong thẻ thông tin hoặc trong danh sách đề xuất dạng chip.
Biểu diễn dưới dạng JSON |
---|
{ // Union field |
Trường | |
---|---|
Trường nhóm option . Câu trả lời đề xuất hoặc thao tác đề xuất option chỉ có thể là một trong những nội dung sau: |
|
reply |
Người dùng có thể nhấn vào một câu trả lời được đề xuất để gửi câu trả lời bằng văn bản cho nhân viên hỗ trợ. |
action |
Người dùng có thể nhấn vào một thao tác đề xuất để bắt đầu thao tác tương ứng trên thiết bị. |
SuggestedReply
Khi được nhấn, nút này sẽ gửi câu trả lời bằng văn bản cho nhân viên hỗ trợ.
Biểu diễn dưới dạng JSON |
---|
{ "text": string, "postbackData": string } |
Trường | |
---|---|
text |
Văn bản xuất hiện trong câu trả lời đề xuất và được gửi lại cho nhân viên hỗ trợ khi người dùng nhấn vào. Tối đa 25 ký tự. |
postbackData |
Tải trọng được mã hoá base64 mà tác nhân nhận được trong một sự kiện người dùng khi người dùng nhấn vào câu trả lời đề xuất. |
SuggestedAction
Khi được nhấn, sẽ bắt đầu thao tác gốc tương ứng trên thiết bị.
Biểu diễn dưới dạng JSON |
---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
Trường | |
---|---|
text |
Văn bản xuất hiện trong hành động đề xuất. Tối đa 25 ký tự. |
postbackData |
Tải trọng (được mã hoá base64) sẽ được gửi đến nhân viên hỗ trợ trong sự kiện người dùng xảy ra khi người dùng nhấn vào hành động được đề xuất. Tối đa 2048 ký tự. |
fallbackUrl |
(Không bắt buộc) URL dự phòng để sử dụng nếu ứng dụng không hỗ trợ một hành động được đề xuất. Các URL dự phòng sẽ mở trong cửa sổ trình duyệt mới. Phải là một URI hợp lệ như được xác định trong RFC 3986. Tối đa 2048 ký tự. |
Trường nhóm action . Thao tác gốc được bắt đầu trên thiết bị khi người dùng nhấn vào thao tác được đề xuất action chỉ có thể là một trong những thao tác sau: |
|
dialAction |
Mở ứng dụng quay số mặc định của người dùng và điền sẵn số điện thoại do nhân viên hỗ trợ chỉ định. |
viewLocationAction |
Mở ứng dụng bản đồ mặc định của người dùng và chọn vị trí do trợ lý ảo chỉ định hoặc tìm kiếm xung quanh vị trí của người dùng dựa trên một cụm từ tìm kiếm do trợ lý ảo chỉ định. |
createCalendarEventAction |
Mở ứng dụng lịch mặc định của người dùng và bắt đầu quy trình tạo sự kiện mới trên lịch với dữ liệu sự kiện do tác nhân chỉ định được điền sẵn. |
openUrlAction |
Mở ứng dụng trình duyệt web mặc định của người dùng đến URL đã cho. Nếu người dùng đã cài đặt một ứng dụng được đăng ký làm trình xử lý mặc định cho URL, thì ứng dụng này sẽ được mở thay thế và biểu tượng của ứng dụng sẽ được dùng trong giao diện người dùng của hành động được đề xuất. |
shareLocationAction |
Mở trình chọn vị trí của ứng dụng RCS để người dùng có thể chọn một vị trí để gửi cho tác nhân. |
DialAction
Mở ứng dụng quay số mặc định của người dùng và điền sẵn số điện thoại do nhân viên hỗ trợ chỉ định.
Biểu diễn dưới dạng JSON |
---|
{ "phoneNumber": string } |
Trường | |
---|---|
phoneNumber |
Số điện thoại ở định dạng E.164, ví dụ: +12223334444. |
ViewLocationAction
Mở ứng dụng bản đồ mặc định của người dùng và chọn vị trí do trợ lý ảo chỉ định hoặc tìm kiếm xung quanh vị trí của người dùng dựa trên một cụm từ tìm kiếm do trợ lý ảo chỉ định.
Biểu diễn dưới dạng JSON |
---|
{
"latLong": {
object ( |
Trường | |
---|---|
latLong |
(Không bắt buộc) Vĩ độ và kinh độ của vị trí được chỉ định. |
label |
(Không bắt buộc) Nhãn của ghim được thả tại latLong. |
query |
(Không bắt buộc, chỉ được hỗ trợ trên ứng dụng Android Messages) Thay vì chỉ định latLong (và nhãn không bắt buộc), nhân viên hỗ trợ có thể chỉ định một chuỗi truy vấn. Đối với các ứng dụng bản đồ mặc định có hỗ trợ chức năng tìm kiếm (bao gồm cả Google Maps), khi người dùng nhấn vào thao tác được đề xuất này, kết quả sẽ là một cụm từ tìm kiếm vị trí tập trung vào vị trí hiện tại của người dùng. Nếu truy vấn đủ cụ thể, thì các tác nhân có thể sử dụng truy vấn đó để chọn bất kỳ vị trí nào trên thế giới. Ví dụ: việc đặt chuỗi truy vấn thành "Growing Tree Bank" sẽ cho thấy tất cả các vị trí của Growing Tree Bank ở gần người dùng. Việc đặt chuỗi truy vấn thành "1600 Amphitheater Parkway, Mountain View, CA 94043" sẽ chọn địa chỉ cụ thể đó, bất kể vị trí của người dùng. |
LatLng
Một đối tượng đại diện cho cặp vĩ độ/kinh độ. Thông tin này được biểu thị dưới dạng một cặp số có độ chính xác gấp đôi để biểu thị vĩ độ và kinh độ theo độ. Trừ phi có quy định khác, đối tượng này phải tuân thủ tiêu chuẩn WGS84. Giá trị phải nằm trong phạm vi được chuẩn hoá.
Biểu diễn dưới dạng JSON |
---|
{ "latitude": number, "longitude": number } |
Trường | |
---|---|
latitude |
Vĩ độ tính bằng độ. Giá trị này phải nằm trong khoảng [-90.0, +90.0]. |
longitude |
Kinh độ tính bằng độ. Giá trị này phải nằm trong khoảng [-180.0, +180.0]. |
CreateCalendarEventAction
Mở ứng dụng lịch mặc định của người dùng và bắt đầu quy trình tạo sự kiện mới trên lịch với dữ liệu sự kiện do tác nhân chỉ định được điền sẵn.
Biểu diễn dưới dạng JSON |
---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
Trường | |
---|---|
startTime |
Thời gian bắt đầu sự kiện. Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: |
endTime |
Thời gian kết thúc sự kiện. Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: |
title |
Tiêu đề sự kiện. Tối đa 100 ký tự. |
description |
Nội dung mô tả sự kiện. Tối đa 500 ký tự. |
OpenUrlAction
Mở ứng dụng trình duyệt web mặc định của người dùng đến URL đã chỉ định. Nếu người dùng đã cài đặt một ứng dụng được đăng ký làm trình xử lý mặc định cho URL, thì ứng dụng này sẽ được mở thay thế và biểu tượng của ứng dụng sẽ được dùng trong giao diện người dùng của hành động được đề xuất.
Biểu diễn dưới dạng JSON |
---|
{ "url": string, "application": enum ( |
Trường | |
---|---|
url |
URL cần mở. Kể từ ngày 1 tháng 11 năm 2025, giao thức URL phải là https:// hoặc http://. Các yêu cầu API sử dụng bất kỳ lược đồ nào khác (ví dụ: tel:, mailto:, sms:) sẽ bị từ chối kèm theo lỗi 400 Bad Request sau ngày này. URL phải là một URI hợp lệ như được xác định trong RFC 3986. Tối đa 2048 ký tự. |
application |
Ứng dụng, trình duyệt hoặc khung hiển thị web mở URL. Để kiểm tra xem thiết bị của người dùng có hỗ trợ chế độ webview hay không, trước tiên, hãy chạy quy trình kiểm tra khả năng. Hãy xem tài liệu để biết thông tin chi tiết: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities. |
webviewViewMode |
Chế độ xem cho webview |
description |
Nội dung mô tả hỗ trợ tiếp cận cho webview. |
OpenUrlApplication
Loại ứng dụng mở URL
Enum | |
---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
Không chỉ định, sẽ dùng trình duyệt để mở. |
BROWSER |
Sử dụng trình duyệt để mở URL. |
WEBVIEW |
Mở URL trong cửa sổ chế độ xem web tích hợp |
WebviewViewMode
Loại chế độ xem của webview.
Enum | |
---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
Chưa chỉ định. Để sử dụng webview, bạn phải chỉ định một chế độ xem. |
FULL |
Yêu cầu lớp phủ toàn màn hình có cuộc trò chuyện với Chatbot được gắn nhãn trong thanh trạng thái. |
HALF |
Cần có lớp phủ nửa màn hình. |
TALL |
Yêu cầu lớp phủ màn hình ba phần tư. |
StandaloneCard
Thẻ độc lập
Biểu diễn dưới dạng JSON |
---|
{ "cardOrientation": enum ( |
Trường | |
---|---|
cardOrientation |
Hướng của thẻ. |
thumbnailImageAlignment |
Căn chỉnh bản xem trước hình ảnh cho các thẻ độc lập có bố cục ngang. |
cardContent |
Nội dung thẻ. |
StandaloneCard.CardOrientation
Hướng của thẻ.
Enum | |
---|---|
CARD_ORIENTATION_UNSPECIFIED |
Chưa chỉ định. |
HORIZONTAL |
Bố cục ngang. Nếu |
VERTICAL |
Bố cục dọc. |
StandaloneCard.ThumbnailImageAlignment
Căn chỉnh bản xem trước hình ảnh cho các thẻ độc lập có bố cục ngang.
Enum | |
---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
Chưa chỉ định. |
LEFT |
Bản xem trước tệp được căn trái. |
RIGHT |
Bản xem trước tệp được căn phải. |
MessageTrafficType
Các loại lưu lượng truy cập thông báo được hỗ trợ. Enum này sẽ được mở rộng để hỗ trợ các loại lưu lượng truy cập khác.
Enum | |
---|---|
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED |
Hành vi mặc định: Loại lưu lượng truy cập tin nhắn được xác định theo trường hợp sử dụng của nhân viên hỗ trợ. Cập nhật loại lưu lượng truy cập nếu cần dựa trên nội dung thông báo. Đối với các tác nhân đa năng, không có giá trị mặc định nào được cung cấp. Bạn phải đặt loại lưu lượng truy cập theo cách thủ công (ví dụ: TRANSACTION, PROMOTION). |
AUTHENTICATION |
Đối với thông báo xác thực trong trường hợp sử dụng tác nhân OTP. |
TRANSACTION |
Đối với tin nhắn giao dịch trong các trường hợp sử dụng Nhân viên hỗ trợ giao dịch hoặc Nhân viên hỗ trợ đa năng. |
PROMOTION |
Đối với tin nhắn khuyến mãi trong các trường hợp sử dụng là khuyến mãi hoặc tác nhân đa năng. |
SERVICEREQUEST |
Đối với những thông báo về các dịch vụ mà người dùng đã đồng ý nhận. Được dùng trong các trường hợp sử dụng OTP, Giao dịch, Quảng bá hoặc Tác nhân đa năng. |
ACKNOWLEDGEMENT |
Đối với những thông báo xác nhận yêu cầu huỷ đăng ký của người dùng. Được dùng trong các trường hợp sử dụng OTP, Giao dịch, Quảng bá hoặc Tác nhân đa năng. |
Phương thức |
|
---|---|
|
Gửi tin nhắn từ nhân viên hỗ trợ đến người dùng. |
|
Thu hồi tin nhắn của nhân viên hỗ trợ đã được gửi nhưng chưa được chuyển đi. |