API: SMS/Appextend - 短信签名管理API
概览
sms/appextend 是 SUBMAIL 的短信签名查询和创建 API。
使用 sms/appextend GET方式 可以查询当前appid或目标appid下的签名列表，包括签名、签名扩展码、审核状态。
使用 sms/appextend POST方式 可以创建短信签名并提交审核。
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 |
是否需要授权
是
参阅 API 授权和验证机制
sms/appextend 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 授权与验证机制 > 授权和验证方式 |
成功返回
{
"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"
}sms/appextend POST 方法请求参数
| 参数 | 类型 | 必需/可选 | 默认 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 无 | 在 SUBMAIL 应用集成中创建的短信应用 ID |
signature | string | 必需 | 无 | 应用密匙或数字签名 参阅 API 授权与验证机制 > 授权和验证方式 |
sms_signature | string | 必需 | 无 | 短信签名，“【”和“】”符号可省略，参数处理过程中会移除这两个符号。 |
company | string | 可选 | 无 | 公司名称 （如忽略则默认使用账户的实名信息） |
company_lisence_code | string | 可选 | 无 | 公司税号 （如忽略则默认使用账户的实名信息） |
legal_name | string | 可选 | 无 | 公司责任人姓名 （如忽略则默认使用账户的实名信息） |
legal_id | string | 可选 | 无 | 公司责任人身份证号 （如忽略则默认使用账户的实名信息） |
timestamp | UNIX 时间戳 | 可选 | 无 | 参阅 API 授权与验证机制 > Timestamp UNIX 时间戳 |
sign_type | string | 可选 | normal | API 授权模式（ md5 or sha1 or normal ）参阅 API 授权与验证机制 > 授权和验证方式 |
注：如果同一APPID下签名已存在，则无法提交新签名，如果签名是审核未通过状态，则接口只会更新签名的实名信息并重新提交审核。
成功返回
{
"status": "success",
}失败返回
{
"status": "error",
"code": 127,
"msg": "Sms Signature already exists"
}