群聊 API
set_group_name 设置群名称
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| new_group_name | string | 新群名称 |
输出参数
此 API 无输出参数，请协议端传入 {}。
set_group_avatar 设置群头像
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| image_uri | string | 头像文件 URI，支持 file:// http(s):// base64:// 三种格式 |
输出参数
此 API 无输出参数，请协议端传入 {}。
set_group_member_card 设置群名片
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| user_id | int64 | 被设置的群成员 QQ 号 |
| card | string | 新群名片 |
输出参数
此 API 无输出参数，请协议端传入 {}。
set_group_member_special_title 设置群成员专属头衔
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| user_id | int64 | 被设置的群成员 QQ 号 |
| special_title | string | 新专属头衔 |
输出参数
此 API 无输出参数，请协议端传入 {}。
set_group_member_admin 设置群管理员
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| user_id | int64 | 被设置的 QQ 号 |
| is_set | boolean | 是否设置为管理员，false 表示取消管理员，默认值：true |
输出参数
此 API 无输出参数，请协议端传入 {}。
set_group_member_mute 设置群成员禁言
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| user_id | int64 | 被设置的 QQ 号 |
| duration | int32 | 禁言持续时间（秒），设为 0 为取消禁言，默认值：0 |
输出参数
此 API 无输出参数，请协议端传入 {}。
set_group_whole_mute 设置群全员禁言
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| is_mute | boolean | 是否开启全员禁言，false 表示取消全员禁言，默认值：true |
输出参数
此 API 无输出参数，请协议端传入 {}。
kick_group_member 踢出群成员
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| user_id | int64 | 被踢的 QQ 号 |
| reject_add_request | boolean | 是否拒绝加群申请，false 表示不拒绝，默认值：false |
输出参数
此 API 无输出参数，请协议端传入 {}。
get_group_announcements 获取群公告列表
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
输出参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| announcements | GroupAnnouncementEntity[] | 群公告列表 |
send_group_announcement 发送群公告
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| content | string | 公告内容 |
| image_uri | string? | 公告附带图像文件 URI，支持 file:// http(s):// base64:// 三种格式 |
输出参数
此 API 无输出参数，请协议端传入 {}。
delete_group_announcement 删除群公告
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| announcement_id | string | 公告 ID |
输出参数
此 API 无输出参数，请协议端传入 {}。
get_group_essence_messages 获取群精华消息列表
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| page_index | int32 | 页码索引，从 0 开始 |
| page_size | int32 | 每页包含的精华消息数量 |
输出参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| messages | GroupEssenceMessage[] | 精华消息列表 |
| is_end | boolean | 是否已到最后一页 |
set_group_essence_message 设置群精华消息
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| message_seq | int64 | 消息序列号 |
| is_set | boolean | 是否设置为精华消息，false 表示取消精华，默认值：true |
输出参数
此 API 无输出参数，请协议端传入 {}。
quit_group 退出群
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
输出参数
此 API 无输出参数，请协议端传入 {}。
send_group_message_reaction 发送群消息表情回应
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| message_seq | int64 | 要回应的消息序列号 |
| reaction | string | 发送的回应的表情 ID |
| reaction_type | enum | 发送的回应类型，可能值：face emoji，默认值：face |
| is_add | boolean | 是否添加表情，false 表示取消，默认值：true |
输出参数
此 API 无输出参数，请协议端传入 {}。
send_group_nudge 发送群戳一戳
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| user_id | int64 | 被戳的群成员 QQ 号 |
输出参数
此 API 无输出参数，请协议端传入 {}。
get_group_notifications 获取群通知列表
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| start_notification_seq | int64? | 起始通知序列号 |
| is_filtered | boolean | true 表示只获取被过滤（由风险账号发起）的通知，false 表示只获取未被过滤的通知，默认值：false |
| limit | int32 | 获取的最大通知数量，默认值：20 |
输出参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| notifications | GroupNotification[] | 获取到的群通知（notification_seq 降序排列），序列号不一定连续 |
| next_notification_seq | int64? | 下一页起始通知序列号 |
accept_group_request 同意入群/邀请他人入群请求
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| notification_seq | int64 | 请求对应的通知序列号 |
| notification_type | enum | 请求对应的通知类型，可能值：join_request invited_join_request |
| group_id | int64 | 请求所在的群号 |
| is_filtered | boolean | 是否是被过滤的请求，默认值：false |
输出参数
此 API 无输出参数，请协议端传入 {}。
reject_group_request 拒绝入群/邀请他人入群请求
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| notification_seq | int64 | 请求对应的通知序列号 |
| notification_type | enum | 请求对应的通知类型，可能值：join_request invited_join_request |
| group_id | int64 | 请求所在的群号 |
| is_filtered | boolean | 是否是被过滤的请求，默认值：false |
| reason | string? | 拒绝理由 |
输出参数
此 API 无输出参数，请协议端传入 {}。
accept_group_invitation 同意他人邀请自身入群
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| invitation_seq | int64 | 邀请序列号 |
输出参数
此 API 无输出参数，请协议端传入 {}。
reject_group_invitation 拒绝他人邀请自身入群
输入参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| group_id | int64 | 群号 |
| invitation_seq | int64 | 邀请序列号 |
输出参数
此 API 无输出参数，请协议端传入 {}。