批量获取邮件组

GET

https://open.feishu.cn/open-apis/mail/v1/mailgroups

分页批量获取邮件组

错误码

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

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/mail/v1/mailgroups?manager_user_id=&user_id_type=&page_token=&page_size=' \
--header 'Authorization;'

响应示例

{
  "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"
      }
    ]
  }
}

请求参数

Query 参数

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，字段权限要求：

获取用户 user ID

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果

示例值："xxx"

page_size

integer

可选

分页大小

示例值：10

默认值：20

数据校验规则：

最大值：200

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

has_more

boolean

是否还有更多项

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

items

array [object {8}]

邮件组列表

必需

修改于 2023-02-02 08:44:09

查询指定邮件组

创建邮件组成员

批量获取邮件组

错误码#

请求参数

返回响应

错误码