文档反馈
文档反馈

查看指定推流任务详情

查看指定推流任务的详细信息,包括推流地址、布局参数设置、是否开启录制等。

URL

URL 中参数说明:

参数名称 类型 是否必选 示例 描述
cid int64 必选 6207760637435905 房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。
taskId String 必选 stream_1 自定义的推流任务ID。请保证此ID唯一。

请求参数

该 API 的 body 中无需指定任何请求参数。

返回参数

参数名称 类型 示例 描述
code int 200 状态码。
errmsg String invalid params 错误详情。仅在状态码为 200 以外的其他状态中返回。errmsg 仅供参考,请勿基于 errmsg 实现业务逻辑。
status String active 推流任务状态。
  • deleted:已删除。
  • active:运行中。
rtmpTasks JSON - 推流任务详情。详细参数说明请参考 rtmpTasks

示例

请求示例

https://logic-dev.netease.im/v2/api/rooms/6207760637435905/task/stream_1

正常返回示例

{   
    "code" : 200,                       
    "status" : "active",                 
    "rtmpTask": {
         "taskId": "stream_1",            
         "streamUrl": "rtmp://test.url", 
         "layout": {...},                
         "record": true,                  
         "version": 1                     
    }
}

错误码

该接口在 HTTP Body 中返回错误码,错误码列表请参考业务错误码

×

反馈成功

非常感谢您的反馈,我们会继续努力做得更好。