DescribeSimpleStreamList

GET

https://rtc-api.zego.im/

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

调用频率限制

同一个 AppID 下所有房间：50 次/秒; 单个房间：1 次/10秒

Request

Query Parameters

Action stringrequired

Possible values: [DescribeSimpleStreamList]

接口原型参数

https://rtc-api.zego.im?Action=DescribeSimpleStreamList

AppId uint32required

💡公共参数。AppId，ZEGO 分配的用户唯一凭证。

SignatureNonce stringrequired

💡公共参数。随机字符串。

Timestamp int64required

💡公共参数。Unix 时间戳，单位为秒。最多允许 10 分钟的误差。

Signature stringrequired

💡公共参数。签名，用于验证请求的合法性。

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡公共参数。签名版本号。

IsTest string

Possible values: [true, false]

Default value: false

💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。

RoomId stringrequired

房间 ID。

Responses

操作成功

application/json

Schema
Example (from schema)

Schema

Code int32

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

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

Message string

操作结果描述。

RequestId string

请求 ID。

Data object

StreamList object[]

流列表。

Array[

StreamId string

流 ID。

UserId string

用户名。

UserName string

用户昵称。

CreateTime int64

创建时间。

StreamNumberId uint32

房间内流序号。

]

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

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

CURL

RESPONSEClear

Click the "Send" button above and see the response here!

DescribeSimpleStreamList

https://rtc-api.zego.im/

Request

Query Parameters

Responses​

Responses