Cucko Docs

导航

消息构建函数 消息发送函数 好友管理函数 群管理函数 消息管理函数 其他功能函数

消息构建函数

BOTAPI()

BOTAPI($url,$json)

底层API调用函数。

参数名 类型 介绍
$url string API路径(不带基础URL)
$json mixed 请求参数(数组或0)

text()

text($content)

构建文本消息段。

参数名 类型 介绍
$content string 文本内容

使用示例:

text("Hello World")

reply()

reply($content)

构建回复消息段。

参数名 类型 介绍
$content string 要回复的消息ID

使用示例:

reply($消息ID)

face()

face($id)

构建表情消息段。

参数名 类型 介绍
$id int/string 表情ID

使用示例:

face(1)

image()

image($content)

构建图片消息段。

参数名 类型 介绍
$content string 图片文件路径或URL

使用示例:

image("http://example.com/pic.jpg")

video()

video($content)

构建视频消息段。

参数名 类型 介绍
$content string 视频文件路径或URL

使用示例:

video("http://example.com/video.mp4")

music()

music($type,$id)

构建音乐分享消息段。

参数名 类型 介绍
$type string 音乐类型
$id string 音乐ID

使用示例:

music("qq", "123456")

at()

at($content)

构建@用户消息段。

参数名 类型 介绍
$content int/string 被@的用户QQ号

使用示例:

at(123456)

kp()

kp($content)

构建JSON卡片消息段。

参数名 类型 介绍
$content string JSON数据

使用示例:

kp('{"app":"com.xxx.menu"}')

伪造()

伪造($QQ,$name,…$msgs)

构建合并转发消息节点。

参数名 类型 介绍
$QQ int/string 伪造的发送者QQ号
$name string 伪造的发送者昵称
…$msgs mixed 可变参数,一个或多个消息段

使用示例:

伪造(123456, "系统通知", text("重要通知"), text("请查收"))

CQ_message()

CQ_message($raw)

解析CQ码消息,将CQ码替换为可读文本。

参数名 类型 介绍
$raw string 包含CQ码的原始消息

使用示例:

CQ_message("你好[CQ:at,qq=123456]")

消息发送函数

群()

群($group,…$msgs)

向指定群发送消息。

参数名 类型 介绍
$group int/string 目标群号
…$msgs mixed 可变参数,一个或多个消息段

使用示例:

(123456, text("Hello"), image("http://example.com/image.jpg"))

私()

私($group,…$msgs)

向指定用户发送私聊消息。

参数名 类型 介绍
$group int/string 目标用户QQ号
…$msgs mixed 可变参数,一个或多个消息段

使用示例:

(987654, text("这是一条私聊消息"))

群伪造()

群伪造($group,…$msgs)

发送群合并转发消息。

参数名 类型 介绍
$group int/string 目标群号
…$msgs mixed 可变参数,一个或多个伪造消息节点

使用示例:

群伪造(123456, 伪造(10001, "小助手", text("你好")))

私伪造()

私伪造($group,…$msgs)

发送私聊合并转发消息。

参数名 类型 介绍
$group int/string 目标用户QQ号
…$msgs mixed 可变参数,一个或多个伪造消息节点

使用示例:

私伪造(987654, 伪造(10001, "小助手", text("私聊消息")))

好友管理函数

点赞()

点赞($QQ,$times)

给指定用户点赞。

参数名 类型 介绍
$QQ int/string 目标用户QQ号
$times int 点赞次数

使用示例:

点赞(123456, 10)

好友列表()

好友列表()

获取好友列表。

使用示例:

$friendList = 好友列表()

删除好友()

删除好友($QQ)

删除指定好友。

参数名 类型 介绍
$QQ int/string 要删除的好友QQ号

使用示例:

删除好友(123456)

陌生人信息()

陌生人信息($QQ)

获取陌生人信息。

参数名 类型 介绍
$QQ int/string 目标用户QQ号

使用示例:

$info = 陌生人信息(123456)

群管理函数

群列表()

