import{_ as l}from"./plugin-vue_export-helper-c27b6911.js";import{r as i,o as p,c as u,a as t,d as a,b as n,w as d,e as h}from"./app-e0095480.js";const b={},_={class:"hint-container warning"},g=t("p",{class:"hint-container-title"},"注意",-1),f=h('
设置群名
该接口用于设置群名。
API 端点
/set_group_name
参数
字段名 | 数据类型 | 说明 |
---|
group_id | int64 | 群号 |
group_name | string | 新群名 |
响应
该接口将返回处理结果,其中 data
字段无数据。。
',9),m={id:"设置群头像",tabindex:"-1"},x=t("a",{class:"header-anchor",href:"#设置群头像","aria-hidden":"true"},"#",-1),k=h('该接口用于设置群头像。
API 端点
/set_group_portrait
参数
字段 | 类型 | 说明 |
---|
group_id | int64 | 群号 |
file | string | 图片文件名 |
cache | int | 表示是否使用已缓存的文件 |
[1] file
参数支持以下几种格式:
',6),v=t("code",null,"file:///sdcard/Pictures/shamrock.png",-1),y={href:"https://tools.ietf.org/html/rfc8089",target:"_blank",rel:"noopener noreferrer"},A=t("code",null,"file",-1),I=t("li",null,[a("网络 URL, 例如 "),t("code",null,"http://i1.piimg.com/567571/fdd6e7b6d93f1ef0.jpg")],-1),P=t("li",null,[a("Base64 编码, 例如 "),t("code",null,"base64://iVBORw0KGgoAAAANSUhEUgAAABQAAAAVCAIAAADJt1n/AAAAKElEQVQ4EWPk5+RmIBcwkasRpG9UM4mhNxpgowFGMARGEwnBIEJVAAAdBgBNAZf+QAAAAABJRU5ErkJggg==")],-1),Q=h('[2] cache
参数: 通过网络 URL 发送时有效, 1
表示使用缓存, 0
关闭关闭缓存, 默认 为1
设置群管理员
该接口用于设置群管理员。
API 端点
/set_group_admin
参数
字段 | 类型 | 必须 | 说明 |
---|
group_id | int64 | 是 | 群号 |
user_id | int64 | 是 | QQ 号 |
enable | bool | 是 | 是否设置 |
响应
该接口将返回处理结果,其中 data
字段无数据。。
设置群名片
该接口用于设置群成员名片。
API 端点
/set_group_card
参数
字段名 | 数据类型 | 默认值 | 说明 |
---|
group_id | int64 | - | 群号 |
user_id | int64 | - | 要设置的 QQ 号 |
card | string | 空 | 群名片内容, 不填或空字符串表示删除群名片 |
设置群聊备注
该接口用于设置群聊备注。
API 端点
/set_group_remark
参数
字段名 | 数据类型 | 默认值 | 说明 |
---|
group_id | int64 | - | 群号 |
remark | string | 空 | 群备注, 不填或空字符串表示删除群备注 |
设置群组专属头衔
该接口用于设置群组专属头衔。
API 端点
/set_group_special_title
参数
字段 | 类型 | 必须 | 说明 |
---|
group_id | int64 | 是 | 群号 |
user_id | int64 | 是 | QQ 号 |
special_title | string | 是 | 头衔 |
响应
该接口将返回处理结果,其中 data
字段无数据。。
群单人禁言
该接口用于群单人禁言。
API 端点
/set_group_ban
参数
提示
当 duration
为 0
时,将解除禁言。
字段 | 类型 | 必须 | 说明 |
---|
group_id | int64 | 是 | 群号 |
user_id | int64 | 是 | QQ 号 |
duration | int64 | 是 | 禁言时长 |
响应
该接口将返回处理结果,其中 data
字段无数据。。
群全员禁言
该接口用于群全员禁言。
API 端点
/set_group_whole_ban
参数
字段名 | 数据类型 | 默认值 | 说明 |
---|
group_id | int64 | - | 群号 |
enable | boolean | true | 是否禁言 |
响应
该接口将返回处理结果,其中 data
字段无数据。。
设置精华消息
该接口用于设置精华消息。
API 端点
/set_essence_msg
参数
字段 | 类型 | 说明 |
---|
message_id | int32 | 消息ID |
移出精华消息
该接口用于移出精华消息。
API 端点
/delete_essence_msg
参数
字段 | 类型 | 说明 |
---|
message_id | int32 | 消息ID |
群打卡
该接口用于群打卡。
API 端点
/send_group_sign
参数
响应
该接口将返回处理结果,其中 data
字段无数据。
发送群公告
该接口用于发送群公告。
API 端点
/_send_group_notice
参数
字段名 | 数据类型 | 默认值 | 说明 |
---|
group_id | int64 | | 群号 |
content | string | | 公告内容 |
image | string | | 图片(可选),支持base64、http(s)和本地路径 |
响应
该接口将返回处理结果,其中 data
字段无数据。
获取群公告
该接口用于获取群公告。
API 端点
/_get_group_notice
参数
字段名 | 数据类型 | 默认值 | 说明 |
---|
group_id | int64 | | 群号 |
响应数据
data 的响应内容为 json 数组,每个元素内容如下:
字段 | 类型 | 说明 |
---|
sender_id | int64 | 公告发表者 |
publish_time | int64 | 公告发表时间 |
message | Object<Message> | 公告内容 |
message
字段 | 类型 | 说明 |
---|
text | string | 公告内容 |
images | List<Images> | 公告图片 |
images
字段 | 类型 | 说明 |
---|
height | string | 图片高度 |
width | string | 图片宽度 |
id | string | 图片ID,可用https://gdynamic.qpic.cn/gdynamic/{id}/628 获取 |
群组踢人
该接口用于群组踢人。
API 端点
/set_group_kick
参数
字段 | 类型 | 必须 | 说明 |
---|
group_id | int64 | 是 | 群号 |
user_id | int64 | 是 | QQ 号 |
reject_add_request | bool | 否 | 是否拒绝再次加群 |
响应
该接口将返回处理结果,其中 data
字段无数据。
退出群组
该接口用于退出群组。
API 端点
/set_group_leave
参数
响应
该接口将返回处理结果,其中 data
字段无数据。。
群戳一戳
该接口用于群戳一戳。
API 端点
/group_touch
- 用于HTTP
/poke
- 用于主动WebSocket与被动WebSocket
参数
字段 | 类型 | 必须 | 说明 |
---|
group_id | int64 | 是 | 群号 |
user_id | int64 | 是 | QQ 号 |
响应
该接口将返回处理结果,其中 data
字段无数据。。
获取被禁言的群成员列表
用于获取群聊谁谁谁啊犯贱或者被二比滥权管理或者某群主时援交手滑禁言掉的人的列表。
API端点
/get_prohibited_member_list
参数
响应
',124),B=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"字段"),t("th",null,"类型"),t("th",null,"说明")])]),t("tbody",null,[t("tr",null,[t("td",null,"user_id"),t("td",null,"int64"),t("td",null,"QQ 号")]),t("tr",null,[t("td",null,"time"),t("td",null,"int64"),t("td",null,"禁言结束时间")])])],-1),j=t("div",{class:"language-json line-numbers-mode","data-ext":"json"},[t("pre",{class:"language-json"},[t("code",null,[t("span",{class:"token punctuation"},"{"),a(`
`),t("span",{class:"token property"},'"status"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"ok"'),t("span",{class:"token punctuation"},","),a(`
`),t("span",{class:"token property"},'"retcode"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"0"),t("span",{class:"token punctuation"},","),a(`
`),t("span",{class:"token property"},'"data"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token punctuation"},"["),a(`
`),t("span",{class:"token punctuation"},"{"),a(`
`),t("span",{class:"token property"},'"user_id"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"2262206340"),t("span",{class:"token punctuation"},","),a(),t("span",{class:"token comment"},"// 被禁言的人"),a(`
`),t("span",{class:"token property"},'"time"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"1700749967"),a(),t("span",{class:"token comment"},"// 禁言结束时间"),a(`
`),t("span",{class:"token punctuation"},"}"),a(`
`),t("span",{class:"token punctuation"},"]"),t("span",{class:"token punctuation"},","),a(`
`),t("span",{class:"token property"},'"echo"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"xxxx"'),a(`
`),t("span",{class:"token punctuation"},"}"),a(`
`)])]),t("div",{class:"line-numbers","aria-hidden":"true"},[t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"})])],-1),E=h(' 获取群 @全体成员 剩余次数
当机器人是管理员时可用
API端点
/get_group_at_all_remain
参数
响应
',7),w=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"字段"),t("th",null,"类型"),t("th",null,"说明")])]),t("tbody",null,[t("tr",null,[t("td",null,"can_at_all"),t("td",null,"bool"),t("td",null,"是否可以 @全体成员")]),t("tr",null,[t("td",null,"remain_at_all_count_for_group"),t("td",null,"int32"),t("td",null,"群内所有管理当天剩余 @全体成员 次数")]),t("tr",null,[t("td",null,"remain_at_all_count_for_uin"),t("td",null,"int32"),t("td",null,"Bot 当天剩余 @全体成员 次数")])])],-1),R=t("div",{class:"language-json line-numbers-mode","data-ext":"json"},[t("pre",{class:"language-json"},[t("code",null,[t("span",{class:"token punctuation"},"{"),a(`
`),t("span",{class:"token property"},'"status"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"ok"'),t("span",{class:"token punctuation"},","),a(`
`),t("span",{class:"token property"},'"retcode"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"0"),t("span",{class:"token punctuation"},","),a(`
`),t("span",{class:"token property"},'"data"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token punctuation"},"["),a(`
`),t("span",{class:"token punctuation"},"{"),a(`
`),t("span",{class:"token property"},'"can_at_all"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token boolean"},"true"),t("span",{class:"token punctuation"},","),a(`
`),t("span",{class:"token property"},'"remain_at_all_count_for_group"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"20"),t("span",{class:"token punctuation"},","),a(`
`),t("span",{class:"token property"},'"remain_at_all_count_for_group"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token number"},"10"),a(`
`),t("span",{class:"token punctuation"},"}"),a(`
`),t("span",{class:"token punctuation"},"]"),t("span",{class:"token punctuation"},","),a(`
`),t("span",{class:"token property"},'"echo"'),t("span",{class:"token operator"},":"),a(),t("span",{class:"token string"},'"xxxx"'),a(`
`),t("span",{class:"token punctuation"},"}"),a(`
`)])]),t("div",{class:"line-numbers","aria-hidden":"true"},[t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"}),t("div",{class:"line-number"})])],-1),V=h(' 设置消息底部评论小表情
貌似是从别的地方抄的奇怪功能,目前版本(9.0.15)只在部分群聊进行灰度测试!
API 端点
/set_group_comment_face
参数
字段 | 类型 | 必须 | 说明 |
---|
group_id | int64 | 是 | 群号 |
msg_id | int32 | 是 | 消息ID |
face_id | int32 | 是 | 表情ID |
is_set | bool | 否 | 是否设置或取消评论 |
响应
该接口将返回处理结果,其中 data
字段无数据。。
',8);function N(U,D){const s=i("Badge"),c=i("ExternalLinkIcon"),o=i("Tabs");return p(),u("div",null,[t("div",_,[g,t("p",null,[a("对于 Shamrock 尚未实现的 API,会在标题添加标记 "),n(s,{text:"未实现",type:"danger",vertical:"baseline"})])]),f,t("h2",m,[x,a(" 设置群头像 "),n(s,{text:"未实现",type:"danger"})]),k,t("ul",null,[t("li",null,[a("绝对路径, 例如 "),v,a(", 格式使用 "),t("a",y,[A,a(" URI"),n(c)])]),I,P]),Q,n(o,{id:"1326",data:[{id:"响应字段"},{id:"响应示例"}]},{title0:d(({value:e,isActive:r})=>[a("响应字段")]),title1:d(({value:e,isActive:r})=>[a("响应示例")]),tab0:d(({value:e,isActive:r})=>[B]),tab1:d(({value:e,isActive:r})=>[j]),_:1}),E,n(o,{id:"1424",data:[{id:"响应字段"},{id:"响应示例"}]},{title0:d(({value:e,isActive:r})=>[a("响应字段")]),title1:d(({value:e,isActive:r})=>[a("响应示例")]),tab0:d(({value:e,isActive:r})=>[w]),tab1:d(({value:e,isActive:r})=>[R]),_:1}),V])}const T=l(b,[["render",N],["__file","group.html.vue"]]);export{T as default};