素材管理 v1

API 概述

功能说明

对 UMS 系统的内部素材和第三方平台的素材进行管理的 API，可以上传图片、视频、文件等素材。

当前仅支持上传附件，用于邮件带附件下发的功能。

调用地址

POST https://api.ums.jiguang.cn/v1/material

调用验证

HTTP Header（头）里加一个字段（ Key/Value 对）：

Authorization: Basic base64_auth_string

          Authorization: Basic base64_auth_string

此代码块在浮窗中显示

其中 base64_auth_string 的生成算法为：base64(ChannelKey:MasterSecret)
即，对 ChannelKey 加上冒号，加上 MasterSecret 拼装起来的字符串，再做 base64 转换。

上传素材

以表单的形式上传一个附件，Content-Type: multipart/form-data

参数	类型	选项	说明
type	String	必填	素材类型，当前仅支持 attachment 1 种类型，代表附件。
file	File	必填	一次仅允许上传1个文件
time_to_live	int	可选	素材有效期，默认值是24小时。对于附件类型，有效期可传的数值范围在[1,168]间，即1小时至168小时（7天）

示例说明

请求示例

curl --location --request POST 'https://api.ums.jiguang.cn/v1/material' \ --header 'Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==' \ --form 'file=@"/D:/ums.pdf"' \ --form 'type="attachment"' \ --form 'time_to_live="169"'

          curl --location --request POST 'https://api.ums.jiguang.cn/v1/material' \
--header 'Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==' \
--form 'file=@"/D:/ums.pdf"' \
--form 'type="attachment"' \
--form 'time_to_live="169"'

此代码块在浮窗中显示

返回参数与示例

参数	类型	选项	说明
code	int	必填	业务状态码，0 代表成功，其他代表失败，详见调用返回码
url	String	必填	上传成功时，将返回文件的地址。对附件来说：该地址仅可用于在消息发送中传值，无法直接请求下载
message	String	可选	失败原因，失败时返回

< HTTP/1.1 200 OK < Content-Type: application/json { "code": 0, "url": "https://jg-ums-inside.obs.cn-north-4.myhuaweicloud.com:443/ums123" }

          < HTTP/1.1 200 OK
< Content-Type: application/json
{
    "code": 0,
    "url": "https://jg-ums-inside.obs.cn-north-4.myhuaweicloud.com:443/ums123"
}

此代码块在浮窗中显示

{"code":1015113,"message":"素材类型不合法，请修改后重试"}

          {"code":1015113,"message":"素材类型不合法，请修改后重试"}

此代码块在浮窗中显示

使用已上传的素材

这里简单介绍下发送邮件时，如何带附件，更多消息发送功能详见普通消息发送

在普通消息发送时，对 msg_email 新增了 files 字段，可以一次传多个附件的 URL 地址。

curl https://api.ums.jiguang.cn/v1/sent -v -X POST -u '10000023A1:750d8f613e13464e942e8bc2' -d ' { "aud_email": [{ "instance": "email", "data": [ "support@jiguang.cn" ] }], "msg_email": [{ "subject": "hello, ums email!", "text": "ums email test. reply", "files": ["https://jg-ums-inside.obs.cn-north-4.myhuaweicloud.com:443/ums123","填写url2"] }], "option": { "sendno": "test_mail", "expire_time": 1602523317, "priority": 2 } }

          curl https://api.ums.jiguang.cn/v1/sent -v -X POST -u '10000023A1:750d8f613e13464e942e8bc2'  -d '
{
  "aud_email": [{
    "instance": "email",
    "data": [
      "support@jiguang.cn"
    ]
  }],
  "msg_email": [{
    "subject": "hello, ums email!",
    "text": "ums email test. reply",
    "files": ["https://jg-ums-inside.obs.cn-north-4.myhuaweicloud.com:443/ums123","填写url2"]
  }],
  "option": {
    "sendno": "test_mail",
    "expire_time": 1602523317,
    "priority": 2
  }
}

此代码块在浮窗中显示

调用返回

调用 API 后的返回码请参考业务返回码

参考

HTTP 返回码：HTTP-Status-Code
HTTP 规范参考：HTTP 基本认证