QQ频道机器人零基础开发详解(基于QQ官方机器人文档)[第六期]

吃点李子2024-09-14 14:05

QQ频道机器人零基础开发详解(基于QQ官方机器人文档)[第六期]

第六期介绍：频道模块之内容管理

目录

不懂得的也可以来私聊或评论区问哦～

原力到一千才可以推广，三连啊喂！！！

创建频道公告

接口

POST /guilds/{guild_id}/announces

功能描述

用于创建频道全局公告。

Content-Type
application/json

参数

字段名 类型 描述
message_id string 选填，消息 id
channel_id string 选填，子频道 id
announces_type uint32 选填，公告类别 0:成员公告，1:欢迎公告，默认为成员公告
recommend_channels RecommendChannel 数组 选填，推荐子频道列表

返回

返回 Announces 对象。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

guild_id = "你的频道ID"
url = f"https://api.sgroup.qq.com/guilds/{guild_id}/announces"
Authorization = f"QQBot 你的鉴权token"

data = {
  "channel_id": "123456",
  "message_id": "xxxxxx"
}

headers = {
    "Content-Type": "application/json",
    "Authorization": Authorization
}

response = requests.post(url, headers=headers, json=data).json()

print(response)

请求数据包

json 复制代码 
{
  "channel_id": "123456",
  "message_id": "xxxxxx"
}

响应数据包

json 复制代码 
{
  "guild_id": "xxxxxx",
  "channel_id": "123456",
  "message_id": "xxxxxx",
  "announces_type": 0,
  "recommend_channels":[]
}

删除频道公告

接口

DELETE /guilds/{guild_id}/announces/{message_id}

功能描述

用于删除频道 guild_id 下指定 message_id 的全局公告。

Content-Type
application/json

返回

成功返回 HTTP 状态码 204。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

guild_id = "你的频道ID"
message_id = "要删除的公告ID"
url = f"https://api.sgroup.qq.com/guilds/{guild_id}/announces/{message_id}"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.delete(url, headers=headers)

if response.status_code == 204:
    print("公告删除成功")
else:
    print("删除公告失败，状态码：", response.status_code)

请求数据包

DELETE /guilds/123456/announces/112233

添加精华消息

接口

PUT /channels/{channel_id}/pins/{message_id}

功能描述

用于添加子频道 channel_id 内的精华消息。

Content-Type
application/json

返回

返回 PinsMessage 对象。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
message_id = "要设置为精华的消息ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/pins/{message_id}"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.put(url, headers=headers).json()

print(response)

请求数据包

PUT /channels/123456/pins/112233

响应数据包

json 复制代码 
{
  "guild_id": "xxxxxx",
  "channel_id": "xxxxxx",
  "message_ids": ["xxxxx"]
}

删除精华消息

接口

DELETE /channels/{channel_id}/pins/{message_id}

功能描述

用于删除子频道 channel_id 下指定 message_id 的精华消息。

Content-Type
application/json

返回

成功返回 HTTP 状态码 204。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
message_id = "要删除的精华消息ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/pins/{message_id}"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.delete(url, headers=headers)

if response.status_code == 204:
    print("精华消息删除成功")
else:
    print("删除精华消息失败，状态码：", response.status_code)

请求数据包

DELETE /channels/123456/pins/112233

获取精华消息

接口

GET /channels/{channel_id}/pins

功能描述

用于获取子频道 channel_id 内的精华消息。

Content-Type
application/json

返回

返回 PinsMessage 对象。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/pins"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.get(url, headers=headers).json()

print(response)

响应数据包

json 复制代码 
{
  "guild_id": "xxxxxx",
  "channel_id": "xxxxxx",
  "message_ids": ["xxxxx"]
}

获取频道日程列表

接口

GET /channels/{channel_id}/schedules

功能描述

用于获取 channel_id 指定的子频道中当天的日程列表。

Content-Type
application/json

参数

字段名 类型 描述
since uint64 起始时间戳( ms)

返回

返回 Schedule 对象数组。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/schedules"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.get(url, headers=headers).json()

print(response)

请求数据包

{
  "since": 1642076400000
}

响应数据包

json 复制代码 
[
  {
    "id": "xxxxxx",
    "name": "上王者",
    "start_timestamp": "1642076400000",
    "end_timestamp": "1642083600000",
    "creator": {
      "user": {
        "id": "xxxxxx",
        "username": "xxxxxx",
        "bot": true
      },
      "nick": "",
      "joined_at": "2022-01-11T10:24:13+08:00"
    },
    "jump_channel_id": "0",
    "remind_type": "0"
  }
]

