用户管理
目录
user/register 创建用户
创建用户
URL http://e.vhall.com/api/vhallapi/v2/user/register
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| third_user_id | string | 是 | 第三方用户ID,做为SDK DEMO里的帐号 |
| pass | string | 是 | 用户密码,做为SDK DEMO里的密码 |
| phone | string | 否 | 用户手机号 |
| name | string | 否 | 用户昵称 |
| email | string | 否 | 用户邮箱 |
| head | string | 否 | 用户头像网络路径 |
| local_head | file | 否 | 本地头像 |
| customized_field | string | 否 | API用户自己定义的一个字段,长度小于255个字符 |
| customized_value | string | 否 | 上述自定义字段的值 |
响应参数
返回形如 {“code”:200,”msg”:“success”,”data”:{“user_id”:“799”}}的json,data值的数据格式如下
| 参数名 | 类型 | 必选 | 说明 |
| user_id | int | 是 | 微吼用户ID |
响应示例
{
"code": 200,
"msg": "success",
"data": {
"user_id": "799"
}
}
错误码
| code | 含义 |
| 10070 | 第三方用户ID不能为空 |
| 10073 | 手机格式不对 |
| 10074 | 该手机号已存在 |
| 10021 | 邮箱格式不对 |
| 10077 | 密码不能为空 |
| 10078 | 密码为6-20位 |
| 10079 | 该邮箱已存在 |
| 10833 | 自定义字段过长 |
| 10834 | 自定义值过长 |
user/update 更新用户
更新用户
URL http://e.vhall.com/api/vhallapi/v2/user/update
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| third_user_id | string | 是 | 第三方用户ID |
| pass | string | 否 | 更新密码 |
| phone | string | 否 | 更新手机号 |
| name | string | 否 | 更新昵称 |
| email | string | 否 | 更新邮箱 |
| wbinar_id | int | 否 | 更新当前活动用户的参会信息 |
| head | string | 否 | 更新头像网络路径 |
| local_head | file | 否 | 本地头像 |
| customized_field | string | 否 | API用户自己定义的一个字段,长度小于255个字符 |
| customized_value | string | 否 | 上述自定义字段的值 |
响应参数
返回形如 {“code”:200,”msg”:“success”,”data”:{“user_id”:“799”}}的json,data值的数据格式如下
| 参数名 | 类型 | 必选 | 说明 |
| user_id | int | 是 | 微吼用户ID |
响应示例
{
"code": 200,
"msg": "success",
"data": {
"user_id": "799"
}
}
错误码
| code | 含义 |
| 10070 | 第三方用户ID不能为空 |
| 10073 | 手机格式不对 |
| 10074 | 该手机号已存在 |
| 10076 | 邮箱格式不对 |
| 10078 | 密码为4-32位 |
| 10079 | 该邮箱已存在 |
| 10080 | 账户信息存在 |
| 10833 | 自定义字段过长 |
| 10834 | 自定义值过长 |
user/get-user-id 获取微吼用户ID
获取微吼用户ID
URL http://e.vhall.com/api/vhallapi/v2/user/get-user-id
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| third_user_id | string | 是 | 第三方用户ID |
响应参数
返回形如{“code”:200,”msg”:“success”,”data”:[{“start_time”:“2016-09-21 15:05:21”,”num”:30},{“start_time”:“2016-09-07 13:58:27”,”num”:1}]}的json。data值的数据类型如下:
响应示例
{
"code": 200,
"msg": "success",
"data": {
"id": 837
}
}
错误码
| code | 含义 |
| 10102 | 第三方用户ID不能为空 |
| 10103 | 第三方用户对象不存在 |
user/change-user-power 更改用户权限
更改第三方账号权限
URL http://e.vhall.com/api/vhallapi/v2/user/change-user-power
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| user_id | int | 是 | 用户id |
| is_child | int | 是 | 是否是子帐号 1是 0不是 |
| assign | int | 是 | 分配量,父账号是流量套餐时单位为(G)且可支持小数点后两位,父账号是并发套餐时单位为(人)仅支持整数 |
如需要用户具有直播权限,is_child请传1,assign大于0或在子账号管理中的用量分配方式修改为“动态”。
响应参数
返回形如{“code”:200,”msg”:“success”,”data”:[{“start_time”:“2016-09-21 15:05:21”,”num”:30},{“start_time”:“2016-09-07 13:58:27”,”num”:1}]}的json。data值的数据类型如下:
响应示例
{
"code": 200,
"msg": "success",
"data": []
}
错误码
| code | 含义 |
| 10102 | 用户ID不能为空 |
| 10103 | 第三方用户对象不存在 |
| 10104 | 子账号信息不存在 |
| 10105 | 分配量不能超过可用量 |
| 10106 | 子账号类型不对 |
| 10107 | 分配量不能为空 |
| 10108 | 该认证用户未开通子账号权限 |
| 10830 | 非第三方用户不能更改子账号选项 |
user/get-user-power 获取用户权限
获取用户权限
URL http://e.vhall.com/api/vhallapi/v2/user/get-user-power
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| user_id | int | 是 | 用户ID |
响应参数
返回形如{“code”:200,”msg”:“success”,”data”:[{“start_time”:“2016-09-21 15:05:21”,”num”:30},{“start_time”:“2016-09-07 13:58:27”,”num”:1}]}的json。data值的数据类型如下:
| is_child | 是否是子账号 0 不是 1 是 |
| assign | 分配用量 |
| role_id | 角色ID |
响应示例
{
"code": 200,
"msg": "success",
"data": {
"is_child": 1,
"assign": "10",
"role_id" : 1
}
}
错误码
| code | 含义 |
| 10102 | 用户ID不能为空 |
| 10103 | 第三方用户对象不存在 |
| 10104 | 子账号信息不存在 |
| 10831 | 当前查询数据非子账号数据拥有者 |
user/get-child-list 获取子账号列表
获取子账号列表
URL http://e.vhall.com/api/vhallapi/v2/user/get-child-list
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| source | int | 否 | 子账号创建来源,1为从微吼平台创建,2为通过接口创建,默认获取全部 |
| pos | int | 否 | 数字,设置从第几条数据开始获取,如果是第一条数据(pos=0),默认为0 |
| limit | int | 否 | 数字,每次返回条数 |
响应参数
返回形如{“code”:200,”msg”:“success”,”data”:{}}的json。data部分数据如下:
| 参数名 | 类型 | 说明 |
| user_id | int | 子账号的微吼用户id |
| source | int | 1为从微吼平台创建,2为通过接口创建 |
| res_type | int | 用量类型,1为流量,2为并发 |
| assign_mode | int | 用量分配方式,1为固定,2为动态 |
| assign | float | 具体分配的并发或流量数,如assign_mode是2则不返回此参数 |
| third_user_id | string | 第三方用户id |
响应示例
{
"code": "200",
"msg": "成功",
"data": [
{
"user_id": 981,
"name": "xxxx",
"source": 2,
"res_type": 1,
"assign_mode": 1,
"assign": 0
},
{
"user_id": 982,
"name": "木木的子账号",
"source": 2,
"res_type": 1,
"assign_mode": 1,
"assign": 50
}
]
}
错误码
| code | 说明 |
| 10819 | 无子账号数据 |
| 10820 | 当前主账号不是会员 |
user/get-user-info 获取用户信息
获取用户信息,支持获取接口创建的用户以及微吼平台添加的子账号
URL http://e.vhall.com/api/vhallapi/v2/user/get-user-info
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| user_id | string | 是 | 微吼用户id |
| fields | string | 是 | 需要获取的字段,字段之间用英文逗号,分割 |
fields 参数详情
| 字段名 | 说明 | |
| name | string | 用户昵称 |
| head | string | 用户头像的网络路径 |
| customized_field | string | 第三方用户创建接口中传入的字段 |
| third_user_id | string | 第三方用户id |
响应参数
返回形如 {
“code”: “200”,
“msg”: “成功”,
“data”: {}
}的json。data部分数据如下:
| 参数名 | 类型 | 说明 |
| name | string | 用户昵称 |
| head | string | 用户头像的网络路径,不传则返回微吼默认头像地址 |
| customized_field | string | API用户自己定义的一个字段,长度小于255个字符 |
| customized_value | string | 上述自定义字段的值 |
响应示例
{
"code": "200",
"msg": "成功",
"data": {
"name": "xxxx",
"head": "",
"customized_field": "",
"customized_value": ""
}
}
错误码
user/use-flow 用户流量查询
统计账号的流量
URL http://e.vhall.com/api/vhallapi/v2/user/use-flow
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| user_id | int | 是 | 用户id |
| time_span | int | 否 | 时间跨度 1⇒ 7天,2 ⇒ 30天,3 ⇒ 90天,4 ⇒ 180天,5 ⇒: 360天 |
| begintime | date | 否 | 标准时间格式,例:2017-7-12 10:12:11,当type为1是为必填项 |
| endtime | date | 否 | 标准时间格式,例:2017-7-22 10:12:11,当type为1是为必填项 |
| type | int | 否 | 默认值为0,当type为1时使用通过begintime-endtime时间段查询,时间范围不能超过一年 |
响应参数
| 参数名 | 类型 | 必选 | 说明 |
| remain_flow | string | 是 | 剩余流量 |
| total_flow | string | 是 | 直播使用总流量 |
| total_record_flow | string | 是 | 回放消耗的总流量 |
| select_total_flow | string | 是 | 查询时间段内直播使用总流量 |
| select_total_record_flow | string | 是 | 查询时间段内回放消耗的总流量 |
list数据
| 参数名 | 类型 | 必选 | 说明 |
| date | string | 是 | 时间 |
| live_flow | string | 是 | 直播消耗流量 |
| record_flow | string | 是 | 回放消耗流量 |
响应示例
{
"code":"200",
"msg":"成功",
"data":{
"remain_flow":98.78,
"total_flow":6.28,
"total_record_flow":0,
"list":[
{
"date":"2017-01-09",
"live_flow":0.12,
"record_flow":0
},
{
"date":"2017-01-08",
"live_flow":0.04,
"record_flow":0
},
{
"date":"2017-01-06",
"live_flow":0.02,
"record_flow":0
},
{
"date":"2017-01-05",
"live_flow":1.04,
"record_flow":0
}
]
}
}
错误码
| code | 含义 |
| 10060 | 用户ID不能为空 |
| 10116 | time_span 参数不能为空 |
| 10060 | 不是自己的活动 |
| 10117 | 不属于自己的账号或子账号 |
| 12201 | 当type为1时,开始时间不能为空 |
| 12202 | 开始时间格式错误 |
| 12203 | 当type为1时,结束时间不能为空 |
| 12204 | 结束时间格式错误 |
| 12205 | 开始时间不能大于结束时间 |
user/bind-manager 主账号绑定第三方账号
主账号绑定第三方账号
URL http://e.vhall.com/api/vhallapi/v2/user/bind-manager
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| third_user_id | string | 是 | 第三方用户ID,做为SDK DEMO里的帐号 |
| pass | string | 是 | 用户密码,做为SDK DEMO里的密码 |
| is_cover | int | 否 | 是否覆盖替换原有绑定的账号,传递1为覆盖,其他为不覆盖 |
响应参数
返回形如 {“code”:200,”msg”:“success”,”data”:{“user_id”:“799”}}的json,data值的数据格式如下
| 参数名 | 类型 | 必选 | 说明 |
| user_id | int | 是 | 微吼用户ID |
响应示例
{
"code": 200,
"msg": "success",
"data": {
"user_id": "799"
}
}
错误码
| code | 含义 |
| 10070 | 第三方用户ID不能为空 |
| 10077 | 密码不能为空 |
| 10078 | 密码为6-20位 |
| 12003 | 绑定主账号失败 |
| 12004 | 主账号已经被其他第三方账号绑定 |
| 12013 | 第三方账号已经注册微吼账号,请换一个未注册微吼账号的第三方账号来绑定主账号 |
user/manager-bind-info 查询主账号绑定的第三方账号
主账号绑定第三方账号
URL http://e.vhall.com/api/vhallapi/v2/user/manager-bind-info
请求参数
响应参数
返回形如 {“code”:200,”msg”:“success”,”data”:{“user_id”:“799”}}的json,data值的数据格式如下
| 参数名 | 类型 | 必选 | 说明 |
| account_id | string | 是 | 第三方账号信息 |
响应示例
{
"code":200,
"msg":"success",
"data":{
"account_id":"testuser"
}
}
错误码
| code | 含义 |
| 12011 | 主账号未绑定第三方账号,请绑定后重新查询 |
user/concurrent-audience 查询用户直播场次并发数据
查询用户直播场次并发数据
URL http://e.vhall.com/api/vhallapi/v2/user/concurrent-audience
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| user_id | int | 是 | 用户id |
| begintime | date | 是 | 标准时间格式,例:2017-7-12 10:12:11 |
| endtime | date | 是 | 标准时间格式,例:2017-7-22 10:12:11 |
响应参数
返回形如{“code”:“200”,”msg”:“\u6210\u529f”,”data”:[{“user_id”:884,”webinar_id”:580997031,”subject”:“\u5b59\u632f\u4eae\u6d4b\u8bd5\u591a\u5609\u5bbe”,”num”:4,”start_time”:“2017-05-26 23:54:30”}]}的json。data部分数据如下:
| 参数名 | 类型 | 必选 | 说明 |
| user_id | int | 是 | 用户id |
| webinar_id | int | 是 | 活动ID |
| subject | string | 是 | 活动主题 |
| num | int | 是 | 并发值 |
| start_time | datetime | 是 | 活动开始时间 |
响应示例
{
"code": "200",
"msg": "成功",
"data": [
{
"user_id": 888,
"webinar_id": 580911111,
"subject": "xxxxxxx",
"num": 3,
"start_time": "2017-05-26 22:48:49"
}
]
}
错误码
| code | 含义 |
| 10060 | 用户ID不能为空 |
| 10117 | 不属于自己的账号或子账号 |
| 10104 | 子账号信息不存在 |
| 12301 | 开始时间不能为空 |
| 12302 | 开始时间格式错误 |
| 12303 | 结束时间不能为空 |
| 12304 | 结束时间格式错误 |
| 12305 | 开始时间不能大于结束时间 |
| 12306 | 查询时间范围不能超过1年 |
user/concurrent-date 查询用户每天并发数
查询用户每天并发数
URL http://e.vhall.com/api/vhallapi/v2/user/concurrent-date
请求参数
| 参数名 | 类型 | 必选 | 说明 |
| user_id | int | 是 | 账号id |
| begintime | date | 是 | 标准时间格式,例:2017-7-12 10:12:11 |
| endtime | date | 是 | 标准时间格式,例:2017-7-22 10:12:11 |
响应参数
返回形如{“code”:“200”,”msg”:“\u6210\u529f”,”data”:{“2017-07-29”:0,”2017-07-30”:0,”2017-07-31”:0,”2017-08-01”:150,”2017-08-02”:0}}的json。data部分数据如下:
| 参数名 | 类型 | 必选 | 说明 |
| | json | 是 | 获取成功,返回列表数据(JSON格式),包含时间对应的并发数 |
响应示例
{
"code": "200",
"msg": "成功",
"data": {
"2017-07-29": 0,
"2017-07-30": 0,
"2017-07-31": 0,
"2017-08-01": 150,
"2017-08-02": 0
}
}
错误码
| code | 含义 |
| 10060 | 用户ID不能为空 |
| 10117 | 不属于自己的账号或子账号 |
| 12301 | 开始时间不能为空 |
| 12302 | 开始时间格式错误 |
| 12303 | 结束时间不能为空 |
| 12304 | 结束时间格式错误 |
| 12305 | 开始时间不能大于结束时间 |
| 12306 | 查询时间范围不能超过1年 |