写在前面
这个文档不是由官方来维护的,本人采用Markdown格式和更为易读的顺序重构

插件地址:契约HTTPAPI插件

一、API调用

如果没有特殊说明,本章节中的一切参数均以POST方法传递,传递格式需要标准的Json

本框架调用方式个人感觉类似于JSON-RPC

1.框架类参数

  • 示例请求:{"api":"debug","content":"hello,world!"}

    • api参数是必须的:指定调用的方法,在这类参数中可以分为以下4种:

      • debug:在契约机器人的日志中写入debug日志,需要额外附带content参数
      • getQQType:获取QQ框架或协议的类型
      • getConfigPath:获取框架配置路径
      • getRunPath:获取框架运行路径
    • content参数仅仅在有debug参数的时候才需要

2.获取类参数

  • 示例请求:{"api":"getGroupMemberInfo","qq":"753445573","fromID":"260236663","fromQQ":"753445573","content":"1"}

    • api参数是必须的:指定调用的方法,在这类参数中可以分为以下8种:

      • getCookie:获取cookie,返回一段字符
      • getDomainCookie:获取指定域名Cookie,可选参数content指定域名,返回跳转成功后的Cookie,返回一段字符
      • getGroupList:获取群列表,返回一段Json
      • getGroupMemberInfo:获取群成员信息,可选参数content指定是否使用缓存,返回一段json
      • getGroupMemberInfoList:获取群成员信息列表 返回一段Json
      • getLoginNick:获取登录的QQ昵称,返回一段字符
      • getLoginQQ:获取已经登陆的QQ号(仅在支持多账号登陆的框架有实际作用)
      • getStrangerInfo:获取陌生人信息,返回一段Json
    • qq参数是可选的:指定与该消息相关的QQ号,仅仅在支持多账号登陆的框架有实际作用
      getLoginQQ方法无需此参数
    • fromID参数:使用和群聊相关的方法时必须
      譬如getGroupListgetGroupMemberInfogetGroupMemberInfoList等,您需要传递一段整数或者以字符形式表现的纯数字
    • fromQQ参数:使用和个人有关的方法时必须
      譬如getStrangerInfo等,您需要传递一段整数或者以字符形式表现的纯数字
    • content参数是可选的:当在需要额外传递信息时可以填写

      • getDomainCookie需要传递一段以字符形式表达的网址,可以是以下两种:

        • http://qun.qq.com(默认)
        • http://qun.qzone.qq.com
      • getGroupMemberInfo需要传递一个整数或者以字符形式表现的纯数字,可以是以下两种:

        • 1:不使用缓存
        • 2:使用缓存

3.接口类参数

  • 示例请求:{"api":"setGroupAddRequest","qq":"753445573","seq":"","eventType":"213","msgType":"1","content":""}

太晚了,睡了,明天再更