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

URL

• 请求方法：GET

• URL：

  网易云信为该功能提供以下两个 API 请求地址，使用 V2 地址需在 URL 中指定 cid 和 taskId，使用 V3 地址需在 URL 中指定 cname 和 taskId，您可以根据业务需求调用任一接口。

  • https://logic-dev.netease.im/v2/api/rooms/{cid}/task/{taskId}
  • https://logic-dev.netease.im/v3/api/rooms/task?cname={cname}&taskId={taskId}

URL 中参数说明：

参数名称	类型	示例	描述
cid	int64	6207760637435905	房间 ID。该 ID 为创建房间接口调用成功后返回的房间 ID。 仅在调用 V2 接口时需要设置。
cname	String	abc	房间名称。 仅在调用 V3 接口时需要设置。
taskId	String	stream_1	自定义的推流任务 ID。请保证此 ID 唯一。 在 V2 和 V3 接口中均需要设置。

接口请求频率

默认上限为 50 次/秒，若请求频率超出限制，可能会返回 429 错误码。
若您需要上调上限，请参考如何处理调用服务端 RESTful API 超出频率限制。

请求参数

• 请求中 Header 的设置请参考请求结构描述。

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

返回参数

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

示例

请求示例

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                     
    }
}

错误码

• header 中的状态码：

  状态码列表请参考 header 中的 HTTP 状态码。

• body 中的错误码（code）

  该接口在 HTTP Body 中返回错误码（code），错误码列表请参考业务错误码。