实时音视频 SparkRTC-查询用户列表:响应参数

时间:2023-11-01 16:16:40

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求的唯一标识

表5 响应Body参数

参数

参数类型

描述

total

Integer

总数

limit

Integer

查询结果限制

offset

Integer

查询偏移量

users

Array of RtcUser objects

用户列表

表6 RtcUser

参数

参数类型

描述

domain

String

域名

app

String

应用标识

room_id

String

房间ID

uid

String

用户id

session

String

会话id

state

String

用户状态

  • FAIL: 加入失败

  • ONLINE:在线

  • OFFLINE:离开

nick_name

String

用户昵称

ip

String

用户接入IP

region

String

用户接入IP所在省份

isp

String

用户接入IP所在运营商

device_model

String

用户设备型号

platform

String

用户设备平台

sdk

String

用户sdk版本

join_time

String

用户加入房间时间。格式为:YYYY-MM-DDThh:mm:ssZ

leave_time

String

用户离开房间时间。格式为:YYYY-MM-DDThh:mm:ssZ,若用户未离开,则返回 “-”

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

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