Home

Awesome

HTTP-API: CoolQ/QQLight/QY Extensioin

扩展你的QQ/微信机器人用途,提供跨框架平台的PHP/Java/Python/NodeJS等编程语言SDK。


HTTP-API简介


HTTP-API是一款主要通过HTTP协议(另外也包含使用webSocket、socket等协议)与机器人进行通信的插件,主要提供PHP/Java/Python/NodeJS等编程语言SDK,以便将机器人用于WEB、大数据、机器学习等领域,尽可能地提现数据的价值。
目前插件主要支持酷Q、QQLight、契约机器人框架,开发者可以通过使用SDK非常方便地对机器人进行操作,比如控制机器人发送消息、公告,获取机器人群列表、好友列表,通过及监听获取近一个月、或者几年的聊天记录。开发者可通过简单的操作完成一些小程序、小应用对的开发,亦可应用于大型应用中。
此外,通过配合使用WEB管理平台,开发者可将自己开发的应用发布到应用商店中,通过用户安装的方式获得收入、使用数据等。用户可直接通过WEB平台安装、管理应用,以及可以批量管理机器人在线状态、收发消息等,让用户用最少的时间完成尽可能多的事。
注:以下表格描述中QQLight简称QL,CoolQ(酷Q)简称CQ,契约简称QY
交流群:(QQ群,用户加入)537419179
开发群:(QQ群,开发者加入)598629636
管理平台:http://work.ksust.com

版本分布(来源)

名称最新版本协议版本状态来源备注Demo地址
HTTP-API For CleverQQ2.3.02.3.0已跑路标准插件HTTP-API CleverQQ DLL插件插件下载
HTTP-API For CoolQ2.3.62.3.6已发布标准插件HTTP-API 酷Q cpk插件插件下载
HTTP-API For QQLight2.3.62.3.6已发布标准插件HTTP-API QQLight 3.x插件插件下载
HTTP-API For QY2.3.62.3.6已发布标准插件HTTP-API 契约多Q/单Q版插件下载
HTTP-API PHP SDK2.3.02.3.0已发布标准SDKPHP SDKPHP Demo
HTTP-API Java SDK2.3.02.3.0已发布(Maven)标准SDKJava SDKJava Demo
HTTP-API Python SDK2.3.02.3.0已发布(Pypi)标准SDKPython SDKPython Demo
HTTP-API NodeJS SDK2.3.02.3.0已发布(npm)标准SDKNodeJS SDKNodeJS Demo
HTTP-API Cloud APIv12.3.0已发布标准REST API在线文档
SDK NameSDK版本HTTP-API协议版本完成状态...来源,其他GITHub仓库开发者备注-

功能介绍


本插件主要包含三种工作机制,即提交返回、主动推送、消息转发,第一种为被动接受,后两种为主动操作,其中提交返回包括HTTP方式、webSocket方式,主动推送使用HTTP方式,消息转发目前仅公开使用HTTP方式,几种方式中HTTP提交返回最常用也最通用。
下面将简单介绍插件的几种工作方式,相关配置请结合插件进行(页底使用引导)。

提交返回

提交返回是最常用的一种工作方式,其原理为:机器人插件作为客户端(做网页请求),开发者开发WEB服务端;在工作时,插件将收到的消息(如QQ消息)经过协议封装后发送到开发者的WEB服务,该服务队发送过来的数据进行处理并返回给插件一些操作命令(如发送消息)。至此,一次简单的工作流程结束。
显然,该工作流程是被动的,开发者的WEB服务必须等待插件访问才能执行相关逻辑,在这种机制下某些操作不能完成。于是,本插件引入WEB回调,即WEB服务向插件发送回调指令(当然得插件先访问WEB服务),表达自己想要的数据(如获取群列表),插件再收到回调指令后会立即将相关数据封装(如群列表)后发送到WEB服务。
在具体开发中,常用的协议为HTTP,即在插件中填入http://...的地址,将程序部署到WEB服务器上;另外,为了更便于双向通信,同时提供了webSocket支持,只需在相关位置填入类似ws://...地址即可。

主动推送

主动推送是通过HTTP协议对机器人插件进行相关操作的一种方式。其原理为:插件作为HTTP服务器,开发者的应用(使用SDK)作为客户端,开发者可直接主动地操作插件(如主动发送消息、主动获取群列表等)。
此方式的相关操作均为主动操作,一般结合提交返回进行使用,并一般要求插件所在服务器/电脑有固定的公网IP(该条件限制太大,如果没有公网IP,下述消息转发是一种可用的替代方式)。

消息转发

