PHP_Robot项目文档


开发PHP_Robot不可或缺的就是词库,PHP_Robot项目文档将为您讲述如何去编写它~

 

框架提供的静态变量


public static $HOST;//服务端监听地址
public static $PORT;//服务端监听端口
public static $MASTER ;//主人QQ号码
public static $DEBUG;//是否开启调试模式
public static $AUTH_GROUP;//授权的QQ群号码
public static $SAFE_MODE;//是否开启安全模式
调用方式 可能的值 作用
Robot::$HOST
127.0.0.1 配置分发器IP
Robot::$PORT
10000 配置分发器端口
Robot::$MASTER
3451709080 主人的QQ
Robot::$DEBUG
true or false debug模式开关
Robot::$HOSTAUTH_GROUP
array(783742193)  开启机器人的群组
Robot::$SAFEMODE
true or false 暂时不开启

 

框架提供的成员方法


getCompleteMessage()


作用:获取完整消息

无需传入参数,返回完整消息。

 

setCompleteMessage()


作用:设置完整消息

传入参数 参数示例 参数说明
$complete_message

getCompleteMessage()

完整消息内容

 

setMessageType()


作用:设置消息类型

传入参数 参数示例 参数说明
$message_type

setMessageType()

消息类型

 

getMessage()


作用:获取消息内容

无需传入参数,返回消息内容。

 

getUserId()


作用:获取发送消息者的QQ

无需传入参数,返回发送消息者的QQ。

 

getSelfId()


作用:获取自己的QQ号

无需传入参数,返回自己的QQ号。

 

getNickname()


作用:获取发送消息者的昵称

无需传入参数,返回发送消息者的昵称。

 

getGroupId()


作用:获取发送消息者的昵称

无需传入参数,返回发送消息者的昵称。

 

getCard()


作用:获取卡片消息

无需传入参数,返回卡片消息。

 

getMessageId()


作用:获取消息ID

无需传入参数,返回消息ID。

 

setMessage()


作用:设置消息为

传入参数 参数示例 参数说明
$message

Hello

消息内容

 

setUserId()


作用:设置用户ID

传入参数 参数示例 参数说明
$user_id

3451709080

用户ID

 

setSelfId()


作用:设置自己ID

传入参数 参数示例 参数说明
$self_id

3451709080

自己ID

 

setGroupId()


作用:设置群号

传入参数 参数示例 参数说明
$self_id

3451709080

自己ID

 

setCard()


作用:设置卡片消息为

传入参数 参数示例 参数说明
$card

3451709080

<?xml version='1.0' encoding='UTF-8' standalone='yes' ?><msg serviceID="1" templateID="123" action="web" brief="公安局的分享" sourceMsgId="0" url="http://liflag.cn" flag="0" adverSign="0" multiMsgFlag="0"><item layout="2" action_type="0" advertiser_id="0" aid="0" dest_type="0" product_type="0"><picture cover="http://p.qpic.cn/qqshare/0/0bbf35a703b29c86d989636509d5d1ca/0" w="0" h="0" /><title>公安局已加入该群</title><summary>公安局已开始监控聊天</summary></item><source name="刑警已介入" icon="" action="" appid="0" /></msg>

 

setMessageId()


作用:设置消息ID为

传入参数 参数示例 参数说明
$message_id

4846451

消息ID

 

使用频率较高的方法


 

sendPrivateMsg($userId, $message)


作用:发送私信信息

传入参数 参数示例 参数说明
$userId

3451709080

对方的QQ
$message

你太帅拉

发送的信息

 

sendGroupMsg($groupId, $message)


作用:发送群组信息

传入参数 参数示例 参数说明
$groupId

783742193

群号
$message

老嘤太帅拉

发送的信息

发送到群组需要在Config.json中启用!

 

deleteMsg($messageId)


作用:撤回消息

传入参数 参数示例 参数说明
$messageId

暂无

消息ID

 

getMassageInfo($message_id)


作用:获取消息信息

传入参数 参数示例 参数说明
$message_id

暂无

消息ID

 

getImgInfo($imgName)


作用:获取图片信息

传入参数 参数示例 参数说明
$imgName

暂无

POST图片地址

 

kickGroupUser($groupId,$userId,$rejectAddRequest)


作用:在指定群内踢出成员

传入参数 参数示例 参数说明
$groupId

123456789

群号码
$userId

