实时音视频

服务端 API

API 概览

快速开始

调用方式

在线调试服务端 API

全局返回码

房间信令接口

混流转码接口

媒体服务接口

媒体文件接口

音视频流审核接口

场景服务接口

使用 Postman 调试

DescribeSimpleStreamList

GET

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

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

调用频率限制

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

Request

Query Parameters

Action string必填

可选值: [DescribeSimpleStreamList]

接口原型参数

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

AppId uint32必填

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

SignatureNonce string必填

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

Timestamp int64必填

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

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

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

RoomId string必填

房间 ID。

Responses

操作成功

application/json

数据结构
按数据结构生成的示例

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

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。

当前页

Request

返回到顶部

DescribeSimpleStreamList

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

Request

Query Parameters

Responses​

Responses