Skip to content

Commit 5141cdb

Browse files
Kauid323QianLin-Jiaxi
authored andcommitted
Create bot.md
1 parent f682052 commit 5141cdb

1 file changed

Lines changed: 75 additions & 0 deletions

File tree

src/api/v1/bot.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: bot
3+
---
4+
5+
未特别说明情况下请求域名均为 https://chat-go.jwzhd.com
6+
没写请求/响应项目表示不需要相关参数.
7+
8+
# 机器人商店banner
9+
10+
POST /v1/bot/banner
11+
12+
请求头:
13+
14+
|名称|必须|备注|
15+
|-----|-----|-----|
16+
|token|||
17+
18+
响应头:
19+
```JSONC
20+
{
21+
"code": 1, // 请求状态码,1为正常
22+
"data": {
23+
"banners": [
24+
{
25+
"id": 6, // banner的id
26+
"title": "机器人开发指南", // 标题
27+
"introduction": "依托开放的服务接口,用户可以打造属于自己的机器人,提升工作生活效率", // 介绍
28+
"targetId": "", // "查看详情"跳转的链接
29+
"targetUrl": "https://www.yhchat.com/document/1-3", // "查看详情"跳转的链接
30+
"imageUrl": "https://chat-img.jwznb.com/ca2b3753a9e7dbb94881b5f9364f7ffc.tmp", // banner背景图
31+
"sort": 40, // 排列顺序
32+
"delFlag": 0,
33+
"createTime": 0, // 创建时间
34+
"remark": "", // 备注
35+
"createBy": 0, // banner创建者
36+
"typ": 2 // 类型
37+
}
38+
// ...
39+
]
40+
},
41+
"msg": "success" // 返回消息
42+
}
43+
```
44+
45+
# 机器人商店列表
46+
47+
POST /v1/bot/new-list
48+
49+
请求头:
50+
51+
|名称|必须|备注|
52+
|-----|-----|-----|
53+
|token|||
54+
55+
响应头:
56+
```JSONC
57+
{
58+
"code": 1, // 请求状态码,1为正常
59+
"data": {
60+
"bots": [
61+
{
62+
"chatId": "35393533", // 机器人id
63+
"chatType": "3", // 识别对象类别,1-用户,2-群聊,3-机器人
64+
"headcount": "25", // 机器人使用人数
65+
"nickname": "红红火火恍恍惚惚", // 机器人名字
66+
"introduction": "介绍介绍介绍介绍介绍介绍介绍", // 机器人介绍
67+
"instructions": "",
68+
"avatarUrl": "https://chat-img.jwznb.com/1753199311790.647github-mark.png" // 机器人头像url
69+
}
70+
// ...
71+
]
72+
},
73+
"msg": "success" // 返回消息
74+
}
75+
```

0 commit comments

Comments
 (0)