编辑: 无理的喜欢 | 2015-09-06 |
第一章 余额
3 1.
1 请求地址
3 1.2参数说明
3 1.3返回值
3
第二章 发送接口
4 2.1 请求地址
4 2.2参数说明
4 2.3返回值
6
第三章 状态报告接口
7 3.1 请求地址
7 3.2参数说明
7 3.3返回值
7 3.4错误返回值
8
第四章 上行接口
8 4.1 请求地址
8 4.2参数说明
9 4.3返回值
9 4.4错误返回值
9 接口说明:客户接口部分提供http url方式的接口,根据客户需求可以提供相应接口,接口编码方式采用统一的UTF-8或者GBK 接口参数: 服务器地址:121.43.104.172 端口:8030 用户账号: 用户密码: 通信认证密码:
第一章 余额 1.1 请求地址 请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是 http://服务器地址:端口/service/httpService/httpInterface.do 入口地址一般不会发生变化,当发生变化的时候,会通知接口用户 1.2参数说明 http://服务器地址:端口/service/httpService/httpInterface.do?method=getAmount 参数名称 含义 说明 method 查询余额 查询余额,固定为getAmount username 用户账号 用户账号 password 用户密码 用户密码 veryCode 通信认证密码 例如: http://121.43.104.172:8030/service/httpService/httpInterface.do?method=getAmount&
username=JSM40001&
password=123456&
veryCode=453245 1.3返回值 在接收到客户端发送的http请求后,返回以xml的方式返回处理结果.格式为: 0返回状态值:成功返回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/httpInterface.do?method=sendMsg 入口地址一般不会发生变化,当发生变化的时候,会通知接口用户 指定字符编码提交地址,无需携带code参数 Utf8编码: http://服务器IP:端口/service/httpService/httpInterface.do?method=sendUtf8Msg GBK编码 http://服务器IP:端口/service/httpService/httpInterface.do?method=sendGbkMsg 2.2参数说明 参数名称 含义 说明 method 发送短信(必填) 发送短信,固定为sendMsg username 用户账号(必填) 用户账号 password 用户密码(必填) 用户密码 veryCode 通信认证密码(必填) mobile 手机号码(必填) 手机号码(群发短信时,最多100个,英文逗号,隔开) content 短信内容(必填) 短信内容(最多300个汉字),特殊字符需要转义;
如果使用模板短信发送,此参数用来传递模板短信的变量和值,参数之间以逗号隔开 extcode 扩展码 用户自己分配的小号(即显示在接收手机上的主叫尾号,可用于上行信息匹配)例:我们给合作方开的特服号是106905994140010,然后合作方在发送信息的时候可以随意填写扩展号ext=8888(最大支持4位),那么用户收到信息时显示的下发号码就是1069059941400108888 sendtime 定时时间 定时短信的定时时间,格式为: (yyyyMMddhhmmss),例如:20140504111010 代表2014年5月4日11时10分10秒,短信会在指定的时间发送出去 sendTime值为空时,为即时发送短信 sendTime值不为空时,为定时发送短信 msgtype 短信类型(必填) 短信类型.1-普通短信,2-模板短信. signtag 短信签名序号 短信签名序号,如果帐号报备多个签名,此参数指定使用第几个签名(由于运营商要求,帐号只允许单一签名,此参数可以省略) signtext 自定义签名 自定义签名,帐号支持自定义签名该参数才生效 tempid 模板短信编号 模板编号,(msgtype=2时参数必填) code 编码格式 编码方式(utf-8,gbk),默认:gbk;