直播API

房间管理

房间列表

API 地址

api.vhallyun.com/api/v1/room/lists

描述

按当前公共参数传入app_id对应的应用,获取房间列表

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
pos int 获取条目节点,默认为 0。eg : 10, 从第10条开始查询
limit int 获取条目数量, 默认为 10 条, 最大为1000条

出参

参数 类型 是否必选 含义
room_id string 房间ID
app_id string app_id
is_disable int 是否禁停房间,0 非禁停,1 禁停
created_at string 创建时间

错误码

错误码 类型 含义
40008 int 分页起始提条目不正确
40009 int 分页条目不正确
20002 int 房间查询为空

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "room_id": "lss_314eaf4b",
            "app_id": "app_id_1",
            "is_disable": 0,
            "created_at": "2017-12-01 21:27:09"
        },
        {
            "room_id": "lss_b42cd4bd",
            "app_id": "app_id_1",
            "is_disable": 0,
            "created_at": "2017-12-04 11:01:16"
        },
        {
            "room_id": "lss_b88e1673",
            "app_id": "app_id_1",
            "is_disable": 0,
            "created_at": "2017-12-04 11:18:54"
        }
    ]
}

创建房间

API 地址

api.vhallyun.com/api/v1/room/create

描述

房间是视频流的载体,创建房间后,可使用房间发起直播

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义

出参

参数 类型 是否必选 含义
room_id string 房间ID

错误码

错误码 类型 含义

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "room_id": "lss_69178ce4"
    }
}

封停房间

API 地址

api.vhallyun.com/api/v1/room/disable

描述

当视频被认为是违规或其他情况,封停接口,可使视频流不在分发,观看端无法继续观看

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 房间ID

出参

参数 类型 是否必选 含义
disable_room_id string 封停房间ID

错误码

错误码 类型 含义
20002 int 房间查询为空
30001 int 不是当前房间拥有者
50001 int 系统更新错误

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "disable_room_id": "lss_87dfa7ef"
    }
}

解封房间

API 地址

api.vhallyun.com/api/v1/room/enable

描述

和封停房间对应,解除对房间的封停

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 房间ID

出参

参数 类型 是否必选 含义
enable_room_id string 解封房间ID

错误码

错误码 类型 含义
20002 int 房间查询为空
30001 int 不是当前房间拥有者
50001 int 系统更新错误

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "enable_room_id": "lss_87dfa7ef"
    }
}

删除房间

API 地址

api.vhallyun.com/api/v1/room/delete

描述

删除房间,和创建房间对应

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 房间ID

出参

参数 类型 是否必选 含义
delete_room_id string 删除房间ID

错误码

错误码 类型 含义
20002 int 房间查询为空
30001 int 不是当前房间拥有者
50002 int 系统删除失败

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "delete_room_id": "lss_87dfa7ef"
    }
}

获取推流信息

API 地址

api.vhallyun.com/api/v1/room/get-push-info

描述

微吼云房间支持使用第三方推流工具推流,通过接口可以获取推流地址

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 房间ID
expire_time string 过期时间, 格式: 2017/01/01 00:00:00

出参

参数 类型 是否必选 含义
stream_number string 直播码
push_address string 推流地址信息

错误码

错误码 类型 含义
10026 int 过期时间不能为空
20002 int 房间查询为空
30001 int 不是当前房间拥有者
40004 int 时间类型不正确

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "stream_number": "lss_75ba2dcf",
        "push_address": "rtmp://t-open-push.live.vhou.net:1935/vhall?vhost=indexVhost?token=3D93913Dt24FA1?webinar_id=lss_75ba2dcf?ismix=0?mixserver=?accesstoken=vhall"
    }
}

获取直播流信息

API 地址

api.vhallyun.com/api/v1/room/get-stream-msg

描述

获取房间下直播流的流信息

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 房间ID

出参

参数 类型 是否必选 含义
rate string 流帧率

错误码

错误码 类型 含义
20002 int 房间查询为空
30001 int 不是当前房间拥有者
20008 int 当前流没有推起

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "rate": "0fps"
    }
}

获取正在推流的房间列表

