API: Message/xsend


概览


一分钟快速集成短信验证码[图文教程]

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

message/send API 一样,message/xsend 提供完整且强大的短信发送功能,区别于 message/send API,message/xsend 无需提交短信内容和短信签名,仅需提交你在 SUBMAIL MESSAGE 应用程序中创建的短信项目的标记(请参见 获取开发者标识),并可以使用文本变量动态的控制每封短信的内容。

了解如何使用文本变量

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



URL


<主> https://api.mysubmail.com/message/xsend
<备> https://api.submail.cn/message/xsend


支持格式


格式URL
jsonhttps://api.mysubmail.com/message/xsend.json(默认)
xmlhttps://api.mysubmail.com/message/xsend.xml


http 请求方式


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


是否需要授权


参阅 API 授权和验证机制


请求参数


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


代码示例


发送一封测试短信


POST URL
https://api.mysubmail.com/message/xsend.json


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


返回
{
    "status": "success",
    "send_id": "c2f0e679ad8dxxxxxf6cb71bf2925665e0",
    "fee": 1,
    "sms_credits": "21129",
    "transactional_sms_credits": "0"
}


使用 CURL 发送一封测试短信


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


返回
{
    "status": "success",
    "send_id": "c2f0e679ad8dxxxxxf6cb71bf2925665e0",
    "fee": 1,
    "sms_credits": "21129",
    "transactional_sms_credits": "0"
}


返回值


请求成功
{
    "status": "success",
    "send_id": "c2f0e679ad8dxxxxxf6cb71bf2925665e0",
    "fee": 1,
    "sms_credits": "21129",
    "transactional_sms_credits": "0"
}


请求失败
{
      "status":"error",
      "code":"1xx",
      "msg":"error message"
}


错误代码


参阅 API 错误代码