- API使用说明
- 1. 开发者HttpAPI接口原理:将所有参数,以POST方式,直接发送到开发者创建应用时的URL【接收地址】(开发者自己的URL地址),处理完数据按照指定格式,返回发送消息。
- 2. HttpApi接口完全免费,支持html(html必须支持post传参),php,asp,.net,jsp,cgi等所有web开发方式。
- 3. 关于管理地址,数据安全校验,系统自动在Url加上“chechk”参数(GET方式)
群应用算法 : chechk= md5('checkurl'.$_GET['gid'].$_GET['n'])
好友应用算法 : chechk=md5('checkurl'.$_GET['wxuin'].$_GET['n']) - 4. 特殊消息代码(需开通高级服务/开发者高级服务):
- 1)发图文:[结束][url][title=百度],[des=百度一下],[url=http://www.baidu.com/],[img=https://ss0.bdstatic.com/5aV1bjqh_Q23odCf/static/superman/img/logo/bd_logo1_31bdc765.png][/url]
- 2)发图片:[结束][img]https://ss0.bdstatic.com/5aV1bjqh_Q23odCf/static/superman/img/logo/bd_logo1_31bdc765.png[/img]
- 3)发名片:[结束][card]好友微信号,好友昵称[/card]
- 4)发视频:[结束][file]本地视频文件路径[/file]
- 5)发文件:[结束][file]本地文件路径[/file]
- 5)发音乐( 可直接播放,软件必须V3.31/3.42以上版本):[结束][music][title=这里填写标题],[des=这里是描述],[url=这里是点击打开网址],[musicurl=这里是音频文件网址][/music]
- 6)@某人:#@wxid_xxx#内容(1.多个wxid用英文逗号; 2.[内容]中必须包含@, @多少个成员, 内容中就必须包含多少个@符号,可以在任意位置, V3.31与开发版支持同时@多人)
- 7)发公告:[notice]内容[/notice] (机器人必须是群主)
- 8)发小程序:[结束][app][title=标题],[appnickname=小程序名称],[pagepath=小程序路径],[username=gh_xxxxxxx@app],[img=缩略图本地路径][/app] (必须pcwx2.7.1.82版及以上支持,gh_xxxxxxx@app具体内容可以在软件日志中获取)
- .. 【重要】应用创建成功后,在群里发“更新功能”,即可打通。(如何测试:在群里发“功能”,功能菜单出现创建的应用名称,说明打通成功。)
- 开发流程: 1.申请开发者->2.创建应用并绑定测试群->3.在绑定群直接使用 ( 如需上架,提交审核即可,上架的应用,必须有图文介绍,参考已上架应用)
- 新手必看教程(必看)
- 应用创建后,无需提交审核,直接可以在绑定群/号进行测试,开发交流QQ群:512998803
- 平台提供:登录/注册/同步接口,有需要合作的软件请联系客服QQ:1756292969
- 【小翼开发版 - 稳定版 2.0】: 立即下载(无任何多余功能,更稳定)
- 【小翼开发版 - 最新版 3.0】: 立即下载(无任何多余功能,更稳定) | 新版接口文档 >>
应用接口-HttpAPI (稳定版 2.0 开发文档) |
1. [群] 关键词触发(创建应用时,触发关键词留空,则所有消息都触发)
【接收地址】收到参数 | 名称 | 描述 |
---|---|---|
robotid | 机器人唯一 ID | 扫码机器人的唯一 ID |
msgid | 消息 ID | |
gid | 群唯一 ID | |
gusername | 群唯一ID | |
gname | 群名称 | 已经转码为:Unicode编码,格式”\u“,需要在服务器解码 |
mid | 群成员唯一 ID | |
nickname | 群成员 昵称 | 已经转码为:Unicode编码,格式”\u“,需要在服务器解码 |
displayname | 群成员 名片 | 已经转码为:Unicode编码,格式”\u“,需要在服务器解码 | gadmin | 群管理员 | 唯一id,多个以逗号隔开 |
skw | 应用 ID | 创建应用的唯一 ID |
content | 消息内容 | 用户消息触发,带参数时,使用该字段。 已经转码为:Unicode编码,格式”\u“,需要在服务器解码 |
atlist | @多个用户 | 用户消息@其他用户时,触发。 可能含多个用户ID |
robotnickname | 机器人昵称 | 用户消息触发,带参数时,使用该字段。 已经转码为:Unicode编码,格式”\u“,需要在服务器解码 |
atmod | @模式开启状态 | 1开启,0关闭 (软件上是否开启了: 群聊@模式) |
URL返回值格式(严格按格式返回,非json):
注:格式二,小翼版3.16及以上版本支持
格式一,普通回复(直接回复发消息对象):{"rs":1,"tip":"这里是返回的内容,utf-8格式中文,不需要转码[结束][img]http://www.dijiu.com/upload/2009/2/24/2009022479639361.gif[/img][结束][img]http://www.dijiu.com/upload/2009/2/24/2009022479639361.gif[/img]","end":0}
格式二,扩展回复(直接回复发消息对象,扩展另增加指定对象):{"rs":1,"tip":"这里是返回的内容,utf-8格式中文,不需要转码[结束][img]http://www.dijiu.com/upload/2009/2/24/2009022479639361.gif[/img][结束][img]http://www.dijiu.com/upload/2009/2/24/2009022479639361.gif[/img]","wxuin":"扩展对象","wxuin_tip":"扩展回复内容","end":0}
格式三,特殊处理(见下表):
返回参数 | 返回值 | 描述 |
---|---|---|
rs | 1 | 正常触发消息 |
rs | 10 | 获取当前群所有成员,软件会再调一次接口 (发送所有群成员参数"memberlist",status=9退群,1正常),不会处理返回值 返回例子 : {"rs":10,"tip":"这里是返回的内容","end":0} |
rs | 13 | 正常触发消息,并将当前发消息的群成员,踢出本群 返回例子 : {"rs":13,"tip":"这里是返回的内容,xxx你被踢了","end":0} |
rs | 14 | 正常触发消息,并将返回的群成员昵称/wxid,踢出本群。返回多个昵称用[结束]分割。 ( 附加参数:"nickname") 返回例子 : {"rs":14,"tip":"这里是返回的内容","nickname":"香蕉[结束]茄子[结束]草莓","end":0} |
ds | 1 | 支持返回一个定时消息,在指定时间,发到群里。在标准格式中,增加如下参数即可:"content":"消息内容","sendtime":"时间戳" 返回例子 : {"rs":1,"tip":"这里是返回的内容","ds":1,"content":"这里填写定时消息","sendtime":"1498445991","end":0} |
注:支持文字、图片、多条消息。
1:图片格式(jpg,gif,png):[结束][img]https://www.baidu.com/logo.gif[/img][结束]
2:多条消息:用[结束]分割
3:若有图片与文字,图片必须为单独的消息,如:这里是返回的内容[结束]这里是第二条消息[结束][img]https://www.baidu.com/logo.gif[/img][结束][img]https://www.baidu.com/logo.gif[/img]
2. [群] 主动消息接口 ([群]定时消息)
【接收地址】收到参数 | 名称 | 描述 |
---|---|---|
robotid | 机器人唯一 ID | |
gid | 群唯一 ID | |
skw | 应用 ID | 创建应用的唯一 ID |
URL返回值格式(严格按格式返回,非json):{"rs":1,"content":"定时消息的内容","sendtime":"指定发送时间(格式:时间戳 , 秒级)","end":1}
注:支持文字、图片、消息分割、emoji。
1:图片格式(jpg,gif,png):[img]https://www.baidu.com/logo.gif[/img]
2:多条消息:用[结束]分割
3:若有图片与文字,图片前必须加[结束],如:这里是返回的内容[结束]这里是第二条消息[结束][img]https://www.baidu.com/logo.gif[/img][结束][img]https://www.baidu.com/logo.gif[/img]
4:V2.1以上版本支持该接口。
5:【接口逻辑】系统每隔一定周期,自动请求接口一次。返回的消息,必须为(当前时间+10秒以上)才会发送。具体触发定时,以软件所在电脑时间为准。
(1) 一般:2分钟周期
6:由于系统会周期性请求新的数据,所以,每次返回单条定时消息即可。
3. [友] 好友聊天关键词触发
【接收地址】收到参数 | 名称 | 描述 |
---|---|---|
msgid | 消息 ID | |
robotid | 机器人唯一 ID | |
mid | 好友ID | 唯一 | username | 群成员 |
nickname | 好友昵称 | 已经转码为:Unicode编码,格式”\u“,需要在服务器解码 |
content | 消息内容 | 已经转码为:Unicode编码,格式”\u“,需要在服务器解码 | robotnickname | 机器人昵称 | 用户消息触发,带参数时,使用该字段。 已经转码为:Unicode编码,格式”\u“,需要在服务器解码 |
URL返回值格式(严格按格式返回,非json):{"rs":1,"tip":"么么哒(づ 3 )づ[结束][img]http://www.dijiu.com/upload/2009/2/24/2009022479639361.gif[/img][结束][img]http://www.dijiu.com/upload/2009/2/24/2009022479639361.gif[/img]","end":0}
返回参数 | 返回值 | 描述 |
---|---|---|
rs | 1 | 正常触发消息 返回例子 : {"rs":1,"tip":"你好,这里是返回的内容","end":0} |
rs | 12 | 返回群的关键词,第一个匹配成功的群(默认模糊匹配,支持正则),系统自动邀请聊天好友加入 返回例子 : {"rs":12,"tip":"你好,已经邀请你加入群聊咯","gname":"测试1","end":0} |
注:支持文字、图片、多条消息。
1:图片格式(jpg,gif,png):[img]https://www.baidu.com/logo.gif[/img]
2:多条消息:用[结束]分割
3:若有图片与文字,图片必须为单独的消息,如:这里是返回的内容[结束]这里是第二条消息[结束][img]https://www.baidu.com/logo.gif[/img][结束][img]https://www.baidu.com/logo.gif[/img]
4:这里设置后,若群内使用该功能,则将动态显示在”功能菜单“中
5:转账消息格式, 请自行分析收到代码 (消息类型: msgtype=49 收到转账 , 其他自己测试)
4. [友/群] 主动消息接口(任意) ([友/群]定时消息) ( V3.31 或 开发版 支持)
【接收地址】收到参数 | 名称 | 描述 |
---|---|---|
robotid | 机器人唯一 ID | |
robotnickname | 机器人昵称 | |
skw | 应用 ID | 创建应用的唯一 ID |
URL返回值格式(严格按格式返回,非json):{"rs":1,"wxid":"发送对象支持任意好友,任意群(友:wxid_xxxxxx,群:xxxx@chatroom)","content":"定时消息的内容","sendtime":"指定发送时间(格式:时间戳 , 秒级)","end":1}
返回参数 | 返回值 | 描述 |
---|---|---|
rs | 1 | 正常触发消息 返回例子 : {"rs":1,"wxid":"发送对象支持任意好友,任意群(友:wxid_xxxxxx,群:xxxx@chatroom)","content":"定时消息的内容","sendtime":"指定发送时间(格式:时间戳 , 秒级)","end":1} |
rs | 15 | 返回当前机器人好友/群列表, 以POST方式传给接收地址. POST参数: grouplist(群列表), friendlist(好友列表) . 注: 昵称带特殊符号,有可能导致json转换失败(不要直接转json),建议直接正则或循环取具体数据 (多测试) 返回例子 : {"rs":15,"end":1} |
注:支持文字、图片、消息分割、emoji。
1:图片格式(jpg,gif,png):[img]https://www.baidu.com/logo.gif[/img]
2:多条消息:用[结束]分割
3:若有图片与文字,图片前必须加[结束],如:这里是返回的内容[结束]这里是第二条消息[结束][img]https://www.baidu.com/logo.gif[/img][结束][img]https://www.baidu.com/logo.gif[/img]
4:V3.29以上版本支持该接口
5:【接口逻辑】系统每隔一定周期,自动请求接口一次。返回的消息,建议为(当前时间+10秒以上)。具体触发定时,以软件所在电脑时间为准。
(1) 周期:120秒周期(稳定版),60秒(内测版)
6:由于系统会周期性请求新的数据,所以,每次返回单条定时消息即可。
7:【重要】本接口创建应用后,需要点击软件上【更新功能】
数据接口(查询群成员信息)-HttpAPI (新)
1. 【接口】获取单个群成员数据
GET方式接口:http://www.app-yun.cn/index.php?m=appapi&a=api_memberinfo_get&mid=[成员mid]&gid=[群gid]&key=[开发者key]&username=[开发者账号]
返回Json 描述 nickname 成员昵称 gold 成员金币 fen 成员积分 title 成员头衔 signin_total 签到总计 signin_month_total 月签到 signin_lianxu_total 连续签到 signin_addtime 最后签到时间 signin_top 最后签到排名 2. 【接口】修改单个群成员金币/积分
POST接口:http://www.app-yun.cn/index.php?m=appapi&a=api_memberinfo_edit
POST参数 (不需要修改的,留空):
mid=[成员mid]&gid=[群gid]&key=[开发者key]&username=[开发者账号]&gold=[修改金币数量]&fen=[修改积分数量]返回Json 描述 status 1修改成功,0用户数据不存在,-1 参数不全,-2 验证码不对 - 注:所有参数必填。金币/积分必须是正整数。[成员mid]、[群gid] 通过最上方【httpapi应用接口】获取。