-
基础知识
-
平台操作流程
-
API接口
-
状态码
-
调用接口实例
技术服务
API接口
短信剩余条数查询接口（Balance）
接口定义
| 接口名称 | 短信剩余条数查询接口 |
|---|---|
| 接口描述 | 由第三方平台主动发起请求向平台获取结果 |
| 请求内容 | INDEX：http://ip:port/api/sms/balance 或者 https://ip:port/api/sms/balance BODY：&userid=用户编号&ts=1476235100217&sign=md5(userid + ts + apikey) 完 整 URL 实 例 ， 如 ： http://ip:port/api/sms/balance?userid=100001&ts=1476235100217&sign=b3ac538457234fed842ed5f06c87f03a |
| 请求方法 | GET 或POST 请求 |
| 应答方式 | JSON |
| 接口协议 | HTTP |
输入参数
| 字段名称 | 说明 | 数据类型 | 长度 |
|---|---|---|---|
| userid | 用户编号，接入方信息唯一标识 | String | 用户在平台上分配的用户编号 |
| ts | 时间戳, 5 分钟内有效, 时间戳是指格林威治时间 1970 年01 月 01 日 00 时 00 分 00 秒起至现在的总毫秒数 | Long | System.currentTimeM illis() |
| sign | 三个信息字符串拼接，然后md5 算法加密 （MD5 用32 位，值必须要小写进行加密）md5(userid + ts + apikey) 中间无需空格、无需+号 | String | apikey:由系统分配 |
输出参数
| 字段名称 | 说明 | 数据类型 | 长度 |
|---|---|---|---|
| code | 状态码 | String | 10 |
| msg | 状态描述 | String | 50 |
| data | 数据节点 | Object | |
| balance | 可用短信条数（条） | int | 11 |
参数示例：
{
"code": "0",
"msg": "成功",
"data": {
" balance": "74"
}
}
