注册送短信

API: SMS/XSend - 短信模板发送


概览


sms/xsend 是 SUBMAIL 的短信 API 的升级版本。

sms/send API 一样,sms/xsend 提供完整且强大的短信发送功能,区别于 sms/send API,sms/xsend 无需提交短信内容和短信签名,仅需提交您创建的短信模版的 ID(请参见 获取项目 ID),并可以使用文本变量动态的控制每封短信的内容。

了解如何使用文本变量

使用 sms/xsend API 你将可以使用 SUBMAIL 编辑器高效、可视化地创建/管理你的短信模板。当用户请求使用此项目进行触发时,SUBMAIL 会立即执行发送动作,无需担心发送延迟问题。



URL


https://api-v4.mysubmail.com/sms/xsend


支持格式


格式URL
jsonhttps://api-v4.mysubmail.com/sms/xsend.json(默认)
xmlhttps://api-v4.mysubmail.com/sms/xsend.xml
yamlhttps://api-v4.mysubmail.com/sms/xsend.yaml


http 请求方式


请求方式content-type设置
postmultipart/form-datax-www-form-urlencodedapplication/json
get


是否需要授权


参阅 API 授权和验证机制


请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短信应用 ID
signaturestring必需应用密匙或数字签名
参阅 API 授权与验证机制 > 授权和验证方式
tostring必需收件人手机号码,该API 仅支持一对一模式(即单条 API 请求仅能发送一个联系人),该参数现在仅能提交一个位联系人。
projectstring必需模版 ID
在 SUBMAIL > sms >项目中查看你所创建的短信模版 ID。请参见获取项目 ID
varsjsonstring可选使用文本变量动态控制短信中的文本。
参阅 了解如何创建和使用文本变量
tagstring可选自定义标签功能,该标签可用作 SUBHOOK 追踪(32 个字符以内,当请求传入此参数时则 SUBHOOK 推送时也会携带此参数。tag参数不参加加密计算)
timestampstring可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式
sign_versionstring可选signature 加密计算方式(当 sign_version 传 2 时,vars 参数不参与加密计算)


代码示例


发送一封测试短信


POST URL
https://api-v4.mysubmail.com/sms/xsend


POST DATA
appid=your_app_id
&to=138xxxxxxxx
&project=ThJBE4
&signature=your_app_key


返回
{
    "status": "success",  //请求状态
    "send_id": "893c91d9bfaa433f6952b2902546a8ed", //唯一send_id
    "fee": 1 //计费条数
}


使用 CURL 发送一封测试短信


发送 CURL
curl -d 'appid=your_app_id&to=138xxxxxxxx&project=ThJBE4&signature=your_app_key' https://api-v4.mysubmail.com/sms/xsend.json


返回值


请求成功
{
    "status": "success",  //请求状态
    "send_id": "893c91d9bfaa433f6952b2902546a8ed", //唯一send_id
    "fee": 1 //计费条数
}


请求失败
{
      "status":"error",  //请求状态
      "code":"1xx",      //失败码
      "msg":"error sms"  //失败信息描述
}


错误代码


参阅 API 错误代码