cyonjan/WeChatFerry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
c3c22543b9
WeChatFerry/clients/gohttp/public/swag/swagger.json

1108 lines
35 KiB
JSON
Raw Normal View History

Add go http client
2023-12-17 13:16:15 +08:00
{
"swagger": "2.0",
"info": {
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"description": "基于 WeChatFerry RPC 实现的微信接口，使用 Go 语言编写，无第三方运行时依赖，易于对接任意编程语言。",
"title": "WeChat Rest Api",
Add go http client
2023-12-17 13:16:15 +08:00
"contact": {
"name": "WeChatRest",
"url": "https://github.com/opentdp/wechat-rest"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"version": "v0.5.0"
Add go http client
2023-12-17 13:16:15 +08:00
},
"basePath": "/api",
"paths": {
"/accept_new_friend": {
"post": {
"produces": [
"application/json"
],
"summary": "接受好友请求",
"parameters": [
{
"description": "接受好友请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.Verification"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/add_chatroom_members": {
"post": {
"produces": [
"application/json"
],
"summary": "添加群成员",
"parameters": [
{
"description": "增删群成员请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.MemberMgmt"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/alias_in_chatroom/{wxid}/{roomid}": {
"get": {
"produces": [
"application/json"
],
"summary": "获取群成员昵称",
"parameters": [
{
"type": "string",
"description": "wxid",
"name": "wxid",
"in": "path",
"required": true
},
{
"type": "string",
"description": "群id",
"name": "roomid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
}
}
},
"/chatroom_members/{roomid}": {
"get": {
"produces": [
"application/json"
],
"summary": "获取群成员列表",
"parameters": [
{
"type": "string",
"description": "群id",
"name": "roomid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/wcferry.RpcContact"
}
}
}
}
}
},
"/chatrooms": {
"get": {
"produces": [
"application/json"
],
"summary": "获取群列表",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/wcferry.RpcContact"
}
}
}
}
}
},
"/contacts": {
"get": {
"produces": [
"application/json"
],
"summary": "获取完整通讯录",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/wcferry.RpcContact"
}
}
}
}
}
},
"/db_names": {
"get": {
"produces": [
"application/json"
],
"summary": "获取数据库列表",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"/db_query_sql": {
"post": {
"produces": [
"application/json"
],
"summary": "执行数据库查询",
"parameters": [
{
"description": "数据库查询请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcfrest.DbSqlQueryRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"/db_tables/{db}": {
"get": {
"produces": [
"application/json"
],
"summary": "获取数据库表列表",
"parameters": [
{
"type": "string",
"description": "数据库名",
"name": "db",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/wcferry.DbTable"
}
}
}
}
}
},
"/del_chatroom_members": {
"post": {
"produces": [
"application/json"
],
"summary": "删除群成员",
"parameters": [
{
"description": "增删群成员请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.MemberMgmt"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"/disable_receiver": {
Add go http client
2023-12-17 13:16:15 +08:00
"post": {
"produces": [
"application/json"
],
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"summary": "关闭推送消息到URL",
Add go http client
2023-12-17 13:16:15 +08:00
"parameters": [
{
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"description": "消息推送请求参数",
Add go http client
2023-12-17 13:16:15 +08:00
"name": "body",
"in": "body",
"required": true,
"schema": {
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"$ref": "#/definitions/wcfrest.ReceiverRequest"
Add go http client
2023-12-17 13:16:15 +08:00
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/download_attach": {
"post": {
"produces": [
"application/json"
],
"summary": "下载附件",
"parameters": [
{
"description": "下载附件参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcfrest.DownloadAttachRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/download_image": {
"post": {
"produces": [
"application/json"
],
"summary": "下载图片",
"parameters": [
{
"description": "下载图片参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcfrest.DownloadImageRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"/enable_receiver": {
Add go http client
2023-12-17 13:16:15 +08:00
"post": {
"produces": [
"application/json"
],
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"summary": "开启推送消息到URL",
Add go http client
2023-12-17 13:16:15 +08:00
"parameters": [
{
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"description": "消息推送请求参数",
Add go http client
2023-12-17 13:16:15 +08:00
"name": "body",
"in": "body",
"required": true,
"schema": {
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"$ref": "#/definitions/wcfrest.ReceiverRequest"
Add go http client
2023-12-17 13:16:15 +08:00
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
Impl Forward Message
2023-12-27 18:26:35 +08:00
"/forward_msg": {
"post": {
"produces": [
"application/json"
],
"summary": "转发消息",
"parameters": [
{
"description": "转发消息请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.ForwardMsg"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
Add go http client
2023-12-17 13:16:15 +08:00
"/friends": {
"get": {
"produces": [
"application/json"
],
"summary": "获取好友列表",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/wcferry.RpcContact"
}
}
}
}
}
},
"/get_audio_msg": {
"post": {
"produces": [
"application/json"
],
"summary": "获取语音消息",
"parameters": [
{
"description": "语音消息请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcfrest.GetAudioMsgRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/get_ocr_result": {
"post": {
"produces": [
"application/json"
],
"summary": "获取OCR识别结果",
"parameters": [
{
"description": "文本请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcfrest.GetOcrRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/invite_chatroom_members": {
"post": {
"produces": [
"application/json"
],
"summary": "邀请群成员",
"parameters": [
{
"description": "增删群成员请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.MemberMgmt"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/is_login": {
"get": {
"produces": [
"application/json"
],
"summary": "检查登录状态",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "boolean"
}
}
}
}
},
"/msg_types": {
"get": {
"produces": [
"application/json"
],
"summary": "获取所有消息类型",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
}
}
},
"/receive_transfer": {
"post": {
"produces": [
"application/json"
],
"summary": "接受转账",
"parameters": [
{
"description": "接受转账请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.Transfer"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/refresh_pyq/{id}": {
"get": {
"produces": [
"application/json"
],
"summary": "刷新朋友圈",
"parameters": [
{
"type": "integer",
"description": "朋友圈id",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/revoke_msg/{msgid}": {
"get": {
"produces": [
"application/json"
],
"summary": "撤回消息",
"parameters": [
{
"type": "integer",
"description": "消息id",
"name": "msgid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/self_wxid": {
"get": {
"produces": [
"application/json"
],
"summary": "获取登录账号wxid",
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
}
}
}
},
"/send_file": {
"post": {
"produces": [
"application/json"
],
"summary": "发送文件消息",
"parameters": [
{
"description": "文件消息请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.PathMsg"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/send_img": {
"post": {
"produces": [
"application/json"
],
"summary": "发送图片消息",
"parameters": [
{
"description": "图片消息请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.PathMsg"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/send_pat_msg": {
"post": {
"produces": [
"application/json"
],
"summary": "拍一拍群友",
"parameters": [
{
"description": "拍一拍请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.PatMsg"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/send_rich_text": {
"post": {
"produces": [
"application/json"
],
"summary": "发送卡片消息",
"parameters": [
{
"description": "卡片消息请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.RichText"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/send_txt": {
"post": {
"produces": [
"application/json"
],
"summary": "发送文本消息",
"parameters": [
{
"description": "文本消息请求参数",
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/wcferry.TextMsg"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcfrest.RespPayload"
}
}
}
}
},
"/user_info": {
"get": {
"produces": [
"application/json"
],
"summary": "获取登录账号个人信息",
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcferry.UserInfo"
}
}
}
}
},
"/user_info/{wxid}": {
"get": {
"produces": [
"application/json"
],
"summary": "根据wxid获取个人信息",
"parameters": [
{
"type": "string",
"description": "wxid",
"name": "wxid",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/wcferry.RpcContact"
}
}
}
}
}
},
"definitions": {
"wcferry.DbTable": {
"type": "object",
"properties": {
"name": {
"description": "表名",
"type": "string"
},
"sql": {
"description": "建表 SQL",
"type": "string"
}
}
},
Impl Forward Message
2023-12-27 18:26:35 +08:00
"wcferry.ForwardMsg": {
"type": "object",
"properties": {
"id": {
"description": "待转发消息 ID",
"type": "integer"
},
"receiver": {
"description": "转发接收目标，群为 roomId，个人为 wxid",
"type": "string"
}
}
},
Add go http client
2023-12-17 13:16:15 +08:00
"wcferry.MemberMgmt": {
"type": "object",
"properties": {
"roomid": {
"description": "要加的群ID",
"type": "string"
},
"wxids": {
"description": "要加群的人列表，逗号分隔",
"type": "string"
}
}
},
"wcferry.PatMsg": {
"type": "object",
"properties": {
"roomid": {
"description": "群 id",
"type": "string"
},
"wxid": {
"description": "wxid",
"type": "string"
}
}
},
"wcferry.PathMsg": {
"type": "object",
"properties": {
"path": {
"description": "要发送的图片的路径",
"type": "string"
},
"receiver": {
"description": "消息接收人",
"type": "string"
}
}
},
"wcferry.RichText": {
"type": "object",
"properties": {
"account": {
"description": "公众号 id",
"type": "string"
},
"digest": {
"description": "摘要",
"type": "string"
},
"name": {
"description": "显示名字",
"type": "string"
},
"receiver": {
"description": "接收人",
"type": "string"
},
"thumburl": {
"description": "缩略图",
"type": "string"
},
"title": {
"description": "标题",
"type": "string"
},
"url": {
"description": "链接",
"type": "string"
}
}
},
"wcferry.RpcContact": {
"type": "object",
"properties": {
"city": {
"description": "城市",
"type": "string"
},
"code": {
"description": "微信号",
"type": "string"
},
"country": {
"description": "国家",
"type": "string"
},
"gender": {
"description": "性别",
"type": "integer"
},
"name": {
"description": "微信昵称",
"type": "string"
},
"province": {
"description": "省/州",
"type": "string"
},
"remark": {
"description": "备注",
"type": "string"
},
"wxid": {
"description": "微信 id",
"type": "string"
}
}
},
"wcferry.TextMsg": {
"type": "object",
"properties": {
"aters": {
"description": "要@的人列表，逗号分隔",
"type": "string"
},
"msg": {
"description": "要发送的消息内容",
"type": "string"
},
"receiver": {
"description": "消息接收人，当为群时可@",
"type": "string"
}
}
},
"wcferry.Transfer": {
"type": "object",
"properties": {
"taid": {
"description": "Transaction id",
"type": "string"
},
"tfid": {
"description": "转账id transferid",
"type": "string"
},
"wxid": {
"description": "转账人",
"type": "string"
}
}
},
"wcferry.UserInfo": {
"type": "object",
"properties": {
"home": {
"description": "文件/图片等父路径",
"type": "string"
},
"mobile": {
"description": "手机号",
"type": "string"
},
"name": {
"description": "昵称",
"type": "string"
},
"wxid": {
"description": "微信ID",
"type": "string"
}
}
},
"wcferry.Verification": {
"type": "object",
"properties": {
"scene": {
"description": "添加方式：17 名片，30 扫码",
"type": "integer"
},
"v3": {
"description": "加密的用户名",
"type": "string"
},
"v4": {
"description": "Ticket",
"type": "string"
}
}
},
"wcfrest.DbSqlQueryRequest": {
"type": "object",
"properties": {
"db": {
"type": "string"
},
"sql": {
"type": "string"
}
}
},
"wcfrest.DownloadAttachRequest": {
"type": "object",
"properties": {
"extra": {
"type": "string"
},
"msgid": {
"type": "integer"
},
"thumb": {
"type": "string"
}
}
},
"wcfrest.DownloadImageRequest": {
"type": "object",
"properties": {
"dir": {
"type": "string"
},
"extra": {
"type": "string"
},
"msgid": {
"type": "integer"
},
"timeout": {
"type": "integer"
}
}
},
"wcfrest.GetAudioMsgRequest": {
"type": "object",
"properties": {
"msgid": {
"type": "integer"
},
"path": {
"type": "string"
},
"timeout": {
"type": "integer"
}
}
},
"wcfrest.GetOcrRequest": {
"type": "object",
"properties": {
"extra": {
"type": "string"
},
"timeout": {
"type": "integer"
}
}
},
Fix db_query field value to string
2024-01-12 09:02:19 +08:00
"wcfrest.ReceiverRequest": {
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
},
Add go http client
2023-12-17 13:16:15 +08:00
"wcfrest.RespPayload": {
"type": "object",
"properties": {
"error": {},
"result": {
"type": "string"
},
"success": {
"type": "boolean"
}
}
}
}
}
Reference in New Issue Copy Permalink