实时音视频 SPARKRTC-查询用户列表:URI

时间:2024-10-18 15:28:09

URI

GET /v1/{project_id}/rtc/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

app

String

应用id

room_id

String

房间id

uid

String

用户id

nickname

String

用户昵称

region

Array

用户省份,支持省份名或缩写,如广东或者GD

isp

Array

用户接入运营商

state

Array

用户状态,取值如下:

  • FAIL:加入失败

  • ONLINE:在线

  • OFFLINE:离开

start_time

String

查询起始时间。UTC时间,格式:YYYY-MM-DDThh:mm:ssZ,如2020-04-23T06:00:00Z,不写默认读取过去1小时数据数据。

end_time

String

查询结束时间。UTC时间,格式:YYYY-MM-DDThh:mm:ssZ,如2020-04-23T06:00:00Z,不写默认为当前时间。

limit

Integer

查询结果限制

offset

Integer

查询偏移量

type

String

查询模式,取值如下:

  • detail:会话级

  • summary:用户级(默认)

support.huaweicloud.com/api-rtc/ListRtcUserList.html