注册送短信

API: aim/upload - 上传素材


概览


aim/upload 是 SUBMAIL AIM阅信的素材上传 API。



URL


https://api-v4.mysubmail.com/aim/upload


接口响应数据格式


格式URL
jsonhttps://api-v4.mysubmail.com/aim/upload.json(默认)


http 请求方式


请求方式content-type设置
postmultipart/form-data、x-www-form-urlencoded、application/json


是否需要授权


参阅 API 授权和验证机制


请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短信应用ID
uploadTypeint可选00为通过文件上传,1为通过base64编码上上传
filefile条件可选uploadType参数为0时,该参数必填。
素材文件,可支持的格式为:
图片:(jpg、jpeg、png)最大不超过20M
视频:mp4,视频最大不超过10M
*图片素材大小建议控制在2M内,否则影响用户侧解析时间和解析效果*
contentTypestring条件可选uploadType参数为1时,该参数必填。
文件扩展类型。
可选值:jpg、jpeg、png、mp4
fileDatastring条件可选upload_type参数为1时,该参数必填。
素材文件,可支持的格式为:
图片:(jpg、jpeg、png)最大不超过20M
视频:mp4,视频最大不超过10M
*图片素材大小建议控制在2M内,否则影响用户侧解析时间和解析效果*
fileRateint可选0当上传的素材为图片时,该参数有效,参数可选值:
0. 图片长宽比为1:1
1. 图片长宽比为16:9
2. 图片长宽比为3:1
3. 图片长宽比为48:65
*请自行调整好图片的长宽比后上传*
timestampint可选UNIX 时间戳,结果以秒为单位,使用加密鉴权方式,此参数必填
signTypestring可选normalAPI 鉴权模式,可选参数normal、sha256
signaturestring必需鉴权签名:
1. 当signType为sha256时,将以下参数拼接appid+appkey+appid=12345&signType=sha256& timestamp=1712122221+appid+appkey ,“+”号为链接符号,不参与拼接用sha256将以上拼接字符串加密作为鉴权参数
2.当signType为normal时,appkey即是signature的值。


代码示例


发送一封测试短信


POST URL
https://api-v4.mysubmail.com/aim/upload


POST DATA
{
  "appid":"your_app_id",
  "signature":"your_app_key",
  "contentType":"png",
  "fileData":"/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNr………………",
  "fileRate":0
}


成功返回
{
  "status": "success",  //请求状态
  "id": "ikJvMC", //素材ID
}


失败返回
{
  "status":"error",  //请求状态
  "code":"1xx",      //失败码
  "msg":"error sms"  //失败信息描述
}