消息转发解决了无公网IP以及不能主动操作的问题,原则上开发者不需要服务器也能获得提交返回、主动推送的功能,并且更加便捷。其原理为:除插件和开发者外,存在若干的转发服务器(转发服务器集群),这些服务器对开发者的操作以及插件产生的消息进行转发,以达到开发者与插件通信的目的。
目前本方式只开放HTTP方式,即只能完成上述主动推送的任务(但是不要求有公网IP)。开发者只需要直到机器人的QQ、授权码即可对机器人进行主动操作,任意一方均不要求有公网IP。

快速开始


以下将使用提供的PHP/Java/Python/NodeJS编程语言SDK开发Demo,以便开发者快速入门。
以下操作建立在配置好插件基础上,相关步骤参考请到跳转到页面底部了解。Demo中使用的SDK均可在本项目GITHUB上下载到,Demo适配的最低版本为2.2.2。 所示Demo包含本插件三大功能(提交返回[包含webSocket]、HTTP主动推送、消息转发推送),相关demo可在本项目demo中下载。

PHP Demo

提交返回

<?php
//插件的提交返回地址中配为本文件的访问地址
error_reporting(0);
header("Content-Type:text/html;Charset=utf8");//设置编码,必需
include 'HTTPSDK.php';
$sdk = HTTPSDK::httpGet();
$msg = $sdk->getMsg();//插件发送过来的消息
$sdk->sendPrivateMsg($msg['QQ'], '你发送了这样的消息:' . $msg['Msg']);//逻辑代码,向发送者回消息
echo $sdk->toJsonString();//命令返回

webSocket(结合使用workman)

<?php
//websocket(结合使用workman),插件的提交返回地址中配为相关地址(websocket://0.0.0.0:2346),命令行中启动本文件(php demo-ws.php restart)
//workman下载地址:https://www.workerman.net/download/workermanzip
header("Content-type:text/html;charset=utf-8");
require_once __DIR__ . '/workman/Autoloader.php';
use Workerman\Worker;

require_once 'HTTPSDK.php';
// Create a Websocket server
$ws_worker = new Worker("websocket://0.0.0.0:2346");
// 4 processes
$ws_worker->count = 4;
// Emitted when new connection come
$ws_worker->onConnect = function ($connection) {
    echo "New connection\n";
};
// Emitted when data received
$ws_worker->onMessage = function ($connection, $data) {
    $json = json_decode(urldecode(urldecode($data)), true);
    if (isset($json['type']) && $json['type'] == 'init') {
        $connection->send('{"type":"success"}');
    } else {
        //消息操作
        $sdk = HTTPSDK::webSocket($data);
        $msg = $sdk->getMsg();
        if ($msg['Msg'] == 'demo') {
            $sdk->sendPrivateMsg($msg['QQ'], '你发送了这样的消息:' . $msg['Msg']);//逻辑代码,向发送者回消息
        }
        //echo $sdk->toJsonString();
        $connection->send($sdk->toJsonString());
    }

};
// Emitted when connection closed
$ws_worker->onClose = function ($connection) {
    echo "Connection closed\n";
};
// Run worker
Worker::runAll();

HTTP推送

<?php
header("Content-Type:text/html;Charset=utf8");//设置编码,必需
include 'HTTPSDK.php';
//插件中开启推送,并设置端口为8080
$push = HTTPSDK::httpPush('http://127.0.0.1:8080');
var_dump($push->getLoginQQ());//获取登录的QQ
var_dump($push->sendPrivateMsg('QQ', 'hello~'));//向QQ发送消息
var_dump($push->getFriendList());//获取好友列表

消息转发

<?php
header("Content-Type:text/html;Charset=utf8");//设置编码,必需
include 'HTTPSDK.php';
//保证插件再2.2.2及以上并启动
$forward = HTTPSDK::msgForwardPush('QQ', 'code');//输入QQ和授权码(http://work.ksust.com)
var_dump($forward->getLoginQQ());//获取登录的QQ
var_dump($forward->sendPrivateMsg('QQ', 'hello~'));//向QQ发送消息
var_dump($forward->getFriendList());//获取好友列表

Java Demo

Java Demo项目地址:https://github.com/ksust/HTTP-API-Java-Demo

SDK引入方式

  1. Maven引入
    Java SDK已经提交Maven中央仓库,直接在pom文件中配置。在pom中加入如下代码即可:
<dependencies>
    <dependency>
        <groupId>com.ksust.qq</groupId>
        <artifactId>http-api-sdk</artifactId>
        <version>2.3.0.RELEASE</version>
    </dependency>
</dependencies>
  1. jar包引入(需要手动解决依赖)
    可直接使用jar包(包名如:http-api-sdk-2.2.2.jar),在项目中下载即可,需要手动解决依赖。所需要的依赖及版本如下:(另外可以直接使用3提供的独立jar包,不用解决依赖问题)
    <properties>
        <okttp.version>3.8.1</okttp.version>
        <validator.version>4.2.0.Final</validator.version>
        <lombok.version>1.16.10</lombok.version>
        <fastjson.version>1.2.31</fastjson.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>${validator.version}</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>${fastjson.version}</version>
        </dependency>
        <dependency>
            <groupId>com.squareup.okhttp3</groupId>
            <artifactId>okhttp</artifactId>
            <version>${okttp.version}</version>
        </dependency>

    </dependencies>
  1. jar包引入(包含所需依赖,独立jar包)
    包含后缀-with-dependencies的jar包中已经包含依赖,如http-api-sdk-2.2.2-jar-with-dependencies.jar

