API: rcs/upload - 上傳素材
概覽
rcs/upload
是 SUBMAIL 5G消息的素材上傳 API,素材通過審核并上傳成功后,即可創(chuàng)建5G消息模板,或發(fā)送5G消息。
通過接口接入的素材管理,請通過subhook接入獲取素材通過審核后的路徑等信息。
注:上傳的素材有效期為7天,請在素材即將過期時,重新請求此接口刷新素材的有效期!
URL
https://api-v4.mysubmail.com/rcs/upload
接口響應(yīng)數(shù)據(jù)格式
格式 | URL |
---|---|
json | https://api-v4.mysubmail.com/rcs/upload.json (默認(rèn)) |
xml | https://api-v4.mysubmail.com/rcs/upload.xml |
yaml | https://api-v4.mysubmail.com/rcs/upload.yaml |
http 請求方式
請求方式 | content-type設(shè)置 |
---|---|
post | multipart/form-data、x-www-form-urlencoded、application/json |
請求參數(shù)
參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
---|---|---|---|---|
appid | string | 必須 | 無 | 在 SUBMAIL Chatbot中創(chuàng)建的5G消息應(yīng)用ID |
sign | string | 必須 | 無 | 素材ID |
timestamp | int | 可選 | 無 | UNIX 時間戳,結(jié)果以秒為單位,使用加密鑒權(quán)方式,此參數(shù)必填 |
signType | string | 可選 | normal | API 鑒權(quán)模式,可選參數(shù)normal 、sha256 |
signature | string | 必須 | 無 | 鑒權(quán)簽名 1. 當(dāng) signType 為sha256 時,將以下參數(shù)拼接appid +appkey +appid=?&signType=sha256& timestamp=1712122221 +appid +appkey “+”號為鏈接符號,不參與拼接 用sha256將以上拼接字符串加密作為鑒權(quán)參數(shù) 當(dāng) 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":"錯誤信息描述"
}