查询公共邮箱基础信息

用于进行公共邮箱的基本信息查看

请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/mail/v1/public_mailboxes/:public_mailbox_id
HTTP Method	GET
支持的应用类型	自建应用
权限要求	[邮箱]-[创建/更改/查询公共邮箱]

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"

路径参数（url中冒号标识的参数,如":xxxx"请连同:整体替换成对应值）

名称	类型	描述
public_mailbox_id	string	公共邮箱地址，需要带上邮箱后缀 邮箱地址格式错误/不为公共邮箱会报错

查询参数（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

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
∟email	string	邮箱地址
∟name	string	邮箱名称
∟type	int	邮箱类型 0：项目 1：系统
∟principal_user_id	string	负责人user_id
∟explain	string	邮箱说明
trace_id	string	链路id

响应体示例

{
  "code": 0,
  "traceId": "_Ao59UOIBLPCeAAu",
  "success": true,
  "data": {
    "email": "cese01@kanzhun.com",
    "name": "测试公共邮箱",
    "type": 1,
    "principal_user_id": "wh01@kanzhun.com",
    "explain": "测试公共邮箱的说明"
  },
  "msg": "操作成功"
}

如果响应非成功状态，请对照 错误码文档