更新：查看版本说明，了解新功能和产品动态。

此页面由 Cloud Translation API 翻译。

REST Resource: phones.agentMessages

资源：AgentMessage

从代理向用户发送的消息。

JSON 表示法

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`. }

{
  "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.
}

字段
`name`	`string` 此字段由 RBM 平台设置。创建代理消息时，请勿添加此参数。此字段会解析“phones/{E.164}/agentMessages/{messageId}”，其中 {E.164} 是用户的电话号码（采用 E.164 格式），而 {messageId} 是客服人员为客服人员消息分配的 ID。
`sendTime`	`string (Timestamp format)` 此字段由 RBM 平台设置。创建代理消息时，请勿添加此参数。此字段会解析消息发送给用户的时间。时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例：`"2014-10-02T15:01:23Z"` 和 `"2014-10-02T15:01:23.045123456Z"`。
`contentMessage`	`object (AgentContentMessage)` 代理消息的内容。
联合字段 `expiration`。 `expiration` 只能是下列其中一项：
`expireTime`	`string (Timestamp format)` 可选。资源被视为过期时的时间戳（世界协调时间）。如果已设置该值或设置了 TTL 字段，则会在输出中提供此值。时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例：`"2014-10-02T15:01:23Z"` 和 `"2014-10-02T15:01:23.045123456Z"`。
`ttl`	`string (Duration format)` 可选。仅限输入。邮件的有效期是多久，之后会自动撤消。该时长以秒为单位，最多包含九个小数位，以“`s`”结尾。示例：`"3.5s"`。

AgentContentMessage

从代理发送给用户的消息的内容。

JSON 表示法

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`. }

{
  "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.
}

字段
`suggestions[]`	`object (Suggestion)` 建议回复和建议操作的列表，以建议内容信息卡列表的形式显示在关联的代理消息下方。最多 11 条建议。仅当关联的代理消息是对话（包括代理消息和用户消息）中的最新消息时，系统才会显示条状标签。用户可以点按建议的回复，将文本回复发回给代理，也可以点按建议的操作，在设备上启动原生操作。
联合字段 `content`。代理消息 `content` 的内容只能是下列内容之一：
`text`	`string` 采用 UTF-8 编码的文本。
`fileName (deprecated)`	`string` 此项已弃用！文件的唯一名称。当代理上传文件时，RBM 平台会返回文件名。已弃用，取而代之的是以下上传 RbmFile
`uploadedRbmFile`	`object (UploadedRbmFile)` 包含上传到 RBM 服务器并由其提供的文件和缩略图的标识符
`richCard`	`object (RichCard)` 独立的复合信息卡。
`contentInfo`	`object (ContentInfo)` 文件的相关信息，包括文件网址和文件缩略图的网址。 RBM 平台从缓存提供内容，但代理可以强制 RBM 平台提取新版本的内容并刷新缓存。

UploadedRbmFile

包含文件和缩略图信息的消息

JSON 表示法
{ "fileName": string, "thumbnailName": string }

字段

字段
`fileName`	`string` 上传文件时，RBM 平台会返回的文件名称。
`thumbnailName`	`string` 上传缩略图时，RBM 平台返回的缩略图名称。

fileName

string

上传文件时，RBM 平台会返回的文件名称。

thumbnailName

string

上传缩略图时，RBM 平台返回的缩略图名称。

RichCard

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