API 地址

api.vhallyun.com/api/v1/room/get-pushing-stream-list

描述

按当前公共参数传入app_id对应的应用,获取正在推流的房间列表

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义

出参

参数 类型 是否必选 含义
room_list list 房间列表

错误码

错误码 类型 含义

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "room_list": [
            "lss_497541895",
            "lss_af793b0e",
        ]
    }
}

批量获取房间流状态信息

API 地址

api.vhallyun.com/api/v1/room/get-stream-status

描述

批量获取房间流状态信息,返回是否推流,开始推流和结束推流时间

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_ids string 房间ID,多个房间ID以英文逗号分隔

出参

参数 类型 是否必选 含义
data object 流状态信息数据集合

data 参数

参数 类型 是否必选 含义
room_id string 房间ID
stream_status int 流状态:1 推流中 2 未推流或推流结束
push_time string 开始推流时间
end_time string 结束推流时间

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "lss_1a3edf96": {
            "push_time": "2018-09-14 13:35:32",
            "stream_status": 2,
            "end_time": "2018-09-14 13:35:42",
            "room_id": "lss_1a3edf96"
        },
        "lss_599ea484": {
            "push_time": "0000-00-00 00:00:00",
            "stream_status": 2,
            "end_time": "0000-00-00 00:00:00",
            "room_id": "lss_599ea484"
        },
        "lss_b5516b04": {
            "push_time": "0000-00-00 00:00:00",
            "stream_status": 2,
            "end_time": "0000-00-00 00:00:00",
            "room_id": "lss_b5516b04"
        }
    }
}

直播设置

配置直播转码

API 地址

api.vhallyun.com/api/v1/room/set-trans-code-info

描述

开通直播服务后,微吼云不会对视频流进行转码,可通过接口配置需要转码的清晰度

  • 清晰度配置针对应用配置,如果多个应用都需要,需要分别配置

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
rate string 转换清晰度 多个清晰度以英文逗号分开,清晰度见下面列表。 eg : 360P,720P

清晰度列表

参数 类型 含义
360P string 分辨率360P,码率330kb
480P string 分辨率480P,码率450kb
720P string 分辨率720P,码率650kb

出参

参数 类型 是否必选 含义
rate string 配置的清晰度

错误码

错误码 类型 含义
10024 int 转码配置不能为空
40010 int 转码类型不正确

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "rate": "360P,720P"
    }
}

配置开始直播录制

API 地址

api.vhallyun.com/api/v1/room/set-record-info

描述

通过API配置后可以在直播在推流结束后调用点播API生成点播文件

  • 配置开始录制针对应用配置,如果多个应用都需要,需要分别配置

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
open_record int 是否开启直播录制, 0 关闭 ,1 开启,默认

出参

参数 类型 是否必选 含义
open_record int 配置的是否开启值

错误码

错误码 类型 含义
10025 int 是否开启配置不能为空
40011 int 配置开启录制类型不正确
40012 int 未开启点播服务

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "open_record": "1"
    }
}

直播水印设置

API 地址

api.vhallyun.com/api/v1/room/set-watermark

描述

添加播放器中的水印信息

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
watermark_id int 水印模板id,为0或空时不展示水印

出参

参数 类型 是否必选 含义
watermark_id int 水印模板id

错误码

错误码 类型 含义
20015 int 水印模板查询为空
50001 int 系统更新错误

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "watermark_id": 9
    }
}

数据统计查询

获取直播流量数据

API 地址

api.vhallyun.com/api/v1/room/get-stream-flow

描述

按当前传入app_id对应的应用,获取直播流量数据

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
pos int 获取条目节点,默认为 0。 eg : 10 从第10条开始查询
limit int 获取条目数量, 默认为10 条,最大为1000条
start_time date 查询开始时间, 格式为: 2017/01/01
end_time date 查询结束时间, 默认为当前时间。 格式为: 2017/01/01

出参

参数 类型 是否必选 含义
flow list 按天获取的流量使用列表 (单位为 KB)

错误码

