# 修改指令面板
修改指定指令面板的配置内容,包括面板元素列表和备注。不影响已关联的用户/群列表
# 请求
# 基础信息
| 字段 | 值 |
|---|---|
| HTTP URL | /v2/panels/{panel_id} |
| HTTP Method | PUT |
| 接口频率限制 | 10 QPM |
# 路径参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| panel_id | string | 是 | 面板 ID |
# 请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| panel | Panel | 是 | 面板配置内容。传入后会覆盖原有的面板元素列表和备注,不影响已关联的用户/群列表 |
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| items | []PanelItem | 否 | 面板元素列表,定义面板中展示的指令或链接项,一个指令面板里最多配置 20 个面板元素 |
| remark | string | 否 | 面板备注,用于开发者标记面板用途,最多 255 个字符,不对用户展示 |
| version | integer | 否 | 当前版本号 |
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| name | string | 否 | 元素名称。type=command 时用户点击后该内容会填入聊天输入框;type=link 时仅用于面板展示 最多 14 个字符,约 7 个中文汉字 |
| desc | string | 否 | 元素描述,用于补充说明该指令或链接的功能,在面板中展示给用户 最多 30 个字符,约 15 个中文汉字 |
| type | string | 否 | 元素类型,可选值:command(指令)、link(链接跳转) |
| only_admin | boolean | 否 | 是否仅管理员可操作。true 时仅频道/群管理员可点击,false 时所有用户可点击 |
| link | string | 否 | 跳转链接 URL,仅 type=link 时有效。用户点击后在浏览器中打开该地址 |
# 请求示例
修改面板元素
{
"panel": {
"items": [
{
"type": "command",
"name": "新指令",
"desc": "更新后的指令"
}
],
"remark": "更新备注"
}
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 响应
# 响应体
| 名称 | 类型 | 描述 |
|---|---|---|
| version | integer | 本次修改后的面板版本号 |
# 响应示例
成功
{
"version": 1
}
1
2
3
2
3
# 错误码
| 错误码 | 描述 | 排查建议 |
|---|---|---|
| 40030006 | 指令面板不存在 | 确认 panel_id 是否正确 |
| 40030008 | URL 格式错误 | 确认 URL 以 https:// 开头 |
| 40030009 | 指令面板操作进行中,请稍后重试 | 存在并发操作冲突,请稍后重试 |
| 40030013 | 超出数量限制 | 请减少请求数量,具体限制值见返回信息中的 limit |
| 40030015 | 面板元素类型不合法 | panel_item.type 仅支持 command/link |
| 40030016 | 必填字段缺失 | 检查必填字段是否全部正确传入 |
| 40030018 | 当前场景不支持此操作 | 检查 scope 是否支持当前操作 |
| 40030020 | 内容存在安全风险,请修改后重试 | 请检查菜单/面板内容是否包含敏感信息 |
| 40030021 | 全局面板不支持添加指定关联对象 | target_type=all 的面板不支持此操作,请使用 specific 模式 |