logo
实时音视频
服务端 API
当前页

获取简易流列表


描述

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

接口原型

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

请求参数

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

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

请求示例

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

响应参数

参数类型描述
CodeInt32返回码。
MessageString操作结果描述。
RequestIdString请求 ID。
DataObject响应数据。
└ StreamListArray of Object流列表。
  └ StreamIdString流 ID。
  └ UserIdString用户名。
  └ UserNameString用户昵称。
  └ CreateTimeInt64创建时间。
  └ StreamNumberIdUInt32房间内流序号。

响应示例

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

返回码

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

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

Previous

删除房间流

Next

关闭房间