# 拓展API 由于部分 api 原版 CQHTTP 并未实现，go-cqhttp 修改并增加了一些拓展 api . ## CQCode ### 回复 Type : `reply` 范围: **发送/接收** 参数: | 参数名 | 类型 | 说明 | | ------ | ---- | ------------------------------------- | | id | int | 回复时所引用的消息id, 必须为本群消息. | 示例: `[CQ:reply,id=123456]` ### 红包 Type: `redbag` 范围: **接收** 参数: | 参数名 | 类型 | 说明 | | ------ | ------ | ----------- | | title | string | 祝福语/口令 | 示例: `[CQ:redbag,title=恭喜发财]` ### 戳一戳 > 注意：发送戳一戳消息无法撤回，返回的 `message id` 恒定为 `0` Type: `poke` 范围: **发送(仅群聊)** 参数: | 参数名 | 类型 | 说明 | | ------ | ------ | ----------- | | qq | int64 | 需要戳的成员 | 示例: `[CQ:poke,qq=123456]` ### 合并转发 Type: `forward` 范围: **接收** 参数: | 参数名 | 类型 | 说明 | | ------ | ------ | ------------------------------------------------------------ | | id | string | 合并转发ID, 需要通过 `/get_forward_msg` API获取转发的具体内容 | 示例: `[CQ:forward,id=xxxx]` ### 合并转发消息节点 Type: `node` 范围: **发送** 参数: | 参数名 | 类型 | 说明 | 特殊说明 | | ------- | ------- | -------------- | ------------------------------------------------------------ | | id | int32 | 转发消息id | 直接引用他人的消息合并转发, 实际查看顺序为原消息发送顺序 **与下面的自定义消息二选一** | | name | string | 发送者显示名字 | 用于自定义消息 (自定义消息并合并转发，实际查看顺序为自定义消息段顺序) | | uin | int64 | 发送者QQ号 | 用于自定义消息 | | content | message | 具体消息 | 用于自定义消息 **不支持转发套娃，不支持引用回复** | 特殊说明: **需要使用单独的API `/send_group_forward_msg` 发送，并且由于消息段较为复杂，仅支持Array形式入参。 如果引用消息和自定义消息同时出现，实际查看顺序将取消息段顺序. 另外按 [CQHTTP](https://cqhttp.cc/docs/4.15/#/Message?id=格式) 文档说明, `data` 应全为字符串, 但由于需要接收`message` 类型的消息, 所以 *仅限此Type的content字段* 支持Array套娃** 示例: 直接引用消息合并转发: ````json [ { "type": "node", "data": { "id": "123" } }, { "type": "node", "data": { "id": "456" } } ] ```` 自定义消息合并转发: ````json [ { "type": "node", "data": { "name": "消息发送者A", "uin": "10086", "content": [ { "type": "text", "data": {"text": "测试消息1"} } ] } }, { "type": "node", "data": { "name": "消息发送者B", "uin": "10087", "content": "[CQ:image,file=xxxxx]测试消息2" } } ] ```` 引用自定义混合合并转发: ````json [ { "type": "node", "data": { "name": "自定义发送者", "uin": "10086", "content": "我是自定义消息" } }, { "type": "node", "data": { "id": "123" } } ] ```` ### xml支持 Type: `xml` 范围: **发送/接收** 参数: | 参数名 | 类型 | 说明 | | ------ | ------ | ------------------------------------------------------------ | | data | string | xml内容，xml中的value部分，记得实体化处理| | resid | int32 | 可以不填| 示例: `[CQ:xml,data=xxxx]` #### 一些xml样例 #### ps:重要：xml中的value部分，记得html实体化处理后，再打加入到cq码中 #### qq音乐 ```xml ``` #### 网易音乐 ```xml ``` #### 卡片消息1 ```xml 生死8秒！女司机高速急刹，他一个操作救下一车性命 ``` #### 卡片消息2 ```xml test title ``` ### json消息支持 Type: `json` 范围: **发送/接收** 参数: | 参数名 | 类型 | 说明 | | ------ | ------ | ------------------------------------------------------------ | | data | string | json内容，json的所有字符串记得实体化处理| | resid | int32 | 默认不填为0，走小程序通道，填了走富文本通道发送| json中的字符串需要进行转义： >","=>`,`、 >"&"=> `&`、 >"["=>`[`、 >"]"=>`]`、 否则无法正确得到解析 示例json 的cq码： ```test [CQ:json,data={"app":"com.tencent.miniapp","desc":"","view":"notification","ver":"0.0.0.1","prompt":"[应用]","appID":"","sourceName":"","actionData":"","actionData_A":"","sourceUrl":"","meta":{"notification":{"appInfo":{"appName":"全国疫情数据统计","appType":4,"appid":1109659848,"iconUrl":"http:\/\/gchat.qpic.cn\/gchatpic_new\/719328335\/-2010394141-6383A777BEB79B70B31CE250142D740F\/0"},"data":[{"title":"确诊","value":"80932"},{"title":"今日确诊","value":"28"},{"title":"疑似","value":"72"},{"title":"今日疑似","value":"5"},{"title":"治愈","value":"60197"},{"title":"今日治愈","value":"1513"},{"title":"死亡","value":"3140"},{"title":"今**亡","value":"17"}],"title":"中国加油，武汉加油","button":[{"name":"病毒：SARS-CoV-2，其导致疾病命名 COVID-19","action":""},{"name":"传染源：新冠肺炎的患者。无症状感染者也可能成为传染源。","action":""}],"emphasis_keyword":""}},"text":"","sourceAd":""}] ``` ### cardimage 一种xml的图片消息（装逼大图） ps: xml 接口的消息都存在风控风险，请自行兼容发送失败后的处理（可以失败后走普通图片模式） Type: `cardimage` 范围: **发送** 参数: | 参数名 | 类型 | 说明 | | ------ | ------ | ------------------------------------------------------------ | | file | string | 和image的file字段对齐，支持也是一样的| | minwidth | int64 | 默认不填为400，最小width| | minheight | int64 | 默认不填为400，最小height| | maxwidth | int64 | 默认不填为500，最大width| | maxheight | int64 | 默认不填为1000，最大height| | source | string | 分享来源的名称，可以留空| | icon | string | 分享来源的icon图标url，可以留空| 示例cardimage 的cq码： ```test [CQ:cardimage,file=https://i.pixiv.cat/img-master/img/2020/03/25/00/00/08/80334602_p0_master1200.jpg] ``` ## API ### 设置群名 终结点: `/set_group_name` **参数** | 字段 | 类型 | 说明 | | -------- | ------ | ---- | | group_id | int64 | 群号 | | group_name | string | 新名 | ### 获取图片信息 终结点: `/get_image` > 该接口为 CQHTTP 接口修改 参数 | 字段 | 类型 | 说明 | | ------ | ------ | -------------- | | `file` | string | 图片缓存文件名 | 响应数据 | 字段 | 类型 | 说明 | | ---------- | ------ | -------------- | | `size` | int32 | 图片源文件大小 | | `filename` | string | 图片文件原名 | | `url` | string | 图片下载地址 | ### 获取群消息 终结点: `/get_group_msg` 参数 | 字段 | 类型 | 说明 | | ------------ | ----- | ------ | | `message_id` | int32 | 消息id | 响应数据 | 字段 | 类型 | 说明 | | ------------ | ------- | ---------- | | `message_id` | int32 | 消息id | | `real_id` | int32 | 消息真实id | | `sender` | object | 发送者 | | `time` | int32 | 发送时间 | | `content` | message | 消息内容 | ### 获取合并转发内容 终结点: `/get_forward_msg` 参数 | 字段 | 类型 | 说明 | | ------------ | ------ | ------ | | `message_id` | string | 消息id | 响应数据 | 字段 | 类型 | 说明 | | ---------- | ----------------- | -------- | | `messages` | forward message[] | 消息列表 | 响应示例 ````json { "data": { "messages": [ { "content": "合并转发1", "sender": { "nickname": "发送者A", "user_id": 10086 }, "time": 1595694374 }, { "content": "合并转发2[CQ:image,file=xxxx,url=xxxx]", "sender": { "nickname": "发送者B", "user_id": 10087 }, "time": 1595694393 } ] }, "retcode": 0, "status": "ok" } ```` ### 发送合并转发(群) 终结点: `/send_group_forward_msg` **参数** | 字段 | 类型 | 说明 | | ---------- | -------------- | ---------------------------- | | `group_id` | int64 | 群号 | | `messages` | forward node[] | 自定义转发消息, 具体看CQCode | ### ## 事件 #### 群消息撤回 **上报数据** | 字段 | 类型 | 可能的值 | 说明 | | ------------- | ------ | -------------- | -------------- | | `post_type` | string | `notice` | 上报类型 | | `notice_type` | string | `group_recall` | 消息类型 | | `group_id` | int64 | | 群号 | | `user_id` | int64 | | 消息发送者id | | `operator_id` | int64 | | 操作者id | | `message_id` | int64 | | 被撤回的消息id | #### 好友消息撤回 **上报数据** | 字段 | 类型 | 可能的值 | 说明 | | ------------- | ------ | -------------- | -------------- | | `post_type` | string | `notice` | 上报类型 | | `notice_type` | string | `friend_recall`| 消息类型 | | `user_id` | int64 | | 好友id | | `message_id` | int64 | | 被撤回的消息id | #### 群内戳一戳 > 注意：此事件无法在平板和手表协议上触发 **上报数据** | 字段 | 类型 | 可能的值 | 说明 | | ------------- | ------ | -------------- | -------------- | | `post_type` | string | `notice` | 上报类型 | | `notice_type` | string | `notify` | 消息类型 | | `group_id` | int64 | | 群号 | | `sub_type` | string | `poke` | 提示类型 | | `user_id` | int64 | | 发送者id | | `target_id` | int64 | | 被戳者id | #### 群红包运气王提示 > 注意：此事件无法在平板和手表协议上触发 **上报数据** | 字段 | 类型 | 可能的值 | 说明 | | ------------- | ------ | -------------- | -------------- | | `post_type` | string | `notice` | 上报类型 | | `notice_type` | string | `notify` | 消息类型 | | `group_id` | int64 | | 群号 | | `sub_type` | string | `lucky_king` | 提示类型 | | `user_id` | int64 | | 红包发送者id | | `target_id` | int64 | | 运气王id | #### 群成员荣誉变更提示 > 注意：此事件无法在平板和手表协议上触发 **上报数据** | 字段 | 类型 | 可能的值 | 说明 | | ------------- | ------ | -------------- | -------------- | | `post_type` | string | `notice` | 上报类型 | | `notice_type` | string | `notify` | 消息类型 | | `group_id` | int64 | | 群号 | | `sub_type` | string | `honor` | 提示类型 | | `user_id` | int64 | | 成员id | | `honor_type` | string | `talkative:龙王` `performer:群聊之火` `emotion:快乐源泉` | 荣誉类型 |