错误码 类型 含义
10020 int 开始时间不能为空
40004 int 时间类型不正确
40008 int 分页起始提条目不正确
40009 int 分页条目不正确

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "flow": {
            "2017-12-11": "0",
            "2017-12-12": "20400",
            "2017-12-13": "0",
        }
    }
}

获取直播宽带数据

API 地址

api.vhallyun.com/api/v1/room/get-stream-board-band

描述

按当前公共参数传入app_id对应的应用,获取直播宽带数据

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
pos int 获取条目节点,默认为 0。 eg : 10 从第10条开始查询
limit int 获取条目数量, 默认为 10 条, 最大为1000
start_time date 查询开始时间 ,格式为: 2017/01/01
end_time date 查询结束时间, 默认为当前时间 格式为: 2017/01/01

出参

参数 类型 是否必选 含义
bandwidth list 按天获取的宽带使用列表 (单位为 KB)

错误码

错误码 类型 含义
10020 int 开始时间不能为空
40004 int 时间类型不正确
40008 int 分页起始提条目不正确
40009 int 分页条目不正确

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "bandwidth": {
            "2017-12-11": "0",
            "2017-12-12": "0",
        }
    }
}

获取直播属性信息

API 地址

api.vhallyun.com/api/v1/room/get-room-use-info

描述

获取直播房间的流量、宽带、pv、uv以及观看时长

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 房间ID
pos int 获取条目节点,默认为 0。 eg : 10 从第10条开始查询
limit int 获取条目数量,默认为 10 条,最大为1000条
start_time date 查询开始时间,格式为:2017/01/01
end_time date 查询结束时间,默认为当前时间,格式为:2017/01/01

出参

参数 类型 是否必选 含义
flow int 流量 单位(KB)
bandwidth int 带宽 单位 (kbps)
pv_num int pv
uv_num int uv
tt int 总观看时长 单位 (秒)
created_time date 统计时间

错误码

错误码 类型 含义
10020 int 开始时间不能为空
20011 int 房间使用信息查询为空
30001 int 不是当前房间拥有者
40004 int 时间类型不正确
40008 int 分页起始提条目不正确
40009 int 分页条目不正确

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "flow": 15015,
            "bandwidth": 330,
            "pv_num": 3,
            "uv_num": 1,
            "tt": 364,
            "created_time": "2019-01-29 11:00:00"
        },
        {
            "flow": 700,
            "bandwidth": 193,
            "pv_num": 1,
            "uv_num": 1,
            "tt": 29,
            "created_time": "2019-01-29 12:00:00"
        }
    ]
}

获取直播访问记录

API 地址

api.vhallyun.com/api/v1/room/get-room-join-info

描述

获取直播房间流的访问记录

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 房间ID
pos int 获取条目节点,默认为 0
limit int 获取条目数量,默认为 10 条,最大为1000条
start_time date 查询开始时间,格式为:2017/01/01
end_time date 查询结束时间,默认为当前时间,格式为:2017/01/01

出参

参数 类型 是否必选 含义
uid string 第三方用户ID
start_time string 进入时间
end_time string 离开时间
tt int 总观看时长 单位 (秒)
pf string 观看终端 ,0代表iOSAPP,1代表AndroidAPP,2代表flash,3代表wap,4代表IOSSDK,5代表AndroidSDK,6代表小助手,7代表h5播放器pc端
browser string 请求方式
viewer_province string 地域

错误码

错误码 类型 含义
10020 int 开始时间不能为空
20011 int 房间使用信息查询为空
30001 int 不是当前房间拥有者
40004 int 时间类型不正确
40008 int 分页起始提条目不正确
40009 int 分页条目不正确
20014 int 当前房间记录为空

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "uid": "1000204982",
            "start_time": "2018-03-06 11:55:00",
            "end_time": "2018-03-07 11:29:00",
            "tt": 1335,
            "pf": "7",
            "browser": "QQBrowser",
            "viewer_province": "上海"
        },
        {
            "uid": "1000204982",
            "start_time": "2018-03-06 11:57:00",
            "end_time": "2018-03-07 11:29:00",
            "tt": 1268,
            "pf": "7",
            "browser": "Chrome",
            "viewer_province": "加利福尼亚州"
        }
    ]
}

