logo
实时音视频
服务端 API
场景服务接口
当前页

DescribeUserList

GET

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

调用本接口获取房间内用户列表。

调用频率限制
同一个 AppID 下所有房间:200 次/秒; 单个房间:1 次/1秒

Request

Query Parameters

    Action stringrequired

    Possible values: [DescribeUserList]

    接口原型参数

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

    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。房间不存在会返回空列表。

    Mode int32

    Possible values: [0, 1]

    Default value: 0

    用户登录房间的时间排序,默认值为 0。0:按时间正序 1:按时间倒序

    Limit int32

    Possible values: <= 200

    Default value: 200

    单次请求返回的用户个数,取值范围 0-200,即调用本接口一次最多返回 200 个用户。房间内人数超过 200 时,需要根据前一次调用本接口时、返回结果中的 Marker(用户起始位标识)取值,再次调用本接口查询其余用户。

    例如,房间内有 450 个用户,调用本接口查询用户列表时:

    • (1) 第一次调用本接口,入参 Marker 传空,查询第 1 ~ 200 的用户;返回结果中 Marker 值假设为 “marker1”。
    • (2) 第二次调用本接口,入参 Marker 取值为 “marker1”,查询第 201 ~ 400 的用户;返回结果中 Marker 值假设为 “marker2”。
    • (3) 第三次调用本接口,入参 Marker 取值为 “marker2”,查询第 401 ~ 450 的用户;查询完毕,返回结果中 Marker 为空。
    Marker string

    查询用户起始位标识,每次请求的响应有返回,为空时从头开始返回用户信息。

Responses

操作成功
Schema
    Code int32

    返回码。请参考 全局返回码

    Message string

    操作结果描述。

    RequestId string

    请求 ID。

    Data object
    Marker string

    用户起始位标识。

    UserList object[]
    用户列表。
  • Array[
  • UserId string

    用户名。

    UserName string

    用户昵称。

    UserRole uint32

    用户角色。

    • 1:主播。
    • 2:观众。
    • 4:管理员,该类型用户主要存在于云录制、音视频流审核等场景中,客户端 SDK 的用户相关接口会过滤该类型用户。

    该返回参数,仅在接入 LiveRoom 服务时有实际意义,接入 Express 服务时请忽略此参数。

  • ]

Request
Collapse all
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
query
query
query
query
RESPONSEClear

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

Previous

查询用户状态

Next

增加房间流

当前页

返回到顶部