# 查询邮件组基础信息

用于对邮件组的基础信息进行查询

# 请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/mail/v1/mailgroups/:email
HTTP Method	GET
支持的应用类型	自建应用
权限要求	[邮箱]-[创建/更改/查询邮件组]

# 请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer `access_token`" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type	string	是	固定值："application/json; charset=utf-8"

# 路径参数（url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值）

名称	类型	描述
email	string	邮件组地址 zenglinhong@kanzhun.com，需要带上邮箱后缀，邮箱地址格式错误会报错

# 查询参数（url后?&拼接的参数）

名称	类型	描述
user_id_type	string	控制响应体内返回的用户 ID 的类型示例值："open_id" 可选值有： open_id：用户的 open id union_id：用户的 union id user_id：用户的 user id 默认值：open_id 当值为 user_id时，存在字段权限要求，未开通则会调用失败：请参见[应用权限管理]-[通讯录]- [获取用户ID]

# 响应

# 响应体

{
  "code": "0",
  "traceId": "",
  "data": [
    {
      "name": "邮件组名称", //示例值
      "who_can_send_mail": 1, //示例值
      "manager_user_id": "qwerasdf", //示例值
      "description": "邮件组描述" //示例值
    }
  ],
  "msg": "操作成功"
}

1
2
3
4
5
6
7
8
9
10
11
12
13

data内对象结构

名称	类型	描述
name	string	邮件组名称
who_can_send_mail	int	权限范围 1.全部 2.仅内部 3.部分成员 4.邮件组内成员
manager_user_id	string	邮件组管理员user_id，根据入参指定的user_id_type返回
description	string	邮件组说明

如果响应非成功状态，请对照错误码文档

← 停用邮件组编辑邮件组基础信息 →