835201983

需要踢出的QQ号
$rejectAddRequest

默认false,打开则为true

是否拒绝入群

 

banGroupUser($groupId,$userId,$banTime)


作用:在指定群禁言成员

传入参数 参数示例 参数说明
$groupId

123456789

群号码
$userId

835201983

需要禁言的QQ号
$banTime

禁言时长,单位秒,0 表示取消禁言

禁言时间

 

banAnonymousUser($groupId,$userId,$userFlag,$banTime)


作用:群组匿名用户禁言

传入参数 参数示例 参数说明
$groupId

123456789

群号码
$userId

835201983

需要禁言的QQ号
$userFlag

可选,要禁言的匿名用户的 flag(需从群消息上报的数据中获得)

匿名用户选择
$banTime

禁言时长,单位秒,0 表示取消禁言

禁言时间

 

setWholeBan($groupId,$enable)


作用:全体禁言

传入参数 参数示例 参数说明
$groupId

123456789

需要禁言的群号码
$enable

默认为ture开启,关闭则填false

是否禁言

 

setGroupAdmin($groupId,$userId,$enable)


作用:设置管理员

传入参数 参数示例 参数说明
$groupId

123456789

群号码
$userId

835201983

需要设置管理的QQ号
$enable

true 为设置,false 为取消

是否设置

 

setUserCard($groupId,$userId,$card)


作用:设置群名片

传入参数 参数示例 参数说明
$groupId

123456789

群号码
$userId

835201983

需要设置名片的QQ号
$card

群名片内容,不填或空字符串表示删除群名片

名片内容

 

setGroupName($groupId,$groupName)


作用:设置群名称

传入参数 参数示例 参数说明
$groupId

123456789

需要设置的群号码
$groupName

默认为ture开启,关闭则填false

是否禁言

 

leaveGroup($groupId,$isDismiss)


作用:退出群聊

传入参数 参数示例 参数说明
$groupId

123456789

需要设置的群号码
$isDismiss

true

是否解散,如果登录号是群主,则仅在此项为 true 时能够解散

 

setSpecialTitle($groupId,$userId,$special_title,$duration)


作用:设置头衔

传入参数 参数示例 参数说明
$groupId

123456789

群号
$userId

835201983

需要设置头衔的QQ号
$special_title

玖逸

专属头衔,不填或空字符串表示删除专属头衔
$duration

-1

专属头衔有效期,单位秒,-1 表示永久,不过此项似乎没有效果,可能是只有某些特殊的时间长度有效,有待测试

 

setFriendAddRequest($flag,$approve,$remark)


作用:处理加好友请求

传入参数 参数示例 参数说明
$flag

加好友请求的 flag(需从上报的数据中获得)
$approve

true/false

是否同意请求
$remark

牛马

添加后的好友备注(仅在同意时有效)

 

setGroupAddRequest($flag,$type,$approve,$reason)


处理加群请求/邀请

传入参数 参数示例 参数说明
$flag

暂无

加群请求的 flag(需从上报的数据中获得)
$type

add/invite

add 或 invite,请求类型(需要和上报消息中的 sub_type 字段相符)
$approve

true/false

是否同意请求/邀请
$reason

老嘤太帅拉

拒绝理由(仅在拒绝时有效)

 

getLoginInfo()


作用:获取账号信息

无需传入参数,返回QQ号和昵称

 

getQidianLoginInfo()


作用:获取企点账号信息

无需传入参数,返回信息

 

getStrangerInfo($userId,$noCache)


作用:获取陌生人信息

传入参数 参数示例 参数说明
$userId

123456789

QQ号
$noCache

true/false

是否不使用缓存(使用缓存可能更新不及时,但响应更快)

 

getFriendList()


作用:获取好友列表

无需传入参数,返回json数据

返回json介绍:user_id为QQ号,nickname为昵称,remark为备注

 

deleteFriend($userId)


作用:删除好友

传入参数 参数示例 参数说明
$userId

暂无

需要删除的QQ

 

getGroupInfo($groupId,$noCache)


作用:获取群信息

传入参数 参数示例 参数说明
$groupId

123456789

群号
$noCache

true/false

是否不使用缓存(使用缓存可能更新不及时,但响应更快)

 

getGroupList()


作用:获取群列表

无需传入参数,返回json数据

返回json介绍:group_id为群号,group_name为群名称

 

