Skip to content

获取目录列表

标签邮箱目录

请求说明

字段
请求地址
https://openapi.wps.cn/v7/mailboxes/{mailbox_id}/folders
HTTP 方法
GET
接口描述
获取指定邮箱的所有目录
签名方式
KSO-1
限频策略
权限要求
查询和管理邮箱信息(用户授权) kso.mailbox.readwrite
查询邮箱信息(用户授权) kso.mailbox.read

路径参数 (Path)

属性名类型是否必填描述可选值
mailbox_id
string-

查询参数 (Query)

属性名类型是否必填描述可选值
page_size
integer分页大小,默认取10-
page_token
string翻页token,首次无需提供-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "data": {
    "items": [
      {
        "display_name": "string",
        "folder_id": "string",
        "level": 0,
        "parent_folder_id": "string",
        "total_message_count": 0,
        "unread_message_count": 0
      }
    ],
    "next_page_token": "string"
  },
  "code": 0,
  "msg": "string"
}