水印模板管理

创建水印模板

API 地址

api.vhallyun.com/api/v1/watermark/create

描述

水印模板创建后,可通过直播和点播水印设置接口设置使用

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
watermark_name string 模板名称
watermark_image http multipart/form-data 水印图片文件
watermark_positiontype int 水印位置 1 2 3 4 对应 左上、右上、右下和左下

出参

参数 类型 是否必选 含义
watermark_id int 水印模板ID

错误码

错误码 类型 含义
10033 int 水印图片不能为空
10034 int 水印模板名称不能为空
10035 int 水印位置不能为空
40034 int 水印图片只能使用png格式
40035 int 水印图片大小不能超过1M
40036 int 模板名称最多30个字符
40037 int 模板名称只能使用中英文数字
40033 int 水印位置不正确
50005 int 水印模板创建失败

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "watermark_id": 10
    }
}

修改水印模板

API 地址

api.vhallyun.com/api/v1/watermark/update

描述

修改水印模板的名称、图片和位置

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
watermark_id int 模板ID
watermark_name string 模板名称
watermark_image http multipart/form-data 水印图片文件
watermark_positiontype int 水印位置 1 2 3 4 对应 左上、右上、右下和左下

出参

参数 类型 是否必选 含义
watermark_id int 水印模板ID
watermark_name string 水印模板名称
watermark_img string 水印模板图片地址
watermark_positiontype int 水印模板位置
created_at datetime 水印模板创建时间
updated_at datetime 水印模板更新时间

错误码

错误码 类型 含义
10001 int 应用ID不能为空
10036 int 水印模板id不能为空
40032 int 水印模板不存在
40033 int 水印位置不正确
40034 int 水印图片只能使用png格式
40035 int 水印图片大小不能超过1M
40036 int 模板名称最多30个字符
40037 int 模板名称只能使用中英文数字
50001 int 系统更新错误

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "watermark_id": 7,
        "watermark_name": "1",
        "watermark_img": "https://t-static01-open.e.vhall.com/images/c3eefa6997d318e1229009a726f259a3.png",
        "watermark_positiontype": 1,
        "created_at": "2019-01-22 11:24:31",
        "updated_at": "2019-01-22 11:24:31"
    }
}

删除水印模板

API 地址

api.vhallyun.com/api/v1/watermark/delete

描述

删除一个水印模板

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
watermark_id int 模板ID

出参

参数 类型 是否必选 含义
delete_watermark_id int 删除的水印模板ID

错误码

错误码 类型 含义
10001 int 应用ID不能为空
10036 int 水印模板id不能为空
40032 int 水印模板不存在

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "delete_watermark_id": 9
    }
}

查看水印模板详情

API 地址

api.vhallyun.com/api/v1/watermark/view

描述

查看一个水印模板的具体配置信息

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
watermark_id int 模板ID

出参

参数 类型 是否必选 含义
watermark_id int 水印模板ID
watermark_name string 水印模板名称
watermark_img string 水印模板图片地址
watermark_positiontype int 水印位置 1 2 3 4 对应 左上、右上、右下和左下
created_at datetime 水印模板创建时间
updated_at datetime 水印模板更新时间

错误码

错误码 类型 含义
10001 int 应用ID不能为空
10036 int 水印模板id不能为空
40032 int 水印模板不存在

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "watermark_id": 7,
        "watermark_name": "1",
        "watermark_img": "https://t-static01-open.e.vhall.com/images/c3eefa6997d318e1229009a726f259a3.png",
        "watermark_positiontype": 1,
        "created_at": "2019-01-22 11:24:31",
        "updated_at": "2019-01-22 11:24:31"
    }
}

查看水印模板列表

API 地址

api.vhallyun.com/api/v1/watermark/lists

描述

列出当前应用所有水印模板的配置信息

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
pos int 获取条目节点,默认为 0。eg : 10 从第10条开始查询
limit int 获取条目数量,默认为10条,最大为1000条

出参

