HTTP/HTTPS
请求协议
APIUSB / 平台接口 / 获取全部分类目录
获取全部分类目录
接口地址：https://api.apiusb.com/api/platform?s=Platform.Email.FolderList
接口描述： 获取全部分类目录
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| access_token | 字符串 | 可选 | 访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口 |
返回字段
| 返回结果 | 类型 | 说明 |
|---|---|---|
| ret | 整型 | 状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误 |
| data | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| data.items[] | 对象 | 分类目录信息 |
| data.items[].id | 整型 | 分类目录 |
| data.items[].folder_id | 整型 | 统一编码10 Inbox, 20Sent, 30Drafts，40Spam，90Trash,100 开始,是用户自建目录 |
| data.items[].uuid | str | 用户uuid |
| data.items[].depid | 整型 | 部门ID |
| data.items[].title | str | 分类目录名称 |
| data.items[].credits | str | 处理后获得的积分 |
| data.items[].icon | str | 图标 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 |
客户端请求示例
{
"ret": 200,
"data": {
"items": [
{
"id": 1,
"folder_id": 10,
"type_id": 0,
"uuid": "",
"depid": 0,
"title": "Inbox",
"icon": "fa-comment-alt-dots",
"credits": 0,
"sortnum": 1,
"update_time": "2020-06-29 06:11:20",
"add_time": "2020-06-29 06:11:20"
},
{
"id": 2,
"folder_id": 20,
"type_id": 0,
"uuid": "",
"depid": 0,
"title": "Sent",
"icon": "fa-ambulance",
"credits": 0,
"sortnum": 2,
"update_time": "2020-06-29 06:11:20",
"add_time": "2020-06-29 06:11:20"
},
{
"id": 3,
"folder_id": 30,
"type_id": 0,
"uuid": "",
"depid": 0,
"title": "Drafts",
"icon": "fa-bug",
"credits": 0,
"sortnum": 3,
"update_time": "2020-06-29 06:11:20",
"add_time": "2020-06-29 06:11:20"
},
{
"id": 4,
"folder_id": 40,
"type_id": 0,
"uuid": "",
"depid": 0,
"title": "Spam",
"icon": "fa-bug",
"credits": 0,
"sortnum": 3,
"update_time": "2020-06-29 06:11:20",
"add_time": "2020-06-29 06:11:20"
},
{
"id": 5,
"folder_id": 90,
"type_id": 0,
"uuid": "",
"depid": 0,
"title": "Trash",
"icon": "fa-bug",
"credits": 0,
"sortnum": 3,
"update_time": "2020-06-29 06:11:20",
"add_time": "2020-06-29 06:11:20"
},
{
"id": 6,
"folder_id": 100,
"type_id": 1,
"uuid": "",
"depid": 0,
"title": "自定义目录1",
"icon": "fa-bug",
"credits": 0,
"sortnum": 3,
"update_time": "2020-06-29 06:11:20",
"add_time": "2020-06-29 06:11:20"
},
{
"id": 7,
"folder_id": 102,
"type_id": 1,
"uuid": "",
"depid": 0,
"title": "自定义目录2",
"icon": "fa-bug",
"credits": 0,
"sortnum": 3,
"update_time": "2020-06-29 06:11:20",
"add_time": "2020-06-29 06:11:20"
},
{
"id": 8,
"folder_id": 100,
"type_id": 1,
"uuid": "rOCQh6L3Uic0IqqfeGwIazYTVT673mfu",
"depid": 1,
"title": "123",
"icon": "1",
"credits": 0,
"sortnum": 1,
"update_time": "2020-07-17 17:19:17",
"add_time": "2020-07-17 17:19:17"
}
]
},
"msg": ""
}错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-04-18 11:17:49