提交返回

//本样例基于SpringBoot,可运行的Demo在项目中可直接下载。主要代码如下:
@RestController
public class HTTPSDKDemo {
    @GetMapping("/test")
    public String test() {
        return "success";
    }


    private void test(MessageGet msg) {
        System.out.println(JSON.toJSONString(msg));
    }

    //提交返回演示:外部地址(插件中填的请求地址):http://yourIP:9999/ip
    @PostMapping(value = "/qq")
    public String qq(@RequestBody String data) throws Exception {
        //外部消息通过这个方法进入,请求地址即为 POST host:port/qq
        //开始演示:发送消息回复(点赞等),并且演示通过提交返回获取群列表
        HTTPSDK httpsdk = HTTPSDK.httpGet(data);
        //插件发来的消息
        MessageGet msg = httpsdk.getMsg();
        test(msg);
        if (httpsdk.getMsg().getType() == TypeEnum.FRIEND.getCode() && !httpsdk.isCallback()) {
            //私聊消息
            //点赞、抖窗、回复
            httpsdk.sendLike(msg.getQQ(), 2);
            httpsdk.sendShake(msg.getQQ());
            httpsdk.sendPrivateMsg(msg.getQQ(), "Hello,这里是HTTP-API演示程序,你发送的消息为:" + msg.getMsg()
                    + "。我还给你点了两个赞哦~");
            //发起获取群列表的请求(提交请求下不能立即得到),待下一次请求时携带消息
            httpsdk.getGroupList();
        }

        //接收 WEB回调消息。
        if (httpsdk.isCallback()) {
            //打印群列表
            if (msg.getType() == TypeEnum.GET_GROUP_LIST.getCode()) {
                for (Group group : httpsdk.getGroupList()) {
                    System.out.println(group.getGroupName() + "," + group.getGroupId());
                }
            }
        }
        //必须!!!向插件回复消息并清空当前对象待发送消息
        return httpsdk.toJsonString();
    }
}

webSocket

//与PHP版本类似,传入获取的字符串即可。取决于用什么框架,和上述提交返回使用方法基本相同,这里不再赘述。

HTTP推送

//推送测试代码如下,插件中开启推送,并设置端口为8080
public class HTTPSDKPushDemo {
    public static void main(String[] args) {
        //首先擦创建对象,支持加密。详情请查看文档
        HTTPSDK httpsdkPush = HTTPSDK.httpPush("http://127.0.0.1:8080", null, null);
        //引号中为测试QQ号
        String qq = "1402549575";
        //发送消息
        httpsdkPush.sendPrivateMsg(qq, "Hello World[ksust,at_all:qq=all][ksust,music:name=明天]");
        httpsdkPush.sendGroupMsg("244510218", "hello[ksust,at_all:qq=all][ksust,music:name=明天]");
        //点赞
        httpsdkPush.sendLike(qq, 1);
        //查看点赞数量
        System.out.println(httpsdkPush.getLikeCount(qq));
        //查看机器人当前状态
        System.out.println(JSON.toJSONString(httpsdkPush.getQQRobotInfo()));
    }
}

消息转发

//保证插件再2.2.2及以上并启动
public class MsgForwardDemo {
    public static void main(String[] args) throws IOException {
        HTTPSDK forwardPush = HTTPSDK.msgForwardPush("QQ", "code");//输入QQ和授权码
        System.out.println(forwardPush.getLoginQQ());
        System.out.println(forwardPush.sendPrivateMsg("QQ", "hello"));
        List<GroupMember> groupMemberList = forwardPush.getGroupMemberList("群号");
        for (GroupMember groupMember : groupMemberList) {
            System.out.println(groupMember.getName() + "," + groupMember.getQq());
        }
    }
}

Python Demo

安装(Python2/3):pip install http-api-sdk

提交返回

# 独立demo:https://github.com/ksust/http_api_django_demo

webSocket

#原理同提交返回,取决于使用什么外部框架。

HTTP推送

#!/usr/bin/env python
# -*-coding:utf-8-*-
"""
Demo Push
HTTP-API Python SDK(Python2、python3)
 * Created by PyCharm.
 * User: yugao
 * version 2.2.2
 * Note: HTTPSDK for Python(适用于版本2.2.2插件):用于解析插件消息、构造返回数据,以及HTTP推送(发起HTTP请求)
 * Contact: 开发者邮箱 admin@ksust.com
 * 安装:pip install http-api-sdk
"""

