列出邮箱联系人

列出邮箱联系人列表

Tip: 使用 tenant_access_token 时，需要申请邮箱联系人资源的数据权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/mail/v1/user_mailboxes/:user_mailbox_id/mail_contacts
HTTP Method	GET
接口频率限制	20 次/分钟
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	mail:user_mailbox.mail_contact:read 查看邮箱联系人 mail:user_mailbox.mail_contact:write 查看、创建、更新、删除邮箱联系人
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 mail:user_mailbox.mail_contact.mail_address:read 读取邮箱联系人邮箱地址字段 mail:user_mailbox.mail_contact.phone:read 读取邮箱联系人手机号字段

请求头

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

路径参数

名称	类型	描述
user_mailbox_id	string	用户邮箱地址 或 输入me代表当前调用接口用户 示例值："user@xxx.xx 或 me"

查询参数

名称	类型	必填	描述
page_size	int	是	分页大小 示例值：20 数据校验规则： - 取值范围：1 ～ 20
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：xxx

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ items	mail_contact\[\]	邮件联系人列表
└ id	string	联系人 id
└ name	string	联系人姓名
└ company	string	联系人公司
└ phone	string	联系人手机号 字段权限要求： mail:user_mailbox.mail_contact.phone:read 读取邮箱联系人手机号字段
└ mail_address	string	联系人邮箱 字段权限要求： mail:user_mailbox.mail_contact.mail_address:read 读取邮箱联系人邮箱地址字段
└ tag	string	联系人标签
└ remark	string	联系人备注
└ avatar	string	联系人头像
└ position	string	联系人职位
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
└ has_more	boolean	是否还有更多项

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "id": "7256274576546463764",
                "name": "张三",
                "company": "张三科技有限公司",
                "phone": "19912341234",
                "mail_address": "zhangsan@example.com",
                "tag": "朋友",
                "remark": "飞书发布会认识",
                "avatar": "https://exampleimg.com/xxxx.jpg",
                "position": "CEO"
            }
        ],
        "page_token": "xxx",
        "has_more": true
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1230001	参数错误	修改参数后重试
403	1230002	内部错误	请稍后重试
500	1230003	无权限	成为公共邮箱成员或申请相关数据权限后调用该接口