API: Flashsms/xsend


概览


flashsms/xsend 是 SUBMAIL 的针对闪信 开发的 API 。

闪信正文内容最大长度不超过66个字符,编辑完成后,需要联系客服在运营商报备,在报备完成后,即可发送



URL


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


支持格式


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


http 请求方式


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


是否需要授权


参阅 API 授权和验证机制


请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的短信应用 ID
tostring必需收件人手机号码,该API 仅支持一对一模式(即单条 API 请求仅能发送一个联系人),该参数现在仅能提交一个位联系人。
projectstring必需模版 ID
在 SUBMAIL > Message >项目中查看你所创建的短信模版 ID。请参见获取项目 ID
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal
参阅 API 授权与验证机制 > 授权和验证方式
signaturestring必需应用密匙或数字签名
参阅 API 授权与验证机制 > 授权和验证方式


代码示例


POST URL
https://api.mysubmail.com/flashsms/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",
}


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


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


返回值


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


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


错误代码


参阅 API 错误代码