from httpapi.HTTPSDK import *

if sys.version_info.major == 2:
    reload(sys)  # python2请配置相应编码
    sys.setdefaultencoding('utf8')
    sys.setdefaultencoding('gb18030')

push = HTTPSDK.httpPush("http://127.0.0.1:8080")
print(push.getGroupList())
print(push.sendPrivdteMsg('QQ', '你好'))

forward = HTTPSDK.msgForwardPush('QQ', '授权码')
print(forward.getGroupList())
print(forward.getLoginQQ())
print(forward.sendPrivdteMsg('QQ', '你好'))
print(forward.getQQRobotInfo())

消息转发

#上述推送中包含消息转发(forward)

NodeJS Demo

安装依赖:npm install http-api-sdk
引用包:如 const HTTPSDK = require('http-api-sdk');

提交返回

/**
 * Demo
 * User: yugao
 * Date: 2019/2/27
 * version 2.2.2
 * Note: HTTPSDK for NodeJS(适用于版本2.2.2插件):用于解析插件消息、构造返回数据,以及HTTP推送(发起HTTP请求)
 * Contact: 开发者邮箱 admin@ksust.com
 * 安装SDK:npm install http-api-sdk
 */
const http = require('http');
const HTTPSDK = require('http-api-sdk');
const server = http.createServer((req, res) => {
    req.on('data', function (data) {
        let sdk = HTTPSDK.httpGet(data.toString());
        //console.log(sdk.getMsg());//获取到的消息
        sdk.sendPrivateMsg(sdk.getMsg()['QQ'], '你发送了这样的消息:' + sdk.getMsg()['Msg']);
        sdk.getLoginQQ();
        //回调演示,提交返回获取群列表、登录QQ等
        if (sdk.isCallback() && parseInt(sdk.getMsg()['Type']) === HTTPSDK.TYPE_GET_LOGIN_QQ) {
            console.log('Login QQ:' + sdk.getLoginQQ());
        }
        res.end(sdk.toJsonString());
    });
});
server.on('clientError', (err, socket) => {
    socket.end('HTTP/1.1 400 Bad Request\r\n\r\n');
});
server.listen(8000);

webSocket()

//与PHP版本类似,传入获取的字符串即可。取决于用什么框架,和上述提交返回使用方法基本相同,这里不再赘述。

HTTP推送

/**
 * Demo
 * User: yugao
 * Date: 2019/2/27
 * version 2.2.2
 * Note: HTTPSDK for NodeJS(适用于版本2.2.2插件):用于解析插件消息、构造返回数据,以及HTTP推送(发起HTTP请求)
 * Contact: 开发者邮箱 admin@ksust.com
 * 安装SDK:npm install http-api-sdk
 */
const HTTPSDK = require('http-api-sdk');
//推送演示,需要配置推送
push = HTTPSDK.httpPush('http://127.0.0.1:8080')
push.getGroupList().data(function (data) {
    console.log('push ' + data)
});
push.getLoginQQ().data(function (data) {
    console.log('push ' + data)
});
push.sendPrivateMsg('QQ', 'Hello').data(function (data) {
    console.log('push ' + data)
});
//消息转发演示,插件在线即可用
let forward = HTTPSDK.msgForwardPush('QQ', '授权码');
forward.getLoginQQ().data(function (data) {
    console.log('forward ' + data);
});
forward.getGroupList().data(function (data) {
    console.log('forward ' + data);
});
forward.sendPrivateMsg('QQ', 'Hello').data(function (data) {
    console.log('forward' + data)
});

消息转发

//上述推送中包含消息转发(forward)

SDK参考手册


