diff --git a/src/.vuepress/public/favicon.ico b/src/.vuepress/public/favicon.ico index b411f79d..6f13c69b 100644 Binary files a/src/.vuepress/public/favicon.ico and b/src/.vuepress/public/favicon.ico differ diff --git a/src/.vuepress/public/logo.png b/src/.vuepress/public/logo.png deleted file mode 100644 index ccd732e1..00000000 Binary files a/src/.vuepress/public/logo.png and /dev/null differ diff --git a/src/.vuepress/public/logo.svg b/src/.vuepress/public/logo.svg deleted file mode 100644 index 364d184e..00000000 --- a/src/.vuepress/public/logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/src/.vuepress/public/logo.webp b/src/.vuepress/public/logo.webp new file mode 100644 index 00000000..6f13c69b Binary files /dev/null and b/src/.vuepress/public/logo.webp differ diff --git a/src/.vuepress/theme.ts b/src/.vuepress/theme.ts index a8da709a..4ae158c5 100644 --- a/src/.vuepress/theme.ts +++ b/src/.vuepress/theme.ts @@ -4,14 +4,14 @@ import navbar from "./navbar.js"; import sidebar from "./sidebar.js"; export default hopeTheme({ - hostname: "https://vuepress-theme-hope-docs-demo.netlify.app", + hostname: "https://yh-api.yyyyt.top", author: { name: "yh-third-dev", url: "https://github.com/yh-Tpdev/", }, - logo: "https://theme-hope-assets.vuejs.press/logo.svg", + logo: "/logo.webp", repo: "yh-Tpdev/yhchatAPI", diff --git a/src/README.md b/src/README.md index 4caee2d8..2af62da7 100644 --- a/src/README.md +++ b/src/README.md @@ -2,7 +2,7 @@ home: true icon: house title: 主页 -heroImage: https://theme-hope-assets.vuejs.press/logo.svg +heroImage: /logo.webp bgImage: /assets/Hiro.avif bgImageStyle: background-attachment: fixed diff --git a/src/api/README.md b/src/api/README.md index 730999ce..f37d87a8 100644 --- a/src/api/README.md +++ b/src/api/README.md @@ -18,7 +18,10 @@ title: API - 视频路由: - `https://chat-video1.jwznb.com/` -云湖数据床地址需要请求头加上 `Referer: http://myapp.jwznb.com` 才可正常获取内容，否则会403. +云湖数据床地址需要请求头加上 `Referer: http://myapp.jwznb.com` 才可正常获取内容，否则会403. + +chat_type 聊天对象的类型: 1-用户, 2-群组, 3-机器人 +content_type 信息类型: 1-文本，2-图片，3-markdown，4-文件，5-表单，6-文章，7-表情，8-html，11-语音，13-语音通话, 14-A2UI ::: ::: tip 如何让 LLM 写出可用性更高的代码 @@ -44,6 +47,8 @@ https://yh-api.yyyyt.top/llms-full.txt **请务必注意 protobuf 协议本身的特性.** **云湖账号的 Token 请务必小心对待不要泄露,不要将 token 硬编码到代码中.** ``` -:::: + +::: + diff --git a/src/api/v1/README.md b/src/api/v1/README.md index f19a5d1b..24783529 100644 --- a/src/api/v1/README.md +++ b/src/api/v1/README.md @@ -13,8 +13,8 @@ Proto 文件中的 Status 未特别备注均为下面内容: ```proto message Status { - uint64 number = 1; // 不知道干啥的,可能是请求ID - uint64 code = 2; // 状态码,1为正常 + uint64 request_id = 1; // 请求 ID + uint64 code = 2; // 状态码,1 为正常 string msg = 3; // 返回消息 } ``` @@ -23,8 +23,8 @@ message Status { ```JSONC { - "code":1, // 返回状态码 - "msg":"success" //返回状态信息 + "code":1, // 返回状态码,1 为正常 + "msg":"success" //返回状态消息 } ``` diff --git a/src/api/v1/beta.md b/src/api/v1/beta.md index 8142c706..e61cbe4b 100644 --- a/src/api/v1/beta.md +++ b/src/api/v1/beta.md @@ -19,13 +19,13 @@ POST /v1/beta/info ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1 为正常 + "code": 1, "data": { "beta": "allow", // 是否为内测用户，allow - 是，noapply - 否 "info": "\n即将内测的功能：\n1、更加完整的内测功能\n2、邀请码自定义功能\n3、地区排名活动\n4、网页版云湖\n" }, // 内测信息 - "msg": "success" // 返回消息 + "msg": "success" } ``` diff --git a/src/api/v1/bot.md b/src/api/v1/bot.md index e6a65981..060193d5 100644 --- a/src/api/v1/bot.md +++ b/src/api/v1/bot.md @@ -19,27 +19,27 @@ POST /v1/bot/banner ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "banners": [ { - "id": 123, // banner的id + "id": 123, // banner 的 ID "title": "测试标题", // 标题 "introduction": "测试介绍", // 介绍 - "targetId": "", // "查看详情"点击后的id + "targetId": "", // "查看详情"点击后的 ID "targetUrl": "https://...", // "查看详情"跳转的链接 - "imageUrl": "https://...", // banner背景图 + "imageUrl": "https://...", // banner 背景图 "sort": 123, // 排列顺序 "delFlag": 0, "createTime": 0, // 创建时间 "remark": "", // 备注 - "createBy": 0, // banner创建者 + "createBy": 0, // banner 创建者 "typ": 2 // 类型 } // ... ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -57,22 +57,22 @@ POST /v1/bot/new-list ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "bots": [ { - "chatId": "123", // 机器人id - "chatType": "3", // 识别对象类别，1-用户，2-群聊，3-机器人 + "chatId": "123", // 机器人 ID + "chatType": "3", // 对象类别: 1-用户，2-群聊，3-机器人 "headcount": "25", // 机器人使用人数 "nickname": "测试机器人名称", // 机器人名字 "introduction": "测试机器人介绍", // 机器人介绍 "instructions": "", - "avatarUrl": "https://..." // 机器人头像url - } - // ... + "avatarUrl": "https://..." // 机器人头像 URL + }, + // ... ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -90,7 +90,7 @@ POST /v1/bot/bot-detail ```JSONC { - "id": "123" // 机器人id + "id": "123" // 机器人 ID } ``` @@ -98,18 +98,18 @@ POST /v1/bot/bot-detail ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "bot": { - "id": 1, // 排序id（？ - "botId": "123", // 机器人id + "id": 1, // 排序 ID（？ + "botId": "123", // 机器人 ID "nickname": "测试机器人每次", //机器人名字 - "nicknameId": 123, // 名称id - "avatarId": 123, // 头像id - "avatarUrl": "https://.。。", // 头像url + "nicknameId": 123, // 名称 ID + "avatarId": 123, // 头像 ID + "avatarUrl": "https://.。。", // 头像 URL "type": 0, // 类型 "introduction": "测试机器人介绍", // 机器人介绍 - "createBy": "123", // 机器人创建者id + "createBy": "123", // 机器人创建者 ID "createTime": 1231231230, // 机器人创建时间戳 "headcount": 123, // 机器人使用人数 "private": 0, // 是否私有（0为否，1为私人） @@ -118,33 +118,33 @@ POST /v1/bot/bot-detail "del_flag": 0, "alwaysAgree": 1, // 是否总是同意添加群聊 "banId": 0, // 顾名思义 - "uri": "https://chat-go.jwzhd.com/open-apis/v1/bot/send?token=" // 机器人发送消息url（？ + "uri": "https://chat-go.jwzhd.com/open-apis/v1/bot/send?token=" // 机器人发送消息 URL（？ }, "groups": [ { "id": 0, // 排序 （不知道为什么很多字段没有值，而客户端加入这个群显示群聊信息正常） - "groupId": "123", // 群组id + "groupId": "123", // 群组 ID "name": "测试群聊名称", // 群聊名字 "introduction": "测试群聊简介", // 群聊介绍 - "createBy": "", // 群聊创建者id + "createBy": "", // 群聊创建者 ID "createTime": 0, // 群聊创建时间 - "avatarId": 0, // 群聊头像id + "avatarId": 0, // 群聊头像 ID "del_flag": 0, - "avatarUrl": "https://...", // 群聊头像url + "avatarUrl": "https://...", // 群聊头像 URL "headcount": 0, // 群聊人数 "readHistory": 0, // 是否启用新成员查看历史记录 "alwaysAgree": 0, // 是否总是直接加入群聊 - "categoryId": 0, // 类别id - "category": "", // 类别 - "private": 0, // 群聊是否私有 - "banId": 0, // ban人的id + "categoryId": 0, // 分类 ID + "category": "", // 分类 + "private": 0, // 是否私有 + "banId": 0, // ban 人的 ID "gag": 0, "gagBy": "", "msgTypeLimit": "" }, // ... ], - "msg": "success" // 返回消息 + "msg": "success" }, } ``` @@ -163,39 +163,39 @@ POST /v1/bot/bot-group-list ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "botsTotal": 1, // 机器人数量 "list": { "bots": [ { "id": 0, // 机器人排列位置ID - "botId": "123", // 机器人ID + "botId": "123", // 机器人 ID "nickname": "测试机器人名称", // 机器人名称 - "nicknameId": 0, // 机器人名称ID - "avatarId": 0, // 机器人头像ID - "avatarUrl": "https://...", // 机器人头像ID - "token": "123123123123123123123", // 机器人token + "nicknameId": 0, // 机器人名称 ID + "avatarId": 0, // 机器人头像 ID + "avatarUrl": "https://...", // 机器人头像 ID + "token": "123123123123123123123", // 机器人 token "link": "", // 机器人分享链接？ "type": 0, // 未知 "introduction": "测试机器人简介", // 机器人简介 - "createBy": "", // 创建者id + "createBy": "", // 创建者 ID "createTime": 0, // 机器人创建时间 "headcount": 0, // 未知 "private": 0, // 是否私有 "isStop": 0, // 是否停用 - "settingJson": "", // 机器人设置json，需转义 + "settingJson": "", // 机器人设置 json，需转义 "del_flag": 0, // 删除标签 "alwaysAgree": 0, // 拉机器人时机器人是否直接进群 "groupLimit": 0, // 机器人进群限制 - "banId": 0, // 被封禁的id + "banId": 0, // 被封禁的 ID "linkStop": 0, // 未知 - "uri": "https://chat-go.jwzhd.com/open-apis/v1/bot/send?token=" // 机器人示例API接口 + "uri": "https://chat-go.jwzhd.com/open-apis/v1/bot/send?token=" // 机器人示例 API 接口 }, ] } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -213,8 +213,8 @@ POST /v1/bot/edit-setting-json ```JSONC { - "id": "123", // 机器人id - "settingJson": "[]" // 机器人设置json，需转义 + "id": "123", // 机器人 ID + "settingJson": "[]" // 机器人设置 json，需转义 } ``` @@ -222,8 +222,8 @@ POST /v1/bot/edit-setting-json ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -244,7 +244,7 @@ POST /v1/bot/web-edit-bot "nickname":"测试机器人名称", // 机器人名称 "introduction":"测试机器人简介", // 机器人简介 "avatarUrl":"https://...", //机器人头像 - "botId":"123", // 机器人ID + "botId":"123", // 机器人 ID "private":0 // 0-公开，1-私有 } ``` @@ -253,8 +253,8 @@ POST /v1/bot/web-edit-bot ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -271,14 +271,14 @@ POST /v1/bot/bot-info 请求体: ```ProtoBuf -id: 123 // 机器人ID +id: 123 // 机器人 ID ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message bot_info_send { - string id = 2; // 机器人ID + string id = 2; // 机器人 ID } ``` @@ -288,30 +288,30 @@ message bot_info_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } Bot_data { - bot_id: "123" // 机器人ID + bot_id: "123" // 机器人 ID name: "测试机器人名称" // 机器人名称 - name_id: 123 // 机器人名称ID - avatar_url: "https://..." // 机器人头像url - avatar_id: 123 // 机器人头像ID + name_id: 123 // 机器人名称 ID + avatar_url: "https://..." // 机器人头像 URL + avatar_id: 123 // 机器人头像 ID introduction: "测试机器人介绍" // 机器人介绍 - create_by: "123" // 机器人创建者ID + create_by: "123" // 机器人创建者 ID create_time: 123123123 // 机器人创建时间戳 headcount: 123 // 使用人数 - private: 0 // 是否为私有，0-公开，1-私有 - is_stop: 0 // 是否停用，0-启用，1-停用 - always_agree: 0 // 自动进群，0-不自动进群，1-自动进群 - do_not_disturb: 0 // 免打扰，0-不免打扰，1-免打扰 - top: 0 // 置顶，0-未置顶，1-已置顶 - group_limit: 0 // 限制进群，0-允许进群，1-限制进群 + private: 0 // 是否为私有: 0-公开，1-私有 + is_stop: 0 // 是否停用: 0-启用，1-停用 + always_agree: 0 // 自动进群: 0-不自动进群，1-自动进群 + do_not_disturb: 0 // 免打扰: 0-不免打扰，1-免打扰 + top: 0 // 置顶: 0-未置顶，1-已置顶 + group_limit: 0 // 限制进群: 0-允许进群，1-限制进群 } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 获取机器人信息返回信息 @@ -319,21 +319,21 @@ message bot_info { Status status = 1; Bot_data data = 2; message Bot_data { - string bot_id = 1; // 机器人ID + string bot_id = 1; // 机器人 ID string name = 2; // 机器人名称 - int64 name_id = 3; // 机器人名称ID - string avatar_url = 4; // 机器人头像url - string avatar_id = 5; // 机器人头像ID + int64 name_id = 3; // 机器人名称 ID + string avatar_url = 4; // 机器人头像 URL + string avatar_id = 5; // 机器人头像 ID string introduction = 6; // 机器人介绍 - string create_by = 7; // 机器人创建者ID + string create_by = 7; // 机器人创建者 ID int64 create_time = 8; // 机器人创建时间戳 int64 headcount = 9; // 使用人数 - int32 private = 10; // 是否为私有，0-公开，1-私有 - int32 is_stop = 11; // 是否停用，0-启用，1-停用 - int32 always_agree = 13; // 自动进群，0-不自动进群，1-自动进群 - int32 do_not_disturb = 15; // 免打扰，0-不免打扰，1-免打扰 - int32 top = 18; // 置顶，0-未置顶，1-已置顶 - int32 group_limit = 20; // 限制进群，0-允许进群，1-限制进群 + int32 private = 10; // 是否为私有: 0-公开，1-私有 + int32 is_stop = 11; // 是否停用: 0-启用，1-停用 + int32 always_agree = 13; // 自动进群: 0-不自动进群，1-自动进群 + int32 do_not_disturb = 15; // 免打扰: 0-不免打扰，1-免打扰 + int32 top = 18; // 置顶: 0-未置顶，1-已置顶 + int32 group_limit = 20; // 限制进群: 0-允许进群，1-限制进群 } } @@ -354,17 +354,17 @@ POST /v1/bot/board 请求体: ```ProtoBuf -id: 123 // 群聊ID -chat_type: 2 // 对象类型 1-用户 2-群聊 3-机器人 +id: 123 // 群聊 ID +chat_type: 2 // 对象类型 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 看板 message board_send { - string id = 3; // 群聊/用户/机器人ID - int64 chat_type = 4; // 对象类型 1-用户 2-群聊 3-机器人 + string id = 3; // 对象 ID + int64 chat_type = 4; // 对象类型 } ``` @@ -374,14 +374,14 @@ message board_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } Board_data { - bot_id: "123" // 机器人ID - chat_id: "123" // 对象ID - chat_type: 2 // 对象类别，2-群聊，3-机器人 + bot_id: "123" // 机器人 ID + chat_id: "123" // 对象 ID + chat_type: 2 // 对象类别 content: "测试看板内容" // 看板内容 content_type = 5; // 看板内容类别，1-文本，2-markdown，3-html last_update_time: 123123123 // 最后更新时间戳 @@ -389,7 +389,7 @@ Board_data { } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 获取看板返回 @@ -397,9 +397,9 @@ message board { Status status = 1; Board_data data = 2; message Board_data { - string bot_id = 1; // 机器人ID - string chat_id = 2; // 对象ID - int32 chat_type = 3; // 对象类别，2-群聊，3-机器人 + string bot_id = 1; // 机器人 ID + string chat_id = 2; // 对象 ID + int32 chat_type = 3; // 对象类别 string content = 4; // 看板内容 int32 content_type = 5; // 看板内容类别，1-文本，2-markdown，3-html int64 last_update_time = 6; // 最后更新时间戳 @@ -424,8 +424,8 @@ POST /v1/bot/remove-follower ```JSONC { - "botId": "123", // 机器人ID - "userId": "123" // 用户ID + "botId": "123", // 机器人 ID + "userId": "123" // 用户 ID } ``` @@ -433,8 +433,8 @@ POST /v1/bot/remove-follower ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -452,8 +452,8 @@ POST /v1/bot/remove-group ```JSONC { - "botId": "123", // 机器人ID - "groupId": "123" // 群聊ID + "botId": "123", // 机器人 ID + "groupId": "123" // 群聊 ID } ``` @@ -461,8 +461,8 @@ POST /v1/bot/remove-group ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -480,7 +480,7 @@ POST /v1/bot/llm/llm-setting-list ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { @@ -497,15 +497,15 @@ POST /v1/bot/llm/llm-setting-list "params": "[{\"name\": \"API Key\", \"type\": \"input\"}]", // 参数模板 "parent_id": 1, // 参数模板ID "subItems": null, - "tag": "测试模型数据" // tag数据，若无则为null + "tag": "测试模型数据" // tag数据，若无则为 null } // ... ], - "tag": "测试模型数据" // tag数据，若无则为null + "tag": "测试模型数据" // tag数据，若无则为 null } // ... ], - "msg": "success" // 返回消息 + "msg": "success" }, } ``` @@ -524,7 +524,7 @@ POST /v1/bot/llm/llm-setting-ref-info ```JSONC { - "botId": "123", // 机器人ID + "botId": "123", // 机器人 ID } ``` @@ -532,22 +532,22 @@ POST /v1/bot/llm/llm-setting-ref-info ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "historyCount": 0, "id": 0, - "isBigModel": 0, // 是否开启大模型，0-关闭，1-开启 + "isBigModel": 0, // 是否开启大模型: 0-关闭，1-开启 "isNeedReply": 0, - "key": "", // 大模型APIkey + "key": "", // 大模型 APIkey "llmBaseUrl": "", - "llmId": 0, // 大模型组ID + "llmId": 0, // 大模型组 ID "llmModelName": "测试大模型-chat", // 大模型名称 "llmName": "测试大模型", // 大模型组名称 - "mcpJson": "", // mcpJSON数据，json转义 - "paramJson": "", // paramJSON数据，json转义 - "prompt": "" // AI提示词 + "mcpJson": "", // mcpJSON 数据，json 转义 + "paramJson": "", // paramJSON 数据，json 转义 + "prompt": "" // AI 提示词 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -565,7 +565,7 @@ POST /v1/bot/reset-bot-token ```JSONC { - "botId": "123", // 机器人ID + "botId": "123", // 机器人 ID } ``` @@ -573,11 +573,11 @@ POST /v1/bot/reset-bot-token ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "token": "123" // 重置后的机器人token + "token": "123" // 重置后的机器人 token }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -596,17 +596,17 @@ POST /v1/bot/create-bot ```ProtoBuf name: 2 //机器人名称 introduction: 3 //机器人简介 -avatar_url：4 // 机器人头像Url +avatar_url：4 // 机器人头像 URL private:5 // 是否私有(0-公开，1-私有) ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message CreateBotRequest { string name = 2; // 机器人名称 string introduction = 3; // 机器人简介 - string avatar_url = 4; // 头像URL + string avatar_url = 4; // 头像 URL int32 private = 5; // 是否私有(0-公开，1-私有) } ``` @@ -621,13 +621,13 @@ message CreateBotResponse { BotData data = 2; message Status { - int64 number = 1; // 可能是请求ID - int32 code = 2; // 1表示成功 - string msg = 3; // success + int64 request_id = 1; + int32 code = 2; + string msg = 3; } message BotData { - string bot_id = 1; // 创建的机器人ID + string bot_id = 1; // 创建的机器人 ID } } ``` @@ -646,9 +646,9 @@ POST /v1/bot/edit-subscribed-link ```JSONC { - "botId": "75282754", // 机器人id + "botId": "75282754", // 机器人 ID "link": "http(s)://xxxxxx", // 设置消息订阅接口（地址） - "subscribeType": 0 // 订阅类别，0-url订阅，1-wss订阅 + "subscribeType": 0 // 订阅类别: 0-url 订阅，1-wss 订阅 } ``` @@ -656,8 +656,8 @@ POST /v1/bot/edit-subscribed-link ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -675,8 +675,8 @@ POST /v1/bot/get-user-settings-json ```JSONC { - "botId": "2468910", // 机器人id - "chatId": "1234567" // 会话id(一般是群聊) + "botId": "2468910", // 机器人 ID + "chatId": "1234567" // 会话 ID(一般是群聊) } ``` @@ -688,18 +688,18 @@ POST /v1/bot/get-user-settings-json "data": { "settingsJson": [ { - "id": "pqkyru", // 该项的id（表单id） + "id": "pqkyru", // 该项的 ID（表单ID） "key": 0, // 第几个项，这里是第一个 "props": [ { "name": "标签", // 该项名称 - "type": "label", // 类型，一个用于设置“标签”的配置项，有radio-单选框，input-输入框，switch-开关，chexkbox-多选框，textarea-多行输入框，select-选择器 + "type": "label", // 类型，一个用于设置“标签”的配置项，有 radio-单选框，input-输入框，switch-开关，chexkbox-多选框，textarea-多行输入框，select-选择器 "value": "" // 这个类型预定的值，默认空 }, { "name": "选项", "placeholder": "用#分割，如：北京#上海#天津", // 带有输入框的项/类型，会有选项，然后里面有占位符，这个就是占位符文本，其实这个叫选项 - "type": "options", // 带placeholder的类型有，Radio 单选框，Checkbox 多选框，Select 选择器 + "type": "options", // 带 placeholder 的类型有，Radio 单选框，Checkbox 多选框，Select 选择器 "value": "" } ], @@ -831,7 +831,7 @@ POST /v1/bot/get-user-settings-json } ] }, - "msg": "success" // 返回状态消息 + "msg": "success" } ``` @@ -849,9 +849,9 @@ POST /v1/bot/send-setting-json ```JSONC { - "id": "12345", // 机器人id - "groupId": "678910", // 群聊id - "settingJson": "" // 机器人设置json数组（需转义） + "id": "12345", // 机器人 ID + "groupId": "678910", // 群聊 ID + "settingJson": "" // 机器人设置 json 数组（需转义） } ``` @@ -859,8 +859,8 @@ POST /v1/bot/send-setting-json ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -878,7 +878,7 @@ POST /v1/bot/llm/clean-content ```JSONC { - "botId": "25637484" // 机器人ID + "botId": "25637484" // 机器人 ID } ``` @@ -886,8 +886,8 @@ POST /v1/bot/llm/clean-content ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -905,7 +905,7 @@ POST /v1/bot/llm/knowledge/list ```JSONC { - "botId": "123123123" // 机器人ID + "botId": "123123123" // 机器人 ID } ``` @@ -913,29 +913,29 @@ POST /v1/bot/llm/knowledge/list ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { "id": 123, // 知识文件ID - "botId": "123123123", // 机器人ID - "botLlmId": 123, // Llm智能体机器人ID + "botId": "123123123", // 机器人 ID + "botLlmId": 123, // Llm智能体机器人 ID "name": "轻韵助手-第三方云湖助手：第三方扩展插件编写文档.txt", "url": "https://chat-file.jwznb.com/knowledge/835a1ab0d63ba9921c25d5f4e8c3bfe5.txt", - "status": 0, // 知识库文件处理状态，0-处理中，1-处理成功，2-处理失败 - "isStop": 0, // 是否停用此文件，0-不停用，1-停用 + "status": 0, // 知识库文件处理状态: 0-处理中，1-处理成功，2-处理失败 + "isStop": 0, // 是否停用此文件: 0-不停用，1-停用 "charLength": 0, // 字符长度 "paragraphCount": 0, // 分段数 - "createBy": "123", // 知识库文件创建者ID + "createBy": "123", // 知识库文件创建者 ID "createTime": 123123123, // 知识库文件创建时间戳 - "updateBy": "", // 知识库文件更新用户ID + "updateBy": "", // 知识库文件更新用户 ID "updateTime": 0, // 知识库文件更新时间戳 "delFlag": 0 // 删除标签 - } + }, // ... ] }, - "msg": "success" // 返回状态消息 + "msg": "success" } ``` @@ -953,8 +953,8 @@ POST /v1/bot/llm/knowledge/create ```JSONC { - "botId": "123123123", // 机器人ID - "knowledgeId": 123 // 知识文件ID + "botId": "123123123", // 机器人 ID + "knowledgeId": 123 // 知识文件 ID } ``` @@ -962,8 +962,8 @@ POST /v1/bot/llm/knowledge/create ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -981,27 +981,27 @@ POST /v1/bot/console/my-bots ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "botsTotal": 1, // 创建的机器人总数 "list": { "bots": [ { - "botId": "123123123", // 机器人ID + "botId": "123123123", // 机器人 ID "nickname": "测试机器人名称", // 机器人名称 "avatarUrl": "https://...", // 机器人头像 - "token": "123123123123123123123", // 机器人token + "token": "123123123123123123123", // 机器人 token "link": "", // 订阅链接 - "linkStop": "0", // 订阅链接是否被停用，0-未停用，1-已停用 - "subscribeType": "0", // 订阅类别，0-url订阅，1-wss订阅 - "settingJson": "", // 机器人设置配置json，需将json数据转义后填入 + "linkStop": "0", // 订阅链接是否被停用: 0-未停用，1-已停用 + "subscribeType": "0", // 订阅类别: 0-url 订阅，1-wss 订阅 + "settingJson": "", // 机器人设置配置 json，需将 json 数据转义后填入 "introduction": "测试机器人简介" // 机器人简介 } // ... ] } }, - "msg": "success" // 返回状态消息 + "msg": "success" } ``` @@ -1019,14 +1019,14 @@ POST /v1/bot/group-permission-get ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "allowEditGroupInfo": 0, // 允许编辑群消息，0-不允许，1-允许 - "allowGagMember": 0, // 允许禁言用户，0-不允许，1-允许 - "allowRemoveMember": 0, // 允许移除用户，0-不允许，1-允许 - "allowGroupTagManage": 0 // 允许管理群标签，0-不允许，1-允许 + "allowEditGroupInfo": 0, // 允许编辑群信息: 0-不允许，1-允许 + "allowGagMember": 0, // 允许禁言用户: 0-不允许，1-允许 + "allowRemoveMember": 0, // 允许移除用户: 0-不允许，1-允许 + "allowGroupTagManage": 0 // 允许管理群标签: 0-不允许，1-允许 }, - "msg": "success" // 返回状态消息 + "msg": "success" } ``` @@ -1044,7 +1044,7 @@ POST /v1/bot/llm/llm-setting-ref-params ```JSONC { - "chatId": "123123123", // 对象ID + "chatId": "123123123", // 对象 ID "chatType": 2 // 对象类别 } ``` @@ -1053,11 +1053,11 @@ POST /v1/bot/llm/llm-setting-ref-params ```JSONC { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [] // 暂无实例数据 }, - "msg": "success" // 返回状态消息 + "msg": "success" } ``` @@ -1075,12 +1075,12 @@ POST /v1/bot/group-permission-edit ```JSONC { - "botId": "123123", // 机器人ID - "groupId": "123123123", // 群聊ID - "allowEditGroupInfo": 0, // 允许编辑群消息，0-不允许，1-允许 - "allowGagMember": 0, // 允许禁言用户，0-不允许，1-允许 - "allowRemoveMember": 0, // 允许移除用户，0-不允许，1-允许 - "allowGroupTagManage": 0 // 允许管理群标签，0-不允许，1-允许 + "botId": "123123", // 机器人 ID + "groupId": "123123123", // 群聊 ID + "allowEditGroupInfo": 0, // 允许编辑群信息: 0-不允许，1-允许 + "allowGagMember": 0, // 允许禁言用户: 0-不允许，1-允许 + "allowRemoveMember": 0, // 允许移除用户: 0-不允许，1-允许 + "allowGroupTagManage": 0 // 允许管理群标签: 0-不允许，1-允许 } ``` @@ -1088,8 +1088,8 @@ POST /v1/bot/group-permission-edit ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -1112,16 +1112,16 @@ data { size: 20 // 分页大小 page: 1 // 页数 } -bot_id: "123" // 机器人ID +bot_id: "123" // 机器人 ID keywords: "测试" // 搜索关键词 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message list_follower { Data data = 2; - string bot_id = 3; // 机器人ID + string bot_id = 3; // 机器人 ID string keywords = 4; // 搜索关键词 message Data { @@ -1137,22 +1137,22 @@ message list_follower { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } user { - user_id: "7356666" // 用户ID + user_id: "7356666" // 用户 ID name: "Feng" // 用户名 - avatar_url: "https://..." // 头像URL - is_vip: 0 // 是否为vip用户, 0-不为vip用户, 1-vip用户 + avatar_url: "https://..." // 头像 URL + is_vip: 0 // 是否为 vip 用户, 0-不为 vip 用户, 1-vip 用户 } // 可以有多个 // ... totol: 32 // 关注该机器人的用户总数 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message list_follower { @@ -1190,16 +1190,16 @@ data { size: 20 // 分页大小 page: 1 // 页数 } -bot_id: "123" // 机器人ID +bot_id: "123" // 机器人 ID keywords: "测试用户名" // 搜索关键词 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message list_join_group { Data data = 2; - string bot_id = 3; // 机器人ID + string bot_id = 3; // 机器人 ID string keywords = 4; // 搜索关键词 message Data { @@ -1215,21 +1215,21 @@ message list_join_group { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } group { - user_id: "123" // 群聊ID + user_id: "123" // 群聊 ID name: "测试群聊名称" // 群聊名字 - avatar_url: "https://..." // 头像URL + avatar_url: "https://..." // 头像 URL } // 可以有多个 // ... totol: 32 // 机器人加入的群聊总数 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message list_join_group { diff --git a/src/api/v1/chat-background.md b/src/api/v1/chat-background.md index 61dfa417..aaae482d 100644 --- a/src/api/v1/chat-background.md +++ b/src/api/v1/chat-background.md @@ -19,7 +19,7 @@ POST /v1/chat-background/edit ### 请求体 -```JSONC +```JSON { "userId": "用户 id", "chatId": "群聊 id", // 如果设置全部背景则填 all @@ -29,10 +29,10 @@ POST /v1/chat-background/edit ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1 为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -50,9 +50,9 @@ POST /v1/chat-background/list ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1 为正常 + "code": 1, "data": { "list": [ { @@ -67,6 +67,6 @@ POST /v1/chat-background/list // ... ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` diff --git a/src/api/v1/check.md b/src/api/v1/check.md index 2c755098..65f2c341 100644 --- a/src/api/v1/check.md +++ b/src/api/v1/check.md @@ -18,7 +18,7 @@ POST /v1/check/get-latest-version ### 请求体 -```JSONC +```JSON { "packageInfo":"{\"appName\":\"云湖\",\"packageName\":\"com.yhchat.app\",\"version\":\"1.4.83\",\"buildNumber\":\"347\"}", // 当前应用信息，为 JSON 数组，需转义后才可使用 "platform":"android", // 设备标识 @@ -32,7 +32,7 @@ POST /v1/check/get-latest-version `packageInfo` 转换后的 JSON 结构 -```JSONC +```JSON { "appName": "云湖", // 软件名称 "packageName": "com.yhchat.app", // 软件包名 @@ -45,7 +45,7 @@ POST /v1/check/get-latest-version ### 响应体 -```JSONC +```JSON { "ApkMd5": "", // 更新包 MD5 "ApkSize": 74491, // 包体大小 @@ -68,7 +68,7 @@ POST /v1/check/check-version ### 请求体 -```jsonc +```JSON { "packageInfo": "{\"appName\":\"云湖\",\"packageName\":\"云湖\",\"version\":\"1.6.50\",\"buildNumber\":\"225\"}", // 当前应用信息，为 JSON 数组，需转义后才可使用 "platform": "windows", // 平台 @@ -81,7 +81,7 @@ POST /v1/check/check-version `packageInfo` 转换后的 JSON 结构 -```JSONC +```JSON { "appName": "云湖", // 软件名称 "packageName": "云湖", // 软件包名 @@ -96,7 +96,7 @@ POST /v1/check/check-version `deviceinfo` 设备信息示例。 -```JSONC +```JSON { "computerName":"", // 设备名称 "numberOfCores":12, // CPU 线程数 @@ -130,14 +130,14 @@ POST /v1/check/check-version ### 响应体 -```jsonc +```JSON { - "code": 1, // 成功 + "code": 1, "data": { "latestDesc": "1、全新发布云湖APP\\n2、修复多个bug", // 更新日志 "latestVersion": "1.6.50", // 最新版本 "update": 0 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` diff --git a/src/api/v1/coin.md b/src/api/v1/coin.md index 4d142c64..ecb1e96e 100644 --- a/src/api/v1/coin.md +++ b/src/api/v1/coin.md @@ -17,7 +17,7 @@ POST /v1/coin/shop/product-recommend 请求体: -```JSONC +```JSON { "size": 100, // 字号 "page": 1 // 商品页数 @@ -26,20 +26,20 @@ POST /v1/coin/shop/product-recommend 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { - "id": 1, // 商品id + "id": 1, // 商品 ID "type": 1, // "cycle": 7, //会员持续时间（持续7天 "info": "7", "name": "【云湖】会员7天", // 商品名 - "imageUrls": "[\"https://chat-img.jwznb.com/999955a351c67b761ed078dc40d28ede.png\"]", // 商品图片url，为json数组，需转义后才可使用 + "imageUrls": "[\"https://chat-img.jwznb.com/999955a351c67b761ed078dc40d28ede.png\"]", // 商品图片 URL，为 json 数组，需转义后才可使用 "price": 100, // 价格（单位为金币） - "priceVip": 90, // vip专项价格 + "priceVip": 90, // vip 专项价格 "stock": 49, // 商品库存 "sale": 0, // 已经出售了0件 "description": "云湖会员7天，享受所有会员服务\r\n\r\n### **商品不定期补充库存，请留意全员群及官方消息**\r\n##### 注意事项\r\n1. 该商品每7天可兑换一次\r\n2. 兑换后直接开通或续费会员，无额外操作\r\n3. 虚拟商品，兑换后不支持退换\r\n4. 如有疑问联系官方客服", // 商品描述 @@ -50,7 +50,7 @@ POST /v1/coin/shop/product-recommend ], "total": 1 // 商品总数 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -66,16 +66,16 @@ POST /v1/coin/task/my-task-info 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "adsWatchNumber": 5, // 广告观看次数 - "avatarEditNumber": 0, // 判断是否改了头像，0是未更改，1是已更改 + "avatarEditNumber": 0, // 判断是否改了头像，0 是未更改，1 是已更改 "nicknameEditNumber": 1, // 判断是否改了名字，同上 - "raffleTimes": 1 // 抽奖时间（来自bing翻译 + "raffleTimes": 1 // 抽奖时间（来自 bing 翻译 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -91,25 +91,25 @@ POST /v1/coin/shop/product-detail 请求体： -```JSONC +```JSON { - "id": 1 // 商品id + "id": 1 // 商品 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "product": { - "id": 1, // 商品id + "id": 1, // 商品 ID "type": 1, "cycle": 7, //会员持续时间（持续7天 "info": "7", "name": "【云湖】会员7天", // 商品名 - "imageUrls": "[\"https://chat-img.jwznb.com/999955a351c67b761ed078dc40d28ede.png\"]", // 商品图片url，为json数组，需转义后才可使用 + "imageUrls": "[\"https://chat-img.jwznb.com/999955a351c67b761ed078dc40d28ede.png\"]", // 商品图片 URL，为 json 数组，需转义后才可使用 "price": 100, // 价格（单位为金币） "priceVip": 90, // vip专项价格 "stock": 49, // 商品库存 @@ -120,7 +120,7 @@ POST /v1/coin/shop/product-detail "lastUpdate": 0 // 商品更新时间 } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -136,9 +136,9 @@ POST /v1/coin/task/raffle 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回成功信息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/community.md b/src/api/v1/community.md index 7d7fa4f8..ae40d767 100644 --- a/src/api/v1/community.md +++ b/src/api/v1/community.md @@ -17,26 +17,26 @@ POST /v1/community/posts/create 请求体: -```JSONC +```JSON { - "baId": 40, // 文章分区ID - "groupId": "123", // 文本引用群聊ID + "baId": 40, // 文章分区 ID + "groupId": "123", // 文本引用群聊 ID "title": "测试文章标题", // 文章标题 "content": "测试文章内容", // 文章内容 - "contentType": 1, // 文章内容类别，1-文本，2-markdown - "draftId": 123 // 草稿ID，若此值不为0则云湖会删除这里设定的草稿ID所对应的草稿 + "contentType": 1, // 文章内容类别: 1-文本，2-markdown + "draftId": 123 // 草稿 ID，若此值不为 0 则云湖会删除这里设定的草稿 ID 所对应的草稿 } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "audioUrl": 123, // 文章ID + "audioUrl": 123, // 文章 ID }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -52,18 +52,18 @@ POST /v1/community/posts/delete 请求体: -```JSONC +```JSON { - "postId": 123 // 文章ID + "postId": 123 // 文章 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -79,20 +79,20 @@ POST /v1/community/posts/post-reward 请求体: -```JSONC +```JSON { - "postId": 123, // 文章ID - "recvId": "123", // 接受用户ID + "postId": 123, // 文章 ID + "recvId": "123", // 接受用户 ID "amount": 1.0 // 打赏金币数 } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -108,9 +108,9 @@ POST /v1/community/comment/comment-reward 请求体: -```JSONC +```JSON { - "postId": 123, // 文章ID + "postId": 123, // 文章 ID "commentId": 123, // 打赏评论 "amount": 1.0// 打赏金币数 } @@ -118,10 +118,10 @@ POST /v1/community/comment/comment-reward 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -137,18 +137,18 @@ POST /v1/community/posts/post-like 请求体: -```JSONC +```JSON { - "id": 123, // 文章ID + "id": 123, // 文章 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -164,18 +164,18 @@ POST /v1/community/posts/post-collect 请求体: -```JSONC +```JSON { - "id": 123, // 文章ID + "id": 123, // 文章 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -191,24 +191,24 @@ POST /v1/community/posts/edit 请求体: -```JSONC +```JSON { - "postId": 123, // 文章ID + "postId": 123, // 文章 ID "title": "测试文章标题", "content": "测试文章内容", // 文章内容 - "contentType": 2 // 文章内容类别，1-文本，2-markdown + "contentType": 2 // 文章内容类别: 1-文本，2-markdown } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "id": 123 // 文章ID(不知道为什么要再返回一遍) + "id": 123 // 文章 ID(不知道为什么要再返回一遍) }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -224,10 +224,10 @@ POST /v1/community/posts/post-list 请求体： -```JSONC +```JSON { "typ": 1, // 典型值 - "baId": 41, // 分区id + "baId": 41, // 分区 ID "size": 20, // 尺寸 "page": 1 // 页数 } @@ -235,18 +235,18 @@ POST /v1/community/posts/post-list 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "posts": [ { - "id": 123, // 文章id - "baId": 41, // 分区id - "senderId": "114514", // 文章作者id - "senderNicknameId": 123, // 发送者昵称 Id - "senderAvatarId": 123, // 发送者头像 Id - "groupId": "", // 绑定该分区且从这个群聊发送文章的群聊id + "id": 123, // 文章 ID + "baId": 41, // 分区 ID + "senderId": "114514", // 文章作者 ID + "senderNicknameId": 123, // 发送者昵称 ID + "senderAvatarId": 123, // 发送者头像 ID + "groupId": "", // 绑定该分区且从这个群聊发送文章的群聊 ID "title": "我是标题", // 标题 "contentType": 2, // 文章类型(2是Markdown，1是普通文本) "content": "文章内容部分预览", @@ -259,26 +259,26 @@ POST /v1/community/posts/post-list "commentNum": 4, // 评论数量 "collectNum": 0, // 收藏数量 "amountNum": 0, // 投币数量 - "senderNickname": "文章作者id", - "senderAvatar": "https://.。。", // 作者头像url + "senderNickname": "文章作者 ID", + "senderAvatar": "https://.。。", // 作者头像 URL "createTimeText": "2025-08-05 16:30:13", // 创建文章时间 - "group": { // 以下是绑定该分区且从这个群聊发送文章的群聊id + "group": { // 以下是绑定该分区且从这个群聊发送文章的群聊 ID "id": 0, // - "groupId": "", // 群聊id + "groupId": "", // 群聊 ID "name": "", // 群聊名字 "introduction": "", // 群聊简介 - "createBy": "", // 群主id + "createBy": "", // 创建者 ID "createTime": 0, // 创建时间戳 - "avatarId": 0, // 群聊头像id + "avatarId": 0, // 群聊头像 ID "del_flag": 0, - "avatarUrl": "", // 群聊头像url + "avatarUrl": "", // 群聊头像 URL "headcount": 0, // 群聊人数 "readHistory": 0, // 是否开启新成员浏览历史信息（1为开启，0为关闭） "alwaysAgree": 0, // 是否直接进群（1为开启，0为关闭） - "categoryId": 0, // 群聊分类Id + "categoryId": 0, // 群聊分类 ID "category": "", // 群聊所属分类 "private": 0, // 是否私有（1为开启，0为关闭） - "banId": 0, // 被禁言的id + "banId": 0, // 被禁言的 ID "gag": 0, // 是否禁言 "gagBy": "", // 禁言者 "msgTypeLimit": "" // 消息类型限制 @@ -286,13 +286,13 @@ POST /v1/community/posts/post-list "isLiked": "0", // 你有没有给这个文章点赞（1为是，0则不是） "isCollected": 0, // 你有没有收藏这个文章（1为是，0则不是） "isReward": 0, // 你有没有给这个文章投币 （1为是，0则不是） - "isVip": 0 // 你是不是vip（1为是，0则不是） + "isVip": 0 // 是否 vip（1为是，0则不是） } // ... ], "total": 360 // 已经加载的文章（共360篇文章） }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -308,22 +308,22 @@ POST /v1/community/ba/info 请求体： -```JSONC +```JSON { - "id": 41 // 分区id + "id": 41 // 分区 ID } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "ba": { - "id": 41, // 分区id + "id": 41, // 分区 ID "name": "云湖", // 分区名 - "avatar": "https://chat-img2.jwznb.com/FoHHKnX-QNuD33-NnGWlq74xkgpg.webp", // 分区头像url + "avatar": "https://chat-img2.jwznb.com/FoHHKnX-QNuD33-NnGWlq74xkgpg.webp", // 分区头像 URL "delTime": 0, // 删除时间 "createTime": 1665233353, // 创建时间戳 "lastActive": 1754474179, // 上次活跃时间戳 @@ -331,10 +331,10 @@ POST /v1/community/ba/info "postNum": 9656, // 该分区的文章数量 "groupNum": 55, // 绑定该分区的群聊数量 "createTimeText": "2022-10-08 20:49:13", // 分区创建时间 - "isFollowed": "1" // 你是否关注了此分区（1为已关注，0为未关注） + "isFollowed": "1" // 是否关注了此分区（1为已关注，0为未关注） } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -350,7 +350,7 @@ POST /v1/community/ba/following-ba-list 请求体： -```JSONC +```JSON { "typ": 2, // 类型（1-关注, 2-热门, 3-我的, 4-全部） "size": 20, // 排序 @@ -360,15 +360,15 @@ POST /v1/community/ba/following-ba-list 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "ba": [ { - "id": 41, // 分区id + "id": 41, // 分区 ID "name": "云湖", // 分区名字 - "avatar": "https://chat-img2.jwznb.com/FoHHKnX-QNuD33-NnGWlq74xkgpg.webp", // 分区头像url + "avatar": "https://chat-img2.jwznb.com/FoHHKnX-QNuD33-NnGWlq74xkgpg.webp", // 分区头像 URL "delTime": 0, // 删除时间 "createTime": 1665233353, // 创建时间 "lastActive": 1754474179, // 上次活跃时间 @@ -381,7 +381,7 @@ POST /v1/community/ba/following-ba-list ], "total": 11 // 总共的分区数量（共11个） }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -397,7 +397,7 @@ POST /v1/community/reward-record 请求体： -```JSONC +```JSON { "typ": "post", // 类型（post-文章,comment-评论） "size": 20, // 尺寸 @@ -407,29 +407,29 @@ POST /v1/community/reward-record 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "rewards": [ { - "id": 123, // 打赏id - "senderId": "123", // 打赏者id - "recvId": "123", // 文章作者id - "postId": 123, // 文章id - "commentId": 123, // 评论id + "id": 123, // 打赏 ID + "senderId": "123", // 打赏者 ID + "recvId": "123", // 文章作者 ID + "postId": 123, // 文章 ID + "commentId": 123, // 评论 ID "amount": 0.01, // 打赏者减少金币的数量 "recvAmount": 0.01, // 收到的金币数量 "createTime": 1753427517, "reason": "打赏文章扣金币", // 扣大赏者金币原因 "remark": "", // 备注 "post": { - "id": 123, // 文章id - "baId": 41, // 分区id - "senderId": "123", // 文章作者id - "senderNicknameId": 123, // 发送者名字id - "senderAvatarId": 84, // 发送者头像id - "groupId": "", // 文章关联群组id + "id": 123, // 文章 ID + "baId": 41, // 分区 ID + "senderId": "123", // 文章作者 ID + "senderNicknameId": 123, // 发送者名称 ID + "senderAvatarId": 84, // 发送者头像 ID + "groupId": "", // 文章关联群组的 ID "title": "测试文章标题", // 文章标题 "contentType": 1, // 文章类型（1-Markdown，0-普通文章） "delTime": 0, // 删除时间戳 @@ -441,15 +441,15 @@ POST /v1/community/reward-record "collectNum": 6, // 收藏数量 "amountNum": 0.01, // 文章投币数量 "senderNickname": "测试打赏者名称", // 文章作者昵称 - "senderAvatar": "https://...", // 文章作者头像url + "senderAvatar": "https://...", // 文章作者头像 URL "createTimeText": "2025-07-05 21:21:47", // 创建文章时间 "auditStatus": 0 }, "sender": { - "id": 106634, // 打赏id - "user_id": "123", // 打赏者id + "id": 106634, // 打赏 ID + "user_id": "123", // 打赏者 ID "nickname": "测试打赏者昵称", // 打赏者昵称 - "avatar_url": "https://..." // 打赏者头像url + "avatar_url": "https://..." // 打赏者头像 URL }, "comment": { "id": 0, @@ -475,7 +475,7 @@ POST /v1/community/reward-record ], "total": 1 // 总共的记录 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -491,20 +491,20 @@ POST /v1/community/comment/comment 请求体： -```JSONC +```JSON { - "postId": 123, // 文章id - "commentId": 123, // 评论id（若直接评论文章那id=0） + "postId": 123, // 文章 ID + "commentId": 123, // 评论 ID（若直接评论文章那 id=0） "content": "🤣" // 评论内容 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -520,9 +520,9 @@ POST /v1/community/comment/comment-list 请求体： -```JSONC +```JSON { - "postId": 31153, // 文章id + "postId": 31153, // 文章 ID "size": 10, // 尺寸 "page": 1 // 页数 } @@ -530,18 +530,18 @@ POST /v1/community/comment/comment-list 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "comments": [ { - "id": 123, // 评论id - "postId": 123, // 文章id - "parentId": 0, // 父id - "senderId": "114514", //发送者id - "sender_nicknameId": 123, // 发送者名称id - "sender_avatarUd": 123, // 发送者头像id + "id": 123, // 评论 ID + "postId": 123, // 文章 ID + "parentId": 0, // 父 ID + "senderId": "114514", // 发送者 ID + "sender_nicknameId": 123, // 发送者名称 ID + "sender_avatarUd": 123, // 发送者头像 ID "content": "？", // 评论内容 "delTime": 0, // 删除时间戳 "createTime": 1754746982, // 发送时间戳 @@ -551,7 +551,7 @@ POST /v1/community/comment/comment-list "auditStatus": 0, // 审核状态 "replies": [], // 评论内容 "senderNickname": "测试评论发送者名称", // 发送者昵称 - "senderAvatar": "https://...", // 发送者头像url + "senderAvatar": "https://...", // 发送者头像 URL "createTimeText": "2025-08-09 21:43:02", // 评论时间 "isLiked": "0", // 是否点赞(1-是，0-否) "isReward": 0, // 是否投币(1-是，0-否) @@ -562,7 +562,7 @@ POST /v1/community/comment/comment-list "isAdmin": 0, // 判断你是否为管理员(1/是，2-否) "total": 3 // 总共评论数量(3个) }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -578,7 +578,7 @@ POST /v1/community/search 请求体： -```JSONC +```JSON { "typ": 3, // 未知 "keyword": "123", // 关键词文本 @@ -589,21 +589,21 @@ POST /v1/community/search 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "ba": [], "posts": [ { - "id": 30315, // 文章ID - "baId": 43, // 文章所属分区ID - "senderId": "123", // 文章发送者ID - "senderNicknameId": 123, // 文章发送者名称ID - "senderAvatarId": 123, // 文章发送者头像ID - "groupId": "", // 文章引用群聊ID + "id": 30315, // 文章 ID + "baId": 43, // 文章所属分区 ID + "senderId": "123", // 文章发送者 ID + "senderNicknameId": 123, // 文章发送者名称 ID + "senderAvatarId": 123, // 文章发送者头像 ID + "groupId": "", // 文章引用群聊 ID "title": "测试文章标题", // 文章标题 - "contentType": 2, // 文章内容类别，1-文本，2-Markdown + "contentType": 2, // 文章内容类别: 1-文本，2-markdown "content": "测试文章内容", // 文章内容 "delTime": 0, // 未知 "createTime": 1749736140, // 文章创建时间戳 @@ -639,7 +639,7 @@ POST /v1/community/search "msgTypeLimit": "" // 未知 }, "ba": { - "id": 123, // 文章所处分区ID + "id": 123, // 文章所处分区 ID "name": "测试文章所处分区名称", // 文章所处分区名称 "avatar": "https://...", // 文章所处分区头像 "delTime": 0, // 未知 @@ -657,7 +657,7 @@ POST /v1/community/search // ... ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -673,7 +673,7 @@ POST /v1/community/set-black-list 请求体： -```JSONC +```JSON { "isAdd": 0, // 0-取消屏蔽，1-屏蔽 "authorId": "123" @@ -682,10 +682,10 @@ POST /v1/community/set-black-list 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -701,7 +701,7 @@ POST /v1/community/black-list 请求体： -```JSONC +```JSON { "size": 20, // 返回文章数量 "page": 1 // 页数 @@ -710,14 +710,14 @@ POST /v1/community/black-list 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { - "id": 0, // 屏蔽ID - "user_id": "123", // 屏蔽用户ID + "id": 0, // 屏蔽 ID + "user_id": "123", // 屏蔽用户 ID "nickname": "测试屏蔽用户", // 屏蔽用户名称 "avatar_url": "https://..." // 屏蔽用户头像 } @@ -725,7 +725,7 @@ POST /v1/community/black-list ], "total": 1 // 屏蔽用户数 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -741,22 +741,22 @@ POST /v1/community/posts/post-detail 请求体： -```JSONC +```JSON { - "id": 31622 //文章id + "id": 31622 //文章 ID } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "ba": { - "id": 41, // 文章分区id + "id": 41, // 文章分区 ID "name": "云湖", // 分区名称 - "avatar": "https://chat-img2.jwznb.com/FoHHKnX-QNuD33-NnGWlq74xkgpg.webp", // 作者头像url + "avatar": "https://chat-img2.jwznb.com/FoHHKnX-QNuD33-NnGWlq74xkgpg.webp", // 作者头像 URL "delTime": 0, // 删除时间(戳) "createTime": 1665233353, // 文章创建时间戳 "lastActive": 1757794419, // 上次活跃时间戳 @@ -768,12 +768,12 @@ POST /v1/community/posts/post-detail }, "isAdmin": 0, // 文章作者是否为管理员 "post": { - "id": 123, // 文章id - "baId": 41, // 该文章所处的分区id - "senderId": "7384288", // 文章作者id + "id": 123, // 文章 ID + "baId": 41, // 该文章所处的分区 ID + "senderId": "7384288", // 文章作者 ID "senderNicknameId": 123, // 文章作者名称id "senderAvatarId": 123, // 文章作者头像id - "groupId": "", // 该文章所处的群聊id + "groupId": "", // 该文章所处的群聊 ID "title": "文章标题", // 文章标题 "contentType": 2, // 文章类型，1-普通文字，2-Markdown "content": "文章内容", // 文章内容 @@ -789,11 +789,11 @@ POST /v1/community/posts/post-detail "isSticky": 0, // 置顶时间戳，若不是置顶则为0 "amountNum": 0, // 文章投币数量 "senderNickname": "作者名称", // 文章作者名称 - "senderAvatar": "https://c...", // 文章作者头像url + "senderAvatar": "https://c...", // 文章作者头像 URL "createTimeText": "2025-09-13 17:29:14", // 文章发送时间 "group": { // 该文章下绑定的群聊信息 "id": 0, // 会话类型id - "groupId": "", // 群聊id + "groupId": "", // 群聊 ID "name": "", // 群聊名称 "introduction": "", // 群聊简介 "createBy": "", // 该群群主id @@ -813,9 +813,9 @@ POST /v1/community/posts/post-detail "msgTypeLimit": "" // 群聊消息类型限制 }, "ba": { // 分区相关信息 - "id": 41, // 该文章所属分区id + "id": 41, // 该文章所属分区 ID "name": "云湖", // 分区名称 - "avatar": "https://chat-img.jwznb.com/1665235278282.2976yunhu192.png", // 分区头像url + "avatar": "https://chat-img.jwznb.com/1665235278282.2976yunhu192.png", // 分区头像 URL "delTime": 0, // 分区删除时间戳 "createTime": 1665233353, // 分区创建时间戳 "lastActive": 1757794419, // 分区上次活跃时间戳 @@ -829,7 +829,7 @@ POST /v1/community/posts/post-detail "isVip": 0 // 文章作者是否为vip，0-没有，1-有 } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -845,7 +845,7 @@ POST /v1/community/posts/my-post-list 请求体： -```JSONC +```JSON { "size": 20, // 显示文章数量 "page": 1 // 页数 @@ -854,18 +854,18 @@ POST /v1/community/posts/my-post-list 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "posts": [ // 帖子相关 { - "id": 123, // 文章id - "baId": 49, // 文章所属分区id + "id": 123, // 文章 ID + "baId": 49, // 文章所属分区 ID "senderId": "1659829", // 文章作者 "senderNicknameId": 123, // 作者名称id "senderAvatarId": 123, // 作者头像id - "groupId": "", // 文章所属群聊id + "groupId": "", // 文章所属群聊 ID "title": "test", // 文章标题 "contentType": 1, // 文章类型，1-普通文字，2-Markdown "content": "内容", // 文章内容 @@ -882,18 +882,18 @@ POST /v1/community/posts/my-post-list "amountNum": 0, // 文章投币数量 "senderNickname": "作者", // 文章作者名称 "auditStatus": 0, // 审核状态，0-通过，1-不通过 - "senderAvatar": "https://...", // 文章作者头像url + "senderAvatar": "https://...", // 文章作者头像 URL "createTimeText": "2025-09-14 10:47:58", // 文章发布时间 "group": { // 文章绑定群聊相关 "id": 0, // 文章所属群聊的类型id - "groupId": "", // 文章所属群聊id + "groupId": "", // 文章所属群聊 ID "name": "", // 群聊名称 "introduction": "", // 群聊简介 "createBy": "", // 群聊群主id "createTime": 0, // 群聊创建时间戳 - "avatarId": 0, // 群聊头像id + "avatarId": 0, // 群聊头像 ID "del_flag": 0, - "avatarUrl": "", // 群聊头像url + "avatarUrl": "", // 群聊头像 URL "headcount": 0, // 群聊人数 "readHistory": 0, // 是否开启聊天历史记录，0-没有，1-开了 "alwaysAgree": 0, // 新成员是否直接进入群聊，0-没有，1-开了 @@ -929,9 +929,9 @@ POST /v1/community/ba/group-list 请求体： -```JSONC +```JSON { - "baId": 41, //分区id + "baId": 41, //分区 ID "size": 10, // 分页大小 "page": 1 // 页数 } @@ -939,14 +939,14 @@ POST /v1/community/ba/group-list 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "groups": [ { "id": 10497, // 群聊创建id - "groupId": "554470989", // 群聊id + "groupId": "554470989", // 群聊 ID "name": "这个是群聊", // 群聊名称 "introduction": "这个是介绍", // 群聊简介 "createBy": "6016104", // 群聊创建者id(群主id) @@ -1010,7 +1010,7 @@ POST /v1/community/ba/forward 请求体： -```JSONC +```JSON { "baId": 0, "receive": [ @@ -1025,10 +1025,10 @@ POST /v1/community/ba/forward 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1044,9 +1044,9 @@ POST /v1/community/ba/manage 请求体： -```JSONC +```JSON { - "baId": 0, // 分区ID + "baId": 0, // 分区 ID "visibleRange": 0, // 分区可见状态，0-所有人可见，1-只有分区所有者可见 "publishAuthority": 0 // 分区开放度，0-所有人都可以发文章和评论，1-仅分区所有者可以发文章任何人都可以评论，2-仅分区所有者可以发文章和评论 } @@ -1054,10 +1054,10 @@ POST /v1/community/ba/manage 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1073,7 +1073,7 @@ POST /v1/community/ba/create 请求体： -```JSONC +```JSON { "name": "1111111111", // 分区名称，最多10字 "avatar": "https://..." // 分区头像 @@ -1082,13 +1082,13 @@ POST /v1/community/ba/create 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "id": 0 // 分区ID + "id": 0 // 分区 ID }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -1104,9 +1104,9 @@ POST /v1/community/ba/edit 请求体： -```JSONC +```JSON { - "baId": 0, // 分区ID + "baId": 0, // 分区 ID "name": "1111111111", // 分区名称，最多10字 "avatar": "https://..." // 分区头像 } @@ -1114,10 +1114,10 @@ POST /v1/community/ba/edit 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1133,18 +1133,18 @@ POST /v1/community/ba/delete 请求体： -```JSONC +```JSON { - "baId": 0 // 分区ID + "baId": 0 // 分区 ID } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1160,9 +1160,9 @@ POST /v1/community/posts/create-draft 请求体： -```JSONC +```JSON { - "baId": 0, // 草稿所在分区ID + "baId": 0, // 草稿所在分区 ID "title": "测试完整草稿标题", // 草稿标题 "content": "测试文章草稿内容", // 草稿内容 "contentType": 1, // 草稿类别，1-文本，2-Markdown @@ -1172,13 +1172,13 @@ POST /v1/community/posts/create-draft 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "id": 123 // 草稿ID }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -1194,26 +1194,26 @@ POST /v1/community/posts/get-draft 请求体： -```JSONC +```JSON { - "baId": 0, // 草稿所处文章分区ID，一般为0 + "baId": 0, // 草稿所处文章分区 ID，一般为0 "draftId": 123 // 草稿ID } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "posts": { // 帖子相关 - "id": 123, // 文章id - "baId": 41, // 文章所属分区id + "id": 123, // 文章 ID + "baId": 41, // 文章所属分区 ID "senderId": "123", // 文章作者 "senderNicknameId": 123, // 作者名称id "senderAvatarId": 123, // 作者头像id - "groupId": "", // 文章所属群聊id + "groupId": "", // 文章所属群聊 ID "title": "test", // 文章标题 "contentType": 1, // 文章类型，1-普通文字，2-Markdown "content": "内容", // 文章内容 @@ -1229,18 +1229,18 @@ POST /v1/community/posts/get-draft "isSticky": 0, // 置顶时间戳，若不是置顶则为0 "amountNum": 0, // 文章投币数量 "senderNickname": "作者", // 文章作者名称 - "senderAvatar": "https://...", // 文章作者头像url + "senderAvatar": "https://...", // 文章作者头像 URL "createTimeText": "2025-09-14 10:47:58", // 文章发布时间 "group": { // 文章绑定群聊相关 "id": 0, // 文章所属群聊的类型id - "groupId": "", // 文章所属群聊id + "groupId": "", // 文章所属群聊 ID "name": "", // 群聊名称 "introduction": "", // 群聊简介 "createBy": "", // 群聊群主id "createTime": 0, // 群聊创建时间戳 - "avatarId": 0, // 群聊头像id + "avatarId": 0, // 群聊头像 ID "del_flag": 0, - "avatarUrl": "", // 群聊头像url + "avatarUrl": "", // 群聊头像 URL "headcount": 0, // 群聊人数 "readHistory": 0, // 是否开启聊天历史记录，0-没有，1-开了 "alwaysAgree": 0, // 新成员是否直接进入群聊，0-没有，1-开了 @@ -1258,7 +1258,7 @@ POST /v1/community/posts/get-draft "isVip": 0 // 暂时不清楚 } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -1274,7 +1274,7 @@ POST /v1/community/posts/cancel-draft 请求体： -```JSONC +```JSON { "draftId": 123 // 草稿ID } @@ -1282,10 +1282,10 @@ POST /v1/community/posts/cancel-draft 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1301,19 +1301,19 @@ POST /v1/community/ba/user-follow-ba 请求体： -```JSONC +```JSON { - "baId": 45, // 分区id + "baId": 45, // 分区 ID "followSource": 2 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1329,18 +1329,18 @@ POST /v1/community/ba/user-unfollow-ba 请求体： -```JSONC +```JSON { - "baId": 45, // 分区id + "baId": 45, // 分区 ID } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1356,18 +1356,18 @@ POST /v1/community/posts/edit-sticky 请求体： -```JSONC +```JSON { - "postId": 45008 // 文章id（如果已经置顶了，则会取消置顶） + "postId": 45008 // 文章 ID（如果已经置顶了，则会取消置顶） } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1383,9 +1383,9 @@ POST /v1/community/ba/follower-list 请求体： -```JSONC +```JSON { - "id": 115, // 分区id + "id": 115, // 分区 ID "size": 20, // 每页显示的数量 "page": 1, // 第1页 "memberName": "" // 搜索关注者的关键词 @@ -1394,28 +1394,28 @@ POST /v1/community/ba/follower-list 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "followers": [ { "id": 11930, //关注id（应该是） - "baId": 115, // 分区id - "userId": "1234567", // 关注者用户id + "baId": 115, // 分区 ID + "userId": "1234567", // 关注者用户 ID "delTime": 0, "followSource": 2, "createTime": 1763132265, // 关注时间戳 "userLevel": 0, // 关注者等级（0-普通，2-分区管理员） "nickname": "是个人", // 关注者名称 "avatarUrl": "https://chat-img.jwznb.com/6900488d625d48ac45ba34eff5b1246c.jpg", // 关注者头像url - "vipUserid": "1234567", // 关注者vip用户id + "vipUserid": "1234567", // 关注者vip用户 ID "vipEndTime": 1765728069 // vip结束时间戳 } ], "total": 1 // 总关注者数量 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -1431,20 +1431,20 @@ POST /v1/community/ba/manage-setting 请求体： -```JSONC +```JSON { - "baId": 115, // 分区id - "userId": "1234567", // 用户id + "baId": 115, // 分区 ID + "userId": "1234567", // 用户 ID "userLevel": 2 // 关注者(用户)等级（0-普通，2-分区管理员） } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1460,27 +1460,27 @@ POST /v1/community/ba/list-by-create 请求体： -```JSONC +```JSON { - "userId": "1234567" // 用户id + "userId": "1234567" // 用户 ID } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "ba": [ { - "id": 50, // 分区id + "id": 50, // 分区 ID "name": "123", // 分区名称 - "avatar": "https://..." // 分区头像url + "avatar": "https://..." // 分区头像 URL } ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -1496,7 +1496,7 @@ POST /v1/community/posts/post-list-recommend 请求体： -```JSONC +```JSON { "size":1, // 每页的文章数量 "page":2 // 页数 @@ -1505,18 +1505,18 @@ POST /v1/community/posts/post-list-recommend 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "posts": [ { - "id": 29950, // 文章id - "baId": 41, // 文章所属分区id - "senderId": "1234567", // 文章作者id - "senderNicknameId": 127504, // 作者昵称id - "senderAvatarId": 32537, // 作者头像id - "groupId": "", // 文章所属群聊id + "id": 29950, // 文章 ID + "baId": 41, // 文章所属分区 ID + "senderId": "1234567", // 文章作者 ID + "senderNicknameId": 127504, // 作者昵称 ID + "senderAvatarId": 32537, // 作者头像 ID + "groupId": "", // 文章所属群聊 ID "title": "测试", // 文章标题 "contentType": 2, // 文章类型，1-普通文字，2-Markdown "content": "如果缺少您所在的城市，欢迎反馈添加。", // 文章部分内容 @@ -1534,7 +1534,7 @@ POST /v1/community/posts/post-list-recommend "auditStatus": 0, // 审核状态 "delBy": "", "senderNickname": "昵称", // 作者昵称 - "senderAvatar": "https://chat-img.jwznb.com/xxx.jpg", // 作者头像url + "senderAvatar": "https://chat-img.jwznb.com/xxx.jpg", // 作者头像 URL "createTimeText": "", "group": { "id": 0, @@ -1571,6 +1571,6 @@ POST /v1/community/posts/post-list-recommend ], "total": 3933 // 总文章数量 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` diff --git a/src/api/v1/conversation.md b/src/api/v1/conversation.md index 7b172de0..bca40e63 100644 --- a/src/api/v1/conversation.md +++ b/src/api/v1/conversation.md @@ -17,18 +17,18 @@ POST /v1/conversation/dismiss-notification 请求体: -```JSONC +```JSON { - "chatId": "123" // 用户/机器人/群组ID + "chatId": "123" // 用户/机器人/群组 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 返回状态码,1为正常 - "msg": "success" // 返回信息 + "code": 1, + "msg": "success" } ``` @@ -45,10 +45,10 @@ POST /v1/conversation/list 请求体 ```ProtoBuf -md5: "123123" // 上次获取对话列表的md5，如果与服务器一致则返回空列表 +md5: "123123" // 上次获取对话列表的 md5，如果与服务器一致则返回空列表 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 请求标识符 @@ -63,41 +63,41 @@ message address_book_list_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } data { - chat_id: "7356666" // 对象ID - chat_type: 1 // 对象类型,1-用户 2-群聊 3-机器人 + chat_id: "7356666" // 对象 ID + chat_type: 1 // 对象类型: 1-用户 2-群聊 3-机器人 remark: "测试" // 备注名称 chat_content: "我信(" // 会话内容 timestamp_ms: 1755566778727 // 加入对话列表时间戳(毫秒) unread_message: 1 // 是否存在未读消息 - at: 1 // 是否被@,1表示被@ - avatar_id: 12345 // 头像ID - avatar_url: "https://chat-img.jwznb.com/..." // 头像URL - do_not_disturb: 1 // 免打扰,1表示开启 + at: 1 // 是否被 @,1 表示被 @ + avatar_id: 12345 // 头像 ID + avatar_url: "https://chat-img.jwznb.com/..." // 头像 URL + do_not_disturb: 1 // 免打扰,1 表示开启 send_timestamp: 1755566778 // 消息发送时间戳(秒) at_data { - unknown: 123456 // 似乎是名称ID - mentioned_id: "7356666" // 被@的ID + unknown: 123456 // 似乎是名称 ID + mentioned_id: "7356666" // 被@的 ID mentioned_name: "测试" // 被@人名称 - mentioned_in: "8826666" // @消息所属的对话ID,例如群ID - mentioner_id: "8827777" // 发起@的对象的ID + mentioned_in: "8826666" // @消息所属的对话 ID,例如群 ID + mentioner_id: "8827777" // 发起@的对象的 ID mentioner_name: "测试" // 发起@的对象的名称 msg_seq: 1234 // 消息序列 } name: "测试"; // 用户真实名称 - certification_level: 1 // 认证相关,1是官方,2是地区 + certification_level: 1 // 认证相关,1 是官方,2 是地区 } // ... total: 8 // 会话数目 -md5: "abcdef" // 对话列表的md5 +md5: "abcdef" // 对话列表的 md5 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 列出对话 @@ -105,30 +105,30 @@ message list { Status status = 1; repeated Data data = 2; uint64 total = 3; // 列表中对话的数量 - string md5 = 4; // 对话列表的md5 + string md5 = 4; // 对话列表的 md5 message Data { - string chat_id = 1; // 对象ID + string chat_id = 1; // 对象 ID uint64 chat_type = 2; // 对象类型 string remark = 3; // 备注名称 string chat_content = 4; // 消息内容 uint64 timestamp_ms = 5; // 加入对话列表时间戳(毫秒) uint64 unread_message = 6; // 1表示有未读消息 uint64 at = 7; // 是否被@ - uint64 avatar_id = 8; // 头像ID - string avatar_url = 9; // 头像URL + uint64 avatar_id = 8; // 头像 ID + string avatar_url = 9; // 头像 URL uint64 do_not_disturb = 11; // 免打扰 uint64 send_timestamp = 12; // 消息发送时间戳(秒) At_data at_data = 14; // @数据 string name = 15; // 用户真实名称 - uint64 certification_level = 16; // 认证,1是官方 2是地区 + uint64 certification_level = 16; // 认证,1 是官方 2 是地区 message At_data { - uint64 unknown = 1; // 似乎是名称ID - string mentioned_id = 2; // 被@的ID,感觉没啥用 + uint64 unknown = 1; // 似乎是名称 ID + string mentioned_id = 2; // 被@的 ID,感觉没啥用 string mentioned_name = 3; // 被@的名称,感觉也没啥用 - string mentioned_in = 4; // @消息所属的对话ID(例如群ID),感觉还没啥用 - string mentioner_id = 6; // 发起@的对象ID + string mentioned_in = 4; // @消息所属的对话 ID(例如群 ID),感觉还没啥用 + string mentioner_id = 6; // 发起@的对象 ID string mentioner_name = 7; // 发起@对象的名称 uint64 msg_seq = 8; // 发起@的消息序列 } @@ -150,18 +150,18 @@ POST /v1/conversation/sort-change 请求体: -```JSONC +```JSON { - "userId": "123" // 对象ID + "userId": "123" // 对象 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 返回状态码,1为正常 - "msg": "success" // 返回信息 + "code": 1, + "msg": "success" } ``` @@ -177,17 +177,17 @@ POST /v1/conversation/remove 请求体: -```JSONC +```JSON { - "chatId": "123" // 用户/机器人/群组ID + "chatId": "123" // 对象 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 返回状态码,1为正常 - "msg": "success" // 返回信息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/disk.md b/src/api/v1/disk.md index 6d0efbce..f1609bdc 100644 --- a/src/api/v1/disk.md +++ b/src/api/v1/disk.md @@ -17,21 +17,21 @@ POST /v1/disk/create-folder 请求体: -```JSONC +```JSON { - "chatId": "群聊id", // 群聊id + "chatId": "群聊id", // 群聊 id "chatType": 2, // 会话类型 "folderName": "文件名", - "parentFolderId": 0 // 父文件夹id + "parentFolderId": 0 // 父文件夹 id } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -47,32 +47,32 @@ POST /v1/disk/file-list 请求体: -```JSONC +```JSON { - "chatId": "群聊id", + "chatId": "群聊 id", "chatType": 2, // 会话类型 - "folderId": 0, // 文件夹id（在根目录就是0） + "folderId": 0, // 文件夹 id（在根目录就是 0） "sort": "name_asc" // 排序 } ``` 响应体: -```JSONC +```JSON { "code": 1, "data": { "list": [ { - "id": 1818, // 文件id + "id": 1818, // 文件 id "name": "114514", // 文件名称 "fileSize": 0, // 文件大小 "objectType": 1, // 对象类型 "uploadTime": 1754534188, // 更新时间 - "uploadBy": "114514", // 上传者id + "uploadBy": "114514", // 上传者 id "uploadByName": "上传者名称", "qiniuKey": "" // 七牛云密钥 - } + }, // ... ] }, @@ -92,29 +92,31 @@ POST /v1/disk/file-size 请求体: -```JSONC +```JSON { - "chatId": "群聊id", + "chatId": "群聊 id", "chatType": 2, // 会话类型 } ``` 响应体: -```JSONC +```JSON { "code": 1, "data": { "totalSize": 0 // 群网盘总占用大小（单位：B） }, - "msg": "success" // 返回消息 + "msg": "success" } ``` -## 上传文件（需搭配[获取上传文件token](/api/v1/misc.html#%E8%8E%B7%E5%8F%96%E5%8A%9F%E8%83%BD%E8%B7%AF%E7%94%B1)使用） +## 上传文件 POST /v1/disk/upload-file +需搭配[获取上传文件token](/api/v1/misc.html#%E8%8E%B7%E5%8F%96%E5%8A%9F%E8%83%BD%E8%B7%AF%E7%94%B1)使用. + 请求头: | 名称 | 必须 | 备注 | @@ -123,25 +125,25 @@ POST /v1/disk/upload-file 请求体: -```JSONC +```JSON { - "chatId": "群聊id", + "chatId": "群聊 id", "chatType": 2, // 会话类型 - "fileSize": 124080, // 文件大小（单位是KB） + "fileSize": 124080, // 文件大小（单位是 KB） "fileName": "1114514.png", // 文件名 - "fileMd5": "6b14eab6a86c93c802de85e09561cb5c.png", // 文件的md5+文件拓展名（你的文件上传到云端文件名就是“文件的md5.文件拓展名”） + "fileMd5": "6b14eab6a86c93c802de85e09561cb5c.png", // 文件的 md5+文件拓展名（你的文件上传到云端文件名就是“文件的 md5.文件拓展名”） "fileEtag": "FqhRXAMU8qSP_omDntW7D6BUk50q", // Etag - "qiniuKey": "disk/6b14eab6a86c93c802de85e09561cb5c.png", // 七牛云key（目测在七牛云文件的路径） - "folderId": 0 // 文件夹id（在根目录就是0） + "qiniuKey": "disk/6b14eab6a86c93c802de85e09561cb5c.png", // 七牛云 key（目测在七牛云文件的路径） + "folderId": 0 // 文件夹 id（在根目录就是 0） } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -157,9 +159,9 @@ POST /v1/disk/rename 请求体: -```JSONC +```JSON { - "id": 123, // 文件ID + "id": 123, // 文件 ID "objectType": 2, // 文件类型（1-文件夹, 2-文件） "name": "测试文件名称" // 文件名称 } @@ -167,10 +169,10 @@ POST /v1/disk/rename 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -186,18 +188,18 @@ POST /v1/disk/remove 请求体: -```JSONC +```JSON { - "id": 123, // 文件ID + "id": 123, // 文件 ID "objectType": 2, // 文件类型（1-文件夹, 2-文件） } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/event.md b/src/api/v1/event.md index cceb7132..f2556dcc 100644 --- a/src/api/v1/event.md +++ b/src/api/v1/event.md @@ -17,32 +17,32 @@ POST /v1/event/list 请求体： -```JSONC +```JSON { - "botId": "123" // 机器人id + "botId": "123" // 机器人 id } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": { - "id": 123, // 列表ID - "botId": "123", // 机器人ID - "messageReceiveNormal": 1, // 推送普通信息事件，0-不推送，1-推送 - "messageReceiveInstruction": 1, // 推送指令信息事件，0-不推送，1-推送 - "groupJoin": 0, // 推送加入群事件，0-不推送，1-推送 - "groupLeave": 0, // 推送退出群事件，0-不推送，1-推送 - "botFollowed": 0, // 推送关注机器人事件，0-不推送，1-推送 - "botUnfollowed": 0, // 推送取关机器人事件，0-不推送，1-推送 - "botSetting": 0, // 推送机器人信息设置事件，0-不推送，1-推送 - "del_flag": 0 // 删除flag标签 + "id": 123, // 列表 ID + "botId": "123", // 机器人 ID + "messageReceiveNormal": 1, // 推送普通信息事件: 0-不推送，1-推送 + "messageReceiveInstruction": 1, // 推送指令信息事件: 0-不推送，1-推送 + "groupJoin": 0, // 推送加入群事件: 0-不推送，1-推送 + "groupLeave": 0, // 推送退出群事件: 0-不推送，1-推送 + "botFollowed": 0, // 推送关注机器人事件: 0-不推送，1-推送 + "botUnfollowed": 0, // 推送取关机器人事件: 0-不推送，1-推送 + "botSetting": 0, // 推送机器人信息设置事件: 0-不推送，1-推送 + "del_flag": 0 // 删除标签 } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -58,25 +58,25 @@ POST /v1/event/edit 请求体： -```JSONC +```JSON { - "botId": "75282754", // 机器人id - "messageReceiveNormal": 1, // 普通消息事件，1开启，0-关闭 - "messageReceiveInstruction": 0, // 指令消息事件，1开启，0-关闭 - "botFollowed": 1, // 关注机器人事件，1开启，0-关闭 - "botUnfollowed": 1, // 取关机器人事件，1开启，0-关闭 - "groupJoin": 1, // 加入群事件，1开启，0-关闭 - "groupLeave": 1, // 退出群事件，1开启，0-关闭 - "botSetting": 1, // 机器人设置消息事件，1开启，0-关闭 - "typ": "messageReceiveInstruction" // 每次机器人设置的key值，为该请求2-8的key值中的一个 + "botId": "75282754", // 机器人 id + "messageReceiveNormal": 1, // 普通消息事件: 1开启，0-关闭 + "messageReceiveInstruction": 0, // 指令消息事件: 1开启，0-关闭 + "botFollowed": 1, // 关注机器人事件: 1开启，0-关闭 + "botUnfollowed": 1, // 取关机器人事件: 1开启，0-关闭 + "groupJoin": 1, // 加入群事件: 1开启，0-关闭 + "groupLeave": 1, // 退出群事件: 1开启，0-关闭 + "botSetting": 1, // 机器人设置消息事件: 1开启，0-关闭 + "typ": "messageReceiveInstruction" // 每次机器人设置的 key 值，为该请求 2-8 的 key 值中的一个 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/expression.md b/src/api/v1/expression.md index 2762edef..986a6039 100644 --- a/src/api/v1/expression.md +++ b/src/api/v1/expression.md @@ -17,7 +17,7 @@ POST /v1/expression/list 响应体: -```JSONC +```JSON { "code": 1, "data": { @@ -25,10 +25,10 @@ POST /v1/expression/list { "id": 114514, "url": "expression/abcdef123456789abcdef123456789ab.jpg", // 需要前面加上 https://chat-img.jwznb.com/ - "urlOriginal": "https://chat-img.jwznb.com/123456789abcdefabcf43bce54e4e242.jpg", // 来源URL + "urlOriginal": "https://chat-img.jwznb.com/123456789abcdefabcf43bce54e4e242.jpg", // 来源 URL "delFlag": 0, "createTime": 114514, // 创建时间戳 - "createBy": "7356666" // 创建者ID + "createBy": "7356666" // 创建者 ID } ] }, @@ -48,18 +48,18 @@ POST /v1/expression/create 请求体: -```JSONC +```JSON { - "url": "https://chat-img.jwznb.com/......" // 图片URL + "url": "https://chat-img.jwznb.com/......" // 图片 URL } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 状态码，正常为1 - "msg": "success" // 状态信息 + "code": 1, + "msg": "success" } ``` @@ -75,18 +75,18 @@ POST /v1/expression/delete 请求体: -```JSONC +```JSON { - "id": 114514 // // 要删除的表情ID + "id": 114514 // // 要删除的表情 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 状态码，正常为1 - "msg": "success" // 状态信息 + "code": 1, + "msg": "success" } ``` @@ -102,18 +102,18 @@ POST /v1/expression/topping 请求体: -```JSONC +```JSON { - "id": 114514 // 要置顶的表情ID + "id": 114514 // 要置顶的表情 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 状态码，正常为1 - "msg": "success" // 状态信息 + "code": 1, + "msg": "success" } ``` @@ -129,17 +129,17 @@ POST /v1/expression/add 请求体: -```JSONC +```JSON { - "id": 123 // 表情ID + "id": 123 // 表情 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 状态码，正常为1 - "msg": "success" // 状态信息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/file.md b/src/api/v1/file.md index fb53795a..2322c4a5 100644 --- a/src/api/v1/file.md +++ b/src/api/v1/file.md @@ -17,17 +17,17 @@ POST /v1/file/send 请求体: -```JSONC +```JSON { - "userId": "123", // 目标用户ID - "deviceId": "123", // 目标用户指定分享的设备ID，为空则为发送给目标用户的所有设备 - "fileData": "{}" // 文件分享数据，格式为json转义 + "userId": "123", // 目标用户 ID + "deviceId": "123", // 目标用户指定分享的设备 ID，为空则为发送给目标用户的所有设备 + "fileData": "{}" // 文件分享数据，格式为 json 转义 } ``` ::: fileData属性，json数据格式 -```JSONC +```JSON { "path": "C:\\Windows\\test.exe", // 文件原始目录 "size": 5774088, // 文件大小 @@ -35,7 +35,7 @@ POST /v1/file/send "isDirectory": 0, // 未知 "count": 1, // 未知 "current": 1, // 未知 - "uuid": "123123123123123123" // 文件分享uuid，应该是随机的，可以随便写 + "uuid": "123123123123123123" // 文件分享 uuid，应该是随机的，可以随便写 } ``` @@ -43,10 +43,10 @@ POST /v1/file/send 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -62,21 +62,21 @@ POST /v1/file/reply 请求体: -```JSONC +```JSON { - "deviceId": "123123123123", // 拒绝请求的设备ID + "deviceId": "123123123123", // 拒绝请求的设备 ID "isAccept": "0", // 未知 - "userId": "123", // 拒绝请求的用户ID + "userId": "123", // 拒绝请求的用户 ID "fileData": "" // 未知 } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -92,20 +92,20 @@ POST /v1/file/offer 请求体: -```JSONC +```JSON { - "deviceId": "123", // 目标用户指定分享的设备ID - "description": "{}", // 连接协议，为json格式数据转义，未完成 + "deviceId": "123", // 目标用户指定分享的设备 ID + "description": "{}", // 连接协议，为 json 格式数据转义，未完成 "userId": "123", //目标用户ID - "sessionId": "123123123123123123123" // 连接请求标识ID，应该是随机的，可以随便写 + "sessionId": "123123123123123123123" // 连接请求标识 ID，应该是随机的，可以随便写 } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/friend.md b/src/api/v1/friend.md index a9c71eb8..22af5f74 100644 --- a/src/api/v1/friend.md +++ b/src/api/v1/friend.md @@ -19,20 +19,20 @@ POST /v1/friend/apply ### 请求体 -```JSONC +```JSON { - "chatId": "123", // 目标对象ID - "chatType": 2, // 目标对象类别，1-用户，2-群聊，3-机器人 + "chatId": "123", // 目标对象 ID + "chatType": 2, // 目标对象类别: 1-用户，2-群聊，3-机器人 "remark": "测试申请简介" // 申请简介 } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常，-1为群聊不存在，-9为已在群聊中 - "msg": "success" // 返回消息 + "code": 1, // 请求状态码，1 为正常，-1 为群聊不存在，-9 为已在群聊中 + "msg": "success" } ``` @@ -40,7 +40,7 @@ POST /v1/friend/apply 群主无法退群，会响应: -```JSONC +```JSON { "code": -1, "msg": "群主不可退群，请先转移群聊" @@ -63,19 +63,19 @@ POST /v1/friend/delete-friend ### 请求体 -```JSONC +```JSON { - "chatId": "123", // 目标对象ID - "chatType": 2, // 目标对象类别，1-用户，2-群聊，3-机器人 + "chatId": "123", // 目标对象 ID + "chatType": 2, // 目标对象类别: 1-用户，2-群聊，3-机器人 } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -93,19 +93,19 @@ POST /v1/friend/agree-apply ### 请求体 -```JSONC +```JSON { - "id": 123, // 申请ID + "id": 123, // 申请 ID "agree": 1 // 1-通过请求，2-拒绝请求，3-显示请求过期，4-显示已解散 } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -123,19 +123,19 @@ POST /v1/friend/ignore-apply ### 请求体 -```JSONC +```JSON { - "id": 123, // 申请ID + "id": 123, // 申请 ID "ignore": 1 } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -154,10 +154,10 @@ POST /v1/friend/address-book-list ### 请求体 ```ProtoBuf -md5: "123123" // 上次获取通讯录的md5，如果与服务器一致则返回空列表 +md5: "123123" // 上次获取通讯录的 md5，如果与服务器一致则返回空列表 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 请求标识符 @@ -172,27 +172,27 @@ message address_book_list_send { ```ProtoBuf status { - number: 114514 - code: 1 // 请求状态码，1为正常 - msg: "success" // 返回消息 + request_id: 114514 + code: 1 + msg: "success" } data { list_name: "测试聊天对象列表名称" // 聊天对象列表名称，为"用户"，"我加入的群聊"，"机器人" data: { - chat_id: "123" // 聊天对象ID + chat_id: "123" // 聊天对象 ID chat_name: "测试聊天对象名称" // 聊天对象名称 - chat_avatar_url: "https://..." // 聊天对象头像url - permisson_level: 2 // 群权限等级(普通用户无此项(数值为0或无此项),群主100,管理员2),只有群列表才有此项 + chat_avatar_url: "https://..." // 聊天对象头像 url + permisson_level: 2 // 群权限等级(普通用户无此项(数值为 0 或无此项),群主 100,管理员 2),只有群列表才有此项 temp_text1 = 1 // 未知 chat_name_up: "测试聊天对象名称" // 聊天对象名称 } chat_type: 1 - // ...单个列表输出完成后，连带list_name和chat_type一起重复 + // ...单个列表输出完成后，连带 list_name 和 chat_type 一起重复 } -md5: "123123" // 通讯录的md5 +md5: "123123" // 通讯录的 md5 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 聊天对话列表 @@ -209,10 +209,10 @@ message address_book_list { // 聊天对象数据 message Data_list { - string chat_id = 1; // 聊天对象ID + string chat_id = 1; // 聊天对象 ID string remark = 2; // 聊天对象备注名称 - string avatar_url = 3; // 聊天对象头像url - int32 permisson_level = 4; // 群权限等级(普通用户无此项(数值为0或无此项),群主100,管理员2),只有群列表才有此项 + string avatar_url = 3; // 聊天对象头像 url + int32 permisson_level = 4; // 群权限等级(普通用户无此项(数值为 0 或无此项),群主 100,管理员 2),只有群列表才有此项 bool noDisturb = 5; // 免打扰 //int32 field6 = 6; // 未知 string name = 8; // 聊天对象真实名称 @@ -239,9 +239,9 @@ POST /v1/friend/request-list ```ProtoBuf status { - number: 114514 - code: 1 // 请求状态码，1为正常 - msg: "success" // 返回消息 + request_id: 114514 + code: 1 + msg: "success" } requests { receiverName: "测试接收者名称" // 接收者名称 @@ -250,16 +250,16 @@ requests { avatar: "https://..." // 请求方头像 groupName: "测试群组名称" // 群组名称 groupAvata: "https://..." // 群组头像 - inviterId: "123" // 邀请者ID (字段8同此含义) + inviterId: "123" // 邀请者 ID (字段8同此含义) ourceType: 1 // 来源类型 targetType: 1 // 目标类型 - targetId: "123" // 目标ID - receiverId: "123" // 接收者ID + targetId: "123" // 目标 ID + receiverId: "123" // 接收者 ID result: 0 // 处理结果 processedAt: 1231231230 // 处理时间戳 inviteAt: 1231231230 // 邀请时间戳 inviteAtStr: "1231-23-12 31:23:00" // 邀请时间字符串 - requestI: 123; // 请求ID + requestI: 123; // 请求 ID botName: "测试机器人名称" // 机器人名称 botAvatar: "https://..." // 机器人头像 processorName: "测试处理者名称" // 处理者名称 @@ -269,7 +269,7 @@ total: 1 // 总请求数 pending: 0 // 待处理请求数 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 对象请求列表 @@ -282,16 +282,16 @@ message Response { string avatar = 4; // 请求方头像 string groupName = 5; // 群组名称 string groupAvatar = 6; // 群组头像 - string inviterId = 7; // 邀请者ID (字段8同此含义) + string inviterId = 7; // 邀请者 ID (字段8同此含义) int32 sourceType = 9; // 来源类型 int32 targetType = 10; // 目标类型 - string targetId = 11; // 目标ID - string receiverId = 12; // 接收者ID + string targetId = 11; // 目标 ID + string receiverId = 12; // 接收者 ID int32 result = 13; // 处理结果 int64 processedAt = 14; // 处理时间戳 int64 inviteAt = 16; // 邀请时间戳 string inviteAtStr = 17; // 邀请时间字符串 - int32 requestId = 18; // 请求ID + int32 requestId = 18; // 请求 ID string botName = 19; // 机器人名称 string botAvatar = 20; // 机器人头像 string processorName = 22; // 处理者名称 @@ -319,19 +319,19 @@ POST /v1/friend/no-notify ### 请求体 -```JSONC +```JSON { - "chatId": "118738312", // 会话ID + "chatId": "118738312", // 会话 ID "noNotify": 0 // 0-取消免打扰，1-设置免打扰 } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -349,7 +349,7 @@ POST /v1/friend/delete-request ### 请求体 -```JSONC +```JSON { "id": 123 // 请求ID } @@ -357,9 +357,9 @@ POST /v1/friend/delete-request ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/group-tag.md b/src/api/v1/group-tag.md index 0ab3513a..c690716a 100644 --- a/src/api/v1/group-tag.md +++ b/src/api/v1/group-tag.md @@ -17,25 +17,25 @@ POST /v1/group-tag/list 请求体: -```JSONC +```JSON { - "groupId": "123456789", //要获取的群聊ID - "size": 20,// 页面总数 - "page": 1,//页码 - "tag": ""// 搜索词语 + "groupId": "123456789", //要获取的群聊 ID + "size": 20, // 页面总数 + "page": 1, // 页码 + "tag": "" // 搜索词语 } ``` 响应体: -```JSONC +```JSON { "code": 1, "data": { "list": [ { - "id": 1234, // 标签ID - "groupId": "123456789", // 群聊ID + "id": 1234, // 标签 ID + "groupId": "123456789", // 群聊 ID "tag": "一个标签", // 标签名称 "color": "#E91E63", // 标签颜色 "desc": "", // 描述 @@ -61,19 +61,19 @@ POST /v1/group-tag/relate 请求体: -```JSONC +```JSON { - "userId": "1234567", // 要关联的用户ID - "tagGroupId": 1145 // 要关联的标签ID + "userId": "1234567", // 要关联的用户 ID + "tagGroupId": 1145 // 要关联的标签 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -89,19 +89,19 @@ POST /v1/group-tag/relate-cancel 请求体: -```JSONC +```JSON { - "userId": "1234567", // 要关联的用户ID - "tagGroupId": 1145 // 要关联的标签ID + "userId": "1234567", // 要关联的用户 ID + "tagGroupId": 1145 // 要关联的标签 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -117,10 +117,10 @@ POST /v1/group-tag/edit 请求体: -```JSONC +```JSON { - "id": 1234, // 要更改的标签ID - "groupId": "123456789", // 要更改的标签所在的群聊ID + "id": 1234, // 要更改的标签 ID + "groupId": "123456789", // 要更改的标签所在的群聊 ID "tag": "一个标签", // 标签名称 "color": "#E91E63", // 标签颜色 "desc": "", //，标签描述 @@ -130,10 +130,10 @@ POST /v1/group-tag/edit 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -149,9 +149,9 @@ POST /v1/group-tag/create 请求体： -```JSONC +```JSON { - "groupId": "123456789", // 要创建标签的群聊ID + "groupId": "123456789", // 要创建标签的群聊 ID "tag": "标签名称", // 标签名称 "color": "#2196F3", // 标签颜色 "desc": "", // 标签描述 @@ -162,10 +162,10 @@ POST /v1/group-tag/create 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -181,18 +181,18 @@ POST /v1/group-tag/delete 请求体: -```JSONC +```JSON { - "id": 1234 // 要删除的标签ID + "id": 1234 // 要删除的标签 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -213,11 +213,11 @@ data { size: 50 // 分页大小 page: 1 // 页数 } -group_id: "123" // 群聊ID -tag_id: 123 // 标签ID +group_id: "123" // 群聊 ID +tag_id: 123 // 标签 ID ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message tag_member_send { @@ -226,8 +226,8 @@ message tag_member_send { int32 size = 1; // 分页大小 int32 page = 2; // 页数 } - string group_id = 3; // 标签所处群聊ID - int64 tag_id = 4; // 标签ID + string group_id = 3; // 标签所处群聊 ID + int64 tag_id = 4; // 标签 ID } ``` @@ -237,26 +237,26 @@ message tag_member_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } user { - group_id: "big" // 所属群聊ID + group_id: "big" // 所属群聊 ID user_info { - user_id: "123" // 用户ID + user_id: "123" // 用户 ID name: "测试用户名" // 用户名 - avatar_url: "https://..." // 头像URL - int32 is_vip: 0 // 是否为vip，0-非vip用户，1-vip用户 + avatar_url: "https://..." // 头像 URL + int32 is_vip: 0 // 是否为 vip: 0-非 vip 用户，1-vip 用户 } - permission_level: 0 // 权限等级, 群主100 管理员2 普通用户无/0 + permission_level: 0 // 权限等级, 群主 100 管理员 2 普通用户无/0 gag_time: 123 // 禁言时间戳 is_gag: 0; // 是否被禁言，0-未被禁言，1-已被禁言 } total: 1 // 总数 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 标签绑定的用户列表 @@ -273,7 +273,7 @@ message tag_member { string avatar_url = 4; int32 is_vip = 6; } - int32 permission_level = 3; // 权限等级, 群主100 管理员2 普通用户无/0 + int32 permission_level = 3; // 权限等级, 群主 100 管理员 2 普通用户无/0 int64 gag_time = 4; // 禁言时间戳 int32 is_gag = 5; // 是否被禁言 } diff --git a/src/api/v1/group.md b/src/api/v1/group.md index e512e0d5..c0c33551 100644 --- a/src/api/v1/group.md +++ b/src/api/v1/group.md @@ -18,7 +18,7 @@ POST /v1/group/info | token | 是 | 无 | ::: warning -此处响应数据部分项目需要在打开相应开关后才会出现,例如private必须打开群聊私有才能在响应数据中看到. +此处响应数据部分项目需要在打开相应开关后才会出现,例如 private 必须打开群聊私有才能在响应数据中看到. ::: ### 请求体 @@ -27,7 +27,7 @@ POST /v1/group/info group_id: "123123" // 群聊 ID ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message info_send { @@ -41,61 +41,61 @@ message info_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } data { - id: "123" //群聊ID + id: "123" //群聊 ID name: "测试群聊" // 群聊名称 - avatar_url: "https://..." // 头像url - avatar_id: 123 // 头像ID + avatar_url: "https://..." // 头像 url + avatar_id: 123 // 头像 ID introduction: "测试群聊" // 群聊简介 member: 123 // 群人数 - create_by: "123" // 创建者ID + create_by: "123" // 创建者 ID direct_join: 0 // 进群免审核,1为开启 - permisson_level: 2 // 权限等级(普通用户无此项(数值为0或无此项),群主100,管理员2) + permisson_level: 2 // 权限等级(普通用户无此项(数值为0或无此项),群主 100,管理员 2) history_msg: 1 // 历史消息,1为开启 category_name: "无" // 分类名 - category_id: 40 // 分类ID - private: 0 // 是否私有,1为私有 - do_not_disturb: 1 // 免打扰,1为开启 - community_id: 123 // 加入社区的ID + category_id: 40 // 分类I D + private: 0 // 是否私有,1 为私有 + do_not_disturb: 1 // 免打扰,1 为开启 + community_id: 123 // 加入社区的 ID community_name: "云湖" // 加入社区的名称 - top: 0 // 置顶会话,1为开启 - admin: "123" // 管理员ID,可以有多个 + top: 0 // 置顶会话,1 为开启 + admin: "123" // 管理员 ID,可以有多个 create_time: 1231231230 // 群聊创建时间 limited_msg_type: "" // 被限制的消息类型,如1,2,3,使用","分格 - owner: "123" // 群主ID - recommandation: 1 // 是否加入群推荐,1为开启 + owner: "123" // 群主 ID + recommandation: 1 // 是否加入群推荐,1 为开启 tag_old: "冲刺一百万用户！" // 标签 tag { - id: 123 // 标签id + id: 123 // 标签 id text: "" // 标签文字 color: "#FFFFFFFF" // 标签颜色 } my_group_nickname: "12345" // 我的群昵称 group_code: "test1234" // 群口令 - hide_group_members: 1 // 隐藏群成员（开启时为1） + hide_group_members: 1 // 隐藏群成员（开启时为 1） auto_delete_message: 730 // 消息自动销毁时间（0-永久不删，90-2个月后删除，365-1年后删除，730-2年后删除） deny_members_upload_to_group_disk: 1 // 禁止群成员上传文件到群云盘（开启时为1） } history_bot { - id: "123" // 机器人ID + id: "123" // 机器人 ID name: "测试" // 机器人名称 name_id: 123 // 机器人名称的序列(数据库中第N个用户/机器人/群组) - avatar_url: "https://..." // 头像URL - avatar_id: 123 // 头像ID + avatar_url: "https://..." // 头像 URL + avatar_id: 123 // 头像 ID introduction: "测试机器人" // 机器人简介 - create_by: "123" // 创建者ID + create_by: "123" // 创建者 ID create_time: 1231231230 // 创建时间戳 user_number: 123 // 使用人数 - private: 1 // 1表示私有机器人. + private: 1 // 1 表示私有机器人. } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 群聊信息 @@ -109,7 +109,7 @@ message info { string group_id = 1; string name = 2; string avatar_url = 3; - uint64 avatar_id = 4; // 头像ID + uint64 avatar_id = 4; // 头像 ID string introduction = 5; uint64 member = 6; // 群人数 string create_by = 7; @@ -117,7 +117,7 @@ message info { uint64 permisson_level = 9; // 权限等级 uint64 history_msg = 10; // 历史消息 string category_name = 11; // 分类名 - uint64 category_id = 12; // 分类ID + uint64 category_id = 12; // 分类 ID uint64 private = 13; // 是否为私有群聊 uint64 do_not_disturb = 14; // 免打扰 uint64 community_id = 15; @@ -132,13 +132,13 @@ message info { repeated Tag tag = 27; string my_group_nickname = 28; // 我的群昵称 string group_code = 29; // 群口令 - uint64 hide_group_members = 30; // 隐藏群成员（开启时为1） + uint64 hide_group_members = 30; // 隐藏群成员（开启时为 1） uint64 auto_delete_message = 32; // 消息自动销毁时间 - uint64 deny_members_upload_to_group_disk = 33; // 禁止群成员上传文件到群云盘（开启时为1） + uint64 deny_members_upload_to_group_disk = 33; // 禁止群成员上传文件到群云盘（开启时为 1） // 已使用标签信息,2没啥用不解析了 message Tag { - uint64 id = 1; // 标签ID(貌似) + uint64 id = 1; // 标签 ID (貌似) string text = 3; string color = 4; } @@ -181,11 +181,11 @@ data { size: 50 // 分页大小 page: 1 // 页数 } -group_id: "big" // 群聊ID +group_id: "big" // 群聊 ID keywords: "测试群成员" // 搜索关键词 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message list_member_send { @@ -196,7 +196,7 @@ message list_member_send { int32 page = 2; // 页数 } - string group_id = 3; // 群聊ID + string group_id = 3; // 群聊 ID string keywords = 4; // 搜索关键词 } ``` @@ -207,20 +207,20 @@ message list_member_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } user { - group_id: "big" // 所属群聊ID + group_id: "big" // 所属群聊 ID user_info { - user_id: "7356666" // 用户ID + user_id: "7356666" // 用户 ID name: "Feng" // 用户名 - avatar_url: "https://..." // 头像URL - is_vip: 0 // 是否为vip用户, 0-不为vip用户, 1-vip用户 + avatar_url: "https://..." // 头像 URL + is_vip: 0 // 是否为 vip 用户,: 0-非 vip 用户, 1-vip 用户 } - permission_level: 100 // 权限等级, 群主100 管理员2 普通用户无/0 + permission_level: 100 // 权限等级, 群主 100 管理员 2 普通用户无/0 gag_time: 123456 // 禁言时间戳 is_gag: 0 // 是否处于禁言状态 } @@ -228,7 +228,7 @@ user { // ... ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message list_member { @@ -269,35 +269,35 @@ POST /v1/group/live-room ### 请求体 -```JSONC +```JSON { - "groupId": "123" // 群聊id + "groupId": "123" // 群聊 id } ``` ### 响应数据 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "rooms": [ { - "userId": "123", // 房间管理员用户ID - "roomId": "123", // 房间ID - "chatId": "123", // 房间所属对象ID + "userId": "123", // 房间管理员用户 ID + "roomId": "123", // 房间 ID + "chatId": "123", // 房间所属对象 ID "title": "测试房间", // 房间名称 "chatType": 2, // 房间所属对象类别，一般为2-群聊 "status": 0, // 房间状态码 - "createBy": "123", // 房间创建用户ID + "createBy": "123", // 房间创建用户 ID "createTime": 1231231230, //房间创建时间戳 "nickname": "测试用户", // 房间创建用户名称 "count": 123, // 房间内人数 - "avatarUrl": "https://..." // 房间头像url + "avatarUrl": "https://..." // 房间头像 url } ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -315,7 +315,7 @@ POST /v1/group/instruction-list ### 请求体 -```JSONC +```JSON { "groupId": "big" // 目标群聊 } @@ -323,24 +323,24 @@ POST /v1/group/instruction-list ### 响应数据 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "instructions": [ { - "botId": "123", // 机器人ID + "botId": "123", // 机器人 ID "botName": "测试机器人", // 机器人名称 "name": "测试指令", // 指令名称 "desc": "测试指令简介", // 指令简介 - "id": 123, // 指令ID + "id": 123, // 指令 ID "sort": 0, // 未知 - "auth": 0 // 可用状态，0-所有人可用，1-所有人禁用，2-群主可用，3-群主管理员可用 + "auth": 0 // 可用状态: 0-所有人可用，1-所有人禁用，2-群主可用，3-群主管理员可用 }, // ... ] }, - "msg": "success" // 返回状态消息 + "msg": "success" } ``` @@ -358,9 +358,9 @@ POST /v1/group/invite ### 请求体 -```JSONC +```JSON { - "chatId": "123", // 邀请成员ID，必须为目标用户token已添加的token + "chatId": "123", // 邀请成员 ID，必须添加目标对象为好友 "chatType": 1, // 邀请成员类别，1-用户，3-机器人 "groupId": "123" // 目标群聊 } @@ -368,10 +368,10 @@ POST /v1/group/invite ### 响应数据 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -389,19 +389,19 @@ POST /v1/group/remove-member ### 请求体 -```JSONC +```JSON { - "groupId": "123", // 目标群聊ID - "userId": "123" // 踢出用户ID + "groupId": "123", // 目标群聊 ID + "userId": "123" // 踢出用户 ID } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -419,20 +419,20 @@ POST /v1/group/gag-member ### 请求体 -```JSONC +```JSON { - "groupId": "123", // 目标群聊ID - "userId": "123", // 禁言用户ID - "gag": 0 // 禁言时间，只能为这些时间，0-取消禁言，600-10分钟，3600-1小时，21600-6小时，43200-12小时，1-永久禁言 + "groupId": "123", // 目标群聊 ID + "userId": "123", // 禁言用户 ID + "gag": 0 // 禁言时间，只能为这些时间: 0-取消禁言，600-10分钟，3600-1小时，21600-6小时，43200-12小时，(-1)-永久禁言 } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -444,7 +444,7 @@ GET /v1/group/category ### 响应体 -```JSONC +```JSON { "code": 1, "data": { @@ -624,18 +624,18 @@ POST /v1/group/recommend/list ### 请求体 -```JSONC +```JSON { - "categoryId": 22, // 群聊分类id， 0 代表全部 + "categoryId": 22, // 群聊分类 id， 0 代表全部 "keyword": "114514" // 搜索关键词，留空获取全部群聊 } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "groups": [ { @@ -643,26 +643,26 @@ POST /v1/group/recommend/list "groupId": "114514", "name": "这是群聊名字", "introduction": "这是个群聊介绍", - "createBy": "114514", // 创建者id + "createBy": "114514", // 创建者 id "createTime": 1754113069, // 创建时间戳 "avatarId": 43821, // 头像id "del_flag": 0, - "avatarUrl": "https://chat-img.jwznb.com/3d805b635cc54829e461102ab315381b.gif", // 群头像url + "avatarUrl": "https://chat-img.jwznb.com/3d805b635cc54829e461102ab315381b.gif", // 群头像 url "headcount": 16, // 群聊人数 "readHistory": 1, // 是否开启新成员查看消息历史记录（1为开启，0为关闭） "alwaysAgree": 1, // 是否直接进群（1为开启，0为关闭） - "categoryId": 22, // 群聊分类id + "categoryId": 22, // 群聊分类 id "category": "技术-IT/互联网", // 群聊分类名称 "private": 0, // 群聊是否私有（1为开启，0为关闭） "banId": 0, // "gag": 0, // 是否禁言（1为开启，0为关闭） - "gagBy": "", // 被禁言的id + "gagBy": "", // 被禁言的 id "msgTypeLimit": "" // 消息类型限制 }, // ... ] }, - "msg": "success" // 返回状态消息 + "msg": "success" } ``` @@ -680,7 +680,7 @@ POST /v1/group/msg-type-limit ### 请求体 -```JSONC +```JSON { "groupId": "群聊id", "type": "消息类型" // 1-文本消息，2-图片消息，3-Markdown消息，4-文件消息，6-帖子消息，7-表情消息，8-HTML消息，10-视频消息，11-语音消息，13-语音通话（限制多个消息类型一般是 1,2,3,4··· 之类） @@ -689,10 +689,10 @@ POST /v1/group/msg-type-limit ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -711,31 +711,31 @@ POST /v1/group/edit-group ### 请求体 ```ProtoBuf -group_id: "123" // 目标群聊ID +group_id: "123" // 目标群聊 ID name: "测试群聊名称" // 群聊名称 introduction: "测试群聊简介" // 群聊简介 -avatarUrl: "https://..." // 群聊头像url -direct_join: 0 // 进群免审核,1为开启 -history_msg: 1 // 历史消息,1为开启 +avatarUrl: "https://..." // 群聊头像u rl +direct_join: 0 // 进群免审核,1 为开启 +history_msg: 1 // 历史消息,1 为开启 category_name: "无" // 分类名 -category_id: 40 // 分类ID -private: 0 // 是否私有,1为私有 +category_id: 40 // 分类 ID +private: 0 // 是否私有,1 为私有 hide_group_members: 0 // 隐藏群成员 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message edit_group_send { - string group_id = 2; // 目标群聊ID + string group_id = 2; // 目标群聊 ID string name = 3; // 群聊名称 string introduction = 4; // 群聊简介 - string avatarUrl = 5; // 群聊头像url - uint64 direct_join = 6; // 进群免审核,1为开启 - uint64 history_msg = 7; // 历史消息,1为开启 + string avatarUrl = 5; // 群聊头像 url + uint64 direct_join = 6; // 进群免审核,1 为开启 + uint64 history_msg = 7; // 历史消息,1 为开启 string category_name = 8; // 分类名 - uint64 category_id = 9; // 分类ID - uint64 private = 10; // 是否私有,1为私有 + uint64 category_id = 9; // 分类 ID + uint64 private = 10; // 是否私有,1 为私有 uint64 hide_group_members = 11; // 隐藏群成员 } @@ -747,13 +747,13 @@ message edit_group_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message edit_group { @@ -778,14 +778,14 @@ POST /v1/group/bot-list ### 请求体 ```ProtoBuf -group_id: "123" // 目标群聊ID +group_id: "123" // 目标群聊 ID ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message edit_group_send { - string group_id = 2; // 目标群聊ID + string group_id = 2; // 目标群聊 ID } ``` @@ -795,14 +795,14 @@ message edit_group_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } // ... ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 获取群机器人列表 @@ -837,11 +837,11 @@ message bot_list { // int32 hidden/del_flag = 3; // 是否隐藏/删除,猜的 string name = 4; string content = 5; // 内容 - int32 menu_type = 6; // 按钮类型,1-普通按钮 2-选中按钮 3-下拉选择 + int32 menu_type = 6; // 按钮类型: 1-普通按钮 2-选中按钮 3-下拉选择 int64 create_time = 7; // 8,9没找到 int32 menu_action = 10; // 操作类型 - string select = 99; // 选择的选项,在选择按钮的时候也作为状态,选中为1,未选中为0 + string select = 99; // 选择的选项,在选择按钮的时候也作为状态,选中为 1,未选中为 0 } } ``` @@ -862,19 +862,19 @@ POST /v1/group/remove-bot ### 请求体 -```JSONC +```JSON { - "groupId": "123", // 群聊id - "botId": "123" // 机器人id + "groupId": "123", // 群聊 id + "botId": "123" // 机器人 id } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -892,18 +892,18 @@ POST /v1/group/edit-my-group-nickname ### 请求体 -```JSONC +```JSON { - "groupId": "123", // 目标群聊ID + "groupId": "123", // 目标群聊 ID "nickname": "测试群昵称" // 欲设置的群昵称 } ``` ### 响应体 -```JSONC +```JSON { - "msg": "success" // 返回状态消息 + "msg": "success" } ``` @@ -927,19 +927,19 @@ POST /v1/group/edit-group-keyword ### 请求体 -```JSONC +```JSON { - "groupId": "123", // 目前群聊ID + "groupId": "123", // 目前群聊 ID "keyword": "测试群口令" // 欲设置的群口令 } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -961,7 +961,7 @@ POST /v1/group/info-add-friend keyword: "测试群口令" // 欲要搜索的群口令 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message info_add_friend_send { @@ -975,26 +975,26 @@ message info_add_friend_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } Data { - id: "123" // 群聊ID + id: "123" // 群聊 ID name: "测试群名称" // 群聊名称 - avatar_url: "https://..." // 群聊头像url - avatar_id: 123; // 群聊头像ID + avatar_url: "https://..." // 群聊头像 url + avatar_id: 123; // 群聊头像 ID introduction: "测试群聊简介" // 群聊简介 headcount: 123 // 群人数 - createBy: "123" // 群聊创建者ID - readHistory: 1 // 是否允许阅读历史信息，0-不允许，1-允许 + createBy: "123" // 群聊创建者 ID + readHistory: 1 // 是否允许阅读历史信息: 0-不允许，1-允许 limited_msg_type: "1" // 被限制的消息类型,如1,2,3,使用","分格 - keyword: "测试群口令" // 群聊设置的口令 + keyword: "测试群口令" // 群聊设置的群口令 } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message info_add_friend { @@ -1002,16 +1002,16 @@ message info_add_friend { Data data = 1; message Data { - string id = 1; // 群聊ID + string id = 1; // 群聊 ID string name = 2; // 群聊名称 - string avatar_url = 3; // 群聊头像url - uint64 avatar_id = 4; // 群聊头像ID + string avatar_url = 3; // 群聊头像 url + uint64 avatar_id = 4; // 群聊头像 ID string introduction = 5; // 群聊简介 uint64 headcount = 6; // 群人数 - string createBy = 7; // 群聊创建者ID - uint64 readHistory = 10; // 是否允许阅读历史信息，0-不允许，1-允许 + string createBy = 7; // 群聊创建者 ID + uint64 readHistory = 10; // 是否允许阅读历史信息: 0-不允许，1-允许 string limited_msg_type = 22; // 被限制的消息类型,如1,2,3,使用","分格 - string keyword = 29; // 群聊设置的口令 + string keyword = 29; // 群聊设置的群口令 } } ``` @@ -1032,19 +1032,19 @@ POST /v1/group/edit-auto-delete-message ### 请求体 -```JSONC +```JSON { - "groupId": "123", // 群聊id + "groupId": "123", // 群聊 id "autoDeleteMessage": 0 // 消息自动销毁时间（0-永久不删，90-2个月后删除，365-1年后删除，730-2年后删除） } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -1062,19 +1062,19 @@ POST /v1/group/edit-stop-member-upload-group-file ### 请求体 -```JSONC +```JSON { - "groupId": "123456789", // 群聊id + "groupId": "123456789", // 群聊 id "stopMemberUploadGroupFile":1 // 是否开启（0-关闭，1-开启） } ``` ### 响应体 -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -1095,10 +1095,10 @@ POST /v1/group/create-group ```ProtoBuf name: "测试群聊" // 群聊名称 introduction: "测试群聊" // 群聊简介 -avatar_url: "https://..." // 头像url +avatar_url: "https://..." // 头像 url ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message create_send { @@ -1114,14 +1114,14 @@ message create_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } -group_id: "123" // 新群聊ID +group_id: "123" // 新群聊 ID ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message dismiss_group { @@ -1142,7 +1142,7 @@ POST /v1/group/dismiss-group | 名称 | 必须 | 备注 | | ----- | ---- |--------------| -| token | 是 | 必须为群主的 | +| token | 是 | 群主 | ### 请求体 @@ -1150,7 +1150,7 @@ POST /v1/group/dismiss-group group_id: "123123" // 群聊 ID ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message dismiss_send { @@ -1164,13 +1164,13 @@ message dismiss_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message dismiss_group { @@ -1192,35 +1192,35 @@ POST /v1/group/live-room 请求体： -```JSONC +```JSON { - "groupId": "big" // 群聊id + "groupId": "big" // 群聊 id } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "rooms": [ { - "userId": "1234567", // 用户id - "roomId": "c7552ca7c79546dd93baca4e4adxxxxx", // 房间id - "chatId": "123456789", // 房间所发起的会话id + "userId": "1234567", // 用户 id + "roomId": "c7552ca7c79546dd93baca4e4adxxxxx", // 房间 id + "chatId": "123456789", // 房间所发起的会话 id "title": "", // 房间标题 "chatType": 2, // 房间所发起的会话类型 "status": 0, // 房间状态 - "createBy": "1234567", // 发起房间的用户id + "createBy": "1234567", // 发起房间的用户 id "createTime": 1775881889, // 房间创建时间戳 "nickname": "111", // 房间创建者名称 "count": 1, // 房间人数 - "avatarUrl": "https://chat-img.jwznb.com/defalut-avatars/Nellie%20Bly.png" // 房间创建者头像Url + "avatarUrl": "https://chat-img.jwznb.com/defalut-avatars/Nellie%20Bly.png" // 房间创建者头像 Url } ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -1238,19 +1238,19 @@ POST /v1/group/agree-invite 请求体： -```JSONC +```JSON { - "id": 123, // 申请ID + "id": 123, // 申请 ID "agree": 1 // 1-通过请求，2-拒绝请求，3-显示请求过期，4-显示已解散 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1268,16 +1268,16 @@ POST /v1/group/member-is-removed 请求体： -```JSONC +```JSON { - "userId": "123", // 用户ID - "groupId": "123" // 群聊ID + "userId": "123", // 用户 ID + "groupId": "123" // 群聊 ID } ``` 响应体： -```JSONC +```JSON { "code": 1, // 1-踢过，2-没踢过 "msg": "success" // 返回消息 @@ -1298,18 +1298,18 @@ POST /v1/group/switch 请求体： -```JSONC +```JSON { - "groupId": "123", // 群聊ID + "groupId": "123", // 群聊 ID "hide": 0 // 0-关闭隐藏（加入群推荐），1-隐藏（不加入群推荐） } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/instruction.md b/src/api/v1/instruction.md index 3f29b8ac..86c20174 100644 --- a/src/api/v1/instruction.md +++ b/src/api/v1/instruction.md @@ -17,28 +17,28 @@ POST /v1/instruction/web-list 请求体： -```JSONC +```JSON { - "botId": "45669202" // 机器人id + "botId": "45669202" // 机器人 id } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { - "id": 2062, // 指令Id - "botId": "45669202", // 机器人id + "id": 2062, // 指令 id + "botId": "45669202", // 机器人 id "name": "普通指令", // 指令名称 "desc": "指令描述", // 指令描述 - "instructionType": 1, // 指令类型，1-普通指令，2-直发指令，5-自定义输入指令，更多（如下两个指令） + "instructionType": 1, // 指令类型: 1-普通指令，2-直发指令，5-自定义输入指令，更多（如下两个指令） "hintText": "输入框提示文字", // 输入框提示文字 "defaultText": "输入框默认文字", // 输入框默认文字 - "customJson": "", // 自定义输入指令json数组 + "customJson": "", // 自定义输入指令 json 数组 "createTime": 0, // 创建时间戳 "sort": 0, // 排序 "hidden": 0 // 是否隐藏(0-显示，1-隐藏) @@ -71,32 +71,32 @@ POST /v1/instruction/web-list } ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` ::: details 自定义输入指令部分解释 -```JSONC +```JSON [{ "key": 0, "type": "radio", "title": "Radio 单选框", - "propsValue": { // propsValue是成品，保存了当前组件实际生效的配置数据。用于组件在页面上显示和运行。 + "propsValue": { // propsValue 是成品，保存了当前组件实际生效的配置数据。用于组件在页面上显示和运行。 "label": "标签", "options": "用#分割，比如：北京#上海#天津" }, - "props": [{ // prop是蓝图，定义了可以配置什么，以及默认值是什么。用于渲染一个配置界面。 - "type": "label", // 类型，一个用于设置“标签”的配置项，有radio-单选框，input-输入框，switch-开关，chexkbox-多选框，textarea-多行输入框，select-选择器 + "props": [{ // prop 是蓝图，定义了可以配置什么，以及默认值是什么。用于渲染一个配置界面。 + "type": "label", // 类型，一个用于设置“标签”的配置项，有 radio-单选框，input-输入框，switch-开关，chexkbox-多选框，textarea-多行输入框，select-选择器 "name": "标签", // 显示给用户的名字叫“标签” - "value": "" // 这个type预定的值，默认空 + "value": "" // 这个 type 预定的值，默认空 }, { "type": "options", "name": "选项", // 显示给用户的名字叫“选项” - "placeholder": "用#分割，如：北京#上海#天津", // 输入框里的提示文字，通常只有Radio-单选框，Checkbox-多选框，Select-选择器会有这个key + "placeholder": "用#分割，如：北京#上海#天津", // 输入框里的提示文字，通常只有 Radio-单选框，Checkbox-多选框，Select-选择器会有这个key "value": "" }], - "id": "ykwmdt" // 该表单的id + "id": "ykwmdt" // 该表单的 id }] ``` @@ -114,23 +114,23 @@ POST /v1/instruction/create 请求体： -```JSONC +```JSON { "name": "名称", // 指令名称 "desc": "描述", // 指令描述 "hintText": "输入框提示文字", // 输入框提示文字 "defaultText": "输入框默认文字", // 输入框默认文字 - "type": 1, // 指令类型，1-普通指令，2-直发指令，5-自定义输入指令 - "botId": "45669202" // 机器人id + "type": 1, // 指令类型: 1-普通指令，2-直发指令，5-自定义输入指令 + "botId": "45669202" // 机器人 id } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -146,24 +146,24 @@ POST v1/instruction/edit 请求体： -```JSONC +```JSON { - "id": 2064, // 已有的指令id + "id": 2064, // 已有的指令 id "name": "自定义输入指令", // 指令名称 "desc": "指令描述", // 指令描述 - "botId": "45669202", // 机器人id - "customJson": "", // 自定义输入指令（表单指令），只有type为5的自定义输入指令需要，这个是json数组，需转义，具体设置可以看 **获取机器人指令列表（网页控制台）** 对一些表单指令的解释 - "type": 5, // 指令类型，1-普通指令，2-直发指令，5-自定义输入指令 + "botId": "45669202", // 机器人 id + "customJson": "", // 自定义输入指令（表单指令），只有 type 为 5 的自定义输入指令需要，这个是 json 数组，需转义，具体设置可以看 **获取机器人指令列表（网页控制台）** 对一些表单指令的解释 + "type": 5, // 指令类型: 1-普通指令，2-直发指令，5-自定义输入指令 "delFlag": 0 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -183,47 +183,55 @@ POST /v1/instruction/list id: "123123123" ``` +::: details ProtoBuf 数据结构 + ```proto message get_bot_instruction { string id = 3; } ``` +::: + 响应体： ```protobuf status { - number: 123456 - code: 1 // 请求状态码，1为正常 - msg: "success" // 返回消息 + request_id: 123456 + code: 1 + msg: "success" } data { - command_id: 123 // 指令id - bot_id： 123123123 // 机器人id + command_id: 123 // 指令 id + bot_id： 123123123 // 机器人 id command_name: "测试指令名称" // 指令名称 - instruction_type: 5 // 指令类型，1-普通指令，2-直发指令，5-自定义输入指令 + instruction_type: 5 // 指令类型: 1-普通指令，2-直发指令，5-自定义输入指令 command_defaultText: "测试默认输入文本" // 指令输入框默认文本 - command_settingsJso: "{}" // 指令设置JSON（表单指令，自定义输入指令） + command_settingsJso: "{}" // 指令设置 JSON（表单指令，自定义输入指令） } ``` +::: details ProtoBuf 数据结构 + ```proto message Status { - uint64 number = 1; // 不知道干啥的,可能是请求ID - uint64 code = 2; // 状态码,1为正常 - string msg = 3; // 返回消息 + uint64 request_id = 1; + uint64 code = 2; + string msg = 3; } message instruction_list { Status status = 1; Data data = 2; message Data { - uint64 command_id = 1; // 指令id - string bot_id = 2; // 机器人id + uint64 command_id = 1; // 指令 id + string bot_id = 2; // 机器人 id string command_name = 3; // 指令名称 - uint64 instruction_type = 5; // 指令类型，1-普通指令，2-直发指令，5-自定义输入指令 + uint64 instruction_type = 5; // 指令类型: 1-普通指令，2-直发指令，5-自定义输入指令 string command_defaultText = 7; // 指令输入框默认文本 - string command_settingsJson = 10; // 指令设置JSON（表单指令，自定义输入指令） + string command_settingsJson = 10; // 指令设置 JSON（表单指令，自定义输入指令） } } ``` + +::: \ No newline at end of file diff --git a/src/api/v1/live.md b/src/api/v1/live.md index cf35d44c..f6ea06da 100644 --- a/src/api/v1/live.md +++ b/src/api/v1/live.md @@ -9,7 +9,7 @@ title: live 云湖的语音频道使用的是标准的 livekit,wss 地址: `wss://livekit.jwznb.com` ::: -## 获取语音频道进入token +## 获取语音频道进入 token POST /v1/live/add @@ -21,22 +21,22 @@ POST /v1/live/add 请求体： -```JSONC +```JSON { - "roomId": "123123123123", // 目标语音频道ID - "chatId": "123" // 目标语言频道所处对象ID + "roomId": "123123123123", // 目标语音频道 ID + "chatId": "123" // 目标语言频道所处对象 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "joinToken": "123123123123123123", // livekit 的 access_token }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -52,18 +52,18 @@ POST /v1/live/close 请求体： -```JSONC +```JSON { - "roomId": "123123123123", // 目标语音频道ID + "roomId": "123123123123", // 目标语音频道 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -79,19 +79,19 @@ POST /v1/live/hang_up 请求体： -```JSONC +```JSON { - "roomId": "123123123123", // 目标语音频道ID + "roomId": "123123123123", // 目标语音频道 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": {}, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -107,26 +107,26 @@ POST /v1/live/room-info 请求体： -```JSONC +```JSON { - "roomId": "123123123123", // 目标语音频道ID + "roomId": "123123123123", // 目标语音频道 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "room": { "id": 18658, - "userId": "123", // 房间管理员用户ID - "roomId": "ef8beba697c84a5f889af45211b449a1", // 房间ID + "userId": "123", // 房间管理员用户 ID + "roomId": "ef8beba697c84a5f889af45211b449a1", // 房间 ID "recvIds": "", // 未知 - "chatId": "872440499", // 房间ID所属对象 - "title": "测试频道", // 房间ID标题 - "chatType": 2, // 房间ID所属对象类别 + "chatId": "872440499", // 房间 ID 所属对象 + "title": "测试频道", // 房间 ID 标题 + "chatType": 2, // 房间 ID 所属对象类别 "status": 0, //房间状态 "duration": 0, // 未知 "typ": 2, // 未知 @@ -136,7 +136,7 @@ POST /v1/live/room-info "updateTime": 1754455159 // 房间创建时间戳 } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -152,19 +152,19 @@ POST /v1/live/title-edit 请求体： -```JSONC +```JSON { - "roomId": "123123123123", // 目标语音频道ID + "roomId": "123123123123", // 目标语音频道 ID "title": "测试语音频道名称" //目标语音频道名称 } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -180,25 +180,25 @@ POST /v1/live/get-calling 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "callTime": 12, // 请求呼叫时间 "chatType": 1, // 发起通话的会话类型 "message": { - "msgId": "20902d6a256d436ebfc4a2xxxxxxxxxx", // 发起通话的消息id - "senderId": "1234567", // 发起通话的用户id + "msgId": "20902d6a256d436ebfc4a2xxxxxxxxxx", // 发起通话的消息 id + "senderId": "1234567", // 发起通话的用户 id "senderType": 0, // 未知 - "senderAvatarId": 123456, // 发送者头像id - "senderNicknameId": 123456, // 发送者名称id + "senderAvatarId": 123456, // 发送者头像 id + "senderNicknameId": 123456, // 发送者名称 id "contentType": 13, // 发起通话的消息类型 "content": "" // 语音通话参数 }, - "senderAvatar": "https://chat-img.jwznb.com/123....jpg", // 发起通话的用户头像Url + "senderAvatar": "https://chat-img.jwznb.com/123....jpg", // 发起通话的用户头像 Url "senderNickname": "1114" // 发起通话的用户名称 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` diff --git a/src/api/v1/menu.md b/src/api/v1/menu.md index 74509fb8..beaa2746 100644 --- a/src/api/v1/menu.md +++ b/src/api/v1/menu.md @@ -17,10 +17,10 @@ POST /v1/menu/event 请求头： -```JSONC +```JSON { - "id": 338, // 按钮id - "chatId": "114514", // 聊天id + "id": 338, // 按钮 id + "chatId": "114514", // 聊天 id "chatType": 2, // 会话类型 "value": "" // 按钮的值 } @@ -28,9 +28,9 @@ POST /v1/menu/event 响应头： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/misc.md b/src/api/v1/misc.md index f660dc7c..461744bb 100644 --- a/src/api/v1/misc.md +++ b/src/api/v1/misc.md @@ -17,9 +17,9 @@ GET /v1/misc/configure-distribution 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "audioUrl": "https://chat-audio1.jwznb.com/", // 音频路由 "fileUrl": "https://chat-file.jwznb.com/", // 文件路由 @@ -27,9 +27,9 @@ GET /v1/misc/configure-distribution "serverUrl": "http://chat.jwznb.com:8888/", // 未知 "shareUrl": "https://yhfx.jwznb.com/", // 分享链接路由 "videoUrl": "https://chat-video1.jwznb.com/", // 视频路由 - "websocketUrl": "wss://chat-ws-go.jwzhd.com/ws" // ws路由 + "websocketUrl": "wss://chat-ws-go.jwzhd.com/ws" // WS 路由 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -45,13 +45,13 @@ GET /v1/misc/qiniu-token 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "token": "123:123" // 图片上传token + "token": "123:123" // 图片上传 token }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -67,13 +67,13 @@ GET /v1/misc/qiniu-token-audio 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "token": "123:123" // 音频上传token + "token": "123:123" // 音频上传 token }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -89,13 +89,13 @@ GET /v1/misc/qiniu-token2 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "token": "123:123" // 文件上传token + "token": "123:123" // 文件上传 token }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -111,13 +111,13 @@ GET /v1/misc/qiniu-token-video 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "token": "123:123" // 视频上传token + "token": "123:123" // 视频上传 token }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -133,13 +133,13 @@ GET /v1/misc/qiniu-token-group-disk 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "token": "123:123" // 群文件上传token + "token": "123:123" // 群文件上传 token }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -155,18 +155,18 @@ GET /v1/misc/setting 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "fileSizeLimitNormal": 40, // 非vip用户文件上传大小，单位MB - "fileeSizeLimitVip": 1024, // VIP用户文件上传大小 /单位MB - "imageSizeLimitNormal": 40, // 非vip用户图片上传大小，单位MB - "imageSizeLimitVip": 50, // vip用户图片上传大小，单位MB - "videoSizeLimitNormal": 40, // 非vip用户视频上传大小，单位MB - "videoSizeLimitVip": 200 // vip用户视频上传大小，单位MB + "fileSizeLimitNormal": 40, // 非 vip 用户文件上传大小，单位 MB + "fileeSizeLimitVip": 1024, // vip 用户文件上传大小 /单位 MB + "imageSizeLimitNormal": 40, // 非 vip 用户图片上传大小，单位 MB + "imageSizeLimitVip": 50, // vip 用户图片上传大小，单位 MB + "videoSizeLimitNormal": 40, // 非 vip 用户视频上传大小，单位 MB + "videoSizeLimitVip": 200 // vip 用户视频上传大小，单位 MB }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -176,13 +176,13 @@ GET /v1/misc/gray-status 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "status": 0 // 0-不为灰色状态，1-灰色状态，处于灰色状态下云湖窗口将加上一层灰色滤镜 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -193,8 +193,8 @@ GET /v1/misc/auto-update URL 参数: ```TEXT -platform=windows // 目标平台标识符，windows，android，macos，ios -userId=123 // 获取更新的用户ID +platform=windows // 目标平台标识符: windows，android，macos，ios +userId=123 // 获取更新的用户 ID ``` 响应体: @@ -206,8 +206,8 @@ userId=123 // 获取更新的用户ID 云湖社交更新中 -// url属性为更新安装包网址，参数platform为macos，ios是此值可能为空 -// version属性为版本号 +// url属性为更新安装包网址，参数 platform 为 macos，ios 是此值可能为空 +// version 属性为版本号 diff --git a/src/api/v1/mount-setting.md b/src/api/v1/mount-setting.md index 97b56131..9fcff1cc 100644 --- a/src/api/v1/mount-setting.md +++ b/src/api/v1/mount-setting.md @@ -17,9 +17,9 @@ POST /v1/mount-setting/create 请求体: -```JSONC +```JSON { - "groupId": "big", // 目标群聊ID + "groupId": "big", // 目标群聊 ID "mountName": "测试挂载名称", // 挂载名称 "webdavUrl": "https://...", // 挂载网址 "webdavUserName": "测试挂载用户名", // 挂载用户名 @@ -30,10 +30,10 @@ POST /v1/mount-setting/create 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -49,17 +49,17 @@ POST /v1/mount-setting/delete 请求体: -```JSONC +```JSON { - "id": 123 // 挂载ID + "id": 123 // 挂载 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/msg.md b/src/api/v1/msg.md index 4891a9ba..39d33fdd 100644 --- a/src/api/v1/msg.md +++ b/src/api/v1/msg.md @@ -16,47 +16,40 @@ POST /v1/msg/send-message | token | 是 | 无 | 请求体: -建议参考proto文件中的内容. +建议参考 proto 文件中的内容. ```ProtoBuf -msg_id: "信息ID" -chat_id: "欲发送到的信息对象" -chat_type: 1 // 欲发送到的信息对象的类别，1-用户，2-群聊，3-机器人 +msg_id: "abcdef" +chat_id: "114514" +chat_type: 2 data { - text: "信息文本" - quote_msg_text: "引用信息文本" - image_key: "欲发送图片key" - msg_text1: "信息文本" - msg_text2: "信息文本" - form: "" // 表单消息 - temp_text2: "" - temp_text3: "" - temp_code1: 0 + text: "文本内容" + image: "abcdef.jpg" } -content_type: 1 -temp_code: 0 -quote_msg_id: "引用信息ID" -temp_text: "" +content_type: 2 // 内容类型 +quote_msg_id: "引用消息的 ID" + +// media 其实没啥用 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 发送消息 message send_message_send { - string msg_id = 2; // 信息ID + string msg_id = 2; // 信息 ID string chat_id = 3; // 欲发送到的信息对象 - uint64 chat_type = 4; // 欲发送到的信息对象的类别，1-用户，2-群聊，3-机器人 + uint64 chat_type = 4; // 欲发送到的信息对象的类别 Data data = 5; message Data { string text = 1; // 信息文本 string buttons = 2; // 按钮 string file_name = 4; // 欲发送文件名称 - string file_key = 5; // 欲发送文件key - repeated string mentioned_id = 6; // @用户ID,可以填写多个 + string file_key = 5; // 欲发送文件 key + repeated string mentioned_id = 6; // @对象 ID ,可以填写多个 string form = 7; // 表单消息 string quote_msg_text = 8; // 引用信息文本 - string image = 9; // 欲发送图片key/url(expression/abcdef.jpg) + string image = 9; // 欲发送图片 key/url(expression/abcdef.jpg) string post_id = 10; // 文章ID string post_title = 11; // 文章标题 string post_content = 12; // 文章内容 @@ -65,21 +58,21 @@ message send_message_send { string quote_image_url = 16; // 引用图片直链,https://... string quote_image_name = 17; // 引用图片文件名称 uint64 file_size = 18; // 欲发送文件大小 - string video = 19; // 欲发送视频key/url(123.mp4) - string audio = 21; // 语音key/url(123.m4a) + string video = 19; // 欲发送视频 key/url(123.mp4) + string audio = 21; // 语音 key/url(123.m4a) uint64 audio_time = 22; // 语音秒数 string quote_video_url = 23; // 引用视频直链,https://... uint64 quote_video_time = 24; // 引用视频时长 - uint64 sticker_item_id = 25; // 表情ID - uint64 sticker_pack_id = 26; // 表情包ID + uint64 sticker_item_id = 25; // 表情 ID + uint64 sticker_pack_id = 26; // 表情包 ID string room_name = 29; // 语音房间发送显示信息的文本 } - uint64 content_type = 6; // 信息类别，1-文本，2-图片，3-markdown，4-文件，5-表单，6-文章，7-表情，8-html，11-语音，13-语音通话 - uint64 command_id = 7; // 所使用命令ID - string quote_msg_id = 8; // 引用信息ID + uint64 content_type = 6; // 信息类别 + uint64 command_id = 7; // 所使用命令 ID + string quote_msg_id = 8; // 引用信息 ID Media media = 9; - message Media { // 在media发送对象为，图片/音频/视频 - string file_key = 1; // 发送对象key(就是上传后七牛对象存储给你返回的file_key) + message Media { // 在 media 发送对象为，图片/音频/视频 + string file_key = 1; // 发送对象 key (就是上传后七牛对象存储给你返回的 file_key) string file_hash = 2; // 发送对象上传返回哈希 string file_type = 3; // 发送对象类别，image/jpeg-图片，video/mp4-音频 uint64 image_height = 5; // 图片高度 @@ -184,13 +177,13 @@ message send_message_send { ```ProtoBuf status { - number: 123456 + request_id: 123456 code: 1 msg: "success" } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 信息发送是否成功状态信息 @@ -220,18 +213,18 @@ POST /v1/msg/edit-message 请求体: ```ProtoBuf -msg_id: "123456" // 要编辑的消息ID -chat_id: "big" // 消息所属聊天对象的ID -chat_type: 2 // 消息所属聊天对象的类型,1-用户 2-群组 3-机器人 +msg_id: "123456" // 要编辑的消息 ID +chat_id: "big" // 消息所属聊天对象的 ID +chat_type: 2 // 消息所属聊天对象类型 content { text: "123" // 文本 - // 剩下的建议看proto文件 + // 剩下的建议看 proto 文件 } -content_type: 1 // 要编辑为的消息类型,1-文本 3-markdown 8-html -quote_msg_id: "11451419180" // 引用的消息ID +content_type: 1 // 要编辑为的消息类型 +quote_msg_id: "11451419180" // 引用的消息 ID ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 编辑消息 @@ -245,8 +238,8 @@ message edit_message_send { string buttons = 2; // 按钮 string quote_msg_text = 8; // 引用消息文字 } - uint64 content_type = 6; // 信息类别，1-文本，3-markdown，8-html - string quote_msg_id = 8; // 引用信息ID + uint64 content_type = 6; // 信息类别 + string quote_msg_id = 8; // 引用信息 ID } ``` @@ -256,13 +249,13 @@ message edit_message_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message edit_message { @@ -277,7 +270,7 @@ message edit_message { POST /v1/msg/list-message-by-seq ::: warning -由于没有所有消息情况,因此此处响应相关内容(尤其是指令等测试群不常见部分)可能会有缺失/错误,见谅.同时建议参照proto文件理解相关内容.也欢迎来PR补充. +由于没有所有消息情况,因此此处响应相关内容(尤其是指令等测试群不常见部分)可能会有缺失/错误,见谅.同时建议参照 proto 文件理解相关内容.也欢迎来 PR 补充. ::: 请求头: @@ -290,18 +283,18 @@ POST /v1/msg/list-message-by-seq ```ProtoBuf msg_start: 1234 // 开始的消息序列 -chat_type: 2 // 对象类型, 1-用户 2-群聊 3-机器人 -chat_id: "big" // 对象ID +chat_type: 2 // 对象类型 +chat_id: "big" // 对象 ID ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 通过消息序列列出消息 message list_message_by_seq_send { - uint64 msg_start = 3; // 从第N个消息开始 + uint64 msg_start = 3; // 从第 N 个消息开始 uint64 chat_type = 4; // 对象类型 - string chat_id = 5; // 对象ID + string chat_id = 5; // 对象 ID } ``` @@ -311,21 +304,21 @@ message list_message_by_seq_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } msg { - msg_id: "abcdef" // 消息ID + msg_id: "abcdef" // 消息 ID sender { - chat_id: "7356666" // 发送者ID + chat_id: "7356666" // 发送者 ID chat_type: 1 // 发送者类型。 name: "测试" // 发送者名称 - avatar_url: "https://chat-img.jwznb.com/..." // 头像URL + avatar_url: "https://chat-img.jwznb.com/..." // 头像 URL tag_old: "测试成员" // 标签(旧版显示) // ... tag { - id: 114514 // 标签ID + id: 114514 // 标签 ID text: "测试成员" // 标签文字 color: "#FFFFFFFF" // 颜色 } @@ -335,7 +328,7 @@ msg { content_type: 1 // 消息类型 content { text: "ok" // 消息内容 - // 剩下的建议看ProtoBuf序列文件,太多不写了 + // 剩下的建议看 ProtoBuf 序列文件,太多不写了 } send_time: 123456789 // 发送时间(毫秒时间戳) cmd { @@ -344,7 +337,7 @@ msg { type: 1 // 指令类型（1-普通指令, 2-直发指令, 5-自定义输入指令） } msg_delete_time: 8888 // 消息撤回时间(毫秒时间戳) - quote_msg_id: "abcdef" // 引用消息的ID + quote_msg_id: "abcdef" // 引用消息的 ID msg_seq: 6666 // 消息序列 edit_time: 1234 // 最后编辑时间 } @@ -352,11 +345,11 @@ msg { total: 23 // 获取的消息数量,貌似最大31个,实际获取的数量是请求中的数量+1 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message Tag { - uint64 id = 1; // 标签ID(貌似) + uint64 id = 1; // 标签 ID (貌似) string text = 3; string color = 4; } @@ -367,7 +360,7 @@ message list_message_by_seq { uint64 msg_count = 3; // 消息数 message Msg { - string msg_id = 1; // 消息ID + string msg_id = 1; // 消息 ID Sender sender = 2; string direction = 3; // 消息位置,左边/右边 uint64 content_type = 4; @@ -375,12 +368,12 @@ message list_message_by_seq { uint64 send_time = 6; // 时间戳(毫秒) Cmd cmd = 7; // 指令 uint64 msg_delete_time = 8; // 消息撤回时间 - string quote_msg_id = 9; // 引用消息ID + string quote_msg_id = 9; // 引用消息 ID uint64 msg_seq = 10; uint64 edit_time = 12; // 最后编辑时间 message Cmd { - uint64 cmd_id = 1; // 指令ID + uint64 cmd_id = 1; // 指令 ID string name = 2; // 指令名 uint64 type = 4; // 指令类型（1-普通指令, 2-直发指令, 5-自定义输入指令） } @@ -388,28 +381,28 @@ message list_message_by_seq { message Content { string text = 1; // 消息内容 string buttons = 2; // 按钮 - string image_url = 3; // 图像URL + string image_url = 3; // 图像 URL string file_name = 4; // 文件名 - string file_url = 5; // 文件URL - repeated string at = 6; // @ + string file_url = 5; // 文件 URL + repeated string at = 6; // 被 @ 对象的 ID string form = 7; // 表单消息 string quote_msg_text = 8; // 引用消息文字 - string sticker_url = 9; // 表情URL - string post_id = 10; // 文章ID + string sticker_url = 9; // 表情 URL + string post_id = 10; // 文章 ID string post_title = 11; // 文章标题 string post_content = 12; // 文章内容 string post_content_type = 13; // 文章类型 - string expression_id = 15; // 个人表情ID(不知道为啥为STR) + string expression_id = 15; // 个人表情 ID (不知道为啥类型为字符串) string quote_image_url = 16; // 引用图片直链,https://... string quote_image_name = 17; // 引用图片文件名称 uint64 file_size = 18; // 文件/图片大小(字节) - string video_url = 19; // 视频URL - string audio_url = 21; // 语音URL + string video_url = 19; // 视频 URL + string audio_url = 21; // 语音 URL uint64 audio_time = 22; // 语音时长 string quote_video_url = 23; // 引用视频直链,https://... uint64 quote_video_time = 24; // 引用视频时长 - uint64 sticker_item_id = 25; // 表情ID - uint64 sticker_pack_id = 26; // 表情包ID + uint64 sticker_item_id = 25; // 表情 ID + uint64 sticker_pack_id = 26; // 表情包 ID string call_text = 29; // 语音通话文字 string call_status_text = 32; // 语音通话状态文字 uint64 width = 33; // 图片的宽度 @@ -418,10 +411,10 @@ message list_message_by_seq { } // 发送者信息 message Sender { - string chat_id = 1; // 发送者ID + string chat_id = 1; // 发送者 ID uint64 chat_type = 2; // 发送者类型 string name = 3; // 发送者名称 - string avatar_url = 4; // 头像URL + string avatar_url = 4; // 头像 URL repeated string tag_old = 6; // 标签(旧版显示) repeated Tag tag = 7; // 标签 } @@ -436,7 +429,7 @@ message list_message_by_seq { POST /v1/msg/list-message ::: warning -由于没有所有消息情况,因此此处响应相关内容(尤其是指令等测试群不常见部分)可能会有缺失/错误,见谅.同时建议参照proto文件理解相关内容.也欢迎来PR补充. +由于没有所有消息情况,因此此处响应相关内容(尤其是指令等测试群不常见部分)可能会有缺失/错误,见谅.同时建议参照 proto 文件理解相关内容.也欢迎来 PR 补充. ::: 请求头: @@ -449,40 +442,40 @@ POST /v1/msg/list-message ```ProtoBuf msg_count: 233 // 获取的消息数 -msg_id: "abcdef" // 从指定消息id开始,可不写 -chat_type: 2 // 对象类型,1-用户 2-群聊 3-机器人 -chat_id: "big" // 对象ID +msg_id: "abcdef" // 从指定消息 id 开始,可不写 +chat_type: 2 // 对象类型 +chat_id: "big" // 对象 ID ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message list_message_send { uint64 msg_count = 2; // 获取消息数 - string msg_id = 3; // 从指定消息ID开始 + string msg_id = 3; // 从指定消息 ID 开始 uint64 chat_type = 4; // 对象类型 - string chat_id = 5; // 对象ID + string chat_id = 5; // 对象 ID } ``` ::: 响应体: -列出的是指定消息ID前的消息. +列出的是指定消息 ID 前的消息. ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } msg { - msg_id: "abcdef" // 消息ID + msg_id: "abcdef" // 消息 ID sender { - chat_id: "7356666" // 发送者ID + chat_id: "7356666" // 发送者 ID chat_type: 1 // 发送者类型。 name: "测试" // 发送者名称 - avatar_url: "https://chat-img.jwznb.com/..." // 头像URL + avatar_url: "https://chat-img.jwznb.com/..." // 头像 URL tag_old: "测试成员" // 标签(旧版显示) // ... tag { @@ -496,34 +489,34 @@ msg { content_type: 1 // 消息类型 content { text: "ok" // 消息内容 - // 剩下的建议看ProtoBuf序列文件,太多不写了 + // 剩下的建议看 ProtoBuf 序列文件,太多不写了 } send_time: 123456789 // 发送时间(毫秒时间戳) cmd { - cmd_id = 123; // 指令ID + cmd_id = 123; // 指令 ID name: "指令名" // 指令名 type: 1 // 指令类型（1-普通指令, 2-直发指令, 5-自定义输入指令） } msg_delete_time: 8888 // 消息撤回时间(毫秒时间戳) - quote_msg_id: "abcdef" // 引用消息的ID + quote_msg_id: "abcdef" // 引用消息的 ID msg_seq: 6666 // 消息序列 edit_time: 1234 // 最后编辑时间 } // ... ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 标签 message Tag { - uint64 id = 1; // 标签ID(貌似) + uint64 id = 1; // 标签 ID (貌似) string text = 3; string color = 4; } message Msg { - string msg_id = 1; // 消息ID + string msg_id = 1; // 消息 ID Sender sender = 2; string direction = 3; // 消息位置,左边/右边 uint64 content_type = 4; @@ -531,12 +524,12 @@ message Msg { uint64 send_time = 6; // 时间戳(毫秒) Cmd cmd = 7; // 指令 uint64 msg_delete_time = 8; // 消息撤回时间 - string quote_msg_id = 9; // 引用消息ID + string quote_msg_id = 9; // 引用消息 ID uint64 msg_seq = 10; uint64 edit_time = 12; // 最后编辑时间 message Cmd { - uint64 cmd_id = 1; // 指令ID + uint64 cmd_id = 1; // 指令 ID string name = 2; // 指令名 uint64 type = 4; // 指令类型（1-普通指令, 2-直发指令, 5-自定义输入指令） } @@ -547,25 +540,25 @@ message Msg { string image_url = 3; string file_name = 4; string file_url = 5; - repeated string at = 6; // @ + repeated string at = 6; // 被 @ 对象的 ID string form = 7; // 表单消息 string quote_msg_text = 8; // 引用消息文字 - string sticker_url = 9; // 表情URL - string post_id = 10; // 文章ID + string sticker_url = 9; // 表情 URL + string post_id = 10; // 文章 ID string post_title = 11; // 文章标题 string post_content = 12; // 文章内容 string post_content_type = 13; // 文章类型 - string expression_id = 15; // 个人表情ID(不知道为啥为STR) + string expression_id = 15; // 个人表情 ID (不知道为啥为类型为字符串) string quote_image_url = 16; // 引用图片直链,https://... string quote_image_name = 17; // 引用图片文件名称 uint64 file_size = 18; // 文件/图片大小(字节) - string video_url = 19; // 视频URL - string audio_url = 21; // 语音URL + string video_url = 19; // 视频 URL + string audio_url = 21; // 语音 URL uint64 audio_time = 22; // 语音时长 string quote_video_url = 23; // 引用视频直链,https://... uint64 quote_video_time = 24; // 引用视频时长 - uint64 sticker_item_id = 25; // 表情ID - uint64 sticker_pack_id = 26; // 表情包ID + uint64 sticker_item_id = 25; // 表情 ID + uint64 sticker_pack_id = 26; // 表情包 ID string call_text = 29; // 语音通话文字 string call_status_text = 32; // 语音通话状态文字 uint64 width = 33; // 图片的宽度 @@ -584,7 +577,7 @@ message Msg { } // 获取消息 -message list_message { // 其实可以和 list-message-by-seq共用的。 +message list_message { // 其实可以和 list-message-by-seq 共用的。 Status status = 1; repeated Msg msg = 2; } @@ -597,11 +590,11 @@ message list_message { // 其实可以和 list-message-by-seq共用的。 POST /v1/msg/list-message-by-mid-seq ::: warning -由于没有所有消息情况,因此此处响应相关内容(尤其是指令等测试群不常见部分)可能会有缺失/错误,见谅.同时建议参照proto文件理解相关内容.也欢迎来PR补充. +由于没有所有消息情况,因此此处响应相关内容(尤其是指令等测试群不常见部分)可能会有缺失/错误,见谅.同时建议参照 proto 文件理解相关内容.也欢迎来 PR 补充. ::: ::: tip -此接口和 list-message 的区别在于此接口获取到的消息包含请求的消息ID的消息内容. 实际获取到的消息数量是请求消息数量+1 +此接口和 list-message 的区别在于此接口获取到的消息包含请求的消息 ID 的消息内容. 实际获取到的消息数量是请求消息数量+1 ::: 请求头: @@ -613,12 +606,12 @@ POST /v1/msg/list-message-by-mid-seq 请求体: ```ProtoBuf -msg_seq: 123456 // 开始消息的seq,不写默认0 -chat_type: 2 // 对象类型,1-用户 2-群聊 3-机器人 -chat_id: "big" // 对象ID +msg_seq: 123456 // 开始消息的 seq,不写默认0 +chat_type: 2 // 对象类型 +chat_id: "big" // 对象 ID unknown: 0 // 不知道干啥的 msg_count: 10 // 请求获取消息数量 -msg_id: abcdef // 消息ID +msg_id: abcdef // 消息 ID ``` ::: details ProtoBuf 数据结构 @@ -626,7 +619,7 @@ msg_id: abcdef // 消息ID ```proto // 列出包含请求 msg_id 消息 message list_message_by_mid_seq_send { - uint64 msg_seq = 3; // 开始消息的seq + uint64 msg_seq = 3; // 开始消息的 seq uint64 chat_type = 4; string chat_id = 5; uint64 unknown = 6; // 不知道干啥的 @@ -641,21 +634,21 @@ message list_message_by_mid_seq_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } msg { - msg_id: "abcdef" // 消息ID + msg_id: "abcdef" // 消息 ID sender { - chat_id: "7356666" // 发送者ID + chat_id: "7356666" // 发送者 ID chat_type: 1 // 发送者类型。 name: "测试" // 发送者名称 - avatar_url: "https://chat-img.jwznb.com/..." // 头像URL + avatar_url: "https://chat-img.jwznb.com/..." // 头像 URL tag_old: "测试成员" // 标签(旧版显示) // ... tag { - id: 114514 // 标签ID + id: 114514 // 标签 ID text: "测试成员" // 标签文字 color: "#FFFFFFFF" // 颜色 } @@ -665,16 +658,16 @@ msg { content_type: 1 // 消息类型 content { text: "ok" // 消息内容 - // 剩下的建议看ProtoBuf序列文件,太多不写了 + // 剩下的建议看 ProtoBuf 序列文件,太多不写了 } send_time: 123456789 // 发送时间(毫秒时间戳) cmd { - cmd_id = 123; // 指令ID + cmd_id = 123; // 指令 ID name: "指令名" // 指令名 type: 1 // 指令类型（1-普通指令, 2-直发指令, 5-自定义输入指令） } msg_delete_time: 8888 // 消息撤回时间(毫秒时间戳) - quote_msg_id: "abcdef" // 引用消息的ID + quote_msg_id: "abcdef" // 引用消息的 ID msg_seq: 6666 // 消息序列 edit_time: 1234 // 最后编辑时间 } @@ -682,18 +675,18 @@ msg { total: 11 // 获取的消息数量 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 标签 message Tag { - uint64 id = 1; // 标签ID(貌似) + uint64 id = 1; // 标签 ID (貌似) string text = 3; string color = 4; } message Msg { - string msg_id = 1; // 消息ID + string msg_id = 1; // 消息 ID Sender sender = 2; string direction = 3; // 消息位置,左边/右边 uint64 content_type = 4; @@ -701,12 +694,12 @@ message Msg { uint64 send_time = 6; // 时间戳(毫秒) Cmd cmd = 7; // 指令 uint64 msg_delete_time = 8; // 消息撤回时间 - string quote_msg_id = 9; // 引用消息ID + string quote_msg_id = 9; // 引用消息 ID uint64 msg_seq = 10; uint64 edit_time = 12; // 最后编辑时间 message Cmd { - uint64 cmd_id = 1; // 指令ID + uint64 cmd_id = 1; // 指令 ID string name = 2; // 指令名 uint64 type = 4; // 指令类型（1-普通指令, 2-直发指令, 5-自定义输入指令） } @@ -717,25 +710,25 @@ message Msg { string image_url = 3; string file_name = 4; string file_url = 5; - repeated string at = 6; // @ + repeated string at = 6; // 被 @ 对象的 ID string form = 7; // 表单消息 string quote_msg_text = 8; // 引用消息文字 - string sticker_url = 9; // 表情URL - string post_id = 10; // 文章ID + string sticker_url = 9; // 表情 URL + string post_id = 10; // 文章 ID string post_title = 11; // 文章标题 string post_content = 12; // 文章内容 string post_content_type = 13; // 文章类型 - string expression_id = 15; // 个人表情ID(不知道为啥为STR) + string expression_id = 15; // 个人表情 ID (不知道为啥为类型是字符串) string quote_image_url = 16; // 引用图片直链,https://... string quote_image_name = 17; // 引用图片文件名称 uint64 file_size = 18; // 文件/图片大小(字节) - string video_url = 19; // 视频URL - string audio_url = 21; // 语音URL + string video_url = 19; // 视频 URL + string audio_url = 21; // 语音 URL uint64 audio_time = 22; // 语音时长 string quote_video_url = 23; // 引用视频直链,https://... uint64 quote_video_time = 24; // 引用视频时长 - uint64 sticker_item_id = 25; // 表情ID - uint64 sticker_pack_id = 26; // 表情包ID + uint64 sticker_item_id = 25; // 表情 ID + uint64 sticker_pack_id = 26; // 表情包 ID string call_text = 29; // 语音通话文字 string call_status_text = 32; // 语音通话状态文字 uint64 width = 33; // 图片的宽度 @@ -775,9 +768,9 @@ POST /v1/msg/list-message-edit-record 请求体： -```JSONC +```JSON { - "msgId": "12312312312312312312312313", // 信息ID + "msgId": "12312312312312312312312313", // 信息 ID "size": 10, // 获取的历史编辑内容数 "page": 1 // 页面数 } @@ -785,16 +778,16 @@ POST /v1/msg/list-message-edit-record 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { - "id": 1018684, // 信息编辑ID - "msgId": "123123123123123123123123", // 信息ID + "id": 1018684, // 信息编辑 ID + "msgId": "123123123123123123123123", // 信息 ID "contentType": 1, // 信息类别 - "contentOld": "{\"text\":\"测试原始编辑文本\"}", // 信息文本，转义后json数据 + "contentOld": "{\"text\":\"测试原始编辑文本\"}", // 信息文本，转义后 json 数据 "createTime": 1231231231230, // 信息创建时间戳 "msgTime": 1231231231230 // 编辑时间戳 } @@ -802,7 +795,7 @@ POST /v1/msg/list-message-edit-record ], "total": 1 // 历史编辑总数 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -819,22 +812,22 @@ POST /v1/msg/button-report 请求体: ```ProtoBuf -msg_id: "123123123123123123" // 信息ID -chat_type: 2 // 对象类型, 1-用户 2-群聊 3-机器人 -chat_id: "123" // 对象ID -user_id: "123" // 按钮事件发送者ID +msg_id: "123123123123123123" // 信息 ID +chat_type: 2 // 对象类型 +chat_id: "123" // 对象 ID +user_id: "123" // 按钮事件发送者 ID button_value: "测试按钮文本" // 欲点击按钮的值 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 通过按钮事件点击消息 message button_report_send { - string msg_id = 2; // 信息ID - uint64 chat_type = 3; // 对象类型, 1-用户 2-群聊 3-机器人 - string chat_id = 4; // 对象ID - string user_id = 5; // 按钮事件发送者ID + string msg_id = 2; // 信息 ID + uint64 chat_type = 3; // 对象类型 + string chat_id = 4; // 对象 ID + string user_id = 5; // 按钮事件发送者 ID string button_value = 6; // 欲点击按钮的值 } ``` @@ -842,17 +835,17 @@ message button_report_send { ::: 响应体: -列出的是指定消息ID前的消息. +列出的是指定消息 ID 前的消息. ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 按钮事件点击返回状态信息 @@ -876,19 +869,19 @@ POST /v1/msg/recall-msg 请求体: ```ProtoBuf -msg_id: "123123123123123123" // 信息ID -chat_id: "123" // 信息所属对象ID -chat_type: 2 // 信息所属对象类型, 1-用户 2-群聊 3-机器人 +msg_id: "123123123123123123" // 信息 ID +chat_id: "123" // 信息所属对象 ID +chat_type: 2 // 信息所属对象类型 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto -// 通过msgId撤回消息 +// 通过 msgId 撤回消息 message recall_msg_send { - string msg_id = 2; // 信息ID - string chat_id = 3; // 信息所属对象ID - uint64 chat_type = 4; // 信息所属对象类型, 1-用户 2-群聊 3-机器人 + string msg_id = 2; // 信息 ID + string chat_id = 3; // 信息所属对象 ID + uint64 chat_type = 4; // 信息所属对象类型 } ``` @@ -898,13 +891,13 @@ message recall_msg_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 撤回消息返回数据 @@ -928,20 +921,20 @@ POST /v1/msg/recall-msg-batch 请求体: ```ProtoBuf -msg_id: "123123123123123123" // 信息ID +msg_id: "123123123123123123" // 信息 ID // ... -chat_id: "123" // 信息所属对象ID -chat_type: 2 // 信息所属对象类型, 1-用户 2-群聊 3-机器人 +chat_id: "123" // 信息所属对象 ID +chat_type: 2 // 信息所属对象类型 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto -// 通过msgId撤回消息 +// 通过 msgId 撤回消息 message recall_msg_batch_send { - repeated string msg_id = 2; // 信息ID - string chat_id = 3; // 信息所属对象ID - uint64 chat_type = 4; // 信息所属对象类型, 1-用户 2-群聊 3-机器人 + repeated string msg_id = 2; // 信息 ID + string chat_id = 3; // 信息所属对象 ID + uint64 chat_type = 4; // 信息所属对象类型 } ``` @@ -951,13 +944,13 @@ message recall_msg_batch_send { ```ProtoBuf status { - number: 114514 + request_id: 114514 code: 1 msg: "success" } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 批量信息撤回返回状态 @@ -980,19 +973,19 @@ POST /v1/msg/file-download-record 请求体: -```JSONC +```JSON { - "msgId": "5040d27fc975416680a14e5a1b37ef06", // 文件消息id + "msgId": "5040d27fc975416680a14e5a1b37ef06", // 文件消息 id "downloadPath": "/storage/emulated/0/Download/云湖/恶臭(1).txt" // 下载路径 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1008,13 +1001,13 @@ POST v1/msg/msg-forward 请求体: -```JSONC +```JSON { - "msgId": "e22342a5a1a54f03bc3xxxxxxxxxxxx", // 被转发的消息msgId + "msgId": "e22342a5a1a54f03bc3xxxxxxxxxxxx", // 被转发的消息 msgId "chatType": 2, // 被转发消息的会话类型 "receive": [ { - "chatId": "1234567", // 要转发到的会话id + "chatId": "1234567", // 要转发到的会话 id "chatType": 1 // 要转发到的会话类型 } ] @@ -1023,10 +1016,10 @@ POST v1/msg/msg-forward 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -1043,20 +1036,20 @@ POST v1/msg/pic-list-message-by-mid-seq 请求体： ```ProtoBuf -image_id: 110617 // 图片id +image_id: 110617 // 图片 id chat_type: 2 // 会话类型 -chat_id: "418769995" // 会话id +chat_id: "418769995" // 会话 id earlier_quantities: 10 // 前面（消息时间较早）的图片数量 latest_quantities: 0 // 后面（消息时间较新）的图片数量 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto meassage pic-list-message-by-mid-seq { - uint64 image_id = 3; // 图片id + uint64 image_id = 3; // 图片 id uint64 chat_type = 4; // 会话类型 - string chat_id = 5; // 会话id + string chat_id = 5; // 会话 id uint64 earlier_quantities = 6; // 前面（消息时间较早）的图片数量 uint64 latest_quantities = 7; // 后面（消息时间较新）的图片数量 } @@ -1067,7 +1060,7 @@ meassage pic-list-message-by-mid-seq { 响应体： ```proto -// 和list-message/list-message-by-seq/list-message-by-mid-seq的proto共用 +// 和 list-message/list-message-by-seq/list-message-by-mid-seq 的 proto 共用 ``` ## 删除消息（不是撤回） @@ -1084,19 +1077,19 @@ POST /v1/msg/delete 请求体： -```JSONC +```JSON { - "chatId": "123", // 聊天ID - "msgId": "123", // 消息ID + "chatId": "123", // 聊天 ID + "msgId": "123", // 消息 ID "chatType": 1 // 聊天类型 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/report.md b/src/api/v1/report.md index 1d8d71f6..45ec9d86 100644 --- a/src/api/v1/report.md +++ b/src/api/v1/report.md @@ -13,8 +13,8 @@ POST /v1/report/create ```JSONC { - "chatId": "123", // 对象id - "chatType": 2, // 对象类型，1-用户，2-群聊，3-机器人 + "chatId": "123", // 对象 id + "chatType": 2, // 对象类型 "chatName": "测试会话名称", // 对象名称 "content": "测试举报内容", // 举报内容 "url": "https://...", // 举报提交的图片 @@ -26,7 +26,7 @@ POST /v1/report/create ```JSONC { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/search.md b/src/api/v1/search.md index 6c5cbd26..5759fa08 100644 --- a/src/api/v1/search.md +++ b/src/api/v1/search.md @@ -17,7 +17,7 @@ POST /v1/search/home-search 请求体： -```JSONC +```JSON { "word": "114514" // 搜索关键词 } @@ -25,35 +25,35 @@ POST /v1/search/home-search 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { "title": "用户", // 类型标题 - "list": null // 搜索用户，没有就显示null + "list": null // 搜索用户，没有就显示 null }, { "title": "群组", // 类型标题 "list": [ { - "friendId": "114514", // 群聊id - "friendType": 2, // 识别对象类别，1-用户，2-群聊，3-机器人 + "friendId": "114514", // 群聊 id + "friendType": 2, // 识别对象类别 "nickname": "114514", // 群聊名字 "name": "", - "avatarUrl": "https://chat-img.jwznb.com/ba7631819aaff2fc5799bbf6f279c606.jpg", // 群聊头像url + "avatarUrl": "https://chat-img.jwznb.com/ba7631819aaff2fc5799bbf6f279c606.jpg", // 群聊头像 url "hit": 1 } ] }, { "title": "机器人", // 类型标题 - "list": null // 搜索机器人，没有就显示null + "list": null // 搜索机器人，没有就显示 null } ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -69,12 +69,12 @@ POST /v1/search/chat-search 请求体： -```JSONC +```JSON { "word": "3598257", // 搜索词 - "chatId": "test", // 对象ID + "chatId": "test", // 对象 ID "chatType": 2, // 对象类别 - "type": "all", // 信息类别，1-文本，3-markdown，4-文件，6-文章，7-表情包，8-html + "type": "all", // 信息类别，1-文本，3-markdown，4-文件，6-文章，7-表情，8-html "size": 30, // "time": 9999999999999, // 涵盖信息时间戳，只返回此时间戳内的信息 "direction":1 // 未知 @@ -83,15 +83,15 @@ POST /v1/search/chat-search 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { - "id": "123", // 信息ID + "id": "123", // 信息 ID "sequence": 123, // 第几条信息 - "chatId": "123", // 信息所处对象ID + "chatId": "123", // 信息所处对象 ID "chatType": 0, // 未知，不是信息所处对象类别 "name": "测试发送者名称", // 发送者名称 "avatarUrl": "https://...", @@ -103,6 +103,6 @@ POST /v1/search/chat-search // ... ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` diff --git a/src/api/v1/share.md b/src/api/v1/share.md index 79f7fc40..e7c28a51 100644 --- a/src/api/v1/share.md +++ b/src/api/v1/share.md @@ -17,33 +17,33 @@ POST /v1/share/info 请求体： -```JSONC +```JSON { - "key": "9o5UKnYgLk6z", // 分享链接key（来自 https://yhfx.jwznb.com/share?key=9o5UKnYgLk6z&ts=1754730310 内key的值 ） + "key": "9o5UKnYgLk6z", // 分享链接 key（来自 https://yhfx.jwznb.com/share?key=9o5UKnYgLk6z&ts=1754730310 内 key 的值 ） "ts": "1754730310" // 创建分享链接时间戳（ts=timestamp） } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "share": { "id": 33110, // 第33110个群聊 - "user_id": "114514", // 用户id + "user_id": "114514", // 用户 id "chat_name": "咸料", // 分享链接会话名称 "chat_type": 2, // 分享链接会话类型 - "chat_id": "65535", // 会话id - "key": "123123", // 分享链接key（来自 https://yhfx.jwznb.com/share?key=123123&ts=123123123 内key的值 ） - "create_by": "114514", // 分享链接创建者id + "chat_id": "65535", // 会话 id + "key": "123123", // 分享链接 key（来自 https://yhfx.jwznb.com/share?key=123123&ts=123123123 内 key 的值 ） + "create_by": "114514", // 分享链接创建者 id "create_time": 123123123, // 创建分享链接时间戳 - "imageUrl": "share/...", // 分享链接会话头像url + "imageUrl": "share/...", // 分享链接会话头像 url "imageName": "resources/share_bg/bg1.jpg" // 图片名称 } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -59,7 +59,7 @@ POST /v1/share/create 请求体： -```JSONC +```JSON { "chatId": "会话id", "chatType": 2, // 会话类型，1-用户，2-群聊，3-机器人 @@ -69,15 +69,15 @@ POST /v1/share/create 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "imageKey": "share/...", // 图片key - "key": "123123123", // 分享链接的key - "shareUrl": "https://yhfx.jwznb.com/", // 分享开头的url + "imageKey": "share/...", // 图片 key + "key": "123123123", // 分享链接的 key + "shareUrl": "https://yhfx.jwznb.com/", // 分享链接的 URL "ts": 123123123 // 分享链接创建时间戳 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` diff --git a/src/api/v1/sticker.md b/src/api/v1/sticker.md index 12be447d..447f6ff5 100644 --- a/src/api/v1/sticker.md +++ b/src/api/v1/sticker.md @@ -17,7 +17,7 @@ POST /v1/sticker/list 响应体: -```JSONC +```JSON { "code": 1, "data": { @@ -25,24 +25,25 @@ POST /v1/sticker/list { "id": 114514, "name": "表情包名称", - "createBy": "7356666", // 创建者ID + "createBy": "7356666", // 创建者 ID "createTime": 114514, // 创建时间戳 "delFlag": 0, // 是否被删除 "userCount": 2, // 使用人数 - "hot": 0, // 表情包热度,不知道为啥全0 + "hot": 0, // 表情包热度,不知道为啥全 0 "uuid": "dddddddd-dddd-2333-1145-ddddddabcdef", // UUID "updateTime": 2333, // 更新时间戳 - "sort": 0, // 分类?我这边都是0 + "sort": 0, // 分类?我这边都是 0 "stickerItems": [ { "id": 114514, "name": "表情名称", - "url": "sticker/114514abcdd444456aaaaaaaaee0d454.jpg", // 表情包URL,需要前面加上 https://chat-img.jwznb.com/ - "stickerPackId": 114514, // 所属表情包ID - "createBy": "7356666", // 创建者ID + "url": "sticker/114514abcdd444456aaaaaaaaee0d454.jpg", // 表情包 URL,需要前面加上 https://chat-img.jwznb.com/ + "stickerPackId": 114514, // 所属表情包 ID + "createBy": "7356666", // 创建者 ID "createTime": 2333, // 更新时间戳 "delFlag": 0 - } + }, + // ... ] } ] @@ -63,36 +64,36 @@ POST /v1/sticker/detail 请求体: -```JSONC +```JSON { - "id": 123 // 表情包ID + "id": 123 // 表情包 ID } ``` 响应体: -```JSONC +```JSON { "code": 1, "data": { "stickerPack": { - "id": 894, // 表情包ID + "id": 894, // 表情包 ID "name": "图标梗", // 表情包名称 "createBy": "9120256", // 创建者 "createTime": 1730724963, // 创建时间(时间戳) "delFlag": 0, "userCount": 8, // 用户人数 - "hot": 0, // 热度? 我这边抓到的都是0 - "uuid": "216d7881-64ae-4409-aa0a-4f4d1a8f649d", // uuid + "hot": 0, // 热度? 我这边抓到的都是 0 + "uuid": "216d7881-64ae-4409-aa0a-4f4d1a8f649d", // UUID "updateTime": 1754363209, // 更新时间 "sort": 0, // 分类相关? "stickerItems": [ { "id": 18951, // 表情ID "name": "汇总部分", // 表情名称 - "url": "sticker/4599f91519364bcc2be6718c3915d388.jpg", // 表情URL,前面需加上 https://chat-img.jwznb.com/ - "stickerPackId": 894, // 所属表情包ID - "createBy": "9120256", // 创建者ID + "url": "sticker/4599f91519364bcc2be6718c3915d388.jpg", // 表情 URL,前面需加上 https://chat-img.jwznb.com/ + "stickerPackId": 894, // 所属表情包 ID + "createBy": "9120256", // 创建者 ID "createTime": 1730724991, // 创建时间 "delFlag": 0 }, @@ -100,8 +101,8 @@ POST /v1/sticker/detail ] }, "user": { - "id": 56922, // 似乎是名称ID? - "user_id": "9120256", // 创建者用户ID + "id": 56922, // 似乎是名称 ID? + "user_id": "9120256", // 创建者用户 ID "nickname": "千米", // 创建者用户名 "avatar_url": "https://uapis.cn/api/imgapi/bq/youshou.php" // 头像地址 } @@ -122,18 +123,18 @@ POST /v1/sticker/add 请求体: -```JSONC +```JSON { - "id": 894 // 表情包ID + "id": 894 // 表情包 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -149,18 +150,18 @@ POST /v1/sticker/remove-sticker-pack 请求体: -```JSONC +```JSON { - "id": 123 // 要移除的表情包的ID + "id": 123 // 要移除的表情包的 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -176,11 +177,11 @@ POST /v1/sticker/sort 请求体: -```JSONC +```JSON { "sort": "[ { - \"id\":\"123\", // 表情包ID + \"id\":\"123\", // 表情包 ID \"sort\":\"2\" // 排序,数字越大越靠前 }, { @@ -192,13 +193,13 @@ POST /v1/sticker/sort } ``` -::: details 备注: 使用Python请求代码 +::: details 备注: 使用 Python 请求代码 ```Python headers = {"token": token} sticker = [ { - "id": "1","sort": "1", # 不知道为啥id前面是数值这里为啥变成了字符串,sort越大排序越靠前 + "id": "1","sort": "1", # 不知道为啥 id 前面是数值这里为啥变成了字符串,sort 越大排序越靠前 }, { "id": "2","sort": "2" @@ -213,9 +214,9 @@ print(response.text) 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/sticky.md b/src/api/v1/sticky.md index 780c7e9f..fd5e74e4 100644 --- a/src/api/v1/sticky.md +++ b/src/api/v1/sticky.md @@ -17,27 +17,27 @@ POST /v1/sticky/list 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "sticky": [ { - "id": 8977, // 置顶ID - "chatType": 2, // 会话对象类别，1-用户，2-群聊，3-机器人 - "chatId": "114514", // 会话对象id + "id": 8977, // 置顶 ID + "chatType": 2, // 会话对象类别: 1-用户，2-群聊，3-机器人 + "chatId": "114514", // 会话对象 id "chatName": "example", // 会话对象名字 "sort": 1751616217, // 不知道，跟群聊创建时间戳一样（? "avatarUrl": "https://chat-img.jwznb.com/xxxxxxxxxxxxxxx.jpg", // 群聊头像地址 "createTime": 1751616217, // 会话对象创建时间戳 "delFlag": 0, - "userId": "1234567", // 用户id - "certificationLevel": 0 // 识别是否为官方出品，1为官方出品，0则不是 + "userId": "1234567", // 用户 id + "certificationLevel": 0 // 认证等级: 2-地区,1-官方,0-非官方 } // ... ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -53,19 +53,19 @@ POST /v1/sticky/add 请求体： -```JSONC +```JSON { - "chatId": "430084557", // 会话id - "chatType": 2 // 会话类型，1-用户，2-群聊，3-机器人 + "chatId": "430084557", // 会话 id + "chatType": 2 // 会话类型: 1-用户，2-群聊，3-机器人 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -81,19 +81,19 @@ POST /v1/sticky/delete 请求体： -```JSONC +```JSON { - "chatId": "430084557", // 会话id - "chatType": 2 // 会话类型，1-用户，2-群聊，3-机器人 + "chatId": "430084557", // 会话 id + "chatType": 2 // 会话类型: 1-用户，2-群聊，3-机器人 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -109,17 +109,17 @@ POST /v1/sticky/topping 请求体： -```JSONC +```JSON { - "id": 5753 // 置顶id + "id": 5753 // 置顶 id } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/user.md b/src/api/v1/user.md index c3a3da97..61f466ab 100644 --- a/src/api/v1/user.md +++ b/src/api/v1/user.md @@ -11,14 +11,14 @@ POST /v1/user/captcha 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "b64s": "image//png;base64...", // 人机验证图片base64 - "id": "123" // 人机验证ID + "b64s": "image//png;base64...", // 人机验证图片 Base64 + "id": "123" // 人机验证 ID }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -28,24 +28,24 @@ POST /v1/user/verification-login 请求体: -```JSONC +```JSON { "mobile": "12312312300", // 登录手机号 "captcha": "123123", // 手机验证码 "deviceId": "awa", // 登录设备唯一标识符，可自定义 - "platform": "windows" // 登录平台名称,一般为windows,web等可自定义 + "platform": "windows" // 登录平台名称,一般为 windows,web 等可自定义,不校验 } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "token": "f87TJHF9-****-****-************" // 账户登录token + "token": "f87TJHF9-****-****-************" // 账户 token }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -63,25 +63,25 @@ GET /v1/user/info ```ProtoBuf status { - number: 114514 - code: 1 // 请求状态码，1为正常 - msg: "success" // 返回消息 + request_id: 114514 + code: 1 + msg: "success" } data { - id: "123" // 用户id + id: "123" // 用户 id name: "测试用户" // 用户名 - avatar_url: "https://..." // 头像URL - avatar_id: 123 //头像ID + avatar_url: "https://..." // 头像 URL + avatar_id: 123 //头像 ID phone: "12312312300" // 手机号 email: "123@123.com" // 邮箱 coin: 123 // 金币数 - is_vip: 0 // 是否为VIP - vip_expired_time: 1231231230 // VIP过期时间 + is_vip: 0 // 是否为 VIP + vip_expired_time: 1231231230 // VIP 过期时间 invitation_code: "123" // 邀请码 } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 用户自身信息 @@ -90,15 +90,15 @@ message info { Status status = 1; message Data { // 11是描述手机号长整数的,懒得解析了 - string id = 1; // 用户id + string id = 1; // 用户 id string name = 2; // 用户名 - string avatar_url = 4; // 头像URL - uint64 avatar_id = 5; // 头像ID + string avatar_url = 4; // 头像 URL + uint64 avatar_id = 5; // 头像 ID string phone = 6; // 手机号 string email = 7; // 邮箱 double coin = 8; // 金币数 - int32 is_vip = 9; // 是否为VIP - uint64 vip_expired_time = 10; // VIP过期时间 + int32 is_vip = 9; // 是否为 VIP + uint64 vip_expired_time = 10; // VIP 过期时间 string invitation_code = 12; // 邀请码 } Data data = 2; @@ -120,10 +120,10 @@ POST /v1/user/get-user 请求体: ```ProtoBuf -id: "用户id" +id: "用户 id" ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message get_user_send { @@ -137,21 +137,21 @@ message get_user_send { ```ProtoBuf status { - number: 123456 - code: 1 // 请求状态码，1为正常 - msg: "success" // 返回消息 + request_id: 123456 + code: 1 + msg: "success" } data { - id: "123" // 用户ID + id: "123" // 用户 ID name: "测试用户" // 用户名 - name_id: 123 // 名称ID - avatar_url: "https://..." // 头像URL - avatar_id: 123 // 头像ID + name_id: 123 // 名称 ID + avatar_url: "https://..." // 头像 URL + avatar_id: 123 // 头像 ID register_time: "1234-12-12 12:12:12" // 注册时间(YYYY-MM-DD hh:mm:ss) online_day: 123 // 在线时长 continuous_online_day: 123 // 连续在线时长 - is_vip: 1 // 是否为VIP - vip_expired_time: 123123123 // VIP过期时间(时间戳) + is_vip: 1 // 是否为 VIP + vip_expired_time: 123123123 // VIP 过期时间(时间戳) ban_time: 123123123 // 封禁结束时间(时间戳) medal [ { @@ -178,28 +178,28 @@ data { "profile_info": { "flag": 1, // ？ "scoreOrId": 1295971200, - "province": "省（自治区）", // IP归属地 - "city": "市", // IP归属地 - "district": "区（县）", // IP归属地 + "province": "省（自治区）", // IP 归属地 + "city": "市", // IP 归属地 + "district": "区（县）", // IP归 属地 }, - "country": "国家或地区" // IP归属地 + "country": "国家或地区" // IP 归属地 } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 勋章信息 message Medal_info { - uint64 id = 1; // 勋章ID + uint64 id = 1; // 勋章 ID string name = 2; // 勋章名称 uint64 sort = 5; // 勋章顺序 } message Remark_info { string remark_name = 1; // 备注名 - string phone_number = 2; // 手机号 - string extra_remark = 3; // 其他备注（格式为JSON，示例：'[{"key":"他是","value":"我的朋友"},{"key":"职业","value":"打工人"}]' + string phone = 2; // 手机号 + string extra_remark = 3; // 其他备注（格式为 JSON，示例：'[{"key":"他是","value":"我的朋友"},{"key":"职业","value":"打工人"}]' } message Profile_info { @@ -214,24 +214,24 @@ message Profile_info { // 获取用户信息 message get_user { - Status status = 1; // 状态码 - Data data = 2; //数据 + Status status = 1; + Data data = 2; // 数据 message Data { - string id = 1; // 用户id + string id = 1; // 用户 id string name = 2; // 用户名 - uint64 name_id = 3; // 名称ID - string avatar_url = 4; //头像URL - uint64 avatar_id = 5; // 头像ID + uint64 name_id = 3; // 名称 ID + string avatar_url = 4; //头像 URL + uint64 avatar_id = 5; // 头像 ID repeated Medal_info medal = 6; // 勋章信息 string register_time = 7; // 注册时间,格式: YYYY-MM-DD hh:mm:ss uint64 ban_time = 10; // 封禁结束时间(时间戳) uint64 online_day = 11; // 在线天数 uint64 continuous_online_day = 12; // 连续在线天数 - int32 is_vip = 13; // 是否为vip - uint64 vip_expired_time = 14; // VIP过期时间(时间戳) + int32 is_vip = 13; // 是否为 vip + uint64 vip_expired_time = 14; // VIP 过期时间(时间戳) Remark_info remark_info = 18; // 备注信息 Profile_info profile_info = 19; // 用户资料信息 - string ipGeo = 20; // IP归属地（国家） + string ip_geo = 20; // IP归属地（国家） } } ``` @@ -252,29 +252,29 @@ POST /v1/user/medal ```ProtoBuf status { - number: 114514 - code: 1 // 请求状态码，1为正常 - msg: "success" // 返回消息 + request_id: 114514 + code: 1 + msg: "success" } medal { - id: 1 // 勋章ID + id: 1 // 勋章 ID name: "测试勋章" // 勋章名称 sort: 100 // 勋章顺序 } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 勋章 message medal { - Status status = 1; // 状态信息 + Status status = 1; repeated Medal_info medal = 2; // 勋章信息 } // 勋章信息 message Medal_info { - uint64 id = 1; // 勋章ID + uint64 id = 1; // 勋章 ID string name = 2; // 勋章名称 uint64 sort = 5; // 勋章顺序 } @@ -298,7 +298,7 @@ POST /v1/user/edit-nickname name: "123" // 用户名称 ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message edit_nickname_send { @@ -312,18 +312,18 @@ message edit_nickname_send { ```ProtoBuf status { - number: 114514 - code: 1 // 请求状态码，1为正常 - msg: "success" // 返回消息 + request_id: 114514 + code: 1 + msg: "success" } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 更改名称状态信息 message edit_nickname { - Status status = 1; // 状态信息 + Status status = 1; } ``` @@ -342,10 +342,10 @@ POST /v1/user/edit-avatar 请求体: ```ProtoBuf -url: "https://..." // 用户头像url +url: "https://..." // 用户头像 url ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto message edit_avatar_send { @@ -359,18 +359,18 @@ message edit_avatar_send { ```ProtoBuf status { - number: 114514 - code: 1 // 请求状态码，1为正常 - msg: "success" // 返回消息 + request_id: 114514 + code: 1 + msg: "success" } ``` -::: details ProtoBuf数据结构 +::: details ProtoBuf 数据结构 ```proto // 更改名称状态信息 message edit_avatar { - Status status = 1; // 状态信息 + Status status = 1; } ``` @@ -382,7 +382,7 @@ POST /v1/user/email-login 请求体： -```JSONC +```JSON { "email": "123456@example.com", // 登录邮箱 "password": "123456", // 登录密码 @@ -393,13 +393,13 @@ POST /v1/user/email-login 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "token": "abcdefg1-xxxx-xxxx-xxxxxxxxxx" // 登录效验令牌 + "token": "abcdefg1-xxxx-xxxx-xxxxxxxxxx" // 账号 token }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -415,18 +415,18 @@ POST /v1/user/logout 请求体: -```JSONC +```JSON { - "device-id": "123123123" // 设备ID + "device-id": "123123123" // 设备 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -442,7 +442,7 @@ POST /v1/user/recommend-category-list 请求体： -```JSONC +```JSON { "appChannel": "default" } @@ -450,9 +450,9 @@ POST /v1/user/recommend-category-list 响应体： -```JSONC +```JSON { - "code": 1, // 状态码，正常为1 + "code": 1, "data": { "categories": [ // 群聊类别 "精选", @@ -464,7 +464,7 @@ POST /v1/user/recommend-category-list "资讯订阅" ] }, - "msg": "success" // 状态信息 + "msg": "success" } ``` @@ -480,7 +480,7 @@ POST /v1/user/recommend-list 请求体： -```JSONC +```JSON { "category": "精选", // 群聊类别 "keyword": "", // 关键词 @@ -491,13 +491,13 @@ POST /v1/user/recommend-list 响应体： -```JSONC +```JSON { - "code": 1, // 状态码，正常为1 + "code": 1, "data": { "groupList": [ { - "chatId": "123", // 群聊id + "chatId": "123", // 群聊 id "banId": 0, // 顾名思义 "nickname": "测试群聊名称", // 群聊名字 "introduction": "测试群聊简介", // 群聊介绍 @@ -508,7 +508,7 @@ POST /v1/user/recommend-list // ... ] }, - "msg": "success" // 状态信息 + "msg": "success" } ``` @@ -524,27 +524,27 @@ POST /v1/user/recommend 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "botList": [ { - "chatId": "123", // 机器人id + "chatId": "123", // 机器人 id "chatType": "3", // 识别对象类别，1-用户，2-群聊，3-机器人 "headcount": "123", // 使用人数 "nickname": "测试机器人名称", // 机器人名称 "introduction": "测试机器人简介", // 机器人简介 "introductions": "", - "avatarUrl": "https://...", // 机器人头像url + "avatarUrl": "https://...", // 机器人头像 url "isAdd": 1, // 是否添加（1为可添加，0为不可添加） - "isApply": 0, // 是否应用 - "alwaysAgree": 0 // 是否总是同意 + "isApply": 0, // 是否启用 + "alwaysAgree": 0 // 是否自动进群 } // ... ] }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -560,7 +560,7 @@ POST /v1/user/module-ignore-info 请求体： -```JSONC +```JSON { "deviceId": "1234" } @@ -568,19 +568,19 @@ POST /v1/user/module-ignore-info 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "ignore": { - "id": 0, // 可能是模块设置id - "userId": "1234567", // 用户id + "id": 0, // 可能是模块设置 id + "userId": "1234567", // 用户 id "updateTime": 123455660, // 更新时间戳 - "deviceId": "1234", // 设备id - "ignore": ",30,20,10" // 模块id，10-隐藏社区页面，20-隐藏发现页面，30-精简我的界面 + "deviceId": "1234", // 设备 id + "ignore": ",30,20,10" // 模块id: 10-隐藏社区页面，20-隐藏发现页面，30-精简我的界面 } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -596,7 +596,7 @@ POST /v1/user/module-ignore 请求体： -```JSONC +```JSON { "deviceId": "1234", "ignore": ",30,20,10" // 模块id，10-隐藏社区页面，20-隐藏发现页面，30-精简我的界面 @@ -605,10 +605,10 @@ POST /v1/user/module-ignore 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -624,7 +624,7 @@ POST /v1/user/notification-status 请求体： -```JSONC +```JSON { "deviceId": "1114514", // 设备id "registrationId": "114514" // 注册id @@ -633,15 +633,15 @@ POST /v1/user/notification-status 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "notification": { // 通知json - "id": 110061, // 注册id - "userId": "114514", // 用户id - "deviceId": "114514", // 设备id - "registrationId": "114514", // 通知注册id + "notification": { // 通知 json + "id": 110061, // 注册 id + "userId": "114514", // 用户 id + "deviceId": "114514", // 设备 id + "registrationId": "114514", // 通知注册 id "isOpen": 1, // 是否打开系统消息通知（设置”系统消息通知“选项可控制这个数值，1-打开，0-关闭） "type": 2, // 类型 "delFlag": 0, @@ -649,7 +649,7 @@ POST /v1/user/notification-status "updateTime": 1231231230 // 更新时间戳 } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -665,10 +665,10 @@ POST /v1/user/notification-info 请求体： -```JSONC +```JSON { - "deviceId": "114514", // 设备id - "registrationId": "114514", // 注册通知id + "deviceId": "114514", // 设备 id + "registrationId": "114514", // 注册通知 id "isOpen": 1, // // 是否打开系统消息通知（设置”系统消息通知“选项可控制这个数值，1-打开，0-关闭） "type": 2 // 类型 } @@ -676,10 +676,10 @@ POST /v1/user/notification-info 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -695,7 +695,7 @@ POST /v1/user/gold-coin-increase-decrease-record 请求体： -```JSONC +```JSON { "size": 20, // 尺寸 "page": 1 // 页数 @@ -704,14 +704,14 @@ POST /v1/user/gold-coin-increase-decrease-record 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "goldCoinRecord": [ { - "id": 193275, // 金币记录id - "userId": "用户id", + "id": 193275, // 金币记录 id + "userId": "用户 id", "typ": 8, // 类型 "beforeAmount": 55.01, // 之前金币数量 "afterAmount": 57.01, // 之后的金币数量 @@ -722,9 +722,9 @@ POST /v1/user/gold-coin-increase-decrease-record } // ... ], - "total": 243 // 总共的金币记录 + "total": 243 // 金币记录的总数量 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -732,6 +732,8 @@ POST /v1/user/gold-coin-increase-decrease-record POST /v1/user/bing-phone +!!不要问为什么是 bing,我也不知道.!! + 请求头: | 名称 | 必须 | 备注 | @@ -740,7 +742,7 @@ POST /v1/user/bing-phone 请求体： -```JSONC +```JSON { "phone": "12312311230", // 欲绑定手机号 "captcha": "123123" // 短信验证码 @@ -749,10 +751,10 @@ POST /v1/user/bing-phone 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -760,6 +762,8 @@ POST /v1/user/bing-phone POST /v1/user/bing-email +!!不要问为什么是 bing,我也不知道.!! + 请求头: | 名称 | 必须 | 备注 | @@ -768,7 +772,7 @@ POST /v1/user/bing-email 请求体： -```JSONC +```JSON { "email": "123@123.com", // 欲绑定邮箱 "captcha": "123123" // 邮件验证码 @@ -777,10 +781,10 @@ POST /v1/user/bing-email 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -796,7 +800,7 @@ POST /v1/user/change-phone-check 请求体： -```JSONC +```JSON { "phone": "12312341230", // 欲绑定手机号 "captcha": "123123" // 短信验证码 @@ -805,10 +809,10 @@ POST /v1/user/change-phone-check 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -824,7 +828,7 @@ POST /v1/user/change-email-check 请求体： -```JSONC +```JSON { "email": "123@123.com", // 欲绑定邮箱 "captcha": "123123" // 邮件验证码 @@ -833,10 +837,10 @@ POST /v1/user/change-email-check 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -846,7 +850,7 @@ POST /v1/user/forget-password 请求体： -```JSONC +```JSON { "email": "123@123.com", // 欲绑定邮箱 "captcha": "123123", // 邮件验证码 @@ -856,10 +860,10 @@ POST /v1/user/forget-password 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -875,10 +879,10 @@ POST /v1/user/save-user-data 请求体： -```JSONC +```JSON { "introduction": "111", // 个人简介 - "gender": 3, // 性别，1-男，2-女，3-其他 + "gender": 3, // 性别: 1-男，2-女，3-其他 "birthday": 1231231230, // 生日时间戳 "province": "北京市", // 所在地省份 "city": "北京城区", // 所在地城市 @@ -889,10 +893,10 @@ POST /v1/user/save-user-data 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -908,17 +912,17 @@ POST /v1/user/get-user-data 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "data": { - "id": 123, // 个人简介ID - "userId": "123", // 用户ID + "id": 123, // 个人简介 ID + "userId": "123", // 用户 ID "lastLoginTime": 1231231230, // 最后登录时间戳 "update_time": 1231231230, // 个人简介最后更新时间戳 "introduction": "测试个人简介", // 个人简介 - "gender": 3, // 性别，1-男，2-女，3-其他 + "gender": 3, // 性别: 1-男，2-女，3-其他 "birthday": 1231231230, // 生日时间戳 "province": "北京市", // 所在地省份 "city": "北京城区", // 所在地城市 @@ -926,7 +930,7 @@ POST /v1/user/get-user-data "locationCode": "110101" // 所在地邮政编码 } }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -942,16 +946,16 @@ POST /v1/user/get-user-show-adv 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { - "androidCodeId": "123", // Android代码ID + "androidCodeId": "123", // Android ID "bottomHeight": 123, // 底部高度 - "iosCodeId": "123", // IOS代码ID - "isShow": 0 // 是否显示，0-不显示，1-显示 + "iosCodeId": "123", // IOS ID + "isShow": 0 // 是否显示: 0-不显示，1-显示 }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -967,21 +971,21 @@ POST /v1/user/save-user-remarks 请求体： -```JSONC +```JSON { - "friendId": "123123123", // 好友ID + "friendId": "123123123", // 好友 ID "name": "测试好友备注名称", // 备注名称 "phone": "123123123", // 备注手机号 - "others": "[{\"key\":\"123\",\"value\":\"123\"}]" // 更多备注，需将数据按照此格式转义后填入 + "others": "[{\"key\":\"123\",\"value\":\"123\"}]" // 更多备注，需将数据转义后填入 } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -989,6 +993,8 @@ POST /v1/user/save-user-remarks POST /v1/user/cancel-user +!!谁 TMD 想出来的这种命名?!! + 请求头: | 名称 | 必须 | 备注 | @@ -997,7 +1003,7 @@ POST /v1/user/cancel-user 请求体： -```JSONC +```JSON { "phone": "123123123", // 手机号，手机号与邮箱之中只要有一个就行 "email": "123123123@123.com", // 邮箱，手机号与邮箱之中只要有一个就行 @@ -1007,10 +1013,10 @@ POST /v1/user/cancel-user 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` @@ -1026,17 +1032,17 @@ POST /v1/user/device-offline 请求体： -```JSONC +```JSON { - "deviceId": "123123123123123" // 设备ID，为登陆时填写的设备ID + "deviceId": "123123123123123" // 设备 ID，为登陆时填写的设备 ID } ``` 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回状态消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/verification.md b/src/api/v1/verification.md index 99396dae..b0426a3e 100644 --- a/src/api/v1/verification.md +++ b/src/api/v1/verification.md @@ -11,21 +11,21 @@ POST /v1/verification/get-verification-code 请求体: -```JSONC +```JSON { "mobile": "12312312300", // 手机号 "code": "123123", // 人机验证校验码 - "id": "123", // 人机验证ID - "platform": "windows" // 登录平台名称,一般为windows,web等可自定义 + "id": "123", // 人机验证 ID + "platform": "windows" // 登录平台名称,一般为 windows,web 等可自定义,后端不校验 } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` @@ -35,20 +35,20 @@ POST /v1/verification/get-email-verification-code 请求体: -```JSONC +```JSON { "email": "123@123.123", // 邮箱 - "typ": "forget_password", // 验证类别，forget_password-更改密码验证，其他所有验证都为空 + "typ": "forget_password", // 验证类别: forget_password-更改密码验证，其他所有验证都为空 "code": "123123", // 人机验证校验码 - "id": "123" // 人机验证ID + "id": "123" // 人机验证 ID } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 - "msg": "success" // 返回消息 + "code": 1, + "msg": "success" } ``` diff --git a/src/api/v1/vip.md b/src/api/v1/vip.md index d9484652..8978f116 100644 --- a/src/api/v1/vip.md +++ b/src/api/v1/vip.md @@ -17,33 +17,33 @@ POST /v1/vip/vip-product-list 请求体: -```JSONC +```JSON { - "platform": "Web" // 平台标识码，为web/Windows/android等 + "platform": "Web" // 平台标识码: 可选 web/Windows/android 等 } ``` 响应体: -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { - "id": 1, // 商品id + "id": 1, // 商品 id "name": "VIP月付", // 商品名 "description": "1个月", // 商品描述 "price": 10, // 商品价格（单位为人民币(元) "priceOriginal": 20, // 商品原价 - "day": 31, // vip持续时间 - "productId": "" // 产品id（？ - } + "day": 31, // vip 持续时间 + "productId": "" // 产品 id（？ + }, // ... ], "qrCodeUrl": "https://www.yhchat.com/" // 二维码(QRCode)获取地址（？ }, - "msg": "success" // 返回消息 + "msg": "success" } ``` @@ -59,21 +59,21 @@ GET /v1/vip/vip-benefits-list 响应体： -```JSONC +```JSON { - "code": 1, // 请求状态码，1为正常 + "code": 1, "data": { "list": [ { - "id": 1, // 特权id + "id": 1, // 特权 id "name": "尊贵身份标识", // 特权主名 "description": "贵族身份的象征", // 特权描述 "target": "", // 针对xxx "sort": 100 // 排序 - } + }, // ... ] }, - "msg": "success" // 返回消息 + "msg": "success" } ```