获取分组内成员 (POST)

请求参数

Header 参数

Authorization

string

必需

认证Token，例如：Bearer YOUR_TOKEN

示例值:

Bearer YOUR_TOKEN

Content-Type

string

请求体的内容类型

必需

示例值:

application/json

Body 参数application/json

action

string

动作名称

必需

示例值:

get_group_members

params

object

GetGroupMembersParams

必需

get_group_members 动作的参数。group_id 或 group_name 必须提供一个。

group_id

string

可选

目标分组ID (可选)

示例值:

group_id_for_members

group_name

string

可选

目标分组名称 (可选，如果 group_id 未提供)

示例值:

分组名查成员

echo

string

原样返回字段

可选

示例值:

request_echo_123

示例

{
    "action": "get_group_members",
    "params": {
        "group_id": "grp_friends"
    },
    "echo": "echo_get_members_post"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://127.0.0.1:10614/get_group_members' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "get_group_members",
    "params": {
        "group_id": "grp_friends"
    },
    "echo": "echo_get_members_post"
}'

返回响应

🟢200操作结果

application/json

Body

status

enum<string>

执行状态

必需

枚举值:

okfailed

示例值:

ok

retcode

integer <int64>

必需

返回码 (0 为成功, 其他为错误码，具体定义见 oneboterr 包)

示例值:

0

message

string

可选

错误信息 (仅在 status 为 'failed' 时有效)

示例值:

参数无效

echo

string

可选

原样返回的 echo 字段

示例值:

request_echo_123

data

array[object (Member) {2}]

可选

id

string

必需

成员ID (wxid 或 room_id)

示例值:

wxid_testuser

type

enum<string>

MemberType

必需

成员类型 ('user' 表示用户, 'group' 表示群组)

枚举值:

usergroup

示例值:

user

示例

{
    "status": "ok",
    "retcode": 0,
    "data": [
        {
            "id": "wxid_user1",
            "type": "user"
        },
        {
            "id": "12345@chatroom",
            "type": "group"
        }
    ],
    "echo": "echo_get_members_post"
}