Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

获取邮箱信息

获取指定邮箱的邮箱信息(当前仅支持公共邮箱)

请求说明

请求地址https://openapi.wps.cn/v7/mailboxes/{mailbox_id}
请求方法GET
签名方式KSO-1
权限要求查询和管理邮箱信息(用户授权) kso.mailbox.readwrite
查询邮箱信息(用户授权) kso.mailbox.read

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
mailbox_idstring邮箱 id

请求地址示例

[GET] https://openapi.wps.cn/v7/mailboxes/{mailbox_id}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ addressstring地址,形如:user_name@domain
∟ idstringid
∟ is_primaryboolean是否主邮箱
∟ is_sharedboolean是否公共邮箱
∟ namestring名字
∟ ownerobject邮箱负责人
∟ ∟ avatarstring用户的头像链接
∟ ∟ email_addressstring用户的邮箱地址
∟ ∟ namestring名字。创建,更新公共邮箱时无需提供
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "address": "string",
    "id": "string",
    "is_primary": false,
    "is_shared": false,
    "name": "string",
    "owner": {
      "avatar": "string",
      "email_address": "string",
      "name": "string"
    }
  },
  "msg": "string"
}
回到旧版