主播上线时、修改画面布局等场景中需要调用此接口更新直播。

请求

URI

POST https://{endpoint}/apps/v2/live-update

• {endpoint} 为 会议组件接入地址的域名，默认为 roomkit.netease.im。
• Content-Type：application/json;charset=utf-8

Header

请求 Header 的参数说明请参见 请求结构。

请求参数

参数名称	类型	是否必选	示例	描述
roomArchiveId	Long	是	110119120	归档到历史记录中的房间 ID，全局唯一 您可以通过创建会议的返回参数中获取该参数的值
liveUserUuids	Array of String	是	-	主播的用户 ID，您可以通过创建会议账号的返回参数中获取用户 ID 的值。 如果是画廊模式和聚焦模式，主播最多为 4 个。 如果是自定义模式，主播最多为 7 个。
title	String	否	年终总结大会	直播标题，最大长度 64 位字符。支持中文、英文、数字和下划线
liveLayout	Integer	否	1	直播布局，包括： 1：画廊布局 2：聚焦布局 5：自定义布局
password	String	否	123456	直播密码，格式为 6 位数字的字符串 如果密码为空，用户无需密码即可进入直播。 如果设置了密码，用户需要输入密码才能观看直播。
extensionConfig	String	否	-	扩展字段，Json 格式，用于透传消息给客户端。最大 500 个字符
layoutCoordinateList	Array of Json	否	-	布局相关参数配置请参考自定义直播布局

请求体示例

java{
    "roomArchiveId":110119120,
    "title":"www.pushurl.com",
    "liveLayout":1,
    "password":"123321",
    "liveUserUuids":["abc","def","ghi"],
    "extensionConfig": "{\"onlyEmployeesAllow\":true,\"liveChatRoomEnable\":false}"
}

响应

响应参数

参数名称	类型	示例	描述
code	Integer	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	-	开启直播的结果
taskId	String	1344725342275574	直播任务编号
pushUrl	String	rtmp://p8b442175.live.126.net/live/c86a203ba1fb08b74dc5d5c?wsSecret=46c29fb35ab0&wsTime=1648733127	推流地址
chatRoomId	String	975537600	直播聊天室房间号
pullHttpUrl	String	http://flv8b442175.live.126.net/live/c86a20***1fb08b74dc5d5c.flv?netease=flv8b442175.live.126.net	HTTP 拉流地址
pullRtmpUrl	String	rtmp://v8b442175.live.126.net/live/c86a20***ba1fb08b74dc5d5c	RTMP 拉流地址
pullHlsUrl	String	http://pullhls8b442175.live.126.net/live/c86a20***3ba1fb08b74dc5d5c/playlist.m3u8	HLS 拉流地址
pullRtsUrl	String	nertc://rt8b442175.live.126.net/live/c86a20***a1fb08b74dc5d5c	RTS 拉流地址
title	String	121314	直播标题
liveLayout	Integer	4	直播布局 1：画廊布局 2：聚焦布局 4：共享屏幕布局 5：自定义布局
liveChatRoomIndependent	boolean	true	是否使用独立的直播聊天室 false：不使用独立的直播聊天室，使用会议的聊天室作为直播聊天室，此时直播间的聊天消息和会议的聊天消息互通 true：使用独立的直播聊天室，此时直播间的聊天消息和会议的聊天消息不互通
liveAVRoomUids	Array of Long	-	主播的 liveUserUuids 对应的 RTC 房间内的 uid
extensionConfig	String	-	扩展字段，Json 格式，用于透传消息给客户端

响应体示例

java{
    "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.	直播不存在

相关接口

接口	描述
开始直播	开启会议直播
查询直播信息	查询指定直播的详细信息，包括推流地址、布局模式等
自定义直播布局	如果默认布局无法满足您的要求，开发者可以自定义布局
结束直播	结束直播