批量添加公共邮箱成员

一次请求可以给一个公共邮箱添加多个成员。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/public_mailboxes/:public_mailbox_id/members/batch_create
HTTP Method	POST
接口频率限制	20 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	mail:public_mailbox 查询、创建、修改公共邮箱
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
public_mailbox_id	string	The unique ID or email address of a public mailbox 示例值："xxxxxxxxxxxxxxx or test_public_mailbox@xxx.xx"

查询参数

名称	类型	必填	描述
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，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
items	public_mailbox.member\[\]	是	本次调用添加的公共邮箱成员列表 数据校验规则： - 长度范围：1 ～ 200
└ member_id	string	否	公共邮箱内成员唯一标识（在请求体中不用填） 示例值："xxxxxxxxxxxxxxx"
└ user_id	string	否	租户内用户的唯一标识（当成员类型是USER时有值） 示例值："xxxxxxxxxx"
└ type	string	否	成员类型 示例值："USER" 可选值有： - USER: 内部用户

请求体示例

{
    "items": [
        {
            "user_id": "xxxxxxxxxx",
            "type": "USER"
        }
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	public_mailbox.member\[\]	添加成功后的公共邮箱成员信息列表
└ member_id	string	公共邮箱内成员唯一标识（在请求体中不用填）
└ user_id	string	租户内用户的唯一标识（当成员类型是USER时有值）
└ type	string	成员类型 可选值有： - USER: 内部用户

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "member_id": "xxxxxxxxxxxxxxx",
                "user_id": "xxxxxxxxxx",
                "type": "USER"
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
404	1234016	public mailbox not found	请确认公共邮箱是否存在
400	1234008	request parameter error	请检查请求参数是否正确
400	1234027	some users have exceeded the limit on the number of bindable public mailboxes	请检查并去除绑定公共邮箱已达数量限制的用户