API: SMS/MultiXSend - 短信模板一對(duì)多發(fā)送

版本號(hào) v4.002

更新說明

2024年11月12日

1. 接口新增了對(duì)動(dòng)態(tài)短信簽名的支持，可以通過sms_signature參數(shù)來實(shí)現(xiàn)通過一個(gè)模板，發(fā)送多種簽名的短信。

概覽

sms/multixsend 是 SUBMAIL 的短信一對(duì)多（即1條API請(qǐng)求發(fā)送多個(gè)號(hào)碼，并可以靈活控制每個(gè)聯(lián)系人的文本變量）和群發(fā) API 。（建議： 單線程提交數(shù)量控制在50—200個(gè)聯(lián)系人， 可以開多個(gè)線程同時(shí)發(fā)送）

與 sms/xsend API 一樣，sms/multixsend 提供完整且強(qiáng)大的短信發(fā)送功能，sms/multixsend 解決開發(fā)者在應(yīng)用場(chǎng)景中的一對(duì)多或群發(fā)的需求，極大的提高 API 并發(fā)效率。

使用方法與 sms/xsend 極為相似，不同的是 sms/multixsend 去除了 to 和 vars 參數(shù)將其整合到 multi 參數(shù)中，可以將聯(lián)系人的手機(jī)號(hào)碼，和不同的文本變量整合，實(shí)現(xiàn)一對(duì)多場(chǎng)景中靈活控制文本變量的功能。

開發(fā)者們可在提交 sms/multixsend API 時(shí)，將 to 和 vars 參數(shù)編碼為 JSON 字符串格式添加到 multi 參數(shù)中提交，multi 參數(shù)的數(shù)據(jù)模型請(qǐng)參考以下示例：

multi=[{
        "to":"15*********",
        "vars":{
            "name":"kevin",
            "code":123456
        }
    },{
        "to":"18*********",
        "vars":{
            "name":"jacky",
            "code":236554
        }
    },{
        "to":"13*********",
        "vars":{
            "name":"tom",
            "code":236554
        }]

完整的 sms/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/sms/multixsend

支持格式

http 請(qǐng)求方式

是否需要授權(quán)

是

參閱 API 授權(quán)和驗(yàn)證機(jī)制

請(qǐng)求參數(shù)

注：為了保證響應(yīng)速度，建議單次請(qǐng)求號(hào)碼數(shù)量不超過200個(gè)號(hào)碼

代碼示例

發(fā)送一封測(cè)試短信

POST URL

https://api-v4.mysubmail.com/sms/multixsend

POST DATA

appid=your_app_id
&project=ThJBE4
&multi=[{
    "to":"15*********",
    "vars":{
        "name":"kevin",
        "code":123456
        }
    },{
    "to":"18*********",
    "vars":{
        "name":"jacky",
        "code":236554
        }
    }]
&signature=your_app_key

返回值

請(qǐng)求成功

[
   {
        "status":"success",
        "to":"15*********",
        "send_id":"093c0a7df143c087d6cba9cdf0cf3738",
        "fee":1
    },{
        "status":"success",
        "to":"18*********",
        "send_id":"093c0a7df143c087d6cba9cdf0cf3738",
        "fee":1
    }
]

請(qǐng)求失敗

[
   {
        "status":"error",
        "code":1xx,
        "msg":"error sms"
    },{
        "status":"success",
        "to":"18*********",
        "send_id":"093c0a7df143c087d6cba9cdf0cf3738",
        "fee": 1
    }
]

• 注：sms/multixsend API 中返回碼將包含成功和失敗的狀態(tài) ，API 在一條API中發(fā)起對(duì)多個(gè)號(hào)碼的請(qǐng)求，所以返回狀態(tài)也是按多條API計(jì)算的，例如：單次請(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)）

錯(cuò)誤代碼

參閱 API 錯(cuò)誤代碼