getGroupMemberList($groupId)


作用:获取群成员列表

传入参数 参数示例 参数说明
$groupId

暂无

需要获取的群号

 

canSendImg()


作用:检查是否可以发送图片

无需传入参数,返回yes或no

 

canSendRecord()


作用:检查是否可以发送语音

无需传入参数,返回yes或no

 

getVersionInfo()


 

作用:获取版本信息

无需传入参数,返回CQ及插件信息

 

restartBot()


 

作用:重启GO-CQHTTP

参数:delay 要延迟的毫秒数, 如果默认情况下无法重启, 可以尝试设置延迟为 2000 左右

 

cleanCache()


 

作用:清理缓存

无需传入参数,清理缓存

 

setGroupPortrait($groupId,$filePath,$Cache)


 

作用:设置群头像

传入参数 参数示例 参数说明
$groupId

需要设置的群号
$filePath

图片文件名
$Cache

1/0,1表示使用,0表示不使用

是否使用已缓存的文件

 

getWordSlices($content)


作用:获取中文分词

传入参数 参数示例 参数说明
$content

老嘤太帅了吧卧槽

内容

 

ocrImg($image)


作用:图片OCR

传入参数 参数示例 参数说明
$image

暂无

图片ID

 

handleQuickOperation($context,$operation)


作用:对事件执行快速操作

传入参数 参数示例 参数说明
$context

事件上报的数据对象
$operation

true/false

快速操作对象,例如 {"ban": true, "reply": "老嘤太帅了,妒忌死了"}

 

getGroupSystemMsg()


作用:获取群系统消息

无需传入参数,返回系统信息

 

getVipInfo($userId)


 

作用:获取会员信息(暂不可用)

传入参数 参数示例 参数说明
$userId

835201983

需要获取的QQ号

 

uploadGroupFile($groupId,$filePath,$fileName,$dirId)


作用:上传文件

传入参数 参数示例 参数说明
$groupId

123456789

群号
$filePath

暂无

本地文件路径
$fileName

暂无

储存名称
$dirId

暂无

父目录ID

 

getGroupFileInfo($groupId)


作用:获取群文件系统信息

传入参数 参数示例 参数说明
$groupId

暂无

群号

 

getGroupFileList($groupId)


作用:取文件目录列表

传入参数 参数示例 参数说明
$groupId

暂无

群号

 

getGroupFolderList($groupId,$folderId)


作用:获取群子目录列表

传入参数 参数示例 参数说明
$groupId

暂无

群号
$folderId

暂无

文件夹ID

 

getStatus()


作用:获取状态

无需传入参数,直接返回状态

 

getGroupAtAllRemain($groupId)


作用:获取剩余艾特全体次数

传入参数 参数示例 参数说明
$groupId

暂无

群号

 

sendGroupNotice($groupId,$content,$image)


作用:发送公告

传入参数 参数示例 参数说明
$groupId

123456789

群号
$content

老嘤好帅啊卧槽

内容
$image

图片路径(可选)

 

reloadEventFilter($file)


作用:重载事件过滤器

传入参数 参数示例 参数说明
$file

暂无

事件过滤器文件

 

downloadFile($url,$threadCount,$headers)


作用:下载文件

传入参数 参数示例 参数说明
$url

http://www.baidu.com/

链接地址
$threadCount

暂无

下载线程数
$headers

User-Agent=YOUR_UA[\r\n]Referer=https://www.baidu.com

自定义请求头

 

getOnlineClients($noCache)


作用:获取当前账号在线客户端

传入参数 参数示例 参数说明
$noCache

true/false

是否不使用缓存(使用缓存可能更新不及时,但响应更快)

 

setEssenceMsg($messageId)


作用:设置精华消息

传入参数 参数示例 参数说明
$message_id

暂无

消息ID

 

deleteEssenceMsg($messageId)


作用:删除精华消息

传入参数 参数示例 参数说明
$message_id

暂无

消息ID

 

checkUrlSafely($url)


作用:检查连接安全性

传入参数 参数示例 参数说明
$url

暂无

需要检查的链接

 

getModelShow($model)


作用:获取机型

传入参数 参数示例 参数说明
$model

暂无

机型名称

 

setModelShow($model,$modelShow)


作用:设置在线机型

传入参数 参数示例 参数说明
$model

true/false

机型名称
$modelShow

暂无

-