批量获取邮件组

分页批量获取邮件组

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/mailgroups
HTTP Method	GET
接口频率限制	特殊频控
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	mail:mailgroup 查询、创建、修改、删除邮件组 mail:mailgroup:readonly 查询邮件组
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称	类型	必填	描述
manager_user_id	string	否	邮件组管理员用户ID，用于获取该用户有管理权限的邮件组 示例值：ou_xxxxxx
user_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 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：xxx
page_size	int	否	分页大小 示例值：10 默认值：20 数据校验规则： - 最大值：200

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ has_more	boolean	是否还有更多项
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ items	mailgroup\[\]	邮件组列表
└ mailgroup_id	string	邮件组ID
└ email	string	邮件组地址
└ name	string	邮件组名称
└ description	string	邮件组描述
└ direct_members_count	string	邮件组成员数量
└ include_external_member	boolean	是否包含外部成员
└ include_all_company_member	boolean	是否是全员邮件组
└ who_can_send_mail	string	谁可发送邮件到此邮件组 可选值有： - ANYONE: 任何人 - ALL_INTERNAL_USERS: 仅组织内部成员 - ALL_GROUP_MEMBERS: 仅邮件组成员 - CUSTOM_MEMBERS: 自定义成员

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "has_more": true,
        "page_token": "xxx",
        "items": [
            {
                "mailgroup_id": "xxxxxxxxxxxxxxx",
                "email": "test_mail_group@xxx.xx",
                "name": "test mail group",
                "description": "mail group for testing",
                "direct_members_count": "10",
                "include_external_member": true,
                "include_all_company_member": false,
                "who_can_send_mail": "ALL_INTERNAL_USERS"
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
503	1235003	Service unavailable	请稍后重试