华软通信接口调用文档 1. 引言
1.1 目的
该接口手册编写目的在于描述企业信息系统(以下简称EMS)具体的接口协议,供接口用户进行接口的对接开发。
备注:本接口默认以GB2312编码,如是UTF-8编码格式 请先在程序中转码操作。
2. 短信
2.1 HTTP接口
2.1.1 短息发送
功能 : 短信发送
地址 : http://api./smsGBK.aspx?action=Send
支持GET和POST.
备注 : 建议采用post方法提交请求,采用GB2312编码,可以支持单条和批量发送
请求参数如下 :
参数名称 |
描述 |
字段值 |
username |
用户名 |
String 不允许为空,系统开户设置 |
password |
密码 |
String 不允许为空(密码为MD5加密码) |
gwid |
网关ID |
由系统开户设置,系统配置,不允许为空( 联系客服) |
mobile |
手机号码 |
String 不允许为空。多条手机号码,用英文逗号(,)
间隔建议最多40000个号码 |
message |
短信内容 |
String
不允许为空。如果采用Get方式提交内容,请用UrlEncode把发送内容用GB2312编码一下,如果采用Post方式提交内容不需要编码。短信内容最多350个字 |
调用返回结果:
以JOSN形式返回{"CODE":"-1","RESULT":"账户名错误"},具体错误信息具体判断
GET示例(直接输入到IE浏览器地址栏中):
http://api./smsGBK.aspx?action=Send&username=*****&password=*****&gwid=***&mobile=手机号1,手机号2,手机号3&message=【签名】短信内容
1. 发送返回代码定义
返回值 |
错误描述 |
1 |
发送短信成功(其他请求代表成功) |
-1 |
账号无效或未开户 |
-2 |
账号密码错误 |
-3 |
下发手机号为空 |
-4 |
下发短信内容为空 |
-5 |
指定短信网关ID为空 |
-6 |
账户或密码错误 |
-7 |
账户被冻结 |
-8 |
下发短信内容包含非法关键词 |
-9 |
账户没有充值或指定企业ID错误 |
-10 |
下发短信内容长度超出规定限制,限制为300字符 |
-11 |
下发账号余额不足 |
-20 |
服务器连接异常 |
-21 |
当前短信隶属106营销短信 必须加“尊称”、“退订回复T” |
-22 |
数据未响应 |
-99 |
系统未知错误 |
2.1.2 查询余额
功能 : 查询余额
地址 : http://api./smsGBK.aspx?action=Get&username=******&password=*****&gwid=***
接口详细参数描述 :
参数名称 |
描述 |
字段值 |
username |
用户名 |
String 不允许为空,系统开户设置 |
password |
密码 |
String 不允许为空(密码为MD5加密码) |
gwid |
网关ID |
由系统开户设置,系统配置,不允许为空 |
返回结果以数字形式返回
1. 查询返回代码定义
返回值 |
错误描述 |
大于等于0 |
查询成功,并发回剩余条数 |
-1 |
账户为空 |
-2 |
密码为空 |
-3 |
网关ID为空( 联系客服) |
-1 |
没有可用的企业ID号 |
|