变量短信发送

发送接口

协议说明

用户通过HTTP的POST、GET方式提交短信发送

协议类目 说明
调用地址 http://IP:PORT/msg/HttpVarSM
请求方式 POST,GET
编码格式 UTF-8
Content-Type application/x-www-form-urlencoded;charset=utf-8

请求参数

参数 必填 描述
account 用户账号
ts 时间戳,格式yyyyMMddHHmmss
pswd 用户密码,ts参数为空时填明文密码,ts参数不为空时填md5(账号+密码+时间戳),对账号密码时间戳拼接的字符串进行md5加密
msg 短信模板。其中的变量用“{$var}”来替代。例如:“{$var},你好!,请你于{$var}日参加活动”,该短信中具有两个变量参数。编码为UTF-8格式。
params 变量短信的参数组。单次提交参数组的数目不能超过1000个。 编码为UTF-8格式。 每一组参数之间用英文“;”间隔每一组参数内部用英文“,”间隔,其中第一个参数为手机号 码,第二个参数为模板中第一个变量,第三个参数为模板中第二个变量,以此类推。 如: 13800210000,李先生,2013-01-01;13500210000,王先生,2013-01-15 表明提交了两个变量组,其中手机号码分别为:13800210000和13500210000。模板变量分别为:李先生,2013-01-01和王先生,2013-01-15
needstatus 是否需要状态报告,取值true或false。true,表明需要状态报告;false不需要状态报告
product 产品编码:sms,不填写默认是普通短信发送。
extno 扩展码,用户定义扩展码,3位,实际提交限制为6位,建议用户扩展3位
resptype 响应格式,默认返回文本格式,填json返回json格式
templateId 短信模板
rid 客户发送短信时自行生成rid,状态报告推送时返回此参数

请求示例

1
http://IP:PORT/msg/HttpVarSM?account=111111&pswd=123456&msg={$var},你好!,请你于{$var}日参加活动&params=13800210000,李先生,2013-01-01;13500210000,王先生,2013-01-15&needstatus=true&product=sms

文本响应格式

文本方式响应格式如下:

1
2
resptime,respstatus,successnum,failnum
msgid

短信提交响应分为两行(每行以换行符(0x0a,即\n)分割),第一行为响应时间和状态,第二行为服务器给出提交msgid,一个发送请求只返回一个msgid。如果响应的状态不是“0”,或者提交时needstatus不等于true,则没有msgid,即第二行数据为空。

提交成功示例

1
2
3
4
20110725160412,0,10,1 //响应时间为20110725160412,响应状态为0 表明成功提交到服务器,
//参数组个数为10表明提交参数params中格式正确的条数为10条,
//发送包失败个数为1表明提交参数msg中格式错误的条数为1条
1234567890100 //返回的msgid,供状态报告匹配时使用。

提交失败示例

1
2
20110725160412,101 //响应时间为20110725160412,响应状态为101表示提交失败,请查询状态码
//服务器端并未返回msgid。

json响应格式

提交成功示例

1
2
3
4
5
6
7
8
{
"ts": "20110725160412", //ts为响应时间
"result": 0, //响应状态,0表示成功
"suc": 10, //格式正确条数
"fail": 0, //为格式错误条数
"msgid": "1234567890100" //状态匹配使用,如果响应的状态不是0,
//或者提交时needstatus不等于true,则没有msgid字段
}

提交失败示例

1
2
3
4
5
{
"ts": "20110725160412", //ts为响应时间
"result": 102 //响应状态102表示失败,请查询状态码说明
//服务器端并未返回msgid
}

状态码说明

详情查询状态码