API: aim/upload - 上傳素材
概覽
aim/upload 是 SUBMAIL AIM閱信的素材上傳 API。
URL
https://api-v4.mysubmail.com/aim/upload
接口響應(yīng)數(shù)據(jù)格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/aim/upload.json（默認） |
http 請求方式
| 請求方式 | content-type設(shè)置 |
|---|---|
post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗證機制
請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短信應(yīng)用ID |
uploadType | int | 可選 | 0 | 0為通過文件上傳，1為通過base64編碼上上傳 |
file | file | 條件可選 | 無 | uploadType參數(shù)為0時，該參數(shù)必填。素材文件，可支持的格式為： 圖片：（jpg、jpeg、png）最大不超過20M 視頻：mp4，視頻最大不超過10M *圖片素材大小建議控制在2M內(nèi)，否則影響用戶側(cè)解析時間和解析效果* |
contentType | string | 條件可選 | 無 | uploadType參數(shù)為1時，該參數(shù)必填。文件擴展類型。 可選值：jpg、jpeg、png、mp4 |
fileData | string | 條件可選 | 無 | upload_type參數(shù)為1時，該參數(shù)必填。素材文件，可支持的格式為： 圖片：（jpg、jpeg、png）最大不超過20M 視頻：mp4，視頻最大不超過10M *圖片素材大小建議控制在2M內(nèi)，否則影響用戶側(cè)解析時間和解析效果* |
fileRate | int | 可選 | 0 | 當上傳的素材為圖片時，該參數(shù)有效，參數(shù)可選值： 0. 圖片長寬比為1:1 1. 圖片長寬比為16:9 2. 圖片長寬比為3:1 3. 圖片長寬比為48:65 *請自行調(diào)整好圖片的長寬比后上傳* |
timestamp | int | 可選 | 無 | UNIX 時間戳，結(jié)果以秒為單位，使用加密鑒權(quán)方式，此參數(shù)必填 |
signType | string | 可選 | normal | API 鑒權(quán)模式，可選參數(shù)normal、sha256 |
signature | string | 必需 | 無 | 鑒權(quán)簽名: 1. 當signType為sha256時，將以下參數(shù)拼接appid+appkey+appid=12345&signType=sha256& timestamp=1712122221+appid+appkey ,“+”號為鏈接符號，不參與拼接用sha256將以上拼接字符串加密作為鑒權(quán)參數(shù) 2.當signType為normal時，appkey即是signature的值。 |
代碼示例
發(fā)送一封測試短信
POST URL
https://api-v4.mysubmail.com/aim/uploadPOST DATA
{
"appid":"your_app_id",
"signature":"your_app_key",
"contentType":"png",
"fileData":"/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNr………………",
"fileRate":0
}成功返回
{
"status": "success", //請求狀態(tài)
"id": "ikJvMC", //素材ID
}失敗返回
{
"status":"error", //請求狀態(tài)
"code":"1xx", //失敗碼
"msg":"error sms" //失敗信息描述
}