API: InternationalSMS/Send - 国际短信发送
概览
internationalsms/send
是 SUBMAIL 的国际短信 API。 internationalsms/send
和国内短信 API 不共享短信模板,当使用 internationalsms/send
API 提交短信时,无需创建模板并且不对短信签名做约束,用户可自定义短信内容,能够更加灵活方便的集成。
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 授权和验证机制
请求参数
参数 | 类型 | 必需/可选 | 默认 | 描述 |
---|---|---|---|---|
appid | string | 必需 | 无 | 在 SUBMAIL 应用集成中创建的国际短信应用ID |
to | string | 必需 | 无 | 收件人手机号码,使用标准的 E164 格式,e.g. +1778889901(仅支持单个手机号码,不支持 +86 国内手机号码) |
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参数不参与加密计算) |
signature | string | 必需 | 无 | 应用密匙或数字签名 参阅 API授权与验证机制 > 授权和验证方式 |
注意:
content 可以传自定义内容,非必须短信签名,纯英文短信(包括标点符号,短信签名的[]也需英文)单条按140个字符计费,超过140个字符每132个字符计费一次,其他语言单条按70个字符计费,超过70个字符每67个字符计费一次。请将 短信正文控制在 500 个字符以内。
代码示例
发送一封测试短信
POST URL
https://api-v4.mysubmail.com/internationalsms/send.json
POST DATA
appid=your_app_id
&to=+17788xxxxxxxx
&content=【SUBMAIL】您的短信验证码:4438,请在10分钟内输入。
&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&content=【SUBMAIL】您的短信验证码:4438,请在10分钟内输入。&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"
}