# 0x02 1.和操作有關的API
>[info] 若要獲取接口的參數說明,由于API過多,建議使用 Ctrl+F 快速搜索
>[info]MPQ現已支持轉發接口,而看云則為API接口類文檔提供了一個可以在線調試的插件。
文檔中的API現已全量支持基于[轉發接口](https://f.mypcqq.cc/thread-5925.htm)的在線調試。使用方法請查看[這篇文檔](http://www.hmoore.net/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):

您和對方之間無法進行任何操作。如果需要移出黑名單,您可以使用 Api_DBan 。
>Example #1 加黑某個QQ

## Api_DBan - 將指定QQ移出QQ黑名單
參數名稱 | 數據類型 | 描述 |
--- | --- | --- |
參_機器人QQ | 文本型 | |
參_操作對象 | 文本型 | |
>Example #1 將某個QQ移出黑名單

## 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 調用示例:

效果:

## 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 調用示例:

## 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

## 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