# 0x02 1.和操作有关的API
>[info] 若要获取接口的参数说明,由于API过多,建议使用 Ctrl+F 快速搜索
>[info]MPQ现已支持转发接口,而看云则为API接口类文档提供了一个可以在线调试的插件。
文档中的API现已全量支持基于[转发接口](https://f.mypcqq.cc/thread-5925.htm)的在线调试。使用方法请查看[这篇文档](https://www.kancloud.cn/mypcqq/dev-common/922252)。
请放心,看云的插件不会收集您的任何个人信息或接口信息,插件仅仅会在本地运行。点击[这里](https://help.kancloud.cn/67539)查看官方文档中的相关信息。
[TOC]
# 三位参数的API
<br />
### API在线调试
>(下方说明文本以Api_GetNameCard为例,其余接口自行替换信息即可)
~~~[api]
get:http://127.0.0.1:8010/
*string:
QQ=12345#框架中登录的QQ,如12345
API=Api_GetNameCard('12345','66996','23333')#取群管列表(包括群主),若群号为66996,被取名片成员的QQ号为23333,则填写Api_GetAdminList('12345','66996','23333')
<<<
success
{"Code":"0","Msg":"OK","Data":"..."}
<<<
error
参看转发接口说明(https://f.mypcqq.cc/thread-5925.htm)中的**状态码说明**部分
~~~
>Tips:将返回信息中的**Data**字段进行[base64解码](http://tool.chinaz.com/Tools/Base64.aspx)后即可获得真正的json信息。效果等同于在软件内调用相关Api(在软件内返回值即为base64解码后的信息)。
<br />
## Api_GetNameCard - 取群名片
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作群号 | 文本型 | 被取名片成员所在群号 |
参_操作对象 | 文本型 | 被取名片成员的QQ号 |
此参数可以取某个人在某个群内的名片。
## Api_GroupInvitation - 邀请对象加入群
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | 被邀请的人的QQ |
参_操作群号 | 文本型 | 邀请加入的QQ群 |
## Api_DGInvitation - 邀请对象加入讨论组
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_讨论组ID | 文本型 | 邀请的讨论组id |
参_成员组 | 文本型 | 多个成员用换行符分割 |
## Api_JoinGroup - 主动加群
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作群号 | 文本型 | 要加入的群号 |
参_附加理由 | 文本型 | 验证信息/要回答的问题的答案 |
>[info]Tips:若此操作出现验证码,则不处理
## Api_Kick - 将对象移除群
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作群号 | 文本型 | 被移除群成员所在群号 |
参_操作对象 | 文本型 | 即将被移除的群成员的QQ号 |
## Api_KickDG - 将对象移除讨论组
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_讨论组ID | 文本型 | 被移除讨论组成员所在讨论组ID |
参_操作对象 | 文本型 | 即将被移除的讨论组成员的QQ号 |
## Api_Cache_NameCard - 将群名片加入高速缓存
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_操作群号 | 文本型 | |
参_操作对象 | 文本型 | |
群_名片 | 文本型 | 缓存的名片 |
## Api_AddQQ - 向框架内添加一个QQ(存在时覆盖密码)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_机器人密码 | 文本型 | |
参_自动登录 | 逻辑型 | 是否自动登陆 |
# 两位参数的API
<br />
### API在线调试
>(下方说明文本以Api_GetAdminList为例,其余接口自行替换信息即可)
~~~[api]
get:http://127.0.0.1:8010/
*string:
QQ=12345#框架中登录的QQ,如12345
API=Api_GetAdminList('12345','66996')#取群管列表(包括群主),若群号为66996,则填写Api_GetAdminList('12345','66996')
<<<
success
{"Code":"0","Msg":"OK","Data":"..."}
<<<
error
参看转发接口说明(https://f.mypcqq.cc/thread-5925.htm)中的**状态码说明**部分
~~~
>Tips:将返回信息中的**Data**字段进行[base64解码](http://tool.chinaz.com/Tools/Base64.aspx)后即可获得真正的json信息。效果等同于在软件内调用相关Api(在软件内返回值即为base64解码后的信息)。
<br />
## Api_GetAdminList - 取群管列表(包括群主)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | 欲取群管列表的QQ群 |
## Api_GetGroupMemberA - 取群成员列表(qun.qq.com)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作群号 | 文本型 | 欲取群成员列表的QQ群 |
>Tips:本接口返回的为json信息
## Api_GetGroupMemberB - 取群成员列表(qun.qzone.qq.com)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作群号 | 文本型 | 欲取群成员列表的QQ群 |
>Tips:本接口返回的为json信息
## Api_Ban - 将指定QQ列入QQ黑名单
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | |
>加黑后,这个家伙将出现在这里(PCQQ):
![ZZCz.png](https://piccdn.freejishu.com/images/2017/05/16/ZZCz.png)
您和对方之间无法进行任何操作。如果需要移出黑名单,您可以使用 Api_DBan 。
>Example #1 加黑某个QQ
![ZXQ4.png](https://piccdn.freejishu.com/images/2017/05/16/ZXQ4.png)
## Api_DBan - 将指定QQ移出QQ黑名单
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | |
>Example #1 将某个QQ移出黑名单
![Z7XU.png](https://piccdn.freejishu.com/images/2017/05/16/Z7XU.png)
## Api_DelFriend - 删除好友
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | 欲删除的好友QQ |
## Api_QuitGroup - 退出群
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作群号 | 文本型 | 欲退出的群号 |
## Api_QuitDG - 退出讨论组
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作讨论组ID | 文本型 | 欲退出的讨论组id |
## Api_GetNotice - 取群公告
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作群号 | 文本型 | 欲取群公告的群号 |
## Api_GetAge - 取年龄
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | 欲取年龄的QQ号 |
## Api_GetQQAge - 取Q龄
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | 欲取Q龄的QQ号 |
## Api_GetEmail - 取邮箱
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | 欲取邮箱的QQ号 |
## Api_GetGender - 取对象性别
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | 欲取性别的QQ号 |
## Api_GetPersonalProfile - 取个人说明
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | 欲取个人说明的QQ号 |
## Api_GetSign - 取个性签名
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | 欲取个性签名的QQ号 |
## [判断] Api_IsFriend - 是否好友(双向)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
参_操作对象 | 文本型 | |
>Tips:单项好友和双向好友的区别
单项好友状态下,有很多功能收到限制,例如转账;
而这些限制在成为双向好友之后就可以解除。
只需要另一方向你发送好友请求,你同意即可。
<br /><br /><br />
# 一位参数的API
<br />
### API在线调试
>(下方说明文本以Api_GetFriendList为例,其余接口自行替换信息即可)
~~~[api]
get:http://127.0.0.1:8010/
*string:
QQ=12345#框架中登录的QQ,如12345
API=Api_GetFriendList('12345')#取好友列表,如Api_GetFriendList('12345')
<<<
success
{"Code":"0","Msg":"OK","Data":"..."}
<<<
error
参看转发接口说明(https://f.mypcqq.cc/thread-5925.htm)中的**状态码说明**部分
~~~
>Tips:将返回信息中的**Data**字段进行[base64解码](http://tool.chinaz.com/Tools/Base64.aspx)后即可获得真正的json信息。效果等同于在软件内调用相关Api(在软件内返回值即为base64解码后的信息)。
<br />
## Api_GetFriendList - 取好友列表(qun.qq.com)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
>Tips:本接口返回的为json信息
## Api_GetGroupListA - 取群列表(qun.qzone.qq.com)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
>Tips:本接口返回的为json信息
## Api_GetGroupListB - 取群列表(qun.qq.com)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
>Tips:本接口返回的为json信息
## Api_CreateDG - 创建一个讨论组(成功返回讨论组ID)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
## Api_OutPut - 在框架记录页输出一行信息
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_输出内容 | 文本型 | 输出的内容 |
>Tips:这个API可以输出给用户的提示信息,也可以用于下断点调试。
>Example #1 调用示例:
![UKp4.png](https://piccdn.freejishu.com/images/2017/04/21/UKp4.png)
效果:
![Ulez.png](https://piccdn.freejishu.com/images/2017/04/21/Ulez.png)
## Api_Login - 登录一个现存的QQ
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | 欲登录的QQ |
>Tips:在登陆之前,请先让这个QQ存在于框架之中。
若使用SE版,请及时关注您的授权问题。
## Api_Logout - 让指定QQ下线
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | 欲下线的QQ |
## Api_GetNick - 取昵称
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_操作对象 | 文本型 | |
## Api_GetQQLevel - 取等级信息(QQ以及VIP)
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_操作对象 | 文本型 | |
>Tips:本接口返回的为json信息
## Api_GetLdw - 计算长Ldw
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
## Api_GetGtk_Bkn - 计算Bkn或G_tk
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
>**Q:** Gtk(G\_tk)和Bkn是什么东西?
>**A:** 腾讯的页面(网页)操作令牌。目前这两个参数的值和算法都是一样的。
千万不要小看这两个参数的作用。如果没有这两个参数,涉及账户信息的页面操作几乎全部会失败。登陆后获得的Cookie里面也应该会回传这个参数。
>Example #1 调用示例:
![UZWK.png](https://piccdn.freejishu.com/images/2017/04/21/UZWK.png)
## Api_GetBkn32 - 计算长Bkn或长G_tk
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
## Api_GetClientkey - 取Clientkey
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
## Api_GetLongClientkey - 取长Clientkey
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
## Api_GetCookies - 取Cookies
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
## Api_GetSessionkey - 取QQ会话秘钥
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
## Api_GetDGList - 取讨论组号列表,最大100个
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
## Api_GidGetGN - 群ID转群号
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_操作群号| 文本型 | |
>Tips:腾讯内部并不是完全以群号作为判定一个群的关键键值,有的时候还会存在群ID这种操作。
如果你遇到了一小串和群有关但是却不是群号的数字,您也许可以试试是不是群ID。
## Api_GNGetGid - 群号转群ID
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_操作群号| 文本型 | |
## Api_GuidGetPicLink - 取GUID的下载链接
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_图片GUID | 文本型 | 例:{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}.jpg |
## [判断] Api_IfBlock - 群信息是否被屏蔽
参数名称 | 数据类型 | 描述 |
--- | --- | --- |
参_机器人QQ | 文本型 | |
>被屏蔽,就是机器人发出去的消息(包括各种类型)其他人接收不到。
我们目前认为屏蔽的主要原因是触发了腾讯的风控相关机制,细分有如下几种原因:(不全也并不一定,仅供参考)
1、发送非法信息被腾讯检测到
2、频繁的发送消息,速度快于常人
3、频繁的进行高危操作,例如发送缺少参数的数据包
...
# 无需参数的API
<br />
### API在线调试
>(下方说明文本以Api_GetLog为例,其余接口自行替换信息即可)
~~~[api]
get:http://127.0.0.1:8010/
*string:
QQ=12345#框架中登录的QQ,如12345
API=Api_GetLog()#取得日志所有信息,则填写Api_GetLog()
<<<
success
{"Code":"0","Msg":"OK","Data":"..."}
<<<
error
参看转发接口说明(https://f.mypcqq.cc/thread-5925.htm)中的**状态码说明**部分
~~~
>Tips:将返回信息中的**Data**字段进行[base64解码](http://tool.chinaz.com/Tools/Base64.aspx)后即可获得真正的json信息。效果等同于在软件内调用相关Api(在软件内返回值即为base64解码后的信息)。
<br />
## Api_GetLog - 取得日志所有信息
无需参数
## Api_GetMC - 取得机器码
无需参数
## Api_GetPrefix - 取得框架内设置的信息发送前缀
无需参数
## Api_GetRunPath - 取框架所在目录
无需参数
## Api_GetQQlist - 取所有QQ列表(包括未登录以及登录失败的QQ)
无需参数
>取得框架内在线的QQ列表。以换行符分割,每行一个。
例如:
28934444
7894561
1237895
>Example #1 循环输出所有在线的QQ
![ZNsK.png](https://piccdn.freejishu.com/images/2017/05/16/ZNsK.png)
## Api_GetOnlineQQlist - 取当前在线可用的QQ列表
无需参数
>注意
此API只获取已经登录了的QQ,不获取框架内未登录QQ。如需获取全部,请使用 Api_GetQQlist() 。
本API用法同Api_GetQQlist()。
## Api_GetRadomOnlineQQ - 取随机一个在线且可以使用的QQ
无需参数
## Api_GetTimeStamp - 取当前框架内部时间戳_周期性与服务器时间同步
无需参数
## Api_GetVersion - 取框架版本号(发布时间戳)
无需参数
## Api_GetVersionName - 取框架版本名
无需参数
>Tips:判断是否为SE版本可以利用此Api返回值:在返回值中寻找**SE**两个字符,存在即为SE版本。
## [判断] Api_IsEnable - 是否启用本插件
无需参数
>[info]编写:苏苏
>润色:a632079 & 斯米拉
>审核:Eghuai
>最后更新:2019.1.21