新增邮件组

用于进行邮件组的创建

请求

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

请求头

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

查询参数（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]

请求体

名称	类型	必填	描述
email	string	是	邮件组地址，邮箱地址格式错误会报错 示例值："mail_group@xxx.xx"
name	string	是	邮件组名称 示例值："mail name"
who_can_send_mail	int	是	发件范围 1.全部 2.仅内部 3.部分成员 4.邮件组内成员
scope_user_id_list	string[]	否	发件范围user_id_list 发件范围为3时生效，当有部分使用人不存在时，仅会添加存在的用户，当一个user_id填写错误时，接口会整体报错添加失败
scope_email_list	string[]	否	发件范围user_id_list 发件范围为3时生效，当有部分使用人不存在时，仅会添加存在的用户；可以添加公共邮箱和个人邮箱；当一个email填写错误时，接口整体报错添加失败；与发件范围scope_user_id_list 只能选填一个，两个都填时报错
member_user_id_list	string[]	否	邮件组成员user_id_list 当有部分使用人不存在时，仅会添加存在的用户，当一个user_id填写错误时，接口整体报错添加失败
member_email_list	string[]	否	邮件组成员user_id_list 当有部分使用人不存在时，仅会添加存在的用户；可以添加公共邮箱和个人邮箱；当一个email填写错误时，接口整体报错添加失败；与邮件组范围user_id_list 只能选填一个，两个都填时报错
manager_user_id	string	是	邮件组管理员user_id
description	string	是	邮件组描述 示例值："mail description"

请求体示例

{
  "email": "xxx@xxx.com",
  "name": "xxx",
  "who_can_send_mail": 3,
  "scope_user_id_list": ["qwerty","ytrewq"],
  "scope_email_list": ["xxx@xxx.com","xxx2@xxx.com"],
  "member_user_id_list": ["qwerty","ytrewq"],
  "member_email_list": ["xxx@xxx.com","xxx2@xxx.com"],
  "manager_user_id": "qwerty",
  "description": "xxx"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	调用描述
success	boolean	调用是否成功
data	object
∟invalid_user_ids	string[]	不合法的 user_id 列表
∟invalid_emails	string[]	不合法的邮箱地址
trace_id	string	链路id

响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "success": true,
  "data": {
    "invalid_user_ids":["qweras"],
    "invalid_emails":["xxx@xxx.xx"]
  },
  "msg": "操作成功"
}

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