方法说明返回值支持平台参数1(从左到右)参数2参数3参数4参数5
httpGet(String msg)提交返回模型,PHP SDK无需传入参数HTTPSDK对象IR/CQ/QQLight获取到的原始消息(RequestBody)----
webSocket(String msg)提交返回(webSocket)模型,传入获取到的原始消息HTTPSDK对象IR/CQ/QQLight获取到的原始消息(RequestBody)----
httpPush(String URL, String key, String secret)HTTP推送模型HTTPSDK对象IR/CQ/QQLight推送地址及端口,如http://127.0.0.1:8888验证key 为空或null则表示不加密验证secret 为空或null则表示不加密--
msgForwardPush(String qq, String code)消息转发推送模型HTTPSDK对象IR/CQ/QQLight机器人QQ该机器人QQ的授权码,统一管理平台:http://work.ksust.com---
getMsg()获取接收到的消息(结构化)JSON/MessageGet对象IR/CQ/QQLight-----
isCallback()当前消息体是否为插件反馈(用于提交返回模型下获取群列表等)booleanIR/CQ/QQLight-----
setCallbackSend(boolean callbackSend)是否在插件反馈情况下返回消息(提交返回),默认-IR/CQ/QQLighttrue/false----
toJsonString()构造返回的JSON String格式并清除当前MessageBackList。同时重置已发送消息(清空),仅针对于提交返回StringIR/CQ/QQLight-----
sendPrivateMsg(String qq, String msg, int structureType, int subType)发送私聊消息,默认非卡片形式intIR/CQ/QQLight目标QQ,好友消息内容消息结构类型 0普通消息,1 XML消息,2 JSON消息默认0XML、JSON消息发送方式下:0为普通(默认),1为匿名(需要群开启),默认0-
sendGroupMsg(String groupId, String msg, int structureType, int subType)发送群聊消息,默认非卡片形式intIR/CQ/QQLight群号消息内容消息结构类型 0普通消息,1 XML消息,2 JSON消息默认0XML、JSON消息发送方式下:0为普通(默认),1为匿名(需要群开启),默认0-
sendDiscussMsg(String discuss, String msg, int structureType, int subType)发送讨论组消息,默认非卡片形式intIR/CQ/QQLight讨论组id消息内容消息结构类型 0普通消息,1 XML消息,2 JSON消息默认0XML、JSON消息发送方式下:0为普通(默认),1为匿名(需要群开启),默认0-
sendLike(String qq, int count)点赞intIR/CQ/QQLight对象QQ点赞数量,一人最多一天10---
sendShake(String qq)抖动窗口intIR/CQ/QQLight对象QQ----
setGroupBan(String groupId, String qq, int time)群禁言(管理)intIR/CQ/QQLight群号禁言QQ,为null则禁言全群禁言时间,单位秒,至少10秒。0为解除禁言--
setGroupQuit(String groupId)主动退群intIR/CQ/QQLight群号----
setGroupKick(String groupId, String qq, boolean neverIn)踢人(管理)intIR/CQ/QQLight群号对象QQ是否不允许再加群--
setGroupCard(String groupId, String qq, String card)设置群名片intIR/CQ/QQLight群号对象QQ群名片--
setGroupAdmin(String groupId, String qq, boolean become)设置管理员(群主)intIR/CQ/QQLight群号对象QQTrue为设置,false为取消--
handleGroupIn(String groupId, String qq, boolean agree, int type, String msg)处理加群事件,是否同意intIR/CQ/QQLight群号对象QQ是否同意加群213请求入群 214我被邀请加入某群 215某人被邀请加入群 。为0则不管哪种消息,当拒绝时发送的消息
handleFriendAdd(String qq, boolean agree, String msg)是否同意被加好友intIR/CQ/QQLight对象QQ是否同意当拒绝时发送的消息--
addGroupNotice(String groupId, String title, String content)发群公告(管理)intIR群号公告标题内容--
addGroupHomework(String groupId, String homewordName, String title, String content)发群作业(管理)。注意作业名和标题中不能含有#号intIR群号作业名标题内容-
joinGroup(String groupId, String reason)主动申请加入群intIR群号加群理由---
disGroupCreate(String disName, List<String> qqList)创建讨论组StringIR讨论组名。并作为创建后第一条消息发送(激活消息)需要添加到讨论组的QQ号列表---
disGroupQuit(String disGroupId)退出讨论组intIR/CQ/QQLight讨论组ID----
disGroupKick(String disGroupId, List<String> qqList)踢出讨论组intIR讨论组ID踢提出的QQ号列表---
disGroupInvite(String disGrouId, List<String> qqList)添加讨论组成员intIR讨论组号欲添加的QQ号列表---
groupInvite(String groupId, String qq)邀请QQ入群(管理+群员)intIR群号QQ---
getStrangerInfo(String qq)获取陌生人信息 isCallback情况下返回有数据的,否则返回空对象Stranger/-IR/CQ/QQLightQQ----
getLoginQQ()获取当前登陆的QQ isCallback情况下返回有数据的,否则返回空对象int/-IR/CQ/QQLight-----
getGroupList()获取当前QQ群列表,JSON字符串 isCallback情况下返回有数据的,否则返回空对象JSON字符串/-IR/CQ/QQLight-----
getFriendList()获取好友列表 isCallback情况下返回有数据的,否则返回空对象好友列表/-IR/QQLight-----
getGroupMemberList(String groupId)获取群成员列表 isCallback情况下返回有数据的,否则返回空对象群成员列表/-IR/CQ/QQLight群号----
getGroupNotice(String groupId)获取群公告 isCallback情况下返回有数据的,否则返回空对象Notice/-IR群号----
getLikeCount(String qq)获取对象QQ赞数量 isCallback情况下返回有数据的,否则返回空对象int/-IR/QQLight对象QQ----
getDisGroupList()获取讨论组列表(IRQQ框架获取为空) isCallback情况下返回有数据的,否则返回空对象DisGroup/-IR-----
getQQLevel(String qq)获取QQ等级intIRQQ----
getGroupMemberCard(String groupId, String qq)获取群成员名片群名片IR群号QQ---
getQQIsOline(String qq)查询QQ是否在线是否在线IRQQ----
getQQIsFriend(String qq)查询QQ是否好友是否好友IRQQ----
getQQRobotInfo()获取当前QQ机器人状态信息(如是否在线)结构信息IR/CQ/QQLight-----
setInputStatus(String qq)置正在输入 状态,发送消息撤销intIRQQ----
123456789