获取日程详情

接口

GET /channels/{channel_id}/schedules/{schedule_id}

功能描述

获取日程子频道 channel_id 下 schedule_id 指定的的日程的详情。

Content-Type
application/json

返回

返回 Schedule 对象。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
schedule_id = "日程ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/schedules/{schedule_id}"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.get(url, headers=headers).json()

print(response)

请求数据包

GET /channels/123455/schedules/112233

响应数据包

json 复制代码 
{
  "id": "112233",
  "name": "上王者",
  "start_timestamp": "1642076400000",
  "end_timestamp": "1642083600000",
  "creator": {
    "user": {
      "id": "xxxxxx",
      "username": "xxxxxx",
      "bot": true
    },
    "nick": "",
    "joined_at": "2022-01-11T10:24:13+08:00"
  },
  "jump_channel_id": "0",
  "remind_type": "0"
}

创建日程

接口

POST /channels/{channel_id}/schedules

功能描述

用于在 channel_id 指定的 日程子频道 下创建一个日程。

Content-Type
application/json

参数

字段名 类型 描述
schedule Schedule 日程对象，不需要带 id

返回

返回 Schedule 对象。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/schedules"
Authorization = f"QQBot 你的鉴权token"

data = {
  "schedule": {
    "name": "上王者",
    "start_timestamp": "1642076453000",
    "end_timestamp": "1642083653000",
    "jump_channel_id": "0",
    "remind_type": "0"
  }
}

headers = {
    "Content-Type": "application/json",
    "Authorization": Authorization
}

response = requests.post(url, headers=headers, json=data).json()

print(response)

请求数据包

json 复制代码 
{
  "schedule": {
    "name": "上王者",
    "start_timestamp": "1642076453000",
    "end_timestamp": "1642083653000",
    "jump_channel_id": "0",
    "remind_type": "0"
  }
}

响应数据包

json 复制代码 
{
  "id": "xxxxxx",
  "name": "上王者",
  "start_timestamp": "1642076400000",
  "end_timestamp": "1642083600000",
  "creator": {
    "user": {
      "id": "xxxxxx",
      "username": "xxxxxx",
      "bot": true
    },
    "nick": "",
    "joined_at": "2022-01-11T10:24:13+08:00"
  },
  "jump_channel_id": "0",
  "remind_type": "0"
}

修改日程

接口

PATCH /channels/{channel_id}/schedules/{schedule_id}

功能描述

用于修改日程子频道 channel_id 下 schedule_id 指定的日程的详情。

Content-Type
application/json

参数

字段名 类型 描述
schedule Schedule 日程对象，不需要带 id

返回

返回 Schedule 对象。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
schedule_id = "日程ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/schedules/{schedule_id}"
Authorization = f"QQBot 你的鉴权token"

data = {
  "schedule": {
    "name": "今晚八点上王者",
    "start_timestamp": "1642076453000",
    "end_timestamp": "1642083653000",
    "jump_channel_id": "0",
    "remind_type": "0"
  }
}

headers = {
    "Content-Type": "application/json",
    "Authorization": Authorization
}

response = requests.patch(url, headers=headers, json=data).json()

print(response)

请求数据包

json 复制代码 
{
  "schedule": {
    "name": "今晚八点上王者",
    "start_timestamp": "1642076453000",
    "end_timestamp": "1642083653000",
    "jump_channel_id": "0",
    "remind_type": "0"
  }
}

响应数据包

json 复制代码 
{
  "id": "xxxxxx",
  "name": "今晚八点上王者",
  "start_timestamp": "1642076453000",
  "end_timestamp": "1642083653000",
  "creator": {
    "user": {
      "id": "xxxxxx",
      "username": "xxxxxx",
      "bot": true
    },
    "nick": "",
    "joined_at": "2022-01-13T11:02:21+08:00"
  },
  "jump_channel_id": "0",
  "remind_type": "0"
}

删除日程

接口

DELETE /channels/{channel_id}/schedules/{schedule_id}

功能描述

用于删除日程子频道 channel_id 下 schedule_id 指定的日程。

Content-Type
application/json

返回

成功返回 HTTP 状态码 204。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
schedule_id = "日程ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/schedules/{schedule_id}"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.delete(url, headers=headers)

if response.status_code == 204:
    print("日程删除成功")
else:
    print("删除日程失败，状态码：", response.status_code)

