用户工具

站点工具


open:vhall_api_和讯相关

* 活动管理

webinar/top-online-by-times 按活动次数获取最高并发

按活动次数获取最高并发

URL http://e.vhall.com/api/vhallapi/v2/webinar/top-online-by-times 

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID 9位数字
limit int 默认获取一条,最高50条

响应参数

返回形如{“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值的数据类型如下:

类型 说明
int 在线人数

响应示例

{
  "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
    }
  ]
}

错误码

code 含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动
10101 获取条数不能超过50
10102 活动查询记录为空

webinar/current-online-number 获取当前在线人数

获取当前在线人数

URL http://e.vhall.com/api/vhallapi/v2/webinar/current-online-number 

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID 9位数字

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:20}的json。data值的数据类型如下:

类型 说明
int 在线人数

响应示例

{
    "code": 200,
    "msg": "success",
    "data": 100
}

错误码

code 含义
10017 活动id为空
10010 活动不存在
10801 当前接口30秒内只能访问一次

webinar/online-top-number 当前活动最高并发

当前活动最高并发

URL http://e.vhall.com/api/vhallapi/v2/webinar/online-top-number

请求参数

参数名类型必选说明
webinar_id int 活动ID

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:101}的json。data值的数据类型如下:

类型 说明
int 在线人数

相应示例

{
    "code": 200,
    "msg": "success",
    "data": 101
}

错误码

code含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动
10801 当前接口30秒内只能访问一次

webinar/last-option-time 活动开始和结束时间

获取活动最近一次的开始和结束时间

URL http://e.vhall.com/api/vhallapi/v2/webinar/last-option-time

请求参数

参数名类型必选说明
webinar_id int 活动ID

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{“start_time”:“2016-09-0713:58:27”,”end_time”:“2016-09-0714:02:01”}}的json。data值的数据类型如下:

参数名 类型 必选 说明
start_time string 开始时间
end_time string 结束时间

相应示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "start_time": "2016-09-07 13:58:27",
        "end_time": "2016-09-07 14:02:01"
    }
}

错误码

code含义
10017 活动id为空
10010 活动不存在
10011 不是自己的活动

* 录播管理

record/record-time 回放视频时长

回放视频时长

URL http://e.vhall.com/api/vhallapi/v2/record/record-time

请求参数

参数名类型必选说明
record_id int 活动ID

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{“duration”:281}}的json。data值的数据类型如下:

参数名 类型 必选 说明
duration int 时长(单位:秒)

相应示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "duration": 281
    }
}

错误码

code含义
10017 录播id为空
10010 录播不存在
10011 不是自己的活动
10010 查询数据为空

record/default 将回放设置为默认活动回放

回放视频时长

URL http://e.vhall.com/api/vhallapi/v2/record/default

请求参数

参数名类型必选说明
record_id int 活动ID

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{}}的json。data值的数据类型如下:

参数名 类型 必选 说明

相应示例

{
    "code": 200,
    "msg": "success",
    "data": {}
}

错误码

code含义
10017 录播id为空
10010 录播不存在
10011 不是自己的活动

chat/send-comment 添加评论

添加评论

URL http://e.vhall.com/api/vhallapi/v2/chat/send-comment 

请求参数

参数名 类型 必选 说明
webinar_id int 活动ID
content string 评论内容
user_id int 用户ID
nike_name string 用户昵称
avatar string 用户头像的完整网络路径

响应参数

返回形如{“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 含义
10017 活动ID为空
10806 内容为空
10807 用户ID为空
10809 昵称为空
10010 活动不存在
10011 不是自己的活动
10808 当前用户未参会

webinar/create-webinar-from-record 把回放发布为点播活动

把回放发布为活动

URL http://e.vhall.com/api/vhallapi/v2/webinar/create-webinar-from-record 

请求参数

参数名 类型 必选 说明
record_id int 回放id
subject int 活动标题,50个字符
use_global_k int 默认为0不开启,1为开启,是否针对此活动开启全局K值配置
exist_3rd_auth int 默认为0不开启,1为开启,是否开启第三方K值验证查看说明
auth_url int 是/否 255个字符限制,第三方K值验证接口URL(如果exist_3rd_auth值为1则必填)
failure_url int 255个字符限制,第三方K值验证失败跳转URL(可选)
introduction int 1000个字符,活动简介
is_open int 0为公开,1为非公开,个人公开/非公开活动
is_chat int 0为是,1为否,是否开启聊天

以上所有参数除了record_id,如果未填写则使用原活动的配置。

错误码

code 含义
400 用户参数错误
500 服务器错误

没有细分具体的错误码,但是会分别给出错误信息

返回形如{“code”:400,”msg”:“回放id不能为空”}的json

响应参数

返回形如{“code”:200,”msg”:“success”,”webinar_id”:888}的json。data值的数据类型如下:

类型 说明
webinar_id  新生成活动的id
open/vhall_api_和讯相关.txt · 最后更改: 2016/12/14 13:57 由 dawei.pei