短信接入

适用范围
本接口适用于如下产品类型:短信验证码/通知
服务器地址
http://apisms.huaxincloud.com:8081/
接入列表
  • 查询余额接口
  • 短信状态报告推送
  • 短信发送接口
请求地址
/custom/{accountSid}/sms/getBalance
请求参数
响应包体
属性 类型 约束 举例 说明
balance String 必须 29.5 余额(单位:元)
transactId String 必须 nIqa3aSqBxcb6ZxmflF20160327 发送唯一编码
errorCode String 必须 0 发送状态0:正常
msg String 必须 正常 消息
JSON响应示例
{
"transactId":"nIqa3aSqBxcb6ZxmflF20160327",
"errorCode":"0",
"msg":"正常",
"balance":"29.5"
}
请求地址
POST / callbackURL (短信发送时的callbackurl参数); 本请求是由我方发起,请求您的服务器;此地址在“短信发送”请求中上传
请求参数
属性 类型 约束 举例 说明
transactId String 必须 SLIJFLgYbtmI6JbUUGO20150911 交易唯一编码
status String 必须 3:成功,4:失败 短信发送结果
phone String 必须 13333333333 号码
JSON请求示例
{
"transactId":"SLIJFLgYbtmI6JbUUGO20150911",
"status":"3",
"phone":"13333333333"
}
响应包体
属性 类型 约束 举例 说明
result String 必须 SUCC SUCC成功,其他失败
JSON响应示例
{
"result":"SUCC"
}
请求地址
/custom/{accountSid}/sms/putDynaSms
请求参数
属性 类型 约束 举例 说明
productId String 必须 B2016000009 已订购的产品ID
dynadatas String 必须 json格式 短信发送目标及参数的列表 本信息中如有中文,请用URLEncoder对其转码,转码请用UTF-8。 如:URLEncoder.encode(str,"utf-8"); 每次请求只能发送一条短信 destination:指定发送目标手机号 后面把模板中需要填充的参数及值都带上
templateId String 必须 SMS20160918122 模板id
signingId String 必须 1459067067796178 签名id
subId String 可选 1234 扩展码
callbackUrl String 可选 http://zbc.com 回调地址
JSON请求示例
{
"productId":"B2016000009",
"dynadatas":"{"destination":"13901234567","name":"name1","param2":"value2"}",
signingId":"1459067067796178",
"templateId":"SMS20160912133",
"subId":"1234"
}
响应包体
属性 类型 约束 举例 说明
transactId String 必须 nIqa3aSqBxcb6ZxmflF20160327 交易唯一编码
errorCode String 必须 0 发送状态0:正常
msg String 必须 正常 消息
JSON响应示例
{
"transactId":"nIqa3aSqBxcb6ZxmflF20160327",
"errorCode":"0",
"msg":"正常"
}

恭喜您注册成功