参数 类型 是否必选 含义
watermark_id int 水印模板ID
watermark_name string 水印模板名称
watermark_img string 水印模板图片地址
watermark_positiontype int 水印位置 1 2 3 4 对应 左上、右上、右下和左下
created_at datetime 水印模板创建时间
updated_at datetime 水印模板更新时间

错误码

错误码 类型 含义
10001 int 应用ID不能为空
20015 int 水印模板查询为空
70001 int 分页条目超过限制
40009 int 分页条目不正确

响应格式

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "watermark_id": 3,
            "watermark_name": "1",
            "watermark_img": "t-static01-open.e.vhall.com/images/c3eefa6997d318e1229009a726f259a3.png",
            "watermark_positiontype": 1,
            "created_at": "2019-01-21 19:54:21",
            "updated_at": "2019-01-21 19:54:21"
        },
        {
            "watermark_id": 6,
            "watermark_name": "1",
            "watermark_img": "https://t-static01-open.e.vhall.com/images/c3eefa6997d318e1229009a726f259a3.png",
            "watermark_positiontype": 1,
            "created_at": "2019-01-22 11:24:28",
            "updated_at": "2019-01-22 11:24:28"
        },
 ...
    ]
}

鉴黄管理

获取鉴黄列表

API 地址

api.vhallyun.com/api/v1/room/get-check-pic-list

描述

按传入时间获取直播服务对应APP下的截图列表

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 按房间ID查询截图详情
pos int 获取条目节点,默认为 0。 eg : 10 从第10条开始查询
limit int 获取条目数量, 默认为 10 条, 最大为1000
start_time date 查询开始时间 ,格式为: 2017/01/01
end_time date 查询结束时间, 默认为当前时间 格式为: 2017/01/01

出参

参数 类型 是否必选 含义
num int 总数
lists obj 截图详情

lists 参数

参数 类型 是否必选 含义
room_id string 房间ID
label string 风险场景, porn (色情)normal (正常)
rate string 分数,越高表示越接近风险场景(label 字段)
suggestion string 议用户执行的操作,取值范围:pass:图片正常,无需进行其余操作,或者未识别出目标对象 review:需要进行人工审核,或识别出目标对象 block:图片违规,可以直接删除或者做限制处理
img_url string 截图产生的文件地址
created_at string 截图时间

错误码

错误码 类型 含义
10020 int 开始时间不能为空
40004 int 时间类型不正确
40008 int 分页起始提条目不正确
40009 int 分页条目不正确

响应格式

{
    "code":200,
    "msg":"",
    "data":{
        "num":24,
        "lists":[
            {
                "room_id":"lss_fcc7c832",
                "scene":"porn",
                "label":"normal",
                "rate":100,
                "suggestion":"pass",
                "img_url":"http://e.vhall.com/screenshot/20180606/20180606101020.jpg",
                "created_at":"2018-06-06 10:10:25"
            },
            {
                "room_id":"lss_fcc7c832",
                "scene":"porn",
                "label":"normal",
                "rate":100,
                "suggestion":"pass",
                "img_url":"http://e.vhall.com/screenshot/20180606/20180606101030.jpg",
                "created_at":"2018-06-06 10:10:34"
            }
        ]
    }
}

设置鉴黄开关

API 地址

api.vhallyun.com/api/v1/room/set-check-pic

描述

通过接口设置直播服务是否开启鉴黄服务,以及鉴黄频率(截图频率)

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
is_open int 是否开启鉴黄服务 1 开启 2 关闭
check_time int 鉴黄频率 单位为秒 默认 10秒

出参

参数 类型 是否必选 含义

错误码

错误码 类型 含义
10031 int 配置开关不能为空

响应格式

{
    "code": 200,
    "msg": "",
    "data": []
}

直播截图查询

API 地址

api.vhallyun.com/api/v1/room/pictures

描述

获取直播房间截图列表,返回图片地址和生成截图时间

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 房间ID
limit int 获取条目数量, 默认为 10 条, 最大为1000
start_time date 查询开始时间 ,格式为: 2017/01/01
end_time date 查询结束时间, 默认为当前时间 格式为: 2017/01/01

出参

参数 类型 是否必选 含义
data object 图片地址和生成截图时间

data 参数