JSON 表示法

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`. }

{

  // 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.
}

字段

字段
联合字段 `card`。独立卡片或卡片轮播界面。`card` 只能是下列其中一项：
`carouselCard`	`object (CarouselCard)` 卡片轮播界面。
`standaloneCard`	`object (StandaloneCard)` 独立卡。

联合字段 card。独立卡片或卡片轮播界面。card 只能是下列其中一项：

carouselCard

object (CarouselCard)

卡片轮播界面。

standaloneCard

object (StandaloneCard)

独立卡。

CarouselCard

卡片轮播界面。

JSON 表示法
{ "cardWidth": enum (`CarouselCard.CardWidth`), "cardContents": [ { object (`CardContent`) } ] }

字段

字段
`cardWidth`	`enum (CarouselCard.CardWidth)` 轮播界面中卡片的宽度。
`cardContents[]`	`object (CardContent)` 轮播界面中每张卡片的内容列表。一个轮播界面可以包含至少 2 张卡片，最多可以包含 10 张卡片。

cardWidth

enum (CarouselCard.CardWidth)

轮播界面中卡片的宽度。

cardContents[]

object (CardContent)

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

CarouselCard.CardWidth

轮播界面中卡片的宽度。

枚举
`CARD_WIDTH_UNSPECIFIED`	未指定。
`SMALL`	120 DP。请注意，无法使用高大型媒体。
`MEDIUM`	232 DP。

CardContent

卡片内容

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

字段
`title`	`string` （可选）卡片的标题。不得超过 200 个字符。
`description`	`string` （可选）卡片的说明。不得超过 2000 个字符。
`media`	`object (Media)` （可选）要在卡片中添加的媒体（图片、GIF、视频）。
`suggestions[]`	`object (Suggestion)` （可选）要在卡片中添加的建议列表。最多 4 条建议。

媒体

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

JSON 表示法

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`. }

{
  "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.
}

字段
`height`	`enum (Media.Height)` 采用垂直布局的复合信息卡中的媒体高度。对于采用横向布局的独立卡片，高度不可自定义，且系统会忽略此字段。
联合字段 `content`。媒体内容 `content` 只能是下列内容之一：
`fileName (deprecated)`	`string` 此项已弃用！上传文件时，RBM 平台会返回的唯一文件名称。已弃用，取而代之的是以下上传 RbmFile
`uploadedRbmFile`	`object (UploadedRbmFile)` 包含上传到 RBM 服务器并由其提供的文件和缩略图的标识符
`contentInfo`	`object (ContentInfo)` 文件的相关信息，包括文件网址和文件缩略图的网址。 RBM 平台从缓存提供内容，但代理可以强制 RBM 平台提取新版本的内容并刷新缓存。

ContentInfo

包含内容信息的消息。

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

字段

字段
`fileUrl`	`string` 文件的可公开访问的网址。RBM 平台在提取文件时，会根据 HTTP 标头中的 content-type 字段确定文件的 MIME 类型。content-type 字段必须在网址发出的 HTTP 响应中必须存在且准确无误。建议的文件大小上限为 100 MB。
`thumbnailUrl`	`string` （可选，仅适用于图片和视频文件）缩略图的可公开访问的网址。大小上限为 100 kB。如果您不提供缩略图网址，RBM 平台将显示空白的占位缩略图，直到用户的设备下载文件为止。根据用户的设置，文件可能不会自动下载，并且可能需要用户点按下载按钮。
`forceRefresh`	`boolean` 如果设置了该属性，RBM 平台会从指定网址提取文件和缩略图，即使平台已缓存该文件（和/或缩略图）的副本。

fileUrl

string

文件的可公开访问的网址。RBM 平台在提取文件时，会根据 HTTP 标头中的 content-type 字段确定文件的 MIME 类型。content-type 字段必须在网址发出的 HTTP 响应中必须存在且准确无误。建议的文件大小上限为 100 MB。

thumbnailUrl

string

（可选，仅适用于图片和视频文件）缩略图的可公开访问的网址。大小上限为 100 kB。

如果您不提供缩略图网址，RBM 平台将显示空白的占位缩略图，直到用户的设备下载文件为止。根据用户的设置，文件可能不会自动下载，并且可能需要用户点按下载按钮。

forceRefresh

boolean

如果设置了该属性，RBM 平台会从指定网址提取文件和缩略图，即使平台已缓存该文件（和/或缩略图）的副本。

Media.Height

媒体高度

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

建议

复合信息卡或建议内容信息卡列表中包含的建议回复或建议操作。

