REST Resource: conversations.messages

资源:消息

代理与用户之间的对话消息。

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.
}
字段
name

string

消息的名称,由 Business Messages 设置。解析为“conversations/{conversationId}/messages/{messageId}”,其中 {conversationId} 是对话的唯一 ID,{messageId} 是消息的唯一 ID。

messageId

string

必需。消息的唯一标识符,由客服人员分配。如果某封邮件尝试使用与上一封邮件相同的 messageId,则可能会影响该邮件的正确递送。

representative

object (Representative)

发送消息的代表(真人或聊天机器人)的详细信息。

suggestions[]

object (Suggestion)

建议回复的列表,以建议内容信息条列表的形式显示在关联消息之后。最多 13 条建议。

仅当关联的消息是对话中的最新消息(包括代理消息和用户消息)时,条状标签才会显示。用户可以点按建议的回复,将文本回复发送给代理。

fallback

string

可选。当用户的设备不支持消息类型或内容时显示的后备文字。不得超过 3,072 个字符。

containsRichText

boolean

可选。如果为 true,则表示消息包含富文本。如果消息包含无效的格式,Business Messages 会返回错误。

联合字段 content。消息的内容。content 只能是下列其中一项:
text

string

短信。不得超过 3,072 个字符。

image

object (Image)

图片消息。

richCard

object (RichCard)

复合信息卡消息。

映像

图片。

JSON 表示法
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
字段
联合字段 content。图片内容。content 只能是下列其中一项:
contentInfo

object (ContentInfo)

图片的相关信息,包括图片的网址和缩略图的网址。

ContentInfo

包含内容信息的消息。

JSON 表示法
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}
字段
fileUrl

string

文件的可公开访问网址。当平台提取文件时,平台会根据 HTTP 标头中的 content-type 字段确定文件的 MIME 类型。content-type 字段必须在网址的 HTTP 响应中出现且准确无误。

大小上限为 5 MB。

支持的内容类型:image/jpeg、image/jpg、image/png、image/webp

thumbnailUrl

string

可选。缩略图的可公开访问的网址。

如果您不提供缩略图网址,平台会显示空白的占位符缩略图,直到用户设备下载文件为止。

大小上限为 25 KB。

支持的内容类型:image/jpeg、image/jpg、image/png、image/webp

forceRefresh

boolean

如果设置了此字段,即使平台已缓存文件(和/或缩略图)的副本,平台也会从指定的网址提取文件和缩略图。

altText

string

用于描述无障碍功能的媒体详细信息的文本。

RichCard

代理发送给用户的独立复合信息卡或复合信息卡轮播界面。

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.
}
字段
联合字段 card。可能的复合搜索卡类型。card 只能是下列其中一项:
standaloneCard

object (StandaloneCard)

独立卡片。

carouselCard

object (CarouselCard)

卡片轮播界面。

StandaloneCard

独立卡片。

JSON 表示法
{
  "cardContent": {
    object (CardContent)
  }
}
字段
cardContent

object (CardContent)

卡片内容。

CardContent

卡片内容。

JSON 表示法
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
字段
title

string

可选。卡片的标题。不得超过 200 个字符。

description

string

可选。卡片的说明。不得超过 2,000 个字符。

media

object (Media)

可选。要添加到卡片中的媒体。

suggestions[]

object (Suggestion)

可选。要添加到卡片中的建议列表。最多 4 条建议。

媒体

复合信息卡中的媒体文件。

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.
}
字段
height

enum (Height)

复合信息卡中媒体的高度。

联合字段 content。媒体内容。content 只能是下列其中一项:
contentInfo

object (ContentInfo)

文件的相关信息,包括文件网址和文件缩略图的网址。

高度

媒体高度

枚举
HEIGHT_UNSPECIFIED 未指定。
SHORT 112 DP。
MEDIUM 168 DP。
TALL 264 DP。当卡片宽度设为 SMALL 时,不适用于复合信息卡轮播界面。

建议

条状标签列表中的建议。

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.
}
字段
联合字段 option。建议的回复。option 只能是下列其中一项:
reply

object (SuggestedReply)

用户使用指定文本进行回复的建议。

action

object (SuggestedAction)

在设备上启动原生操作的建议操作。

liveAgentRequest

object (LiveAgentRequest)

让人工客服加入对话的请求。

authenticationRequest

object (AuthenticationRequest)

启动身份验证流程的请求。

SuggestedReply

被点按后,将文本回复发送回客服人员。

JSON 表示法
{
  "text": string,
  "postbackData": string
}
字段
text

string

文本,会显示在建议的回复中,并会在用户点按它时发送给代理。不得超过 25 个字符。

postbackData

string

用户点按建议的回复时,代理收到的字符串。不得超过 2,048 个字符。

SuggestedAction

点按后,在设备上启动相应的原生操作。

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.
}
字段
text

string

建议操作中显示的文字。不得超过 25 个字符。

postbackData

string

用户点按建议的操作时,代理收到的字符串。不得超过 2,048 个字符。

联合字段 action。用户点按建议操作时在设备上发起的原生操作。action 只能是下列其中一项:
openUrlAction

object (OpenUrlAction)

打开指定的网址。

dialAction

object (DialAction)

打开用户的默认拨号器应用。

OpenUrlAction

打开指定的网址。

JSON 表示法
{
  "url": string
}
字段
url

string

网址

DialAction

打开用户的默认拨号器应用,其中填写了指定电话号码。

JSON 表示法
{
  "phoneNumber": string
}
字段
phoneNumber

string

必需。指定的电话号码,采用 RFC 3966 格式。例如,“+1-201-555-0123”。

LiveAgentRequest

此类型没有字段。

点按相应按钮后,系统会发送请求,请人工客服加入对话。

AuthenticationRequest

请求对对话进行身份验证。

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.
}
字段
联合字段 authentication_type。身份验证类型。authentication_type 只能是下列其中一项:
oauth

object (Oauth)

通过 OAuth 进行身份验证的详细信息。

OAuth

通过 OAuth 进行身份验证的详细信息。

JSON 表示法
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
字段
clientId

string

必需。请求授权的应用的 ID

codeChallenge

string

必需。用于交换访问令牌的代码质询

scopes[]

string

必需。一个数组,用于指定请求的范围。

codeChallengeMethod

string

可选。用于生成代码质询的代码质询方法。如果省略此参数,服务器会假定为 plain

CarouselCard

卡片轮播界面。

JSON 表示法
{
  "cardWidth": enum (CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
字段
cardWidth

enum (CardWidth)

轮播界面中卡片的宽度。

cardContents[]

object (CardContent)

轮播界面中每张卡片的内容列表。一个轮播界面可以包含至少 2 张卡片,最多 10 张卡片。

CardWidth

轮播界面中卡片的宽度。

枚举
CARD_WIDTH_UNSPECIFIED 未指定
SMALL 136 DP。不得包含竖版媒体内容。
MEDIUM 280 DP。

方法

create

从代理向用户发送消息。

updateReceipt

将代理的消息收据发送给用户。