{ "schemes": ["https"], "swagger": "2.0", "info": { "description": "wekeapi API 文档", "title": "wekeapi API 文档", "contact": {}, "license": { "name": "Apache 2.0" }, "version": "1.0" }, "host": "api.wekeapi.com", "basePath": "/api/", "paths": { "/v1/chatroom/addChatroomAdmin": { "post": { "description": "添加群管理员，只有群主有权限操作", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "添加管理员", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.addChatroomAdminRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/addMember": { "post": { "description": "添加微信好友加入群聊", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "添加成员进群", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.addMemberRequest" } } ], "responses": { "0": { "description": "成功添加的群成员wxid列表", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } } } } ] } } } } }, "/v1/chatroom/addMemberToContact": { "post": { "description": "添加群成员为好友", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "添加群成员为好友", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.addMemberToContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/chatroom.chatroomMemberDetailInfo" } } } } ] } } } } }, "/v1/chatroom/agreeToJoinChatroom": { "post": { "description": "同意加入群聊", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "同意进群", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.agreeToJoinChatroomRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/chatroom.joinChatroomResponse" } } } ] } } } } }, "/v1/chatroom/approveAddMember": { "post": { "description": "开启群聊邀请确认后，群主或群管理员同意群成员邀请其他成员进群的申请。必须是群主或群管理员才能操作", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "同意邀请进群申请", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.approveAddChatroomMemberRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/createChatroom": { "post": { "description": "创建新的微信群", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "创建微信群", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.createChatroomRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/chatroom.createChatroomResponse" } } } ] } } } } }, "/v1/chatroom/deleteChatroomAdmin": { "post": { "description": "移除群管理员，只有群主有权限操作", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "移除管理员", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.deleteChatroomAdminRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/deleteMember": { "post": { "description": "将成员移出群，必须是群主或群管理员才能操作", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "移除群成员", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.delMemberRequest" } } ], "responses": { "0": { "description": "成功移出的群成员wxid列表", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } } } } ] } } } } }, "/v1/chatroom/dismissChatroom": { "post": { "description": "解散群聊，只有群主有权限操作", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "解散群聊", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.dismissChatroomRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/getChatroomAnnouncement": { "post": { "description": "获取群公告", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "获取群公告", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.getChatroomAnnouncementRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/chatroom.getChatroomAnnouncementResponse" } } } ] } } } } }, "/v1/chatroom/getChatroomMemberDetail": { "post": { "description": "获取群成员详情；此接口仅支持获取群内微信成员详情；企微成员可直接调用通讯录模块的”获取企微好友信息“接口进行获取", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "获取群成员详情", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.getChatroomMemberDetailRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/chatroom.chatroomMemberDetailInfo" } } } } ] } } } } }, "/v1/chatroom/getChatroomMemberList": { "post": { "description": "获取群成员列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "获取群成员列表", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.getChatroomMemberListRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/chatroom.getChatroomMemberListResponse" } } } ] } } } } }, "/v1/chatroom/getChatroomQrCode": { "post": { "description": "获取群二维码", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "获取群二维码", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.getChatroomQrCodeRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/chatroom.getChatroomQrCodeResponse" } } } ] } } } } }, "/v1/chatroom/inviteMember": { "post": { "description": "邀请微信好友加入群聊", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "邀请成员进群", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.inviteMemberRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/joinChatroomWithQrCode": { "post": { "description": "扫二维码进群", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "扫码进群", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.joinChatroomWithQrCodeRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/chatroom.joinChatroomResponse" } } } ] } } } } }, "/v1/chatroom/modifyChatroomName": { "post": { "description": "修改群名称", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "修改群名称", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.modifyChatroomNameRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/modifyChatroomRemark": { "post": { "description": "修改群备注", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "修改群备注", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.modifyChatroomRemarkRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/modifyNickNameInChatroom": { "post": { "description": "修改我在群内的昵称", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "修改群内昵称", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.modifyNickNameInChatroomRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/quitChatroom": { "post": { "description": "退出群聊", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "退出群聊", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.quitChatroomRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/removeFromContact": { "post": { "description": "从通讯录移除群", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "从通讯录移除群", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.removeFromContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/saveToContact": { "post": { "description": "保存群到通讯录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "保存群到通讯录", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.saveToContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/sendPat": { "post": { "description": "群拍一拍；请求发出后对方会在5秒后收到", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "群拍一拍", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.sendPatRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/setChatroomAnnouncement": { "post": { "description": "设置群公告", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "设置群公告", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.setChatroomAnnouncementRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/setInviteVerify": { "post": { "description": "开启/关闭群聊邀请确认", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "设置群聊邀请确认", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.setInviteVerifyRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/chatroom/transferChatroomOwner": { "post": { "description": "将群主管理权转让给其他群成员，只有群主有权限操作", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群聊" ], "summary": "转让群主", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/chatroom.transferChatroomOwnerRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/contact/addContact": { "post": { "description": "- 主动添加好友；好友添加成功后，会通过回调消息推送一条包含V3的消息，可用于判断好友是否添加成功\n- 本接口建议在线3天后再进行调用", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "添加好友", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.addContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/contact.addContactResponse" } } } ] } } } } }, "/v1/contact/addQWContact": { "post": { "description": "- 申请添加企微联系人为好友", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "添加企微好友", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.addQWContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/contact/deleteContact": { "post": { "description": "删除好友", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "删除好友", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.deleteContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/contact/deleteQWContact": { "post": { "description": "删除企微好友", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "删除企微好友", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.deleteQWContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/contact/fetchContactList": { "post": { "description": "- 获取微信通讯录列表，包括好友、微信群和关注的公众号，只返回ID\n- 本接口返回的群聊仅为保存到通讯录中的群聊；未保存通讯录的群，需要根据消息推送自行判断并保存\n- 微信通讯录同步耗时较长，账号登录后，平台会自动进行一次同步并缓存，本接口是从缓存中获取。如果遇到“通讯录同步进行中”错误，请等待一定时间后再次调用", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "获取通讯录列表", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.fetchContactListRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/contact.fetchContactListResponse" } } } ] } } } } }, "/v1/contact/fetchQWContactList": { "post": { "description": "获取企微好友列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "获取企微好友列表", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.fetchQWContactListRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/contact.qwContactInfo" } } } } ] } } } } }, "/v1/contact/getBriefInfo": { "post": { "description": "- 批量获取联系人/群/公众号的简要信息\n- 本接口也是从缓存中获取。如果遇到“通讯录同步进行中”错误，请等待一定时间后再次调用", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "获取联系人/群/公众号简要信息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.getBriefInfoRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/contact.contactBriefInfo" } } } } ] } } } } }, "/v1/contact/getDetailInfo": { "post": { "description": "批量获取联系人/群/公众号详细信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "获取联系人/群/公众号详细信息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.getDetailInfoRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/contact.contactDetailInfo" } } } } ] } } } } }, "/v1/contact/getMobileContact": { "post": { "description": "获取手机通讯录里的微信好友", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "获取手机通讯录好友", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.getMobileContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/contact.mobileContactInfo" } } } } ] } } } } }, "/v1/contact/getQWContactInfo": { "post": { "description": "批量获取企微好友信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "获取企微好友信息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.getQWContactInfoRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/contact.qwContactInfo" } } } } ] } } } } }, "/v1/contact/searchContact": { "post": { "description": "搜索微信联系人；搜索结果可在“添加好友”接口中使用；搜索的联系人如果已经是好友，响应结果中的V3则为好友的wxid", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "搜索联系人", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.searchContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/contact.searchContactResponse" } } } ] } } } } }, "/v1/contact/searchQWContact": { "post": { "description": "搜索企微微信联系人；搜索结果可在“添加企微联系人”接口中使用", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "搜索企微联系人", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.searchQWContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/contact.searchQWContactResponse" } } } ] } } } } }, "/v1/contact/setContactPermission": { "post": { "description": "设置好友是否仅聊天", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "设置好友仅聊天", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.setContactPermissionRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/contact/setContactRemark": { "post": { "description": "设置好友备注信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "设置好友备注", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.setContactRemarkRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/contact/setQWContactRemark": { "post": { "description": "设置企微好友的备注信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "设置企微好友设置备注", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.setQWContactRemarkRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/contact/updateContactList": { "post": { "description": "- 本接口会启动微信通讯录的同步，并更新本地缓存；相当于强制更新微信通讯录到平台\n- 如果遇到微信的新联系人在群平台没有更新，可以调用本接口强制更新", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "更新通讯录列表", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.updateContactListRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/contact/uploadMobileContact": { "post": { "description": "- 上传手机通讯录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "上传手机通讯录", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.uploadMobileContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/contact/verifyContact": { "post": { "description": "同意好友添加申请；好友发送添加申请后，会收到一条回调消息，从回调中获取请求参数", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通讯录" ], "summary": "同意添加好友", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/contact.verifyContactRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/label/addLabel": { "post": { "description": "添加微信标签", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "标签" ], "summary": "添加标签", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/label.addLabelRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/label.labelPair" } } } } ] } } } } }, "/v1/label/deleteLabel": { "post": { "description": "删除微信标签", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "标签" ], "summary": "删除标签", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/label.delLabelRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/label/fetchLabelList": { "post": { "description": "获取微信标签列表；手机上增删标签不会自动同步到平台，如果在手机上加了新标签，请主动调用此接口进行同步", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "标签" ], "summary": "获取标签列表", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/label.fetchLabelListRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/label.labelPair" } } } } ] } } } } }, "/v1/label/modifyFriendLabel": { "post": { "description": "修改好友的微信标签；修改时，请将所有微信标签放在请求里一起提交", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "标签" ], "summary": "修改好友标签", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/label.modifyFriendLabelRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/login/checkLogin": { "post": { "description": "- 获取登录二维码后，定时调用本接口检测用户扫码登录结果，推荐定时时间间隔3秒，确定登录成功或失败后结束调用\n- 返回结果中的扫码状态：0-未扫码，1-已扫码未登录，2-已登录，3-扫码已失效，10-已扫码需要验证\n- 新设备登录平台，次日凌晨可能会掉线一次；重新登录时需传已有appId获取登录二维码，登录成功后则可以长期在线\n- 登录成功后请记录appId与wxid的对应关系，后续接口中会用到", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "登录" ], "summary": "检测扫码结果", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/login.checkLoginQrCodeRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/login.checkLoginQrCodeResponse" } } } ] } } } } }, "/v1/login/checkOnlineStatus": { "post": { "description": "- 调用本接口可以检查账号在线状态\n- 如果设置自动登录，检测到掉线会尝试自动重连，然后返回重连后的在线状态；可用于账号状态的日常巡检", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "登录" ], "summary": "检查在线状态", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/login.checkOnlineStatusRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/login.checkOnlineStatusResponse" } } } ] } } } } }, "/v1/login/dialogLogin": { "post": { "description": "- 账号在手机端、或通过 API 主动退出登录，再次登录时可调用此接口，不用扫码，只需在手机弹出页面上点击确认登录\n- 调用本接口后，使用响应中的QrCodeUUID，定时调用“检测扫码结果”接口获取登录结果，同扫码登录后的检测过程\n- 如果调用接口失败，则需重新走获取登录二维码、扫码登录、检测扫码状态的流程\n- 以下情况无法使用本接口登录：新设备登录后掉线、官方风控下线等被动退出登录的场景", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "登录" ], "summary": "快捷登录", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/login.dialogLoginRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/login.dialogLoginResponse" } } } ] } } } } }, "/v1/login/getLoginQrCode": { "post": { "description": "- 绑定微信账号的第一步，调用此接口获取登录二维码；将获取的二维码展示给用户，由用户使用手机微信扫码登录\n- 用户扫码登录期间，定时调用“检测扫码结果”接口获取扫码结果；推荐定时时间间隔5秒\n- appId相当于设备ID，新账号第一次获取登录二维码，appId传空，系统会自动生成，请做好记录\n- 账号退出登录或掉线后再次获取登录二维码，务必使用上次登录的appId；否则会作为新设备登录，容易触发风控", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "登录" ], "summary": "获取登录二维码", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/login.getLoginQrCodeRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/login.getLoginQrCodeResponse" } } } ] } } } } }, "/v1/login/logout": { "post": { "description": "主动退出登录状态", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "登录" ], "summary": "退出登录", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/login.logoutRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/message/downloadCdn": { "post": { "description": "- 如果没有回调消息的xml，但是有CDN返回的FileId、AesKey和文件大小，可以使用本接口下载\n- 支持下载图片、视频和文件；响应中不包含视频的播放时长和文件名等信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "CDN下载", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.cdnDownloadRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.cdnDownloadResponse" } } } ] } } } } }, "/v1/message/downloadEmoji": { "post": { "description": "使用接收Emoji（表情动画）消息中的xml下载Emoji", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "下载Emoji", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.emojiDownloadRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.emojiDownloadResponse" } } } ] } } } } }, "/v1/message/downloadFile": { "post": { "description": "使用接收文件消息中的xml下载文件（xml中type=6的消息，文件发送完成）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "下载文件", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.fileDownloadRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.fileDownloadResponse" } } } ] } } } } }, "/v1/message/downloadImage": { "post": { "description": "- 使用接收图片消息中的xml下载原图、常规图片和缩略图\n- 如果不存在该规格的图片，会返回 -33: 无对应资源", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "下载图片", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.imageDownloadRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.imageDownloadResponse" } } } ] } } } } }, "/v1/message/downloadVideo": { "post": { "description": "- 使用接收视频消息中的xml下载原视频、常规视频或缩略图\n- 如果不存在该规格的视频，会返回 -33: 无对应资源", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "下载视频", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.videoDownloadRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.videoDownloadResponse" } } } ] } } } } }, "/v1/message/downloadVoice": { "post": { "description": "- 使用接收语音消息中的xml下载语音文件\n- 支持返回原格式(SILK)或WAV格式", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "下载语音", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.voiceDownloadRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.voiceDownloadResponse" } } } ] } } } } }, "/v1/message/forwardFile": { "post": { "description": "使用发送文件后的响应转发文件消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "转发文件", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.forwardFileRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/forwardFileMsg": { "post": { "description": "使用接收文件消息中的xml转发文件消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "转发文件消息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.forwardFileMessageRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/forwardImage": { "post": { "description": "使用发送图片后的响应转发图片", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "转发图片", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.forwardImageRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/forwardImageMsg": { "post": { "description": "使用接收图片消息中的xml转发图片消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "转发图片消息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.forwardImageMessageRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/forwardLink": { "post": { "description": "使用发送链接后的响应转发链接消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "转发链接", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.forwardLinkRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/forwardLinkMsg": { "post": { "description": "使用接收链接消息中的xml转发链接消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "转发链接消息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.forwardLinkMessageRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/forwardMiniApp": { "post": { "description": "使用接收到的小程序消息中的xml信息转发该小程序", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "转发小程序消息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.forwardMiniAppRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/forwardVideo": { "post": { "description": "使用发送视频后的响应转发视频", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "转发视频", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.forwardVideoRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/forwardVideoMsg": { "post": { "description": "使用接收视频消息中的xml转发视频消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "转发视频消息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.forwardVideoMessageRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/revokeMsg": { "post": { "description": "撤回已发送的消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "撤回消息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.revokeMessageRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } }, "/v1/message/sendAppMsg": { "post": { "description": "- 可用于发送所有包含节点的消息，如视频号、聊天记录、音乐分享等；使用消息中xml进行发送\n- 如提供原消息OriMsgId/OriMsgFrom/OriMsgTo/OriMsgSource相关参数，将按转发进行发送", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送AppMsg消息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendAppMsgRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/sendEmoji": { "post": { "description": "发送Emoji消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送Emoji", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendEmojiRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/sendFile": { "post": { "description": "- 发送视频消息，支持传入文件数据和文件URL两种方式\n- 如果同一个文件发送给多人，请在使用本接口发送给第一人之后，使用转发文件接口继续发送，可以显著提高发送效率", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送文件", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendFileRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.sendFileResponse" } } } ] } } } } }, "/v1/message/sendImage": { "post": { "description": "- 发送图片消息，支持传入图片数据和图片URL两种方式\n- 如果同一张图片发送给多人，请在使用本接口发送给第一人之后，使用转发图片接口继续发送，可以显著提高发送效率\n- 发送图片支持jpg/png/bmp/webp/tiff格式，其他格式会返回 -30: 不支持的格式", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送图片", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendImageRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.sendImageResponse" } } } ] } } } } }, "/v1/message/sendLink": { "post": { "description": "- 提供链接的标题、描述、链接地址和缩略图，发送链接消息\n- 如果同一个链接发送给多人，请在使用本接口发送给第一人之后，使用转发链接接口继续发送，可以显著提高发送效率", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送链接", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendLinkRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.sendLinkResponse" } } } ] } } } } }, "/v1/message/sendMiniApp": { "post": { "description": "发送小程序消息；先将该小程序消息发送给自己，然后使用接收消息中的xml信息发送该小程序", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送小程序消息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendMiniAppRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/sendNameCard": { "post": { "description": "发送名片消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送名片", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendNameCardMessageRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/sendText": { "post": { "description": "给好友或群聊发送文本消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送文本", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendTextRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/message/sendVideo": { "post": { "description": "- 发送视频消息，支持传入视频数据和视频URL两种方式\n- 如果同一个视频发送给多人，请在使用本接口发送给第一人之后，使用转发视频接口继续发送，可以显著提高发送效率", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送视频", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendVideoRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.sendVideoResponse" } } } ] } } } } }, "/v1/message/sendVoice": { "post": { "description": "发送语音消息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "消息" ], "summary": "发送语音", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/message.sendVoiceRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/message.baseMessageResponse" } } } ] } } } } }, "/v1/proxy/getProxy": { "post": { "description": "获取某个设备当前代理信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "代理" ], "summary": "获取代理信息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proxy.getProxyInfoRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/proxy.getProxyInfoResponse" } } } ] } } } } }, "/v1/proxy/setProxy": { "post": { "description": "- 设置某个设备的代理；代理与之前不同，相当于修改代理；代理为空，相当于删除代理\n- 如果设备上登录的账号当前在线，新代理立即生效；不在线，则等下次登录或重连后生效\n- 如果新代理网络不通，会返回 -51: 网络连接异常", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "代理" ], "summary": "设置代理信息", "parameters": [ { "type": "string", "description": "访问凭证 AccessToken", "name": "X-Access-Token", "in": "header", "required": true }, { "description": "请求体", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/proxy.setProxyInfoRequest" } } ], "responses": { "0": { "description": "", "schema": { "allOf": [ { "$ref": "#/definitions/response.ResponseData" }, { "type": "object", "properties": { "data": { "type": "boolean" } } } ] } } } } } }, "definitions": { "chatroom.addChatroomAdminRequest": { "type": "object", "required": [ "appId", "chatroomId", "wxids" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "wxids": { "description": "待添加为管理员的wxid列表，格式为字符串数组，最多可以添加3个管理员", "type": "array", "items": { "type": "string" } } } }, "chatroom.addMemberRequest": { "type": "object", "required": [ "appId", "chatroomId", "wxids" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "wxids": { "description": "添加成员wxid列表，格式为字符串数组", "type": "array", "items": { "type": "string" } } } }, "chatroom.addMemberToContactRequest": { "type": "object", "required": [ "appId", "chatroomId", "memberWxid", "verifyContent" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "memberWxid": { "description": "待添加的群成员wxid", "type": "string" }, "verifyContent": { "description": "添加好友时的招呼语(验证信息)", "type": "string", "example": "hello" } } }, "chatroom.agreeToJoinChatroomRequest": { "type": "object", "required": [ "appId", "url" ], "properties": { "appId": { "type": "string" }, "url": { "description": "邀请进群回调消息中的URL", "type": "string" } } }, "chatroom.approveAddChatroomMemberRequest": { "type": "object", "required": [ "appId", "msgBase64", "newMsgId" ], "properties": { "appId": { "type": "string" }, "msgBase64": { "description": "邀请进群回调消息中xml的Base64编码", "type": "string" }, "newMsgId": { "description": "邀请进群回调消息的newMsgId", "type": "integer" } } }, "chatroom.chatroomMemberDetailInfo": { "type": "object", "properties": { "alias": { "description": "微信别名，即自定义微信号", "type": "string", "example": "wekeapi" }, "city": { "description": "所在城市", "type": "string" }, "country": { "description": "所在国家", "type": "string" }, "hasWeiXinHdHeadImg": { "description": "是否有大尺寸头像", "type": "integer" }, "headImgBig": { "description": "大尺寸头像图片", "type": "string" }, "headImgSmall": { "description": "小尺寸头像图片", "type": "string" }, "inviterWxid": { "description": "入群邀请人微信号", "type": "string" }, "nickName": { "description": "昵称", "type": "string", "example": "weke" }, "nickNameJianPin": { "description": "昵称的拼音简拼", "type": "string", "example": "weke" }, "nickNameQuanPin": { "description": "昵称的拼音全拼", "type": "string", "example": "weke" }, "phoneNumList": { "description": "手机号列表", "type": "array", "items": { "type": "string" } }, "province": { "description": "所在省份", "type": "string" }, "remark": { "description": "备注", "type": "string" }, "remarkJianPin": { "description": "备注的拼音简拼", "type": "string" }, "remarkQuanPin": { "description": "备注的拼音全拼", "type": "string" }, "sex": { "description": "性别", "type": "integer", "example": 1 }, "signature": { "description": "群成员的签名", "type": "string" }, "v3": { "description": "V3信息，添加好友时要用到", "type": "string" }, "v4": { "description": "V4信息，添加好友时要用到", "type": "string" }, "wxid": { "description": "原始微信号", "type": "string", "example": "wxid_9whjih398kqp22" } } }, "chatroom.chatroomMemberInfo": { "type": "object", "properties": { "displayName": { "description": "群成员在群里显示的昵称", "type": "string", "example": "weke" }, "headImgBig": { "description": "大尺寸头像图片", "type": "string" }, "headImgSmall": { "description": "小尺寸头像图片", "type": "string" }, "inviterWxid": { "description": "入群邀请人微信号", "type": "string" }, "nickName": { "description": "群成员昵称", "type": "string", "example": "weke" }, "wxid": { "description": "群成员微信号", "type": "string", "example": "wxid_9whjih398kqp22" } } }, "chatroom.createChatroomRequest": { "type": "object", "required": [ "appId", "wxids" ], "properties": { "appId": { "type": "string" }, "wxids": { "description": "群成员wxid列表，至少有两个", "type": "array", "items": { "type": "string" } } } }, "chatroom.createChatroomResponse": { "type": "object", "properties": { "chatroomId": { "description": "新建群的ID", "type": "string", "example": "xxx@chatroom" }, "headImgData": { "description": "base64编码的群头像图片数据", "type": "string", "example": "data:image/jpg;base64,\u003cbase64_data\u003e" } } }, "chatroom.delMemberRequest": { "type": "object", "required": [ "appId", "chatroomId", "wxids" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "wxids": { "description": "删除成员wxid列表，格式为字符串数组", "type": "array", "items": { "type": "string" } } } }, "chatroom.deleteChatroomAdminRequest": { "type": "object", "required": [ "appId", "chatroomId", "wxids" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "wxids": { "description": "待删除管理员的wxid列表，格式为字符串数组，最多可以删除3个管理员", "type": "array", "items": { "type": "string" } } } }, "chatroom.dismissChatroomRequest": { "type": "object", "required": [ "appId", "chatroomId" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" } } }, "chatroom.getChatroomAnnouncementRequest": { "type": "object", "required": [ "appId", "chatroomId" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" } } }, "chatroom.getChatroomAnnouncementResponse": { "type": "object", "properties": { "announcement": { "description": "群公告", "type": "string", "example": "通知" }, "announcementEditor": { "description": "群公告发布人Wxid", "type": "string", "example": "wxid_9whjih398kqp22" }, "announcementTime": { "description": "群公告发布时间", "type": "string", "example": "2025-03-01 10:18:18" } } }, "chatroom.getChatroomMemberDetailRequest": { "type": "object", "required": [ "appId", "chatroomId", "memberWxids" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "memberWxids": { "description": "群成员wxid列表，格式为字符串数组", "type": "array", "items": { "type": "string" } } } }, "chatroom.getChatroomMemberListRequest": { "type": "object", "required": [ "appId", "chatroomId" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" } } }, "chatroom.getChatroomMemberListResponse": { "type": "object", "properties": { "chatroomAdmin": { "description": "群管理员列表", "type": "array", "items": { "type": "string" } }, "chatroomOwner": { "description": "群主微信号", "type": "string" }, "memberList": { "description": "群成员列表", "type": "array", "items": { "$ref": "#/definitions/chatroom.chatroomMemberInfo" } } } }, "chatroom.getChatroomQrCodeRequest": { "type": "object", "required": [ "appId", "chatroomId" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string" } } }, "chatroom.getChatroomQrCodeResponse": { "type": "object", "properties": { "qrCodeImgData": { "description": "base64编码的二维码图片数据，可用于前端显示", "type": "string", "example": "data:image/jpg;base64,\u003cbase64_data\u003e" }, "qrCodeTips": { "description": "二维码提示信息", "type": "string" } } }, "chatroom.inviteMemberRequest": { "type": "object", "required": [ "appId", "chatroomId", "wxids" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "wxids": { "description": "邀请成员wxid列表，格式为字符串数组", "type": "array", "items": { "type": "string" } } } }, "chatroom.joinChatroomResponse": { "type": "object", "properties": { "chatroomId": { "description": "群ID", "type": "string" } } }, "chatroom.joinChatroomWithQrCodeRequest": { "type": "object", "required": [ "appId", "qrCodeInfo" ], "properties": { "appId": { "type": "string" }, "qrCodeInfo": { "description": "二维码对应的信息，即解析二维码得到的URL", "type": "string" } } }, "chatroom.modifyChatroomNameRequest": { "type": "object", "required": [ "appId", "chatroomId", "chatroomName" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "chatroomName": { "description": "新的群名称", "type": "string" } } }, "chatroom.modifyChatroomRemarkRequest": { "type": "object", "required": [ "appId", "chatroomId", "chatroomRemark" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "chatroomRemark": { "description": "新的群备注", "type": "string" } } }, "chatroom.modifyNickNameInChatroomRequest": { "type": "object", "required": [ "nickNameInChatroom", "appId", "chatroomId" ], "properties": { "nickNameInChatroom": { "description": "我在群里的昵称", "type": "string" }, "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" } } }, "chatroom.quitChatroomRequest": { "type": "object", "required": [ "appId", "chatroomId" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" } } }, "chatroom.removeFromContactRequest": { "type": "object", "required": [ "appId", "chatroomId" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "待移出通讯录的群ID", "type": "string", "example": "xxx@chatroom" } } }, "chatroom.saveToContactRequest": { "type": "object", "required": [ "appId", "chatroomId" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "待加入通讯录的群ID", "type": "string", "example": "xxx@chatroom" } } }, "chatroom.sendPatRequest": { "type": "object", "required": [ "appId", "chatroomId", "toWxid" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "toWxid": { "description": "被拍的群成员wxid", "type": "string" } } }, "chatroom.setChatroomAnnouncementRequest": { "type": "object", "required": [ "appId", "chatroomId", "content" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "content": { "description": "群公告内容", "type": "string" } } }, "chatroom.setInviteVerifyRequest": { "type": "object", "required": [ "appId", "chatroomId", "inviteVerifySet" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "inviteVerifySet": { "description": "群聊邀请确认设置：1-开启 0-关闭", "type": "integer", "enum": [ 0, 1 ] } } }, "chatroom.transferChatroomOwnerRequest": { "type": "object", "required": [ "appId", "chatroomId", "wxid" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "群ID", "type": "string", "example": "xxx@chatroom" }, "wxid": { "description": "新群主的wxid", "type": "string" } } }, "contact.addContactRequest": { "type": "object", "required": [ "appId", "scene", "v3", "v4", "verifyContent" ], "properties": { "appId": { "type": "string" }, "chatroomId": { "description": "通过群聊添加好友时群的id", "type": "string" }, "scene": { "description": "添加来源, 1-QQ 2-邮箱 3-微信号 4-QQ好友 13-通讯录 14-群聊 15-手机号 30-二维码", "type": "integer", "example": 2 }, "v3": { "description": "V3信息，通过搜索好友或获取群成员详情得到", "type": "string", "example": "V3_xxxxxx" }, "v4": { "description": "V4信息，通过搜索好友或获取群成员详情得到", "type": "string", "example": "V4_xxxxxx" }, "verifyContent": { "description": "添加好友时的招呼语(验证信息)", "type": "string", "example": "hello" } } }, "contact.addContactResponse": { "type": "object", "properties": { "username": { "description": "添加好友后返回的username；如果是V3信息，代表申请已发出，对方验证通过后的会收到包含该V3的回调消息", "type": "string" } } }, "contact.addQWContactRequest": { "type": "object", "required": [ "appId", "v1", "wxid" ], "properties": { "appId": { "type": "string" }, "v1": { "description": "v1信息，通过搜索企微联系人或获取企微信息得到", "type": "string" }, "veryfyContent": { "description": "添加好友时的招呼语(验证信息)", "type": "string" }, "wxid": { "description": "企微联系人ID，通过搜索企微联系人得到", "type": "string" } } }, "contact.chatroomMemberInfo": { "type": "object", "properties": { "nickName": { "description": "群成员昵称", "type": "string", "example": "weke" }, "wxid": { "description": "群成员微信号", "type": "string", "example": "wxid_9whjih398kqp22" } } }, "contact.contactBriefInfo": { "type": "object", "properties": { "alias": { "description": "微信别名，即自定义微信号", "type": "string", "example": "wekeapi" }, "city": { "description": "所在城市", "type": "string" }, "country": { "description": "所在国家", "type": "string" }, "hasWeiXinHdHeadImg": { "description": "是否有大尺寸头像", "type": "integer" }, "headImgBig": { "description": "大尺寸头像图片", "type": "string" }, "headImgSmall": { "description": "小尺寸头像图片", "type": "string" }, "nickName": { "description": "昵称", "type": "string", "example": "weke" }, "nickNameJianPin": { "description": "昵称的拼音简拼", "type": "string", "example": "weke" }, "nickNameQuanPin": { "description": "昵称的拼音全拼", "type": "string", "example": "weke" }, "province": { "description": "所在省份", "type": "string" }, "remark": { "description": "备注", "type": "string" }, "sex": { "description": "性别", "type": "integer", "example": 1 }, "wxid": { "description": "原始微信号", "type": "string", "example": "wxid_9whjih398kqp22" } } }, "contact.contactDetailInfo": { "type": "object", "properties": { "alias": { "description": "微信别名，即自定义微信号", "type": "string", "example": "wekeapi" }, "chatroomMemberList": { "type": "array", "items": { "$ref": "#/definitions/contact.chatroomMemberInfo" } }, "city": { "description": "所在城市", "type": "string" }, "country": { "description": "所在国家", "type": "string" }, "hasWeiXinHdHeadImg": { "description": "是否有大尺寸头像", "type": "integer" }, "headImgBig": { "description": "大尺寸头像图片", "type": "string" }, "headImgSmall": { "description": "小尺寸头像图片", "type": "string" }, "labelList": { "description": "好友的标签ID列表，英文逗号分隔", "type": "string" }, "nickName": { "description": "昵称", "type": "string", "example": "weke" }, "nickNameJianPin": { "description": "昵称的拼音简拼", "type": "string", "example": "weke" }, "nickNameQuanPin": { "description": "昵称的拼音全拼", "type": "string", "example": "weke" }, "province": { "description": "所在省份", "type": "string" }, "remark": { "description": "备注", "type": "string" }, "remarkJianPin": { "description": "备注的拼音简拼", "type": "string" }, "remarkQuanPin": { "description": "备注的拼音全拼", "type": "string" }, "sex": { "description": "性别", "type": "integer", "example": 1 }, "signature": { "description": "好友的签名", "type": "string" }, "wxid": { "description": "原始微信号", "type": "string", "example": "wxid_9whjih398kqp22" } } }, "contact.deleteContactRequest": { "type": "object", "required": [ "appId", "wxid" ], "properties": { "appId": { "type": "string" }, "wxid": { "description": "待删除好友的wxid", "type": "string" } } }, "contact.deleteQWContactRequest": { "type": "object", "required": [ "appId", "wxid" ], "properties": { "appId": { "type": "string" }, "wxid": { "description": "待删除企微好友的wxid", "type": "string" } } }, "contact.fetchContactListRequest": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string" }, "contactType": { "description": "联系人类型：0-全部 1-好友 2-群 3-公众号", "type": "integer", "enum": [ 0, 1, 2, 3 ] } } }, "contact.fetchContactListResponse": { "type": "object", "properties": { "chatrooms": { "description": "保存在通讯录的群ID", "type": "array", "items": { "type": "string" } }, "friends": { "description": "通讯录好友wxid", "type": "array", "items": { "type": "string" } }, "ghs": { "description": "关注的公众号ID", "type": "array", "items": { "type": "string" } } } }, "contact.fetchQWContactListRequest": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string" } } }, "contact.getBriefInfoRequest": { "type": "object", "required": [ "appId", "wxids" ], "properties": { "appId": { "type": "string" }, "wxids": { "description": "联系人或群id列表，格式为字符串数组", "type": "array", "items": { "type": "string" } } } }, "contact.getDetailInfoRequest": { "type": "object", "required": [ "appId", "wxids" ], "properties": { "appId": { "type": "string" }, "wxids": { "description": "联系人、群或公众号id列表，一次最多传10个，格式为字符串数组", "type": "array", "items": { "type": "string" } } } }, "contact.getMobileContactRequest": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string" } } }, "contact.getQWContactInfoRequest": { "type": "object", "required": [ "appId", "wxids" ], "properties": { "appId": { "type": "string" }, "wxids": { "description": "企微好友id列表，格式为字符串数组", "type": "array", "items": { "type": "string" } } } }, "contact.mobileContactInfo": { "type": "object", "properties": { "HeadImgbig": { "description": "大尺寸头像", "type": "string" }, "HeadImgsmall": { "description": "小尺寸头像", "type": "string" }, "mobileMD5": { "description": "手机号MD5", "type": "string" }, "nickname": { "description": "好友的昵称", "type": "string" }, "sex": { "description": "性别", "type": "integer" }, "wxid": { "description": "好友的微信号", "type": "string" } } }, "contact.qwContactInfo": { "type": "object", "properties": { "enterpriseFullName": { "description": "企业全名", "type": "string" }, "enterpriseId": { "description": "企业ID", "type": "string" }, "enterpriseName": { "description": "企业名称", "type": "string" }, "headImgBig": { "description": "大尺寸头像图片", "type": "string" }, "headImgSmall": { "description": "小尺寸头像图片", "type": "string" }, "nickName": { "description": "昵称", "type": "string", "example": "weke" }, "nickNameJianPin": { "description": "昵称的拼音简拼", "type": "string", "example": "weke" }, "nickNameQuanPin": { "description": "昵称的拼音全拼", "type": "string", "example": "weke" }, "remark": { "description": "备注", "type": "string" }, "remarkJianPin": { "description": "备注的拼音简拼", "type": "string" }, "remarkQuanPin": { "description": "备注的拼音全拼", "type": "string" }, "sex": { "description": "性别", "type": "integer", "example": 1 }, "userName": { "description": "企微号", "type": "string", "example": "xxx@openim" }, "v1": { "description": "V1信息，后续添加好友时要用到", "type": "string", "example": "v1_xxxx" } } }, "contact.searchContactRequest": { "type": "object", "required": [ "appId", "contactInfo" ], "properties": { "appId": { "type": "string" }, "contactInfo": { "description": "待搜索的联系人信息，微信号、QQ号、手机号等", "type": "string" } } }, "contact.searchContactResponse": { "type": "object", "properties": { "HeadImgbig": { "description": "大尺寸头像", "type": "string" }, "HeadImgsmall": { "description": "小尺寸头像", "type": "string" }, "nickname": { "description": "好友的昵称", "type": "string" }, "sex": { "description": "性别", "type": "integer" }, "signature": { "description": "好友的签名", "type": "string" }, "v3": { "description": "V3信息，添加好友时要用到", "type": "string" }, "v4": { "description": "V4信息，添加好友时要用到", "type": "string" } } }, "contact.searchQWContactRequest": { "type": "object", "required": [ "appId", "contactInfo" ], "properties": { "appId": { "type": "string" }, "contactInfo": { "description": "待搜索的企微联系人信息，支持手机号和企微联系人的二维码解码后的信息", "type": "string" } } }, "contact.searchQWContactResponse": { "type": "object", "properties": { "HeadImgbig": { "description": "大尺寸头像", "type": "string" }, "HeadImgsmall": { "description": "小尺寸头像", "type": "string" }, "nickname": { "description": "企微联系人昵称", "type": "string" }, "sex": { "description": "性别", "type": "integer" }, "v1": { "description": "V1信息，后续添加好友时要用到", "type": "string" }, "wxid": { "description": "企微联系人ID", "type": "string" } } }, "contact.setContactPermissionRequest": { "type": "object", "required": [ "appId", "onlyChat", "wxid" ], "properties": { "appId": { "type": "string" }, "onlyChat": { "description": "是否仅聊天", "type": "boolean" }, "wxid": { "description": "好友微信号", "type": "string" } } }, "contact.setContactRemarkRequest": { "type": "object", "required": [ "appId", "remark", "wxid" ], "properties": { "appId": { "type": "string" }, "remark": { "description": "待设置的备注", "type": "string" }, "wxid": { "description": "好友微信号", "type": "string" } } }, "contact.setQWContactRemarkRequest": { "type": "object", "required": [ "appId", "remark", "wxid" ], "properties": { "appId": { "type": "string" }, "remark": { "description": "待设置的企微好友备注", "type": "string" }, "wxid": { "description": "企微好友ID", "type": "string" } } }, "contact.updateContactListRequest": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string" } } }, "contact.uploadMobileContactRequest": { "type": "object", "required": [ "appId", "mobiles", "opCode" ], "properties": { "appId": { "type": "string" }, "mobiles": { "description": "待操作的手机号列表", "type": "array", "items": { "type": "string" } }, "opCode": { "description": "操作类型：1-上传 2-删除", "type": "integer", "enum": [ 1, 2 ] } } }, "contact.verifyContactRequest": { "type": "object", "required": [ "appId", "msgBase64" ], "properties": { "appId": { "type": "string" }, "msgBase64": { "description": "好友添加申请回调消息中xml的Base64编码", "type": "string" } } }, "label.addLabelRequest": { "type": "object", "required": [ "appId", "labels" ], "properties": { "appId": { "type": "string" }, "labels": { "description": "新增标签列表，格式为字符串数组", "type": "array", "items": { "type": "string" } } } }, "label.delLabelRequest": { "type": "object", "required": [ "appId", "labelId" ], "properties": { "appId": { "type": "string" }, "labelId": { "description": "待删除的标签ID", "type": "integer", "example": 1 } } }, "label.fetchLabelListRequest": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string" } } }, "label.labelPair": { "type": "object", "properties": { "labelId": { "description": "标签ID", "type": "integer", "example": 1 }, "labelName": { "description": "标签名称", "type": "string", "example": "客户" } } }, "label.modifyFriendLabelRequest": { "type": "object", "required": [ "appId", "labelIds", "wxid" ], "properties": { "appId": { "type": "string" }, "labelIds": { "description": "该好友的所有标签，格式为int数组", "type": "array", "items": { "type": "integer" } }, "wxid": { "description": "待修改好友的wxid", "type": "string" } } }, "login.checkLoginQrCodeAccountInfo": { "type": "object", "properties": { "alias": { "description": "微信别名", "type": "string" }, "mobile": { "description": "绑定的手机号", "type": "string" }, "nickname": { "description": "微信昵称", "type": "string" }, "uin": { "description": "uin", "type": "integer" }, "wxid": { "description": "微信号", "type": "string" } } }, "login.checkLoginQrCodeRequest": { "type": "object", "required": [ "appId", "qrCodeUUID" ], "properties": { "appId": { "type": "string" }, "qrCodeUUID": { "description": "二维码对应的UUID", "type": "string" } } }, "login.checkLoginQrCodeResponse": { "type": "object", "properties": { "accountInfo": { "description": "登录成功后返回的微信账号信息", "$ref": "#/definitions/login.checkLoginQrCodeAccountInfo" }, "expiration": { "description": "二维码剩余有效时间（秒）", "type": "integer", "example": 127 }, "headImgUrl": { "description": "扫码或登录微信的头像地址", "type": "string" }, "msg": { "description": "扫码状态描述信息", "type": "string" }, "nickname": { "description": "扫码或登录微信的昵称", "type": "string" }, "status": { "description": "扫码状态：0-未扫码 1-已扫码未登录 2-已登录 3-扫码已失效 10-已扫码需要验证", "type": "integer", "example": 1 }, "verifyQrCode": { "description": "base64编码的登录验证二维码，status=10时有效", "type": "string" }, "verifyQrCodeInfo": { "description": "登录验证二维码信息，status=10时有效", "type": "string" } } }, "login.checkOnlineStatusRequest": { "type": "object", "required": [ "appId", "autoConnect" ], "properties": { "appId": { "type": "string" }, "autoConnect": { "description": "如果掉线是否自动重连", "type": "boolean", "example": true } } }, "login.checkOnlineStatusResponse": { "type": "object", "properties": { "onlineStatus": { "description": "在线状态 1-在线 -1-离线 0-未登录", "type": "integer" } } }, "login.dialogLoginRequest": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string" } } }, "login.dialogLoginResponse": { "type": "object", "properties": { "appId": { "description": "系统生成的appId，再次调用返回相同appId", "type": "string" }, "qrCodeUUID": { "description": "二维码对应的UUID，检测登录状态时使用", "type": "string", "example": "Q8n9CN9Xc37qS0tglfzg" } } }, "login.getLoginQrCodeRequest": { "type": "object", "properties": { "appId": { "description": "appId代表登录微信的一台设备，第一次获取二维码时传空，系统会生成appId；再次获取二维码时必须携带已有appId，否则会被视为新设备登录", "type": "string" }, "proxy": { "description": "DeviceType string `json:\"deviceType\" validate:\"required\" enums:\"iPad,Mac\"` // 设备类型，值为：iPad/Mac\nAutoVerify bool `json:\"autoVerify\" validate:\"required\" enums:\"true,false\"` // 是否自动验证，值为：true/false；每次登录时，可先传true，登录失败再使用false继续尝试\nIsMac2iPad bool `json:\"isMac2iPad\" validate:\"required\" enums:\"true,false\"`", "type": "string", "example": "socks5://username:password@ipv4:port" } } }, "login.getLoginQrCodeResponse": { "type": "object", "properties": { "appId": { "description": "系统生成的appId，再次调用返回相同appId", "type": "string" }, "qrCodeImgData": { "description": "base64编码的二维码图片数据，可用于前端显示", "type": "string", "example": "data:image/jpg;base64,\u003cbase64_data\u003e" }, "qrCodeInfo": { "description": "二维码对应的信息，用于自行生成二维码", "type": "string", "example": "http://weixin.qq.com/x/Q8n9CN9Xc37qS0tglfzg" }, "qrCodeUUID": { "description": "二维码对应的UUID", "type": "string", "example": "Q8n9CN9Xc37qS0tglfzg" } } }, "login.logoutRequest": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string" } } }, "message.baseMessageResponse": { "type": "object", "properties": { "createTime": { "description": "消息创建时间", "type": "integer" }, "newMsgId": { "description": "消息ID", "type": "integer" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "type": { "description": "消息类型", "type": "integer" } } }, "message.cdnDownloadRequest": { "type": "object", "required": [ "aesKey", "appId", "fileId", "fileSize", "type" ], "properties": { "aesKey": { "description": "CDN返回的Aeskey", "type": "string" }, "appId": { "type": "string" }, "fileId": { "description": "CDN返回的文件ID", "type": "string" }, "fileSize": { "description": "文件大小", "type": "integer" }, "type": { "description": "下载类型：1-高清图片 2-常规图片 3-缩略图 4-视频 5-文件", "type": "integer" } } }, "message.cdnDownloadResponse": { "type": "object", "properties": { "fileExt": { "description": "文件格式", "type": "string" }, "fileUrl": { "description": "文件下载地址，7天有效", "type": "string" } } }, "message.emojiDownloadRequest": { "type": "object", "required": [ "appId", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "xmlMsgBase64": { "description": "Emoji消息中xml的Base64编码", "type": "string" } } }, "message.emojiDownloadResponse": { "type": "object", "properties": { "emojiSize": { "description": "Emoji文件大小", "type": "integer" }, "emojiUrl": { "description": "Emoji下载地址，7天有效", "type": "string" }, "fileExt": { "description": "Emoji文件格式", "type": "string" } } }, "message.fileDownloadRequest": { "type": "object", "required": [ "appId", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "xmlMsgBase64": { "description": "文件消息中xml的Base64编码", "type": "string" } } }, "message.fileDownloadResponse": { "type": "object", "properties": { "fileExt": { "description": "文件扩展名", "type": "string" }, "fileName": { "description": "文件名", "type": "string" }, "fileSize": { "description": "文件大小", "type": "integer" }, "fileUrl": { "description": "文件下载地址，7天有效", "type": "string" } } }, "message.forwardFileMessageRequest": { "type": "object", "required": [ "appId", "toWxid", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "oriMsgFrom": { "description": "原文件消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原文件消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原文件消息MsgSource的Base64", "type": "string" }, "oriMsgTo": { "description": "原文件消息接收人Wxid", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "xmlMsgBase64": { "description": "文件消息xml的Base64编码", "type": "string" } } }, "message.forwardFileRequest": { "type": "object", "required": [ "aesKey", "appId", "fileCRC", "fileId", "fileMd5", "fileName", "fileSize", "oriMsgFrom", "oriMsgId", "oriMsgSourceBase64", "oriMsgTo", "toWxid" ], "properties": { "aesKey": { "description": "原文件发送时CDN返回的Aeskey", "type": "string" }, "appId": { "type": "string" }, "fileCRC": { "description": "原文件发送时CDN返回的FileCRC", "type": "integer" }, "fileId": { "description": "原文件发送时CDN返回的文件ID", "type": "string" }, "fileMd5": { "description": "原文件发送时CDN返回的文件Md5", "type": "string" }, "fileName": { "description": "文件名，包括扩展名", "type": "string" }, "fileSize": { "description": "原文件发送时CDN返回的文件大小", "type": "integer" }, "oriMsgFrom": { "description": "原文件消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原文件消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原文件消息MsgSource的Base64", "type": "string" }, "oriMsgTo": { "description": "原文件消息接收人Wxid", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.forwardImageMessageRequest": { "type": "object", "required": [ "appId", "toWxid", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "oriMsgFrom": { "description": "原图片消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原图片消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原图片消息MsgSource的Base64", "type": "string" }, "oriMsgTo": { "description": "原图片消息接收人Wxid", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "xmlMsgBase64": { "description": "图片消息xml的Base64编码", "type": "string" } } }, "message.forwardImageRequest": { "type": "object", "required": [ "aesKey", "appId", "bigImgSize", "fileId", "fileMd5", "midImgSize", "oriMsgFrom", "oriMsgId", "oriMsgSourceBase64", "oriMsgTo", "thumbImgHeight", "thumbImgSize", "thumbImgWidth", "toWxid" ], "properties": { "aesKey": { "description": "CDN返回的Aeskey", "type": "string" }, "appId": { "type": "string" }, "bigImgSize": { "description": "CDN返回的BigImgSize", "type": "integer" }, "fileId": { "description": "CDN返回的图片Id", "type": "string" }, "fileMd5": { "description": "CDN返回的图片Md5", "type": "string" }, "midImgSize": { "description": "CDN返回的MidImgSize", "type": "integer" }, "oriMsgFrom": { "description": "原图片消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原图片消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原图片消息MsgSource的Base64", "type": "string" }, "oriMsgTo": { "description": "原图片消息接收人Wxid", "type": "string" }, "thumbImgHeight": { "description": "CDN返回的ThumbImgHeight", "type": "integer" }, "thumbImgSize": { "description": "CDN返回的ThumbImgSize", "type": "integer" }, "thumbImgWidth": { "description": "CDN返回的ThumbImgWidth", "type": "integer" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.forwardLinkMessageRequest": { "type": "object", "required": [ "appId", "toWxid", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "oriMsgFrom": { "description": "原链接消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原链接消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原链接消息msgsource的Base64", "type": "string" }, "oriMsgTo": { "description": "原链接消息接收人Wxid", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "xmlMsgBase64": { "description": "链接消息中的xml的Base64编码", "type": "string" } } }, "message.forwardLinkRequest": { "type": "object", "required": [ "ReqId", "aesKey", "appId", "linkUrl", "oriMsgFrom", "oriMsgId", "oriMsgSourceBase64", "oriMsgTo", "thumbHeight", "thumbMd5", "thumbSize", "thumbUrl", "thumbWidth", "title", "toWxid" ], "properties": { "ReqId": { "description": "ReqId", "type": "string" }, "aesKey": { "description": "CDN返回的Aeskey", "type": "string" }, "appId": { "type": "string" }, "desc": { "description": "链接显示内容", "type": "string" }, "linkUrl": { "description": "链接对应的Url", "type": "string" }, "oriMsgFrom": { "description": "原链接消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原链接消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原链接消息返回msgsource的Base64", "type": "string" }, "oriMsgTo": { "description": "原链接消息接收人Wxid", "type": "string" }, "thumbHeight": { "description": "缩略图高度", "type": "integer" }, "thumbMd5": { "description": "缩略图Md5", "type": "string" }, "thumbSize": { "description": "缩略图大小", "type": "integer" }, "thumbUrl": { "description": "CDN返回的缩略图Url", "type": "string" }, "thumbWidth": { "description": "缩略图宽度", "type": "integer" }, "title": { "description": "链接显示标题", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.forwardMiniAppRequest": { "type": "object", "required": [ "appId", "oriMsgFrom", "oriMsgId", "oriMsgSourceBase64", "oriMsgTo", "toWxid", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "oriMsgFrom": { "description": "原小程序消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原小程序消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原小程序消息msgsource的Base64", "type": "string" }, "oriMsgTo": { "description": "原小程序消息接收人Wxid", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "xmlMsgBase64": { "description": "小程序消息xml的Base64编码", "type": "string" } } }, "message.forwardVideoMessageRequest": { "type": "object", "required": [ "appId", "toWxid", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "oriMsgFrom": { "description": "原视频消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原视频消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原视频消息MsgSource的Base64", "type": "string" }, "oriMsgTo": { "description": "原视频消息接收人Wxid", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "xmlMsgBase64": { "description": "视频消息xml的Base64编码", "type": "string" } } }, "message.forwardVideoRequest": { "type": "object", "required": [ "aesKey", "appId", "crc32", "fileId", "fileMd5", "fileSize", "newMd5", "oriMsgFrom", "oriMsgId", "oriMsgSourceBase64", "oriMsgTo", "playLength", "rawAesKey", "rawFileId", "rawFileMd5", "rawFileSize", "thumbHeight", "thumbSize", "thumbWidth", "toWxid" ], "properties": { "aesKey": { "description": "CDN返回的Aeskey", "type": "string" }, "appId": { "type": "string" }, "crc32": { "description": "CDN返回的CRC32", "type": "integer" }, "fileId": { "description": "CDN返回的视频ID", "type": "string" }, "fileMd5": { "description": "CDN返回的视频文件Md5", "type": "string" }, "fileSize": { "description": "CDN返回的视频文件大小", "type": "integer" }, "newMd5": { "description": "CDN返回的NewMd5", "type": "string" }, "oriMsgFrom": { "description": "原视频消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原视频消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原视频消息MsgSource的Base64", "type": "string" }, "oriMsgTo": { "description": "原视频消息接收人Wxid", "type": "string" }, "playLength": { "description": "视频时长，单位为秒", "type": "integer" }, "rawAesKey": { "description": "CDN返回的RawAeskey", "type": "string" }, "rawFileId": { "description": "CDN返回的原视频ID", "type": "string" }, "rawFileMd5": { "description": "CDN返回的原视频文件Md5", "type": "string" }, "rawFileSize": { "description": "CDN返回的原视频文件大小", "type": "integer" }, "thumbHeight": { "description": "CDN返回的封面图图片高度", "type": "integer" }, "thumbSize": { "description": "CDN返回的封面图图片大小", "type": "integer" }, "thumbWidth": { "description": "CDN返回的封面图图片宽度", "type": "integer" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.imageDownloadRequest": { "type": "object", "required": [ "appId", "type", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "type": { "description": "下载的图片类型：1-原图 2-常规图 3-缩略图", "type": "integer", "enum": [ 1, 2, 3 ] }, "xmlMsgBase64": { "description": "图片消息中xml的Base64编码", "type": "string" } } }, "message.imageDownloadResponse": { "type": "object", "properties": { "fileExt": { "description": "图片文件格式", "type": "string" }, "imageSize": { "description": "图片文件大小", "type": "integer" }, "imageUrl": { "description": "图片文件下载地址，7天有效", "type": "string" } } }, "message.revokeMessageRequest": { "type": "object", "required": [ "appId", "createTime", "newMsgId", "toWxid" ], "properties": { "appId": { "type": "string" }, "createTime": { "description": "发送接口返回的createTime", "type": "integer" }, "newMsgId": { "description": "发送接口返回的newMsgId", "type": "integer" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.sendAppMsgRequest": { "type": "object", "required": [ "appId", "toWxid", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "oriMsgFrom": { "description": "原消息发送人Wxid", "type": "string" }, "oriMsgId": { "description": "原消息的newMsgId", "type": "integer" }, "oriMsgSourceBase64": { "description": "原消息msgsource的Base64", "type": "string" }, "oriMsgTo": { "description": "原消息接收人Wxid", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "xmlMsgBase64": { "description": "消息xml的Base64编码", "type": "string" } } }, "message.sendEmojiRequest": { "type": "object", "required": [ "appId", "emojiMd5", "emojiSize", "toWxid" ], "properties": { "appId": { "type": "string" }, "emojiMd5": { "description": "Emoji图片的md5编码", "type": "string" }, "emojiSize": { "description": "Emoji的文件大小", "type": "integer" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.sendFileRequest": { "type": "object", "required": [ "appId", "fileData", "fileName", "toWxid" ], "properties": { "appId": { "type": "string" }, "fileData": { "description": "文件内容的base64编码，或文件的URL地址（以http://或https://开头）", "type": "string" }, "fileName": { "description": "文件名，包括扩展名", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.sendFileResponse": { "type": "object", "properties": { "aesKey": { "description": "CDN返回的Aeskey，用于消息转发", "type": "string" }, "createTime": { "description": "消息创建时间", "type": "integer" }, "fileCRC": { "description": "CDN返回的FileCRC，用于消息转发", "type": "integer" }, "fileId": { "description": "CDN返回的文件ID，用于消息转发", "type": "string" }, "fileMd5": { "description": "CDN返回的文件Md5，用于消息转发", "type": "string" }, "fileSize": { "description": "CDN返回的文件大小，用于消息转发", "type": "integer" }, "msgSourceBase64": { "description": "消息来源的Base64，用于消息转发", "type": "string" }, "newMsgId": { "description": "消息ID", "type": "integer" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "type": { "description": "消息类型", "type": "integer" } } }, "message.sendImageRequest": { "type": "object", "required": [ "appId", "imageData", "toWxid" ], "properties": { "appId": { "type": "string" }, "imageData": { "description": "图片数据的base64编码或图片的URL地址（以http://或https://开头）；支持jpg/png/webp/bmp/tiff格式", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.sendImageResponse": { "type": "object", "properties": { "aesKey": { "description": "CDN返回的Aeskey，用于消息转发", "type": "string" }, "bigImgSize": { "description": "CDN返回的BigImgSize，用于消息转发", "type": "integer" }, "createTime": { "description": "消息创建时间", "type": "integer" }, "fileId": { "description": "CDN返回的图片ID，用于消息转发", "type": "string" }, "fileMd5": { "description": "CDN返回的图片Md5，用于消息转发", "type": "string" }, "midImgSize": { "description": "CDN返回的MidImgSize，用于消息转发", "type": "integer" }, "msgSourceBase64": { "description": "消息来源的Base64，用于消息转发", "type": "string" }, "newMsgId": { "description": "消息ID", "type": "integer" }, "thumbImgHeight": { "description": "CDN返回的ThumbImgHeight，用于消息转发", "type": "integer" }, "thumbImgSize": { "description": "CDN返回的ThumbImgSize，用于消息转发", "type": "integer" }, "thumbImgWidth": { "description": "CDN返回的ThumbImgWidth，用于消息转发", "type": "integer" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "type": { "description": "消息类型", "type": "integer" } } }, "message.sendLinkRequest": { "type": "object", "required": [ "appId", "imageData", "linkUrl", "title", "toWxid" ], "properties": { "appId": { "type": "string" }, "desc": { "description": "链接显示内容", "type": "string" }, "imageData": { "description": "缩略图的base64编码，或缩略图的URL地址（以http://或https://开头）；支持jpg/png/webp/gif/bmp/tiff格式", "type": "string" }, "linkUrl": { "description": "链接对应的Url", "type": "string" }, "title": { "description": "链接显示标题", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.sendLinkResponse": { "type": "object", "properties": { "ReqId": { "description": "ReqId，用于消息转发", "type": "string" }, "aesKey": { "description": "CDN返回的Aeskey，用于消息转发", "type": "string" }, "createTime": { "description": "消息创建时间", "type": "integer" }, "msgSourceBase64": { "description": "消息来源的Base64，用于消息转发", "type": "string" }, "newMsgId": { "description": "消息ID", "type": "integer" }, "thumbHeight": { "description": "缩略图高度，用于消息转发", "type": "integer" }, "thumbMd5": { "description": "缩略图Md5，用于消息转发", "type": "string" }, "thumbSize": { "description": "缩略图大小，用于消息转发", "type": "integer" }, "thumbUrl": { "description": "CDN返回的缩略图Url，用于消息转发", "type": "string" }, "thumbWidth": { "description": "缩略图宽度，用于消息转发", "type": "integer" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "type": { "description": "消息类型", "type": "integer" } } }, "message.sendMiniAppRequest": { "type": "object", "required": [ "appId", "toWxid", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "xmlMsgBase64": { "description": "小程序消息xml的Base64编码", "type": "string" } } }, "message.sendNameCardMessageRequest": { "type": "object", "required": [ "appId", "cardNickname", "cardWxid", "toWxid" ], "properties": { "appId": { "type": "string" }, "cardAlias": { "description": "名片对应的别名", "type": "string" }, "cardNickname": { "description": "名片对应的昵称", "type": "string" }, "cardWxid": { "description": "名片对应的Wxid", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.sendTextRequest": { "type": "object", "required": [ "appId", "content", "toWxid" ], "properties": { "appId": { "type": "string" }, "ats": { "description": "群聊时@的群成员id，多个用英文逗号分隔。群主或管理员@全部群成员时，填写'all'", "type": "string" }, "content": { "description": "发送的文本内容；在群内发送消息@某人时，内容中应该有'@xxx'，其中xxx是该人的群昵称或微信昵称", "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" } } }, "message.sendVideoRequest": { "type": "object", "required": [ "appId", "toWxid", "videoData" ], "properties": { "appId": { "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "videoData": { "description": "视频数据的base64编码，或视频的URL地址（以http://或https://开头）", "type": "string" } } }, "message.sendVideoResponse": { "type": "object", "properties": { "aesKey": { "description": "CDN返回的Aeskey，用于消息转发", "type": "string" }, "crc32": { "description": "CDN返回的CRC32，用于消息转发", "type": "integer" }, "createTime": { "description": "消息创建时间", "type": "integer" }, "fileId": { "description": "CDN返回的视频ID，用于消息转发", "type": "string" }, "fileMd5": { "description": "CDN返回的文件Md5，用于消息转发", "type": "string" }, "fileSize": { "description": "CDN返回的视频文件大小，用于消息转发", "type": "integer" }, "msgSourceBase64": { "description": "消息来源的Base64，用于消息转发", "type": "string" }, "newMd5": { "description": "CDN返回的NewMd5，用于消息转发", "type": "string" }, "newMsgId": { "description": "消息ID", "type": "integer" }, "playLength": { "description": "视频时长，单位为秒，用于消息转发", "type": "integer" }, "rawAesKey": { "description": "CDN返回的RawAeskey，用于消息转发", "type": "string" }, "rawFileId": { "description": "CDN返回的原视频ID，用于消息转发", "type": "string" }, "rawFileMd5": { "description": "CDN返回的原视频文件Md5，用于消息转发", "type": "string" }, "rawFileSize": { "description": "CDN返回的原视频文件大小，用于消息转发", "type": "integer" }, "thumbHeight": { "description": "CDN返回的封面图图片高度，用于消息转发", "type": "integer" }, "thumbSize": { "description": "CDN返回的封面图图片大小，用于消息转发", "type": "integer" }, "thumbWidth": { "description": "CDN返回的封面图图片宽度，用于消息转发", "type": "integer" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "type": { "description": "消息类型", "type": "integer" } } }, "message.sendVoiceRequest": { "type": "object", "required": [ "appId", "toWxid", "voiceData" ], "properties": { "appId": { "type": "string" }, "toWxid": { "description": "发送好友/群的ID", "type": "string" }, "voiceData": { "description": "语音数据的base64编码或URL地址（以http://或https://开头）；支持wav格式和原生SILK格式；语音时长在60秒以内", "type": "string" } } }, "message.videoDownloadRequest": { "type": "object", "required": [ "appId", "type", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "type": { "description": "下载类型：1-原视频 2-常规视频 3-视频缩略图", "type": "integer", "enum": [ 1, 2, 3 ] }, "xmlMsgBase64": { "description": "视频消息中xml的Base64编码", "type": "string" } } }, "message.videoDownloadResponse": { "type": "object", "properties": { "PlayLength": { "description": "视频播放时长（秒）", "type": "integer" }, "fileExt": { "description": "视频文件格式", "type": "string" }, "videoSize": { "description": "视频/缩略图文件大小", "type": "integer" }, "videoUrl": { "description": "视频/缩略图文件下载地址，7天有效", "type": "string" } } }, "message.voiceDownloadRequest": { "type": "object", "required": [ "appId", "format", "fromWxid", "newMsgId", "xmlMsgBase64" ], "properties": { "appId": { "type": "string" }, "format": { "description": "下载的语音格式：1-原SILK格式 2-转为WAV格式", "type": "integer", "enum": [ 1, 2 ] }, "fromWxid": { "description": "发送语音消息的好友/群ID", "type": "string" }, "newMsgId": { "description": "语音消息的newMsgId", "type": "integer" }, "xmlMsgBase64": { "description": "语音消息中xml的Base64编码", "type": "string" } } }, "message.voiceDownloadResponse": { "type": "object", "properties": { "PlayLength": { "description": "语音播放时长（毫秒）", "type": "integer" }, "fileExt": { "description": "语音文件格式", "type": "string" }, "voiceSize": { "description": "语音文件大小", "type": "integer" }, "voiceUrl": { "description": "语音文件下载地址，7天有效", "type": "string" } } }, "proxy.getProxyInfoRequest": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string" } } }, "proxy.getProxyInfoResponse": { "type": "object", "properties": { "proxy": { "description": "代理地址，格式为socks5://username:password@ipv4:port", "type": "string" } } }, "proxy.setProxyInfoRequest": { "type": "object", "required": [ "appId" ], "properties": { "appId": { "type": "string" }, "proxy": { "description": "代理地址", "type": "string", "example": "socks5://username:password@ipv4:port" } } }, "response.ResponseData": { "type": "object", "properties": { "code": { "description": "响应代码，正常返回为0", "type": "integer", "example": 0 }, "data": { "description": "返回数据" }, "message": { "description": "响应信息，正常返回为'OK'", "type": "string", "example": "OK" } } } } }