JSON 表示法

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`. }

{

  // 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.
}

字段

字段
联合字段 `option`。建议的回复或建议操作 `option` 只能是下列其中一项：
`reply`	`object (SuggestedReply)` 用户可以点按建议的回复，将文字回复发回给客服人员。
`action`	`object (SuggestedAction)` 用户可以点按建议的操作，在设备上启动相应的原生操作。

联合字段 option。建议的回复或建议操作 option 只能是下列其中一项：

reply

object (SuggestedReply)

用户可以点按建议的回复，将文字回复发回给客服人员。

action

object (SuggestedAction)

用户可以点按建议的操作，在设备上启动相应的原生操作。

SuggestedReply

点按相应按钮后，将文字回复发送回客服人员。

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

字段

字段
`text`	`string` 在建议的回复中显示并在用户点按该回复时将其发送回代理的文本。不得超过 25 个字符。
`postbackData`	`string` 当用户点按建议的回复时，代理在用户事件中收到的 base64 编码载荷。

text

string

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

postbackData

string

当用户点按建议的回复时，代理在用户事件中收到的 base64 编码载荷。

SuggestedAction

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

JSON 表示法

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`. }

{
  "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.
}

字段
`text`	`string` 建议操作中显示的文字。不得超过 25 个字符。
`postbackData`	`string` 载荷（采用 base64 编码），将在用户点按建议操作时出现的用户事件中发送给代理
`fallbackUrl`	`string` （可选）在客户端不支持建议的操作时使用的后备网址。后备网址会在新的浏览器窗口中打开。
联合字段 `action`。用户点按建议操作 `action` 时在设备上启动的原生操作只能是下列操作之一：
`dialAction`	`object (DialAction)` 打开用户的默认拨号器应用，其中已填写代理指定的电话号码。
`viewLocationAction`	`object (ViewLocationAction)` 打开用户的默认地图应用，并选择代理指定的位置，或针对指定的代理查询在用户所在位置周围搜索。
`createCalendarEventAction`	`object (CreateCalendarEventAction)` 打开用户的默认日历应用，并开始新的日历活动流程，其中预先填充了代理指定的活动数据。
`openUrlAction`	`object (OpenUrlAction)` 将用户的默认网络浏览器应用打开到指定网址。如果用户安装了已注册为网址的默认处理程序的应用，系统会改为打开此应用，并在建议的操作界面中使用其图标。
`shareLocationAction`	`object (ShareLocationAction)` 打开 RCS 应用的位置信息选择器，以便用户选择要发送给代理的位置信息。

DialAction

打开用户的默认拨号器应用，其中已填写代理指定的电话号码。

JSON 表示法
{ "phoneNumber": string }

字段

字段
`phoneNumber`	`string` 采用 E.164 格式的电话号码，例如 +12223334444。

phoneNumber

string

采用 E.164 格式的电话号码，例如 +12223334444。

ViewLocationAction

打开用户的默认地图应用，并选择代理指定的位置，或针对指定的代理查询在用户所在位置周围搜索。

JSON 表示法
{ "latLong": { object (`LatLng`) }, "label": string, "query": string }

字段

字段
`latLong`	`object (LatLng)` （可选）指定位置的纬度和经度。
`label`	`string` （可选）在 latLong 放置的图钉标签。
`query`	`string` （可选，仅在 Android 信息客户端上受支持）代理可以指定查询字符串，而无需指定 latLong（也可以根据需要指定标签）。对于支持搜索功能的默认地图应用（包括 Google 地图），点按此建议的操作便会以用户当前所在位置为中心显示位置搜索。如果查询足够具体，则代理可以使用它来选择世界上的任何位置。例如，如果将查询字符串设置为“Growing Tree Bank”，则会显示用户附近的所有 Growing Tree Bank 位置。如果将查询字符串设置为“1600 Amphitheater Parkway, Mountain View, CA 94043”，则无论用户身处何地，都会选择该特定地址。

latLong

object (LatLng)

（可选）指定位置的纬度和经度。

label

string

（可选）在 latLong 放置的图钉标签。

query

string

（可选，仅在 Android 信息客户端上受支持）代理可以指定查询字符串，而无需指定 latLong（也可以根据需要指定标签）。对于支持搜索功能的默认地图应用（包括 Google 地图），点按此建议的操作便会以用户当前所在位置为中心显示位置搜索。如果查询足够具体，则代理可以使用它来选择世界上的任何位置。

例如，如果将查询字符串设置为“Growing Tree Bank”，则会显示用户附近的所有 Growing Tree Bank 位置。如果将查询字符串设置为“1600 Amphitheater Parkway, Mountain View, CA 94043”，则无论用户身处何地，都会选择该特定地址。