参数 类型 是否必选 含义
count_all int 时间区间内的全部图片个数
count_return int 实际返回的图片个数(出于数量限制的要求)
lists array 截图列表

lists 参数

参数 类型 是否必选 含义
url string 图片地址
create_time datetime 截图时间

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
        "count_all": 2,
        "count_return": 2,
        "lists": [
            {
                "url": "http://pictures01.e.vhou.net/vhallpictures/433842427/screenshot/20160401/20160401151402.jpg",
                "create_time": "2016-04-01 15:14:02"
            },
            {
                "url": "http://pictures01.e.vhou.net/vhallpictures/433842427/screenshot/20160401/20160401151412.jpg",
                "create_time": "2016-04-01 15:14:12"
            }
        ]
    }
}

直播拉流管理

创建拉流配置

API 地址

api.vhallyun.com/api/v1/room/create-live-pull-stream-config

描述

根据源流(url或vhall房间ID) 、拉流的目标房间(vhall房间ID)、开始时间、结束时间创建直播拉流配置,创建完成后将按照开始/结束时间执行任务。

回调事件类型: 直播拉流事件

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
room_id string 拉流房间ID
source_type int 标识拉流来源类型
0:第三方URL类型
1:vhall直播间类型
source_url string 来源的视频流URL
支持rtmp,http格式
(当source_type为0的类型会校验url正确性,其他类型时字段值可以为空)
source_room_id string 来源的vhall直播房间ID
(当source_type为1的类型会校验来源房间正确性,其他类型时字段值可以为空)
start_time string 拉流开始时间,格式如2019-01-01 12:00:00
end_time string 拉流结束时间,格式如2019-01-02 12:00:00
结束时间和开始时间必须大于当前时间
拉流结束时间和开始时间间隔在 5 天内,且结束时间要大于开始时间

出参

参数 类型 是否必选 含义
config_id string 拉流配置ID

错误码

错误码 类型 含义
20002 int 房间查询为空
30001 int 不是当前房间拥有者
40004 int 时间类型不正确
40040 int 请求参数错误
40041 int 创建拉流配置失败
40042 int 创拉流配置冲突

响应格式

{
    "code": 200,
    "msg": "",
    "data": {
	"config_id":"18930"
    }
}

查询拉流配置

API 地址

api.vhallyun.com/api/v1/room/describe-live-pull-stream-config

描述

根据房间ID或拉流配置ID,查询该用户下所有或者某一个配置下的拉流信息

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
config_id string 拉流配置ID
不传此参数则查询应用下所有有效配置

出参

参数 类型 是否必选 含义
pull_stream_configs object 拉流配置信息列表

pull_stream_config数据类型

参数 类型 是否必选 含义
config_id string 配置ID
room_id string 拉流房间ID
source_type int 标识拉流来源类型
0:第三方URL类型
1:vhall直播间类型
source_url string 来源的视频流URL
source_room_id string 来源的vhall直播房间ID
start_time string 拉流开始时间
end_time string 拉流结束时间
pull_status int 直播拉流状态
0:未开始
1:直播拉流开始
2:直播拉流结束
3:直播拉流异常

错误码

错误码 类型 含义
40040 int 请求参数错误

响应格式

{
	"code": 200,
	"msg": "",
	"data": {
		"pull_stream_configs":[
			{
				"config_id":"18930",
				"room_id":"lss_893f81e9",
				"source_url":"",
				"source_room_id":"",
				"source_type":0,
				"start_time": "2019-10-17 11:23:10",
				"end_time":"2019-10-19 14:10:52"
			}
		]
	}
}

删除拉流配置

API 地址

api.vhallyun.com/api/v1/room/delete-live-pull-stream-config

描述

删除直播拉流配置。如该任务正在执行,则立即停止任务并删除配置。

回调事件类型: 直播拉流事件

入参

关于公共请求参数详细内容,请参考 公共请求参数

参数 类型 是否必选 含义
config_id string 配置ID

出参

参数 类型 是否必选 含义

错误码

错误码 类型 含义
40040 int 请求参数错误
40044 int 拉流配置查询为空

响应格式

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