开始直播
更新时间: 2024/08/15 17:30:43
本文介绍通过会议服务端接口开启会议直播。会议直播适用于大型会议场景,只有几个主播需要发言,大部分观众只需要拉流观看。会议直播的应用场景包括但不限于企业内部会议、学术会议、在线培训和公共演讲等领域。通过会议直播,不仅可以提高信息传达效率,还可以节省成本。
会议直播 为增值功能,如需开通,您可在线咨询网易云信商务经理以获得相应的产品报价。
请求信息
- 请求方法:POST
- 请求 URL:https://roomkit.netease.im/apps/v2/live-start
- Content-Type:application/json;charset=utf-8
- AppKey:应用的 AppKey。详情请参考 创建应用并获取 AppKey。
- 鉴权头:接口鉴权。详情请参考 请求结构。
请求头参数
请求头(Header)的参数说明,请参考 请求结构。
请求体参数
参数名称 |
类型 | 是否必选 | 示例 | 说明 |
---|---|---|---|---|
roomArchiveId | Long | 是 | 110119120 | 归档到历史记录中的房间 ID,全局唯一 您可以通过 创建会议 的返回参数中获取该参数的值 |
title | String | 是 | 年终总结大会 | 直播标题,最大长度 64 位字符。支持中文、英文、数字和下划线 |
liveLayout | Integer | 是 | 1 | 直播布局,包括:
|
liveChatRoomIndependent | boolean | 是 | true | 是否使用独立的直播聊天室
|
liveUserUuids | Array of String | 是 | - | 主播的用户 ID,您可以通过 创建会议账号 的返回参数中获取用户 ID 的值。
|
password | String | 否 | 123456 | 直播密码,格式为 6 位数字的字符串
|
extensionConfig | String | 否 | - | 扩展字段,Json 格式,用于透传消息给客户端。最大 500 个字符。 |
layoutCoordinateList | Array of Json | 否 | - | 布局相关参数配置请参考 自定义直播布局。 |
请求体示例
JSON{
"roomArchiveId":110119120,
"title":"www.pushurl.com",
"liveLayout":1,
"liveChatRoomIndependent":true,
"liveUserUuids":["abc","def","ghi"],
"password":"123321",
"extensionConfig": "{\"onlyEmployeesAllow\":true,\"liveChatRoomEnable\":false}"
}
响应信息
响应参数
参数名称 |
类型 | 示例 |
说明 |
---|---|---|---|
code | int | 0 | 状态码,0 表示成功,具体请参考 错误码。 |
msg | String | Success | 业务结果描述,Success 表示成功 |
ts | Long | 1648021056815 | 会议服务器处理该请求的完成时间。该时间为 Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数 |
requestId | String | 7c4b6d9c3e9d42*****cc6e3a4d995 | 请求的唯一标识 |
cost | String | 48ms | 处理该请求所消耗的时间 |
+ data | Object | - | 开启直播的结果 |
响应体示例
JSON{
"code": 0,
"msg": "Success",
"ts": 1648784050915,
"cost": "6223ms",
"requestId": "01221dcff02c444981830488822584ef",
"data": {
"taskId": "1344725342275574",
"pushUrl": "rtmp://p8b442175.live.126.net/live/c86a20***3ba1fb08b74dc5d5c?wsSecret=46c2***9fb35ab0&wsTime=1648733127",
"chatRoomId": "975537600",
"pullHttpUrl": "http://flv8b442175.live.126.net/live/c86a20***1fb08b74dc5d5c.flv?netease=flv8b442175.live.126.net",
"pullRtmpUrl": "rtmp://v8b442175.live.126.net/live/c86a20***ba1fb08b74dc5d5c",
"pullHlsUrl": "http://pullhls8b442175.live.126.net/live/c86a20***3ba1fb08b74dc5d5c/playlist.m3u8",
"pullRtsUrl": "nertc://rt8b442175.live.126.net/live/c86a20***a1fb08b74dc5d5c",
"title": "121314",
"liveLayout": 1,
"liveChatRoomIndependent": true,
"liveAVRoomUids": [
13429,
123
],
"extensionConfig": "{\"onlyEmployeesAllow\":true,\"liveChatRoomEnable\":false}"
}
}
错误码
错误码 | 错误信息 | 说明 |
---|---|---|
3104 | Meeting not found. | 会议不存在 |
1020 | Incorrect password. | 密码错误 |
801 | Chat room already exists. | 已创建独立聊天室 |
802 | live broadcast status error. | 直播状态错误 |
803 | live broadcast does not exist. | 直播不存在 |
相关接口
接口 | 描述 |
---|---|
修改直播 | 主播上线时、修改画面布局等场景中需要调用此接口更新直播 |
查询直播信息 | 查询指定直播的详细信息,包括推流地址、布局模式等 |
自定义直播布局 | 如果默认布局无法满足您的要求,您可以自定义布局 |
结束直播 | 结束直播 |
此文档是否对你有帮助?