查询用户所属用户组

调用该接口查询指定用户所属的用户组列表。

Tip: x

注意事项

• 如果应用的通讯录权限范围设置为 全部员工，则通过本接口可查询到用户所属的全部用户组列表，否则，仅会查询到应用通讯录权限范围内该用户所属的用户组。了解应用通讯录权限范围，可参见权限范围资源介绍。

• 支持查询到普通用户组和动态用户组的信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/contact/v3/group/member_belong
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	contact:group:readonly 获取用户组信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
member_id	string	是	成员 ID。ID 类型与 member_id_type 取值保持一致。 示例值：u287xj12
member_id_type	string	否	成员 ID 类型。 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID。 - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？。 - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？。 默认值：open_id
group_type	int	否	用户组类型。 示例值：1 可选值有： - 1: 普通用户组 - 2: 动态用户组 数据校验规则： - 取值范围：1 ～ 2
page_size	int	否	分页大小，用于限制一次请求所返回的数据条目数。 示例值：500 默认值：500 数据校验规则： - 取值范围：1 ～ 1000
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ group_list	string\[\]	用户组 ID 列表。 说明：你可以调用查询指定用户组接口，通过用户组 ID 获取用户组的详细信息。
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "group_list": [
            "og-1455998e138698e1386"
        ],
        "page_token": "AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=",
        "has_more": false
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	40001	param error	参数错误。请检查输入参数是否设置有误，你可以参考接口文档内的参数描述，修复输入参数值。
500	40003	internal error	内部错误，你可以获取请求的 X-Request-Id，并联系技术支持。
400	40011	page size is invalid	page_size 无效。page_size 取值范围为 1 ~ 1000，请调整参数值后重试。
400	40012	page token is invalid	page_token 无效。你需要检查传入的 page_token 是否为上次请求返回的 page_token 值。
400	41071	invalid member_id_type	成员 ID 类型无效。member_id_type 的枚举值仅支持 open_id、union_id、user_id。
400	41073	invalid member_id	成员 ID 无效。你可以按以下步骤进行检查，并修改为正确的成员 ID 值。 1. 检查设置的 member_id_type 类型是否与传入的 member_id 类型一致。 2. 根据 member_id_type 参数描述，重新获取指定类型的成员 ID 值，并重试。
400	41074	invalid member_type	无效的成员类型。group_type 的枚举值仅支持 1 或 2。
403	41050	no user authority error	无用户权限。需将当前操作的用户添加到应用或用户的权限范围内。根据调用 API 的身份不同，解决方案也不同，具体说明如下： - 使用 tenant_access_token 调用 API 当前操作的用户需要添加在应用的通讯录权限范围内。通讯录权限范围定义了应用在调用通讯录 API 时可获取的部门、用户的数据范围。应用无法访问不在通讯录权限范围内的数据。 由开发者登录开发者后台，在应用详情页的 开发配置 > 权限管理 > 数据权限 页面内，配置 通讯录权限范围，添加指定用户。 已发布的应用企业管理员可在管理后台 > 工作台 > 应用管理 页面，修改应用的通讯录权限范围。 - 使用 user_access_token 调用 API 当你使用用户身份调用通讯录 API 时，可操作的权限范围不受应用的通讯录权限范围影响，而是受当前用户的组织架构可见范围影响，该范围限制了用户在企业内可见的组织架构数据范围。 由企业管理员在管理后台 > 安全 > 成员权限 页面中，点击 组织架构可见范围 进行管理。 完整介绍参见权限范围资源介绍。

更多错误码信息，参见通用错误码。