[关闭]
@sewise-dev 2019-01-17T02:09:09.000000Z 字数 4679 阅读 412

直播统计接口文档

api live management


更新历史

编号 版本 说明 作者 日期
1 v1.0 直播统计接口文档 GuQiuSheng 2019-01-10

目录


1. 登录

1.1 用户登录

接口地址

/login

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
account String 账号名
password否 String 用户密码
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONObject 创建成功返回结果
msg String 添加任务失败时返回,错误原因

data

返回字段 字段类型 说明
account_id String 账号id
account String 账号
status int 账号状态
type int 账号类型
接口示例

Request
curl -X POST -d {"account":"xxxxx","password":"11sdffsd"} http://ip:port/login
Response
{"data":{"type":1,"account_id":"ssssssss","id":46,"account":"sewise","status":1},"success":true}

1.2 用户登出

接口地址

/loginout

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody

HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONObject 创建成功返回结果
msg String 添加任务失败时返回,错误原因
接口示例

Request
curl -X POST http://ip:port/loginout
Response
{"success":true}

2. 用户

2.1 创建用户

接口地址

/web/user/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
account String 账号
account_id String 账号id
vendor_key 直播应用开发key
create_time String 创建时间,格式为20190110
password String 密码
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
error String 添加任务失败时返回,错误原因
接口示例

Request
curl -X POST -d {"account":"xxxxx"} http://ip:port/api/course/add
Response
{"data":{"course_id":"d63efdd4-fb48-427f-a09a-fe25444e4f92","create_time":"2018-12-13 16:46:05","creator_uid":"testuser","duration":0.0,"id":"5c121c4dbcffe95a7b5c9d25","title":"2018-12-13 16:46:05"},"success":true}

2.2 获取用户信息

接口地址

/web/user/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody

HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONArray 创建成功返回结果
msg String 添加任务失败时返回,错误原因

data

返回字段 字段类型 说明
account_id String 账号ID
account String 账号
account_name String 账号名称
status int 账号状态
type int 账号类型
create_time String 创建时间
avatar String 头像
gender String 性别
phone String 手机
mail String 邮件
接口示例

Request
curl -X POST http://ip:port/loginout
Response
{"success":true}

2.3 更新用户信息

接口地址

/web/user/updatePw

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
account_id String 账号ID
avatar String 头像
gender String 性别
phone String 手机
mail String 邮件
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONArray 创建成功返回结果
msg String 添加任务失败时返回,错误原因
接口示例

Request
curl -X POST http://ip:port/loginout
Response
{"success":true}

2.4 更新用户密码

接口地址

/web/user/updatePw

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
account_id String 账号ID
newPw String 新密码
oldPw String 旧密码
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONArray 创建成功返回结果
msg String 添加任务失败时返回,错误原因
接口示例

Request
curl -X POST http://ip:port/loginout
Response
{"success":true}

3 账号

3.1 账号充值

接口地址

/web/account/pay

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
account_id String 账号ID
pay_amount int 充值金额,整数
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONArray 创建成功返回结果
msg String 添加任务失败时返回,错误原因
接口示例

Request
curl -X POST http://ip:port/loginout
Response
{"success":true}

3.2 获取充值总额

接口地址

/web/account/payamount

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
PathParam
account_id String 账号ID
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONArray 创建成功返回结果
msg String 添加任务失败时返回,错误原因

data

返回字段 字段类型 说明
pay_amount int 金额
接口示例

Request
curl -X POST http://ip:port/loginout
Response
{"success":true}

3.3 获取充值账单

接口地址

/web/account/list

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
PathParam
account_id String 账号ID
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONArray 创建成功返回结果
msg String 添加任务失败时返回,错误原因

data

返回字段 字段类型 说明
pay_amount int 金额
account_id String 账号ID
pay_time String 支付时间
接口示例

Request
curl -X POST http://ip:port/loginout
Response
{"success":true}

4 消费

4.1 获取使用记录

接口地址

/web/daily/list

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
account_id String 账号ID
start String 开始时间
end String 结束时间
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONArray 创建成功返回结果
msg String 添加任务失败时返回,错误原因

data

返回字段 字段类型 说明
use_amount int 消费金额
dailys JSONArray 日常使用数据

dailys

返回字段 字段类型 说明
account_id String 账号ID
audio int 纯音频使用量
sd int 标清视频使用量
hd int 高清视频使用量
hdp int 超清视频使用量
use_time String 使用时间,格式为20190110
接口示例

Request
curl -X POST http://ip:port/loginout
Response
{"success":true}

5 APP API

5.1 账号检查

接口地址

/api/account/check

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
PathParam
vendor_key String 直播开发账号ID
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
data JSONArray 创建成功返回结果
msg String 添加任务失败时返回,错误原因
接口示例

Request
curl -X POST http://ip:port/loginout
Response
{"success":true}

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注