请求数据包

DELETE /channels/123456/schedules/112233

音频控制

接口

POST /channels/{channel_id}/audio

功能描述

用于控制子频道 channel_id 下的音频。

  • 音频接口：仅限 音频类机器人 才能使用，如需调用，需联系平台申请权限。

Content-Type
application/json

参数

字段名 类型 描述
audio_url string 音频链接
text string 音频中包含的文本
status uint32 音频播放状态

返回

成功返回空对象。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/audio"
Authorization = f"QQBot 你的鉴权token"

data = {
  "audio_url": "http:/xxxxx.mp3",
  "text": "xxx",
  "status": 0
}

headers = {
    "Content-Type": "application/json",
    "Authorization": Authorization
}

response = requests.post(url, headers=headers, json=data)

if response.status_code == 204:
    print("音频控制成功")
else:
    print("音频控制失败，状态码：", response.status_code)

请求数据包

json 复制代码 
{
  "audio_url": "http:/xxxxx.mp3",
  "text": "xxx",
  "status": 0
}

机器人上麦

接口

PUT /channels/{channel_id}/mic

功能描述

机器人在 channel_id 对应的语音子频道上麦。

Content-Type
application/json

返回

成功返回空对象。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/mic"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.put(url, headers=headers)

if response.status_code == 204:
    print("机器人上麦成功")
else:
    print("机器人上麦失败，状态码：", response.status_code)

请求数据包

json 复制代码 
{}

机器人下麦

接口

DELETE /channels/{channel_id}/mic

功能描述

机器人在 channel_id 对应的语音子频道下麦。

Content-Type
application/json

返回

成功返回空对象。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/mic"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.delete(url, headers=headers)

if response.status_code == 204:
    print("机器人下麦成功")
else:
    print("机器人下麦失败，状态码：", response.status_code)

请求数据包

json 复制代码 
{}

获取帖子列表

☣️关于帖子相关的所有API，公域机器人暂不支持申请，仅私域机器人可用，选择私域机器人后默认开通。开通后需要先将机器人从频道移除，然后重新添加，方可生效。

接口

GET /channels/{channel_id}/threads

功能描述

用于获取子频道下的帖子列表。

Content-Type
application/json

返回

字段名 类型 描述
threads Thread 数组 帖子列表对象
is_finish uint32 是否拉取完毕(0:否；1:是)

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/threads"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.get(url, headers=headers).json()

print(response)

响应数据包

json 复制代码 
{
  "threads": [{
    "guild_id": "75827011639035987",
    "channel_id": "2324603",
    "author_id": "144115218680332809",
    "thread_info": {
      "thread_id": "B_59101362700301001441152186803328090X60-1645416537",
      "title": "帖子标题1",
      "content": "{\"paragraphs\":[{\"elems\":[{\"text\":{\"text\":\"发送消息 | QQ机器人文档\"},\"type\":1}],\"props\":{}},{\"elems\":[{\"text\":{\"text\":\"• 主动消息：发送消息时，未填充msg_id 字段的消息。\"},\"type\":1}],\"props\":{}}]}",
      "date_time": "2022-02-21T12:08:57+08:00"
    }
  }],
  "is_finish": 1
}

获取帖子详情

接口

GET /channels/{channel_id}/threads/{thread_id}

功能描述

用于获取子频道下的帖子详情。

Content-Type
application/json

返回

字段名 类型 描述
thread ThreadInfo 帖子详情对象

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
thread_id = "帖子ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/threads/{thread_id}"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.get(url, headers=headers).json()

print(response)

响应数据包

json 复制代码 
{
  "thread":{
    "guild_id":"75827011639035987",
    "channel_id":"2324603",
    "author_id":"144115218680332809",
    "thread_info":{
      "thread_id":"B_79051362477c03001441152186803328090X60-1645413753",
      "title":"帖子标题",
      "content":"{\"paragraphs\":[{\"elems\":[{\"text\":{\"text\":\"发送消息 | QQ机器人文档\"},\"type\":1}],\"props\":{}},{\"elems\":[{\"text\":{\"text\":\"• 主动消息：发送消息时，未填充msg_id 字段的消息。\"},\"type\":1}],\"props\":{}}]}",
      "date_time":"2022-02-21T11:22:33+08:00"
    }
  }
}

发表帖子

接口

PUT /channels/{channel_id}/threads

功能描述

用于在子频道下发表帖子。

Content-Type
application/json

参数

字段名 类型 描述
title string 帖子标题
content string 帖子内容
format uint32 帖子文本格式