群列表()

获取机器人加入的群列表。

使用示例:

$groupList = 群列表()

群详情()

群详情($QQ)

获取群基本信息。

参数名 类型 介绍
$QQ int/string 群号

使用示例:

$groupInfo = 群详情(123456)

群详细信息()

群详细信息($QQ)

获取群详细信息。

参数名 类型 介绍
$QQ int/string 群号

使用示例:

$detailInfo = 群详细信息(123456)

群成员列表()

群成员列表($QQ)

获取群成员列表。

参数名 类型 介绍
$QQ int/string 群号

使用示例:

$memberList = 群成员列表(123456)

群成员信息()

群成员信息($group,$QQ)

获取指定群成员信息。

参数名 类型 介绍
$group int/string 群号
$QQ int/string 用户QQ号

使用示例:

$memberInfo = 群成员信息(123456, 789012)

设置群管理()

设置群管理($group,$QQ)

设置群管理员。

参数名 类型 介绍
$group int/string 群号
$QQ int/string 用户QQ号

使用示例:

设置群管理(123456, 789012)

取消群管理()

取消群管理($group,$QQ)

取消群管理员。

参数名 类型 介绍
$group int/string 群号
$QQ int/string 用户QQ号

使用示例:

取消群管理(123456, 789012)

设置群名片()

设置群名片($group,$QQ,$name)

设置群成员名片。

参数名 类型 介绍
$group int/string 群号
$QQ int/string 用户QQ号
$name string 新名片

使用示例:

设置群名片(123456, 789012, "新名片")

禁言()

禁言($group,$QQ,$time)

禁言群成员。

参数名 类型 介绍
$group int/string 群号
$QQ int/string 用户QQ号
$time int 禁言时长(秒)

使用示例:

禁言(123456, 789012, 600) // 禁言10分钟

解禁()

解禁($group,$QQ)

解除群成员禁言。

参数名 类型 介绍
$group int/string 群号
$QQ int/string 用户QQ号

使用示例:

解禁(123456, 789012)

全体禁言()

全体禁言($group)

开启全体禁言。

参数名 类型 介绍
$group int/string 群号

使用示例:

全体禁言(123456)

全体解禁()

全体解禁($group)

关闭全体禁言。

参数名 类型 介绍
$group int/string 群号

使用示例:

全体解禁(123456)

禁言列表()

禁言列表($QQ)

获取群禁言列表。

参数名 类型 介绍
$QQ int/string 群号

使用示例:

$banList = 禁言列表(123456)

设置群名()

设置群名($group,$name)

设置群名称。

参数名 类型 介绍
$group int/string 群号
$name string 新群名

使用示例:

设置群名(123456, "新群名")

踢()

踢($group,$QQ,$status = false)

踢出群成员。

参数名 类型 介绍 默认值
$group int/string 群号 -
$QQ int/string 用户QQ号 -
$status bool 是否拒绝再次加群 false

使用示例:

(123456, 789012, true)

批量踢()

批量踢($group,…$QQ)

批量踢出群成员。

参数名 类型 介绍
$group int/string 群号
…$QQ mixed 可变参数,一个或多个用户QQ号

使用示例:

批量踢(123456, 789012, 345678)

设置群头衔()

设置群头衔($group,$QQ,$title)

设置群成员特殊头衔。

参数名 类型 介绍
$group int/string 群号
$QQ int/string 用户QQ号
$title string 特殊头衔

使用示例:

设置群头衔(123456, 789012, "管理员")

设置群公告()

设置群公告($group,$content,$image=)

设置群公告。

参数名 类型 介绍 默认值
$group int/string 群号 -
$content string 公告内容 -
$image string 图片URL null

使用示例:

设置群公告(123456, "新公告", "http://example.com/image.jpg")

处理加群申请()

处理加群申请($flag,$approve)

处理加群申请。

参数名 类型 介绍
$flag string 申请标识符
$approve bool 是否同意

使用示例:

处理加群申请($申请ID, true)

消息管理函数

