获取邮件组权限成员

获取邮件组单个权限成员信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/mailgroups/:mailgroup_id/permission_members/:permission_member_id
HTTP Method	GET
接口频率限制	特殊频控
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	mail:mailgroup 查询、创建、修改、删除邮件组 mail:mailgroup:readonly 查询邮件组
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

路径参数

名称	类型	描述
mailgroup_id	string	邮件组ID或者邮件组地址 示例值："xxxxxxxxxxxxxxx 或 test_mail_group@xxx.xx"
permission_member_id	string	权限组内成员唯一标识 示例值："xxxxxxxxxxxxxxx"

查询参数

名称	类型	必填	描述
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
department_id_type	string	否	此次调用中使用的部门ID的类型 示例值：open_department_id 可选值有： - department_id: 以自定义department_id来标识部门 - open_department_id: 以open_department_id来标识部门

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	mailgroup.permission_member	-
└ permission_member_id	string	权限组内成员唯一标识（在请求体中不用填）
└ user_id	string	租户内用户的唯一标识（当成员类型是USER时有值）
└ department_id	string	租户内部门的唯一标识（当成员类型是DEPARTMENT时有值）
└ email	string	成员邮箱地址（当成员类型是MAIL_GROUP/PUBLIC_MAILBOX时有值）
└ type	string	成员类型 可选值有： - USER: 内部用户 - DEPARTMENT: 部门 - MAIL_GROUP: 邮件组 - PUBLIC_MAILBOX: 公共邮箱

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "permission_member_id": "xxxxxxxxxxxxxxx",
        "user_id": "xxxxxxxxxx",
        "department_id": "xxxxxxxxxx",
        "email": "xxx@xx.x",
        "type": "USER"
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
404	1234013	mail group not found	请确认邮件组是否存在
404	1234015	mail group permission member not found	请确认邮件组权限成员是否存在