查询指定邮件组

获取特定邮件组信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/mailgroups/:mailgroup_id
HTTP Method	GET
接口频率限制	特殊频控
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	mail:mailgroup 查询、创建、修改、删除邮件组 mail:mailgroup:readonly 查询邮件组

请求头

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

路径参数

名称	类型	描述
mailgroup_id	string	邮件组ID或者邮件组地址 示例值："xxxxxxxxxxxxxxx 或 test_mail_group@xxx.xx"

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	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": {
        "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状态码	错误码	描述	排查建议
404	1234013	mail group not found	请确认邮件组是否存在