查询直播信息

更新时间: 2025/04/09 14:46:37

查询指定直播的详细信息,包括推流地址、布局模式等。

  • 若该会议已被回收,则无法查询到对应的会议直播信息。会议状态说明请参考 创建会议
  • 只有当该会议未被回收时,您能查询到对应的会议直播信息,包括正在进行的或已结束的。

请求信息

请求 URI

GET https://{endpoint}/apps/v2/live-info/?roomArchiveId={roomArchiveId}

{endpoint} 为 网易会议组件接入地址的域名,默认为 roomkit.yunxinapi.com

请求头参数

请求 Header 的参数说明请参考 请求结构

请求查询参数

参数名称
类型 是否必选 示例 说明
roomArchiveId Long 110119120 待查询直播间的 roomArchiveId,即归档到历史记录中的房间 ID,全局唯一。您可以通过 创建会议 的返回参数中获取该参数的值。

请求示例

https://roomkit.yunxinapi.com/apps/v2/live-info?roomArchiveId=123456

响应信息

响应参数

参数名称
类型
示例
说明
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 直播任务编号。
chatRoomId String 975537600 直播聊天室房间号。
pushUrl String rtmp://p8b442175.live.126.net/live/c86a203ba1fb08b74dc5d5c?wsSecret=46c29fb35ab0&wsTime=1648733127 推流地址。如果您开启了防盗链,该参数返回一个带防盗链的推流地址,格式请参考 防盗链
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 1 直播布局
  • 1:画廊布局
  • 2:聚焦布局
  • 5:自定义布局。
liveChatRoomIndependent boolean true 是否使用独立的直播聊天室
  • false:不使用独立的直播聊天室,使用会议的聊天室作为直播聊天室,此时直播间的聊天消息和会议的聊天消息互通
  • true:使用独立的直播聊天室,此时直播间的聊天消息和会议的聊天消息不互通。
liveAVRoomUids Array of Long - 主播的 liveUserUuids 对应的 RTC 房间内的 uid。
extensionConfig String - 扩展字段,Json 格式,用于透传消息给客户端。

响应体示例

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": 4,
        "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. 直播不存在。

相关接口

接口 描述
开始直播 开启会议直播
修改直播 主播上线时、修改画面布局等场景中需要调用此接口更新直播
自定义直播布局 如果默认布局无法满足您的要求,您可以自定义布局
结束直播 结束直播
此文档是否对你有帮助?
有帮助
去反馈
  • 请求信息
  • 请求 URI
  • 请求头参数
  • 请求查询参数
  • 请求示例
  • 响应信息
  • 响应参数
  • 响应体示例
  • 错误码
  • 相关接口