API: InternationalSMS/XSend - 国际短信模板发送
概览
internationalsms/xsend 是 SUBMAIL 的国际短信单发API。
URL
https://api-v4.mysubmail.com/internationalsms/xsend
支持格式
| 格式 | URL |
|---|
json | https://api-v4.mysubmail.com/internationalsms/xsend.json （默认） |
xml | https://api-v4.mysubmail.com/internationalsms/xsend.xml |
yaml | https://api-v4.mysubmail.com/internationalsms/xsend.yaml |
http 请求方式
| 请求方式 | content-type设置 |
|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授权
是
请求参数
| 参数 | 类型 | 必需/可选 | 默认 | 描述 |
|---|
appid | string | 必需 | 无 | 在 SUBMAIL 应用集成中创建的国际短信应用 ID |
to | string | 必需 | 无 | 收件人手机号码，使用标准的 E164 格式，e.g. +1778889901（仅支持单个手机号码，不支持 +86 国内手机号码） |
project | string | 必需 | 无 | 项目标记,在 SUBMAIL > 短信>项目列表中查看你所创建的短信项目（模板ID）标记。请参见获取项目 ID |
vars | jsonstring | 必需 | 无 | 使用文本变量动态控制短信中的文本。参阅 了解如何创建和使用文本变量 |
tag | string | 可选 | 无 | 自定义标签功能，该标签可用作SUBHOOK追踪（32 个字符以内） |
timestamp | UNIX 时间戳 | 可选 | 无 | 参阅 API 授权与验证机制 > Timestamp UNIX 时间戳 |
sign_type | string | 可选 | normal | API 授权模式（ md5 or sha1 or normal ）参阅 API 授权与验证机制 > 授权和验证方式 |
sign_version | string | 可选 | 无 | signature加密计算方式(当sign_version传2时，vars参数不参与加密计算) |
signature | string | 必需 | 无 | 应用密匙或数字签名参阅 API授权与验证机制 > 授权和验证方式 |
代码示例
发送一封测试短信
POST URL
https://api-v4.mysubmail.com/internationalsms/xsend.json
POST DATA
appid=your_app_id
&to=+17788xxxxxxxx
&project=ThJBE4
&signature=your_app_key
返回
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":0.046,
"account_balance":14197.087
}
使用CURL 发送一封测试短信
发送 CURL
curl -d 'appid=your_app_id&to=+17788xxxxxxxx&project=ThJBE4&signature=your_app_key' https://api-v4.mysubmail.com/internationalsms/xsend.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"
}
错误代码