LatLng

表示纬度/经度对的对象。该对象以一对双精度数表示，分别代表纬度度数和经度度数。除非另有说明，否则该对象必须符合 WGS84 标准。值必须介于标准化范围内。

JSON 表示法
{ "latitude": number, "longitude": number }

字段

字段
`latitude`	`number` 纬度（以度为单位）。它必须在 [-90.0, +90.0] 范围内。
`longitude`	`number` 经度（以度为单位）。它必须在 [-180.0, +180.0] 范围内。

latitude

number

纬度（以度为单位）。它必须在 [-90.0, +90.0] 范围内。

longitude

number

经度（以度为单位）。它必须在 [-180.0, +180.0] 范围内。

CreateCalendarEventAction

打开用户的默认日历应用，并开始新的日历活动流程，其中预先填充了代理指定的活动数据。

JSON 表示法
{ "startTime": string, "endTime": string, "title": string, "description": string }

字段
`startTime`	`string (Timestamp format)` 活动开始时间。时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例：`"2014-10-02T15:01:23Z"` 和 `"2014-10-02T15:01:23.045123456Z"`。
`endTime`	`string (Timestamp format)` 活动结束时间。时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例：`"2014-10-02T15:01:23Z"` 和 `"2014-10-02T15:01:23.045123456Z"`。
`title`	`string` 活动名称。
`description`	`string` 活动说明。

OpenUrlAction

将用户的默认网络浏览器应用打开到指定的网址。如果用户安装了已注册为网址的默认处理程序的应用，系统会改为打开此应用，并在建议的操作界面中使用其图标。

JSON 表示法
{ "url": string }

字段

字段
`url`	`string` 网址

url

string

网址

ShareLocationAction

此类型没有字段。

打开 RCS 应用的位置信息选择器，以便用户选择要发送回代理的位置信息。

StandaloneCard

独立卡

JSON 表示法
{ "cardOrientation": enum (`StandaloneCard.CardOrientation`), "thumbnailImageAlignment": enum (`StandaloneCard.ThumbnailImageAlignment`), "cardContent": { object (`CardContent`) } }

字段

字段
`cardOrientation`	`enum (StandaloneCard.CardOrientation)` 卡片的方向。
`thumbnailImageAlignment`	`enum (StandaloneCard.ThumbnailImageAlignment)` 采用水平布局的独立卡片的图片预览对齐方式。
`cardContent`	`object (CardContent)` 卡片内容。

cardOrientation

enum (StandaloneCard.CardOrientation)

卡片的方向。

thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

采用水平布局的独立卡片的图片预览对齐方式。

cardContent

object (CardContent)

卡片内容。

StandaloneCard.CardOrientation

卡片的方向。

枚举

CARD_ORIENTATION_UNSPECIFIED 未指定。

枚举
`CARD_ORIENTATION_UNSPECIFIED`	未指定。
`HORIZONTAL`	水平布局。如果横向复合信息卡的 `object(CardContent)` 包含 `media` 字段，则它还必须至少包含 `title`、`description` 或 `suggestions[]` 字段。
`VERTICAL`	垂直布局。

HORIZONTAL

水平布局。

如果横向复合信息卡的 object(CardContent) 包含 media 字段，则它还必须至少包含 title、description 或 suggestions[] 字段。

VERTICAL 垂直布局。

StandaloneCard.ThumbnailImageAlignment

采用水平布局的独立卡片的图片预览对齐方式。

枚举
`THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED`	未指定。
`LEFT`	文件预览是左对齐的。
`RIGHT`	文件预览已右对齐。

方法
`create`	从代理向用户发送消息。
`delete`	撤消已发送但尚未递送的代理消息。

REST Resource: phones.agentMessages

资源：AgentMessage

AgentContentMessage

UploadedRbmFile

RichCard

CarouselCard

CarouselCard.CardWidth

CardContent

媒体

ContentInfo

Media.Height

建议

SuggestedReply

SuggestedAction

DialAction

ViewLocationAction

LatLng

CreateCalendarEventAction

OpenUrlAction

ShareLocationAction

StandaloneCard

StandaloneCard.CardOrientation

StandaloneCard.ThumbnailImageAlignment

方法

`create`

`delete`