API: MMS/XSend - 彩信模板發(fā)送
概覽
MMS/xsend 是 SUBMAIL 彩信 單發(fā)API。
URL
https://api-v4.mysubmail.com/mms/xsend
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/mms/xsend.json （默認） |
xml | https://api-v4.mysubmail.com/mms/xsend.xml |
yaml | https://api-v4.mysubmail.com/mms/xsend.yaml |
http 請求方式
| 請求方式 | content-type設(shè)置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的彩信應(yīng)用ID |
to | string | 必需 | 無 | 收件人手機號碼，現(xiàn)在彩信信僅支持一對一模式（即單條API請求僅能發(fā)送一個聯(lián)系人），該參數(shù)現(xiàn)在僅能提交一個位聯(lián)系人。 |
project | string | 必需 | 無 | 模板標記 (ID) |
vars | jsonstring | 可選 | 無 | 使用文本變量動態(tài)控制彩信中的文本。 參閱 了解如何創(chuàng)建和使用文本變量 |
tag | string | 可選 | 無 | 自定義標簽功能，該標簽可用作SUBHOOK追蹤（32 個字符以內(nèi)，當請求傳入此參數(shù)時則SUBHOOK推送時也會攜帶此參數(shù)） |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式（ md5 or sha1 or normal ）參閱 API 授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
signature | string | 必需 | 無 | 應(yīng)用密匙或數(shù)字簽名 參閱 API授權(quán)與驗證機制 > 授權(quán)和驗證方式 |
代碼示例
發(fā)送一封測試短信
POST URL
https://api-v4.mysubmail.com/mms/xsend.jsonPOST DATA
appid=your_app_id
&to=138xxxxxxxx
&project=ThJBE4
&signature=your_app_key返回
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":0.18
}使用 CURL 發(fā)送一封測試短信
發(fā)送 CURL
curl -d 'appid=your_app_id&to=138xxxxxxxx&&project=ThJBE4&signature=your_app_key' https://api-v4.mysubmail.com/message/xsend.xml返回
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":0.18
}返回值
請求成功
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":0.18
}請求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}