REST Resource: conversations.messages

Tài nguyên: Thông báo

Tin nhắn trong cuộc trò chuyện giữa nhân viên hỗ trợ và người dùng.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "messageId": string,
  "representative": {
    object (Representative)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "fallback": string,
  "containsRichText": boolean,

  // Union field content can be only one of the following:
  "text": string,
  "image": {
    object (Image)
  },
  "richCard": {
    object (RichCard)
  }
  // End of list of possible types for union field content.
}
Trường
name

string

Tên của tin nhắn, do Business Messages thiết lập. Phân giải thành "conversations/{conversationId}/messages/{messageId}", trong đó {conversationId} là mã nhận dạng duy nhất của cuộc trò chuyện và {messageId} là mã nhận dạng duy nhất của tin nhắn.
messageId

string

Bắt buộc. Mã nhận dạng duy nhất của tin nhắn, do nhân viên hỗ trợ chỉ định. Nếu một thư cố gắng sử dụng cùng một messageId như thư trước, thì việc gửi thư đúng cách có thể bị ảnh hưởng.
representative

object (Representative)

Thông tin chi tiết về người đại diện (người hoặc bot trò chuyện) đã gửi tin nhắn.
suggestions[]

object (Suggestion)

Danh sách câu trả lời đề xuất xuất hiện dưới dạng danh sách các khối đề xuất theo tin nhắn liên quan. Tối đa 13 đề xuất.

Các khối này chỉ xuất hiện khi tin nhắn liên quan 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 nội dung tin nhắn trả lời đó cho nhân viên hỗ trợ.
fallback

string

Không bắt buộc. Văn bản dự phòng sẽ hiển thị nếu thiết bị của người dùng không hỗ trợ loại thông báo hoặc nội dung. Tối đa 3.072 ký tự.
containsRichText

boolean

Không bắt buộc. Nếu là true, cho biết thư chứa văn bản đa dạng thức. Nếu tin nhắn có định dạng không hợp lệ, thì Business Messages sẽ trả về thông báo lỗi.
Trường kết hợp content. Nội dung của tin nhắn. content chỉ có thể là một trong những trạng thái sau đây:
text

string

Tin nhắn văn bản. Tối đa 3.072 ký tự.
image

object (Image)

Tin nhắn hình ảnh.
richCard

object (RichCard)

Tin nhắn thẻ thông tin.

Bài đăng có hình ảnh

Một hình ảnh.

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

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
Trường
Trường kết hợp content. Nội dung hình ảnh. content chỉ có thể là một trong những trạng thái sau đây:
contentInfo

object (ContentInfo)

Thông tin về một hình ảnh, bao gồm cả URL của hình ảnh và URL của hình thu nhỏ của hình ảnh.

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,
  "altText": string
}
Trường
fileUrl

string

URL có thể truy cập công khai của tệp. Nền tảng này 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.

Tối đa 5 MB.

Các loại nội dung được hỗ trợ: hình ảnh/jpeg, hình ảnh/jpg, hình ảnh/png, hình ảnh/webp
thumbnailUrl

string

Không bắt buộc. URL có thể truy cập công khai của hình thu nhỏ.

Nếu bạn không cung cấp URL của hình thu nhỏ, nền tảng 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.

Tối đa 25 KB.

Các loại nội dung được hỗ trợ: hình ảnh/jpeg, hình ảnh/jpg, hình ảnh/png, hình ảnh/webp
forceRefresh

boolean

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

string

Văn bản mô tả chi tiết về nội dung nghe nhìn nhằm mục đích hỗ trợ tiếp cận.

RichCard

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

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

  // Union field card can be only one of the following:
  "standaloneCard": {
    object (StandaloneCard)
  },
  "carouselCard": {
    object (CarouselCard)
  }
  // End of list of possible types for union field card.
}
Trường
Trường kết hợp card. Các loại thẻ thông tin chi tiết có thể có. card chỉ có thể là một trong những trạng thái sau đây:
standaloneCard

object (StandaloneCard)

Thẻ độc lập.
carouselCard

object (CarouselCard)

Băng chuyền thẻ.

StandaloneCard

Thẻ độc lập.

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

object (CardContent)

Nội dung thẻ.

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 đề thẻ. Tối đa 200 ký tự.
description

string

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

object (Media)

Không bắt buộc. Nội dung nghe nhìn để thêm vào thẻ.
suggestions[]

object (Suggestion)

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

Nội dung nghe nhìn

