MypcqqAPI说明⽂档资料
Api说明⽂档
若未特别声明以下所有Api均封装于message.dll内
Api_GetGtk_Bkn 返回类型:⽂本型说明:根据提交的QQ号计算得到页⾯操作⽤参数Bkn或G_tk .参数响应的QQ, ⽂本型
Api_GetBkn32 返回类型:⽂本型说明:根据提交的QQ号计算得到页⾯操作⽤参数长Bkn或长G_tk .参数响应的QQ, ⽂本型
Api_GetLdw 返回类型:⽂本型说明:根据提交的QQ号计算得到页⾯操作⽤参数长Ldw
.参数响应的QQ, ⽂本型
Api_GetRunPath 返回类型:⽂本型说明:取得框架所在⽬录.可能鸡肋了。
Api_GetOnlineQQlist 返回类型:⽂本型说明:取得当前框架内在线可⽤的QQ 列表
Api_GetQQlist 返回类型:⽂本型说明:取得框架内所有QQ列表。包括未登录以及登录失败的QQ Api_GetSessionkey 返回类型:⽂本型说明:根据QQ取得对应的会话秘钥
.参数响应的QQ, ⽂本型
Api_GetClientkey 返回类型:⽂本型说明:取得页⾯登录⽤的Clientkey
.参数响应的QQ, ⽂本型
Api_GetLongClientkey 返回类型:⽂本型说明:取得页⾯登录⽤的长Clientkey
.参数响应的QQ, ⽂本型
Api_GetCookies 返回类型:⽂本型说明:取得页⾯操作⽤的Cookies
.参数响应的QQ, ⽂本型
Api_GetPrefix 返回类型:⽂本型说明:取得框架内设置的信息发送前缀
Api_Cache_NameCard 返回类型:⽆说明:将群名⽚加⼊⾼速缓存当作.
.参数群号, ⽂本型
.参数 QQ, ⽂本型
.参数名⽚, ⽂本型
Api_DBan 返回类型:⽆说明:将指定QQ移出QQ⿊名单
.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型
Api_Ban 返回类型:⽆说明:将指定QQ列⼊QQ⿊名单
.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型
Api_Shutup 返回类型:逻辑型说明:禁⾔群成员
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型, , 禁⾔对象所在群.
.参数 QQ, ⽂本型, , 禁⾔对象.留空为全群禁⾔
.参数时长, 整数型, , 单位:秒最⼤为1个⽉. 为零解除对象或全群禁⾔
Api_IsShutup 返回类型:逻辑型说明:根据群号+QQ判断指定群员是否被禁⾔获取失败的情况下亦会返回假.参数响应的QQ, ⽂本型
.参数群号, ⽂本型, , 欲判断对象所在群.
.参数 QQ, ⽂本型, , 欲判断对象
Api_SetNotice 返回类型:⽆说明:发群公告
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
.参数标题, ⽂本型
.参数内容, ⽂本型
Api_GetNotice 返回类型:⽂本型说明:取群公告
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
Api_GetNameCard 返回类型:⽂本型说明:取群名⽚
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
.参数 QQ, ⽂本型
Api_SetNameCard 返回类型:⽆说明:设置群名⽚
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
.参数 QQ, ⽂本型
.参数名⽚, ⽂本型
Api_QuitDG 返回类型:⽆说明:退出讨论组
.参数响应的QQ, ⽂本型
.参数讨论组ID, ⽂本型
Api_DelFriend 返回类型:逻辑型说明:删除好友
.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型
Api_Kick 返回类型:逻辑型说明:将对象移除群
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
.参数对象, ⽂本型
Api_JoinGroup 返回类型:⽆说明:主动加群.为了避免⼴告、群发⾏为。出现验证码时将会直接失败不处理
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
.参数附加理由, ⽂本型
Api_QuitGroup 返回类型:⽆说明:退出群
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
Api_UploadPic 返回类型:⽂本型说明:返回值:成功返回图⽚GUID⽤于发送该图⽚.失败返回空. 图⽚尺⼨应⼩于4MB
.参数响应的QQ, ⽂本型, , 机器⼈QQ
.参数参_上传类型, 整数型, , 1好友2群 注:好友图和群图的GUID并不相同并不通⽤需要⾮别上传。群、讨论组⽤类型2 临时会话、好友信息需要类型1
.参数参_参考对象, ⽂本型, , 上传该图⽚所属的群号或QQ
.参数参_图⽚数据, 字节集, 参考, 图⽚字节集数据或字节集数据指针()
Api_GuidGetPicLink 返回类型:⽂本型说明:根据图⽚GUID取得图⽚下载连接失败返回空
.参数图⽚GUID, ⽂本型, , {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}.jpg 这样的GUID
Api_SendMsg 返回类型:整数型说明:向对象、⽬标发送信息⽀持好友群讨论组群临时会话讨论组临时会话
.参数响应的QQ, ⽂本型
.参数信息类型, 整数型, , 1好友 2群 3讨论组 4群临时会话 5讨论组临时会话
.参数参考⼦类型, 整数型, , ⽆特殊说明情况下留空或填零
.参数收信群_讨论组, ⽂本型, , 发送群信息、讨论组信息、群临时会话信息、讨论组临时会话信息时填写
.参数收信对象, ⽂本型, , 最终接收这条信息的对象QQ
.参数内容, ⽂本型, , 信息内容
Api_Send 返回类型:⽂本型说明:向服务器直接发送⼀个加密封装完成后的封包。成功返回服务器回传加密后的响应包体。失败或超时返回空
.参数封包内容, ⽂本型
Api_OutPut 返回类型:整数型说明:在框架记录页输出⼀⾏信息
.参数内容, ⽂本型, , 输出的内容
Api_IsEnable 返回类型:逻辑型说明:取得本插件启⽤状态
Api_Login 返回类型:逻辑型说明:登录⼀个现存的QQ
.参数 QQ, ⽂本型, , 欲登录的Q
Api_Logout 返回类型:⽆说明:让指定QQ下线
.参数 QQ, ⽂本型
Api_Tea加密返回类型:⽂本型说明:tean加密算法
.参数加密内容, ⽂本型
.参数 Key, ⽂本型
Api_Tea解密返回类型:⽂本型说明:tean解密算法
.参数解密内容, ⽂本型
.参数 Key, ⽂本型
Api_GetNick 返回类型:⽂本型说明:取⽤户名
.参数 QQ, ⽂本型
Api_GetQQLevel 返回类型:⽂本型说明:取QQ等级+QQ会员等级返回json格式信息
.参数 QQ, ⽂本型
Api_GNGetGid 返回类型:⽂本型说明:群号转群ID
.参数群号, ⽂本型
Api_GidGetGN 返回类型:⽂本型说明:群ID转群号
.参数群ID, ⽂本型
Api_GetVersion 返回类型:整数型说明:取框架版本号(发布时间戳
Api_GetVersionName 返回类型:⽂本型说明:取框架版本名
Api_GetTimeStamp 返回类型:整数型说明:取当前框架内部时间戳_周期性与服务器时间同步
Api_GetLog 返回类型:⽂本型说明:取得框架输出列表内所有信息
Api_IfBlock 返回类型:逻辑型说明:判断是否处于被屏蔽群信息状态。
.参数响应的QQ, ⽂本型
Api_GetAdminList 返回类型:⽂本型说明:取包括群主在内的群管列表
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
Api_AddTaotao 返回类型:⽂本型说明:发说说
.参数响应的QQ, ⽂本型
.参数内容, ⽂本型
Api_GetSign 返回类型:⽂本型说明:取个签
.参数响应的QQ, ⽂本型
.参数对象, ⽂本型
Api_SetSign 返回类型:⽂本型说明:设置个签
.参数响应的QQ, ⽂本型
.参数内容, ⽂本型
Api_GetGroupListA 返回类型:⽂本型说明:通过
接⼝取得取群列表.成功返回转码后的JSON 格式⽂本信息
.参数响应的QQ, ⽂本型
Api_GetGroupListB 返回类型:⽂本型说明:通过
接⼝取得取群列表.成功返回转码后的JSON 格式⽂本信息
.参数响应的QQ, ⽂本型
Api_GetGroupMemberA 返回类型:⽂本型说明:通过
接⼝取得群成员列表成功返回转码后的JSON格式⽂本
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
Api_GetGroupMemberB 返回类型:⽂本型说明:通过
接⼝取
得群成员列表成功返回转码后的JSON格式⽂本
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
Api_GetFriendList 返回类型:⽂本型说明:通过
接⼝取得好友列表。成功返回转码后的JSON⽂本
.参数响应的QQ, ⽂本型
Api_GetQQAge 返回类型:整数型说明:取Q龄成功返回Q龄失败返回-1
.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型
Api_GetAge 返回类型:整数型说明:取年龄成功返回年龄失败返回-1
.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型
Api_GetPersonalProfile 返回类型:⽂本型说明:取个⼈说明
.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型, , 对象QQ
Api_GetEmail 返回类型:⽂本型说明:取邮箱成功返回邮箱失败返回空
.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型
Api_GetGender 返回类型:整数型说明:取对象性别 1男 2⼥未或失败返回-1
.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型
Api_SendTyping 返回类型:整数型说明:向好友发送‘正在输⼊’的状态信息.当好友收到信息之后“正在输⼊”状态会⽴刻被打断.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型
Api_SendShake 返回类型:整数型说明:向好友发送窗⼝抖动信息
.参数响应的QQ, ⽂本型
.参数 QQ, ⽂本型
Api_GetRadomOnlineQQ 返回类型:⽂本型说明:取得框架内随机⼀个在线且可以使⽤的QQ
Api_AddQQ 返回类型:逻辑型说明:往帐号列表添加⼀个Q.当该Q已存在时则覆盖密码
.参数 QQ, ⽂本型
.参数密码, ⽂本型
.参数⾃动登录, 逻辑型, , 运⾏框架时是否⾃动登录该Q.若添加后需要登录该Q则需要通过Api_Login操作
Api_SetOLStatus 返回类型:逻辑型说明:设置在线状态+附加信息
.参数响应的QQ, ⽂本型
.参数在线状态, 整数型, , 1~6 分别对应我在线上, Q我吧, 离开, 忙碌, 请勿打扰, 隐⾝
.参数状态附加信息, ⽂本型, , 最⼤255字节
Api_GetMC 返回类型:⽂本型说明:取得机器码
Api_GroupInvitation 返回类型:⽂本型说明:邀请对象加⼊群失败返回错误理由
.参数响应的QQ, ⽂本型
.参数好友QQ, ⽂本型, , 多个好友⽤换⾏分割
.参数群号, ⽂本型
Api_CreateDG 返回类型:⽂本型说明:创建⼀个讨论组成功返回讨论组ID 失败返回空注:每24⼩时只能创建100个讨论组悠着点⽤
.参数响应的QQ, ⽂本型
Api_KickDG 返回类型:⽂本型说明:将对象移除讨论组.成功返回空失败返回理由
.参数响应的QQ, ⽂本型
.参数讨论组ID, ⽂本型
.参数成员, ⽂本型
Api_DGInvitation 返回类型:⽂本型说明:邀请对象加⼊讨论组成功返回空失败返回理由
.参数响应的QQ, ⽂本型
.参数讨论组ID, ⽂本型
.参数成员组, ⽂本型, , 多个成员⽤换⾏符分割
Api_GetDGList 返回类型:⽂本型说明:成功返回以换⾏符分割的讨论组号列表.最⼤为100个讨论组失败返回空
.参数响应的QQ, ⽂本型
Api_SendMusic 返回类型:逻辑型说明:向对象发送⼀条⾳乐信息(所谓的点歌)次数不限
.参数响应的QQ, ⽂本型
.参数收信对象类型, 整数型, , 同Api_SendMsg 1好友 2群 3讨论组 4群临时会话 5讨论组临时会话
.参数收信对象所属群_讨论组, ⽂本型, , 发群内、临时会话必填好友可不填
.参数收信对象QQ, ⽂本型, , 临时会话、好友必填发⾄群内可不填
.参数⾳乐简介, ⽂本型, , 留空默认‘QQ⾳乐的分享’
.参数⾳乐播放页⾯连接, ⽂本型, , 任意直连或短链接均可留空为空⽆法点开
.参数⾳乐封⾯连接, ⽂本型, , 任意直连或短链接均可可空
例:http://www.wendangwang.com/doc/5910003124c52cc58bd63186bceb19e8b8f6ec97.html/cDiJT4
.参数⾳乐⽂件直连连接, ⽂本型, , 任意直连或短链接均可不可空
例:http://www.wendangwang.com/doc/5910003124c52cc58bd63186bceb19e8b8f6ec97.html/djwXjr
.参数曲名, ⽂本型, , 可空
.参数歌⼿名, ⽂本型, , 可空
.参数⾳乐来源名, ⽂本型, , 可空为空默认QQ⾳乐
.参数⾳乐来源图标连接, ⽂本型, , 可空为空默认QQ⾳乐
http://www.wendangwang.com/doc/5910003124c52cc58bd63186bceb19e8b8f6ec97.html/ac/qzone/applogo/64/308/100497308_64.gif Api_SendObjectMsg 返回类型:逻辑型说明:
.参数响应的QQ, ⽂本型
.参数收信对象类型, 整数型, , 同Api_SendMsg 1好友 2群 3讨论组 4群临时会话 5讨论组临时会话
.参数收信对象所属群_讨论组, ⽂本型, , 发群内、临时会话必填好友可不填
.参数收信对象QQ, ⽂本型, , 临时会话、好友必填发⾄群内可不填
.参数 ObjectMsg, ⽂本型
.参数结构⼦类型, 整数型, , 00 基本 02 点歌其他不明
Api_IsFriend 返回类型:逻辑型说明:判断对象是否为好友(双向)
.参数响应的QQ, ⽂本型
.参数对象QQ, ⽂本型
Api_AddFriend 返回类型:逻辑型说明:主动加好友成功返回真失败返回假当对象设置需要正确回答问题或不允许任何⼈添加时⽆条件失败
.参数响应的QQ, ⽂本型, , 机器⼈QQ
.参数对象QQ, ⽂本型, , 加谁
.参数附加理由, ⽂本型, , 加好友提交的理由
Api_SelfDisable 返回类型:⽆说明:⽆参⽤于插件⾃⾝请求禁⽤插件⾃⾝
Api_GetClientType 返回类型:整数型说明:取协议客户端类型常量失败返回0
Api_GetClientVer 返回类型:整数型说明:取协议客户端版本号常量失败返回0
Api_GetPubNo 返回类型:整数型说明:取协议客户端公开版本号常量失败返回0
Api_GetMainVer 返回类型:整数型说明:取协议客户端主版本号常量失败返回0
Api_GetTXSSOVer 返回类型:整数型说明:取协议客户端通信模块(TXSSO)版本号常量失败返回0
Api_UploadVoice 返回类型:⽂本型说明:上传⾳频⽂件成功返回guid⽤于发送
.参数响应的QQ, ⽂本型
.参数 amr⾳频数据, 整数型, , ⾳频字节集数据
Api_GuidGetVoiceLink 返回类型:⽂本型说明:通过⾳频、语⾳guid取得下载连接
.参数响应的QQ, ⽂本型
.参数 GUID, ⽂本型, , 格式:{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx}.amr
Api_AddLogHandler 返回类型:逻辑型说明: 添加⼀个⽇志处理函数。每条新⽇志信息输出都会投递给该函数处理、重复添加将覆盖旧的、之前的接⼝
.参数参_处理函数指针, ⼦程序指针, , 回调⼦程序、函数指针(内存地址)。函数仅⼀个参数。参数1为结构体LOGSTRUCT指针Api_RemoveLogHandler 返回类型:⽆返回说明:移除由Api_AddLogHandler添加、设置的⽇志处理函数
处理函数原型:
C风格:
struct LOGSTRUCT{
unsigned long dwLogType;/四字节⽆符号⽇志信息类型/
char *LogText;/Ansi编码⽇志信息指针/
char *Response;/Ansi编码响应对象信息指针/
}
void LogHandler(LOGSTRUCT *Msg);//返回⾮0阻塞/屏蔽/拦截本条⽇志信息
易语⾔:
.数据类型结构_LOGSTRUCT
.成员⽇志类型, 整数型, , , 四字节⽆符号⽇志信息类型
.成员⽇志内容, ⽂本型, , , ⽇志⽂本信息内容
.成员响应对象, ⽂本型, , , 响应对象信息
.⼦程序处理函数,返回⾮0阻塞/屏蔽/拦截本条⽇志信息 , ,
.参数参_处理函数指针, 结构_LOGSTRUCT, ,
注:由于易DLL并不⽀持结构体传递因⽽实际编写时需将参数“参_处理函数指针”类型改为“整数型”否则⽆法取地址或编译实际使⽤请参考以下代码
.版本 2
.⼦程序处理函数,返回⾮0阻塞/屏蔽/拦截本条⽇志信息 , 公开
.参数参_结构指针, 整数型
.局部变量局_缓冲变量, 结构_LOGSTRUCT
.局部变量局_LOGSTRUCT, 结构_LOGSTRUCT
强制交换变量 (局_缓冲变量, 参_结构指针) ’ 交换数据指针
局_LOGSTRUCT =局_缓冲变量 ’ 拷贝数据
强制交换变量 (局_缓冲变量, 参_结构指针) ’ 交换数据指针还原原变量
’ 局_LOGSTRUCT便是所需结构体数据
返回(1)’返回⾮0阻塞/屏蔽/拦截本条⽇志信息
⽇志类型:
’ 0未定义
’ 1好友
’ 2群
’ 3讨论组
’ 4群临时
’ 5讨论组临时
’ 1000登录
’ 2000插件输出
’ 10000提⽰
’ 10001发送
’ 10002事件
’ 10003框架⾃检
’ 20000错误-不严重的可忽略的
’ 20001错误-严重的不可忽略的
’ 20002错误-致命的引起崩溃的
Api_GetGroupName 返回类型:⽂本型说明:获取群名
.参数响应的QQ, ⽂本型
.参数群号, ⽂本型
Api_SetMsgFilter 返回类型:逻辑型说明:添加⼀个待发送处理函数。每条待发送信息都会投递给该函数处理、重复添加将覆盖旧的、之前的接⼝
.参数参_处理函数指针, ⼦程序指针, , 回调⼦程序、函数指针(内存地址)。
Api_RemoveMsgFilter 返回类型:⽆返回说明:移除\取消由Api_SetMsgFilter 所添加\设置的处理函数
处理函数原型:
.版本 2
.⼦程序 MsgFilter, 整数型, , 待发送信息处理接⼝默认编码GBK
.参数参_响应的QQ, ⽂本型, , 标识处理本信息的是框架内的哪个机器⼈QQ .参数参_待发送类型, 整数型, , 1好友 2群 3讨论组 4群临时 5讨论组临时其他:⾮法\不应存在的类型
.参数参_待发送⼦类型, 整数型, , 0普通⽂本信息 1 ObjectMessage
.参数参_收信群号_讨论组号, ⽂本型, , 群号或讨论组号
.参数参_收信QQ, ⽂本型, , 收信对象QQ
.参数参_原始信息内容, ⽂本型, , 未经过格式化处理包含例如[name] [qq]之类的标记符
.参数参_格式化信息内容, ⽂本型, , 经过格式化处理后的信息例如[name] [qq]之类的标记符->‘eghuai’ ‘445491251’