资源:AgentMessage
从代理发送给用户的消息。
JSON 表示法 |
---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
字段 | |
---|---|
name |
此字段由 RBM 平台设置。请勿在创建代理消息时包含此元素。该字段会解析“phones/{E.164}/agentMessages/{messageId}”,其中 {E.164} 是用户的电话号码(采用 E.164 格式),{messageId} 是客服人员为客服人员分配的 ID。 |
sendTime |
此字段由 RBM 平台设置。请勿在创建代理消息时包含此元素。此字段用于解析向用户发送消息的时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
contentMessage |
代理消息的内容。 |
联合字段
|
|
expireTime |
可选。资源被视为过期时的时间戳(世界协调时间)。如果设置了此值或设置了 TTL 字段,则输出中会提供此值。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
ttl |
可选。仅限输入。消息在自动撤消前的有效期。 该时长以秒为单位,最多包含九个小数位,以“ |
AgentContentMessage
从代理发送给用户的消息的内容。
JSON 表示法 |
---|
{ "suggestions": [ { object ( |
字段 | |
---|---|
suggestions[] |
建议回复和建议操作的列表,以建议内容信息卡列表的形式显示在关联的代理消息之后。最多 11 条建议。 仅当关联的代理消息是对话中的最新消息(包括代理消息和用户消息)时,条状标签才会显示。用户可以点按建议的回复,将文本回复发送回代理,也可以点按建议的操作,在设备上启动原生操作。 |
联合字段 content 。代理消息 content 的内容只能是下列其中一项: |
|
text |
以 UTF-8 编码的文本。 |
fileName |
文件的唯一名称。当代理上传文件时,RBM 平台会返回一个文件名。已弃用,改为使用已上传的 RbmFile |
uploadedRbmFile |
包含上传到 RBM 服务器并由 RBM 服务器投放的文件和缩略图的标识符 |
richCard |
独立的复合信息卡。 |
contentInfo |
文件的相关信息,包括文件网址和文件缩略图的网址。 RBM 平台从缓存中提供内容,但代理可以强制 RBM 平台提取新版本的内容并刷新缓存。 |
UploadedRbmFile
包含文件和缩略图信息的消息
JSON 表示法 |
---|
{ "fileName": string, "thumbnailName": string } |
字段 | |
---|---|
fileName |
文件的名称,由 RBM 平台在上传文件时返回。 |
thumbnailName |
缩略图名称,在上传缩略图时 RBM 平台会返回。 |
RichCard
代理发送给用户的独立复合信息卡或复合信息卡轮播界面。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 card 。独立的卡片或卡片轮播。card 只能是下列其中一项: |
|
carouselCard |
卡片轮播界面。 |
standaloneCard |
独立卡片。 |
CarouselCard
卡片轮播界面。
JSON 表示法 |
---|
{ "cardWidth": enum ( |
字段 | |
---|---|
cardWidth |
轮播界面中卡片的宽度。 |
cardContents[] |
轮播界面中每张卡片的内容列表。一个轮播界面可以包含至少 2 张卡片,最多 10 张卡片。 |
CarouselCard.CardWidth
轮播界面中卡片的宽度。
枚举 | |
---|---|
CARD_WIDTH_UNSPECIFIED |
未指定。 |
SMALL |
120 DP。请注意,不能使用高大的媒体。 |
MEDIUM |
232 DP。 |
CardContent
卡片内容
JSON 表示法 |
---|
{ "title": string, "description": string, "media": { object ( |
字段 | |
---|---|
title |
(可选)卡片的标题。不得超过 200 个字符。 |
description |
(可选)卡片的说明。不得超过 2000 个字符。 |
media |
(可选)要添加到卡片中的媒体(图片、GIF、视频)。 |
suggestions[] |
(可选)要添加到卡片中的建议列表。最多 4 条建议。 |
媒体
复合信息卡中的媒体文件。
JSON 表示法 |
---|
{ "height": enum ( |
字段 | |
---|---|
height |
采用纵向布局的复合信息卡中媒体的高度。对于采用水平布局的独立卡片,高度无法自定义,因此系统会忽略此字段。 |
联合字段 content 。媒体内容 content 只能是下列内容之一: |
|
fileName |
文件的唯一名称,在上传文件时由 RBM 平台返回。已弃用,改为使用已上传的 RbmFile |
uploadedRbmFile |
包含上传到 RBM 服务器并由 RBM 服务器投放的文件和缩略图的标识符 |
contentInfo |
文件的相关信息,包括文件网址和文件缩略图的网址。 RBM 平台从缓存中提供内容,但代理可以强制 RBM 平台提取新版本的内容并刷新缓存。 |
ContentInfo
包含内容信息的消息。
JSON 表示法 |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
字段 | |
---|---|
fileUrl |
文件的可公开访问网址。RBM 平台在提取文件时,通过 HTTP 标头中的内容类型字段确定文件的 MIME 类型。content-type 字段必须在网址的 HTTP 响应中出现且准确无误。建议的文件大小上限为 100 MB。 |
thumbnailUrl |
(可选,仅适用于图片、音频和视频文件)缩略图的可公开访问网址。大小上限为 100 kB。 如果您不提供缩略图网址,RBM 平台会在用户设备下载文件前显示空白的占位缩略图。根据用户的设置,该文件可能不会自动下载,并且可能需要用户点按下载按钮。 |
forceRefresh |
设置完毕后,即使该平台已缓存文件(和/或缩略图)的副本,RBM 平台也会从指定的网址中提取文件和缩略图。 |
Media.Height
媒体高度
枚举 | |
---|---|
HEIGHT_UNSPECIFIED |
未指定。 |
SHORT |
112 DP。 |
MEDIUM |
168 DP。 |
TALL |
264 DP。当卡片宽度设为“小”时,不适用于复合信息卡轮播界面。 |
建议
复合信息卡或建议内容信息卡列表中包含的建议回复或建议操作。
JSON 表示法 |
---|
{ // Union field |
字段 | |
---|---|
联合字段 option 。建议的回复或建议操作 option 只能是下列其中一项: |
|
reply |
用户可以点按建议的回复,将文本回复发送回代理。 |
action |
用户可以点按建议的操作,以在设备上启动相应的原生操作。 |
SuggestedReply
被点按后,将文本回复发送回客服人员。
JSON 表示法 |
---|
{ "text": string, "postbackData": string } |
字段 | |
---|---|
text |
文本,会显示在建议的回复中,并会在用户点按该文本时发送回代理。不得超过 25 个字符。 |
postbackData |
当用户点按建议的回复时,代理在用户事件中收到的 base64 编码的载荷。 |
SuggestedAction
点按后,在设备上启动相应的原生操作。
JSON 表示法 |
---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
字段 | |
---|---|
text |
建议操作中显示的文字。不得超过 25 个字符。 |
postbackData |
载荷(采用 base64 编码),将在用户点按建议操作时产生的用户事件中发送给代理的载荷 |
fallbackUrl |
(可选)在客户端不支持建议的操作时使用的后备网址。后备网址会在新的浏览器窗口中打开。 |
联合字段 action 。用户点按建议操作 action 时在设备上发起的原生操作只能是下列其中一项: |
|
dialAction |
打开用户的默认拨号器应用,其中填写了代理指定的电话号码。 |
viewLocationAction |
打开用户的默认地图应用,并选择代理指定的位置,或在给定代理指定的查询的情况下,围绕用户所在位置进行搜索。 |
createCalendarEventAction |
打开用户的默认日历应用,并开始新的日历活动流程,其中预填充了代理指定的活动数据。 |
openUrlAction |
使用指定网址打开用户的默认网络浏览器应用。如果用户已安装了一个已注册为网址的默认处理程序的应用,则系统会改为打开该应用,并在建议的操作界面中使用其图标。 |
shareLocationAction |
打开 RCS 应用的位置信息选择器,以便用户选择要发送给代理的位置信息。 |
DialAction
打开用户的默认拨号器应用,其中填写了代理指定的电话号码。
JSON 表示法 |
---|
{ "phoneNumber": string } |
字段 | |
---|---|
phoneNumber |
采用 E.164 格式的电话号码,例如 +12223334444。 |
ViewLocationAction
打开用户的默认地图应用,并选择代理指定的位置,或在给定代理指定的查询的情况下,围绕用户所在位置进行搜索。
JSON 表示法 |
---|
{
"latLong": {
object ( |
字段 | |
---|---|
latLong |
(可选)指定位置的纬度和经度。 |
label |
(可选)图钉在 latLong 处放置的标签。 |
query |
(可选,仅在 Android 信息客户端上受支持)代理可以改为指定查询字符串,而不是指定 latLong(也可以选择指定标签)。对于支持搜索功能的默认地图应用(包括 Google 地图),点按此建议操作后,系统将以用户当前所在位置为中心搜索位置。如果查询足够具体,代理可以使用它来选择世界上的任意位置。 例如,将查询字符串设置为“Growing Tree Bank”会显示用户附近的所有 Growing Tree Bank 营业地点。将查询字符串设置为“1600 Amphitheater Parkway, Mountain View, CA 94043”会选择这个特定地址,而不考虑用户身在何处。 |
LatLng
表示纬度/经度对的对象。该对象以一对双精度数表示,分别代表纬度度数和经度度数。除非另有说明,否则该对象必须符合 WGS84 标准。值必须介于标准化范围内。
JSON 表示法 |
---|
{ "latitude": number, "longitude": number } |
字段 | |
---|---|
latitude |
纬度(以度为单位)。它必须在 [-90.0, +90.0] 范围内。 |
longitude |
经度(以度为单位)。它必须在 [-180.0, +180.0] 范围内。 |
CreateCalendarEventAction
打开用户的默认日历应用,并开始新的日历活动流程,其中预填充了代理指定的活动数据。
JSON 表示法 |
---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
字段 | |
---|---|
startTime |
活动开始时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
endTime |
活动结束时间。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
title |
活动名称。 |
description |
活动说明。 |
OpenUrlAction
使用指定的网址打开用户的默认网络浏览器应用。如果用户已安装了一个已注册为网址的默认处理程序的应用,则系统会改为打开该应用,并在建议的操作界面中使用其图标。
JSON 表示法 |
---|
{ "url": string } |
字段 | |
---|---|
url |
网址 |
StandaloneCard
独立卡
JSON 表示法 |
---|
{ "cardOrientation": enum ( |
字段 | |
---|---|
cardOrientation |
卡片的方向。 |
thumbnailImageAlignment |
采用水平布局的独立卡片的图片预览对齐方式。 |
cardContent |
卡片内容。 |
StandaloneCard.CardOrientation
卡片的方向。
枚举 | |
---|---|
CARD_ORIENTATION_UNSPECIFIED |
未指定。 |
HORIZONTAL |
水平布局。 如果横向复合信息卡的 |
VERTICAL |
垂直布局。 |
StandaloneCard.ThumbnailImageAlignment
采用水平布局的独立卡片的图片预览对齐方式。
枚举 | |
---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
未指定。 |
LEFT |
文件预览是左对齐的。 |
RIGHT |
文件预览画面右对齐。 |
方法 |
|
---|---|
|
从代理向用户发送消息。 |
|
撤消已发送但尚未发送的代理消息。 |