API: SMS/Appextend - Appid可用签名查询
概览
sms/appextend
是 SUBMAIL 的短信签名查询 API。
使用 sms/appextend
可以查询当前appid或目标appid下的签名列表,包括签名、签名扩展码、审核状态。
URL
https://api-v4.mysubmail.com/sms/appextend
支持格式
格式 | URL |
---|---|
json | https://api-v4.mysubmail.com/sms/appextend .json (默认) |
xml | https://api-v4.mysubmail.com/sms/appextend .xml |
yaml | https://api-v4.mysubmail.com/sms/appextend .yaml |
http 请求方式
- HTTP GET
是否需要授权
是
参阅 API 授权和验证机制
sms/template GET 方法(获取模板列表)请求参数
参数 | 类型 | 必需/可选 | 默认 | 描述 |
---|---|---|---|---|
appid | string | 必需 | 无 | 在 SUBMAIL 应用集成中创建的短信应用 ID |
signature | string | 必需 | 无 | 应用密匙或数字签名 参阅 API 授权与验证机制 > 授权和验证方式 |
target_appid | string | 可选 | 无 | 目标 appid |
timestamp | UNIX 时间戳 | 可选 | 无 | 参阅 API 授权与验证机制 > Timestamp UNIX 时间戳 |
sign_type | string | 可选 | normal | API 授权模式( md5 or sha1 or normal )参阅 API 授权与验证机制 > 授权和验证方式 |
代码示列
使用 CURL GET方法获取模板列表
发送 CURL
curl --location 'https://api-v4.mysubmail.com/sms/appextend?appid=your appid&signature=your appkey'
返回
{
"status": "success",
"smsSignature": [
{
"appid": "appid",
"smsSignature": "【签名1】",
"extend": "扩展码",
"status": 1 //0=审核中、1=审核已通过、其他=审核不通过
},
{
"appid": "appid",
"smsSignature": "【签名2】",
"extend": "扩展码",
"status": 1
},
...
]
}
请求失败
{
"status": "error",
"code": 154,
"msg": "No available SMS signature"
}