分页查询聊天室在线成员列表

请求参数

Path 参数

room_id

string

聊天室 ID。

必需

示例值:

1602801663

Query 参数

member_roles

string

可选

需要查询的聊天室成员类型。0：普通用户；1：创建者；2：管理员；3：普通游客；4：匿名游客

示例值:

0,1,2,3,4

offset

string

必需

查询的偏移量，首次查询传入 0，后续查询传入上一次查询结果中的 offset。

示例值:

0

limit

string

必需

每页返回的成员数上限，最大为 100。小于等于 0，或者大于 100，会报 414 错误。

示例值:

100

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://open.yunxinapi.com/im/v2/chatrooms/1602801663/actions/list_online_members?offset=0&limit=100' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

has_more

boolean

必需

items

array [object {17}]

必需

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "has_more": false,
    "items": [
      {
        "extension": "在线的ext",
        "member_level": 0,
        "account_id": "qa2test1",
        "room_nick": "qa2test1",
        "room_avatar": "http://b12026.nos.netease.com/MTAxMTAxMA==/bmltYV8xNDMwMzVfMTQ0NzIwOTc4MTgyM18xMGY4YmMzYS1jOWI2LTQ0MjctYmZjNC1iMmY3NzdlODY2ZDI=",
        "member_role": 1,
        "is_online": true,
        "enter_time": 1709175942428,
        "blocked": false,
        "chat_banned": false,
        "temp_chat_banned": false,
        "online_info_list": [
          {
            "robot": false,
            "room_nick": "qa2test1",
            "room_avatar": "http://b12026.nos.netease.com/MTAxMTAxMA==/bmltYV8xNDMwMzVfMTQ0NzIwOTc4MTgyM18xMGY4YmMzYS1jOWI2LTQ0MjctYmZjNC1iMmY3NzdlODY2ZDI=",
            "enter_time": 1709175942428,
            "client_type": 1
          }
        ],
        "online_count": 1
      }
    ]
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误