事件ID及标签


事件ID

其中值>20000的为操作代码,其余的为事件ID。

事件名说明支持平台备注
TYPE_FRIEND_TEMP0在线状态临时会话(Pro版可用)IR-
TYPE_FRIEND1好友消息,发送私聊消息IR/CQ/QQLight-
TYPE_GROUP2群消息,发送群消息IR/CQ/QQLight-
TYPE_DISCUSS3讨论组消息,发送讨论组消息IR/CQ/QQLight-
TYPE_GROUP_TEMP4群临时会话IR-
TYPE_DISCUSS_TEMP5讨论组临时会话IR-
TYPE_ACCOUNT6收到财付通转账IR/QQLight-
TYPE_FRIEND_VERIFY_BACK7好友验证回复会话消息(Pro版可用)IR-
TYPE_HANDLE_AGREE10请求处理_同意IR/CQ/QQLight-
TYPE_HANDLE_REJECT20请求处理_拒绝IR/CQ/QQLight-
TYPE_HANDLE_IGNORE30请求处理_忽略IR-
TYPE_FRIEND_ADDED_SINGLE100被单项添加为好友IR-
TYPE_FRIEND_ADDED101某人请求加为好友IR/CQ/QQLight-
TYPE_FRIEND_ADDED_AGREED102被同意加为好友IR/CQ/QQLight-
TYPE_FRIEND_ADDED_REJECTED103被拒绝加为好友IR-
TYPE_FRIEND_DELETED104被删除好友IR-
TYPE_FRIEND_FILE_OFFLINE105收到好友离线文件(Pro版可用)IR-
TYPE_FRIEND_SIGNATURE_CHANGE106好友签名变更IR-
TYPE_FRIEND_SAY_COMMENT107说说被某人评论IR-
TYPE_GROUP_FILE_RECV218收到群文件IR/CQ-
TYPE_GROUP_IN_WHO_REQUEST213某人请求入群IR/CQ/QQLight-
TYPE_GROUP_IN_ME_INVITED214被邀请加入群IR/CQ/QQLight-
TYPE_GROUP_IN_ME_AGREED220被批准入群IR-
TYPE_GROUP_IN_ME_REJECTED221被拒绝入群IR-
TYPE_GROUP_IN_WHO_INVITED215某人被邀请加入群IR-
TYPE_GROUP_IN_WHO_INVITED_HAS219某人已被邀请加入群(群主或管理员邀请成员加群或开启了群成员100以内无需审核或无需审核直接进群,被邀请人同意进群后才会触发)IR/CQ/QQLight-
TYPE_GROUP_IN_WHO_AGREED212某人被批准加入了群IR/CQ/QQLight-
TYPE_GROUP_QUIT_WHO201某人退出群IR/CQ/QQLight-
TYPE_GROUP_QUITED_WHO202某人被管理移除群IR/CQ/QQLight-
TYPE_GROUP_INVALID216某群被解散IR-
TYPE_GROUP_ADMIN_WHO_BECOME210某人成为管理IR/CQ/QQLight-
TYPE_GROUP_ADMIN_WHO_INVALID211某人被取消管理IR/CQ/QQLight-
TYPE_GROUP_BANED203对象被禁言IR-
TYPE_GROUP_BANED_INVALID204对象被解除禁言IR-
TYPE_GROUP_BANED_ALL205开启全群禁言IR-
TYPE_GROUP_BANED_ALL_INVALID206关闭全群禁言IR-
TYPE_GROUP_ANONYMOUS_OPEN207开启匿名聊天IR-
TYPE_GROUP_ANONYMOUS_CLOSE208关闭匿名聊天IR-
TYPE_GROUP_NOTICE_CHANGE209群公告变动IR-
TYPE_GROUP_CARD_CHANGE217群名片变动IR-
TYPE_SEND_LIKE20001点赞IR/CQ/QQLight操作类型
TYPE_SEND_SHAKE20002窗口抖动I/CQ-
TYPE_GROUP_BAN20011群禁言(管理)IR/CQ/QQLight-
TYPE_GROUP_QUIT20012主动退群IR/CQ/QQLight-
TYPE_GROUP_KICK20013踢群成员(管理)IR/CQ/QQLight-
TYPE_GROUP_SET_CARD20021设置群名片(管理)IR/CQ/QQLight-
TYPE_GROUP_SET_ADMIN20022设置群管理(群主)IR/CQ/QQLight-
TYPE_GROUP_HANDLE_GROUP_IN20023入群处理(某人请求入群、我被邀请入群、某人被邀请入群)IR/CQ/QQLight-
TYPE_FRIEND_HANDLE_FRIEND_ADD20024加好友处理(是否同意被加好友)IR/CQ/QQLight-
TYPE_GROUP_ADD_NOTICE20031发群公告IR-
TYPE_GROUP_ADD_HOMEWORK20032发群作业IR-
TYPE_GROUP_JOIN20033主动申请加入群IR-
TYPE_DIS_CREATE20041创建讨论组,返回讨论组ID(并且对外部接口支持直接根据好友列表创建讨论组)IR-
TYPE_DIS_INVITE20042邀请加入某讨论组,多个用#隔开IR-
TYPE_DIS_KICK20043踢出讨论组成员IR-
TYPE_DIS_QUIT20044退出讨论组IR-
TYPE_GROUP_INVITE20051邀请QQ入群(管理+普通成员)IR-
TYPE_GET_LOGIN_QQ20101获取当前QQIR/CQ/QQLight-
TYPE_GET_STRANGER_INFO20102获取陌生人信息,JSON,昵称,性别,年龄,签名IR/CQ/QQLight-
TYPE_GET_GROUP_LIST20103获取当前QQ群列表,JSONIR/CQ/QQLight-
TYPE_GET_GROUP_MEMBER_LIST20104获取指定群成员列表,JSONIR/CQ/QQLight-
TYPE_GET_FRIEND_LIST20105获取好友列表,JSONIR/QQLight-
TYPE_GET_GROUP_NOTICE20106获取群公告列表,JSONIR-
TYPE_GET_DIS_LIST20107获取讨论组列表IR-
TYPE_GET_QQ_LEVEL20111获取QQ等级IR-
TYPE_GET_GROUP_MEMBER_CARD20112获取群成员名片IR-
TYPE_GET_QQ_ONLINE_STATUS20113查询QQ是否在线IR-
TYPE_GET_QQ_IS_FRIEND20114查询QQ是否好友IR-
TYPE_GET_QQ_ROBOT_INFO20115获取机器人状态信息,JSONIR/CQ/QQLight-
TYPE_LIKE_COUNT_GET20201获取目标对象赞数目IR-
TYPE_SET_INPUT_STATUS20301置正在输入状态(发送消息取消)IR-
TYPE_TIMER_SEND30001定时任务提交类型IR/CQ/QQLight-
SUBTYPE_CALLBACK_SEND10001提交返回有反馈时,更改原数据中的subtype和msg(数据),向返回地址发送反馈
--------

