API: rcs/upload - 上传素材
概览
rcs/upload
是 SUBMAIL 5G消息的素材上传 API,素材通过审核并上传成功后,即可创建5G消息模板,或发送5G消息。
通过接口接入的素材管理,请通过subhook接入获取素材通过审核后的路径等信息。
注:上传的素材有效期为7天,请在素材即将过期时,重新请求此接口刷新素材的有效期!
URL
https://api-v4.mysubmail.com/rcs/upload
接口响应数据格式
格式 | URL |
---|---|
json | https://api-v4.mysubmail.com/rcs/upload.json (默认) |
xml | https://api-v4.mysubmail.com/rcs/upload.xml |
yaml | https://api-v4.mysubmail.com/rcs/upload.yaml |
http 请求方式
请求方式 | content-type设置 |
---|---|
post | multipart/form-data、x-www-form-urlencoded、application/json |
请求参数
参数 | 类型 | 必需/可选 | 默认 | 描述 |
---|---|---|---|---|
appid | string | 必须 | 无 | 在 SUBMAIL Chatbot中创建的5G消息应用ID |
sign | string | 必须 | 无 | 素材ID |
timestamp | int | 可选 | 无 | UNIX 时间戳,结果以秒为单位,使用加密鉴权方式,此参数必填 |
signType | string | 可选 | normal | API 鉴权模式,可选参数normal 、sha256 |
signature | string | 必须 | 无 | 鉴权签名 1. 当 signType 为sha256 时,将以下参数拼接appid +appkey +appid=?&signType=sha256& timestamp=1712122221 +appid +appkey “+”号为链接符号,不参与拼接 用sha256将以上拼接字符串加密作为鉴权参数 当 signType 为normal 时,appkey 即是signature 的值 |
请求示例
POST URL
POST /mail/send HTTP/1.1
Host: api-v4.mysubmail.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 40
appid=appid&signature=appkey&sign=xxxxxx
成功返回
{
"status": "success",
"msg": "上传成功,请等待审核通过!",
}
失败返回
{
"status":"error",
"code":"2xxx",
"msg":"错误信息描述"
}