文档中心
服务端 API v2
房间信令接口
获取简易流列表

获取简易流列表

更新时间：2023-07-12 22:00

1 描述

调用本接口获取房间内流列表信息。获取流列表后与业务后台流列表进行对比，可以防止“炸麦”。也可以通过此接口获取房间内唯一流 ID，在使用第三方拉流器时进行混流音浪回调。

2 接口原型

请求方法：GET
请求地址：https://rtc-api.zego.im/?Action=DescribeSimpleStreamList
传输协议：HTTPS
调用频率限制：
- 单个房间：1 次/10秒
- 同一个 AppID 下所有房间：50 次/秒

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式中的 “2.1 公共请求参数”。

参数	类型	是否必选	描述
RoomId	String	是	房间 ID。

4 请求示例

https://rtc-api.zego.im/?Action=DescribeSimpleStreamList
&RoomId=room1
&<公共请求参数>

5 响应参数

参数	类型	描述
Code	Int32	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。
Data	Object	响应数据。
└ StreamList	Array of Object	流列表。
└ StreamId	String	流 ID。
└ UserId	String	用户名。
└ UserName	String	用户昵称。
└ CreateTime	Int64	创建时间。
└ StreamNumberId	UInt32	房间内流序号。

6 响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "5885338326725063742",
    "Data": {
        "StreamList": [{
          "StreamId": "stream_demo",
          "UserId": "user_demo",
          "UserName": "user_name_demo",
          "CreateTime": 1642045110123,
          "StreamNumberId": 10
        }]
    }
}

7 返回码

以下仅列出了常见的接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
154	获取列表信息失败。	请重试，或联系 ZEGO 技术支持处理。

服务端API

获取简易流列表

1 描述

2 接口原型

3 请求参数

4 请求示例

5 响应参数

6 响应示例

7 返回码