# 查询邮件组成员

用于对邮件组的成员进行查询

# 请求

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

# 请求头

名称 类型 必填 描述
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]
page_token string 分页标记 第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token
page_size int 分页大小 默认20 可填写1-100个/页
page_num int 指定第几页进行查询

# 请求体

名称 类型 必填 描述
email_query string 否 邮箱地址查询条件 不传时查询所有人，传入后模糊匹配
name_query string 否 邮箱名称查询条件 不传时查询所有人，传入后模糊匹配

# 请求体示例

{
  "email_query": "xxx",
  "name_query": "xxx"
}
1
2
3
4

# 响应

# 响应体

{
  "code": "0",
  "traceId": "",
  "data": {
      "has_more": true, //示例值
      "page_token": "qwerasdfzxcv", //示例值
      "page_num": 1, //示例值
      "page_size": 20, //示例值
      "total": 100, //示例值
      "items": [{
          "name": "xxx",
          "email": "xxx@example.com",
          "type": 2,
          "user_id": "qwert",
          "public_mail_type": 1
      }]
  },
  "msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

data内对象结构

名称 类型 描述
has_more boolean 是否还有更多项
page_token string 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
page_num int 当前所在的页码
total int 总匹配的记录条数
items array 邮件组成员列表
 ∟name string 邮箱名称
 ∟email string 邮箱地址
 ∟type int 成员类型 1.公共邮箱 2.个人邮箱
 ∟user_id string user_id 当前租户内用户的唯一标识 当成员类型是2时有值
 ∟public_mail_type int 公邮类型 当成员类型是1时有值 0.系统 1.项目

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

最后更新于 : 3/4/2024, 3:29:16 PM

← 新增邮件组成员 →