撤回()

撤回($id)

撤回指定消息。

参数名 类型 介绍
$id int/string 消息ID

使用示例:

撤回($消息ID)

消息详情()

消息详情($QQ)

获取消息详情。

参数名 类型 介绍
$QQ int/string 消息ID

使用示例:

$msgInfo = 消息详情($消息ID)

贴表情()

贴表情($id,$emoji)

给消息添加表情反应。

参数名 类型 介绍
$id int/string 消息ID
$emoji string 表情ID

使用示例:

贴表情($消息ID, "128077")

群历史消息()

群历史消息($group,$count)

获取群历史消息。

参数名 类型 介绍
$group int/string 群号
$count int 消息数量

使用示例:

$history = 群历史消息(123456, 50)

取消息()

取消息($raw,$type)

从原始消息中提取特定类型的消息内容。

参数名 类型 介绍
$raw string 原始消息JSON字符串
$type string 消息类型:
“reply” - 回复消息ID
“json” - JSON卡片数据
“audio” - 音频URL
“video” - 视频URL
“at” - @的用户QQ数组
“image” - 图片URL数组

使用示例:

$atUsers = 取消息($raw消息, "at")

其他功能函数

群文件()

群文件($group,$file,$name,$folder = null)

上传群文件。

参数名 类型 介绍 默认值
$group int/string 群号 -
$file string 文件路径 -
$name string 文件名 -
$folder string 文件夹ID null

使用示例:

群文件(123456, "/path/to/file.txt", "file.txt")

设置头像()

设置头像($url)

设置机器人头像。

参数名 类型 介绍
$url string 图片URL

使用示例:

设置头像("http://example.com/avatar.jpg")

owner()

owner($QQ)

检查是否为机器人主人。

参数名 类型 介绍
$QQ int/string 用户QQ号

使用示例:

if (owner($QQ)) {
    // 是主人
}

owner_list()

owner_list()

获取主人列表。

使用示例:

$owners = owner_list()

AI语音()

AI语音($group,$id,$msg)

发送AI语音消息。

参数名 类型 介绍
$group int/string 群号
$id string 角色ID
$msg string 文本内容

使用示例:

AI语音(123456, "xiaoyun", "你好")

AI语音角色列表()

AI语音角色列表($group)

获取AI语音角色列表。

参数名 类型 介绍
$group int/string 群号

使用示例:

$characters = AI语音角色列表(123456)

音乐卡片()

音乐卡片($type,$title,$desc,$url,$image,$audio)

生成音乐卡片。

参数名 类型 介绍
$type string 卡片类型
$title string 歌曲标题
$desc string 歌手/描述
$url string 跳转链接
$image string 封面图片
$audio string 音频链接

使用示例:

音乐卡片("qq", "歌曲名", "歌手", "http://...", "http://...", "http://...")

群头像()

群头像($group)

获取群头像URL。

参数名 类型 介绍
$group int/string 群号

使用示例:

$avatar = 群头像(123456)

头像()

头像($QQ)

获取用户头像URL。

参数名 类型 介绍
$QQ int/string 用户QQ号

使用示例:

$avatar = 头像(123456)

群打卡()

群打卡($group)

群打卡。

参数名 类型 介绍
$group int/string 群号

使用示例:

群打卡(123456)

clientkey()

clientkey()

获取客户端key。

使用示例:

$key = clientkey()

登录号信息()

登录号信息()

获取登录账号信息。

使用示例:

$loginInfo = 登录号信息()

发包()

发包($cmd,$pb)

发送Protobuf数据包。

参数名 类型 介绍
$cmd string 命令
$pb string Protobuf数据

使用示例:

发包("cmd", $protobufData)

点击按钮()

点击按钮($appid,$group,$button,$button_id=1)

点击内联键盘按钮。

参数名 类型 介绍 默认值
$appid string 应用ID -
$group int/string 群号 -
$button string 按钮标识 -
$button_id int 按钮ID 1

使用示例:

点击按钮("app123", 123456, "confirm")