API: Message/send


概览


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

message/send 是 SUBMAIL 的短信 API。 message/send API 提供强大的短信发送功能, 并允许用户自定义短信签名及正文,无需提前创建模板,SUBMAIL 会根据您提交的短信签名和内容,自动创建模板并发送。



URL


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


支持格式


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


http 请求方式


请求方式content-type设置
http postmultipart/form-data、x-www-form-urlencoded、application/json


是否需要授权


参阅 API 授权和验证机制


请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短信应用ID
tostring必需收件人手机号码,该API仅支持一对一模式(即单条API请求仅能发送一个联系人),该参数现在仅能提交一个位联系人。
contentstring必需短信正文
(正文中必须提交有效的短信签名,且您的短信签名必须放在短信的最前端,e.g.【SUBMAIL】您的短信验证码:4438,请在10分钟内输入。
content 参数将会与您账户中的短信模板进行匹配,如无匹配 API会创建一个短信模板并提交到人工审核,审核通过后下次提交相似短信(内容达到一定匹配度)则不会触发人工审核直接进行下发,如审核失败则第二次请求返回 420 错误,审核失败会触发SUBHOOK中模板template_reject事件
请将短信正文控制在 500 个字符以内。)
tagstring可选自定义标签功能,该标签可用作SUBHOOK追踪
(32 个字符以内,添加了 tag 参数的 API 请求,会在所有的 SUBHOOK 事件中携带此参数。)
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式
sign_versionstring可选signature加密计算方式
(当sign_version传2时,content参数不参与加密计算)
signaturestring必需应用密匙或数字签名
参阅 API授权与验证机制 > 授权和验证方式


代码示例


发送一封测试短信


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


POST DATA
appid=your_app_id
&to=138xxxxxxxx
&content=【SUBMAIL】您的短信验证码:4438,请在10分钟内输入。
&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&content=【SUBMAIL】您的短信验证码:4438,请在10分钟内输入。&signature=your_app_key' https://api.mysubmail.com/message/send.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 错误代码