结束直播
更新时间: 2024/07/24 10:02:26
本文介绍结束会议直播。
请求
URI
POST https://{endpoint}/apps/v2/live-end
- {endpoint} 为 会议组件接入地址的域名,默认为
roomkit.netease.im
。 - Content-Type:application/json;charset=utf-8
Header
请求 Header 的参数说明请参考 请求结构。
请求参数
参数名称 |
类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
roomArchiveId | Long | 是 | 110119120 | 待结束直播间的 roomArchiveId, 即归档到历史记录中的房间 ID,全局唯一 您可以通过创建会议的返回参数中获取该参数的值 |
请求体示例
java{
"roomArchiveId":110119120
}
响应
响应参数
参数名称 |
类型 | 示例 |
描述 |
---|---|---|---|
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 | 处理该请求所消耗的时间 |
响应体示例
java{
"code": 0,
"msg": "Success",
"ts": 1619068087795,
"cost": "66ms",
"requestId": "6e507107d1f4447ea731f651dc6d2432",
"data": null
}
错误码
错误码 | 错误信息 | 说明 |
---|---|---|
3104 | Meeting not found. | 会议不存在 |
1020 | Incorrect password. | 密码错误 |
801 | Chat room already exists. | 已创建独立聊天室 |
802 | live broadcast status error. | 直播状态错误 |
803 | live broadcast does not exist. | 直播不存在 |
相关接口
接口 | 描述 |
---|---|
开始直播 | 开启会议直播 |
修改直播 | 主播上线时、修改画面布局等场景中需要调用此接口更新直播 |
查询直播信息 | 查询指定直播的详细信息,包括推流地址、布局模式等 |
自定义直播布局 | 如果默认布局无法满足您的要求,开发者可以自定义布局 |
此文档是否对你有帮助?