# CQ码
WARNING
部分方法可能会因为客户端更新而失效
CQ码可用于发送各种额外消息，如在消息中@某人
this.Bot.sendGroupMsg(10001, this.Bot.CQCode.at(10001))
# @某人(at)
▸ at(qqId: number, isNoSpace?: boolean): string
# Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
qqId | number | - | -1 为全体 |
isNoSpace | boolean | false | 默认为假 At后添加空格，可使At更规范美观。如果不需要添加空格，请置本参数为true |
Returns: string
Defined in: Tools/CQCode.ts:44
# xml大图
▸ cardimage(file: string, minwidth?: number, minheight?: number, maxwidth?: number, maxheight?: number, source?: string, icon?: string): string
# Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
file | string | - | 和image的file字段对齐，支持也是一样的 |
minwidth | number | 400 | 默认不填为400，最小width |
minheight | number | 400 | 默认不填为400，最小height |
maxwidth | number | 500 | 默认不填为500，最大width |
maxheight | number | 1000 | 默认不填为1000，最大height |
source | string | '' | 分享来源的名称，可以留空 |
icon | string | '' | 分享来源的icon图标url，可以留空 |
Returns: string
Defined in: Tools/CQCode.ts:224
# 音乐自定义分享
▸ customMusic(url: string, audio: string, title: string, content?: string, image?: string): string
# Parameters:
| Name | Type | Description |
|---|---|---|
url | string | 点击后跳转目标 URL |
audio | string | 音乐 URL |
title | string | 标题 |
content? | string | 发送时可选, 内容描述 |
image? | string | 发送时可选, 图片 URL |
Returns: string
Defined in: Tools/CQCode.ts:76
# 自定义合并转发消息节点
▸ customNode(name: string, uin: number, content: Message): NodeMessage
需要使用单独的API /send_group_forward_msg 发送，并且由于消息段较为复杂，仅支持Array形式入参
# Parameters:
| Name | Type | Description |
|---|---|---|
name | string | 发送者显示名字 |
uin | number | 发送者QQ号 |
content | Message | 具体消息 |
Returns: NodeMessage
Defined in: Tools/CQCode.ts:186
# 自定义回复
▸ customReply(text: string, qq: number, time?: number, seq?: number): string
# Parameters:
| Name | Type | Description |
|---|---|---|
text | string | 自定义回复的信息 |
qq | number | 自定义回复时的自定义QQ |
time? | number | 自定义回复时的时间, 格式为Unix时间 |
seq? | number | 起始消息序号, 可通过 get_msg 获得 |
Returns: string
Defined in: Tools/CQCode.ts:113
# QQ表情
▸ face(id: number): string
https://github.com/kyubotics/coolq-http-api/wiki/%E8%A1%A8%E6%83%85-CQ-%E7%A0%81-ID-%E8%A1%A8
# Parameters:
| Name | Type | Description |
|---|---|---|
id | number | 表情id |
Returns: string
Defined in: Tools/CQCode.ts:13
# 合并转发
▸ forward(id: number): string
# Parameters:
| Name | Type | Description |
|---|---|---|
id | number | 合并转发ID, 需要通过 /get_forward_msg API获取转发的具体内容 |
Returns: string
Defined in: Tools/CQCode.ts:161
# 发送礼物
▸ gift(qq: number, id: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13): string
仅支持免费礼物,发送群礼物消息无法撤回
# Parameters:
| Name | Type | Description |
|---|---|---|
qq | number | 接收礼物的成员 |
id | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 礼物的类型 0 甜Wink 1 快乐肥宅水 2 幸运手链 3 卡布奇诺 4 猫咪手表 5 绒绒手套 6 彩虹糖果 7 坚强 8 告白话筒 9 牵你的手 10 可爱猫咪 11 神秘面具 12 我超忙的 13 爱心口罩 |
Returns: string
Defined in: Tools/CQCode.ts:153
# 图片
▸ image(file: string, cache?: 0 | 1, type?: "flash" | "show", id?: 40000 | 40001 | 40002 | 40003 | 40004 | 40005, c?: 2 | 3): string
# Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
file | string | - | 图片文件名或URL |
cache | 0 | 1 | 1 | 只在通过网络 URL 发送时有效，表示是否使用已缓存的文件，默认 1 |
type? | "flash" | "show" | - | 图片类型，flash 表示闪照，show 表示秀图，默认普通图片 |
id | 40000 | 40001 | 40002 | 40003 | 40004 | 40005 | 40000 | 发送秀图时的特效id，默认为40000 |
c? | 2 | 3 | - | 通过网络下载图片时的线程数, 默认单线程. (在资源不支持并发时会自动处理) |
Returns: string
Defined in: Tools/CQCode.ts:88
# 发送json卡片
▸ json(data: string, resid?: number): string
# Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
data | string | - | json内容，json的所有字符串记得实体化处理 |
resid | number | 0 | 默认不填为0, 走小程序通道, 填了走富文本通道发送 |
Returns: string
Defined in: Tools/CQCode.ts:210
# 音乐分享
▸ music(type: "qq" | "163", id: number): string
# Parameters:
| Name | Type | Description |
|---|---|---|
type | "qq" | "163" | 分别表示使用 QQ 音乐、网易云音乐、虾米音乐 |
id | number | 歌曲 ID |
Returns: string
Defined in: Tools/CQCode.ts:64
# 合并转发消息节点
▸ node(id: number): NodeMessage
需要使用单独的API /send_group_forward_msg 发送，并且由于消息段较为复杂，仅支持Array形式入参
# Parameters:
| Name | Type | Description |
|---|---|---|
id | number | 转发消息id |
Returns: NodeMessage
Defined in: Tools/CQCode.ts:170
# 戳一戳(仅群聊)
▸ poke(qq: number): string
# Parameters:
| Name | Type | Description |
|---|---|---|
qq | number | 需要戳的成员 |
Returns: string
Defined in: Tools/CQCode.ts:129
# 语音
▸ record(file: string, magic?: 0 | 1, cache?: 0 | 1, proxy?: 0 | 1, timeout?: number): string
# Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
file | string | - | 语音文件名 |
magic | 0 | 1 | 0 | 发送时可选, 默认 0, 设置为 1 表示变声 |
cache | 0 | 1 | 1 | 只在通过网络 URL 发送时有效, 表示是否使用已缓存的文件, 默认 1 |
proxy | 0 | 1 | 1 | 只在通过网络 URL 发送时有效, 表示是否通过代理下载文件 ( 需通过环境变量或配置文件配置代理 ) , 默认 1 |
timeout? | number | - | 只在通过网络 URL 发送时有效, 单位秒, 表示下载网络文件的超时时间 , 默认不超时 |
Returns: string
Defined in: Tools/CQCode.ts:25
# 红包
▸ redbag(title: string): string
# Parameters:
| Name | Type | Description |
|---|---|---|
title | string | 祝福语/口令 |
Returns: string
Defined in: Tools/CQCode.ts:121
# 回复
▸ reply(id: number): string
# Parameters:
| Name | Type | Description |
|---|---|---|
id | number | 回复时所引用的消息id, 必须为本群消息. |
Returns: string
Defined in: Tools/CQCode.ts:102
# 链接分享
▸ share(url: string, title?: string, content?: string, image?: string): string
# Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
url | string | - | 分享的链接 |
title | string | '' | 分享的标题 |
content? | string | - | 分享的简介 |
image? | string | - | 分享的图片链接 |
Returns: string
Defined in: Tools/CQCode.ts:55
# 文本转语音
▸ tts(text: string): string
通过TX的TTS接口，采用的音源与登录账号的性别有关
# Parameters:
| Name | Type | Description |
|---|---|---|
text | string | 内容 |
Returns: string
Defined in: Tools/CQCode.ts:233
# 短视频
▸ video(file: string, cover?: string, c?: 2 | 3): string
# Parameters:
| Name | Type | Description |
|---|---|---|
file | string | 视频地址, 支持http和file发送 |
cover? | string | 视频封面, 支持http, file和base64发送, 格式必须为jpg |
c? | 2 | 3 | 通过网络下载视频时的线程数, 默认单线程. (在资源不支持并发时会自动处理) |
Returns: string
Defined in: Tools/CQCode.ts:35
# 发送xml卡片
▸ xml(data: string): string
# Parameters:
| Name | Type | Description |
|---|---|---|
data | string | xml内容，xml中的value部分，记得实体化处理 |
Returns: string
Defined in: Tools/CQCode.ts:201