企信通HTTP接口调用说明
1 协议说明
1.1 HTTP协议
根据客户需求,国宇提供二次开发接口。采用HTTP的POST或GET方式进行消息的下发。在使用接口时,以如下形式进行调用。
http://host/xx.aspx?xxx=111&yyy=1235&……
注意事项:
1.短信内容中的中文字符支持GB码和UTF-8
请求页面分别为:
http://www.gysoft.cn/smspost/send.aspx GB码
http://www.gysoft.cn/smspost_utf8/send.aspx utf8码
3.返回结果为纯文本方式。
4.在返回结果中,需要去除前后多余的空白行。
5.用于文本分割的分割符号均为英文字符,比如逗号和分号。
6.请求的参数名为小写
7.汉字等特殊字符采用编码方式传输 编码实例
源字符串 | abcABC!!&@#中国 123%* |
编码字符串(gb) | abcABC!%a3%a1%26%40%23%d6%d0%b9%fa+123%25* |
编码字符串(utf8) | abcABC!%ef%bc%81%26%40%23%e4%b8%ad%e5%9b%bd+123%25* |
2 消息发送
2.1 发送
2.2.1 获得短信余额数量
入口地址:http://www.gysoft.cn/smspost_utf8/havenum.aspx
参数说明:
参数 | 长度(字节) | 类型 | 说明 |
username | 50 | 字符串 | 用户名 |
password | 50 | 字符串 | 用户密码 |
返回结果:
值 | 类型 | 说明 |
100 | 字符串 | 成功 账户还剩余100可发送 直接返回剩余条数 |
<0 | 字符串 | 失败 |
发送实例:
http://www.gysoft.cn/smspost_utf8/havenum.aspx?username=YourName&password=pwd
2.2.2 发送消息
入口地址:http://www.gysoft.cn/smspost_utf8/send.aspx
参数说明(如果有汉字或特殊字符要编码):
参数 | 长度(字节) | 类型 | 说明 |
username | 50 | 字符串 | 用户名 |
password | 50 | 字符串 | 用户密码 |
mobile | 11 | 字符串 | 手机号码 |
content | 400 | 字符串 | 发送信息内容 |
sendtime |
| 时间 | 用户定时发送,如果立即发送此参数为空字符串 格式为yyyy-mm-dd hh:mm:ss |
返回结果:
值 | 类型 | 说明 |
OK +数字 | 字符串 | 成功 OK +成功提交的短信条数 |
失败说明 | 字符串 | 失败原因 |
发送实例:
http://www.gysoft.cn/smspost_utf8/send.aspx?username=YourName&password=pwd&mobile=PhoneNumber&content=sendContent
注意:支持多条信息同时发送,GET方式每条不要超过1024字节,POST方式每条建议100K以内。
扩展功能发送消息返回任务ID,用于回复状态的识别
入口地址:http://www.gysoft.cn/smspost_utf8/sendbyid.aspx
参数说明(如果有汉字或特殊字符要编码):
参数 | 长度(字节) | 类型 | 说明 |
username | 50 | 字符串 | 用户名 |
password | 50 | 字符串 | 用户密码 |
mobile | 11 | 字符串 | 手机号码 |
content | 400 | 字符串 | 发送信息内容 |
返回结果:
值 | 类型 | 说明 |
OK +数字,任务ID | 字符串 | 成功 OK +成功提交的短信条数,任务ID号 例如:OK1,2609366 |
失败说明 | 字符串 | 失败原因 |
发送实例:
http://www.gysoft.cn/smspost_utf8/sendbyid.aspx?username=YourName&password=pwd&mobile=PhoneNumber&content=sendContent
注意:支持多条信息同时发送,GET方式每条不要超过1024字节,POST方式每条建议100K以内。
2.2.3取到发送清单 (含发送状态 、电信报告)
入口地址:http://www.gysoft.cn/smspost_utf8/report.aspx
参数说明(如果有汉字或特殊字符要编码):
参数 | 长度(字节) | 类型 | 说明 |
username | 50 | 字符串 | 用户名 |
password | 50 | 字符串 | 用户密码 |
返回结果:
值 | 类型 | 说明 |
OK+短信报告 | 字符串 | OK+短信短信报告(|^|)短信报告 例如: OK11499075,2012-08-14 12:04:32,成功,1862***2275 ,33686 |^|11499079,2012-08-14 12:04:32,成功,186****275 ,33716 没有报告返回OK |
失败说明 | 字符串 | 失败原因 |
发送实例:
http://www.gysoft.cn/smspost_utf8/report.aspx?username=YourName&password=pwd
2.2.4 手机号码所属地查询
入口地址:http://www.gysoft.cn/smspost_utf8/getMobilecity.aspx
参数说明(如果有汉字或特殊字符要编码):
参数 | 长度(字节) | 类型 | 说明 |
username | 50 | 字符串 | 用户名 |
password | 50 | 字符串 | 用户密码 |
mobile | 11 | 字符串 | 手机号码 |
返回结果:
值 | 类型 | 说明 |
广东 广州 | 字符串 | 广东 广州 地方名 |
<0 | 字符串 | 小于0的字符串 表示失败 |
发送实例:
http://www.gysoft.cn/smspost_utf8/getMobilecity.aspx?username=YourName&password=pwd&mobile=PhoneNumber
2.2.5 修改用户密码
入口地址:http://www.gysoft.cn/smspost_utf8/changePwd.aspx
参数说明(如果有汉字或特殊字符要编码):
参数 | 长度(字节) | 类型 | 说明 |
username | 50 | 字符串 | 用户名 |
oldpassword | 50 | 字符串 | 旧用户密码 |
NewPassword | 50 | 字符串 | 新用户密码 |
返回结果:
值 | 类型 | 说明 |
OK | 字符串 | 成功 |
<0 | 字符串 | 失败 |
发送实例:
http://www.gysoft.cn/smspost_utf8/changePwd.aspx?username=YourName&password=oldpwd&NewPassword =NewPwd
2.2.6 获得上行信息(用户短信回复)
入口地址:http://www.gysoft.cn/smspost_utf8/getsms.aspx
参数说明(如果有汉字或特殊字符要编码):
参数 | 长度(字节) | 类型 | 说明 |
username | 50 | 字符串 | 用户名 |
password | 50 | 字符串 | 用户密码 |
type | 50 | 字符串 | 类型参数 默认为 new,没有这个参数,就传回从起始时间到当前时间的所有报告 |
begintime |
| 时间 | 开始时间 格式 yyyy-mm-dd |
返回结果:
值 | 类型 | 说明 |
OK+信息 | 字符串 | 成功 OK+ID+日期+号码+内容(|^|)ID+日期+号码+内容 例:OK17,2012-08-14 12:04:02,159****3394,'杨德壕'|^|18,2012-08-14 12:04:02,158****549,'伦业胜,谢谢。'21,2012-08-14 12:04:02,1581***4549,'可以发个详细地址给我吗?在那座大厦。非常感谢。' 回复内容用单引号括起来了 |
<0 | 字符串 | 失败 |
发送实例:
http://www.gysoft.cn/smspost_utf8/getsms.aspx?username=YourName&password=pwd&type=new&begintime=2012-08-10
2.2.7 获得用户详细信息
入口地址:http://www.gysoft.cn/smspost_utf8/getUserInfo.aspx
参数说明(如果有汉字或特殊字符要编码):
参数 | 长度(字节) | 类型 | 说明 |
username | 50 | 字符串 | 用户名 |
password | 50 | 字符串 | 用户密码 |
返回结果:
值 | 类型 | 说明 |
OK+信息 | 字符串 | 成功OK余额:200,总购买数量:1000,总发送量:1124,总发送量:11050124,公司名:国宇软件,联系人手机:,联系人:,最后充值日期:2011-01-31 12:00:00,最后充值数量:333 |
<0 | 字符串 | 失败 |
发送实例:
http://www.gysoft.cn/smspost_utf8/getUserInfo.aspx?username=YourName&password=pwd
2.2.8 短信内容关键字查询
入口地址:http://www.gysoft.cn/smspost_utf8/checkContent.aspx
参数说明(如果有汉字或特殊字符要编码):
参数 | 长度(字节) | 类型 | 说明 |
username | 50 | 字符串 | 用户名 |
password | 50 | 字符串 | 用户密码 |
mobile | 50 | 字符串 | 手机号码 |
content | 400 | 字符串 | 查询的内容 |
返回结果:
值 | 类型 | 说明 |
OK | 字符串 | 成功 |
关键字 | 字符串 | 直接返回不能发送的关键字 |
发送实例:
http://www.gysoft.cn/smspost_utf8/checkContent.aspx?username=YourName&password=pwd&mobile=PhoneNumber&content=sendContent
以上事例都是UTF-8的字符模式
本文来自互联网用户投稿,文章观点仅代表作者本人,不代表本站立场,不承担相关法律责任。如若转载,请注明出处。 如若内容造成侵权/违法违规/事实不符,请点击【内容举报】进行投诉反馈!