REST Resource: phones.agentMessages

Tài nguyên: AgentMessage

Tin nhắn được gửi từ nhân viên hỗ trợ cho người dùng.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
Trường
name

string

Trường này do nền tảng RBM đặt. Đừng đưa thông tin này vào 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ã do nhân viên hỗ trợ chỉ định cho tin nhắn của nhân viên hỗ trợ.
sendTime

string (Timestamp format)

Trường này do nền tảng RBM đặt. Đừng đưa thông tin này vào khi tạo tin nhắn của nhân viên hỗ trợ. Trường này giải quyết thời điểm khi thông báo được gửi tới người dùng.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
contentMessage

object (AgentContentMessage)

Nội dung tin nhắn của nhân viên hỗ trợ.

Trường hợp expiration.

expiration chỉ có thể là một trong những trạng thái sau:
expireTime

string (Timestamp format)

Không bắt buộc. Dấu thời gian theo giờ UTC về 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 bạn đã đặt giá trị này hoặc đặt trường TTL.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
ttl

string (Duration format)

Không bắt buộc. Chỉ nhập. Khoảng thời gian thông báo sẽ tồn tại trước khi tự động bị thu hồi.

Thời lượng tính bằng giây với tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".

AgentContentMessage

Nội dung tin nhắn từ nhân viên hỗ trợ cho người dùng.

Biểu diễn dưới dạng JSON 
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ],

  // Union field content can be only one of the following:
  "text": string,
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "richCard": {
    object (RichCard)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Trường
suggestions[]

object (Suggestion)

Danh sách câu trả lời đề xuất và hành động được đề xuất xuất hiện dưới dạng danh sách khối đề xuất 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 khối chỉ hiển thị khi tin nhắn của nhân viên hỗ trợ được liên kết 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à tin nhắn của người dùng). Người dùng có thể nhấn vào một tin nhắn trả lời đề xuất để gửi tin nhắn 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 được đề xuất để bắt đầu một hành động gốc trên thiết bị.
Trường hợp content. Nội dung tin nhắn của nhân viên hỗ trợ content chỉ được có một trong những nội dung sau:
text

string

Văn bản được mã hoá theo UTF-8.
fileName
(deprecated)

string

Tên duy nhất của tệp. Nền tảng RBM trả về tên tệp khi nhân viên hỗ trợ tải tệp lên. Ngừng sử dụng và thay vào đó là uploadedRbmFile ở bên dưới
uploadedRbmFile

object (UploadedRbmFile)

Chứa giá trị nhận dạng của một tệp và hình thu nhỏ được máy chủ RBM tải lên và phân phát
richCard

object (RichCard)

Một thẻ thông tin độc lập.
contentInfo

