API: SMS/Appextend - 短信簽名管理API
概覽
sms/appextend
是 SUBMAIL 的短信簽名查詢、創(chuàng)建、更新、和刪除 API。
使用 sms/appextend GET
方式 可以查詢當前appid或目標appid下的簽名列表,包括簽名、審核狀態(tài)。
使用 sms/appextend POST
方式 可以創(chuàng)建短信簽名并提交審核。
使用 sms/appextend PUT
方式 可以更新短信簽名資料信息,如果簽名是駁回狀態(tài),會更新短信簽名至待審核狀態(tài)。
使用 sms/appextend DELETE
方式 可以刪除短信簽名。
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 |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗證機制
sms/appextend GET 方法請求參數(shù)
參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應用集成中創(chuàng)建的短信應用 ID |
signature | string | 必需 | 無 | 應用密匙或數(shù)字簽名 參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
target_appid | string | 可選 | 無 | 目標 appid |
sms_signature | string | 可選 | 無 | 要查詢的短信簽名 |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式( md5 or sha1 or normal )參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
成功返回
{
"status": "success",
"smsSignature": [
{
"appid": "appid",
"smsSignature": "【簽名1】",
"status": 1 //0=審核中、1=審核已通過、其他=審核不通過
},
{
"appid": "appid",
"smsSignature": "【簽名2】",
"status": 1
},
...
]
}
失敗返回
{
"status": "error",
"code": 154,
"msg": "No available SMS signature"
}
sms/appextend POST 方法請求參數(shù)
請求方式
http post
content-type: form-data
參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應用集成中創(chuàng)建的短信應用 ID |
signature | string | 必需 | 無 | 應用密匙或數(shù)字簽名 參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
sms_signature | string | 必需 | 無 | 短信簽名,“【”和“】”符號可省略,參數(shù)處理過程中會移除這兩個符號。 |
company | string | 必需 | 無 | 公司名稱 |
company_lisence_code | string | 必需 | 無 | 公司稅號 |
legal_name | string | 必需 | 無 | 公司法人姓名 |
attachments | file | 必需 | 無 | 證明材料,公司營業(yè)執(zhí)照或商標 |
contact | string | 可選 | 無 | 聯(lián)系人手機號碼,審核結(jié)果會以短信的方式通知到該聯(lián)系人 |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式( md5 or sha1 or normal )參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
注:如果同一APPID下簽名已存在,則無法提交新簽名。
成功返回
{
"status": "success",
}
失敗返回
{
"status": "error",
"code": 127,
"msg": "Sms Signature already exists"
}
sms/appextend PUT 方法請求參數(shù)
請求方式
http put
content-type: form-data
參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應用集成中創(chuàng)建的短信應用 ID |
signature | string | 必需 | 無 | 應用密匙或數(shù)字簽名 參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
sms_signature | string | 必需 | 無 | 短信簽名,“【”和“】”符號可省略,參數(shù)處理過程中會移除這兩個符號。 |
company | string | 可選 | 無 | 公司名稱 |
company_lisence_code | string | 可選 | 無 | 公司稅號 |
legal_name | string | 可選 | 無 | 公司法人姓名 |
attachments | file | 可選 | 無 | 證明材料,公司營業(yè)執(zhí)照或商標 |
contact | string | 可選 | 無 | 聯(lián)系人手機號碼,審核結(jié)果會以短信的方式通知到該聯(lián)系人 |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式( md5 or sha1 or normal )參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
成功返回
{
"status": "success",
}
失敗返回
{
"status": "error",
"code": 154,
"msg": "No available SMS signature"
}
sms/appextend DELETE 方法請求參數(shù)
參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應用集成中創(chuàng)建的短信應用 ID |
signature | string | 必需 | 無 | 應用密匙或數(shù)字簽名 參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
target_appid | string | 可選 | 無 | 目標 appid |
sms_signature | string | 必需 | 無 | 要刪除的短信簽名 |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式( md5 or sha1 or normal )參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
成功返回
{
"status": "success",
}
失敗返回
{
"status": "error",
"code": 154,
"msg": "No available SMS signature"
}