短信综合管理信息系统.DOC

1、江苏迅辰信息技术有限公司 客服热线：400-850-0513短信综合管理信息系统HTTP版江苏迅辰信息技术有限公司目录第一章 余额 .31.1 请求地址 .31.2参数说明 .31.3返回值 .3第二章 发送接口 .42.1 请求地址 .42.2参数说明 .42.3返回值 .6第三章 状态报告接口 .73.1 请求地址 .7江苏迅辰信息技术有限公司 客服热线：400-850-05133.2参数说明 .73.3返回值 .73.4错误返回值 .8第四章 上行接口 .84.1 请求地址 .84.2参数说明 .94.3返回值 .94.4错误返回值 .9接口说明：客户接口部分提供http url方式的接

2、口，根据客户需求可以提供相应接口，接口编码方式采用统一的UTF-8或者GBK接口参数：服务器地址：121.43.104.172端口:8030用户账号: 用户密码:通信认证密码：第一章 余额1.1 请求地址请求地址是客户接口程序调用时请求的url地址，采用的是http post 接口，地址是http:/服务器地址:端口/service/httpService/httpInterface.do入口地址一般不会发生变化，当发生变化的时候，会通知接口用户江苏迅辰信息技术有限公司 客服热线：400-850-05131.2参数说明http:/服务器地址:端口/service/httpService/htt

3、pInterface.do?method=getAmount参数名称 含义 说明method 查询余额 查询余额，固定为getAmountusername 用户账号 用户账号password 用户密码 用户密码veryCode 通信认证密码例如：http:/121.43.104.172:8030/service/httpService/httpInterface.do?method=getAmount&username=JSM40001&password=123456&veryCode=4532451.3返回值在接收到客户端发送的http请求后，返回以xml的方式返回处理结果。格式为：0 -返

4、回状态值：成功返回0 失败返回：失败代码5000 -当status为0时，会出现该属性返回值说明：名称 说明status 返回状态值，具体参照状态码说明account 余额，条数= acount * 10状态码说明：返回码 描 述0 查询成功100 查询余额失败101 用户账号不存在或密码错误102 账号已禁用103 参数不正确105 认证码错误117 未开通此接入方式数字account 短信余额第二章 发送接口2.1 请求地址请求地址是客户接口程序调用的时候请求的url地址，采用的是http post 接口，地址：http:/服务器IP:端口/service/httpService/http

5、Interface.do?method=sendMsg江苏迅辰信息技术有限公司 客服热线：400-850-0513入口地址一般不会发生变化，当发生变化的时候，会通知接口用户指定字符编码提交地址，无需携带code参数Utf8编码：http:/服务器IP:端口/service/httpService/httpInterface.do?method= sendUtf8MsgGBK编码http:/服务器IP:端口/service/httpService/httpInterface.do?method= sendGbkMsg2.2参数说明参数名称 含义 说明method 发送短信(必填) 发送短信，固定

6、为sendMsgusername 用户账号(必填) 用户账号password 用户密码(必填) 用户密码veryCode 通信认证密码(必填)mobile 手机号码(必填) 手机号码（群发短信时，最多100个，英文逗号,隔开）content短信内容(必填) 短信内容（最多300个汉字），特殊字符需要转义；如果使用模板短信发送，此参数用来传递模板短信的变量和值，参数之间以逗号隔开extcode扩展码 用户自己分配的小号（即显示在接收手机上的主叫尾号，可用于上行信息匹配）例：我们给合作方开的特服号是106905994140010，然后合作方在发送信息的时候可以随意填写扩展号ext=8888（最大支

7、持4位），那么用户收到信息时显示的下发号码就是1069059941400108888sendtime定时时间 定时短信的定时时间，格式为: (yyyyMMddhhmmss),例如:20140504111010 代表2014年5月4日 11时10分10秒，短信会在指定的时间发送出去sendTime值为空时，为即时发送短信sendTime值不为空时，为定时发送短信 msgtype 短信类型(必填) 短信类型。1-普通短信，2-模板短信。signtag短信签名序号 短信签名序号，如果帐号报备多个签名，此参数指定使用第几个签名（由于运营商要求，帐号只允许单一签名，此参数可以省略）signtext 自定

8、义签名 自定义签名，帐号支持自定义签名该参数才生效tempid 模板短信编号 模板编号，（msgtype=2时参数必填） code 编码格式 编码方式（utf-8,gbk）,默认:gbk；指定字符编码提交地址时无需赋值说明：IP：如果用户开账户时指定IP，则接口只接收该IP发送请求。例如：1发送即时短信示例：http:/121.43.104.172:8030/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=&mobile=15951977097&cont

9、ent=您好！您本次验证码为：174687，请勿告知他人江苏迅辰信息技术有限公司 客服热线：400-850-0513&msgtype=1&code=gbk2 发送预约短信示例：http:/121.43.104.172:8030/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=453245&mobile=15951977097&content=您好！您本次验证码为：174687，请勿告知他人&msgtype=1&code=gbk& sendtime=201

10、505010930303短信多签名示例：（已作废）如帐号报备签名：【迅辰001】|【迅辰002】| 【迅辰003】http:/121.43.104.172:8030/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=453245&mobile=15951977097&content=您好！您本次验证码为：174687，请勿告知他人&extcode&msgtype=1&signtag=2&tempid=&code=gbk发送短信内容：【迅辰002】您好！您本

