Skip to content
On this page

QQ 群 API ​

QQ 群 / 全域适配器下,bot.instance.api 的类型为 QQGroupAPI(继承自 QQGuildAPI)。

python
from amiyabot.adapters.tencent.qqGroup.api import QQGroupAPI

api: QQGroupAPI = bot.instance.api

通用方法

get / post / request 三个通用方法见 API 使用说明。

消息 ​

post_group_message ​

发送群聊消息。

参数名类型释义默认值
channel_openidstr群 OpenID
payloaddict消息体

post_private_message ​

发送单聊消息。

参数名类型释义默认值
user_openidstr用户 OpenID
payloaddict消息体

delete_group_message ​

撤回群聊消息,发送超过 2 分钟不可撤回。

参数名类型释义默认值
group_openidstr群 OpenID
message_idstr消息 ID

delete_private_message ​

撤回单聊消息,发送超过 2 分钟不可撤回。

参数名类型释义默认值
user_openidstr用户 OpenID
message_idstr消息 ID

post_stream_message ​

流式发送单聊消息(仅单聊)。首片响应的 id 即后续分片需携带的 stream_msg_id。

参数名类型释义默认值
user_openidstr用户 OpenID
content_rawstrMarkdown / 文本内容
indexint分片序号,从 0 递增0
input_stateint输入状态,1=生成中,10=生成结束1
input_modestrappend=拼接 / replace=全量替换'replace'
content_typestrtext / markdown'markdown'
stream_msg_idstr流式消息 ID,首片由服务端返回,后续分片需携带None
msg_idstr被动回复消息 IDNone
event_idstr被动回复事件 IDNone
msg_seqint消息序号,用于去重None

富媒体上传 ​

单聊与群聊隔离

单聊与群聊的上传接口互不通用,上传的文件不能跨场景发送。

file_type 取值:1=图片 2=视频 3=语音 4=文件。

upload_file ​

整文件上传(传入公网可访问的 URL,平台自动转存)。

参数名类型释义默认值
openidstr用户 / 群 OpenID
file_typeint文件类型
urlstr文件 URL
srv_send_msgbool是否上传后直接发送(会占用主动消息频次)False
is_directbool是否为单聊(决定使用 users 还是 groups 端点)False
file_namestr文件名None
upload_idstr分片上传 ID;传入时走合并路径,url 可为空None

upload_prepare ​

分片上传第一步:预上传,返回 upload_id、block_size 与各分片预签名 URL。

参数名类型释义默认值
openidstr用户 / 群 OpenID
file_typeint文件类型
file_sizeint文件大小(字节)
file_namestr文件名
md5str整个文件的 MD5
sha1str整个文件的 SHA1
md5_10mstr前 10002432 字节的 MD5(秒传判断)
is_directbool是否为单聊False

upload_part_finish ​

分片上传第三步:通知服务端某个分片已完成(每片 PUT 成功后调用)。

参数名类型释义默认值
openidstr用户 / 群 OpenID
upload_idstr预上传返回的 upload_id
part_indexint分片序号,从 0 开始
block_sizeint该分片实际字节数0
md5str该分片的 MD5None
is_directbool是否为单聊False

分片上传流程 ​

1. upload_prepare      → upload_id + block_size + 预签名 URL 列表
2. 按 block_size 分片,逐片 HTTP PUT 到预签名 URL
3. 每片成功后调用 upload_part_finish
4. 全部完成后调用 upload_file(upload_id=...) 合并 → 得到 file_info

拿到 file_info 后,以 msg_type=7 发送:

python
{
    'msg_type': 7,
    'media': {'file_info': '...'},
}

群管理 ​

需要内邀权限

以下接口中,除 approval_group_join_request 外,官方均标注「该能力正在内邀接入中」。 普通机器人调用会返回错误码 11253(应用无接口访问权限),需向平台运营申请白名单。

get_group_restrict_chat_setting / set_group_member_mute / get_group_join_request_list / approval_group_join_request 另需机器人拥有群管理员身份。

get_group_info ​

获取群基本信息。

参数名类型释义默认值
group_openidstr群 OpenID

get_group_bot_state ​

获取机器人在指定群中的状态信息。

参数名类型释义默认值
group_openidstr群 OpenID

get_group_members ​

获取群成员列表,单页最多 30 条。

参数名类型释义默认值
group_openidstr群 OpenID
cursorstr分页游标,首次传空串''

get_group_member ​

获取单个群成员信息。

参数名类型释义默认值
group_openidstr群 OpenID
member_openidstr成员 OpenID

batch_remove_group_members ​

批量移除群成员,单次最多 20 个。

参数名类型释义默认值
group_openidstr群 OpenID
member_openidsList[str]成员 OpenID 列表
add_to_member_blacklistbool是否同时加入群黑名单False

get_group_member_blacklist ​

查询群黑名单列表。

参数名类型释义默认值
group_openidstr群 OpenID
cursorstr分页游标''
limitint单页数量,最大 10020

modify_group_member_blacklist ​

群黑名单操作。目标用户不在群中时才能加入黑名单。

参数名类型释义默认值
group_openidstr群 OpenID
opstradd 加入 / del 移出
member_openidsList[str]成员 OpenID 列表,最多 20 个

get_group_restrict_chat_setting ​

查询群禁言状态(含全员禁言模式与成员级禁言列表)。需群管理员身份。

参数名类型释义默认值
group_openidstr群 OpenID

set_group_member_mute ​

设置群成员禁言。需群管理员身份,最长禁言 30 天,只能操作普通成员。

参数名类型释义默认值
group_openidstr群 OpenID
membersList[dict]禁言设置列表,最多 20 个

members 每项结构:

python
{
    'op': 'add',                 # add 增加 / update 更新到期时间 / del 解除
    'member_openid': '...',
    'mute_expire_at': '2026-08-05T11:23:05+08:00',  # RFC3339
}

get_group_join_request_list ​

拉取入群申请列表。需群管理员身份。

参数名类型释义默认值
group_openidstr群 OpenID
cursorstr分页游标''
limitint单页数量,最大 5020

approval_group_join_request ​

审批入群申请。需群管理员身份。

参数名类型释义默认值
group_openidstr群 OpenID
member_openidstr申请人 OpenID
opstrapprove 通过 / decline 拒绝
join_request_idstr申请 ID,来自事件或列表None
reject_reasonstr拒绝理由,op=decline 时可用None
add_to_member_blacklistbool是否同时加入群黑名单,op=decline 时可用False

互动与其他 ​

put_interaction_response ​

回应互动事件(按钮回调等)。收到 INTERACTION_CREATE 后应尽快调用,否则客户端会一直处于 loading 状态。

参数名类型释义默认值
interaction_idstr互动事件 ID(事件体的 id)
codeint0=成功 1=失败 2=频繁 3=重复 4=无权限 5=仅管理员操作0

生成机器人分享链接。

参数名类型释义默认值
callback_datastr用户添加机器人时透传的数据,最长 32 字符None