API: InternationalSMS/MultiXSend - 國(guó)際短信模板一對(duì)多發(fā)送
概覽
internationalsms/multixsend
是 SUBMAIL 的國(guó)際短信一對(duì)多(即1條API請(qǐng)求發(fā)送多個(gè)號(hào)碼,并可以靈活控制每個(gè)聯(lián)系人的文本變量)和群發(fā) API 。
internationalsms/multixsend
能夠提供完整且強(qiáng)大的短信發(fā)送功能,internationalsms/multixsend
解決開(kāi)發(fā)者在應(yīng)用場(chǎng)景中的一對(duì)多或群發(fā)的需求,極大的提高 API 并發(fā)效率。
開(kāi)發(fā)者們可在提交 internationalsms/multixsend
API 時(shí),將 to
和 vars
參數(shù)編碼為 JSON
字符串格式添加到 multi
參數(shù)中提交,multi 參數(shù)的數(shù)據(jù)模型請(qǐng)參考以下示例:
multi=[{
"to":"+177888*********",
"vars":{
"name":"kevin",
"code":123456
}
},{
"to":"+8529*********",
"vars":{
"name":"jacky",
"code":236554
}
},{
"to":"+45489*********",
"vars":{
"name":"tom",
"code":236554
}]
完整的 internationalsms/multixsend
POST 請(qǐng)求請(qǐng)參考以下示例:
appid=your_app_id
&project=EM9sd
&multi=[{
"to":"+15*********",
"vars":{
"name":"kevin",
"code":123456
}
},{
"to":"+18*********",
"vars":{
"name":"jacky",
"code":236554
}
},{
"to":"+13*********",
"vars":{
"name":"tom",
"code":236554
}]
&signature=your_app_key
URL
https://api-v4.mysubmail.com/internationalsms/multixsend
支持格式
格式 | URL |
---|---|
json | https://api-v4.mysubmail.com/internationalsms/multixsend.json (默認(rèn)) |
xml | https://api-v4.mysubmail.com/internationalsms/multixsend.xml |
yaml | https://api-v4.mysubmail.com/internationalsms/multixsend.yaml |
http 請(qǐng)求方式
請(qǐng)求方式 | content-type設(shè)置 |
---|---|
http post | multipart/form-data 、x-www-form-urlencoded 、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗(yàn)證機(jī)制
請(qǐng)求參數(shù)
參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
---|---|---|---|---|
appid | string | 必需 | 無(wú) | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的國(guó)際短信應(yīng)用 ID |
project | string | 必需 | 無(wú) | 項(xiàng)目標(biāo)記,在 SUBMAIL >國(guó)際 短信>項(xiàng)目列表中查看你所創(chuàng)建的短信項(xiàng)目(模板ID)標(biāo)記。請(qǐng)參見(jiàn) 獲取項(xiàng)目 ID |
multi | json string | 必需 | 無(wú) | 收件人 to 聯(lián)系人參數(shù)和 vars 文本變量的整合模式,請(qǐng)將 to 和 vars 整合成 json字符串格式提交(數(shù)據(jù)模型請(qǐng)參考本頁(yè)概覽頁(yè)面提交打multi參數(shù)示例) |
timestamp | UNIX 時(shí)間戳 | 可選 | 無(wú) | 參閱 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 | 可選 | 無(wú) | signature加密計(jì)算方式(當(dāng)sign_version傳2時(shí),multi參數(shù)不參與加密計(jì)算) |
signature | string | 必需 | 無(wú) | 應(yīng)用密匙或數(shù)字簽名 參閱 API授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
代碼示例
發(fā)送一封測(cè)試短信
POST URL
https://api-v4.mysubmail.com/internationalsms/multixsend.json
POST DATA
appid=your_app_id
&project=ThJBE4
&multi=[{
"to":"+17788xxxxxxxx",
"vars":{
"name":"kevin",
"code":123456
}
},{
"to":"+17788xxxxxxxx",
"vars":{
"name":"jacky",
"code":236554
}
}]
&signature=your_app_key
返回值
請(qǐng)求成功
[
{
"status":"success",
"to":"+17788xxxxxxxx",
"send_id":"093c0a7df143c087d6cba9cdf0cf3738",
"fee":0.05,
"account_balance":14197.087
},{
"status":"success",
"to":"+17788xxxxxxxx",
"send_id":"093c0a7df143c087d6cba9cdf0cf3738",
"fee":0.05,
"account_balance":14197.037
}
]
請(qǐng)求失敗
[
{
"status":"error",
"code":1xx,
"msg":"error message"
},{
"status":"success",
"to":"+17788xxxxxxxx",
"send_id":"093c0a7df143c087d6cba9cdf0cf3738",
"fee":0.05,
"account_balance":14197.087
}
]
注:internationalsms/multixsend API
中返回碼將包含成功和失敗的狀態(tài) ,API 在一條API中發(fā)起對(duì)多個(gè)號(hào)碼的請(qǐng)求,所以返回狀態(tài)也是按多條API計(jì)算的,例如:?jiǎn)未握?qǐng)求中包含3個(gè)聯(lián)系人,其中2個(gè)聯(lián)系人請(qǐng)求成功,1個(gè)聯(lián)系人請(qǐng)求失敗時(shí),此時(shí)的API返回狀態(tài),將包含3條狀態(tài)數(shù)組(即2條 status:success
,1條 status:error
的狀態(tài))