API: InternationalSMS/Send - 國際短信發(fā)送
概覽
internationalsms/send 是 SUBMAIL 的國際短信 API。 internationalsms/send 和國內(nèi)短信 API 不共享短信模板，當使用 internationalsms/send API 提交短信時，無需創(chuàng)建模板并且不對短信簽名做約束，用戶可自定義短信內(nèi)容，能夠更加靈活方便的集成。
URL
https://api-v4.mysubmail.com/internationalsms/send
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/internationalsms/send.json （默認） |
xml | https://api-v4.mysubmail.com/internationalsms/send.xml |
yaml | https://api-v4.mysubmail.com/internationalsms/send.yaml |
http 請求方式
| 請求方式 | content-type設置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權
是
參閱 API 授權和驗證機制
請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應用集成中創(chuàng)建的國際短信應用ID |
to | string | 必需 | 無 | 收件人手機號碼，使用標準的 E164 格式，e.g. +1778889901(僅支持單個手機號碼，不支持 +86 國內(nèi)手機號碼) |
content | string | 必需 | 無 | 短信正文 |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權與驗證機制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權模式（ md5 or sha1 or normal ）參閱 API 授權與驗證機制 > 授權和驗證方式 |
sign_version | string | 可選 | 無 | signature加密計算方式(當sign_version傳2時，content參數(shù)不參與加密計算) |
signature | string | 必需 | 無 | 應用密匙或數(shù)字簽名 參閱 API授權與驗證機制 > 授權和驗證方式 |
注意：
content 可以傳自定義內(nèi)容，非必須短信簽名，純英文短信（包括標點符號，短信簽名的[]也需英文）單條按140個字符計費，超過140個字符每132個字符計費一次，其他語言單條按70個字符計費，超過70個字符每67個字符計費一次。請將 短信正文控制在 500 個字符以內(nèi)。代碼示例
發(fā)送一封測試短信
POST URL
https://api-v4.mysubmail.com/internationalsms/send.jsonPOST DATA
appid=your_app_id
&to=+17788xxxxxxxx
&content=【SUBMAIL】您的短信驗證碼：4438，請在10分鐘內(nèi)輸入。
&signature=your_app_key返回
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":0.046,
"account_balance":14197.087
}使用CURL 發(fā)送一封測試短信
發(fā)送 CURL
curl -d 'appid=your_app_id&to=+17788xxxxxxxx&content=【SUBMAIL】您的短信驗證碼：4438，請在10分鐘內(nèi)輸入。&signature=your_app_key' https://api-v4.mysubmail.com/internationalsms/send.json返回
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":0.046,
"account_balance":14197.087
}返回值
請求成功
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":0.046,
"account_balance":14197.087
}請求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}