11、次验证码为：174687，请勿告知他人4.使用自定义签名：（作废）http:/121.43.104.172:8030/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=453245&mobile=15951977097&content=您好！您本次验证码为：174687，请勿告知他人&msgtype=1& signtext=迅辰004&code=gbk发送短信内容：【迅辰004】您好！您本次验证码为：174687，请勿告知他人5模板短信示例：登录综合信息管

12、理系统客户端后,菜单：短信中/短信模版，详细操作流程请查看综合信息管理系统_使用手册(客户端).docx如客户定义的编号为JSM4001-0001模板短信为：尊敬的12,您在江苏迅辰网站（ ），注册的手机验证码为3 ，请在验证页面及时输入。http:/121.43.104.172:8030/service/httpService/httpInterface.do?method=sendMsg&username=JSM40001&password=123456&veryCode=453245&mobile=15951977097&content=1=李先生,2=您好,3=928371 &msgt

13、ype=2 &tempid= JSM4001-000&code=gbk发送短信内容：【江苏迅辰】尊敬的李先生你好,您在江苏迅辰网站（），注册的手机验证码为928371，请在验证页面及时输入。Content变量为模版中各变量对应的变量值，多个变量以英文逗号隔开content=1=李先生,2=您好,3=9283712.3返回值0 816f333305664fb9bdd8c1bc96ae12b8 返回值说明：名称 说明江苏迅辰信息技术有限公司 客服热线：400-850-0513status 返回状态值，具体参照状态码说明msgid 消息id，和状态报告内msgid匹配的状态码说明：返回码 描 述0

14、提交成功100 发送失败101 用户账号不存在或密码错误102 账号已禁用103 参数不正确105 短信内容超过300字或为空、或内容编码格式不正确106 手机号码超过100个或有错误号码108 余额不足109 ip错误110#(敏感词A,敏感词B) 短信内容存在系统保留关键词，如有多个词，使用逗号分隔：110#(李老师,XX,成人)114 模板短信序号不存在115 短信签名标签序号不存在116 认证码不正确117 未开通此接入方式第三章 状态报告接口3.1 请求地址请求地址是客户接口程序调用的时候请求的url地址，采用的是http post 接口，地址是http:/服务器地址:端口/serv

15、ice/httpService/httpInterface.do?method=queryReport,只能查询当天的，已获取的状态报告后续不会再获取入口地址一般不会发生变化，当发生变化的时候，会通知接口用户。建议访问频率:3分钟一次3.2参数说明参数名称 含义 说明method 获取状态报告(必填) 固定为queryReportusername 用户账号(必填) 用户账号password 用户密码(必填) 用户密码veryCode 通信认证密码(必填)例如：http:/121.43.104.172:8030/service/httpService/httpInterface.do?metho

16、d=queryReport&username=JSM40001&password=123456&veryCode=453245江苏迅辰信息技术有限公司 客服热线：400-850-05133.3返回值15951977097 7506751276725633025 MA:0006 2015-06-08 11:21:46 159519770977506751276725633026MA:00062015-06-08 11:21:46159519770977507418680283693057DELIVRD2015-06-08 11:59:37返回值说明：名称 说明mobile 返回状态值，具体参照状

17、态码说明msgid 消息id，和发送接口内msgid匹配的status 返回状态码，具体参照状态码说明time 状态报告的时间extno 扩展码状态码说明：返回码 描 述DELIVRD 发送成功,返回其他请参照失败状态码3.4错误返回值返回值说明：名称 说明status 返回状态码，具体参照状态码说明状态码说明：江苏迅辰信息技术有限公司 客服热线：400-850-0513返回码 描 述100 获取状态报告失败101 用户账号不存在或密码错误102 账号已禁用103 参数不正确104 暂无短信状态报告105 认证码错误117 未开通此接入方式第四章 上行接口4.1 请求地址请求地址是客户接口程序

18、调用的时候请求的url地址，采用的是http post 接口，地址是http:/服务器地址:端口/service/httpService/httpInterface.do?method=queryMo只能查询当天的，已获取的上行短信后续不会再获取入口地址一般不会发生变化，当发生变化的时候，会通知接口用户建议访问频率:3分钟一次4.2参数说明参数名称 含义 说明method 获取上行短信(必填) 固定为queryMousername 用户账号(必填) 用户账号password 用户密码(必填) 用户密码veryCode 通信认证密码(必填)例如：http:/121.43.104.172:8030

19、/service/httpService/httpInterface.do?method=queryMo&username=testss&password=123456&veryCode=4532454.3返回值15951977097 106905994140001 江苏迅辰信息技术有限公司2015-04-02 22:12:11 15951977097 106905994140001 江苏迅辰信息技术有限公司 客服热线：400-850-05134006000699 2014-04-03 08:12:11 返回值说明：名称 说明mobile 对应的手机号码recvcode 接受号码content 回复内容time 接收时间4.4错误返回值返回值说明：名称 说明status 返回状态码，请参照状态码说明状态码说明：返回码 描 述100 获取上行短信失败101 用户账号不存在或密码错误102 账号已禁用103 参数不正确104 暂无上行短信105 认证码错误117 未开通此接入方式