分页查询标签下的在线成员列表

请求参数

Path 参数

room_id

integer

聊天室 ID。

必需

Query 参数

tag

string

必需

需要查询的目标标签。

offset

integer

必需

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

limit

integer

必需

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

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/room_members//actions/list_tag_members?tag&offset&limit' \
--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

必需

是否还有更多数据。

offset

integer

必需

下一页的分页标识符。

items

array [object {17}]

必需

示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "offset": 100,
        "has_more": false,
        "items": [
            {
                "extension": "",
                "member_level": 0,
                "account_id": "yx23",
                "room_nick": "yx23",
                "room_avatar": "http://w03d",
                "member_role": 1,
                "is_online": true,
                "enter_time": 1705302091747,
                "blocked": false,
                "chat_banned": false,
                "temp_chat_banned_time": 12322,
                "temp_chat_banned": false,
                "notify_target_tags": "{\"tag\": \"abc\"} and {\"tag\": \"def\"}",
                "tags": "[\"tag\"]",
                "online_info_list": [
                    {
                        "room_nick": "yx23",
                        "room_avatar": "http://wwww",
                        "enter_time": 1705302091747,
                        "client_type": 1
                    }
                ],
                "online_count": 1
            }
        ]
    }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误