API: rcs/batchxsend - 群發(fā)消息API
概覽
rcs/batchxsend 用于通過模板群發(fā)消息和點對點消息，模板正文、懸浮菜單支持變量。
URL
https://api-v4.mysubmail.com/rcs/batchxsend
接口響應數據格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/rcs/batchxsend.json（默認） |
xml | https://api-v4.mysubmail.com/rcs/batchxsend.xml |
yaml | https://api-v4.mysubmail.com/rcs/batchxsend.yaml |
一、創(chuàng)建模板
| 請求方式 | content-type設置 |
|---|---|
post | multipart/form-data、x-www-form-urlencoded、application/json |
請求參數
| 參數 | 類型 | 必須/可選 | 默認 | 描述 |
|---|---|---|---|---|
appid | string | 必須 | 無 | 在 SUBMAIL Chatbot中創(chuàng)建的5G消息應用ID |
timestamp | int | 可選 | 無 | UNIX 時間戳，結果以秒為單位，使用加密鑒權方式，此參數必填 |
signType | enum | 可選 | normal | API 鑒權模式，可選參數normal、sha256 |
signature | string | 必須 | 無 | 鑒權簽名 1. 當 signType為sha256時，將以下參數拼接appid+appkey+appid=12345&signType=sha256& timestamp=1712122221+appid+appkey“+”號為鏈接符號，不參與拼接 用sha256將以上拼接字符串加密作為鑒權參數 當 signType為normal時，appkey即是signature的值 |
tos | string | 必須 | 無 | 接收方手機號，多個號碼用半角逗號分隔，一次最大提交100個號碼，示例：15288888888,15266666666,15299999999 |
conversationID | string | 必須 | 無 | 唯一標識主被叫用戶間的一個聊天對話，建議使用UUID。終端點擊消息中的建議操作或建議回復按鈕，觸發(fā)上行消息攜帶的conversationID將填寫該下行消息的conversationID值 |
contributionId | string | 必須 | 無 | 唯一標識一個聊天會話，建議使用UUID。終端點擊此消息中的建議操作或建議回復按鈕，觸發(fā)上行消息攜帶的inReplyToContributionID將填寫該下行消息的contributionID值。 |
trafficType | enum | 可選 | advertisement | 流量標識，可選值包括：advertisement payment premium subscription plugin |
shortMessageSupported | string | 可選 | false | 是否支持短信回落， true：轉短信，false：不轉短信 |
smsBodyText | string | 可選 | 無 | 當sms參數為true時，此參數必填，當接收方手機不支持5G消息時，消息會以短信的形式回落。當sms參數為false時，此參數無效注： 回落短信至終端時平臺會自動在短信內容的基礎上拼接中文括號+Chatbot簽名，總長度按UTF-8編碼字節(jié)數計算，示例： 短信內容：回落短信 Chatbot簽名：機器人 最終回落內容：【機器人】回落短信 最終回落內容字節(jié)數：27 如最終回落內容字節(jié)數超過1340，回落至終端的文本會轉化為鏈接，以終端實際效果為準。 |
multimediaMessageSupported | string | 可選 | false | 是否支持彩信回落，true：轉彩信，false：不轉彩信 |
mmsSubject | string | 可選 | 無 | 彩信標題，最長60個字節(jié)，支持彩信回落時，該參數為必須參數 |
mmsContentLength | int | 可選 | 無 | 彩信素材大小，支持彩信回落時，該參數為必須參數 |
mmsBodyText | string | 可選 | 無 | 彩信文件url，支持彩信回落時，該參數為必須參數 注： 彩信文件URL需使用上傳素材文件后的鏈接 |
templateID | string | 必須 | 無 | 模板ID |
vars | json | 可選 | 無 | 變量內容 |
sendlist | string | 可選 | 無 | 批量群發(fā)任務標識 |
請求示例
成功返回
{
"status": "success",
[{
"status":"success",
"to":"15288888888",
"send_id":"daa21ecf309149d04108004f6198f0d9",
"fee":1
},{
"status":"success",
"to":"15266666666",
"send_id":"4ee9be3058004b7f6a945558d580f4ce",
"fee":1
}]
}失敗返回
{
"status":"error",
"code":"2xxx",
"msg":"錯誤信息描述"
}