API: SMS/XSend - 短信模板發(fā)送
版本號(hào) v4.002
更新說明
2024年11月12日
1. 接口新增了對(duì)動(dòng)態(tài)短信簽名的支持，可以通過sms_signature參數(shù)來實(shí)現(xiàn)通過一個(gè)模板，發(fā)送多種簽名的短信。
概覽
sms/xsend 是 SUBMAIL 的短信 API 的升級(jí)版本。
與 sms/send API 一樣，sms/xsend 提供完整且強(qiáng)大的短信發(fā)送功能，區(qū)別于 sms/send API，sms/xsend 無需提交短信內(nèi)容和短信簽名，僅需提交您創(chuàng)建的短信模版的 ID（請(qǐng)參見 獲取項(xiàng)目 ID），并可以使用文本變量動(dòng)態(tài)的控制每封短信的內(nèi)容。
了解如何使用文本變量。
使用 sms/xsend API 你將可以使用 SUBMAIL 編輯器高效、可視化地創(chuàng)建/管理你的短信模板。當(dāng)用戶請(qǐng)求使用此項(xiàng)目進(jìn)行觸發(fā)時(shí)，SUBMAIL 會(huì)立即執(zhí)行發(fā)送動(dòng)作，無需擔(dān)心發(fā)送延遲問題。
URL
https://api-v4.mysubmail.com/sms/xsend
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/sms/xsend.json（默認(rèn)） |
xml | https://api-v4.mysubmail.com/sms/xsend.xml |
yaml | https://api-v4.mysubmail.com/sms/xsend.yaml |
http 請(qǐng)求方式
| 請(qǐng)求方式 | content-type設(shè)置 |
|---|---|
post | multipart/form-data、x-www-form-urlencoded、application/json |
get |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗(yàn)證機(jī)制
請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短信應(yīng)用 ID |
signature | string | 必需 | 無 | 應(yīng)用密匙或數(shù)字簽名 參閱 API 授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
to | string | 必需 | 無 | 收件人手機(jī)號(hào)碼，該API 僅支持一對(duì)一模式（即單條 API 請(qǐng)求僅能發(fā)送一個(gè)聯(lián)系人），該參數(shù)現(xiàn)在僅能提交一個(gè)位聯(lián)系人。 |
project | string | 必需 | 無 | 模版 ID 在 SUBMAIL > sms >項(xiàng)目中查看你所創(chuàng)建的短信模版 ID。請(qǐng)參見獲取項(xiàng)目 ID |
vars | jsonstring | 可選 | 無 | 使用文本變量動(dòng)態(tài)控制短信中的文本。 參閱 了解如何創(chuàng)建和使用文本變量 |
sms_signature | string | 可選 | 無 | 自定義短信簽名，如果忽略此參數(shù)，將使用模板的默認(rèn)簽名作為簽名（此參數(shù)不參加加密計(jì)算） |
tag | string | 可選 | 無 | 自定義標(biāo)簽功能，該標(biāo)簽可用作 SUBHOOK 追蹤（32 個(gè)字符以內(nèi)，當(dāng)請(qǐng)求傳入此參數(shù)時(shí)則 SUBHOOK 推送時(shí)也會(huì)攜帶此參數(shù)。（此參數(shù)不參與加密計(jì)算） |
timestamp | string | 可選 | 無 | 參閱 API 授權(quán)與驗(yàn)證機(jī)制 > Timestamp UNIX 時(shí)間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式（ md5 or sha1 or normal ）參閱 API 授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
sign_version | string | 可選 | 無 | signature 加密計(jì)算方式(當(dāng) sign_version 傳 2 時(shí)，vars 參數(shù)不參與加密計(jì)算) |
代碼示例
發(fā)送一封測(cè)試短信
POST URL
https://api-v4.mysubmail.com/sms/xsendPOST DATA
appid=your_app_id
&to=138xxxxxxxx
&project=ThJBE4
&signature=your_app_key返回
{
"status": "success", //請(qǐng)求狀態(tài)
"send_id": "893c91d9bfaa433f6952b2902546a8ed", //唯一send_id
"fee": 1 //計(jì)費(fèi)條數(shù)
}使用 CURL 發(fā)送一封測(cè)試短信
發(fā)送 CURL
curl -d 'appid=your_app_id&to=138xxxxxxxx&project=ThJBE4&signature=your_app_key' https://api-v4.mysubmail.com/sms/xsend.json返回值
請(qǐng)求成功
{
"status": "success", //請(qǐng)求狀態(tài)
"send_id": "893c91d9bfaa433f6952b2902546a8ed", //唯一send_id
"fee": 1 //計(jì)費(fèi)條數(shù)
}請(qǐng)求失敗
{
"status":"error", //請(qǐng)求狀態(tài)
"code":"1xx", //失敗碼
"msg":"error sms" //失敗信息描述
}