object (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ối nội dung từ bộ nhớ đệm, nhưng tác nhân người dùng có thể buộc nền tảng RBM tìm nạp phiên bản nội dung mới 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

string

Tên của tệp, được nền tảng RBM trả về khi tệp được tải lên.
thumbnailName

string

Tên của hình thu nhỏ mà nền tảng RBM trả về khi hình thu nhỏ được tải lên.

RichCard

Một thẻ thông tin độc lập hoặc một băng chuyền gồm các thẻ thông tin được gửi từ nhân viên hỗ trợ cho người dùng.

Biểu diễn dưới dạng JSON 
{

  // Union field card can be only one of the following:
  "carouselCard": {
    object (CarouselCard)
  },
  "standaloneCard": {
    object (StandaloneCard)
  }
  // End of list of possible types for union field card.
}
Trường
Trường hợp card. Thẻ độc lập hoặc băng chuyền gồm các thẻ. card chỉ có thể là một trong những trạng thái sau:
carouselCard

object (CarouselCard)

Băng chuyền thẻ.
standaloneCard

object (StandaloneCard)

Thẻ độc lập.

CarouselCard

Băng chuyền thẻ.

Biểu diễn dưới dạng JSON 
{
  "cardWidth": enum (CarouselCard.CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
Trường
cardWidth

enum (CarouselCard.CardWidth)

Chiều rộng của thẻ trong băng chuyền.
cardContents[]

object (CardContent)

Danh sách nội dung cho từng thẻ trong băng chuyền. Một 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 thẻ trong băng chuyền.

Enum
CARD_WIDTH_UNSPECIFIED Chưa chỉ định.
SMALL 120 DP. Lưu ý rằng không thể sử dụng nội dung nghe nhìn có chiều cao.
MEDIUM 232 DP.

CardContent

Nội dung thẻ

Biểu diễn dưới dạng JSON 
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
Trường
title

string

(Không bắt buộc) Tiêu đề của thẻ. Tối đa 200 ký tự.
description

string

(Không bắt buộc) Nội dung mô tả thẻ. Tối đa 2000 ký tự.
media

object (Media)

(Không bắt buộc) Nội dung nghe nhìn (hình ảnh, ảnh GIF, video) để đưa vào thẻ.
suggestions[]

object (Suggestion)

(Không bắt buộc) Danh sách các nội dung đề xuất để đưa vào thẻ. Tối đa 4 đề xuất.

Nội dung nghe nhìn

Một tệp nội dung nghe nhìn trong thẻ thông tin.

Biểu diễn dưới dạng JSON 
{
  "height": enum (Media.Height),

  // Union field content can be only one of the following:
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Trường
height

enum (Media.Height)

Chiều cao của nội dung nghe nhìn trong thẻ thông tin có bố cục dọc. Đối với thẻ độc lập có bố cục ngang, thẻ không thể tuỳ chỉnh chiều cao và trường này sẽ bị bỏ qua.
Trường hợp content. Nội dung đa phương tiện content chỉ có thể là một trong những nội dung sau:
fileName
(deprecated)

string

Tên duy nhất của tệp, được nền tảng RBM trả về khi tệp được tải lên. Ngừng sử dụng và thay vào đó là uploadedRbmFile ở bên dưới
uploadedRbmFile

object (UploadedRbmFile)

Chứa giá trị nhận dạng của một tệp và hình thu nhỏ được máy chủ RBM tải lên và phân phát
contentInfo

object (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ối nội dung từ bộ nhớ đệm, nhưng tác nhân người dùng có thể buộc nền tảng RBM tìm nạp phiên bản nội dung mới và làm mới bộ nhớ đệm.

ContentInfo

Thư chứa thông tin nội dung.

Biểu diễn dưới dạng JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean
}
Trường
fileUrl

string

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 loại nội dung trong tiêu đề HTTP khi nền tảng tìm nạp tệp. Trường content-type phải hiện diện và chính xác trong phản hồi HTTP từ URL. Kích thước tệp tối đa nên dùng là 100 MB.
thumbnailUrl

string

(Không bắt buộc, chỉ đối với tệp hình ảnh và tệp video) URL có thể truy cập công khai 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ỏ của 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ỳ 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.
forceRefresh

boolean

Nếu bạn đặt chính sách này, 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ó các bản sao của tệp (và/hoặc hình thu nhỏ) đã lưu vào bộ nhớ đệm.

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ẻ thông tin khi chiều rộng thẻ được đặt thành nhỏ.

Đề xuất

Một câu trả lời đề xuất hoặc hành động được đề xuất nằm trong một thẻ thông tin hoặc trong danh sách khối đề xuất.

Biểu diễn dưới dạng JSON 
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  }
  // End of list of possible types for union field option.
}
Trường
Trường hợp option. Câu trả lời đề xuất hoặc hành động được đề xuất option chỉ có thể là một trong những nội dung sau:
reply

object (SuggestedReply)

Người dùng có thể nhấn vào một tin nhắn trả lời đề xuất để gửi tin nhắn trả lời bằng tin nhắn cho nhân viên hỗ trợ.
action

object (SuggestedAction)

Người dùng có thể nhấn vào một hành động đề xuất để bắt đầu hành động gốc tương ứng trên thiết bị.

SuggestedReply

Khi được nhấn, hãy gửi lại tin nhắn 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

string

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

string

Tải trọng được mã hoá base64 mà tác nhân sẽ nhận được trong một sự kiện của 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 hành động 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 action can be only one of the following:
  "dialAction": {
    object (DialAction)
  },
  "viewLocationAction": {
    object (ViewLocationAction)
  },
  "createCalendarEventAction": {
    object (CreateCalendarEventAction)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "shareLocationAction": {
    object (ShareLocationAction)
  }
  // End of list of possible types for union field action.
}
Trường
text

string

Văn bản xuất hiện trong hành động được đề xuất. Tối đa 25 ký tự.
postbackData

string

Tải trọng (được mã hoá base64) sẽ được gửi đến tác nhân trong sự kiện người dùng dẫn đến khi người dùng nhấn vào hành động được đề xuất
fallbackUrl

string

(Không bắt buộc) URL dự phòng để sử dụng nếu ứng dụng khách không hỗ trợ hành động đề xuất. URL dự phòng sẽ mở trong cửa sổ trình duyệt mới.
Trường hợp action. Hành động gốc được bắt đầu trên thiết bị khi người dùng nhấn vào hành động đề xuất action có thể chỉ là một trong các hành động sau:
dialAction

object (DialAction)

Mở ứng dụng quay số mặc định của người dùng với số điện thoại do nhân viên hỗ trợ chỉ định đã điền vào.
viewLocationAction

object (ViewLocationAction)

Mở ứng dụng bản đồ mặc định của người dùng và chọn vị trí do nhân viên hỗ trợ chỉ định hoặc các lượt tìm kiếm xung quanh vị trí của người dùng khi được nhân viên hỗ trợ chỉ định truy vấn.
createCalendarEventAction

object (CreateCalendarEventAction)

Mở ứng dụng lịch mặc định của người dùng và bắt đầu quy trình sự kiện mới trên lịch với dữ liệu sự kiện do nhân viên hỗ trợ chỉ định được điền sẵn.
openUrlAction

object (OpenUrlAction)

Mở ứng dụng trình duyệt web mặc định của người dùng với URL đã cho. Nếu người dùng đã cài đặt một ứng dụng được đăng ký là trình xử lý mặc định cho URL, thì ứng dụng này sẽ được mở và biểu tượng của ứng dụng sẽ được dùng trong giao diện người dùng hành động đề xuất.
shareLocationAction

object (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 nhân viên hỗ trợ.

DialAction

Mở ứng dụng quay số mặc định của người dùng với số điện thoại do nhân viên hỗ trợ chỉ định đã điền vào.

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

string

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 nhân viên hỗ trợ chỉ định hoặc các lượt tìm kiếm xung quanh vị trí của người dùng khi được nhân viên hỗ trợ chỉ định truy vấn.

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

object (LatLng)

(Không bắt buộc) Vĩ độ và kinh độ của vị trí được chỉ định.
label

string

(Không bắt buộc) Nhãn của ghim đã thả tại latLong.
query

string

(Không bắt buộc, chỉ được hỗ trợ trên các ứng dụng Android Tin nhắn) Thay vì chỉ định latLong (và một nhãn nếu muốn), tác nhân có thể chỉ định một chuỗi truy vấn. Đối với các ứng dụng bản đồ mặc định hỗ trợ chức năng tìm kiếm (bao gồm cả Google Maps), hãy nhấn vào kết quả hành động được đề xuất này trong một lượt tìm kiếm vị trí xoay quanh vị trí hiện tại của người dùng. Nếu cụm từ tìm kiếm đủ cụ thể, thì nhân viên hỗ trợ có thể sử dụng cụm từ đó để 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" (Ngân hàng Cây đang phát triển) sẽ hiển thị tất cả vị trí Ngân hàng Cây đang phát triển trong vùng lân cận của 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 độ. Thuộc tính này được biểu thị dưới dạng một cặp đôi đại diện cho độ vĩ độ và kinh độ. 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 đã chuẩn hoá.

Biểu diễn dưới dạng JSON 
{
  "latitude": number,
  "longitude": number
}
Trường
latitude

number

Vĩ độ tính theo độ. Giá trị phải nằm trong phạm vi [-90.0, +90.0].
longitude

number

Kinh độ tính theo độ. Giá trị phải nằm trong phạm vi [-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 sự kiện mới trên lịch với dữ liệu sự kiện do nhân viên hỗ trợ 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

string (Timestamp format)

Thời gian bắt đầu sự kiện.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Thời gian kết thúc sự kiện.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, với độ phân giải nano giây và tối đa 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
title

string

Tiêu đề sự kiện.
description

string

Nội dung mô tả sự kiện.

OpenUrlAction

Mở ứng dụng trình duyệt web mặc định của người dùng với URL đã chỉ định. Nếu người dùng đã cài đặt một ứng dụng được đăng ký là trình xử lý mặc định cho URL, thì ứng dụng này sẽ được mở và biểu tượng của ứng dụng sẽ được dùng trong giao diện người dùng hành động đề xuất.

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

string

URL

ShareLocationAction

Loại này không có trường.

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 lại cho nhân viên hỗ trợ.

StandaloneCard

Thẻ độc lập

Biểu diễn dưới dạng JSON 
{
  "cardOrientation": enum (StandaloneCard.CardOrientation),
  "thumbnailImageAlignment": enum (StandaloneCard.ThumbnailImageAlignment),
  "cardContent": {
    object (CardContent)
  }
}
Trường
cardOrientation

enum (StandaloneCard.CardOrientation)

Hướng của thẻ.
thumbnailImageAlignment

enum (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.
cardContent

object (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 object(CardContent) của thẻ thông tin chi tiết ngang chứa trường media, thì thẻ đó cũng phải bao gồm ít nhất một trường title, description hoặc suggestions[].
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.

Phương thức

create

 Gửi tin nhắn từ nhân viên hỗ trợ cho người dùng.

delete

 Thu hồi tin nhắn nhân viên hỗ trợ đã được gửi nhưng chưa được gửi.