消息标签

消息标签用于特殊消息发送,例如卡片、@全体成员、音乐标签等,目前支持的标签如下:

标签说明举例支持平台备注
[ksust,music:name=歌曲名]多选音乐卡片,传入歌名[ksust,music:name=明天]IR-
[ksust,link:url=链接网址,title=标题文字,content=内容文字,pic=图片链接]简单图文(卡片)-IR/CQ(Pro)-
[ksust,link2:url=链接网址,title=标题文字,content=内容文字,pic=图片链接,bcontent=内容2文字,bpic=大图链接]简单图文,加大图和长文本-IR-
[ksust,at:qq=qq]统一标签,艾特某人。qq=all 或 qq=QQ号码。可跨平台兼容[ksust,at:qq=all]IR/CQ/QQLight/QY-
[ksust,image:pic=图片地址]CQ、IRQQ统一网络图片标签,pic为网络图片地址,可跨平台兼容-IR/CQ(Pro)/QQLight/QY-
[ksust,at_all:qq=all]逐个@全体成员,避免@全体成员限制固定用法 [ksust,at_all:qq=all]IR/CQ/QQLight/QY-
[ksust,voice:url=mp3或amr语音文件网络地址]发送语音消息[ksust,voice:url=http://hao.haolingsheng.com/ring/000/993/d915a1c149bb3076a32dfdab923f8c21.mp3]QY-
[ksust,qqlight_group_file_forward:src=,dst_group=,guid=]转发好友/群文件[ksust,qqlight_group_file_forward:src=好友QQ或群号,dst_group=目标群,guid=文件GUID]QQLight-
[ksust,qy_group_file:group=,group_path=,file_url=,name=]上传群文件[ksust,qy_group_file:group=目标群号,group_path=群文件路径(根目录为/),file_url=文件绝对链接(http://),name=文件名称(如a.zip)]QY-

数据结构

简单列出必要的几种数据结构(使用JSON格式描述),其余请开发者在开发中查看SDK或者打印。

提交返回-插件提交-数据结构(接口getMsg()返回值)

{
	Myqq:机器人QQ,
	Type:"消息类型,举例:【详看消息类型】 -1 未定义事件 1 好友信息 2,群信息 3,讨论组信息 4,群临时会话 5,讨论组临时会话 6,财付通转账,
	SubType:接收财付通转账时 1为好友 2为群临时会话 3为讨论组临时会话    有人请求入群时,不良成员这里为1,
	From:此消息的来源,如:群号、讨论组ID、临时会话QQ、好友QQ,
	Group:来源群号,若无则为空,
	Discuss:来源讨论组,若无则为空,
	QQ:主动发送这条消息的QQ,踢人时为踢人管理员QQ,
	ObjectQQ:被动触发的QQ,如某人被踢出群,则此参数为被踢出人QQ,
	Msg:消息文本内容(当消息为JSON、XML时为相应内容)。消息反馈时为消息反馈文本(如取群列表),
	ID:消息id,用于识别消息【如异步处理时】、撤回等,构成:消息序号-消息ID,
	Data:{
		//携带数据,如当消息为转账消息时,则有相关属性。以下举例转账消息
		"Comments": "接收到转账时留言",
		"Money": "接收到转账时金额(数字)",
		"Number": "接收到转账时订单号"
		}
}

提交返回-返回处理-数据结构(WEB返回)

{
					
	data:[
		{
            ID:唯一标识,UUID,
			Type:发送消息类型【具体查看SDK】, 1 好友信息 2,群信息 3,讨论组信息 4,群临时会话 5,讨论组临时会话 ...,20001 点赞,20002 窗口抖动,20011 群禁言(管理),20012 退群,20013 踢群成员(管理),20021 设置群名片(管理),20022 设置群管理(群主),20023 入群处理(某人请求入群、我被邀请入群、某人被邀请入群),20024 加好友处理(是否同意被加好友),20031 发公告,20032 发作业 等
			SubType:子类型,0普通,1匿名(需要群开启,默认0),
			StructureType:消息结构类型,0为普通文本消息(默认)、1为XML消息、2为JSON消息,
			Group:操作或发送的群号或者讨论组号,
			QQ:操作或者发送的QQ,
			Msg:文本消息【标签等】,当发送类型为JSON、XML时为相应文本,禁言时为分钟数【分钟】,
			Send:是否开启同步发送(1为开启同步发送【测试】,0为不开启【默认】),
			Data:附加数据,用于特定操作等(文本型)
		} ,
		{
			...		
		}
	    ]
}

推送(转发)-发送-数据结构

{
	time:验证的时间戳,
	verify:验证字符串,
	data:[ //暂时仅允许一个成员
		{
            ID:唯一标识,UUID,
			Type:发送消息类型, 1 好友信息 2,群信息 3,讨论组信息 4,群临时会话 5,讨论组临时会话 ...,20001 点赞,20002 窗口抖动,20011 群禁言(管理),20012 退群,20013 踢群成员(管理),20021 设置群名片(管理),20022 设置群管理(群主),20023 入群处理(某人请求入群、我被邀请入群、某人被邀请入群),20024 加好友处理(是否同意被加好友),20031 发公告,20032 发作业 
			SubType:子类型,0普通,1匿名(需要群开启,默认0),
			StructureType:消息结构类型,0为普通文本消息(默认)、1为XML消息、2为JSON消息,
			Group:操作或发送的群号或者讨论组号,
			QQ:操作或者发送的QQ,
			Msg:文本消息【标签等】,当发送类型为JSON、XML时为相应文本,禁言时为分钟数【分钟】,
			Send:是否开启同步发送(1为开启同步发送【测试】,0为不开启【默认】),
			Data:附加数据,用于特定操作等(文本型)
		}
	]
}

插件界面及使用引导


用户使用流程引导

对于使用本插件的用户来说,除了第一次配置插件外,几乎所有操作均在管理平台上进行(包括安装应用、查看机器人状态等)。
对于新用户,步骤如下:

1.注册平台账户(用于线上管理、安装)

2.安装并启用插件(QQLight、酷Q、契约)

3.重启机器人框架

4.打开插件设置进行配置

5.主人QQ绑定

6.安装应用及应用审核

以上流程为新用户完整流程,尽量描述详细,具体执行过程1-2分钟即可完成;对于老用户,则直接绑定平台账号即可。

开发者相关配置

对于开发者,主要包含开发、发布两个流程。下面主要介绍开发过程中的相关配置,更多请加入开发群了解,开发群也有免费视频培训。

开启开发者模式

提交返回配置

主动推送配置

定时任务配置

发布应用到平台


如果你觉得本项目还不错,可以捐助本项目,你的捐赠将会使作者更具开发/更新的信心,同时也能推进本项目的发展(在捐助的时候可以备注您的QQ或微信):
捐助方式
交流群:(QQ群,用户加入)537419179
开发群:(QQ群,开发者加入)598629636
管理平台:http://work.ksust.com