API: Internationalsms/xsend


概览


internationalsms/xsend 是 SUBMAIL 的国际短信单发API。

internationalsms/xsend message/xsend 参数几乎一致,internationalsms/xsendmessage/xsend 共享短信模板。



URL


<主> https://api.mysubmail.com/internationalsms/xsend

<备> https://api.submail.cn/internationalsms/xsend



支持格式


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


http 请求方式


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


是否需要授权


参阅 API 授权和验证机制


请求参数


参数类型必需/可选默认描述
appidstring必需在 SUBMAIL 应用集成中创建的国际短信应用 ID
tostring必需收件人手机号码,使用标准的 E164 格式,e.g. +1778889901(仅支持单个手机号码,不支持 +86 国内手机号码)
projectstring必需项目标记,在 SUBMAIL > 短信>项目列表中查看你所创建的短信项目(模板ID)标记。请参见获取项目或地址薄的开发者标识
varsjsonstring必需使用文本变量动态控制短信中的文本。参阅 了解如何创建和使用文本变量
tagstring可选自定义标签功能,该标签可用作SUBHOOK追踪(32 个字符以内)
timestampUNIX 时间戳可选参阅 API 授权与验证机制 > Timestamp UNIX 时间戳
sign_typestring可选normalAPI 授权模式( md5 or sha1 or normal )参阅 API 授权与验证机制 > 授权和验证方式
sign_versionstring可选1signature加密计算方式(当sign_version传2时,vars参数不参与加密计算)
signaturestring必需应用密匙或数字签名参阅 API授权与验证机制 > 授权和验证方式


代码示例


发送一封测试短信


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


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


返回
{
    "status":"success"
    "send_id":"093c0a7df143c087d6cba9cdf0cf3738"
    "fee":0.046,
    "account_balance":14197.087
}


使用CURL 发送一封测试短信


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


返回
{
      "status":"success"
      "send_id":"093c0a7df143c087d6cba9cdf0cf3738"
      "fee":0.046,
      "account_balance":14197.087
}


返回值


请求成功
{
      "status":"success"
      "send_id":"093c0a7df143c087d6cba9cdf0cf3738"
      "fee":0.046,
      "account_balance":14197.087
}


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




错误代码


参阅 API 错误代码