Tệp đa phương tiện trong thẻ thông tin đa phương tiện.

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

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

enum (Height)

Chiều cao của nội dung đa phương tiện trong thẻ thông tin.
Trường kết hợp content. Nội dung nghe nhìn. content chỉ có thể là một trong những trạng thái sau đây:
contentInfo

object (ContentInfo)

Thông tin về một tệp, bao gồm cả URL của tệp và URL hình thu nhỏ của tệp.

Chiều cao

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 có trong băng chuyền thẻ thông tin khi chiều rộng thẻ được đặt thành SMALL.

Đề xuất

Một đề xuất trong danh sách khối.

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)
  },
  "liveAgentRequest": {
    object (LiveAgentRequest)
  },
  "authenticationRequest": {
    object (AuthenticationRequest)
  }
  // End of list of possible types for union field option.
}
Trường
Trường kết hợp option. Câu trả lời đề xuất. option chỉ có thể là một trong những trạng thái sau đây:
reply

object (SuggestedReply)

Đề xuất để người dùng trả lời bằng văn bản được chỉ định.
action

object (SuggestedAction)

Một hành động đề xuất để bắt đầu một hành động gốc trên thiết bị.
liveAgentRequest

object (LiveAgentRequest)

Yêu cầu mời nhân viên hỗ trợ tham gia cuộc trò chuyện.
authenticationRequest

object (AuthenticationRequest)

Yêu cầu bắt đầu quy trình xác thực.

SuggestedReply

Khi bạn nhấn vào tin nhắn, hãy gửi tin nhắn trả lời lại 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 tới nhân viên hỗ trợ khi người dùng nhấn vào văn bản đó. Tối đa 25 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 đề xuất. Tối đa 2.048 ký tự.

SuggestedAction

Khi được nhấn, hãy 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,

  // Union field action can be only one of the following:
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "dialAction": {
    object (DialAction)
  }
  // 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 đề xuất. Tối đa 25 ký tự.
postbackData

string

Chuỗi mà tác nhân nhận được khi người dùng nhấn vào thao tác được đề xuất. Tối đa 2.048 ký tự.
Trường kết hợp action. Hành động gốc bắt đầu trên thiết bị khi người dùng nhấn vào hành động đề xuất. action chỉ có thể là một trong những trạng thái sau đây:
openUrlAction

object (OpenUrlAction)

Mở URL được chỉ định.
dialAction

object (DialAction)

Mở ứng dụng gọi điện mặc định của người dùng.

OpenUrlAction

Mở URL được chỉ định.

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

string

URL

DialAction

Mở ứng dụng gọi điện mặc định của người dùng với số điện thoại được chỉ định.

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

string

Bắt buộc. Số điện thoại được chỉ định, ở định dạng RFC 3966. Ví dụ: "+1-201-555-0123".

LiveAgentRequest

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

Khi bạn nhấn vào nút này, hãy gửi yêu cầu mời nhân viên hỗ trợ tham gia cuộc trò chuyện.

AuthenticationRequest

Yêu cầu xác thực cuộc trò chuyện.

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

  // Union field authentication_type can be only one of the following:
  "oauth": {
    object (Oauth)
  }
  // End of list of possible types for union field authentication_type.
}
Trường
Trường kết hợp authentication_type. Loại xác thực. authentication_type chỉ có thể là một trong những trạng thái sau đây:
oauth

object (Oauth)

Thông tin chi tiết về việc xác thực qua OAuth.

OAuth

Thông tin chi tiết về việc xác thực qua OAuth.

Biểu diễn dưới dạng JSON 
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
Trường
clientId

string

Bắt buộc. Mã của ứng dụng yêu cầu uỷ quyền.
codeChallenge

string

Bắt buộc. Thử thách mã dùng để trao đổi mã truy cập.
scopes[]

string

Bắt buộc. Một mảng chỉ định phạm vi của yêu cầu.
codeChallengeMethod

string

Không bắt buộc. Phương thức thử thách mã dùng để tạo thử thách mã. Nếu tham số này bị bỏ qua, máy chủ sẽ giả định là plain.

CarouselCard

Băng chuyền thẻ.

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

enum (CardWidth)

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

object (CardContent)

Danh sách nội dung của 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ẻ.

CardWidth

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

Enum
CARD_WIDTH_UNSPECIFIED Chưa chỉ định
SMALL 136 DP. Không được thêm nội dung nghe nhìn cao.
MEDIUM 280 DP.

Phương thức

create

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

updateReceipt

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