API:MMS/xsend


概览


MMS/xsend 是 SUBMAIL 彩信 单发API。



URL


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


支持格式


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


http 请求方式


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


是否需要授权


参阅 API 授权和验证机制



请求参数


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


代码示例


发送一封测试短信


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


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


返回
{
    "status":"success"
    "send_id":"093c0a7df143c087d6cba9cdf0cf3738"
    "fee":1,
    "money_account":14197.23
}


使用 CURL 发送一封测试短信


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


返回
{
      "status":"success"
      "send_id":"093c0a7df143c087d6cba9cdf0cf3738"
      "fee":1,
      "money_account":14197
}


返回值


请求成功
{
      "status":"success"
      "send_id":"093c0a7df143c087d6cba9cdf0cf3738"
      "fee":1,
      "money_account":14197.23
}


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


错误代码


参阅 API 错误代码