返回

字段名 类型 描述
task_id string 帖子任务ID
create_time uint32 发帖时间戳，单位：秒

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/threads"
Authorization = f"QQBot 你的鉴权token"

data = {
  "title": "title",
  "content": "<html lang=\"en-US\"><body><a href=\"https://bot.q.qq.com/wiki\" title=\"QQ机器人文档Title\">QQ机器人文档</a>\n<ul><li>主动消息：发送消息时，未填msg_id字段的消息。</li><li>被动消息：发送消息时，填充了msg_id字段的消息。</li></ul></body></html>",
  "format": 2
}

headers = {
    "Content-Type": "application/json",
    "Authorization": Authorization
}

response = requests.put(url, headers=headers, json=data).json()

print(response)

请求数据包

json 复制代码 
{
  "title": "title",
  "content": "<html lang=\"en-US\"><body><a href=\"https://bot.q.qq.com/wiki\" title=\"QQ机器人文档Title\">QQ机器人文档</a>\n<ul><li>主动消息：发送消息时，未填msg_id字段的消息。</li><li>被动消息：发送消息时，填充了msg_id字段的消息。</li></ul></body></html>",
  "format": 2
}

响应数据包

json 复制代码 
{
  "task_id": "1645413752912602306",
  "create_time": "1645503180"
}

删除帖子

接口

DELETE /channels/{channel_id}/threads/{thread_id}

功能描述

用于删除指定子频道下的某个帖子。

Content-Type
application/json

返回

成功返回 HTTP 状态码 204。

错误码

详见错误码。

Python示例

python 复制代码 
import requests

channel_id = "你的子频道ID"
thread_id = "帖子ID"
url = f"https://api.sgroup.qq.com/channels/{channel_id}/threads/{thread_id}"
Authorization = f"QQBot 你的鉴权token"

headers = {
    "Authorization": Authorization
}

response = requests.delete(url, headers=headers)

if response.status_code == 204:
    print("帖子删除成功")
else:
    print("删除帖子失败，状态码：", response.status_code)

请求数据包

DELETE /channels/123456/threads/112233

致谢和更新

频道模块目前制作完成，内容会在原基础上持续更新，具体更新时间以下面⬇️更新时间为准。

文章持续更新，如果三连支持，速更！！！

请在评论区提出疑惑和建议

上次更新: 9/13/2024, AM

⬅️第五期：频道模块之接口授权管理和发言管理

➡️第七期：WebSocket方式 (待更新...)

相关推荐
菜鸟的人工智能之路8 分钟前
极坐标气泡图：医学数据分析的可视化新视角
python·数据分析·健康医疗
菜鸟学Python9 分钟前
Python 数据分析核心库大全！
开发语言·python·数据挖掘·数据分析
小白不太白95010 分钟前
设计模式之 责任链模式
python·设计模式·责任链模式
喜欢猪猪16 分钟前
Django：从入门到精通
后端·python·django
一个小坑货16 分钟前
Cargo Rust 的包管理器
开发语言·后端·rust
bluebonnet2720 分钟前
【Rust练习】22.HashMap
开发语言·后端·rust
古月居GYH21 分钟前
在C++上实现反射用法
java·开发语言·c++
糖豆豆今天也要努力鸭22 分钟前
torch.__version__的torch版本和conda list的torch版本不一致
linux·pytorch·python·深度学习·conda·torch
何大春38 分钟前
【弱监督语义分割】Self-supervised Image-specific Prototype Exploration for WSSS 论文阅读
论文阅读·人工智能·python·深度学习·论文笔记·原型模式
宋138102797201 小时前
Manus Xsens Metagloves虚拟现实手套
人工智能·机器人·vr·动作捕捉
热门推荐
01(欧拉)openEuler系统添加网卡文件配置流程、(欧拉)openEuler系统手动配置ipv6地址流程、(欧拉)openEuler系统网络管理说明02PyTorch机器学习实现液态神经网络03【HarmonyOS】HUAWEI DevEco Studio 下载地址汇总04玄机平台应急响应—webshell查杀05Coze扣子平台完整体验和实践（附国内和国际版对比）06Ubuntu 20.04使用Livox mid 360 测试 FAST_LIO07【目标跟踪】相机运动补偿08Unity中PICO实现 隔空取物 和 接触抓取物体09RAG 实践- Ollama+RagFlow 部署本地知识库10量化方法怎么选？如何评估量化后的大模型LLM？