查询用户组成员列表

GET

/open-apis/contact/v3/group/{group_id}/member/simplelist

自建应用商店应用

通过该接口可查询某个用户组的成员(目前成员仅支持用户，未来会支持部门)列表，如果应用的通讯录权限范围是“全部员工”，则可查询企业内任何用户组的成员列表。如果应用的通讯录权限范围不是“全部员工”，则仅可查询通讯录权限范围中的用户组的成员列表，点击了解通讯录权限范围。

错误码

HTTP状态码	错误码	描述	排查建议
500	40003	internal error	内部错误，请提供 X-Request-Id向客服反馈。联系客服。
400	40011	page size is invalid	无效的分页参数
400	40012	page token is invalid error	page token无效。
400	42002	invalid group_id	用户组 ID 无效
400	41074	invalid member_type	无效的成员类型
400	41071	en_name length exceed 64 character	英文名长度超过64个字符
400	41072	nickname length exceed 64 character	别名长度超过64个字符
403	42009	no group authority	缺少用户组权限。应用的通讯录权限范围需包含该用户组或为“全部员工”，点击了解更多

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/contact/v3/group/g128187/member/simplelist' \
--header 'Authorization;'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "memberlist": [
            {
                "member_id": "u287xj12",
                "member_type": "user",
                "member_id_type": "user_id"
            }
        ],
        "page_token": "TDRRV9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiJDGexPw=",
        "has_more": true
    }
}

请求参数

Path 参数

group_id

string

必需

用户组ID 示例值："g128187"

示例值:

g128187

Query 参数

page_size

string

可选

分页大小示例值：50 默认值：50

示例值:

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值："AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw="

示例值:

AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=

member_id_type

string

可选

欲获取成员ID类型。当member_type =user时候，member_id_type表示user_id_type，枚举值为open_id, union_id, user_id 示例值："open_id" 可选值有： open_id：member_type =user时候，表示用户的open_id union_id：member_type =user时候，表示用户的union_id user_id：member_type =user时候，表示用户的user_id 默认值：open_id

示例值:

open_id

member_type

string

可选

期待获取的用户组成员的类型，取值为 user 示例值："user" 可选值有： user：user 默认值：user

示例值:

user

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

memberlist

array [object {3}]

成员列表

必需

page_token

string

必需

下次分页获取的page_token

has_more

boolean

是否还需要分页获取

必需

修改于 2023-01-12 07:14:07

移除用户组成员

批量移除用户组成员

查询用户组成员列表

错误码#

请求参数

返回响应

错误码