# 查询用户管理的公共邮箱
通过接口查询用户管理的公共邮箱
# 请求
基本 | |
---|---|
HTTP URL | https://hi-gw.weizhipin.com/open-apis/mail/v1/public_mailboxes/user/:user_id/managed |
HTTP Method | GET |
支持的应用类型 | 自建应用 |
权限要求 | [邮箱]-[创建/更改/查询公共邮箱] |
# 请求头
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token "示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" |
# 路径参数(url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值)
名称 | 类型 | 描述 |
---|---|---|
user_id | string | 用户ID,需要与查询参数中的user_id_type类型保持一致。 示例值:"ou_7dab8a3d3cdcc9da365777c7ad535d62" |
# 查询参数(url后?&拼接的参数)
名称 | 类型 | 描述 |
---|---|---|
user_id_type | string | 用户 ID 类型示例值:"open_id" 可选值有: open_id:用户的 open id union_id:用户的 union id user_id:用户的 user id 默认值:open_id 当值为 user_id,字段权限要求: 获取用户 user ID |
page_token | string | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token |
page_size | int | 分页参数 当前页展示数量,默认每页查询20条,每次不超过100条 |
page_num | int | 分页页数 |
# 响应
# 响应体
名称 | 类型 | 描述 |
---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
trace_id | string | 链路id |
data | - | - |
∟page_size | int | 分页大小 |
∟page_num | int | 分页页数 |
∟page_token | string | 分页标记 |
∟total | int | 总计 |
∟has_more | boolean | 是否还有更多项 |
∟items | list | 分页数据 |
∟ ∟name | string | 邮箱名称 |
string | 邮箱地址 | |
∟ ∟type | int | 邮箱类型 0:项目 1:系统 |
∟ ∟explain | string | 邮箱说明 |
# 响应体示例
{
"code": "0",
"traceId": "12313asd",
"data": {
"items": [{
"name": "邮箱名称",
"email": "wh01@kanzhun.com",
"explain": "邮箱说明",
"type": 1
}],
"has_more": true,
"page_size" : 1,
"page_num" : 20,
"total": 100,
"page_token": "wertsdfgxvb"
},
"msg": "操作成功"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
如果响应非成功状态,请对照 错误码文档
← 重置公共邮箱密码 查询用户所在的公共邮箱 →