wxgo 插件 HTTP+WS 开发文档

接口： /api/plugins/http41827/:wxid/*
协议头： Authorization: Bearer <plugin_token>

1) 固定入口

方法完整路径参数功能名
GET / POST/api/plugins/http41827/bots无获取在线机器人列表
POST/api/plugins/http41827/:wxid/send_text{"to":"接收方wxid","msg":"文本"}快捷发送文本
POST/api/plugins/http41827/:wxid/contacts无获取好友列表
POST/api/plugins/log{"level":"INFO|WARN|ERROR","message":"内容"}日志输出
GET(WS)/api/plugins/ws?token=<plugin_token>query token接收回调消息

2) API接口文档

登录 / 账号

路径功能名参数示例
/api/plugins/http41827/:wxid/check-login检查当前微信是否登录{}
/api/plugins/http41827/:wxid/logout退出当前微信登录{}

联系人

路径功能名参数示例
/api/plugins/http41827/:wxid/get-profile-cache获取机器人资料{}
/api/plugins/http41827/:wxid/get-contact获取陌生人/好友资料{"wxid":"wxid"}
/api/plugins/http41827/:wxid/get-contact-fast获取好友资料(缓存){"wxid":"wxid"}
/api/plugins/http41827/:wxid/update-single-profile更新用户资料{"wxid":"wxid或群id"}
/api/plugins/http41827/:wxid/mod-self-nick-name修改机器人昵称{"newName":"新昵称"}
/api/plugins/http41827/:wxid/mod-self-nick-signature修改机器人个性签名{"newSignature":"新签名"}
/api/plugins/http41827/:wxid/upload-head-img上传机器人头像{"filepath":"C:/path/avatar.jpg"}
/api/plugins/http41827/:wxid/verify-friend同意好友申请{"wxid":"...","v4":"ticket","scene":17}
/api/plugins/http41827/:wxid/remark-contact修改备注{"wxid":"wxid","remark":"备注"}
/api/plugins/http41827/:wxid/del-contact删除好友{"wxid":"wxid"}
/api/plugins/http41827/:wxid/set-top置顶{"wxid":"wxid或群id"}
/api/plugins/http41827/:wxid/cancel-top取消置顶{"wxid":"wxid或群id"}
/api/plugins/http41827/:wxid/set-start星标好友{"wxid":"wxid"}
/api/plugins/http41827/:wxid/del-start取消星标{"wxid":"wxid"}
/api/plugins/http41827/:wxid/set-mute-user开启免打扰{"wxid":"wxid或群id"}
/api/plugins/http41827/:wxid/del-mute-user关闭免打扰{"wxid":"wxid或群id"}
/api/plugins/http41827/:wxid/black-user拉黑好友{"wxid":"wxid"}
/api/plugins/http41827/:wxid/del-black-user移出黑名单{"wxid":"wxid"}

通讯录

路径功能名参数示例
/api/plugins/http41827/:wxid/get-contact-list2获取通讯录列表{}
/api/plugins/http41827/:wxid/update-all-friend更新全部好友{}
/api/plugins/http41827/:wxid/init-rooms初始化群{}
/api/plugins/http41827/:wxid/get-rooms-info获取群资料{}
/api/plugins/http41827/:wxid/get-room-members获取群成员{"room_id":"123@chatroom"}
/api/plugins/http41827/:wxid/creat-chat-room创建群聊{"wxids":"wxid,wxid"}
/api/plugins/http41827/:wxid/invite-member-to-chat-room邀请入群{"wxid_list":"wxid","room_id":"群id"}
/api/plugins/http41827/:wxid/add-member-to-chat-room添加群成员{"wxid_list":"wxid","room_id":"群id"}
/api/plugins/http41827/:wxid/del-member-from-chat-room踢出群成员{"wxid_list":"wxid","room_id":"群id"}
/api/plugins/http41827/:wxid/quit-and-del-chat-room退出群聊{"roomId":"群id"}
/api/plugins/http41827/:wxid/set-room-admin添加群管理{"roomId":"群id","admin":"wxid"}
/api/plugins/http41827/:wxid/del-room-admin删除群管理{"roomId":"群id","admin":"wxid"}

消息发送

路径功能名参数示例
/api/plugins/http41827/:wxid/send-text-msg发送文本消息{"wxid":"wxid或群id","msg":"文本"}
/api/plugins/http41827/:wxid/send-image-msg发送图片消息{"wxid":"...","image_path":"C:/xx.png"}
/api/plugins/http41827/:wxid/send-at-text发送群@消息{"roomId":"群id","msg":"内容","wxids":"wxid"}
/api/plugins/http41827/:wxid/send-app-msg发送卡片/XML{"content":"xml","type":"19","wxid":"wxid或群id"}
/api/plugins/http41827/:wxid/send-file-msg发送文件{"wxid":"...","filepath":"C:/xx.pdf"}
/api/plugins/http41827/:wxid/send-link-card发送链接卡片{"to_wxid":"...","title":"标题","desc":"描述","url":"链接","thumb_url":"缩略图"}
/api/plugins/http41827/:wxid/send-card-msg发送名片{"to_wxid":"接收方","card_wxid":"名片wxid"} 或 {"towxid":"接收方","fromwxid":"名片wxid"}
/api/plugins/http41827/:wxid/send-emotion-msg发送表情{"filepath":"绝对路径","wxid":"群id或wxid"}
/api/plugins/http41827/:wxid/download-img下载图片{"to_user":"...","from_user":"...","start_pos":0,"total_len":559726,"data_len":559726,"compress_type":0,"MsgId":1469066920,"path":"保存路径"}
/api/plugins/http41827/:wxid/download-file下载文件{"from_user":"...","total_len":"31538","MsgId":2750000000,"path":"保存路径","attachid":"@cdn_...","type":"6"}
/api/plugins/http41827/:wxid/download-video下载视频{"MsgId":123,"path":"保存路径"}
/api/plugins/http41827/:wxid/download-voice下载语音{"newMsgId":"...","path":"保存路径"}

其他

路径功能名参数示例
/api/plugins/http41827/:wxid/net-scene-search-contact搜索微信号/手机号{"search":"微信号或手机号"}
/api/plugins/http41827/:wxid/add-friend添加好友{"v3":"...","v4":"..."}
/api/plugins/http41827/:wxid/get-a8-key获取A8Key{"url":"..."}
/api/plugins/http41827/:wxid/add-label增加标签{"label":"内容"}
/api/plugins/http41827/:wxid/del-label删除标签{"label_id":"标签序号"}
/api/plugins/http41827/:wxid/get-label-lists获取标签列表{}
/api/plugins/http41827/:wxid/modify-contact-label修改好友标签{"wxids":"wxid","labelId":"标签序号"}
/api/plugins/http41827/:wxid/sns-get-first-page获取朋友圈首页{"firstPageMd5":"string","maxId":"string"}
/api/plugins/http41827/:wxid/sns-get-next-page获取朋友圈下一页{"lastItemid":"..."}
/api/plugins/http41827/:wxid/sns-post发文字朋友圈{"content":"内容","blackList":"","withauserList":""}
/api/plugins/http41827/:wxid/sns-send-img发图片朋友圈{"filelist":"[\"图片1.jpg\",\"图片2.png\"]","content":"666"}
/api/plugins/http41827/:wxid/sns-del-comment删除朋友圈评论{"content":"回复内容","sns_id":"朋友圈id","comment_id":"3"}
/api/plugins/http41827/:wxid/sns-del删除朋友圈{"sns_id":""}