Skip to content

Commit 91714f3

Browse files
committed
Update live.md
新加了几个API
1 parent eeb93cf commit 91714f3

1 file changed

Lines changed: 119 additions & 3 deletions

File tree

src/api/v1/live.md

Lines changed: 119 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: live
55
未特别说明情况下请求域名均为 https://chat-go.jwzhd.com
66
没写请求/响应项目表示不需要相关参数.
77

8-
## 获取指定语音频道进入token
8+
## 获取语音频道进入token
99

1010
POST /v1/live/add
1111

@@ -17,8 +17,8 @@ POST /v1/live/add
1717
请求体:
1818
```JSONC
1919
{
20-
roomId: "123123123123", // 目标群语音频道ID
21-
chatId: "123" // 目标语言频道所处对象ID
20+
"roomId": "123123123123", // 目标语音频道ID
21+
"chatId": "123" // 目标语言频道所处对象ID
2222
}
2323
```
2424

@@ -32,3 +32,119 @@ chatId: "123" // 目标语言频道所处对象ID
3232
"msg": "success" // 返回消息
3333
}
3434
```
35+
36+
## 关闭语音频道
37+
38+
POST /v1/live/close
39+
40+
请求头:
41+
|名称|必须|备注|
42+
|-----|------|-----|
43+
|token||语音频道管理员token|
44+
45+
请求体:
46+
```JSONC
47+
{
48+
"roomId": "123123123123", // 目标语音频道ID
49+
}
50+
```
51+
52+
响应头:
53+
```JSONC
54+
{
55+
"code": 1, // 请求状态码,1为正常
56+
"msg": "success" // 返回消息
57+
}
58+
```
59+
60+
## 挂断语音频道
61+
62+
POST /v1/live/hang_up
63+
64+
请求头:
65+
|名称|必须|备注|
66+
|-----|------|-----|
67+
|token|||
68+
69+
请求体:
70+
```JSONC
71+
{
72+
"roomId": "123123123123", // 目标语音频道ID
73+
}
74+
```
75+
76+
响应头:
77+
```JSONC
78+
{
79+
"code": 1, // 请求状态码,1为正常
80+
"data": {},
81+
"msg": "success" // 返回消息
82+
}
83+
```
84+
85+
## 获取语音频道信息
86+
87+
POST /v1/live/room-info
88+
89+
请求头:
90+
|名称|必须|备注|
91+
|-----|------|-----|
92+
|token|||
93+
94+
请求体:
95+
```JSONC
96+
{
97+
"roomId": "123123123123", // 目标语音频道ID
98+
}
99+
```
100+
101+
响应头:
102+
```JSONC
103+
{
104+
"code": 1, // 请求状态码,1为正常
105+
"data": {
106+
"room": {
107+
"id": 18658,
108+
"userId": "123", // 房间管理员用户ID
109+
"roomId": "ef8beba697c84a5f889af45211b449a1", // 房间ID
110+
"recvIds": "", // 未知
111+
"chatId": "872440499", // 房间ID所属对象
112+
"title": "测试频道", // 房间ID标题
113+
"chatType": 2, // 房间ID所属对象类别
114+
"status": 0, //房间状态
115+
"duration": 0, // 未知
116+
"typ": 2, // 未知
117+
"createBy": "8264925", // 房间创建用户名称
118+
"createTime": 1754454550, // 房间创建时间戳
119+
"updateBy": "8264925", // 房间更新用户名称
120+
"updateTime": 1754455159 // 房间创建时间戳
121+
}
122+
},
123+
"msg": "success" // 返回消息
124+
}
125+
```
126+
127+
## 编辑语音频道标题
128+
129+
POST /v1/live/title-edit
130+
131+
请求头:
132+
|名称|必须|备注|
133+
|-----|------|-----|
134+
|token||语音频道管理员token|
135+
136+
请求体:
137+
```JSONC
138+
{
139+
"roomId": "123123123123", // 目标语音频道ID
140+
"title": "测试语音频道名称" //目标语音频道名称
141+
}
142+
```
143+
144+
响应头:
145+
```JSONC
146+
{
147+
"code": 1, // 请求状态码,1为正常
148+
"msg": "success" // 返回消息
149+
}
150+
```

0 commit comments

Comments
 (0)