上传用于媒体或复合信息卡消息的文件。
代理会提供文件的网址或二进制文件,以及(可选)相应缩略图文件的网址。RBM 平台会将该文件缓存 30 天,并返回独一无二的名称,以便您在发送代理消息时识别该文件。
要上传文件二进制文件,请向上传 URI 发出 HTTP POST 请求,省略 JSON 请求正文中的 fileUrl
字段,并将二进制文件指定为 POST 请求正文。例如,结合使用 --upload-file
c网址 标志和二进制文件的完全限定文件路径。
HTTP 请求
- 上传 URI,用于媒体上传请求:
POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
- 元数据 URI,用于仅包含元数据的请求:
POST https://rcsbusinessmessaging.googleapis.com/v1/files
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "fileUrl": string, "thumbnailUrl": string, "contentDescription": string, "agentId": string } |
字段 | |
---|---|
fileUrl |
可选。文件的公开网址。RBM 平台在提取文件时会根据 HTTP 标头中的 content-type 字段确定文件的 MIME 类型。 支持的图片内容类型:image/jpeg、image/jpg、image/gif、image/png。 支持的视频内容类型:视频/h263、视频/m4v、视频/mp4、视频/mpeg、视频/mpeg4、视频/webm。 |
thumbnailUrl |
可选。与文件对应的缩略图的公开网址。如果未设置此字段,则 RBM 平台会自动根据文件生成缩略图。RBM 平台在提取文件时会根据 HTTP 标头中的 content-type 字段确定文件的 MIME 类型。 支持的图片内容类型:image/jpeg、image/jpg、image/gif、image/png。 |
contentDescription |
可选。文件内容的文本说明。屏幕阅读器会使用此说明来帮助残障用户了解文件包含的内容。 |
agentId |
必需。代理的唯一标识符。 |
响应正文
具有唯一名称的文件资源,代理可在发送消息时用于标识该文件。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{ "name": string } |
字段 | |
---|---|
name |
由服务器分配的文件资源的唯一名称,代理可在发送消息时用于标识文件。格式为“files/{uid}”,其中 {uid} 是唯一 ID。 |
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/rcsbusinessmessaging
有关详情,请参阅 OAuth 2.0 概览。