From 656ecb6bc9412d338b5b21632b73afb6e376f628 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E6=88=90?= Date: Thu, 26 Mar 2026 10:55:13 +0800 Subject: [PATCH] 1 --- _docs/swagger.json | 9028 +++++++++++++++++ _docs/接口说明文档-完整版-含营销等级.md | 7125 +++++++++++++ _docs、.md | 7125 +++++++++++++ admin/src/api/subscription/user_server.js | 9 + admin/src/mixins/subscriptionRelations.js | 45 + .../src/views/subscription/subscriptions.vue | 110 +- admin/src/views/subscription/tokens.vue | 54 +- admin/src/views/subscription/usage.vue | 67 +- admin/src/views/subscription/users.vue | 43 +- api/controller_admin/biz_user.js | 14 + 10 files changed, 23560 insertions(+), 60 deletions(-) create mode 100644 _docs/swagger.json create mode 100644 _docs/接口说明文档-完整版-含营销等级.md create mode 100644 _docs、.md create mode 100644 admin/src/mixins/subscriptionRelations.js diff --git a/_docs/swagger.json b/_docs/swagger.json new file mode 100644 index 0000000..00ec88a --- /dev/null +++ b/_docs/swagger.json @@ -0,0 +1,9028 @@ +{ + "basePath": "", + "definitions": { + "ActionInfo": { + "properties": { + "AppMsg": { + "$ref": "#/definitions/AppMsg" + } + }, + "title": "ActionInfo", + "type": "object" + }, + "AlisaModel": { + "properties": { + "Alisa": { + "example": "", + "type": "string" + } + }, + "title": "AlisaModel", + "type": "object" + }, + "AppInfo": { + "properties": { + "AppName": { + "example": "", + "type": "string" + }, + "FromURL": { + "example": "", + "type": "string" + }, + "ID": { + "example": "", + "type": "string" + }, + "InstallURL": { + "example": "", + "type": "string" + }, + "IsForceUpdate": { + "format": "uint32", + "type": "integer" + }, + "Version": { + "example": "", + "type": "string" + } + }, + "title": "AppInfo", + "type": "object" + }, + "AppMessageItem": { + "properties": { + "ContentType": { + "description": " 2001:(红包消息)", + "format": "uint32", + "type": "integer" + }, + "ContentXML": { + "example": "", + "type": "string" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "AppMessageItem", + "type": "object" + }, + "AppMessageModel": { + "properties": { + "AppList": { + "items": { + "$ref": "#/definitions/AppMessageItem" + }, + "type": "array" + } + }, + "title": "AppMessageModel", + "type": "object" + }, + "AppMsg": { + "properties": { + "MessageAction": { + "example": "", + "type": "string" + } + }, + "title": "AppMsg", + "type": "object" + }, + "AppletModel": { + "properties": { + "AppId": { + "description": " 应用ID", + "example": "", + "type": "string" + }, + "Data": { + "description": " 小程序云函数操作的 Data; json字符串, 注意必须是 json 字符串; 传空时默认值为: '{\"with_credentials\":true,\"from_component\":true,\"data\":{\"lang\":\"zh_CN\"},\"api_name\":\"webapi_getuserinfo\"}'", + "example": "", + "type": "string" + }, + "Opt": { + "description": " 小程序云函数操作的 Opt; 默认为1", + "example": "1", + "format": "int32", + "type": "integer" + }, + "PackageName": { + "example": "", + "type": "string" + }, + "SdkName": { + "example": "", + "type": "string" + } + }, + "title": "AppletModel", + "type": "object" + }, + "AutoApproveRequestModel": { + "properties": { + "AutoReply": { + "description": " 是否通过验证后自动回复", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Enable": { + "description": " 是否开启自动通过验证", + "example": "1", + "format": "int32", + "type": "integer" + }, + "ReplyMessage": { + "description": " 回复内容（仅一条）", + "example": "", + "type": "string" + } + }, + "title": "AutoApproveRequestModel", + "type": "object" + }, + "AutoCommentRequestModel": { + "properties": { + "CommentMessages": { + "description": " 评论内容（多条用逗号隔开）", + "example": "", + "type": "string" + }, + "Enable": { + "description": " 是否开启自动评论", + "example": "1", + "format": "int32", + "type": "integer" + }, + "EndTime": { + "description": " 评论时间段，结束时间", + "example": "", + "type": "string" + }, + "Groups": { + "description": " 设置分组，多个用逗号隔开", + "example": "", + "type": "string" + }, + "Mode": { + "description": " 模式，1-仅评论分组，0-不评论分组", + "example": "1", + "format": "int32", + "type": "integer" + }, + "StartTime": { + "description": " 评论时间段，开始时间", + "example": "", + "type": "string" + }, + "TimeInSeconds": { + "description": " 延迟评论的时间，单位为秒", + "example": "0", + "format": "int32", + "type": "integer" + } + }, + "title": "AutoCommentRequestModel", + "type": "object" + }, + "AutoForwardRequestModel": { + "properties": { + "EnableAutoForward": { + "description": " 是否开启跟随转发", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Groups": { + "description": " 设置分组，多个用逗号隔开", + "example": "", + "type": "string" + }, + "IsBlockAuthor": { + "description": " 是否屏蔽作者", + "example": "1", + "format": "int32", + "type": "integer" + }, + "IsBlockGroup": { + "description": " 是否屏蔽组", + "example": "1", + "format": "int32", + "type": "integer" + } + }, + "title": "AutoForwardRequestModel", + "type": "object" + }, + "AutoLikeRequestModel": { + "properties": { + "Enable": { + "description": " 是否开启自动点赞", + "example": "1", + "format": "int32", + "type": "integer" + }, + "EndTime": { + "description": " 结束时间// 点赞时间段", + "example": "", + "type": "string" + }, + "Groups": { + "description": " 设置分组，多个用逗号隔开", + "example": "", + "type": "string" + }, + "Mode": { + "description": " 模式，1-仅点赞分组，0-不点赞分组", + "example": "1", + "format": "int32", + "type": "integer" + }, + "StartTime": { + "description": " 开始时间 // 点赞时间段", + "example": "", + "type": "string" + }, + "TimeInSeconds": { + "description": " 延迟点赞的时间，单位为秒", + "example": "0", + "format": "int32", + "type": "integer" + } + }, + "title": "AutoLikeRequestModel", + "type": "object" + }, + "AutoRedRequestModel": { + "properties": { + "AutoReply": { + "description": " 是否自动回复感谢", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Enable": { + "description": " 是否开启领取红包机制", + "example": "1", + "format": "int32", + "type": "integer" + }, + "ReplyMessages": { + "description": " 回复内容（多个消息用逗号隔开）", + "example": "", + "type": "string" + }, + "Single": { + "description": " 是否仅抢单个红包（不同时抢多个）", + "example": "1", + "format": "int32", + "type": "integer" + }, + "TimeInSeconds": { + "description": " 延迟回复的时间，单位为秒", + "example": "0", + "format": "int32", + "type": "integer" + } + }, + "title": "AutoRedRequestModel", + "type": "object" + }, + "AutoTransferRequestModel": { + "properties": { + "AutoReply": { + "description": " 是否开启自动回复", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Enable": { + "description": " 是否开启接收转账功能", + "example": "1", + "format": "int32", + "type": "integer" + }, + "ReplyMessage": { + "description": " 回复内容（仅一条）", + "example": "", + "type": "string" + }, + "TimeInSeconds": { + "description": " 延迟回复的时间，单位为秒", + "example": "0", + "format": "int32", + "type": "integer" + } + }, + "title": "AutoTransferRequestModel", + "type": "object" + }, + "BannedAuthKeyModel": { + "properties": { + "IsBanned": { + "description": " isBanned 1 禁用 默认设置为0", + "example": "0", + "format": "int", + "type": "integer" + }, + "Key": { + "description": " 要禁用的 AuthKey", + "example": "", + "type": "string" + } + }, + "title": "BannedAuthKeyModel", + "type": "object" + }, + "BatchGetContactModel": { + "properties": { + "RoomWxIDList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "UserNames": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "BatchGetContactModel", + "type": "object" + }, + "CdnSnsVideoUploadModel": { + "properties": { + "ThumbData": { + "description": " 缩略图数据的base64编码", + "example": "", + "type": "string" + }, + "VideoData": { + "description": " 视频数据的base64编码", + "example": "", + "type": "string" + } + }, + "title": "CdnSnsVideoUploadModel", + "type": "object" + }, + "CdnUploadVideoRequest": { + "properties": { + "ThumbData": { + "description": " ThumbData", + "items": { + "format": "int", + "type": "integer" + }, + "type": "array" + }, + "ToUserName": { + "example": "", + "type": "string" + }, + "VideoData": { + "description": " 视频数据", + "items": { + "format": "int", + "type": "integer" + }, + "type": "array" + } + }, + "title": "CdnUploadVideoRequest", + "type": "object" + }, + "ChannelsLoginModel": { + "properties": { + "finderUsername": { + "description": " 指定要登录的视频号用户名，为空则选择第一个", + "example": "", + "type": "string" + }, + "url": { + "description": " 视频号助手扫码登录确认链接", + "example": "", + "type": "string" + } + }, + "title": "ChannelsLoginModel", + "type": "object" + }, + "ChatRoomWxIdListModel": { + "properties": { + "ChatRoomWxIdList": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "ChatRoomWxIdListModel", + "type": "object" + }, + "ChatroomMemberModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "UserList": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "ChatroomMemberModel", + "type": "object" + }, + "ChatroomNameModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "Nickname": { + "example": "", + "type": "string" + } + }, + "title": "ChatroomNameModel", + "type": "object" + }, + "CollectmoneyModel": { + "properties": { + "InvalidTime": { + "example": "", + "type": "string" + }, + "ToUserName": { + "example": "", + "type": "string" + }, + "TransFerId": { + "example": "", + "type": "string" + }, + "TransactionId": { + "example": "", + "type": "string" + } + }, + "title": "CollectmoneyModel", + "type": "object" + }, + "ConfirmPreTransfer": { + "properties": { + "BankSerial": { + "description": " 付款方式 Serial序列号", + "example": "", + "type": "string" + }, + "BankType": { + "description": " 付款方式 类型", + "example": "", + "type": "string" + }, + "PayPassword": { + "description": " 支付密码", + "example": "", + "type": "string" + }, + "ReqKey": { + "description": " 创建转账返回的ReqKey", + "example": "", + "type": "string" + } + }, + "title": "ConfirmPreTransfer", + "type": "object" + }, + "ConsentToJoinGroupModel": { + "properties": { + "Url": { + "example": "", + "type": "string" + } + }, + "title": "ConsentToJoinGroupModel", + "type": "object" + }, + "ContentObject": { + "properties": { + "ContentStyle": { + "format": "uint32", + "type": "integer" + }, + "ContentURL": { + "example": "", + "type": "string" + }, + "Description": { + "example": "", + "type": "string" + }, + "MediaList": { + "$ref": "#/definitions/MediaList" + }, + "Title": { + "example": "", + "type": "string" + } + }, + "title": "ContentObject", + "type": "object" + }, + "CreateChatRoomModel": { + "properties": { + "TopIc": { + "example": "", + "type": "string" + }, + "UserList": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "CreateChatRoomModel", + "type": "object" + }, + "CreatePreTransfer": { + "properties": { + "Description": { + "description": " 转账备注", + "example": "", + "type": "string" + }, + "Fee": { + "description": " 转账金额(单位为分)", + "format": "uint32", + "type": "integer" + }, + "ToUserName": { + "description": " 要转账用户的wxid", + "example": "", + "type": "string" + } + }, + "title": "CreatePreTransfer", + "type": "object" + }, + "DataSection": { + "properties": { + "DataLen": { + "description": " 数据分包长度(不要超过 65535)", + "example": "61440", + "format": "uint32", + "type": "integer" + }, + "StartPos": { + "description": " 数据分包开始位置", + "format": "uint32", + "type": "integer" + } + }, + "title": "DataSection", + "type": "object" + }, + "DelContactModel": { + "properties": { + "DelUserName": { + "example": "", + "type": "string" + } + }, + "title": "DelContactModel", + "type": "object" + }, + "DelSafeDeviceModel": { + "properties": { + "DeviceUUID": { + "example": "", + "type": "string" + } + }, + "title": "DelSafeDeviceModel", + "type": "object" + }, + "DelayAuthKeyModel": { + "properties": { + "Days": { + "description": " AuthKey 的延期天数; Days 小于1默认设置为30", + "example": "30", + "format": "int", + "type": "integer" + }, + "ExpiryDate": { + "description": " AuthKey 的到期日期(例如: 2024-01-01); 与 Days 参数只能选其一(优先使用 ExpiryDate 参数)", + "example": "", + "type": "string" + }, + "Key": { + "description": " 要延期的 AuthKey", + "example": "", + "type": "string" + } + }, + "title": "DelayAuthKeyModel", + "type": "object" + }, + "DelayAuthKeyModelNew": { + "properties": { + "KeyUse": { + "description": " 被使用的key", + "example": "", + "type": "string" + } + }, + "title": "DelayAuthKeyModelNew", + "type": "object" + }, + "DelayAutoTransferRequestModel": { + "properties": { + "TimeInSeconds": { + "description": " 延迟接收转账的时间，单位为秒", + "example": "0", + "format": "int32", + "type": "integer" + } + }, + "title": "DelayAutoTransferRequestModel", + "type": "object" + }, + "DelayRedRequestModel": { + "properties": { + "TimeInSeconds": { + "description": " 延迟领取红包的时间，单位为秒", + "example": "0", + "format": "int32", + "type": "integer" + } + }, + "title": "DelayRedRequestModel", + "type": "object" + }, + "DeleteAuthKeyModel": { + "properties": { + "Key": { + "description": " 要删除的 AuthKey", + "example": "", + "type": "string" + }, + "Opt": { + "description": " 删除操作 0:仅删除授权码 1:删除授权码相关的所有数据", + "format": "int", + "type": "integer" + } + }, + "title": "DeleteAuthKeyModel", + "type": "object" + }, + "DeviceIdLoginModel": { + "properties": { + "DeviceInfo": { + "$ref": "#/definitions/DeviceInfo", + "description": " 设备信息" + }, + "LoginData": { + "description": " 62 数据/A16 数据", + "example": "", + "type": "string" + }, + "Password": { + "description": " 微信密码", + "example": "", + "type": "string" + }, + "Proxy": { + "description": " socks代理，例如：socks5://username:password@ipv4:port", + "example": "", + "type": "string" + }, + "Ticket": { + "description": " SMS短信验证码", + "example": "", + "type": "string" + }, + "Type": { + "format": "int", + "type": "integer" + }, + "UserName": { + "description": " 手机号", + "example": "", + "type": "string" + } + }, + "title": "DeviceIdLoginModel", + "type": "object" + }, + "DeviceInfo": { + "properties": { + "AndroidId": { + "example": "", + "type": "string" + }, + "ImeI": { + "example": "", + "type": "string" + }, + "Manufacturer": { + "example": "", + "type": "string" + }, + "Model": { + "example": "", + "type": "string" + } + }, + "title": "DeviceInfo", + "type": "object" + }, + "DownMediaModel": { + "properties": { + "AesKey": { + "example": "", + "type": "string" + }, + "FileType": { + "format": "uint32", + "type": "integer" + }, + "FileURL": { + "example": "", + "type": "string" + } + }, + "title": "DownMediaModel", + "type": "object" + }, + "DownloadEmojiModel": { + "properties": { + "xml_content": { + "description": " msg_type=47的消息xml内容", + "example": "", + "type": "string" + } + }, + "title": "DownloadEmojiModel", + "type": "object" + }, + "DownloadMediaModel": { + "properties": { + "Key": { + "example": "", + "type": "string" + }, + "URL": { + "example": "", + "type": "string" + } + }, + "title": "DownloadMediaModel", + "type": "object" + }, + "DownloadParam": { + "properties": { + "CompressType": { + "description": " 下载图片时，数据压缩类型(默认为0即可)", + "format": "int", + "type": "integer" + }, + "FromUserName": { + "description": " 下载图片时，图片消息的发送者", + "example": "", + "type": "string" + }, + "MsgId": { + "description": " 消息ID(注意是msg_id 不是new_msg_id)", + "format": "uint32", + "type": "integer" + }, + "Section": { + "$ref": "#/definitions/DataSection", + "description": " 当前要获取的数据分包" + }, + "ToUserName": { + "description": " 下载图片时，图片消息的接收者", + "example": "", + "type": "string" + }, + "TotalLen": { + "description": " 下载数据的总长度", + "format": "int", + "type": "integer" + } + }, + "title": "DownloadParam", + "type": "object" + }, + "DownloadQWImageModel": { + "properties": { + "xml": { + "example": "", + "type": "string" + } + }, + "title": "DownloadQWImageModel", + "type": "object" + }, + "DownloadVoiceModel": { + "properties": { + "Bufid": { + "example": "", + "type": "string" + }, + "Length": { + "format": "int", + "type": "integer" + }, + "NewMsgId": { + "example": "", + "type": "string" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "DownloadVoiceModel", + "type": "object" + }, + "Enc": { + "properties": { + "Key": { + "example": "", + "type": "string" + }, + "Value": { + "format": "uint32", + "type": "integer" + } + }, + "title": "Enc", + "type": "object" + }, + "ExtDeviceLoginModel": { + "properties": { + "QrConnect": { + "example": "", + "type": "string" + } + }, + "title": "ExtDeviceLoginModel", + "type": "object" + }, + "FavInfoModel": { + "properties": { + "FavId": { + "format": "uint32", + "type": "integer" + }, + "KeyBuf": { + "example": "", + "type": "string" + } + }, + "title": "FavInfoModel", + "type": "object" + }, + "FavoriteForwardRequestModel": { + "properties": { + "EnableFavoriteForward": { + "description": " 是否开启收藏转发", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Groups": { + "description": " 设置分组，多个用逗号隔开", + "example": "", + "type": "string" + }, + "IsBlockAuthor": { + "description": " 是否屏蔽作者", + "example": "1", + "format": "int32", + "type": "integer" + }, + "IsBlockGroup": { + "description": " 是否屏蔽组", + "example": "1", + "format": "int32", + "type": "integer" + } + }, + "title": "FavoriteForwardRequestModel", + "type": "object" + }, + "FinderFollowModel": { + "properties": { + "Cook": { + "example": "", + "type": "string" + }, + "FinderUserName": { + "example": "", + "type": "string" + }, + "OpType": { + "format": "int32", + "type": "integer" + }, + "PosterUsername": { + "example": "", + "type": "string" + }, + "RefObjectId": { + "example": "", + "type": "string" + }, + "Userver": { + "format": "int32", + "type": "integer" + } + }, + "title": "FinderFollowModel", + "type": "object" + }, + "FinderSearchModel": { + "properties": { + "Index": { + "format": "uint32", + "type": "integer" + }, + "UserKey": { + "example": "", + "type": "string" + }, + "Userver": { + "format": "int32", + "type": "integer" + }, + "Uuid": { + "example": "", + "type": "string" + } + }, + "title": "FinderSearchModel", + "type": "object" + }, + "FinderUserPrepareModel": { + "properties": { + "Userver": { + "format": "int32", + "type": "integer" + } + }, + "title": "FinderUserPrepareModel", + "type": "object" + }, + "FollowGHModel": { + "properties": { + "GHList": { + "items": { + "$ref": "#/definitions/VerifyUserItem" + }, + "type": "array" + } + }, + "title": "FollowGHModel", + "type": "object" + }, + "ForwardImageItem": { + "properties": { + "AesKey": { + "example": "", + "type": "string" + }, + "CdnMidImgSize": { + "format": "int32", + "type": "integer" + }, + "CdnMidImgUrl": { + "example": "", + "type": "string" + }, + "CdnThumbImgSize": { + "format": "int32", + "type": "integer" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "ForwardImageItem", + "type": "object" + }, + "ForwardMessageModel": { + "properties": { + "ForwardImageList": { + "items": { + "$ref": "#/definitions/ForwardImageItem" + }, + "type": "array" + }, + "ForwardVideoList": { + "items": { + "$ref": "#/definitions/ForwardVideoItem" + }, + "type": "array" + } + }, + "title": "ForwardMessageModel", + "type": "object" + }, + "ForwardVideoItem": { + "properties": { + "AesKey": { + "example": "", + "type": "string" + }, + "CdnThumbLength": { + "format": "int", + "type": "integer" + }, + "CdnVideoUrl": { + "example": "", + "type": "string" + }, + "Length": { + "format": "int", + "type": "integer" + }, + "PlayLength": { + "format": "int", + "type": "integer" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "ForwardVideoItem", + "type": "object" + }, + "GenAuthKeyModel": { + "properties": { + "Count": { + "description": " 要生成 AuthKey 的个数; Count小于1默认设置为1", + "example": "1", + "format": "int", + "type": "integer" + }, + "Days": { + "description": " AuthKey 的过期天数; Days小于1默认设置为30", + "example": "30", + "format": "int", + "type": "integer" + } + }, + "title": "GenAuthKeyModel", + "type": "object" + }, + "GenAuthKeyTypeModel": { + "properties": { + "Count": { + "description": " 要生成 AuthKey 的个数; Count小于1默认设置为1", + "example": "1", + "format": "int", + "type": "integer" + }, + "Type": { + "description": " 类型 1日 7 周 30月 90季 180 半年 365年 30000永久（数字为标识，非准确天数）", + "example": "1", + "format": "int", + "type": "integer" + } + }, + "title": "GenAuthKeyTypeModel", + "type": "object" + }, + "GeneratePayQCodeModel": { + "properties": { + "Money": { + "description": " 金额(单位为分), 999 即为 9.99 元", + "example": "", + "type": "string" + }, + "Name": { + "description": " 收款备注", + "example": "", + "type": "string" + } + }, + "title": "GeneratePayQCodeModel", + "type": "object" + }, + "GetA8KeyRequestModel": { + "properties": { + "OpCode": { + "format": "uint32", + "type": "integer" + }, + "ReqUrl": { + "example": "", + "type": "string" + }, + "Scene": { + "format": "uint32", + "type": "integer" + } + }, + "title": "GetA8KeyRequestModel", + "type": "object" + }, + "GetChatroomMemberDetailModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + } + }, + "title": "GetChatroomMemberDetailModel", + "type": "object" + }, + "GetChatroomQrCodeModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + } + }, + "title": "GetChatroomQrCodeModel", + "type": "object" + }, + "GetContactListModel": { + "properties": { + "CurrentChatRoomContactSeq": { + "format": "uint32", + "type": "integer" + }, + "CurrentWxcontactSeq": { + "format": "uint32", + "type": "integer" + } + }, + "title": "GetContactListModel", + "type": "object" + }, + "GetFriendRelationModel": { + "properties": { + "UserName": { + "example": "", + "type": "string" + } + }, + "title": "GetFriendRelationModel", + "type": "object" + }, + "GetIdDetailModel": { + "properties": { + "BlackList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Id": { + "example": "", + "type": "string" + }, + "Location": { + "$ref": "#/definitions/baseinfo.Location" + }, + "LocationVal": { + "format": "int64", + "type": "integer" + } + }, + "title": "GetIdDetailModel", + "type": "object" + }, + "GetLoginQrCodeModel": { + "properties": { + "Check": { + "description": " 修改代理时(SetProxy接口) 是否发送检测代理请求(可能导致请求超时)", + "example": "false", + "type": "boolean" + }, + "IpadOrmac": { + "example": "", + "type": "string" + }, + "Proxy": { + "description": " socks代理，例如：socks5://username:password@ipv4:port", + "example": "", + "type": "string" + } + }, + "title": "GetLoginQrCodeModel", + "type": "object" + }, + "GetMpA8KeyModel": { + "properties": { + "Opcode": { + "format": "uint32", + "type": "integer" + }, + "Scene": { + "format": "int64", + "type": "integer" + }, + "Url": { + "example": "", + "type": "string" + } + }, + "title": "GetMpA8KeyModel", + "type": "object" + }, + "GetMpHistoryMsgModel": { + "properties": { + "Url": { + "example": "", + "type": "string" + } + }, + "title": "GetMpHistoryMsgModel", + "type": "object" + }, + "GetQrCodeModel": { + "properties": { + "Recover": { + "description": " 保持默认值, 无需修改", + "type": "boolean" + }, + "Style": { + "description": " 个人二维码样式: 可设置为8, 其余自行探索", + "example": "8", + "format": "uint32", + "type": "integer" + } + }, + "title": "GetQrCodeModel", + "type": "object" + }, + "GetRedPacketList": { + "properties": { + "HongBaoItem": { + "$ref": "#/definitions/HongBaoURLItem" + }, + "Limit": { + "format": "int64", + "type": "integer" + }, + "NativeURL": { + "example": "", + "type": "string" + }, + "Offset": { + "format": "int64", + "type": "integer" + } + }, + "title": "GetRedPacketList", + "type": "object" + }, + "GetSnsInfoModel": { + "properties": { + "FirstPageMD5": { + "example": "", + "type": "string" + }, + "MaxID": { + "format": "uint64", + "type": "integer" + }, + "UserName": { + "example": "", + "type": "string" + } + }, + "title": "GetSnsInfoModel", + "type": "object" + }, + "GetSyncMsgModel": { + "properties": { + "Key": { + "example": "", + "type": "string" + } + }, + "title": "GetSyncMsgModel", + "type": "object" + }, + "GroupListModel": { + "properties": { + "Key": { + "example": "", + "type": "string" + } + }, + "title": "GroupListModel", + "type": "object" + }, + "GroupMassMsgImageModel": { + "properties": { + "ImageBase64": { + "example": "", + "type": "string" + }, + "ToUserName": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "GroupMassMsgImageModel", + "type": "object" + }, + "GroupMassMsgTextModel": { + "properties": { + "Content": { + "example": "", + "type": "string" + }, + "ToUserName": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "GroupMassMsgTextModel", + "type": "object" + }, + "HongBaoItem": { + "properties": { + "DequeueAtMs": { + "format": "int64", + "type": "integer" + }, + "EnqueueAtMs": { + "format": "int64", + "type": "integer" + }, + "FromUserName": { + "example": "", + "type": "string" + }, + "IsGroup": { + "description": " 默认 1", + "format": "uint32", + "type": "integer" + }, + "Limit": { + "format": "int64", + "type": "integer" + }, + "NativeURL": { + "example": "", + "type": "string" + }, + "RecvAtMs": { + "format": "int64", + "type": "integer" + }, + "SceneID": { + "format": "uint32", + "type": "integer" + }, + "SessionUserName": { + "description": " 群ID或个人ID", + "example": "", + "type": "string" + }, + "URLItem": { + "$ref": "#/definitions/HongBaoURLItem" + } + }, + "title": "HongBaoItem", + "type": "object" + }, + "HongBaoURLItem": { + "properties": { + "ChannelID": { + "example": "", + "type": "string" + }, + "MsgType": { + "example": "", + "type": "string" + }, + "SceneID": { + "format": "uint32", + "type": "integer" + }, + "SendID": { + "example": "", + "type": "string" + }, + "SendUserName": { + "example": "", + "type": "string" + }, + "ShowSourceMac": { + "example": "", + "type": "string" + }, + "ShowWxPayTitle": { + "example": "", + "type": "string" + }, + "Sign": { + "example": "", + "type": "string" + }, + "Ver": { + "example": "", + "type": "string" + } + }, + "title": "HongBaoURLItem", + "type": "object" + }, + "InviteChatroomMembersModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "UserList": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "InviteChatroomMembersModel", + "type": "object" + }, + "KeywordAutoReplyRequestModel": { + "properties": { + "Enable": { + "description": " 是否开启关键词自动回复", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Keywords": { + "description": " 关键词设置", + "items": { + "$ref": "#/definitions/ReplyKeywordsItem" + }, + "type": "array" + }, + "Mode": { + "description": " 模式，1-仅回复设置群，0-不回复设置群", + "example": "1", + "format": "int32", + "type": "integer" + }, + "PrivateReply": { + "description": " 是否回复私聊", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Rooms": { + "description": " 设置的群", + "example": "", + "type": "string" + } + }, + "title": "KeywordAutoReplyRequestModel", + "type": "object" + }, + "KeywordAvoidanceRequestModel": { + "properties": { + "Enable": { + "description": " 是否开启关键字包不抢", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Keywords": { + "description": " 设置关键字（多个用逗号隔开）", + "example": "", + "type": "string" + } + }, + "title": "KeywordAvoidanceRequestModel", + "type": "object" + }, + "KeywordKickRequestModel": { + "properties": { + "Enable": { + "description": " 是否开启关键词踢人", + "example": "1", + "format": "int32", + "type": "integer" + }, + "IsCardKick": { + "description": " 是否踢发名片的人", + "example": "1", + "format": "int32", + "type": "integer" + }, + "IsImageQRCodeKick": { + "description": " 是否踢发图片二维码的人", + "example": "1", + "format": "int32", + "type": "integer" + }, + "IsLinkKick": { + "description": " 是否踢发链接的人", + "example": "1", + "format": "int32", + "type": "integer" + }, + "IsMiniProgramKick": { + "description": " 是否踢发小程序的人", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Keywords": { + "description": " 触发的关键词（多条用逗号分隔）", + "example": "", + "type": "string" + }, + "Mode": { + "description": " 模式，1-仅踢设置群，0-不踢设置群", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Rooms": { + "description": " 设置的群", + "example": "", + "type": "string" + } + }, + "title": "KeywordKickRequestModel", + "type": "object" + }, + "LabelModel": { + "properties": { + "LabelId": { + "example": "", + "type": "string" + }, + "LabelNameList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "UserLabelList": { + "items": { + "$ref": "#/definitions/baseinfo.UserLabelInfoItem" + }, + "type": "array" + } + }, + "title": "LabelModel", + "type": "object" + }, + "Location": { + "properties": { + "City": { + "example": "", + "type": "string" + }, + "Latitude": { + "example": "", + "type": "string" + }, + "Longitude": { + "example": "", + "type": "string" + }, + "PoiAddress": { + "example": "", + "type": "string" + }, + "PoiClassifyID": { + "example": "", + "type": "string" + }, + "PoiClassifyType": { + "format": "uint32", + "type": "integer" + }, + "PoiName": { + "example": "", + "type": "string" + } + }, + "title": "Location", + "type": "object" + }, + "Media": { + "properties": { + "Description": { + "example": "", + "type": "string" + }, + "Enc": { + "$ref": "#/definitions/Enc" + }, + "ID": { + "format": "uint64", + "type": "integer" + }, + "Private": { + "format": "uint32", + "type": "integer" + }, + "Size": { + "$ref": "#/definitions/Size" + }, + "SubType": { + "format": "uint32", + "type": "integer" + }, + "Thumb": { + "$ref": "#/definitions/Thumb" + }, + "Title": { + "example": "", + "type": "string" + }, + "Type": { + "format": "uint32", + "type": "integer" + }, + "URL": { + "$ref": "#/definitions/URL" + }, + "UserData": { + "example": "", + "type": "string" + }, + "VideoDuration": { + "format": "double", + "type": "number" + }, + "VideoSize": { + "$ref": "#/definitions/VideoSize" + } + }, + "title": "Media", + "type": "object" + }, + "MediaList": { + "properties": { + "Media": { + "items": { + "$ref": "#/definitions/Media" + }, + "type": "array" + } + }, + "title": "MediaList", + "type": "object" + }, + "MessageCallbackConfigModel": { + "properties": { + "CallbackURL": { + "description": " 回调URL", + "example": "", + "type": "string" + }, + "Enabled": { + "description": " 是否启用回调", + "type": "boolean" + } + }, + "title": "MessageCallbackConfigModel", + "type": "object" + }, + "MessageCallbackPayload": { + "properties": { + "content": { + "description": " 消息内容", + "example": "", + "type": "string" + }, + "create_time": { + "description": " 消息创建时间", + "format": "int64", + "type": "integer" + }, + "from_user": { + "description": " 发送者", + "example": "", + "type": "string" + }, + "is_group": { + "description": " 是否群消息", + "type": "boolean" + }, + "message_data": { + "$ref": "#/definitions/interface{}", + "description": " 消息数据" + }, + "message_id": { + "description": " 消息ID", + "example": "", + "type": "string" + }, + "message_type": { + "description": " 消息类型", + "format": "int", + "type": "integer" + }, + "to_user": { + "description": " 接收者", + "example": "", + "type": "string" + } + }, + "title": "MessageCallbackPayload", + "type": "object" + }, + "MessageForwardingRequestModel": { + "properties": { + "Enable": { + "description": " 是否开启消息转发", + "example": "1", + "format": "int32", + "type": "integer" + }, + "EndTime": { + "description": " 转发时间段，结束时间", + "example": "", + "type": "string" + }, + "ForwardRooms": { + "description": " 设置的转发群", + "example": "", + "type": "string" + }, + "Lecturers": { + "description": " 添加的讲师", + "example": "", + "type": "string" + }, + "MainRoom": { + "description": " 设置的主讲群", + "example": "", + "type": "string" + }, + "StartTime": { + "description": " 转发时间段，开始时间", + "example": "", + "type": "string" + } + }, + "title": "MessageForwardingRequestModel", + "type": "object" + }, + "MessageItem": { + "properties": { + "AtWxIDList": { + "description": " 发送艾特消息时的 wxid 列表", + "items": { + "type": "string" + }, + "type": "array" + }, + "ImageContent": { + "description": " 图片类型消息时图片的 base64 编码", + "example": "", + "type": "string" + }, + "MsgType": { + "description": "1 Text 2 Image", + "format": "int", + "type": "integer" + }, + "TextContent": { + "description": " 文本类型消息时内容", + "example": "", + "type": "string" + }, + "ToUserName": { + "description": " 接收者 wxid", + "example": "", + "type": "string" + } + }, + "title": "MessageItem", + "type": "object" + }, + "MessageNoShowParam": { + "properties": { + "ToUserName": { + "description": " 消息接收者", + "example": "", + "type": "string" + } + }, + "title": "MessageNoShowParam", + "type": "object" + }, + "ModifyCmdStatusModel": { + "properties": { + "Key": { + "example": "101", + "type": "string" + }, + "Params1": { + "example": "", + "type": "string" + }, + "Params2": { + "example": "", + "type": "string" + }, + "Params3": { + "example": "", + "type": "string" + }, + "Params4": { + "example": "", + "type": "string" + }, + "Value": { + "example": "1", + "format": "int", + "type": "integer" + }, + "ValueStr": { + "example": "", + "type": "string" + } + }, + "title": "ModifyCmdStatusModel", + "type": "object" + }, + "ModifyCmdStatusModelNew": { + "properties": { + "Key": { + "example": "101", + "type": "string" + }, + "Value": { + "example": "1", + "format": "int", + "type": "integer" + }, + "ValueStr": { + "example": "", + "type": "string" + } + }, + "title": "ModifyCmdStatusModelNew", + "type": "object" + }, + "ModifyUserInfo": { + "properties": { + "City": { + "example": "", + "type": "string" + }, + "Country": { + "example": "", + "type": "string" + }, + "InitFlag": { + "format": "uint32", + "type": "integer" + }, + "NickName": { + "example": "", + "type": "string" + }, + "Province": { + "example": "", + "type": "string" + }, + "Sex": { + "format": "uint32", + "type": "integer" + }, + "Signature": { + "example": "", + "type": "string" + } + }, + "title": "ModifyUserInfo", + "type": "object" + }, + "MomentsPostRequestModel": { + "properties": { + "Content": { + "description": " 朋友圈内容", + "example": "", + "type": "string" + }, + "Groups": { + "description": " 设置分组，多个用逗号隔开", + "example": "", + "type": "string" + }, + "IsBlock": { + "description": " 发圈时屏蔽组", + "example": "1", + "format": "int32", + "type": "integer" + }, + "VideoURL": { + "description": " 视频，最大500M（最多上传1个）", + "example": "", + "type": "string" + } + }, + "title": "MomentsPostRequestModel", + "type": "object" + }, + "MomentsRequestModel": { + "properties": { + "Groups": { + "description": " 设置分组，多个用逗号隔开", + "example": "", + "type": "string" + }, + "IsBlock": { + "description": " 发圈时屏蔽组", + "example": "1", + "format": "int32", + "type": "integer" + }, + "MomentContent": { + "description": " 朋友圈内容", + "example": "", + "type": "string" + }, + "MomentImages": { + "description": " 朋友圈图片（最多上传9张，图片路径或链接用逗号隔开）", + "example": "", + "type": "string" + }, + "MomentType": { + "description": " 发圈类型，1-文字，3-图片", + "example": "1", + "format": "int32", + "type": "integer" + }, + "ScheduledTime": { + "description": " 预约发圈时间", + "example": "", + "type": "string" + }, + "Status": { + "description": " 状态，0-未发布，1-已发布，-1-发布失败", + "example": "0", + "format": "int32", + "type": "integer" + } + }, + "title": "MomentsRequestModel", + "type": "object" + }, + "MoveContractModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "Val": { + "format": "uint32", + "type": "integer" + } + }, + "title": "MoveContractModel", + "type": "object" + }, + "OpenRedEnvelopesModel": { + "properties": { + "NativeUrl": { + "example": "", + "type": "string" + } + }, + "title": "OpenRedEnvelopesModel", + "type": "object" + }, + "PeopleNearbyModel": { + "properties": { + "Latitude": { + "format": "double", + "type": "number" + }, + "Longitude": { + "format": "double", + "type": "number" + } + }, + "title": "PeopleNearbyModel", + "type": "object" + }, + "PhoneLoginModel": { + "properties": { + "Url": { + "example": "", + "type": "string" + } + }, + "title": "PhoneLoginModel", + "type": "object" + }, + "QRConnectAuthorizeModel": { + "properties": { + "QrUrl": { + "example": "", + "type": "string" + } + }, + "title": "QRConnectAuthorizeModel", + "type": "object" + }, + "QWAcceptChatRoomModel": { + "properties": { + "Link": { + "example": "", + "type": "string" + }, + "Opcode": { + "format": "uint32", + "type": "integer" + } + }, + "title": "QWAcceptChatRoomModel", + "type": "object" + }, + "QWAddChatRoomMemberModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "ToUserName": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "QWAddChatRoomMemberModel", + "type": "object" + }, + "QWAdminAcceptJoinChatRoomSetModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "P": { + "format": "int64", + "type": "integer" + } + }, + "title": "QWAdminAcceptJoinChatRoomSetModel", + "type": "object" + }, + "QWApplyAddContactModel": { + "properties": { + "Content": { + "example": "", + "type": "string" + }, + "UserName": { + "example": "", + "type": "string" + }, + "V1": { + "example": "", + "type": "string" + } + }, + "title": "QWApplyAddContactModel", + "type": "object" + }, + "QWChatRoomTransferOwnerModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "QWChatRoomTransferOwnerModel", + "type": "object" + }, + "QWContactModel": { + "properties": { + "ChatRoom": { + "example": "", + "type": "string" + }, + "T": { + "example": "", + "type": "string" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "QWContactModel", + "type": "object" + }, + "QWCreateModel": { + "properties": { + "ToUserName": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "QWCreateModel", + "type": "object" + }, + "QWModChatRoomNameModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "Name": { + "example": "", + "type": "string" + } + }, + "title": "QWModChatRoomNameModel", + "type": "object" + }, + "QWRemarkModel": { + "properties": { + "Name": { + "example": "", + "type": "string" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "QWRemarkModel", + "type": "object" + }, + "QWSyncChatRoomModel": { + "properties": { + "Key": { + "example": "", + "type": "string" + } + }, + "title": "QWSyncChatRoomModel", + "type": "object" + }, + "ReadParam": { + "properties": { + "Url": { + "description": " 公众号文章URL", + "example": "", + "type": "string" + } + }, + "title": "ReadParam", + "type": "object" + }, + "RedPacket": { + "properties": { + "Amount": { + "description": " 每个红包的金额(单位为分, 最小为100); 总金额为 Amount*Count", + "format": "uint32", + "type": "integer" + }, + "Content": { + "description": " 红包的备注内容(祝福语)", + "example": "", + "type": "string" + }, + "Count": { + "description": " 红包个数(最少为1)", + "format": "uint32", + "type": "integer" + }, + "From": { + "description": " InAway(0:群红包; 1:个人红包)", + "format": "uint32", + "type": "integer" + }, + "RedType": { + "description": " 红包类型(0 普通红包; 1 拼手气红包; ? 专属红包)", + "format": "uint32", + "type": "integer" + }, + "Username": { + "description": " 红包接收者; wxid 或 群ID", + "example": "", + "type": "string" + } + }, + "title": "RedPacket", + "type": "object" + }, + "ReplyCommentItem": { + "properties": { + "NickName": { + "description": " 发表评论的昵称", + "example": "", + "type": "string" + }, + "OpType": { + "description": " 操作类型：评论/点赞", + "format": "uint32", + "type": "integer" + }, + "Source": { + "description": " source", + "format": "uint32", + "type": "integer" + }, + "UserName": { + "description": " 评论的微信ID", + "example": "", + "type": "string" + } + }, + "title": "ReplyCommentItem", + "type": "object" + }, + "ReplyKeywordsItem": { + "properties": { + "Content": { + "description": " 回复的内容", + "example": "", + "type": "string" + }, + "Keyword": { + "description": " 触发的关键词", + "example": "", + "type": "string" + }, + "MsgType": { + "description": " 收到消息时的类型：1-文本 3-图片 24-笔记 33-小程序 42-名片 49-链接", + "format": "int32", + "type": "integer" + }, + "NewMsgId": { + "description": " 新消息ID 引用了文件助手某条消息时用这个字段", + "example": "", + "type": "string" + }, + "SendType": { + "description": " 回复的类型，发送类型 1-文本 3-图片 49-笔记|链接 2002-小程序 42-名片", + "format": "int32", + "type": "integer" + } + }, + "title": "ReplyKeywordsItem", + "type": "object" + }, + "ResponseResult": { + "properties": { + "Code": { + "format": "int64", + "type": "integer" + }, + "Data": { + "$ref": "#/definitions/interface{}" + }, + "Data62": { + "example": "", + "type": "string" + }, + "Debug": { + "example": "", + "type": "string" + }, + "Message": { + "example": "", + "type": "string" + }, + "Success": { + "type": "boolean" + } + }, + "title": "ResponseResult", + "type": "object" + }, + "ResponseResult2": { + "properties": { + "Code": { + "format": "int64", + "type": "integer" + }, + "Data": { + "$ref": "#/definitions/interface{}" + }, + "Data62": { + "example": "", + "type": "string" + }, + "DeviceId": { + "example": "", + "type": "string" + }, + "Message": { + "example": "", + "type": "string" + }, + "Success": { + "type": "boolean" + } + }, + "title": "ResponseResult2", + "type": "object" + }, + "RevokeMsgModel": { + "properties": { + "ClientImgIdStr": { + "description": " 保存clientImgId的原始字符串值", + "example": "", + "type": "string" + }, + "ClientMsgId": { + "format": "uint64", + "type": "integer" + }, + "CreateTime": { + "format": "uint64", + "type": "integer" + }, + "IsImage": { + "description": " 标识是否为图片消息", + "type": "boolean" + }, + "NewMsgId": { + "example": "", + "type": "string" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "RevokeMsgModel", + "type": "object" + }, + "ScanIntoUrlGroupModel": { + "properties": { + "Url": { + "example": "", + "type": "string" + } + }, + "title": "ScanIntoUrlGroupModel", + "type": "object" + }, + "SearchContactModel": { + "properties": { + "FromScene": { + "format": "uint64", + "type": "integer" + }, + "Tg": { + "example": "", + "type": "string" + }, + "UserName": { + "example": "", + "type": "string" + } + }, + "title": "SearchContactModel", + "type": "object" + }, + "SearchContactRequestModel": { + "properties": { + "FromScene": { + "format": "uint32", + "type": "integer" + }, + "OpCode": { + "description": " 操作类型", + "format": "uint32", + "type": "integer" + }, + "SearchScene": { + "description": " 搜索场景", + "format": "uint32", + "type": "integer" + }, + "UserName": { + "description": " 要搜索的内容(微信号、手机号、QQ号等)", + "example": "", + "type": "string" + } + }, + "title": "SearchContactRequestModel", + "type": "object" + }, + "SendChangePwdRequestModel": { + "properties": { + "newPass": { + "example": "", + "type": "string" + }, + "oldPass": { + "description": " 确保json标签是`oldPass`", + "example": "", + "type": "string" + }, + "opCode": { + "format": "uint32", + "type": "integer" + } + }, + "title": "SendChangePwdRequestModel", + "type": "object" + }, + "SendEmojiItem": { + "properties": { + "EmojiMd5": { + "example": "", + "type": "string" + }, + "EmojiSize": { + "format": "int32", + "type": "integer" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "SendEmojiItem", + "type": "object" + }, + "SendEmojiMessageModel": { + "properties": { + "EmojiList": { + "items": { + "$ref": "#/definitions/SendEmojiItem" + }, + "type": "array" + } + }, + "title": "SendEmojiMessageModel", + "type": "object" + }, + "SendFavItemCircle": { + "properties": { + "BlackList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "FavItemID": { + "format": "uint32", + "type": "integer" + }, + "Location": { + "$ref": "#/definitions/baseinfo.Location" + }, + "LocationVal": { + "format": "int64", + "type": "integer" + }, + "SourceID": { + "example": "", + "type": "string" + } + }, + "title": "SendFavItemCircle", + "type": "object" + }, + "SendMessageModel": { + "properties": { + "MsgItem": { + "description": " 消息体数组", + "items": { + "$ref": "#/definitions/MessageItem" + }, + "type": "array" + } + }, + "title": "SendMessageModel", + "type": "object" + }, + "SendModifyRemarkRequestModel": { + "properties": { + "RemarkName": { + "example": "", + "type": "string" + }, + "UserName": { + "example": "", + "type": "string" + } + }, + "title": "SendModifyRemarkRequestModel", + "type": "object" + }, + "SendPatModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "Scene": { + "format": "int64", + "type": "integer" + }, + "ToUserName": { + "example": "", + "type": "string" + } + }, + "title": "SendPatModel", + "type": "object" + }, + "SendSnsCommentRequestModel": { + "properties": { + "SnsCommentList": { + "items": { + "$ref": "#/definitions/SnsCommentItem" + }, + "type": "array" + }, + "Tx": { + "type": "boolean" + } + }, + "title": "SendSnsCommentRequestModel", + "type": "object" + }, + "SendSnsObjectOpRequestModel": { + "properties": { + "SnsObjectOpList": { + "items": { + "$ref": "#/definitions/SnsObjectOpItem" + }, + "type": "array" + } + }, + "title": "SendSnsObjectOpRequestModel", + "type": "object" + }, + "SendUploadVoiceRequestModel": { + "properties": { + "ToUserName": { + "example": "", + "type": "string" + }, + "VoiceData": { + "example": "", + "type": "string" + }, + "VoiceFormat": { + "format": "int32", + "type": "integer" + }, + "VoiceSecond,": { + "format": "int32", + "type": "integer" + } + }, + "title": "SendUploadVoiceRequestModel", + "type": "object" + }, + "SessionidQRParam": { + "properties": { + "Code": { + "format": "int64", + "type": "integer" + }, + "Data": { + "$ref": "#/definitions/interface{}" + }, + "Data62": { + "example": "", + "type": "string" + }, + "DeviceId": { + "example": "", + "type": "string" + }, + "Message": { + "example": "", + "type": "string" + }, + "Success": { + "type": "boolean" + } + }, + "title": "SessionidQRParam", + "type": "object" + }, + "SetBackgroundImageModel": { + "properties": { + "Url": { + "example": "", + "type": "string" + } + }, + "title": "SetBackgroundImageModel", + "type": "object" + }, + "SetChatroomAccessVerifyModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "Enable": { + "type": "boolean" + } + }, + "title": "SetChatroomAccessVerifyModel", + "type": "object" + }, + "SetFriendCircleDaysModel": { + "properties": { + "Function": { + "format": "uint32", + "type": "integer" + }, + "Value": { + "format": "uint32", + "type": "integer" + } + }, + "title": "SetFriendCircleDaysModel", + "type": "object" + }, + "SetSendPatModel": { + "properties": { + "Value": { + "example": "", + "type": "string" + } + }, + "title": "SetSendPatModel", + "type": "object" + }, + "ShareCardParam": { + "properties": { + "CardAlias": { + "description": " 名片别名(发送公众号名片时留空)", + "example": "", + "type": "string" + }, + "CardFlag": { + "description": " 名片CertFlag(0:个人名片 24:公众号名片)", + "format": "int", + "type": "integer" + }, + "CardNickName": { + "description": " 名片昵称", + "example": "", + "type": "string" + }, + "CardWxId": { + "description": " 名片wxid", + "example": "", + "type": "string" + }, + "ToUserName": { + "description": " 消息接收者", + "example": "", + "type": "string" + } + }, + "title": "ShareCardParam", + "type": "object" + }, + "ShopLoginConfirmModel": { + "properties": { + "url": { + "description": " 登录二维码URL", + "example": "", + "type": "string" + } + }, + "title": "ShopLoginConfirmModel", + "type": "object" + }, + "Size": { + "properties": { + "Height": { + "example": "", + "type": "string" + }, + "TotalSize": { + "example": "", + "type": "string" + }, + "Width": { + "example": "", + "type": "string" + } + }, + "title": "Size", + "type": "object" + }, + "SlideTicketModel": { + "properties": { + "data62": { + "description": " 验证码", + "example": "", + "type": "string" + }, + "randstr": { + "$ref": "#/definitions/bingding:\"required\"`" + }, + "slideticket": { + "example": "", + "type": "string" + }, + "ticket": { + "description": " 验证码", + "example": "", + "type": "string" + } + }, + "title": "SlideTicketModel", + "type": "object" + }, + "SnsCommentItem": { + "properties": { + "Content": { + "description": " 评论内容", + "example": "", + "type": "string" + }, + "CreateTime": { + "description": " 创建时间", + "format": "uint32", + "type": "integer" + }, + "ItemID": { + "description": " 朋友圈项ID", + "example": "", + "type": "string" + }, + "OpType": { + "description": " 操作类型：评论/点赞", + "format": "uint32", + "type": "integer" + }, + "ReplyCommentID": { + "description": " 回复的评论ID", + "format": "uint32", + "type": "integer" + }, + "ReplyItem": { + "$ref": "#/definitions/ReplyCommentItem", + "description": " 回覆的评论项" + }, + "ToUserName": { + "description": " 好友微信ID", + "example": "", + "type": "string" + } + }, + "title": "SnsCommentItem", + "type": "object" + }, + "SnsLocationInfoModel": { + "properties": { + "City": { + "example": "", + "type": "string" + }, + "Latitude": { + "example": "", + "type": "string" + }, + "Longitude": { + "example": "", + "type": "string" + }, + "PoiAddress": { + "example": "", + "type": "string" + }, + "PoiClassifyID": { + "example": "", + "type": "string" + }, + "PoiClassifyType": { + "format": "uint32", + "type": "integer" + }, + "PoiClickableStatus": { + "format": "uint32", + "type": "integer" + }, + "PoiInfoURL": { + "example": "", + "type": "string" + }, + "PoiName": { + "example": "", + "type": "string" + }, + "PoiScale": { + "format": "int32", + "type": "integer" + } + }, + "title": "SnsLocationInfoModel", + "type": "object" + }, + "SnsMediaItemModel": { + "properties": { + "Description": { + "example": "", + "type": "string" + }, + "ID": { + "format": "uint32", + "type": "integer" + }, + "MD5": { + "example": "", + "type": "string" + }, + "Private": { + "format": "uint32", + "type": "integer" + }, + "SizeHeight": { + "example": "", + "type": "string" + }, + "SizeWidth": { + "example": "", + "type": "string" + }, + "SubType": { + "format": "uint32", + "type": "integer" + }, + "ThumType": { + "example": "", + "type": "string" + }, + "Thumb": { + "example": "", + "type": "string" + }, + "Title": { + "example": "", + "type": "string" + }, + "TotalSize": { + "example": "", + "type": "string" + }, + "Type": { + "format": "uint32", + "type": "integer" + }, + "URL": { + "example": "", + "type": "string" + }, + "URLType": { + "example": "", + "type": "string" + }, + "UserData": { + "example": "", + "type": "string" + }, + "VideoDuration": { + "format": "double", + "type": "number" + }, + "VideoHeight": { + "example": "", + "type": "string" + }, + "VideoMD5": { + "example": "", + "type": "string" + }, + "VideoWidth": { + "example": "", + "type": "string" + } + }, + "title": "SnsMediaItemModel", + "type": "object" + }, + "SnsObjectOpItem": { + "properties": { + "Data": { + "description": " 其它数据", + "items": { + "format": "int", + "type": "integer" + }, + "type": "array" + }, + "DataLen": { + "description": " 其它数据长度", + "format": "uint32", + "type": "integer" + }, + "Ext": { + "format": "uint32", + "type": "integer" + }, + "OpType": { + "description": " 操作码", + "format": "uint32", + "type": "integer" + }, + "SnsObjID": { + "description": " 朋友圈ID", + "example": "", + "type": "string" + } + }, + "title": "SnsObjectOpItem", + "type": "object" + }, + "SnsObjectOpRequestModel": { + "properties": { + "SnsObjectOpList": { + "items": { + "$ref": "#/definitions/SnsObjectOpItem" + }, + "type": "array" + } + }, + "title": "SnsObjectOpRequestModel", + "type": "object" + }, + "SnsPostItemModel": { + "properties": { + "BlackList": { + "description": " 不可见好友列表", + "items": { + "type": "string" + }, + "type": "array" + }, + "Content": { + "description": " 文本内容", + "example": "", + "type": "string" + }, + "ContentStyle": { + "description": " 纯文字/图文/引用/视频", + "format": "uint32", + "type": "integer" + }, + "ContentUrl": { + "example": "", + "type": "string" + }, + "Description": { + "example": "", + "type": "string" + }, + "GroupUserList": { + "description": " 可见好友列表", + "items": { + "type": "string" + }, + "type": "array" + }, + "LocationInfo": { + "$ref": "#/definitions/SnsLocationInfoModel", + "description": " 发送朋友圈的位置信息" + }, + "MediaList": { + "description": " 图片/视频列表", + "items": { + "$ref": "#/definitions/SnsMediaItemModel" + }, + "type": "array" + }, + "Privacy": { + "description": " 是否仅自己可见", + "format": "uint32", + "type": "integer" + }, + "WithUserList": { + "description": " 提醒好友看列表", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "SnsPostItemModel", + "type": "object" + }, + "StreamVideo": { + "properties": { + "StreamVideoThumbURL": { + "example": "", + "type": "string" + }, + "StreamVideoURL": { + "example": "", + "type": "string" + }, + "StreamVideoWebURL": { + "example": "", + "type": "string" + } + }, + "title": "StreamVideo", + "type": "object" + }, + "SyncMessageModel": { + "properties": { + "Count": { + "description": " 同步几条消息; 接收空请求体, 默认为0, 同步所有消息", + "format": "int", + "type": "integer" + } + }, + "title": "SyncMessageModel", + "type": "object" + }, + "Thumb": { + "properties": { + "EncIdx": { + "example": "", + "type": "string" + }, + "Key": { + "example": "", + "type": "string" + }, + "Token": { + "example": "", + "type": "string" + }, + "Type": { + "example": "", + "type": "string" + }, + "Value": { + "example": "", + "type": "string" + } + }, + "title": "Thumb", + "type": "object" + }, + "TimelineObject": { + "properties": { + "ActionInfo": { + "$ref": "#/definitions/ActionInfo" + }, + "AppInfo": { + "$ref": "#/definitions/AppInfo" + }, + "ContentDesc": { + "example": "", + "type": "string" + }, + "ContentDescScene": { + "format": "uint32", + "type": "integer" + }, + "ContentDescShowType": { + "format": "uint32", + "type": "integer" + }, + "ContentObject": { + "$ref": "#/definitions/ContentObject" + }, + "ContentObjectVideo": { + "$ref": "#/definitions/ContentObjectVideo" + }, + "CreateTime": { + "format": "uint32", + "type": "integer" + }, + "ID": { + "format": "uint64", + "type": "integer" + }, + "Location": { + "$ref": "#/definitions/Location" + }, + "Private": { + "format": "uint32", + "type": "integer" + }, + "PublicUserName": { + "example": "", + "type": "string" + }, + "ShowFlag": { + "format": "uint32", + "type": "integer" + }, + "SightFolded": { + "format": "uint32", + "type": "integer" + }, + "SourceNickName": { + "example": "", + "type": "string" + }, + "SourceUserName": { + "example": "", + "type": "string" + }, + "StatExtStr": { + "example": "", + "type": "string" + }, + "StatisticsData": { + "example": "", + "type": "string" + }, + "StreamVideo": { + "$ref": "#/definitions/StreamVideo" + }, + "UserName": { + "example": "", + "type": "string" + } + }, + "title": "TimelineObject", + "type": "object" + }, + "TransferGroupOwnerModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "NewOwnerUserName": { + "example": "", + "type": "string" + } + }, + "title": "TransferGroupOwnerModel", + "type": "object" + }, + "TransmitFriendCircleModel": { + "properties": { + "SourceID": { + "example": "", + "type": "string" + } + }, + "title": "TransmitFriendCircleModel", + "type": "object" + }, + "URL": { + "properties": { + "EncIdx": { + "example": "", + "type": "string" + }, + "Key": { + "example": "", + "type": "string" + }, + "MD5": { + "example": "", + "type": "string" + }, + "Token": { + "example": "", + "type": "string" + }, + "Type": { + "example": "", + "type": "string" + }, + "Value": { + "example": "", + "type": "string" + }, + "VideoMD5": { + "example": "", + "type": "string" + } + }, + "title": "URL", + "type": "object" + }, + "UpdateAutopassModel": { + "properties": { + "SwitchType": { + "format": "uint32", + "type": "integer" + } + }, + "title": "UpdateAutopassModel", + "type": "object" + }, + "UpdateChatroomAnnouncementModel": { + "properties": { + "ChatRoomName": { + "description": " 群聊ID：xxx@chatroom", + "example": "", + "type": "string" + }, + "Content": { + "example": "", + "type": "string" + } + }, + "title": "UpdateChatroomAnnouncementModel", + "type": "object" + }, + "UpdateNickNameModel": { + "properties": { + "Scene": { + "format": "uint32", + "type": "integer" + }, + "Val": { + "example": "", + "type": "string" + } + }, + "title": "UpdateNickNameModel", + "type": "object" + }, + "UpdateSexModel": { + "properties": { + "City": { + "example": "", + "type": "string" + }, + "Country": { + "example": "", + "type": "string" + }, + "Province": { + "example": "", + "type": "string" + }, + "Sex": { + "format": "uint32", + "type": "integer" + } + }, + "title": "UpdateSexModel", + "type": "object" + }, + "UpdateStepNumberModel": { + "properties": { + "Number": { + "format": "uint64", + "type": "integer" + } + }, + "title": "UpdateStepNumberModel", + "type": "object" + }, + "UploadAppAttachModel": { + "properties": { + "fileData": { + "example": "", + "type": "string" + } + }, + "title": "UploadAppAttachModel", + "type": "object" + }, + "UploadFriendCircleModel": { + "properties": { + "ImageDataList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "VideoDataList": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "title": "UploadFriendCircleModel", + "type": "object" + }, + "UploadHeadImageModel": { + "properties": { + "Base64": { + "example": "", + "type": "string" + } + }, + "title": "UploadHeadImageModel", + "type": "object" + }, + "UploadImageToCDNModel": { + "properties": { + "imageContent": { + "description": " 图片的base64编码", + "example": "", + "type": "string" + } + }, + "title": "UploadImageToCDNModel", + "type": "object" + }, + "UploadMContactModel": { + "properties": { + "Mobile": { + "example": "", + "type": "string" + }, + "MobileList": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Opcode": { + "format": "int32", + "type": "integer" + } + }, + "title": "UploadMContactModel", + "type": "object" + }, + "UserRankLikeModel": { + "properties": { + "RankId": { + "example": "", + "type": "string" + } + }, + "title": "UserRankLikeModel", + "type": "object" + }, + "VerifyCodeModel": { + "properties": { + "code": { + "description": " 验证码", + "example": "", + "type": "string" + }, + "data62": { + "description": " 验证码", + "example": "", + "type": "string" + }, + "ticket": { + "description": " 验证码", + "example": "", + "type": "string" + } + }, + "title": "VerifyCodeModel", + "type": "object" + }, + "VerifyUserItem": { + "properties": { + "Gh": { + "example": "", + "type": "string" + }, + "Scene": { + "format": "int", + "type": "integer" + } + }, + "title": "VerifyUserItem", + "type": "object" + }, + "VerifyUserRequestModel": { + "properties": { + "ChatRoomUserName": { + "description": " 通过群来添加好友 需要设置此值为群id", + "example": "", + "type": "string" + }, + "OpCode": { + "description": " 操作类型: 1(免验证发送请求) 2(添加好友/发送验证申请) 3(同意好友/通过好友验证) 4(拒绝好友)", + "example": "2", + "format": "uint32", + "type": "integer" + }, + "Scene": { + "description": " 添加来源, 同意添加好友时传回调消息xml中的scene值.\u003cbr/\u003e添加好友时的枚举值如下: \u003cbr/\u003e1(QQ) 2(邮箱) 3(微信号) 4(QQ好友) 8(来自群聊) 13(通讯录)\u003cbr/\u003e14(群聊) 15(手机号) 18(附近的人) 25(漂流瓶) 29(摇一摇) 30(二维码)", + "example": "3", + "format": "int", + "type": "integer" + }, + "V3": { + "description": " V3用户名数据(SearchContact请求返回的UserValue)", + "example": "", + "type": "string" + }, + "V4": { + "description": " V4校验数据(SearchContact请求返回的AntispamTicket)", + "example": "", + "type": "string" + }, + "VerifyContent": { + "description": " 添加好友时的(招呼语/验证信息)", + "example": "", + "type": "string" + } + }, + "title": "VerifyUserRequestModel", + "type": "object" + }, + "VideoSize": { + "properties": { + "Height": { + "example": "", + "type": "string" + }, + "Width": { + "example": "", + "type": "string" + } + }, + "title": "VideoSize", + "type": "object" + }, + "WelcomeNewMemberRequestModel": { + "properties": { + "Enable": { + "description": " 是否开启欢迎新人入群", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Mode": { + "description": " 模式，1-仅欢迎设置群，0-不欢迎设置群", + "example": "1", + "format": "int32", + "type": "integer" + }, + "Rooms": { + "description": " 设置的群", + "example": "", + "type": "string" + }, + "WelcomeMsg": { + "description": " 欢迎语内容（仅一条）", + "example": "", + "type": "string" + } + }, + "title": "WelcomeNewMemberRequestModel", + "type": "object" + }, + "WxBindOpMobileForModel": { + "properties": { + "OpCode": { + "format": "int64", + "type": "integer" + }, + "PhoneNumber": { + "example": "", + "type": "string" + }, + "Proxy": { + "example": "", + "type": "string" + }, + "Reg": { + "format": "uint64", + "type": "integer" + }, + "VerifyCode": { + "example": "", + "type": "string" + } + }, + "title": "WxBindOpMobileForModel", + "type": "object" + }, + "WxFunctionSwitchModel": { + "properties": { + "Function": { + "format": "uint32", + "type": "integer" + }, + "Value": { + "format": "uint32", + "type": "integer" + } + }, + "title": "WxFunctionSwitchModel", + "type": "object" + }, + "baseinfo.Location": { + "properties": { + "City": { + "example": "", + "type": "string" + }, + "Latitude": { + "example": "", + "type": "string" + }, + "Longitude": { + "example": "", + "type": "string" + }, + "PoiAddress": { + "example": "", + "type": "string" + }, + "PoiClassifyID": { + "example": "", + "type": "string" + }, + "PoiClassifyType": { + "format": "uint32", + "type": "integer" + }, + "PoiName": { + "example": "", + "type": "string" + } + }, + "title": "baseinfo.Location", + "type": "object" + }, + "baseinfo.UserLabelInfoItem": { + "properties": { + "LabelIDList": { + "example": "", + "type": "string" + }, + "UserName": { + "example": "", + "type": "string" + } + }, + "title": "baseinfo.UserLabelInfoItem", + "type": "object" + } + }, + "info": { + "contact": "", + "description": "API 文档", + "title": "BIMWE_API", + "version": "1.0.0" + }, + "paths": { + "/admin/DelayAuthKey": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DelayAuthKeyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "授权码延期", + "tags": [ + "管理" + ] + } + }, + "/admin/DeleteAuthKey": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DeleteAuthKeyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除授权码", + "tags": [ + "管理" + ] + } + }, + "/admin/DisableAuthKey": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/BannedAuthKeyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "禁用授权码", + "tags": [ + "管理" + ] + } + }, + "/admin/GenAuthKey1": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GenAuthKeyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "生成授权码(新设备)", + "tags": [ + "管理" + ] + } + }, + "/admin/GenAuthKey2": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "生成授权码(新设备)", + "tags": [ + "管理" + ] + } + }, + "/admin/GenAuthKey3": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GenAuthKeyTypeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "生成授权码(1-日 7-周 30-月 90-季 180-半年 365-年 30000-永久)此key不使用无过期时间", + "tags": [ + "管理" + ] + } + }, + "/admin/GetActiveLicenseKeys": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "查询所有激活状态的卡密", + "tags": [ + "管理" + ] + } + }, + "/admin/GetProxyMappingList": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取代理映射列表", + "tags": [ + "管理" + ] + } + }, + "/admin/HttpSyncLicenseKey": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "同步卡密激活状态, HTTP-轮询方式", + "tags": [ + "管理" + ] + } + }, + "/applet/AuthMpLogin": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetMpA8KeyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "授权公众号登录", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/FollowGH": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/FollowGHModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "关注公众号", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/GetA8Key": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetA8KeyRequestModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "授权链接", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/GetAppMsgExt": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ReadParam" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "阅读公众号文章", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/GetAppMsgExtLike": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ReadParam" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "点赞公众号文章", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/GetAppMsgReadCount": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ReadParam" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取公众号文章阅读数", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/GetMpA8Key": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetMpA8KeyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "授权链接", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/GetMpHistoryMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetMpHistoryMsgModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取公众号历史消息", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/JSOperateWxData": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AppletModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "小程序云函数操作", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/JsLogin": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AppletModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "授权小程序(返回授权后的code)", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/QRConnectAuthorize": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QRConnectAuthorizeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "二维码授权请求", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/QRConnectAuthorizeConfirm": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QRConnectAuthorizeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "二维码授权确认", + "tags": [ + "公众号/小程序" + ] + } + }, + "/applet/SdkOauthAuthorize": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AppletModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "应用授权", + "tags": [ + "公众号/小程序" + ] + } + }, + "/equipment/DelSafeDevice": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DelSafeDeviceModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除安全设备", + "tags": [ + "设备" + ] + } + }, + "/equipment/GetBoundHardDevice": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取硬件设备情况", + "tags": [ + "设备" + ] + } + }, + "/equipment/GetOnlineInfo": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取在线设备信息", + "tags": [ + "设备" + ] + } + }, + "/equipment/GetSafetyInfo": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取安全设备列表", + "tags": [ + "设备" + ] + } + }, + "/favor/BatchDelFavItem": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/FavInfoModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除收藏", + "tags": [ + "收藏" + ] + } + }, + "/favor/FavSync": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "同步收藏", + "tags": [ + "收藏" + ] + } + }, + "/favor/GetFavItemId": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/FavInfoModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取收藏详细", + "tags": [ + "收藏" + ] + } + }, + "/favor/GetFavList": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/FavInfoModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取收藏list", + "tags": [ + "收藏" + ] + } + }, + "/finder/ChannelsLogin": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ChannelsLoginModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "视频号助手扫码登录", + "tags": [ + "视频号" + ] + } + }, + "/finder/FinderFollow": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/FinderFollowModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "关注取消", + "tags": [ + "视频号" + ] + } + }, + "/finder/FinderSearch": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/FinderSearchModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "视频号搜索", + "tags": [ + "视频号" + ] + } + }, + "/finder/FinderUserPrepare": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/FinderUserPrepareModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "视频号中心", + "tags": [ + "视频号" + ] + } + }, + "/friend/AgreeAdd": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/VerifyUserRequestModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "同意好友请求", + "tags": [ + "朋友" + ] + } + }, + "/friend/DelContact": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DelContactModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除好友", + "tags": [ + "朋友" + ] + } + }, + "/friend/GetContactDetailsList": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/BatchGetContactModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取联系人详情", + "tags": [ + "朋友" + ] + } + }, + "/friend/GetContactList": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetContactListModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取全部联系人", + "tags": [ + "朋友" + ] + } + }, + "/friend/GetFriendRelation": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetFriendRelationModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取好友关系", + "tags": [ + "朋友" + ] + } + }, + "/friend/GetGHList": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取关注的公众号列表", + "tags": [ + "朋友" + ] + } + }, + "/friend/GetMFriend": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取手机通讯录好友", + "tags": [ + "朋友" + ] + } + }, + "/friend/GroupList": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取保存的群聊列表", + "tags": [ + "朋友" + ] + } + }, + "/friend/SearchContact": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SearchContactRequestModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "搜索联系人", + "tags": [ + "朋友" + ] + } + }, + "/friend/UploadMContact": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UploadMContactModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "上传手机通讯录好友", + "tags": [ + "朋友" + ] + } + }, + "/friend/VerifyUser": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/VerifyUserRequestModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "验证好友/添加好友", + "tags": [ + "朋友" + ] + } + }, + "/group/AddChatRoomMembers": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/InviteChatroomMembersModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "添加群成员", + "tags": [ + "群管理" + ] + } + }, + "/group/AddChatroomAdmin": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ChatroomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "添加群管理员", + "tags": [ + "群管理" + ] + } + }, + "/group/CreateChatRoom": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/CreateChatRoomModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "创建群请求", + "tags": [ + "群管理" + ] + } + }, + "/group/DelChatroomAdmin": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ChatroomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除群管理员", + "tags": [ + "群管理" + ] + } + }, + "/group/GetChatRoomInfo": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ChatRoomWxIdListModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取群详情", + "tags": [ + "群管理" + ] + } + }, + "/group/GetChatroomMemberDetail": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetChatroomMemberDetailModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取群成员详细", + "tags": [ + "群管理" + ] + } + }, + "/group/GetChatroomQrCode": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetChatroomQrCodeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取群二维码", + "tags": [ + "群管理" + ] + } + }, + "/group/InviteChatroomMembers": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/InviteChatroomMembersModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "邀请群成员", + "tags": [ + "群管理" + ] + } + }, + "/group/MoveToContract": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MoveContractModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取群聊", + "tags": [ + "群管理" + ] + } + }, + "/group/QuitChatroom": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetChatroomMemberDetailModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "退出群聊", + "tags": [ + "群管理" + ] + } + }, + "/group/ScanIntoUrlGroup": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ScanIntoUrlGroupModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "扫码入群", + "tags": [ + "群管理" + ] + } + }, + "/group/SendDelDelChatRoomMember": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/InviteChatroomMembersModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除群成员", + "tags": [ + "群管理" + ] + } + }, + "/group/SendPat": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendPatModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "群拍一拍功能", + "tags": [ + "群管理" + ] + } + }, + "/group/SendTransferGroupOwner": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/TransferGroupOwnerModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "转让群", + "tags": [ + "群管理" + ] + } + }, + "/group/SetChatroomAccessVerify": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SetChatroomAccessVerifyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置群聊邀请开关", + "tags": [ + "群管理" + ] + } + }, + "/group/SetChatroomAnnouncement": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UpdateChatroomAnnouncementModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置群公告", + "tags": [ + "群管理" + ] + } + }, + "/group/SetChatroomName": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ChatroomNameModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置群昵称", + "tags": [ + "群管理" + ] + } + }, + "/group/SetGetChatRoomInfoDetail": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetChatroomMemberDetailModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取群公告", + "tags": [ + "群管理" + ] + } + }, + "/group/SetGroupNickname": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ChatroomNameModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置我在本群的昵称", + "tags": [ + "群管理" + ] + } + }, + "/group/ToJoinGroup": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ConsentToJoinGroupModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "同意入群", + "tags": [ + "群管理" + ] + } + }, + "/label/AddContactLabel": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/LabelModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "添加列表", + "tags": [ + "标签" + ] + } + }, + "/label/DelContactLabel": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/LabelModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除标签", + "tags": [ + "标签" + ] + } + }, + "/label/GetContactLabelList": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取标签列表", + "tags": [ + "标签" + ] + } + }, + "/label/GetWXFriendListByLabel": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/LabelModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取标签下所有好友", + "tags": [ + "标签" + ] + } + }, + "/label/ModifyLabel": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/LabelModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改标签", + "tags": [ + "标签" + ] + } + }, + "/login/A16Login": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DeviceIdLoginModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "数据登录", + "tags": [ + "登录" + ] + } + }, + "/login/CheckLoginStatus": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "检测扫码状态", + "tags": [ + "登录" + ] + } + }, + "/login/DeviceLogin": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DeviceIdLoginModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "62账号密码登录", + "tags": [ + "登录" + ] + } + }, + "/login/GetLoginQrCodeNewDirect": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetLoginQrCodeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取登录二维码-直登(异地IP必须用代理! socks5://username:password@ipv4:port)", + "tags": [ + "登录" + ] + } + }, + "/login/GetLoginStatus": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取在线状态", + "tags": [ + "登录" + ] + } + }, + "/login/LogOut": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "退出登录", + "tags": [ + "登录" + ] + } + }, + "/login/VerifyCode": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/VerifyCodeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "验证码验证(输入iPad登录验证码)", + "tags": [ + "登录" + ] + } + }, + "/login/VerifyCodeSlide": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SlideTicketModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "过mac滑块验证", + "tags": [ + "登录" + ] + } + }, + "/login/WakeUpLogin": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetLoginQrCodeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "唤醒登录(只限扫码登录)", + "tags": [ + "登录" + ] + } + }, + "/message/AddMessageMgr": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "添加要发送的文本消息进入管理器", + "tags": [ + "消息" + ] + } + }, + "/message/CdnUploadVideo": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/CdnUploadVideoRequest" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "上传视频", + "tags": [ + "消息" + ] + } + }, + "/message/DeleteCallback": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除消息回调配置", + "tags": [ + "消息回调" + ] + } + }, + "/message/DownloadEmojiGif": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DownloadEmojiModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "下载表情", + "tags": [ + "消息" + ] + } + }, + "/message/ForwardEmoji": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendEmojiMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "转发表情，包含动图", + "tags": [ + "消息" + ] + } + }, + "/message/ForwardImageMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ForwardMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "转发图片", + "tags": [ + "消息" + ] + } + }, + "/message/ForwardVideoMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ForwardMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "转发视频", + "tags": [ + "消息" + ] + } + }, + "/message/GetCallback": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取消息回调配置", + "tags": [ + "消息回调" + ] + } + }, + "/message/GetMsgBigImg": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DownloadParam" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取图片(高清图片下载)", + "tags": [ + "消息" + ] + } + }, + "/message/GetMsgVideo": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DownloadParam" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取视频(视频数据下载)", + "tags": [ + "消息" + ] + } + }, + "/message/GetMsgVoice": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DownloadVoiceModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "下载语音消息", + "tags": [ + "消息" + ] + } + }, + "/message/GroupMassMsgImage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GroupMassMsgImageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "群发图片", + "tags": [ + "消息" + ] + } + }, + "/message/GroupMassMsgText": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GroupMassMsgTextModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "群发接口", + "tags": [ + "消息" + ] + } + }, + "/message/HttpSyncMsg": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SyncMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "同步消息, HTTP-轮询方式", + "tags": [ + "消息" + ] + } + }, + "/message/NewSyncHistoryMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "同步历史消息", + "tags": [ + "消息" + ] + } + }, + "/message/RevokeMsg": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/RevokeMsgModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "撤销消息", + "tags": [ + "消息" + ] + } + }, + "/message/RevokeMsgNew": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/RevokeMsgModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "撤回消息（New）", + "tags": [ + "消息" + ] + } + }, + "/message/SendAppMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AppMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发送App消息", + "tags": [ + "消息" + ] + } + }, + "/message/SendCdnDownload": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DownMediaModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "下载 请求", + "tags": [ + "消息" + ] + } + }, + "/message/SendEmojiMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendEmojiMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发送表情", + "tags": [ + "消息" + ] + } + }, + "/message/SendImageMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发送图片消息", + "tags": [ + "消息" + ] + } + }, + "/message/SendImageNewMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发送图片消息（New）", + "tags": [ + "消息" + ] + } + }, + "/message/SendTextMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendMessageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发送文本消息", + "tags": [ + "消息" + ] + } + }, + "/message/SendVoice": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendUploadVoiceRequestModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发送语音", + "tags": [ + "消息" + ] + } + }, + "/message/SetCallback": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/MessageCallbackConfigModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置消息回调", + "tags": [ + "消息回调" + ] + } + }, + "/message/ShareCardMessage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ShareCardParam" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "分享名片消息", + "tags": [ + "消息" + ] + } + }, + "/message/TestCallback": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "测试消息回调配置", + "tags": [ + "消息回调" + ] + } + }, + "/message/UploadImageToCDN": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UploadImageToCDNModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "纯CDN图片上传接口", + "tags": [ + "消息" + ] + } + }, + "/other/GetPeopleNearby": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/PeopleNearbyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "查看附近的人", + "tags": [ + "其他" + ] + } + }, + "/other/GetProjectFullPath": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取项目完整路径", + "tags": [ + "其他" + ] + } + }, + "/other/GetRedisSyncMsg": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取缓存在redis中的消息", + "tags": [ + "其他" + ] + } + }, + "/other/GetUserRankLikeCount": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UserRankLikeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取步数排行数据列表", + "tags": [ + "其他" + ] + } + }, + "/other/QWImageDownload": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DownloadQWImageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "企微图片下载", + "tags": [ + "其他" + ] + } + }, + "/other/UpdateCmdStatus": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ModifyCmdStatusModelNew" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "更新指令状态, key 为指令 id，Value 为指令状态 0|1，ValueStr 为字符串值", + "tags": [ + "其他" + ] + } + }, + "/other/UpdateStepNumber": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UpdateStepNumberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改步数", + "tags": [ + "其他" + ] + } + }, + "/other/UploadAppAttach": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UploadAppAttachModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "上传文件", + "tags": [ + "其他" + ] + } + }, + "/pay/Collectmoney": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/CollectmoneyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "确定收款", + "tags": [ + "支付" + ] + } + }, + "/pay/ConfirmPreTransfer": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ConfirmPreTransfer" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "确认转账(客户端版本过低会无法转账)", + "tags": [ + "支付" + ] + } + }, + "/pay/CreatePreTransfer": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/CreatePreTransfer" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "创建转账", + "tags": [ + "支付" + ] + } + }, + "/pay/GeneratePayQCode": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GeneratePayQCodeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "生成自定义收款二维码", + "tags": [ + "支付" + ] + } + }, + "/pay/GetBandCardList": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取银行卡信息", + "tags": [ + "支付" + ] + } + }, + "/pay/GetRedEnvelopesDetail": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/HongBaoItem" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "查看红包详情", + "tags": [ + "支付" + ] + } + }, + "/pay/GetRedPacketList": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetRedPacketList" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "查看红包领取列表", + "tags": [ + "支付" + ] + } + }, + "/pay/OpenRedEnvelopes": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/HongBaoItem" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "拆红包", + "tags": [ + "支付" + ] + } + }, + "/pay/WXCreateRedPacket": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/RedPacket" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "创建红包", + "tags": [ + "支付" + ] + } + }, + "/qy/QWAcceptChatRoom": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAcceptChatRoomModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "同意进企业群", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWAddChatRoomMember": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAddChatRoomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "直接拉朋友进企业群", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWAdminAcceptJoinChatRoomSet": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAdminAcceptJoinChatRoomSetModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设定企业群管理审核进群", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWApplyAddContact": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWApplyAddContactModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "向企业微信打招呼", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWAppointChatRoomAdmin": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAddChatRoomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "增加企业管理员", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWChatRoomAnnounce": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWModChatRoomNameModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发布企业群公告", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWChatRoomTransferOwner": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWChatRoomTransferOwnerModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "转让企业群", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWContact": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWContactModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "提取企业 wx 详情", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWCreateChatRoom": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWCreateModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "创建企业群", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWDelChatRoom": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWModChatRoomNameModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除企业群", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWDelChatRoomAdmin": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAddChatRoomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "移除群管理员", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWDelChatRoomMember": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAddChatRoomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "删除企业群成员", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWGetChatRoomMember": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAddChatRoomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "提取企业群全部成员", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWGetChatRoomQR": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAddChatRoomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "提取企业群二维码", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWGetChatroomInfo": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAddChatRoomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "提取企业群名称公告设定等信息", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWInviteChatRoomMember": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWAddChatRoomMemberModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发送群邀请链接", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWModChatRoomMemberNick": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWModChatRoomNameModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改成员在群中呢称", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWModChatRoomName": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWModChatRoomNameModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改企业群名称", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWRemark": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWRemarkModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "备注企业 wxid", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWSearchContact": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SearchContactModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "搜手机或企业对外名片链接提取验证", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWSyncChatRoom": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/QWSyncChatRoomModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "提取全部企业微信群-", + "tags": [ + "企业微信" + ] + } + }, + "/qy/QWSyncContact": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "提取全部的企业通讯录", + "tags": [ + "企业微信" + ] + } + }, + "/shop/ExtDeviceLoginConfirmGet": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ShopLoginConfirmModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "", + "tags": [ + "/shop" + ] + } + }, + "/shop/ExtDeviceLoginConfirmOk": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ShopLoginConfirmModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "", + "tags": [ + "/shop" + ] + } + }, + "/shop/ScanQrcodeEventReport": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ShopLoginConfirmModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "", + "tags": [ + "/shop" + ] + } + }, + "/shop/ShopLoginConfirm": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ShopLoginConfirmModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "微信小店确认登录", + "tags": [ + "/shop" + ] + } + }, + "/sns/CdnSnsVideoUpload": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/CdnSnsVideoUploadModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "上传CDN朋友圈视频", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/DownloadMedia": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/DownloadMediaModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "下载朋友圈视频", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/GetCollectCircle": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendFavItemCircle" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取收藏朋友圈详情", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/GetSnsSync": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "同步朋友圈", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SendFavItemCircle": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendFavItemCircle" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "转发收藏朋友圈", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SendFriendCircle": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SnsPostItemModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发送朋友圈", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SendFriendCircleByXMl": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/TimelineObject" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "发送朋友圈XML结构", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SendOneIdCircle": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetIdDetailModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "一键转发朋友圈", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SendSnsComment": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendSnsCommentRequestModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "点赞评论", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SendSnsObjectDetailById": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetIdDetailModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取指定id朋友圈", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SendSnsObjectOp": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendSnsObjectOpRequestModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "朋友圈操作", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SendSnsTimeLine": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetSnsInfoModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取朋友圈主页", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SendSnsUserPage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetSnsInfoModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取指定人朋友圈", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SetBackgroundImage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SetBackgroundImageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置朋友圈背景图片", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/SetFriendCircleDays": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SetFriendCircleDaysModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置朋友圈可见天数", + "tags": [ + "朋友圈" + ] + } + }, + "/sns/UploadFriendCircleImage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UploadFriendCircleModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "上传图片信息", + "tags": [ + "朋友圈" + ] + } + }, + "/user/ChangePwd": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendChangePwdRequestModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "更改密码", + "tags": [ + "用户" + ] + } + }, + "/user/GetAdminKeyword": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取管理员关键词配置", + "tags": [ + "用户" + ] + } + }, + "/user/GetInviteKeyword": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取关键词邀请入群配置", + "tags": [ + "用户" + ] + } + }, + "/user/GetKeywordReply": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取关键词自动回复配置", + "tags": [ + "用户" + ] + } + }, + "/user/GetKickKeyword": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取踢人关键词配置", + "tags": [ + "用户" + ] + } + }, + "/user/GetMyQrCode": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetQrCodeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取我的二维码", + "tags": [ + "用户" + ] + } + }, + "/user/GetProfile": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取个人资料信息", + "tags": [ + "用户" + ] + } + }, + "/user/GetWelcome": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "获取欢迎词配置", + "tags": [ + "用户" + ] + } + }, + "/user/ModifyRemark": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SendModifyRemarkRequestModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改备注", + "tags": [ + "用户" + ] + } + }, + "/user/ModifyUserInfo": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ModifyUserInfo" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改资料", + "tags": [ + "用户" + ] + } + }, + "/user/ResetGender": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "重置性别", + "tags": [ + "用户" + ] + } + }, + "/user/SetAdminKeyword": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SetAdminKeywordModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置管理员关键词配置", + "tags": [ + "用户" + ] + } + }, + "/user/SetFunctionSwitch": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/WxFunctionSwitchModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置添加我的方式", + "tags": [ + "用户" + ] + } + }, + "/user/SetInviteKeyword": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SetInviteKeywordModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置关键词邀请入群配置", + "tags": [ + "用户" + ] + } + }, + "/user/SetKeywordReply": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SetKeywordReplyModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置关键词自动回复", + "tags": [ + "用户" + ] + } + }, + "/user/SetKickKeyword": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SetKickKeywordModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置踢人关键词配置", + "tags": [ + "用户" + ] + } + }, + "/user/SetNickName": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UpdateNickNameModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置昵称", + "tags": [ + "用户" + ] + } + }, + "/user/SetProxy": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/GetLoginQrCodeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改Socks5代理 socks5://username:password@ipv4:", + "tags": [ + "用户" + ] + } + }, + "/user/SetSendPat": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SetSendPatModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置拍一拍名称", + "tags": [ + "用户" + ] + } + }, + "/user/SetSexDq": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UpdateSexModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改性别", + "tags": [ + "用户" + ] + } + }, + "/user/SetSignature": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UpdateNickNameModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改签名", + "tags": [ + "用户" + ] + } + }, + "/user/SetWechat": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AlisaModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置微信号", + "tags": [ + "用户" + ] + } + }, + "/user/SetWelcome": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/SetWelcomeModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "设置欢迎词配置", + "tags": [ + "用户" + ] + } + }, + "/user/UpdateAutoPass": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UpdateAutopassModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改加好友需要验证属性", + "tags": [ + "用户" + ] + } + }, + "/user/UpdateNickName": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UpdateNickNameModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "修改名称", + "tags": [ + "用户" + ] + } + }, + "/user/UploadHeadImage": { + "post": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + }, + { + "description": "请求参数", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/UploadHeadImageModel" + } + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "上传头像", + "tags": [ + "用户" + ] + } + }, + "/ws/GetSyncMsg": { + "get": { + "parameters": [ + { + "description": "账号唯一标识", + "in": "query", + "name": "key", + "type": "string" + } + ], + "responses": { + "200": { + "description": "" + } + }, + "summary": "如果 \"key\" 有效，则调用 WebSocketHandler 进行后续处理。", + "tags": [ + "同步消息" + ] + } + } + }, + "swagger": "2.0", + "tags": [ + { + "description": "消息回调接口", + "name": "消息回调" + }, + { + "description": "/login", + "name": "登录" + }, + { + "description": "/message", + "name": "消息" + }, + { + "description": "/pay", + "name": "支付" + }, + { + "description": "/friend", + "name": "朋友" + }, + { + "description": "/user", + "name": "用户" + }, + { + "description": "/group", + "name": "群管理" + }, + { + "description": "/admin", + "name": "管理" + }, + { + "description": "/label", + "name": "标签" + }, + { + "description": "/ws", + "name": "同步消息" + }, + { + "description": "/sns", + "name": "朋友圈" + }, + { + "description": "/equipment", + "name": "设备" + }, + { + "description": "/applet", + "name": "公众号/小程序" + }, + { + "description": "/favor", + "name": "收藏" + }, + { + "description": "/finder", + "name": "视频号" + }, + { + "description": "/qy", + "name": "企业微信" + }, + { + "description": "/other", + "name": "其他" + }, + { + "description": "/shop", + "name": "/shop" + } + ] +} \ No newline at end of file diff --git a/_docs/接口说明文档-完整版-含营销等级.md b/_docs/接口说明文档-完整版-含营销等级.md new file mode 100644 index 0000000..14f85c9 --- /dev/null +++ b/_docs/接口说明文档-完整版-含营销等级.md @@ -0,0 +1,7125 @@ +# WeChat智能托管 API 接口说明文档 + +## 1. 文档说明 + +- 数据来源：`API文档` +- 解析口径：严格按 Swagger 输出参数与字段说明 +- 接口总数：**193**（`Method + Path`） + +## 2. 套餐统计 + +| 套餐 | 接口数 | +|---|---:| +| 初级版 | 68 | +| 高级版 | 79 | +| 定制版 | 37 | +| 白标/OEM | 9 | + +## 3. 按模块统计 + +| 模块 | 接口数 | 初级版 | 高级版 | 定制版 | 白标/OEM | +|---|---:|---:|---:|---:|---:| +| 企业微信 | 22 | 0 | 0 | 22 | 0 | +| 公众号/小程序 | 13 | 0 | 13 | 0 | 0 | +| 其他 | 8 | 0 | 8 | 0 | 0 | +| 同步消息 | 1 | 0 | 1 | 0 | 0 | +| 好友 | 11 | 7 | 4 | 0 | 0 | +| 微信小店 | 4 | 0 | 0 | 4 | 0 | +| 支付 | 9 | 0 | 9 | 0 | 0 | +| 收藏 | 4 | 0 | 4 | 0 | 0 | +| 朋友圈 | 16 | 10 | 6 | 0 | 0 | +| 标签 | 5 | 5 | 0 | 0 | 0 | +| 消息 | 24 | 9 | 15 | 0 | 0 | +| 消息回调 | 4 | 0 | 4 | 0 | 0 | +| 用户 | 26 | 17 | 2 | 7 | 0 | +| 登录 | 9 | 5 | 0 | 4 | 0 | +| 管理/授权 | 9 | 0 | 0 | 0 | 9 | +| 群管理 | 20 | 11 | 9 | 0 | 0 | +| 视频号 | 4 | 0 | 4 | 0 | 0 | +| 设备 | 4 | 4 | 0 | 0 | 0 | + +## 4. 全量接口明细 + +### 4.1 企业微信 + +- 套餐分布：初级版 0，高级版 0，定制版 22，白标/OEM 0 + +#### 4.1.1 `POST /qy/QWAcceptChatRoom` + +- 接口说明：同意进企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAcceptChatRoomModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Link` | `string` | 否 | 待补充 | +| `Opcode` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Link": "", + "Opcode": 0 +} +``` + +#### 4.1.2 `POST /qy/QWAddChatRoomMember` + +- 接口说明：直接拉朋友进企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.3 `POST /qy/QWAdminAcceptJoinChatRoomSet` + +- 接口说明：设定企业群管理审核进群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAdminAcceptJoinChatRoomSetModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `P` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "P": 0 +} +``` + +#### 4.1.4 `POST /qy/QWApplyAddContact` + +- 接口说明：向企业微信打招呼 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWApplyAddContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Content` | `string` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | +| `V1` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Content": "", + "UserName": "", + "V1": "" +} +``` + +#### 4.1.5 `POST /qy/QWAppointChatRoomAdmin` + +- 接口说明：增加企业管理员 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.6 `POST /qy/QWChatRoomAnnounce` + +- 接口说明：发布企业群公告 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWModChatRoomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Name` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Name": "" +} +``` + +#### 4.1.7 `POST /qy/QWChatRoomTransferOwner` + +- 接口说明：转让企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWChatRoomTransferOwnerModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": "" +} +``` + +#### 4.1.8 `POST /qy/QWContact` + +- 接口说明：提取企业 wx 详情 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoom` | `string` | 否 | 待补充 | +| `T` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoom": "", + "T": "", + "ToUserName": "" +} +``` + +#### 4.1.9 `POST /qy/QWCreateChatRoom` + +- 接口说明：创建企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWCreateModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.10 `POST /qy/QWDelChatRoom` + +- 接口说明：删除企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWModChatRoomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Name` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Name": "" +} +``` + +#### 4.1.11 `POST /qy/QWDelChatRoomAdmin` + +- 接口说明：移除群管理员 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.12 `POST /qy/QWDelChatRoomMember` + +- 接口说明：删除企业群成员 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.13 `POST /qy/QWGetChatRoomMember` + +- 接口说明：提取企业群全部成员 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.14 `POST /qy/QWGetChatRoomQR` + +- 接口说明：提取企业群二维码 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.15 `POST /qy/QWGetChatroomInfo` + +- 接口说明：提取企业群名称公告设定等信息 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.16 `POST /qy/QWInviteChatRoomMember` + +- 接口说明：发送群邀请链接 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.17 `POST /qy/QWModChatRoomMemberNick` + +- 接口说明：修改成员在群中呢称 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWModChatRoomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Name` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Name": "" +} +``` + +#### 4.1.18 `POST /qy/QWModChatRoomName` + +- 接口说明：修改企业群名称 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWModChatRoomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Name` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Name": "" +} +``` + +#### 4.1.19 `POST /qy/QWRemark` + +- 接口说明：备注企业 wxid +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWRemarkModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Name` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Name": "", + "ToUserName": "" +} +``` + +#### 4.1.20 `POST /qy/QWSearchContact` + +- 接口说明：搜手机或企业对外名片链接提取验证 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SearchContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FromScene` | `integer` | 否 | 待补充 | +| `Tg` | `string` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FromScene": 0, + "Tg": "", + "UserName": "" +} +``` + +#### 4.1.21 `POST /qy/QWSyncChatRoom` + +- 接口说明：提取全部企业微信群- +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWSyncChatRoomModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Key` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Key": "" +} +``` + +#### 4.1.22 `POST /qy/QWSyncContact` + +- 接口说明：提取全部的企业通讯录 +- 对应套餐：**定制版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + + +### 4.2 公众号/小程序 + +- 套餐分布：初级版 0，高级版 13，定制版 0，白标/OEM 0 + +#### 4.2.1 `POST /applet/AuthMpLogin` + +- 接口说明：授权公众号登录 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetMpA8KeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Opcode` | `integer` | 否 | 待补充 | +| `Scene` | `integer` | 否 | 待补充 | +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Opcode": 0, + "Scene": 0, + "Url": "" +} +``` + +#### 4.2.2 `POST /applet/FollowGH` + +- 接口说明：关注公众号 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FollowGHModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `GHList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "GHList": [ + { + "Gh": {}, + "Scene": {} + } + ] +} +``` + +#### 4.2.3 `POST /applet/GetA8Key` + +- 接口说明：授权链接 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetA8KeyRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `OpCode` | `integer` | 否 | 待补充 | +| `ReqUrl` | `string` | 否 | 待补充 | +| `Scene` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "OpCode": 0, + "ReqUrl": "", + "Scene": 0 +} +``` + +#### 4.2.4 `POST /applet/GetAppMsgExt` + +- 接口说明：阅读公众号文章 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ReadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 公众号文章URL | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.2.5 `POST /applet/GetAppMsgExtLike` + +- 接口说明：点赞公众号文章 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ReadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 公众号文章URL | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.2.6 `POST /applet/GetAppMsgReadCount` + +- 接口说明：获取公众号文章阅读数 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ReadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 公众号文章URL | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.2.7 `POST /applet/GetMpA8Key` + +- 接口说明：授权链接 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetMpA8KeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Opcode` | `integer` | 否 | 待补充 | +| `Scene` | `integer` | 否 | 待补充 | +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Opcode": 0, + "Scene": 0, + "Url": "" +} +``` + +#### 4.2.8 `POST /applet/GetMpHistoryMessage` + +- 接口说明：获取公众号历史消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetMpHistoryMsgModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.2.9 `POST /applet/JSOperateWxData` + +- 接口说明：小程序云函数操作 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AppletModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AppId` | `string` | 否 | 应用ID | +| `Data` | `string` | 否 | 小程序云函数操作的 Data; json字符串, 注意必须是 json 字符串; 传空时默认值为: '{"with_credentials":true,"from_component":true,"data":{"lang":"zh_CN"},"api_name":"webapi_getuserinfo"}' | +| `Opt` | `integer` | 否 | 小程序云函数操作的 Opt; 默认为1 | +| `PackageName` | `string` | 否 | 待补充 | +| `SdkName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AppId": "", + "Data": "", + "Opt": "1", + "PackageName": "", + "SdkName": "" +} +``` + +#### 4.2.10 `POST /applet/JsLogin` + +- 接口说明：授权小程序(返回授权后的code) +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AppletModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AppId` | `string` | 否 | 应用ID | +| `Data` | `string` | 否 | 小程序云函数操作的 Data; json字符串, 注意必须是 json 字符串; 传空时默认值为: '{"with_credentials":true,"from_component":true,"data":{"lang":"zh_CN"},"api_name":"webapi_getuserinfo"}' | +| `Opt` | `integer` | 否 | 小程序云函数操作的 Opt; 默认为1 | +| `PackageName` | `string` | 否 | 待补充 | +| `SdkName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AppId": "", + "Data": "", + "Opt": "1", + "PackageName": "", + "SdkName": "" +} +``` + +#### 4.2.11 `POST /applet/QRConnectAuthorize` + +- 接口说明：二维码授权请求 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QRConnectAuthorizeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `QrUrl` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "QrUrl": "" +} +``` + +#### 4.2.12 `POST /applet/QRConnectAuthorizeConfirm` + +- 接口说明：二维码授权确认 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QRConnectAuthorizeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `QrUrl` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "QrUrl": "" +} +``` + +#### 4.2.13 `POST /applet/SdkOauthAuthorize` + +- 接口说明：应用授权 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AppletModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AppId` | `string` | 否 | 应用ID | +| `Data` | `string` | 否 | 小程序云函数操作的 Data; json字符串, 注意必须是 json 字符串; 传空时默认值为: '{"with_credentials":true,"from_component":true,"data":{"lang":"zh_CN"},"api_name":"webapi_getuserinfo"}' | +| `Opt` | `integer` | 否 | 小程序云函数操作的 Opt; 默认为1 | +| `PackageName` | `string` | 否 | 待补充 | +| `SdkName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AppId": "", + "Data": "", + "Opt": "1", + "PackageName": "", + "SdkName": "" +} +``` + + +### 4.3 其他 + +- 套餐分布：初级版 0，高级版 8，定制版 0，白标/OEM 0 + +#### 4.3.1 `POST /other/GetPeopleNearby` + +- 接口说明：查看附近的人 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `PeopleNearbyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Latitude` | `number` | 否 | 待补充 | +| `Longitude` | `number` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Latitude": 0, + "Longitude": 0 +} +``` + +#### 4.3.2 `GET /other/GetProjectFullPath` + +- 接口说明：获取项目完整路径 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.3.3 `POST /other/GetRedisSyncMsg` + +- 接口说明：获取缓存在redis中的消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.3.4 `POST /other/GetUserRankLikeCount` + +- 接口说明：获取步数排行数据列表 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UserRankLikeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `RankId` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "RankId": "" +} +``` + +#### 4.3.5 `POST /other/QWImageDownload` + +- 接口说明：企微图片下载 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadQWImageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `xml` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "xml": "" +} +``` + +#### 4.3.6 `POST /other/UpdateCmdStatus` + +- 接口说明：更新指令状态, key 为指令 id，Value 为指令状态 0|1，ValueStr 为字符串值 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ModifyCmdStatusModelNew` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Key` | `string` | 否 | 待补充 | +| `Value` | `integer` | 否 | 待补充 | +| `ValueStr` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Key": "101", + "Value": "1", + "ValueStr": "" +} +``` + +#### 4.3.7 `POST /other/UpdateStepNumber` + +- 接口说明：修改步数 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateStepNumberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Number` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Number": 0 +} +``` + +#### 4.3.8 `POST /other/UploadAppAttach` + +- 接口说明：上传文件 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadAppAttachModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `fileData` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "fileData": "" +} +``` + + +### 4.4 同步消息 + +- 套餐分布：初级版 0，高级版 1，定制版 0，白标/OEM 0 + +#### 4.4.1 `GET /ws/GetSyncMsg` + +- 接口说明：如果 "key" 有效，则调用 WebSocketHandler 进行后续处理。 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + + +### 4.5 好友 + +- 套餐分布：初级版 7，高级版 4，定制版 0，白标/OEM 0 + +#### 4.5.1 `POST /friend/AgreeAdd` + +- 接口说明：同意好友请求 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `VerifyUserRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomUserName` | `string` | 否 | 通过群来添加好友 需要设置此值为群id | +| `OpCode` | `integer` | 否 | 操作类型: 1(免验证发送请求) 2(添加好友/发送验证申请) 3(同意好友/通过好友验证) 4(拒绝好友) | +| `Scene` | `integer` | 否 | 添加来源, 同意添加好友时传回调消息xml中的scene值.
添加好友时的枚举值如下:
1(QQ) 2(邮箱) 3(微信号) 4(QQ好友) 8(来自群聊) 13(通讯录)
14(群聊) 15(手机号) 18(附近的人) 25(漂流瓶) 29(摇一摇) 30(二维码) | +| `V3` | `string` | 否 | V3用户名数据(SearchContact请求返回的UserValue) | +| `V4` | `string` | 否 | V4校验数据(SearchContact请求返回的AntispamTicket) | +| `VerifyContent` | `string` | 否 | 添加好友时的(招呼语/验证信息) | + +**请求体代码示例** + +```json +{ + "ChatRoomUserName": "", + "OpCode": "2", + "Scene": "3", + "V3": "", + "V4": "", + "VerifyContent": "" +} +``` + +#### 4.5.2 `POST /friend/DelContact` + +- 接口说明：删除好友 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DelContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DelUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "DelUserName": "" +} +``` + +#### 4.5.3 `POST /friend/GetContactDetailsList` + +- 接口说明：获取联系人详情 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `BatchGetContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `RoomWxIDList` | `array` | 否 | 待补充 | +| `UserNames` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "RoomWxIDList": [ + "string" + ], + "UserNames": [ + "string" + ] +} +``` + +#### 4.5.4 `POST /friend/GetContactList` + +- 接口说明：获取全部联系人 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetContactListModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CurrentChatRoomContactSeq` | `integer` | 否 | 待补充 | +| `CurrentWxcontactSeq` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "CurrentChatRoomContactSeq": 0, + "CurrentWxcontactSeq": 0 +} +``` + +#### 4.5.5 `POST /friend/GetFriendRelation` + +- 接口说明：获取好友关系 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetFriendRelationModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "UserName": "" +} +``` + +#### 4.5.6 `GET /friend/GetGHList` + +- 接口说明：获取关注的公众号列表 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.5.7 `GET /friend/GetMFriend` + +- 接口说明：获取手机通讯录好友 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.5.8 `GET /friend/GroupList` + +- 接口说明：获取保存的群聊列表 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.5.9 `POST /friend/SearchContact` + +- 接口说明：搜索联系人 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SearchContactRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FromScene` | `integer` | 否 | 待补充 | +| `OpCode` | `integer` | 否 | 操作类型 | +| `SearchScene` | `integer` | 否 | 搜索场景 | +| `UserName` | `string` | 否 | 要搜索的内容(微信号、手机号、QQ号等) | + +**请求体代码示例** + +```json +{ + "FromScene": 0, + "OpCode": 0, + "SearchScene": 0, + "UserName": "" +} +``` + +#### 4.5.10 `POST /friend/UploadMContact` + +- 接口说明：上传手机通讯录好友 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadMContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Mobile` | `string` | 否 | 待补充 | +| `MobileList` | `array` | 否 | 待补充 | +| `Opcode` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Mobile": "", + "MobileList": [ + "string" + ], + "Opcode": 0 +} +``` + +#### 4.5.11 `POST /friend/VerifyUser` + +- 接口说明：验证好友/添加好友 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `VerifyUserRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomUserName` | `string` | 否 | 通过群来添加好友 需要设置此值为群id | +| `OpCode` | `integer` | 否 | 操作类型: 1(免验证发送请求) 2(添加好友/发送验证申请) 3(同意好友/通过好友验证) 4(拒绝好友) | +| `Scene` | `integer` | 否 | 添加来源, 同意添加好友时传回调消息xml中的scene值.
添加好友时的枚举值如下:
1(QQ) 2(邮箱) 3(微信号) 4(QQ好友) 8(来自群聊) 13(通讯录)
14(群聊) 15(手机号) 18(附近的人) 25(漂流瓶) 29(摇一摇) 30(二维码) | +| `V3` | `string` | 否 | V3用户名数据(SearchContact请求返回的UserValue) | +| `V4` | `string` | 否 | V4校验数据(SearchContact请求返回的AntispamTicket) | +| `VerifyContent` | `string` | 否 | 添加好友时的(招呼语/验证信息) | + +**请求体代码示例** + +```json +{ + "ChatRoomUserName": "", + "OpCode": "2", + "Scene": "3", + "V3": "", + "V4": "", + "VerifyContent": "" +} +``` + + +### 4.6 微信小店 + +- 套餐分布：初级版 0，高级版 0，定制版 4，白标/OEM 0 + +#### 4.6.1 `POST /shop/ExtDeviceLoginConfirmGet` + +- 接口说明：- +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShopLoginConfirmModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `url` | `string` | 否 | 登录二维码URL | + +**请求体代码示例** + +```json +{ + "url": "" +} +``` + +#### 4.6.2 `POST /shop/ExtDeviceLoginConfirmOk` + +- 接口说明：- +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShopLoginConfirmModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `url` | `string` | 否 | 登录二维码URL | + +**请求体代码示例** + +```json +{ + "url": "" +} +``` + +#### 4.6.3 `POST /shop/ScanQrcodeEventReport` + +- 接口说明：- +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShopLoginConfirmModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `url` | `string` | 否 | 登录二维码URL | + +**请求体代码示例** + +```json +{ + "url": "" +} +``` + +#### 4.6.4 `POST /shop/ShopLoginConfirm` + +- 接口说明：微信小店确认登录 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShopLoginConfirmModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `url` | `string` | 否 | 登录二维码URL | + +**请求体代码示例** + +```json +{ + "url": "" +} +``` + + +### 4.7 支付 + +- 套餐分布：初级版 0，高级版 9，定制版 0，白标/OEM 0 + +#### 4.7.1 `POST /pay/Collectmoney` + +- 接口说明：确定收款 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CollectmoneyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `InvalidTime` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | +| `TransFerId` | `string` | 否 | 待补充 | +| `TransactionId` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "InvalidTime": "", + "ToUserName": "", + "TransFerId": "", + "TransactionId": "" +} +``` + +#### 4.7.2 `POST /pay/ConfirmPreTransfer` + +- 接口说明：确认转账(客户端版本过低会无法转账) +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ConfirmPreTransfer` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BankSerial` | `string` | 否 | 付款方式 Serial序列号 | +| `BankType` | `string` | 否 | 付款方式 类型 | +| `PayPassword` | `string` | 否 | 支付密码 | +| `ReqKey` | `string` | 否 | 创建转账返回的ReqKey | + +**请求体代码示例** + +```json +{ + "BankSerial": "", + "BankType": "", + "PayPassword": "", + "ReqKey": "" +} +``` + +#### 4.7.3 `POST /pay/CreatePreTransfer` + +- 接口说明：创建转账 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CreatePreTransfer` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Description` | `string` | 否 | 转账备注 | +| `Fee` | `integer` | 否 | 转账金额(单位为分) | +| `ToUserName` | `string` | 否 | 要转账用户的wxid | + +**请求体代码示例** + +```json +{ + "Description": "", + "Fee": 0, + "ToUserName": "" +} +``` + +#### 4.7.4 `POST /pay/GeneratePayQCode` + +- 接口说明：生成自定义收款二维码 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GeneratePayQCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Money` | `string` | 否 | 金额(单位为分), 999 即为 9.99 元 | +| `Name` | `string` | 否 | 收款备注 | + +**请求体代码示例** + +```json +{ + "Money": "", + "Name": "" +} +``` + +#### 4.7.5 `POST /pay/GetBandCardList` + +- 接口说明：获取银行卡信息 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.7.6 `POST /pay/GetRedEnvelopesDetail` + +- 接口说明：查看红包详情 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `HongBaoItem` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DequeueAtMs` | `integer` | 否 | 待补充 | +| `EnqueueAtMs` | `integer` | 否 | 待补充 | +| `FromUserName` | `string` | 否 | 待补充 | +| `IsGroup` | `integer` | 否 | 默认 1 | +| `Limit` | `integer` | 否 | 待补充 | +| `NativeURL` | `string` | 否 | 待补充 | +| `RecvAtMs` | `integer` | 否 | 待补充 | +| `SceneID` | `integer` | 否 | 待补充 | +| `SessionUserName` | `string` | 否 | 群ID或个人ID | +| `URLItem` | `object` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "DequeueAtMs": 0, + "EnqueueAtMs": 0, + "FromUserName": "", + "IsGroup": 0, + "Limit": 0, + "NativeURL": "", + "RecvAtMs": 0, + "SceneID": 0, + "SessionUserName": "", + "URLItem": { + "ChannelID": "", + "MsgType": "", + "SceneID": 0, + "SendID": "", + "SendUserName": "", + "ShowSourceMac": "", + "ShowWxPayTitle": "", + "Sign": "", + "Ver": "" + } +} +``` + +#### 4.7.7 `POST /pay/GetRedPacketList` + +- 接口说明：查看红包领取列表 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetRedPacketList` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `HongBaoItem` | `object` | 否 | 待补充 | +| `Limit` | `integer` | 否 | 待补充 | +| `NativeURL` | `string` | 否 | 待补充 | +| `Offset` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "HongBaoItem": { + "ChannelID": "", + "MsgType": "", + "SceneID": 0, + "SendID": "", + "SendUserName": "", + "ShowSourceMac": "", + "ShowWxPayTitle": "", + "Sign": "", + "Ver": "" + }, + "Limit": 0, + "NativeURL": "", + "Offset": 0 +} +``` + +#### 4.7.8 `POST /pay/OpenRedEnvelopes` + +- 接口说明：拆红包 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `HongBaoItem` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DequeueAtMs` | `integer` | 否 | 待补充 | +| `EnqueueAtMs` | `integer` | 否 | 待补充 | +| `FromUserName` | `string` | 否 | 待补充 | +| `IsGroup` | `integer` | 否 | 默认 1 | +| `Limit` | `integer` | 否 | 待补充 | +| `NativeURL` | `string` | 否 | 待补充 | +| `RecvAtMs` | `integer` | 否 | 待补充 | +| `SceneID` | `integer` | 否 | 待补充 | +| `SessionUserName` | `string` | 否 | 群ID或个人ID | +| `URLItem` | `object` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "DequeueAtMs": 0, + "EnqueueAtMs": 0, + "FromUserName": "", + "IsGroup": 0, + "Limit": 0, + "NativeURL": "", + "RecvAtMs": 0, + "SceneID": 0, + "SessionUserName": "", + "URLItem": { + "ChannelID": "", + "MsgType": "", + "SceneID": 0, + "SendID": "", + "SendUserName": "", + "ShowSourceMac": "", + "ShowWxPayTitle": "", + "Sign": "", + "Ver": "" + } +} +``` + +#### 4.7.9 `POST /pay/WXCreateRedPacket` + +- 接口说明：创建红包 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `RedPacket` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Amount` | `integer` | 否 | 每个红包的金额(单位为分, 最小为100); 总金额为 Amount*Count | +| `Content` | `string` | 否 | 红包的备注内容(祝福语) | +| `Count` | `integer` | 否 | 红包个数(最少为1) | +| `From` | `integer` | 否 | InAway(0:群红包; 1:个人红包) | +| `RedType` | `integer` | 否 | 红包类型(0 普通红包; 1 拼手气红包; ? 专属红包) | +| `Username` | `string` | 否 | 红包接收者; wxid 或 群ID | + +**请求体代码示例** + +```json +{ + "Amount": 0, + "Content": "", + "Count": 0, + "From": 0, + "RedType": 0, + "Username": "" +} +``` + + +### 4.8 收藏 + +- 套餐分布：初级版 0，高级版 4，定制版 0，白标/OEM 0 + +#### 4.8.1 `POST /favor/BatchDelFavItem` + +- 接口说明：删除收藏 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FavInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FavId` | `integer` | 否 | 待补充 | +| `KeyBuf` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FavId": 0, + "KeyBuf": "" +} +``` + +#### 4.8.2 `GET /favor/FavSync` + +- 接口说明：同步收藏 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.8.3 `POST /favor/GetFavItemId` + +- 接口说明：获取收藏详细 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FavInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FavId` | `integer` | 否 | 待补充 | +| `KeyBuf` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FavId": 0, + "KeyBuf": "" +} +``` + +#### 4.8.4 `POST /favor/GetFavList` + +- 接口说明：获取收藏list +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FavInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FavId` | `integer` | 否 | 待补充 | +| `KeyBuf` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FavId": 0, + "KeyBuf": "" +} +``` + + +### 4.9 朋友圈 + +- 套餐分布：初级版 10，高级版 6，定制版 0，白标/OEM 0 + +#### 4.9.1 `POST /sns/CdnSnsVideoUpload` + +- 接口说明：上传CDN朋友圈视频 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CdnSnsVideoUploadModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ThumbData` | `string` | 否 | 缩略图数据的base64编码 | +| `VideoData` | `string` | 否 | 视频数据的base64编码 | + +**请求体代码示例** + +```json +{ + "ThumbData": "", + "VideoData": "" +} +``` + +#### 4.9.2 `POST /sns/DownloadMedia` + +- 接口说明：下载朋友圈视频 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadMediaModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Key` | `string` | 否 | 待补充 | +| `URL` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Key": "", + "URL": "" +} +``` + +#### 4.9.3 `POST /sns/GetCollectCircle` + +- 接口说明：获取收藏朋友圈详情 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendFavItemCircle` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 待补充 | +| `FavItemID` | `integer` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `LocationVal` | `integer` | 否 | 待补充 | +| `SourceID` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "FavItemID": 0, + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "LocationVal": 0, + "SourceID": "" +} +``` + +#### 4.9.4 `POST /sns/GetSnsSync` + +- 接口说明：同步朋友圈 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.9.5 `POST /sns/SendFavItemCircle` + +- 接口说明：转发收藏朋友圈 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendFavItemCircle` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 待补充 | +| `FavItemID` | `integer` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `LocationVal` | `integer` | 否 | 待补充 | +| `SourceID` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "FavItemID": 0, + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "LocationVal": 0, + "SourceID": "" +} +``` + +#### 4.9.6 `POST /sns/SendFriendCircle` + +- 接口说明：发送朋友圈 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SnsPostItemModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 不可见好友列表 | +| `Content` | `string` | 否 | 文本内容 | +| `ContentStyle` | `integer` | 否 | 纯文字/图文/引用/视频 | +| `ContentUrl` | `string` | 否 | 待补充 | +| `Description` | `string` | 否 | 待补充 | +| `GroupUserList` | `array` | 否 | 可见好友列表 | +| `LocationInfo` | `object` | 否 | 发送朋友圈的位置信息 | +| `MediaList` | `array` | 否 | 图片/视频列表 | +| `Privacy` | `integer` | 否 | 是否仅自己可见 | +| `WithUserList` | `array` | 否 | 提醒好友看列表 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "Content": "", + "ContentStyle": 0, + "ContentUrl": "", + "Description": "", + "GroupUserList": [ + "string" + ], + "LocationInfo": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiClickableStatus": 0, + "PoiInfoURL": "", + "PoiName": "", + "PoiScale": 0 + }, + "MediaList": [ + { + "Description": {}, + "ID": {}, + "MD5": {}, + "Private": {}, + "SizeHeight": {}, + "SizeWidth": {}, + "SubType": {}, + "ThumType": {}, + "Thumb": {}, + "Title": {}, + "TotalSize": {}, + "Type": {}, + "URL": {}, + "URLType": {}, + "UserData": {}, + "VideoDuration": {}, + "VideoHeight": {}, + "VideoMD5": {}, + "VideoWidth": {} + } + ], + "Privacy": 0, + "WithUserList": [ + "string" + ] +} +``` + +#### 4.9.7 `POST /sns/SendFriendCircleByXMl` + +- 接口说明：发送朋友圈XML结构 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `TimelineObject` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ActionInfo` | `object` | 否 | 待补充 | +| `AppInfo` | `object` | 否 | 待补充 | +| `ContentDesc` | `string` | 否 | 待补充 | +| `ContentDescScene` | `integer` | 否 | 待补充 | +| `ContentDescShowType` | `integer` | 否 | 待补充 | +| `ContentObject` | `object` | 否 | 待补充 | +| `ContentObjectVideo` | `object` | 否 | 待补充 | +| `CreateTime` | `integer` | 否 | 待补充 | +| `ID` | `integer` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `Private` | `integer` | 否 | 待补充 | +| `PublicUserName` | `string` | 否 | 待补充 | +| `ShowFlag` | `integer` | 否 | 待补充 | +| `SightFolded` | `integer` | 否 | 待补充 | +| `SourceNickName` | `string` | 否 | 待补充 | +| `SourceUserName` | `string` | 否 | 待补充 | +| `StatExtStr` | `string` | 否 | 待补充 | +| `StatisticsData` | `string` | 否 | 待补充 | +| `StreamVideo` | `object` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ActionInfo": { + "AppMsg": {} + }, + "AppInfo": { + "AppName": "", + "FromURL": "", + "ID": "", + "InstallURL": "", + "IsForceUpdate": 0, + "Version": "" + }, + "ContentDesc": "", + "ContentDescScene": 0, + "ContentDescShowType": 0, + "ContentObject": { + "ContentStyle": 0, + "ContentURL": "", + "Description": "", + "MediaList": {}, + "Title": "" + }, + "ContentObjectVideo": {}, + "CreateTime": 0, + "ID": 0, + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "Private": 0, + "PublicUserName": "", + "ShowFlag": 0, + "SightFolded": 0, + "SourceNickName": "", + "SourceUserName": "", + "StatExtStr": "", + "StatisticsData": "", + "StreamVideo": { + "StreamVideoThumbURL": "", + "StreamVideoURL": "", + "StreamVideoWebURL": "" + }, + "UserName": "" +} +``` + +#### 4.9.8 `POST /sns/SendOneIdCircle` + +- 接口说明：一键转发朋友圈 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetIdDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 待补充 | +| `Id` | `string` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `LocationVal` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "Id": "", + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "LocationVal": 0 +} +``` + +#### 4.9.9 `POST /sns/SendSnsComment` + +- 接口说明：点赞评论 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendSnsCommentRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `SnsCommentList` | `array` | 否 | 待补充 | +| `Tx` | `boolean` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "SnsCommentList": [ + { + "Content": {}, + "CreateTime": {}, + "ItemID": {}, + "OpType": {}, + "ReplyCommentID": {}, + "ReplyItem": {}, + "ToUserName": {} + } + ], + "Tx": false +} +``` + +#### 4.9.10 `POST /sns/SendSnsObjectDetailById` + +- 接口说明：获取指定id朋友圈 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetIdDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 待补充 | +| `Id` | `string` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `LocationVal` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "Id": "", + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "LocationVal": 0 +} +``` + +#### 4.9.11 `POST /sns/SendSnsObjectOp` + +- 接口说明：朋友圈操作 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendSnsObjectOpRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `SnsObjectOpList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "SnsObjectOpList": [ + { + "Data": {}, + "DataLen": {}, + "Ext": {}, + "OpType": {}, + "SnsObjID": {} + } + ] +} +``` + +#### 4.9.12 `POST /sns/SendSnsTimeLine` + +- 接口说明：获取朋友圈主页 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetSnsInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FirstPageMD5` | `string` | 否 | 待补充 | +| `MaxID` | `integer` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FirstPageMD5": "", + "MaxID": 0, + "UserName": "" +} +``` + +#### 4.9.13 `POST /sns/SendSnsUserPage` + +- 接口说明：获取指定人朋友圈 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetSnsInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FirstPageMD5` | `string` | 否 | 待补充 | +| `MaxID` | `integer` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FirstPageMD5": "", + "MaxID": 0, + "UserName": "" +} +``` + +#### 4.9.14 `POST /sns/SetBackgroundImage` + +- 接口说明：设置朋友圈背景图片 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetBackgroundImageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.9.15 `POST /sns/SetFriendCircleDays` + +- 接口说明：设置朋友圈可见天数 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetFriendCircleDaysModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Function` | `integer` | 否 | 待补充 | +| `Value` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Function": 0, + "Value": 0 +} +``` + +#### 4.9.16 `POST /sns/UploadFriendCircleImage` + +- 接口说明：上传图片信息 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadFriendCircleModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ImageDataList` | `array` | 否 | 待补充 | +| `VideoDataList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ImageDataList": [ + "string" + ], + "VideoDataList": [ + "string" + ] +} +``` + + +### 4.10 标签 + +- 套餐分布：初级版 5，高级版 0，定制版 0，白标/OEM 0 + +#### 4.10.1 `POST /label/AddContactLabel` + +- 接口说明：添加列表 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `LabelModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `LabelId` | `string` | 否 | 待补充 | +| `LabelNameList` | `array` | 否 | 待补充 | +| `UserLabelList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "LabelId": "", + "LabelNameList": [ + "string" + ], + "UserLabelList": [ + { + "LabelIDList": {}, + "UserName": {} + } + ] +} +``` + +#### 4.10.2 `POST /label/DelContactLabel` + +- 接口说明：删除标签 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `LabelModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `LabelId` | `string` | 否 | 待补充 | +| `LabelNameList` | `array` | 否 | 待补充 | +| `UserLabelList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "LabelId": "", + "LabelNameList": [ + "string" + ], + "UserLabelList": [ + { + "LabelIDList": {}, + "UserName": {} + } + ] +} +``` + +#### 4.10.3 `GET /label/GetContactLabelList` + +- 接口说明：获取标签列表 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.10.4 `POST /label/GetWXFriendListByLabel` + +- 接口说明：获取标签下所有好友 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `LabelModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `LabelId` | `string` | 否 | 待补充 | +| `LabelNameList` | `array` | 否 | 待补充 | +| `UserLabelList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "LabelId": "", + "LabelNameList": [ + "string" + ], + "UserLabelList": [ + { + "LabelIDList": {}, + "UserName": {} + } + ] +} +``` + +#### 4.10.5 `POST /label/ModifyLabel` + +- 接口说明：修改标签 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `LabelModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `LabelId` | `string` | 否 | 待补充 | +| `LabelNameList` | `array` | 否 | 待补充 | +| `UserLabelList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "LabelId": "", + "LabelNameList": [ + "string" + ], + "UserLabelList": [ + { + "LabelIDList": {}, + "UserName": {} + } + ] +} +``` + + +### 4.11 消息 + +- 套餐分布：初级版 9，高级版 15，定制版 0，白标/OEM 0 + +#### 4.11.1 `POST /message/AddMessageMgr` + +- 接口说明：添加要发送的文本消息进入管理器 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `MsgItem` | `array` | 否 | 消息体数组 | + +**请求体代码示例** + +```json +{ + "MsgItem": [ + { + "AtWxIDList": {}, + "ImageContent": {}, + "MsgType": {}, + "TextContent": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.2 `POST /message/CdnUploadVideo` + +- 接口说明：上传视频 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CdnUploadVideoRequest` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ThumbData` | `array` | 否 | ThumbData | +| `ToUserName` | `string` | 否 | 待补充 | +| `VideoData` | `array` | 否 | 视频数据 | + +**请求体代码示例** + +```json +{ + "ThumbData": [ + 0 + ], + "ToUserName": "", + "VideoData": [ + 0 + ] +} +``` + +#### 4.11.3 `POST /message/DownloadEmojiGif` + +- 接口说明：下载表情 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadEmojiModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `xml_content` | `string` | 否 | msg_type=47的消息xml内容 | + +**请求体代码示例** + +```json +{ + "xml_content": "" +} +``` + +#### 4.11.4 `POST /message/ForwardEmoji` + +- 接口说明：转发表情，包含动图 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendEmojiMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `EmojiList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "EmojiList": [ + { + "EmojiMd5": {}, + "EmojiSize": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.5 `POST /message/ForwardImageMessage` + +- 接口说明：转发图片 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ForwardMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ForwardImageList` | `array` | 否 | 待补充 | +| `ForwardVideoList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ForwardImageList": [ + { + "AesKey": {}, + "CdnMidImgSize": {}, + "CdnMidImgUrl": {}, + "CdnThumbImgSize": {}, + "ToUserName": {} + } + ], + "ForwardVideoList": [ + { + "AesKey": {}, + "CdnThumbLength": {}, + "CdnVideoUrl": {}, + "Length": {}, + "PlayLength": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.6 `POST /message/ForwardVideoMessage` + +- 接口说明：转发视频 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ForwardMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ForwardImageList` | `array` | 否 | 待补充 | +| `ForwardVideoList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ForwardImageList": [ + { + "AesKey": {}, + "CdnMidImgSize": {}, + "CdnMidImgUrl": {}, + "CdnThumbImgSize": {}, + "ToUserName": {} + } + ], + "ForwardVideoList": [ + { + "AesKey": {}, + "CdnThumbLength": {}, + "CdnVideoUrl": {}, + "Length": {}, + "PlayLength": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.7 `POST /message/GetMsgBigImg` + +- 接口说明：获取图片(高清图片下载) +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CompressType` | `integer` | 否 | 下载图片时，数据压缩类型(默认为0即可) | +| `FromUserName` | `string` | 否 | 下载图片时，图片消息的发送者 | +| `MsgId` | `integer` | 否 | 消息ID(注意是msg_id 不是new_msg_id) | +| `Section` | `object` | 否 | 当前要获取的数据分包 | +| `ToUserName` | `string` | 否 | 下载图片时，图片消息的接收者 | +| `TotalLen` | `integer` | 否 | 下载数据的总长度 | + +**请求体代码示例** + +```json +{ + "CompressType": 0, + "FromUserName": "", + "MsgId": 0, + "Section": { + "DataLen": "61440", + "StartPos": 0 + }, + "ToUserName": "", + "TotalLen": 0 +} +``` + +#### 4.11.8 `POST /message/GetMsgVideo` + +- 接口说明：获取视频(视频数据下载) +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CompressType` | `integer` | 否 | 下载图片时，数据压缩类型(默认为0即可) | +| `FromUserName` | `string` | 否 | 下载图片时，图片消息的发送者 | +| `MsgId` | `integer` | 否 | 消息ID(注意是msg_id 不是new_msg_id) | +| `Section` | `object` | 否 | 当前要获取的数据分包 | +| `ToUserName` | `string` | 否 | 下载图片时，图片消息的接收者 | +| `TotalLen` | `integer` | 否 | 下载数据的总长度 | + +**请求体代码示例** + +```json +{ + "CompressType": 0, + "FromUserName": "", + "MsgId": 0, + "Section": { + "DataLen": "61440", + "StartPos": 0 + }, + "ToUserName": "", + "TotalLen": 0 +} +``` + +#### 4.11.9 `POST /message/GetMsgVoice` + +- 接口说明：下载语音消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadVoiceModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Bufid` | `string` | 否 | 待补充 | +| `Length` | `integer` | 否 | 待补充 | +| `NewMsgId` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Bufid": "", + "Length": 0, + "NewMsgId": "", + "ToUserName": "" +} +``` + +#### 4.11.10 `POST /message/GroupMassMsgImage` + +- 接口说明：群发图片 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GroupMassMsgImageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ImageBase64` | `string` | 否 | 待补充 | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ImageBase64": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.11.11 `POST /message/GroupMassMsgText` + +- 接口说明：群发接口 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GroupMassMsgTextModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Content` | `string` | 否 | 待补充 | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Content": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.11.12 `POST /message/HttpSyncMsg` + +- 接口说明：同步消息, HTTP-轮询方式 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SyncMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Count` | `integer` | 否 | 同步几条消息; 接收空请求体, 默认为0, 同步所有消息 | + +**请求体代码示例** + +```json +{ + "Count": 0 +} +``` + +#### 4.11.13 `POST /message/NewSyncHistoryMessage` + +- 接口说明：同步历史消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.11.14 `POST /message/RevokeMsg` + +- 接口说明：撤销消息 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `RevokeMsgModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ClientImgIdStr` | `string` | 否 | 保存clientImgId的原始字符串值 | +| `ClientMsgId` | `integer` | 否 | 待补充 | +| `CreateTime` | `integer` | 否 | 待补充 | +| `IsImage` | `boolean` | 否 | 标识是否为图片消息 | +| `NewMsgId` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ClientImgIdStr": "", + "ClientMsgId": 0, + "CreateTime": 0, + "IsImage": false, + "NewMsgId": "", + "ToUserName": "" +} +``` + +#### 4.11.15 `POST /message/RevokeMsgNew` + +- 接口说明：撤回消息（New） +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `RevokeMsgModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ClientImgIdStr` | `string` | 否 | 保存clientImgId的原始字符串值 | +| `ClientMsgId` | `integer` | 否 | 待补充 | +| `CreateTime` | `integer` | 否 | 待补充 | +| `IsImage` | `boolean` | 否 | 标识是否为图片消息 | +| `NewMsgId` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ClientImgIdStr": "", + "ClientMsgId": 0, + "CreateTime": 0, + "IsImage": false, + "NewMsgId": "", + "ToUserName": "" +} +``` + +#### 4.11.16 `POST /message/SendAppMessage` + +- 接口说明：发送App消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AppMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AppList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AppList": [ + { + "ContentType": {}, + "ContentXML": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.17 `POST /message/SendCdnDownload` + +- 接口说明：下载 请求 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownMediaModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AesKey` | `string` | 否 | 待补充 | +| `FileType` | `integer` | 否 | 待补充 | +| `FileURL` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AesKey": "", + "FileType": 0, + "FileURL": "" +} +``` + +#### 4.11.18 `POST /message/SendEmojiMessage` + +- 接口说明：发送表情 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendEmojiMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `EmojiList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "EmojiList": [ + { + "EmojiMd5": {}, + "EmojiSize": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.19 `POST /message/SendImageMessage` + +- 接口说明：发送图片消息 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `MsgItem` | `array` | 否 | 消息体数组 | + +**请求体代码示例** + +```json +{ + "MsgItem": [ + { + "AtWxIDList": {}, + "ImageContent": {}, + "MsgType": {}, + "TextContent": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.20 `POST /message/SendImageNewMessage` + +- 接口说明：发送图片消息（New） +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `MsgItem` | `array` | 否 | 消息体数组 | + +**请求体代码示例** + +```json +{ + "MsgItem": [ + { + "AtWxIDList": {}, + "ImageContent": {}, + "MsgType": {}, + "TextContent": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.21 `POST /message/SendTextMessage` + +- 接口说明：发送文本消息 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `MsgItem` | `array` | 否 | 消息体数组 | + +**请求体代码示例** + +```json +{ + "MsgItem": [ + { + "AtWxIDList": {}, + "ImageContent": {}, + "MsgType": {}, + "TextContent": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.22 `POST /message/SendVoice` + +- 接口说明：发送语音 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendUploadVoiceRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ToUserName` | `string` | 否 | 待补充 | +| `VoiceData` | `string` | 否 | 待补充 | +| `VoiceFormat` | `integer` | 否 | 待补充 | +| `VoiceSecond,` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ToUserName": "", + "VoiceData": "", + "VoiceFormat": 0, + "VoiceSecond,": 0 +} +``` + +#### 4.11.23 `POST /message/ShareCardMessage` + +- 接口说明：分享名片消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShareCardParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CardAlias` | `string` | 否 | 名片别名(发送公众号名片时留空) | +| `CardFlag` | `integer` | 否 | 名片CertFlag(0:个人名片 24:公众号名片) | +| `CardNickName` | `string` | 否 | 名片昵称 | +| `CardWxId` | `string` | 否 | 名片wxid | +| `ToUserName` | `string` | 否 | 消息接收者 | + +**请求体代码示例** + +```json +{ + "CardAlias": "", + "CardFlag": 0, + "CardNickName": "", + "CardWxId": "", + "ToUserName": "" +} +``` + +#### 4.11.24 `POST /message/UploadImageToCDN` + +- 接口说明：纯CDN图片上传接口 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadImageToCDNModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `imageContent` | `string` | 否 | 图片的base64编码 | + +**请求体代码示例** + +```json +{ + "imageContent": "" +} +``` + + +### 4.12 消息回调 + +- 套餐分布：初级版 0，高级版 4，定制版 0，白标/OEM 0 + +#### 4.12.1 `GET /message/DeleteCallback` + +- 接口说明：删除消息回调配置 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.12.2 `GET /message/GetCallback` + +- 接口说明：获取消息回调配置 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.12.3 `POST /message/SetCallback` + +- 接口说明：设置消息回调 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `MessageCallbackConfigModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CallbackURL` | `string` | 否 | 回调URL | +| `Enabled` | `boolean` | 否 | 是否启用回调 | + +**请求体代码示例** + +```json +{ + "CallbackURL": "", + "Enabled": false +} +``` + +#### 4.12.4 `GET /message/TestCallback` + +- 接口说明：测试消息回调配置 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + + +### 4.13 用户 + +- 套餐分布：初级版 17，高级版 2，定制版 7，白标/OEM 0 + +#### 4.13.1 `POST /user/ChangePwd` + +- 接口说明：更改密码 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendChangePwdRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `newPass` | `string` | 否 | 待补充 | +| `oldPass` | `string` | 否 | 确保json标签是`oldPass` | +| `opCode` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "newPass": "", + "oldPass": "", + "opCode": 0 +} +``` + +#### 4.13.2 `GET /user/GetAdminKeyword` + +- 接口说明：获取管理员关键词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.3 `GET /user/GetInviteKeyword` + +- 接口说明：获取关键词邀请入群配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.4 `GET /user/GetKeywordReply` + +- 接口说明：获取关键词自动回复配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.5 `GET /user/GetKickKeyword` + +- 接口说明：获取踢人关键词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.6 `POST /user/GetMyQrCode` + +- 接口说明：获取我的二维码 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Recover` | `boolean` | 否 | 保持默认值, 无需修改 | +| `Style` | `integer` | 否 | 个人二维码样式: 可设置为8, 其余自行探索 | + +**请求体代码示例** + +```json +{ + "Recover": false, + "Style": "8" +} +``` + +#### 4.13.7 `GET /user/GetProfile` + +- 接口说明：获取个人资料信息 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.8 `GET /user/GetWelcome` + +- 接口说明：获取欢迎词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.9 `POST /user/ModifyRemark` + +- 接口说明：修改备注 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendModifyRemarkRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `RemarkName` | `string` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "RemarkName": "", + "UserName": "" +} +``` + +#### 4.13.10 `POST /user/ModifyUserInfo` + +- 接口说明：修改资料 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ModifyUserInfo` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `City` | `string` | 否 | 待补充 | +| `Country` | `string` | 否 | 待补充 | +| `InitFlag` | `integer` | 否 | 待补充 | +| `NickName` | `string` | 否 | 待补充 | +| `Province` | `string` | 否 | 待补充 | +| `Sex` | `integer` | 否 | 待补充 | +| `Signature` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "City": "", + "Country": "", + "InitFlag": 0, + "NickName": "", + "Province": "", + "Sex": 0, + "Signature": "" +} +``` + +#### 4.13.11 `POST /user/ResetGender` + +- 接口说明：重置性别 +- 对应套餐：**定制版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.12 `POST /user/SetAdminKeyword` + +- 接口说明：设置管理员关键词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetAdminKeywordModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.13 `POST /user/SetFunctionSwitch` + +- 接口说明：设置添加我的方式 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `WxFunctionSwitchModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Function` | `integer` | 否 | 待补充 | +| `Value` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Function": 0, + "Value": 0 +} +``` + +#### 4.13.14 `POST /user/SetInviteKeyword` + +- 接口说明：设置关键词邀请入群配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetInviteKeywordModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.15 `POST /user/SetKeywordReply` + +- 接口说明：设置关键词自动回复 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetKeywordReplyModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.16 `POST /user/SetKickKeyword` + +- 接口说明：设置踢人关键词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetKickKeywordModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.17 `POST /user/SetNickName` + +- 接口说明：设置昵称 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateNickNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Scene` | `integer` | 否 | 待补充 | +| `Val` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Scene": 0, + "Val": "" +} +``` + +#### 4.13.18 `POST /user/SetProxy` + +- 接口说明：修改Socks5代理 socks5://username:password@ipv4: +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` +- 代理说明：**涉及代理，请使用可用代理，格式 `socks5://username:password@ip:port`；异地 IP 建议配置代理**。 + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetLoginQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Check` | `boolean` | 否 | 修改代理时(SetProxy接口) 是否发送检测代理请求(可能导致请求超时) | +| `IpadOrmac` | `string` | 否 | 待补充 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | + +**请求体代码示例** + +```json +{ + "Check": "false", + "IpadOrmac": "", + "Proxy": "" +} +``` + +#### 4.13.19 `POST /user/SetSendPat` + +- 接口说明：设置拍一拍名称 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetSendPatModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Value` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Value": "" +} +``` + +#### 4.13.20 `POST /user/SetSexDq` + +- 接口说明：修改性别 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateSexModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `City` | `string` | 否 | 待补充 | +| `Country` | `string` | 否 | 待补充 | +| `Province` | `string` | 否 | 待补充 | +| `Sex` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "City": "", + "Country": "", + "Province": "", + "Sex": 0 +} +``` + +#### 4.13.21 `POST /user/SetSignature` + +- 接口说明：修改签名 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateNickNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Scene` | `integer` | 否 | 待补充 | +| `Val` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Scene": 0, + "Val": "" +} +``` + +#### 4.13.22 `POST /user/SetWechat` + +- 接口说明：设置微信号 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AlisaModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Alisa` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Alisa": "" +} +``` + +#### 4.13.23 `POST /user/SetWelcome` + +- 接口说明：设置欢迎词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetWelcomeModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.24 `POST /user/UpdateAutoPass` + +- 接口说明：修改加好友需要验证属性 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateAutopassModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `SwitchType` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "SwitchType": 0 +} +``` + +#### 4.13.25 `POST /user/UpdateNickName` + +- 接口说明：修改名称 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateNickNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Scene` | `integer` | 否 | 待补充 | +| `Val` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Scene": 0, + "Val": "" +} +``` + +#### 4.13.26 `POST /user/UploadHeadImage` + +- 接口说明：上传头像 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadHeadImageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Base64` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Base64": "" +} +``` + + +### 4.14 登录 + +- 套餐分布：初级版 5，高级版 0，定制版 4，白标/OEM 0 + +#### 4.14.1 `POST /login/A16Login` + +- 接口说明：数据登录 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DeviceIdLoginModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DeviceInfo` | `object` | 否 | 设备信息 | +| `LoginData` | `string` | 否 | 62 数据/A16 数据 | +| `Password` | `string` | 否 | 微信密码 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | +| `Ticket` | `string` | 否 | SMS短信验证码 | +| `Type` | `integer` | 否 | 待补充 | +| `UserName` | `string` | 否 | 手机号 | + +**请求体代码示例** + +```json +{ + "DeviceInfo": { + "AndroidId": "", + "ImeI": "", + "Manufacturer": "", + "Model": "" + }, + "LoginData": "", + "Password": "", + "Proxy": "", + "Ticket": "", + "Type": 0, + "UserName": "" +} +``` + +#### 4.14.2 `GET /login/CheckLoginStatus` + +- 接口说明：检测扫码状态 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.14.3 `POST /login/DeviceLogin` + +- 接口说明：62账号密码登录 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DeviceIdLoginModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DeviceInfo` | `object` | 否 | 设备信息 | +| `LoginData` | `string` | 否 | 62 数据/A16 数据 | +| `Password` | `string` | 否 | 微信密码 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | +| `Ticket` | `string` | 否 | SMS短信验证码 | +| `Type` | `integer` | 否 | 待补充 | +| `UserName` | `string` | 否 | 手机号 | + +**请求体代码示例** + +```json +{ + "DeviceInfo": { + "AndroidId": "", + "ImeI": "", + "Manufacturer": "", + "Model": "" + }, + "LoginData": "", + "Password": "", + "Proxy": "", + "Ticket": "", + "Type": 0, + "UserName": "" +} +``` + +#### 4.14.4 `POST /login/GetLoginQrCodeNewDirect` + +- 接口说明：获取登录二维码-直登(异地IP必须用代理! socks5://username:password@ipv4:port) +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` +- 代理说明：**涉及代理，请使用可用代理，格式 `socks5://username:password@ip:port`；异地 IP 建议配置代理**。 + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetLoginQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Check` | `boolean` | 否 | 修改代理时(SetProxy接口) 是否发送检测代理请求(可能导致请求超时) | +| `IpadOrmac` | `string` | 否 | 待补充 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | + +**请求体代码示例** + +```json +{ + "Check": "false", + "IpadOrmac": "", + "Proxy": "" +} +``` + +#### 4.14.5 `GET /login/GetLoginStatus` + +- 接口说明：获取在线状态 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.14.6 `GET /login/LogOut` + +- 接口说明：退出登录 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.14.7 `POST /login/VerifyCode` + +- 接口说明：验证码验证(输入iPad登录验证码) +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `VerifyCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `code` | `string` | 否 | 验证码 | +| `data62` | `string` | 否 | 验证码 | +| `ticket` | `string` | 否 | 验证码 | + +**请求体代码示例** + +```json +{ + "code": "", + "data62": "", + "ticket": "" +} +``` + +#### 4.14.8 `POST /login/VerifyCodeSlide` + +- 接口说明：过mac滑块验证 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SlideTicketModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `data62` | `string` | 否 | 验证码 | +| `randstr` | `object` | 否 | 待补充 | +| `slideticket` | `string` | 否 | 待补充 | +| `ticket` | `string` | 否 | 验证码 | + +**请求体代码示例** + +```json +{ + "data62": "", + "randstr": {}, + "slideticket": "", + "ticket": "" +} +``` + +#### 4.14.9 `POST /login/WakeUpLogin` + +- 接口说明：唤醒登录(只限扫码登录) +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetLoginQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Check` | `boolean` | 否 | 修改代理时(SetProxy接口) 是否发送检测代理请求(可能导致请求超时) | +| `IpadOrmac` | `string` | 否 | 待补充 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | + +**请求体代码示例** + +```json +{ + "Check": "false", + "IpadOrmac": "", + "Proxy": "" +} +``` + + +### 4.15 管理/授权 + +- 套餐分布：初级版 0，高级版 0，定制版 0，白标/OEM 9 + +#### 4.15.1 `POST /admin/DelayAuthKey` + +- 接口说明：授权码延期 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DelayAuthKeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Days` | `integer` | 否 | AuthKey 的延期天数; Days 小于1默认设置为30 | +| `ExpiryDate` | `string` | 否 | AuthKey 的到期日期(例如: 2024-01-01); 与 Days 参数只能选其一(优先使用 ExpiryDate 参数) | +| `Key` | `string` | 否 | 要延期的 AuthKey | + +**请求体代码示例** + +```json +{ + "Days": "30", + "ExpiryDate": "", + "Key": "" +} +``` + +#### 4.15.2 `POST /admin/DeleteAuthKey` + +- 接口说明：删除授权码 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DeleteAuthKeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Key` | `string` | 否 | 要删除的 AuthKey | +| `Opt` | `integer` | 否 | 删除操作 0:仅删除授权码 1:删除授权码相关的所有数据 | + +**请求体代码示例** + +```json +{ + "Key": "", + "Opt": 0 +} +``` + +#### 4.15.3 `POST /admin/DisableAuthKey` + +- 接口说明：禁用授权码 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `BannedAuthKeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `IsBanned` | `integer` | 否 | isBanned 1 禁用 默认设置为0 | +| `Key` | `string` | 否 | 要禁用的 AuthKey | + +**请求体代码示例** + +```json +{ + "IsBanned": "0", + "Key": "" +} +``` + +#### 4.15.4 `POST /admin/GenAuthKey1` + +- 接口说明：生成授权码(新设备) +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GenAuthKeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Count` | `integer` | 否 | 要生成 AuthKey 的个数; Count小于1默认设置为1 | +| `Days` | `integer` | 否 | AuthKey 的过期天数; Days小于1默认设置为30 | + +**请求体代码示例** + +```json +{ + "Count": "1", + "Days": "30" +} +``` + +#### 4.15.5 `GET /admin/GenAuthKey2` + +- 接口说明：生成授权码(新设备) +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.15.6 `POST /admin/GenAuthKey3` + +- 接口说明：生成授权码(1-日 7-周 30-月 90-季 180-半年 365-年 30000-永久)此key不使用无过期时间 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GenAuthKeyTypeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Count` | `integer` | 否 | 要生成 AuthKey 的个数; Count小于1默认设置为1 | +| `Type` | `integer` | 否 | 类型 1日 7 周 30月 90季 180 半年 365年 30000永久（数字为标识，非准确天数） | + +**请求体代码示例** + +```json +{ + "Count": "1", + "Type": "1" +} +``` + +#### 4.15.7 `GET /admin/GetActiveLicenseKeys` + +- 接口说明：查询所有激活状态的卡密 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.15.8 `GET /admin/GetProxyMappingList` + +- 接口说明：获取代理映射列表 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` +- 代理说明：**涉及代理，请使用可用代理，格式 `socks5://username:password@ip:port`；异地 IP 建议配置代理**。 + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.15.9 `GET /admin/HttpSyncLicenseKey` + +- 接口说明：同步卡密激活状态, HTTP-轮询方式 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + + +### 4.16 群管理 + +- 套餐分布：初级版 11，高级版 9，定制版 0，白标/OEM 0 + +#### 4.16.1 `POST /group/AddChatRoomMembers` + +- 接口说明：添加群成员 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `InviteChatroomMembersModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.2 `POST /group/AddChatroomAdmin` + +- 接口说明：添加群管理员 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatroomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.3 `POST /group/CreateChatRoom` + +- 接口说明：创建群请求 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CreateChatRoomModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `TopIc` | `string` | 否 | 待补充 | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "TopIc": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.4 `POST /group/DelChatroomAdmin` + +- 接口说明：删除群管理员 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatroomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.5 `POST /group/GetChatRoomInfo` + +- 接口说明：获取群详情 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatRoomWxIdListModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomWxIdList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomWxIdList": [ + "string" + ] +} +``` + +#### 4.16.6 `POST /group/GetChatroomMemberDetail` + +- 接口说明：获取群成员详细 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetChatroomMemberDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "" +} +``` + +#### 4.16.7 `POST /group/GetChatroomQrCode` + +- 接口说明：获取群二维码 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetChatroomQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "" +} +``` + +#### 4.16.8 `POST /group/InviteChatroomMembers` + +- 接口说明：邀请群成员 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `InviteChatroomMembersModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.9 `POST /group/MoveToContract` + +- 接口说明：获取群聊 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `MoveContractModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Val` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Val": 0 +} +``` + +#### 4.16.10 `POST /group/QuitChatroom` + +- 接口说明：退出群聊 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetChatroomMemberDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "" +} +``` + +#### 4.16.11 `POST /group/ScanIntoUrlGroup` + +- 接口说明：扫码入群 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ScanIntoUrlGroupModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.16.12 `POST /group/SendDelDelChatRoomMember` + +- 接口说明：删除群成员 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `InviteChatroomMembersModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.13 `POST /group/SendPat` + +- 接口说明：群拍一拍功能 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendPatModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Scene` | `integer` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Scene": 0, + "ToUserName": "" +} +``` + +#### 4.16.14 `POST /group/SendTransferGroupOwner` + +- 接口说明：转让群 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `TransferGroupOwnerModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `NewOwnerUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "NewOwnerUserName": "" +} +``` + +#### 4.16.15 `POST /group/SetChatroomAccessVerify` + +- 接口说明：设置群聊邀请开关 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetChatroomAccessVerifyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Enable` | `boolean` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Enable": false +} +``` + +#### 4.16.16 `POST /group/SetChatroomAnnouncement` + +- 接口说明：设置群公告 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateChatroomAnnouncementModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Content` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Content": "" +} +``` + +#### 4.16.17 `POST /group/SetChatroomName` + +- 接口说明：设置群昵称 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatroomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Nickname` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Nickname": "" +} +``` + +#### 4.16.18 `POST /group/SetGetChatRoomInfoDetail` + +- 接口说明：获取群公告 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetChatroomMemberDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "" +} +``` + +#### 4.16.19 `POST /group/SetGroupNickname` + +- 接口说明：设置我在本群的昵称 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatroomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Nickname` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Nickname": "" +} +``` + +#### 4.16.20 `POST /group/ToJoinGroup` + +- 接口说明：同意入群 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ConsentToJoinGroupModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + + +### 4.17 视频号 + +- 套餐分布：初级版 0，高级版 4，定制版 0，白标/OEM 0 + +#### 4.17.1 `POST /finder/ChannelsLogin` + +- 接口说明：视频号助手扫码登录 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChannelsLoginModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `finderUsername` | `string` | 否 | 指定要登录的视频号用户名，为空则选择第一个 | +| `url` | `string` | 否 | 视频号助手扫码登录确认链接 | + +**请求体代码示例** + +```json +{ + "finderUsername": "", + "url": "" +} +``` + +#### 4.17.2 `POST /finder/FinderFollow` + +- 接口说明：关注取消 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FinderFollowModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Cook` | `string` | 否 | 待补充 | +| `FinderUserName` | `string` | 否 | 待补充 | +| `OpType` | `integer` | 否 | 待补充 | +| `PosterUsername` | `string` | 否 | 待补充 | +| `RefObjectId` | `string` | 否 | 待补充 | +| `Userver` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Cook": "", + "FinderUserName": "", + "OpType": 0, + "PosterUsername": "", + "RefObjectId": "", + "Userver": 0 +} +``` + +#### 4.17.3 `POST /finder/FinderSearch` + +- 接口说明：视频号搜索 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FinderSearchModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Index` | `integer` | 否 | 待补充 | +| `UserKey` | `string` | 否 | 待补充 | +| `Userver` | `integer` | 否 | 待补充 | +| `Uuid` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Index": 0, + "UserKey": "", + "Userver": 0, + "Uuid": "" +} +``` + +#### 4.17.4 `POST /finder/FinderUserPrepare` + +- 接口说明：视频号中心 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FinderUserPrepareModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Userver` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Userver": 0 +} +``` + + +### 4.18 设备 + +- 套餐分布：初级版 4，高级版 0，定制版 0，白标/OEM 0 + +#### 4.18.1 `POST /equipment/DelSafeDevice` + +- 接口说明：删除安全设备 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DelSafeDeviceModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DeviceUUID` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "DeviceUUID": "" +} +``` + +#### 4.18.2 `GET /equipment/GetBoundHardDevice` + +- 接口说明：获取硬件设备情况 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.18.3 `GET /equipment/GetOnlineInfo` + +- 接口说明：获取在线设备信息 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.18.4 `POST /equipment/GetSafetyInfo` + +- 接口说明：获取安全设备列表 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 diff --git a/_docs、.md b/_docs、.md new file mode 100644 index 0000000..14f85c9 --- /dev/null +++ b/_docs、.md @@ -0,0 +1,7125 @@ +# WeChat智能托管 API 接口说明文档 + +## 1. 文档说明 + +- 数据来源：`API文档` +- 解析口径：严格按 Swagger 输出参数与字段说明 +- 接口总数：**193**（`Method + Path`） + +## 2. 套餐统计 + +| 套餐 | 接口数 | +|---|---:| +| 初级版 | 68 | +| 高级版 | 79 | +| 定制版 | 37 | +| 白标/OEM | 9 | + +## 3. 按模块统计 + +| 模块 | 接口数 | 初级版 | 高级版 | 定制版 | 白标/OEM | +|---|---:|---:|---:|---:|---:| +| 企业微信 | 22 | 0 | 0 | 22 | 0 | +| 公众号/小程序 | 13 | 0 | 13 | 0 | 0 | +| 其他 | 8 | 0 | 8 | 0 | 0 | +| 同步消息 | 1 | 0 | 1 | 0 | 0 | +| 好友 | 11 | 7 | 4 | 0 | 0 | +| 微信小店 | 4 | 0 | 0 | 4 | 0 | +| 支付 | 9 | 0 | 9 | 0 | 0 | +| 收藏 | 4 | 0 | 4 | 0 | 0 | +| 朋友圈 | 16 | 10 | 6 | 0 | 0 | +| 标签 | 5 | 5 | 0 | 0 | 0 | +| 消息 | 24 | 9 | 15 | 0 | 0 | +| 消息回调 | 4 | 0 | 4 | 0 | 0 | +| 用户 | 26 | 17 | 2 | 7 | 0 | +| 登录 | 9 | 5 | 0 | 4 | 0 | +| 管理/授权 | 9 | 0 | 0 | 0 | 9 | +| 群管理 | 20 | 11 | 9 | 0 | 0 | +| 视频号 | 4 | 0 | 4 | 0 | 0 | +| 设备 | 4 | 4 | 0 | 0 | 0 | + +## 4. 全量接口明细 + +### 4.1 企业微信 + +- 套餐分布：初级版 0，高级版 0，定制版 22，白标/OEM 0 + +#### 4.1.1 `POST /qy/QWAcceptChatRoom` + +- 接口说明：同意进企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAcceptChatRoomModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Link` | `string` | 否 | 待补充 | +| `Opcode` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Link": "", + "Opcode": 0 +} +``` + +#### 4.1.2 `POST /qy/QWAddChatRoomMember` + +- 接口说明：直接拉朋友进企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.3 `POST /qy/QWAdminAcceptJoinChatRoomSet` + +- 接口说明：设定企业群管理审核进群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAdminAcceptJoinChatRoomSetModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `P` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "P": 0 +} +``` + +#### 4.1.4 `POST /qy/QWApplyAddContact` + +- 接口说明：向企业微信打招呼 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWApplyAddContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Content` | `string` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | +| `V1` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Content": "", + "UserName": "", + "V1": "" +} +``` + +#### 4.1.5 `POST /qy/QWAppointChatRoomAdmin` + +- 接口说明：增加企业管理员 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.6 `POST /qy/QWChatRoomAnnounce` + +- 接口说明：发布企业群公告 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWModChatRoomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Name` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Name": "" +} +``` + +#### 4.1.7 `POST /qy/QWChatRoomTransferOwner` + +- 接口说明：转让企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWChatRoomTransferOwnerModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": "" +} +``` + +#### 4.1.8 `POST /qy/QWContact` + +- 接口说明：提取企业 wx 详情 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoom` | `string` | 否 | 待补充 | +| `T` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoom": "", + "T": "", + "ToUserName": "" +} +``` + +#### 4.1.9 `POST /qy/QWCreateChatRoom` + +- 接口说明：创建企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWCreateModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.10 `POST /qy/QWDelChatRoom` + +- 接口说明：删除企业群 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWModChatRoomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Name` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Name": "" +} +``` + +#### 4.1.11 `POST /qy/QWDelChatRoomAdmin` + +- 接口说明：移除群管理员 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.12 `POST /qy/QWDelChatRoomMember` + +- 接口说明：删除企业群成员 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.13 `POST /qy/QWGetChatRoomMember` + +- 接口说明：提取企业群全部成员 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.14 `POST /qy/QWGetChatRoomQR` + +- 接口说明：提取企业群二维码 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.15 `POST /qy/QWGetChatroomInfo` + +- 接口说明：提取企业群名称公告设定等信息 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.16 `POST /qy/QWInviteChatRoomMember` + +- 接口说明：发送群邀请链接 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWAddChatRoomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.1.17 `POST /qy/QWModChatRoomMemberNick` + +- 接口说明：修改成员在群中呢称 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWModChatRoomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Name` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Name": "" +} +``` + +#### 4.1.18 `POST /qy/QWModChatRoomName` + +- 接口说明：修改企业群名称 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWModChatRoomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Name` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Name": "" +} +``` + +#### 4.1.19 `POST /qy/QWRemark` + +- 接口说明：备注企业 wxid +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWRemarkModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Name` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Name": "", + "ToUserName": "" +} +``` + +#### 4.1.20 `POST /qy/QWSearchContact` + +- 接口说明：搜手机或企业对外名片链接提取验证 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SearchContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FromScene` | `integer` | 否 | 待补充 | +| `Tg` | `string` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FromScene": 0, + "Tg": "", + "UserName": "" +} +``` + +#### 4.1.21 `POST /qy/QWSyncChatRoom` + +- 接口说明：提取全部企业微信群- +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QWSyncChatRoomModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Key` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Key": "" +} +``` + +#### 4.1.22 `POST /qy/QWSyncContact` + +- 接口说明：提取全部的企业通讯录 +- 对应套餐：**定制版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + + +### 4.2 公众号/小程序 + +- 套餐分布：初级版 0，高级版 13，定制版 0，白标/OEM 0 + +#### 4.2.1 `POST /applet/AuthMpLogin` + +- 接口说明：授权公众号登录 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetMpA8KeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Opcode` | `integer` | 否 | 待补充 | +| `Scene` | `integer` | 否 | 待补充 | +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Opcode": 0, + "Scene": 0, + "Url": "" +} +``` + +#### 4.2.2 `POST /applet/FollowGH` + +- 接口说明：关注公众号 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FollowGHModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `GHList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "GHList": [ + { + "Gh": {}, + "Scene": {} + } + ] +} +``` + +#### 4.2.3 `POST /applet/GetA8Key` + +- 接口说明：授权链接 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetA8KeyRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `OpCode` | `integer` | 否 | 待补充 | +| `ReqUrl` | `string` | 否 | 待补充 | +| `Scene` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "OpCode": 0, + "ReqUrl": "", + "Scene": 0 +} +``` + +#### 4.2.4 `POST /applet/GetAppMsgExt` + +- 接口说明：阅读公众号文章 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ReadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 公众号文章URL | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.2.5 `POST /applet/GetAppMsgExtLike` + +- 接口说明：点赞公众号文章 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ReadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 公众号文章URL | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.2.6 `POST /applet/GetAppMsgReadCount` + +- 接口说明：获取公众号文章阅读数 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ReadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 公众号文章URL | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.2.7 `POST /applet/GetMpA8Key` + +- 接口说明：授权链接 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetMpA8KeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Opcode` | `integer` | 否 | 待补充 | +| `Scene` | `integer` | 否 | 待补充 | +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Opcode": 0, + "Scene": 0, + "Url": "" +} +``` + +#### 4.2.8 `POST /applet/GetMpHistoryMessage` + +- 接口说明：获取公众号历史消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetMpHistoryMsgModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.2.9 `POST /applet/JSOperateWxData` + +- 接口说明：小程序云函数操作 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AppletModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AppId` | `string` | 否 | 应用ID | +| `Data` | `string` | 否 | 小程序云函数操作的 Data; json字符串, 注意必须是 json 字符串; 传空时默认值为: '{"with_credentials":true,"from_component":true,"data":{"lang":"zh_CN"},"api_name":"webapi_getuserinfo"}' | +| `Opt` | `integer` | 否 | 小程序云函数操作的 Opt; 默认为1 | +| `PackageName` | `string` | 否 | 待补充 | +| `SdkName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AppId": "", + "Data": "", + "Opt": "1", + "PackageName": "", + "SdkName": "" +} +``` + +#### 4.2.10 `POST /applet/JsLogin` + +- 接口说明：授权小程序(返回授权后的code) +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AppletModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AppId` | `string` | 否 | 应用ID | +| `Data` | `string` | 否 | 小程序云函数操作的 Data; json字符串, 注意必须是 json 字符串; 传空时默认值为: '{"with_credentials":true,"from_component":true,"data":{"lang":"zh_CN"},"api_name":"webapi_getuserinfo"}' | +| `Opt` | `integer` | 否 | 小程序云函数操作的 Opt; 默认为1 | +| `PackageName` | `string` | 否 | 待补充 | +| `SdkName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AppId": "", + "Data": "", + "Opt": "1", + "PackageName": "", + "SdkName": "" +} +``` + +#### 4.2.11 `POST /applet/QRConnectAuthorize` + +- 接口说明：二维码授权请求 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QRConnectAuthorizeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `QrUrl` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "QrUrl": "" +} +``` + +#### 4.2.12 `POST /applet/QRConnectAuthorizeConfirm` + +- 接口说明：二维码授权确认 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `QRConnectAuthorizeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `QrUrl` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "QrUrl": "" +} +``` + +#### 4.2.13 `POST /applet/SdkOauthAuthorize` + +- 接口说明：应用授权 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AppletModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AppId` | `string` | 否 | 应用ID | +| `Data` | `string` | 否 | 小程序云函数操作的 Data; json字符串, 注意必须是 json 字符串; 传空时默认值为: '{"with_credentials":true,"from_component":true,"data":{"lang":"zh_CN"},"api_name":"webapi_getuserinfo"}' | +| `Opt` | `integer` | 否 | 小程序云函数操作的 Opt; 默认为1 | +| `PackageName` | `string` | 否 | 待补充 | +| `SdkName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AppId": "", + "Data": "", + "Opt": "1", + "PackageName": "", + "SdkName": "" +} +``` + + +### 4.3 其他 + +- 套餐分布：初级版 0，高级版 8，定制版 0，白标/OEM 0 + +#### 4.3.1 `POST /other/GetPeopleNearby` + +- 接口说明：查看附近的人 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `PeopleNearbyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Latitude` | `number` | 否 | 待补充 | +| `Longitude` | `number` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Latitude": 0, + "Longitude": 0 +} +``` + +#### 4.3.2 `GET /other/GetProjectFullPath` + +- 接口说明：获取项目完整路径 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.3.3 `POST /other/GetRedisSyncMsg` + +- 接口说明：获取缓存在redis中的消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.3.4 `POST /other/GetUserRankLikeCount` + +- 接口说明：获取步数排行数据列表 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UserRankLikeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `RankId` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "RankId": "" +} +``` + +#### 4.3.5 `POST /other/QWImageDownload` + +- 接口说明：企微图片下载 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadQWImageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `xml` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "xml": "" +} +``` + +#### 4.3.6 `POST /other/UpdateCmdStatus` + +- 接口说明：更新指令状态, key 为指令 id，Value 为指令状态 0|1，ValueStr 为字符串值 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ModifyCmdStatusModelNew` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Key` | `string` | 否 | 待补充 | +| `Value` | `integer` | 否 | 待补充 | +| `ValueStr` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Key": "101", + "Value": "1", + "ValueStr": "" +} +``` + +#### 4.3.7 `POST /other/UpdateStepNumber` + +- 接口说明：修改步数 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateStepNumberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Number` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Number": 0 +} +``` + +#### 4.3.8 `POST /other/UploadAppAttach` + +- 接口说明：上传文件 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadAppAttachModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `fileData` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "fileData": "" +} +``` + + +### 4.4 同步消息 + +- 套餐分布：初级版 0，高级版 1，定制版 0，白标/OEM 0 + +#### 4.4.1 `GET /ws/GetSyncMsg` + +- 接口说明：如果 "key" 有效，则调用 WebSocketHandler 进行后续处理。 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + + +### 4.5 好友 + +- 套餐分布：初级版 7，高级版 4，定制版 0，白标/OEM 0 + +#### 4.5.1 `POST /friend/AgreeAdd` + +- 接口说明：同意好友请求 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `VerifyUserRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomUserName` | `string` | 否 | 通过群来添加好友 需要设置此值为群id | +| `OpCode` | `integer` | 否 | 操作类型: 1(免验证发送请求) 2(添加好友/发送验证申请) 3(同意好友/通过好友验证) 4(拒绝好友) | +| `Scene` | `integer` | 否 | 添加来源, 同意添加好友时传回调消息xml中的scene值.
添加好友时的枚举值如下:
1(QQ) 2(邮箱) 3(微信号) 4(QQ好友) 8(来自群聊) 13(通讯录)
14(群聊) 15(手机号) 18(附近的人) 25(漂流瓶) 29(摇一摇) 30(二维码) | +| `V3` | `string` | 否 | V3用户名数据(SearchContact请求返回的UserValue) | +| `V4` | `string` | 否 | V4校验数据(SearchContact请求返回的AntispamTicket) | +| `VerifyContent` | `string` | 否 | 添加好友时的(招呼语/验证信息) | + +**请求体代码示例** + +```json +{ + "ChatRoomUserName": "", + "OpCode": "2", + "Scene": "3", + "V3": "", + "V4": "", + "VerifyContent": "" +} +``` + +#### 4.5.2 `POST /friend/DelContact` + +- 接口说明：删除好友 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DelContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DelUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "DelUserName": "" +} +``` + +#### 4.5.3 `POST /friend/GetContactDetailsList` + +- 接口说明：获取联系人详情 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `BatchGetContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `RoomWxIDList` | `array` | 否 | 待补充 | +| `UserNames` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "RoomWxIDList": [ + "string" + ], + "UserNames": [ + "string" + ] +} +``` + +#### 4.5.4 `POST /friend/GetContactList` + +- 接口说明：获取全部联系人 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetContactListModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CurrentChatRoomContactSeq` | `integer` | 否 | 待补充 | +| `CurrentWxcontactSeq` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "CurrentChatRoomContactSeq": 0, + "CurrentWxcontactSeq": 0 +} +``` + +#### 4.5.5 `POST /friend/GetFriendRelation` + +- 接口说明：获取好友关系 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetFriendRelationModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "UserName": "" +} +``` + +#### 4.5.6 `GET /friend/GetGHList` + +- 接口说明：获取关注的公众号列表 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.5.7 `GET /friend/GetMFriend` + +- 接口说明：获取手机通讯录好友 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.5.8 `GET /friend/GroupList` + +- 接口说明：获取保存的群聊列表 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.5.9 `POST /friend/SearchContact` + +- 接口说明：搜索联系人 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SearchContactRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FromScene` | `integer` | 否 | 待补充 | +| `OpCode` | `integer` | 否 | 操作类型 | +| `SearchScene` | `integer` | 否 | 搜索场景 | +| `UserName` | `string` | 否 | 要搜索的内容(微信号、手机号、QQ号等) | + +**请求体代码示例** + +```json +{ + "FromScene": 0, + "OpCode": 0, + "SearchScene": 0, + "UserName": "" +} +``` + +#### 4.5.10 `POST /friend/UploadMContact` + +- 接口说明：上传手机通讯录好友 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadMContactModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Mobile` | `string` | 否 | 待补充 | +| `MobileList` | `array` | 否 | 待补充 | +| `Opcode` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Mobile": "", + "MobileList": [ + "string" + ], + "Opcode": 0 +} +``` + +#### 4.5.11 `POST /friend/VerifyUser` + +- 接口说明：验证好友/添加好友 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `VerifyUserRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomUserName` | `string` | 否 | 通过群来添加好友 需要设置此值为群id | +| `OpCode` | `integer` | 否 | 操作类型: 1(免验证发送请求) 2(添加好友/发送验证申请) 3(同意好友/通过好友验证) 4(拒绝好友) | +| `Scene` | `integer` | 否 | 添加来源, 同意添加好友时传回调消息xml中的scene值.
添加好友时的枚举值如下:
1(QQ) 2(邮箱) 3(微信号) 4(QQ好友) 8(来自群聊) 13(通讯录)
14(群聊) 15(手机号) 18(附近的人) 25(漂流瓶) 29(摇一摇) 30(二维码) | +| `V3` | `string` | 否 | V3用户名数据(SearchContact请求返回的UserValue) | +| `V4` | `string` | 否 | V4校验数据(SearchContact请求返回的AntispamTicket) | +| `VerifyContent` | `string` | 否 | 添加好友时的(招呼语/验证信息) | + +**请求体代码示例** + +```json +{ + "ChatRoomUserName": "", + "OpCode": "2", + "Scene": "3", + "V3": "", + "V4": "", + "VerifyContent": "" +} +``` + + +### 4.6 微信小店 + +- 套餐分布：初级版 0，高级版 0，定制版 4，白标/OEM 0 + +#### 4.6.1 `POST /shop/ExtDeviceLoginConfirmGet` + +- 接口说明：- +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShopLoginConfirmModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `url` | `string` | 否 | 登录二维码URL | + +**请求体代码示例** + +```json +{ + "url": "" +} +``` + +#### 4.6.2 `POST /shop/ExtDeviceLoginConfirmOk` + +- 接口说明：- +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShopLoginConfirmModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `url` | `string` | 否 | 登录二维码URL | + +**请求体代码示例** + +```json +{ + "url": "" +} +``` + +#### 4.6.3 `POST /shop/ScanQrcodeEventReport` + +- 接口说明：- +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShopLoginConfirmModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `url` | `string` | 否 | 登录二维码URL | + +**请求体代码示例** + +```json +{ + "url": "" +} +``` + +#### 4.6.4 `POST /shop/ShopLoginConfirm` + +- 接口说明：微信小店确认登录 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShopLoginConfirmModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `url` | `string` | 否 | 登录二维码URL | + +**请求体代码示例** + +```json +{ + "url": "" +} +``` + + +### 4.7 支付 + +- 套餐分布：初级版 0，高级版 9，定制版 0，白标/OEM 0 + +#### 4.7.1 `POST /pay/Collectmoney` + +- 接口说明：确定收款 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CollectmoneyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `InvalidTime` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | +| `TransFerId` | `string` | 否 | 待补充 | +| `TransactionId` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "InvalidTime": "", + "ToUserName": "", + "TransFerId": "", + "TransactionId": "" +} +``` + +#### 4.7.2 `POST /pay/ConfirmPreTransfer` + +- 接口说明：确认转账(客户端版本过低会无法转账) +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ConfirmPreTransfer` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BankSerial` | `string` | 否 | 付款方式 Serial序列号 | +| `BankType` | `string` | 否 | 付款方式 类型 | +| `PayPassword` | `string` | 否 | 支付密码 | +| `ReqKey` | `string` | 否 | 创建转账返回的ReqKey | + +**请求体代码示例** + +```json +{ + "BankSerial": "", + "BankType": "", + "PayPassword": "", + "ReqKey": "" +} +``` + +#### 4.7.3 `POST /pay/CreatePreTransfer` + +- 接口说明：创建转账 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CreatePreTransfer` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Description` | `string` | 否 | 转账备注 | +| `Fee` | `integer` | 否 | 转账金额(单位为分) | +| `ToUserName` | `string` | 否 | 要转账用户的wxid | + +**请求体代码示例** + +```json +{ + "Description": "", + "Fee": 0, + "ToUserName": "" +} +``` + +#### 4.7.4 `POST /pay/GeneratePayQCode` + +- 接口说明：生成自定义收款二维码 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GeneratePayQCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Money` | `string` | 否 | 金额(单位为分), 999 即为 9.99 元 | +| `Name` | `string` | 否 | 收款备注 | + +**请求体代码示例** + +```json +{ + "Money": "", + "Name": "" +} +``` + +#### 4.7.5 `POST /pay/GetBandCardList` + +- 接口说明：获取银行卡信息 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.7.6 `POST /pay/GetRedEnvelopesDetail` + +- 接口说明：查看红包详情 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `HongBaoItem` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DequeueAtMs` | `integer` | 否 | 待补充 | +| `EnqueueAtMs` | `integer` | 否 | 待补充 | +| `FromUserName` | `string` | 否 | 待补充 | +| `IsGroup` | `integer` | 否 | 默认 1 | +| `Limit` | `integer` | 否 | 待补充 | +| `NativeURL` | `string` | 否 | 待补充 | +| `RecvAtMs` | `integer` | 否 | 待补充 | +| `SceneID` | `integer` | 否 | 待补充 | +| `SessionUserName` | `string` | 否 | 群ID或个人ID | +| `URLItem` | `object` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "DequeueAtMs": 0, + "EnqueueAtMs": 0, + "FromUserName": "", + "IsGroup": 0, + "Limit": 0, + "NativeURL": "", + "RecvAtMs": 0, + "SceneID": 0, + "SessionUserName": "", + "URLItem": { + "ChannelID": "", + "MsgType": "", + "SceneID": 0, + "SendID": "", + "SendUserName": "", + "ShowSourceMac": "", + "ShowWxPayTitle": "", + "Sign": "", + "Ver": "" + } +} +``` + +#### 4.7.7 `POST /pay/GetRedPacketList` + +- 接口说明：查看红包领取列表 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetRedPacketList` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `HongBaoItem` | `object` | 否 | 待补充 | +| `Limit` | `integer` | 否 | 待补充 | +| `NativeURL` | `string` | 否 | 待补充 | +| `Offset` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "HongBaoItem": { + "ChannelID": "", + "MsgType": "", + "SceneID": 0, + "SendID": "", + "SendUserName": "", + "ShowSourceMac": "", + "ShowWxPayTitle": "", + "Sign": "", + "Ver": "" + }, + "Limit": 0, + "NativeURL": "", + "Offset": 0 +} +``` + +#### 4.7.8 `POST /pay/OpenRedEnvelopes` + +- 接口说明：拆红包 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `HongBaoItem` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DequeueAtMs` | `integer` | 否 | 待补充 | +| `EnqueueAtMs` | `integer` | 否 | 待补充 | +| `FromUserName` | `string` | 否 | 待补充 | +| `IsGroup` | `integer` | 否 | 默认 1 | +| `Limit` | `integer` | 否 | 待补充 | +| `NativeURL` | `string` | 否 | 待补充 | +| `RecvAtMs` | `integer` | 否 | 待补充 | +| `SceneID` | `integer` | 否 | 待补充 | +| `SessionUserName` | `string` | 否 | 群ID或个人ID | +| `URLItem` | `object` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "DequeueAtMs": 0, + "EnqueueAtMs": 0, + "FromUserName": "", + "IsGroup": 0, + "Limit": 0, + "NativeURL": "", + "RecvAtMs": 0, + "SceneID": 0, + "SessionUserName": "", + "URLItem": { + "ChannelID": "", + "MsgType": "", + "SceneID": 0, + "SendID": "", + "SendUserName": "", + "ShowSourceMac": "", + "ShowWxPayTitle": "", + "Sign": "", + "Ver": "" + } +} +``` + +#### 4.7.9 `POST /pay/WXCreateRedPacket` + +- 接口说明：创建红包 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `RedPacket` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Amount` | `integer` | 否 | 每个红包的金额(单位为分, 最小为100); 总金额为 Amount*Count | +| `Content` | `string` | 否 | 红包的备注内容(祝福语) | +| `Count` | `integer` | 否 | 红包个数(最少为1) | +| `From` | `integer` | 否 | InAway(0:群红包; 1:个人红包) | +| `RedType` | `integer` | 否 | 红包类型(0 普通红包; 1 拼手气红包; ? 专属红包) | +| `Username` | `string` | 否 | 红包接收者; wxid 或 群ID | + +**请求体代码示例** + +```json +{ + "Amount": 0, + "Content": "", + "Count": 0, + "From": 0, + "RedType": 0, + "Username": "" +} +``` + + +### 4.8 收藏 + +- 套餐分布：初级版 0，高级版 4，定制版 0，白标/OEM 0 + +#### 4.8.1 `POST /favor/BatchDelFavItem` + +- 接口说明：删除收藏 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FavInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FavId` | `integer` | 否 | 待补充 | +| `KeyBuf` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FavId": 0, + "KeyBuf": "" +} +``` + +#### 4.8.2 `GET /favor/FavSync` + +- 接口说明：同步收藏 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.8.3 `POST /favor/GetFavItemId` + +- 接口说明：获取收藏详细 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FavInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FavId` | `integer` | 否 | 待补充 | +| `KeyBuf` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FavId": 0, + "KeyBuf": "" +} +``` + +#### 4.8.4 `POST /favor/GetFavList` + +- 接口说明：获取收藏list +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FavInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FavId` | `integer` | 否 | 待补充 | +| `KeyBuf` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FavId": 0, + "KeyBuf": "" +} +``` + + +### 4.9 朋友圈 + +- 套餐分布：初级版 10，高级版 6，定制版 0，白标/OEM 0 + +#### 4.9.1 `POST /sns/CdnSnsVideoUpload` + +- 接口说明：上传CDN朋友圈视频 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CdnSnsVideoUploadModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ThumbData` | `string` | 否 | 缩略图数据的base64编码 | +| `VideoData` | `string` | 否 | 视频数据的base64编码 | + +**请求体代码示例** + +```json +{ + "ThumbData": "", + "VideoData": "" +} +``` + +#### 4.9.2 `POST /sns/DownloadMedia` + +- 接口说明：下载朋友圈视频 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadMediaModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Key` | `string` | 否 | 待补充 | +| `URL` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Key": "", + "URL": "" +} +``` + +#### 4.9.3 `POST /sns/GetCollectCircle` + +- 接口说明：获取收藏朋友圈详情 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendFavItemCircle` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 待补充 | +| `FavItemID` | `integer` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `LocationVal` | `integer` | 否 | 待补充 | +| `SourceID` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "FavItemID": 0, + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "LocationVal": 0, + "SourceID": "" +} +``` + +#### 4.9.4 `POST /sns/GetSnsSync` + +- 接口说明：同步朋友圈 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.9.5 `POST /sns/SendFavItemCircle` + +- 接口说明：转发收藏朋友圈 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendFavItemCircle` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 待补充 | +| `FavItemID` | `integer` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `LocationVal` | `integer` | 否 | 待补充 | +| `SourceID` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "FavItemID": 0, + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "LocationVal": 0, + "SourceID": "" +} +``` + +#### 4.9.6 `POST /sns/SendFriendCircle` + +- 接口说明：发送朋友圈 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SnsPostItemModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 不可见好友列表 | +| `Content` | `string` | 否 | 文本内容 | +| `ContentStyle` | `integer` | 否 | 纯文字/图文/引用/视频 | +| `ContentUrl` | `string` | 否 | 待补充 | +| `Description` | `string` | 否 | 待补充 | +| `GroupUserList` | `array` | 否 | 可见好友列表 | +| `LocationInfo` | `object` | 否 | 发送朋友圈的位置信息 | +| `MediaList` | `array` | 否 | 图片/视频列表 | +| `Privacy` | `integer` | 否 | 是否仅自己可见 | +| `WithUserList` | `array` | 否 | 提醒好友看列表 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "Content": "", + "ContentStyle": 0, + "ContentUrl": "", + "Description": "", + "GroupUserList": [ + "string" + ], + "LocationInfo": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiClickableStatus": 0, + "PoiInfoURL": "", + "PoiName": "", + "PoiScale": 0 + }, + "MediaList": [ + { + "Description": {}, + "ID": {}, + "MD5": {}, + "Private": {}, + "SizeHeight": {}, + "SizeWidth": {}, + "SubType": {}, + "ThumType": {}, + "Thumb": {}, + "Title": {}, + "TotalSize": {}, + "Type": {}, + "URL": {}, + "URLType": {}, + "UserData": {}, + "VideoDuration": {}, + "VideoHeight": {}, + "VideoMD5": {}, + "VideoWidth": {} + } + ], + "Privacy": 0, + "WithUserList": [ + "string" + ] +} +``` + +#### 4.9.7 `POST /sns/SendFriendCircleByXMl` + +- 接口说明：发送朋友圈XML结构 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `TimelineObject` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ActionInfo` | `object` | 否 | 待补充 | +| `AppInfo` | `object` | 否 | 待补充 | +| `ContentDesc` | `string` | 否 | 待补充 | +| `ContentDescScene` | `integer` | 否 | 待补充 | +| `ContentDescShowType` | `integer` | 否 | 待补充 | +| `ContentObject` | `object` | 否 | 待补充 | +| `ContentObjectVideo` | `object` | 否 | 待补充 | +| `CreateTime` | `integer` | 否 | 待补充 | +| `ID` | `integer` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `Private` | `integer` | 否 | 待补充 | +| `PublicUserName` | `string` | 否 | 待补充 | +| `ShowFlag` | `integer` | 否 | 待补充 | +| `SightFolded` | `integer` | 否 | 待补充 | +| `SourceNickName` | `string` | 否 | 待补充 | +| `SourceUserName` | `string` | 否 | 待补充 | +| `StatExtStr` | `string` | 否 | 待补充 | +| `StatisticsData` | `string` | 否 | 待补充 | +| `StreamVideo` | `object` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ActionInfo": { + "AppMsg": {} + }, + "AppInfo": { + "AppName": "", + "FromURL": "", + "ID": "", + "InstallURL": "", + "IsForceUpdate": 0, + "Version": "" + }, + "ContentDesc": "", + "ContentDescScene": 0, + "ContentDescShowType": 0, + "ContentObject": { + "ContentStyle": 0, + "ContentURL": "", + "Description": "", + "MediaList": {}, + "Title": "" + }, + "ContentObjectVideo": {}, + "CreateTime": 0, + "ID": 0, + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "Private": 0, + "PublicUserName": "", + "ShowFlag": 0, + "SightFolded": 0, + "SourceNickName": "", + "SourceUserName": "", + "StatExtStr": "", + "StatisticsData": "", + "StreamVideo": { + "StreamVideoThumbURL": "", + "StreamVideoURL": "", + "StreamVideoWebURL": "" + }, + "UserName": "" +} +``` + +#### 4.9.8 `POST /sns/SendOneIdCircle` + +- 接口说明：一键转发朋友圈 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetIdDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 待补充 | +| `Id` | `string` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `LocationVal` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "Id": "", + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "LocationVal": 0 +} +``` + +#### 4.9.9 `POST /sns/SendSnsComment` + +- 接口说明：点赞评论 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendSnsCommentRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `SnsCommentList` | `array` | 否 | 待补充 | +| `Tx` | `boolean` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "SnsCommentList": [ + { + "Content": {}, + "CreateTime": {}, + "ItemID": {}, + "OpType": {}, + "ReplyCommentID": {}, + "ReplyItem": {}, + "ToUserName": {} + } + ], + "Tx": false +} +``` + +#### 4.9.10 `POST /sns/SendSnsObjectDetailById` + +- 接口说明：获取指定id朋友圈 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetIdDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `BlackList` | `array` | 否 | 待补充 | +| `Id` | `string` | 否 | 待补充 | +| `Location` | `object` | 否 | 待补充 | +| `LocationVal` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "BlackList": [ + "string" + ], + "Id": "", + "Location": { + "City": "", + "Latitude": "", + "Longitude": "", + "PoiAddress": "", + "PoiClassifyID": "", + "PoiClassifyType": 0, + "PoiName": "" + }, + "LocationVal": 0 +} +``` + +#### 4.9.11 `POST /sns/SendSnsObjectOp` + +- 接口说明：朋友圈操作 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendSnsObjectOpRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `SnsObjectOpList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "SnsObjectOpList": [ + { + "Data": {}, + "DataLen": {}, + "Ext": {}, + "OpType": {}, + "SnsObjID": {} + } + ] +} +``` + +#### 4.9.12 `POST /sns/SendSnsTimeLine` + +- 接口说明：获取朋友圈主页 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetSnsInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FirstPageMD5` | `string` | 否 | 待补充 | +| `MaxID` | `integer` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FirstPageMD5": "", + "MaxID": 0, + "UserName": "" +} +``` + +#### 4.9.13 `POST /sns/SendSnsUserPage` + +- 接口说明：获取指定人朋友圈 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetSnsInfoModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `FirstPageMD5` | `string` | 否 | 待补充 | +| `MaxID` | `integer` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "FirstPageMD5": "", + "MaxID": 0, + "UserName": "" +} +``` + +#### 4.9.14 `POST /sns/SetBackgroundImage` + +- 接口说明：设置朋友圈背景图片 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetBackgroundImageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.9.15 `POST /sns/SetFriendCircleDays` + +- 接口说明：设置朋友圈可见天数 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetFriendCircleDaysModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Function` | `integer` | 否 | 待补充 | +| `Value` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Function": 0, + "Value": 0 +} +``` + +#### 4.9.16 `POST /sns/UploadFriendCircleImage` + +- 接口说明：上传图片信息 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadFriendCircleModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ImageDataList` | `array` | 否 | 待补充 | +| `VideoDataList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ImageDataList": [ + "string" + ], + "VideoDataList": [ + "string" + ] +} +``` + + +### 4.10 标签 + +- 套餐分布：初级版 5，高级版 0，定制版 0，白标/OEM 0 + +#### 4.10.1 `POST /label/AddContactLabel` + +- 接口说明：添加列表 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `LabelModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `LabelId` | `string` | 否 | 待补充 | +| `LabelNameList` | `array` | 否 | 待补充 | +| `UserLabelList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "LabelId": "", + "LabelNameList": [ + "string" + ], + "UserLabelList": [ + { + "LabelIDList": {}, + "UserName": {} + } + ] +} +``` + +#### 4.10.2 `POST /label/DelContactLabel` + +- 接口说明：删除标签 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `LabelModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `LabelId` | `string` | 否 | 待补充 | +| `LabelNameList` | `array` | 否 | 待补充 | +| `UserLabelList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "LabelId": "", + "LabelNameList": [ + "string" + ], + "UserLabelList": [ + { + "LabelIDList": {}, + "UserName": {} + } + ] +} +``` + +#### 4.10.3 `GET /label/GetContactLabelList` + +- 接口说明：获取标签列表 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.10.4 `POST /label/GetWXFriendListByLabel` + +- 接口说明：获取标签下所有好友 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `LabelModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `LabelId` | `string` | 否 | 待补充 | +| `LabelNameList` | `array` | 否 | 待补充 | +| `UserLabelList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "LabelId": "", + "LabelNameList": [ + "string" + ], + "UserLabelList": [ + { + "LabelIDList": {}, + "UserName": {} + } + ] +} +``` + +#### 4.10.5 `POST /label/ModifyLabel` + +- 接口说明：修改标签 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `LabelModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `LabelId` | `string` | 否 | 待补充 | +| `LabelNameList` | `array` | 否 | 待补充 | +| `UserLabelList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "LabelId": "", + "LabelNameList": [ + "string" + ], + "UserLabelList": [ + { + "LabelIDList": {}, + "UserName": {} + } + ] +} +``` + + +### 4.11 消息 + +- 套餐分布：初级版 9，高级版 15，定制版 0，白标/OEM 0 + +#### 4.11.1 `POST /message/AddMessageMgr` + +- 接口说明：添加要发送的文本消息进入管理器 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `MsgItem` | `array` | 否 | 消息体数组 | + +**请求体代码示例** + +```json +{ + "MsgItem": [ + { + "AtWxIDList": {}, + "ImageContent": {}, + "MsgType": {}, + "TextContent": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.2 `POST /message/CdnUploadVideo` + +- 接口说明：上传视频 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CdnUploadVideoRequest` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ThumbData` | `array` | 否 | ThumbData | +| `ToUserName` | `string` | 否 | 待补充 | +| `VideoData` | `array` | 否 | 视频数据 | + +**请求体代码示例** + +```json +{ + "ThumbData": [ + 0 + ], + "ToUserName": "", + "VideoData": [ + 0 + ] +} +``` + +#### 4.11.3 `POST /message/DownloadEmojiGif` + +- 接口说明：下载表情 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadEmojiModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `xml_content` | `string` | 否 | msg_type=47的消息xml内容 | + +**请求体代码示例** + +```json +{ + "xml_content": "" +} +``` + +#### 4.11.4 `POST /message/ForwardEmoji` + +- 接口说明：转发表情，包含动图 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendEmojiMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `EmojiList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "EmojiList": [ + { + "EmojiMd5": {}, + "EmojiSize": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.5 `POST /message/ForwardImageMessage` + +- 接口说明：转发图片 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ForwardMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ForwardImageList` | `array` | 否 | 待补充 | +| `ForwardVideoList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ForwardImageList": [ + { + "AesKey": {}, + "CdnMidImgSize": {}, + "CdnMidImgUrl": {}, + "CdnThumbImgSize": {}, + "ToUserName": {} + } + ], + "ForwardVideoList": [ + { + "AesKey": {}, + "CdnThumbLength": {}, + "CdnVideoUrl": {}, + "Length": {}, + "PlayLength": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.6 `POST /message/ForwardVideoMessage` + +- 接口说明：转发视频 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ForwardMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ForwardImageList` | `array` | 否 | 待补充 | +| `ForwardVideoList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ForwardImageList": [ + { + "AesKey": {}, + "CdnMidImgSize": {}, + "CdnMidImgUrl": {}, + "CdnThumbImgSize": {}, + "ToUserName": {} + } + ], + "ForwardVideoList": [ + { + "AesKey": {}, + "CdnThumbLength": {}, + "CdnVideoUrl": {}, + "Length": {}, + "PlayLength": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.7 `POST /message/GetMsgBigImg` + +- 接口说明：获取图片(高清图片下载) +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CompressType` | `integer` | 否 | 下载图片时，数据压缩类型(默认为0即可) | +| `FromUserName` | `string` | 否 | 下载图片时，图片消息的发送者 | +| `MsgId` | `integer` | 否 | 消息ID(注意是msg_id 不是new_msg_id) | +| `Section` | `object` | 否 | 当前要获取的数据分包 | +| `ToUserName` | `string` | 否 | 下载图片时，图片消息的接收者 | +| `TotalLen` | `integer` | 否 | 下载数据的总长度 | + +**请求体代码示例** + +```json +{ + "CompressType": 0, + "FromUserName": "", + "MsgId": 0, + "Section": { + "DataLen": "61440", + "StartPos": 0 + }, + "ToUserName": "", + "TotalLen": 0 +} +``` + +#### 4.11.8 `POST /message/GetMsgVideo` + +- 接口说明：获取视频(视频数据下载) +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CompressType` | `integer` | 否 | 下载图片时，数据压缩类型(默认为0即可) | +| `FromUserName` | `string` | 否 | 下载图片时，图片消息的发送者 | +| `MsgId` | `integer` | 否 | 消息ID(注意是msg_id 不是new_msg_id) | +| `Section` | `object` | 否 | 当前要获取的数据分包 | +| `ToUserName` | `string` | 否 | 下载图片时，图片消息的接收者 | +| `TotalLen` | `integer` | 否 | 下载数据的总长度 | + +**请求体代码示例** + +```json +{ + "CompressType": 0, + "FromUserName": "", + "MsgId": 0, + "Section": { + "DataLen": "61440", + "StartPos": 0 + }, + "ToUserName": "", + "TotalLen": 0 +} +``` + +#### 4.11.9 `POST /message/GetMsgVoice` + +- 接口说明：下载语音消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownloadVoiceModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Bufid` | `string` | 否 | 待补充 | +| `Length` | `integer` | 否 | 待补充 | +| `NewMsgId` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Bufid": "", + "Length": 0, + "NewMsgId": "", + "ToUserName": "" +} +``` + +#### 4.11.10 `POST /message/GroupMassMsgImage` + +- 接口说明：群发图片 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GroupMassMsgImageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ImageBase64` | `string` | 否 | 待补充 | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ImageBase64": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.11.11 `POST /message/GroupMassMsgText` + +- 接口说明：群发接口 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GroupMassMsgTextModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Content` | `string` | 否 | 待补充 | +| `ToUserName` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Content": "", + "ToUserName": [ + "string" + ] +} +``` + +#### 4.11.12 `POST /message/HttpSyncMsg` + +- 接口说明：同步消息, HTTP-轮询方式 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SyncMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Count` | `integer` | 否 | 同步几条消息; 接收空请求体, 默认为0, 同步所有消息 | + +**请求体代码示例** + +```json +{ + "Count": 0 +} +``` + +#### 4.11.13 `POST /message/NewSyncHistoryMessage` + +- 接口说明：同步历史消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.11.14 `POST /message/RevokeMsg` + +- 接口说明：撤销消息 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `RevokeMsgModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ClientImgIdStr` | `string` | 否 | 保存clientImgId的原始字符串值 | +| `ClientMsgId` | `integer` | 否 | 待补充 | +| `CreateTime` | `integer` | 否 | 待补充 | +| `IsImage` | `boolean` | 否 | 标识是否为图片消息 | +| `NewMsgId` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ClientImgIdStr": "", + "ClientMsgId": 0, + "CreateTime": 0, + "IsImage": false, + "NewMsgId": "", + "ToUserName": "" +} +``` + +#### 4.11.15 `POST /message/RevokeMsgNew` + +- 接口说明：撤回消息（New） +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `RevokeMsgModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ClientImgIdStr` | `string` | 否 | 保存clientImgId的原始字符串值 | +| `ClientMsgId` | `integer` | 否 | 待补充 | +| `CreateTime` | `integer` | 否 | 待补充 | +| `IsImage` | `boolean` | 否 | 标识是否为图片消息 | +| `NewMsgId` | `string` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ClientImgIdStr": "", + "ClientMsgId": 0, + "CreateTime": 0, + "IsImage": false, + "NewMsgId": "", + "ToUserName": "" +} +``` + +#### 4.11.16 `POST /message/SendAppMessage` + +- 接口说明：发送App消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AppMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AppList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AppList": [ + { + "ContentType": {}, + "ContentXML": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.17 `POST /message/SendCdnDownload` + +- 接口说明：下载 请求 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DownMediaModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `AesKey` | `string` | 否 | 待补充 | +| `FileType` | `integer` | 否 | 待补充 | +| `FileURL` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "AesKey": "", + "FileType": 0, + "FileURL": "" +} +``` + +#### 4.11.18 `POST /message/SendEmojiMessage` + +- 接口说明：发送表情 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendEmojiMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `EmojiList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "EmojiList": [ + { + "EmojiMd5": {}, + "EmojiSize": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.19 `POST /message/SendImageMessage` + +- 接口说明：发送图片消息 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `MsgItem` | `array` | 否 | 消息体数组 | + +**请求体代码示例** + +```json +{ + "MsgItem": [ + { + "AtWxIDList": {}, + "ImageContent": {}, + "MsgType": {}, + "TextContent": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.20 `POST /message/SendImageNewMessage` + +- 接口说明：发送图片消息（New） +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `MsgItem` | `array` | 否 | 消息体数组 | + +**请求体代码示例** + +```json +{ + "MsgItem": [ + { + "AtWxIDList": {}, + "ImageContent": {}, + "MsgType": {}, + "TextContent": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.21 `POST /message/SendTextMessage` + +- 接口说明：发送文本消息 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendMessageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `MsgItem` | `array` | 否 | 消息体数组 | + +**请求体代码示例** + +```json +{ + "MsgItem": [ + { + "AtWxIDList": {}, + "ImageContent": {}, + "MsgType": {}, + "TextContent": {}, + "ToUserName": {} + } + ] +} +``` + +#### 4.11.22 `POST /message/SendVoice` + +- 接口说明：发送语音 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendUploadVoiceRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ToUserName` | `string` | 否 | 待补充 | +| `VoiceData` | `string` | 否 | 待补充 | +| `VoiceFormat` | `integer` | 否 | 待补充 | +| `VoiceSecond,` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ToUserName": "", + "VoiceData": "", + "VoiceFormat": 0, + "VoiceSecond,": 0 +} +``` + +#### 4.11.23 `POST /message/ShareCardMessage` + +- 接口说明：分享名片消息 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ShareCardParam` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CardAlias` | `string` | 否 | 名片别名(发送公众号名片时留空) | +| `CardFlag` | `integer` | 否 | 名片CertFlag(0:个人名片 24:公众号名片) | +| `CardNickName` | `string` | 否 | 名片昵称 | +| `CardWxId` | `string` | 否 | 名片wxid | +| `ToUserName` | `string` | 否 | 消息接收者 | + +**请求体代码示例** + +```json +{ + "CardAlias": "", + "CardFlag": 0, + "CardNickName": "", + "CardWxId": "", + "ToUserName": "" +} +``` + +#### 4.11.24 `POST /message/UploadImageToCDN` + +- 接口说明：纯CDN图片上传接口 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadImageToCDNModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `imageContent` | `string` | 否 | 图片的base64编码 | + +**请求体代码示例** + +```json +{ + "imageContent": "" +} +``` + + +### 4.12 消息回调 + +- 套餐分布：初级版 0，高级版 4，定制版 0，白标/OEM 0 + +#### 4.12.1 `GET /message/DeleteCallback` + +- 接口说明：删除消息回调配置 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.12.2 `GET /message/GetCallback` + +- 接口说明：获取消息回调配置 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.12.3 `POST /message/SetCallback` + +- 接口说明：设置消息回调 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `MessageCallbackConfigModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `CallbackURL` | `string` | 否 | 回调URL | +| `Enabled` | `boolean` | 否 | 是否启用回调 | + +**请求体代码示例** + +```json +{ + "CallbackURL": "", + "Enabled": false +} +``` + +#### 4.12.4 `GET /message/TestCallback` + +- 接口说明：测试消息回调配置 +- 对应套餐：**高级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + + +### 4.13 用户 + +- 套餐分布：初级版 17，高级版 2，定制版 7，白标/OEM 0 + +#### 4.13.1 `POST /user/ChangePwd` + +- 接口说明：更改密码 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendChangePwdRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `newPass` | `string` | 否 | 待补充 | +| `oldPass` | `string` | 否 | 确保json标签是`oldPass` | +| `opCode` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "newPass": "", + "oldPass": "", + "opCode": 0 +} +``` + +#### 4.13.2 `GET /user/GetAdminKeyword` + +- 接口说明：获取管理员关键词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.3 `GET /user/GetInviteKeyword` + +- 接口说明：获取关键词邀请入群配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.4 `GET /user/GetKeywordReply` + +- 接口说明：获取关键词自动回复配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.5 `GET /user/GetKickKeyword` + +- 接口说明：获取踢人关键词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.6 `POST /user/GetMyQrCode` + +- 接口说明：获取我的二维码 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Recover` | `boolean` | 否 | 保持默认值, 无需修改 | +| `Style` | `integer` | 否 | 个人二维码样式: 可设置为8, 其余自行探索 | + +**请求体代码示例** + +```json +{ + "Recover": false, + "Style": "8" +} +``` + +#### 4.13.7 `GET /user/GetProfile` + +- 接口说明：获取个人资料信息 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.8 `GET /user/GetWelcome` + +- 接口说明：获取欢迎词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.9 `POST /user/ModifyRemark` + +- 接口说明：修改备注 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendModifyRemarkRequestModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `RemarkName` | `string` | 否 | 待补充 | +| `UserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "RemarkName": "", + "UserName": "" +} +``` + +#### 4.13.10 `POST /user/ModifyUserInfo` + +- 接口说明：修改资料 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ModifyUserInfo` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `City` | `string` | 否 | 待补充 | +| `Country` | `string` | 否 | 待补充 | +| `InitFlag` | `integer` | 否 | 待补充 | +| `NickName` | `string` | 否 | 待补充 | +| `Province` | `string` | 否 | 待补充 | +| `Sex` | `integer` | 否 | 待补充 | +| `Signature` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "City": "", + "Country": "", + "InitFlag": 0, + "NickName": "", + "Province": "", + "Sex": 0, + "Signature": "" +} +``` + +#### 4.13.11 `POST /user/ResetGender` + +- 接口说明：重置性别 +- 对应套餐：**定制版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.13.12 `POST /user/SetAdminKeyword` + +- 接口说明：设置管理员关键词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetAdminKeywordModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.13 `POST /user/SetFunctionSwitch` + +- 接口说明：设置添加我的方式 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `WxFunctionSwitchModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Function` | `integer` | 否 | 待补充 | +| `Value` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Function": 0, + "Value": 0 +} +``` + +#### 4.13.14 `POST /user/SetInviteKeyword` + +- 接口说明：设置关键词邀请入群配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetInviteKeywordModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.15 `POST /user/SetKeywordReply` + +- 接口说明：设置关键词自动回复 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetKeywordReplyModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.16 `POST /user/SetKickKeyword` + +- 接口说明：设置踢人关键词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetKickKeywordModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.17 `POST /user/SetNickName` + +- 接口说明：设置昵称 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateNickNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Scene` | `integer` | 否 | 待补充 | +| `Val` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Scene": 0, + "Val": "" +} +``` + +#### 4.13.18 `POST /user/SetProxy` + +- 接口说明：修改Socks5代理 socks5://username:password@ipv4: +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` +- 代理说明：**涉及代理，请使用可用代理，格式 `socks5://username:password@ip:port`；异地 IP 建议配置代理**。 + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetLoginQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Check` | `boolean` | 否 | 修改代理时(SetProxy接口) 是否发送检测代理请求(可能导致请求超时) | +| `IpadOrmac` | `string` | 否 | 待补充 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | + +**请求体代码示例** + +```json +{ + "Check": "false", + "IpadOrmac": "", + "Proxy": "" +} +``` + +#### 4.13.19 `POST /user/SetSendPat` + +- 接口说明：设置拍一拍名称 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetSendPatModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Value` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Value": "" +} +``` + +#### 4.13.20 `POST /user/SetSexDq` + +- 接口说明：修改性别 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateSexModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `City` | `string` | 否 | 待补充 | +| `Country` | `string` | 否 | 待补充 | +| `Province` | `string` | 否 | 待补充 | +| `Sex` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "City": "", + "Country": "", + "Province": "", + "Sex": 0 +} +``` + +#### 4.13.21 `POST /user/SetSignature` + +- 接口说明：修改签名 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateNickNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Scene` | `integer` | 否 | 待补充 | +| `Val` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Scene": 0, + "Val": "" +} +``` + +#### 4.13.22 `POST /user/SetWechat` + +- 接口说明：设置微信号 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `AlisaModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Alisa` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Alisa": "" +} +``` + +#### 4.13.23 `POST /user/SetWelcome` + +- 接口说明：设置欢迎词配置 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetWelcomeModel` + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +```json +{} +``` + +#### 4.13.24 `POST /user/UpdateAutoPass` + +- 接口说明：修改加好友需要验证属性 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateAutopassModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `SwitchType` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "SwitchType": 0 +} +``` + +#### 4.13.25 `POST /user/UpdateNickName` + +- 接口说明：修改名称 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateNickNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Scene` | `integer` | 否 | 待补充 | +| `Val` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Scene": 0, + "Val": "" +} +``` + +#### 4.13.26 `POST /user/UploadHeadImage` + +- 接口说明：上传头像 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UploadHeadImageModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Base64` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Base64": "" +} +``` + + +### 4.14 登录 + +- 套餐分布：初级版 5，高级版 0，定制版 4，白标/OEM 0 + +#### 4.14.1 `POST /login/A16Login` + +- 接口说明：数据登录 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DeviceIdLoginModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DeviceInfo` | `object` | 否 | 设备信息 | +| `LoginData` | `string` | 否 | 62 数据/A16 数据 | +| `Password` | `string` | 否 | 微信密码 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | +| `Ticket` | `string` | 否 | SMS短信验证码 | +| `Type` | `integer` | 否 | 待补充 | +| `UserName` | `string` | 否 | 手机号 | + +**请求体代码示例** + +```json +{ + "DeviceInfo": { + "AndroidId": "", + "ImeI": "", + "Manufacturer": "", + "Model": "" + }, + "LoginData": "", + "Password": "", + "Proxy": "", + "Ticket": "", + "Type": 0, + "UserName": "" +} +``` + +#### 4.14.2 `GET /login/CheckLoginStatus` + +- 接口说明：检测扫码状态 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.14.3 `POST /login/DeviceLogin` + +- 接口说明：62账号密码登录 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DeviceIdLoginModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DeviceInfo` | `object` | 否 | 设备信息 | +| `LoginData` | `string` | 否 | 62 数据/A16 数据 | +| `Password` | `string` | 否 | 微信密码 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | +| `Ticket` | `string` | 否 | SMS短信验证码 | +| `Type` | `integer` | 否 | 待补充 | +| `UserName` | `string` | 否 | 手机号 | + +**请求体代码示例** + +```json +{ + "DeviceInfo": { + "AndroidId": "", + "ImeI": "", + "Manufacturer": "", + "Model": "" + }, + "LoginData": "", + "Password": "", + "Proxy": "", + "Ticket": "", + "Type": 0, + "UserName": "" +} +``` + +#### 4.14.4 `POST /login/GetLoginQrCodeNewDirect` + +- 接口说明：获取登录二维码-直登(异地IP必须用代理! socks5://username:password@ipv4:port) +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` +- 代理说明：**涉及代理，请使用可用代理，格式 `socks5://username:password@ip:port`；异地 IP 建议配置代理**。 + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetLoginQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Check` | `boolean` | 否 | 修改代理时(SetProxy接口) 是否发送检测代理请求(可能导致请求超时) | +| `IpadOrmac` | `string` | 否 | 待补充 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | + +**请求体代码示例** + +```json +{ + "Check": "false", + "IpadOrmac": "", + "Proxy": "" +} +``` + +#### 4.14.5 `GET /login/GetLoginStatus` + +- 接口说明：获取在线状态 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.14.6 `GET /login/LogOut` + +- 接口说明：退出登录 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.14.7 `POST /login/VerifyCode` + +- 接口说明：验证码验证(输入iPad登录验证码) +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `VerifyCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `code` | `string` | 否 | 验证码 | +| `data62` | `string` | 否 | 验证码 | +| `ticket` | `string` | 否 | 验证码 | + +**请求体代码示例** + +```json +{ + "code": "", + "data62": "", + "ticket": "" +} +``` + +#### 4.14.8 `POST /login/VerifyCodeSlide` + +- 接口说明：过mac滑块验证 +- 对应套餐：**定制版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SlideTicketModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `data62` | `string` | 否 | 验证码 | +| `randstr` | `object` | 否 | 待补充 | +| `slideticket` | `string` | 否 | 待补充 | +| `ticket` | `string` | 否 | 验证码 | + +**请求体代码示例** + +```json +{ + "data62": "", + "randstr": {}, + "slideticket": "", + "ticket": "" +} +``` + +#### 4.14.9 `POST /login/WakeUpLogin` + +- 接口说明：唤醒登录(只限扫码登录) +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetLoginQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Check` | `boolean` | 否 | 修改代理时(SetProxy接口) 是否发送检测代理请求(可能导致请求超时) | +| `IpadOrmac` | `string` | 否 | 待补充 | +| `Proxy` | `string` | 否 | socks代理，例如：socks5://username:password@ipv4:port | + +**请求体代码示例** + +```json +{ + "Check": "false", + "IpadOrmac": "", + "Proxy": "" +} +``` + + +### 4.15 管理/授权 + +- 套餐分布：初级版 0，高级版 0，定制版 0，白标/OEM 9 + +#### 4.15.1 `POST /admin/DelayAuthKey` + +- 接口说明：授权码延期 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DelayAuthKeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Days` | `integer` | 否 | AuthKey 的延期天数; Days 小于1默认设置为30 | +| `ExpiryDate` | `string` | 否 | AuthKey 的到期日期(例如: 2024-01-01); 与 Days 参数只能选其一(优先使用 ExpiryDate 参数) | +| `Key` | `string` | 否 | 要延期的 AuthKey | + +**请求体代码示例** + +```json +{ + "Days": "30", + "ExpiryDate": "", + "Key": "" +} +``` + +#### 4.15.2 `POST /admin/DeleteAuthKey` + +- 接口说明：删除授权码 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DeleteAuthKeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Key` | `string` | 否 | 要删除的 AuthKey | +| `Opt` | `integer` | 否 | 删除操作 0:仅删除授权码 1:删除授权码相关的所有数据 | + +**请求体代码示例** + +```json +{ + "Key": "", + "Opt": 0 +} +``` + +#### 4.15.3 `POST /admin/DisableAuthKey` + +- 接口说明：禁用授权码 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `BannedAuthKeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `IsBanned` | `integer` | 否 | isBanned 1 禁用 默认设置为0 | +| `Key` | `string` | 否 | 要禁用的 AuthKey | + +**请求体代码示例** + +```json +{ + "IsBanned": "0", + "Key": "" +} +``` + +#### 4.15.4 `POST /admin/GenAuthKey1` + +- 接口说明：生成授权码(新设备) +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GenAuthKeyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Count` | `integer` | 否 | 要生成 AuthKey 的个数; Count小于1默认设置为1 | +| `Days` | `integer` | 否 | AuthKey 的过期天数; Days小于1默认设置为30 | + +**请求体代码示例** + +```json +{ + "Count": "1", + "Days": "30" +} +``` + +#### 4.15.5 `GET /admin/GenAuthKey2` + +- 接口说明：生成授权码(新设备) +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.15.6 `POST /admin/GenAuthKey3` + +- 接口说明：生成授权码(1-日 7-周 30-月 90-季 180-半年 365-年 30000-永久)此key不使用无过期时间 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GenAuthKeyTypeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Count` | `integer` | 否 | 要生成 AuthKey 的个数; Count小于1默认设置为1 | +| `Type` | `integer` | 否 | 类型 1日 7 周 30月 90季 180 半年 365年 30000永久（数字为标识，非准确天数） | + +**请求体代码示例** + +```json +{ + "Count": "1", + "Type": "1" +} +``` + +#### 4.15.7 `GET /admin/GetActiveLicenseKeys` + +- 接口说明：查询所有激活状态的卡密 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.15.8 `GET /admin/GetProxyMappingList` + +- 接口说明：获取代理映射列表 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` +- 代理说明：**涉及代理，请使用可用代理，格式 `socks5://username:password@ip:port`；异地 IP 建议配置代理**。 + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.15.9 `GET /admin/HttpSyncLicenseKey` + +- 接口说明：同步卡密激活状态, HTTP-轮询方式 +- 对应套餐：**白标/OEM** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + + +### 4.16 群管理 + +- 套餐分布：初级版 11，高级版 9，定制版 0，白标/OEM 0 + +#### 4.16.1 `POST /group/AddChatRoomMembers` + +- 接口说明：添加群成员 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `InviteChatroomMembersModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.2 `POST /group/AddChatroomAdmin` + +- 接口说明：添加群管理员 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatroomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.3 `POST /group/CreateChatRoom` + +- 接口说明：创建群请求 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `CreateChatRoomModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `TopIc` | `string` | 否 | 待补充 | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "TopIc": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.4 `POST /group/DelChatroomAdmin` + +- 接口说明：删除群管理员 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatroomMemberModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.5 `POST /group/GetChatRoomInfo` + +- 接口说明：获取群详情 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatRoomWxIdListModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomWxIdList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomWxIdList": [ + "string" + ] +} +``` + +#### 4.16.6 `POST /group/GetChatroomMemberDetail` + +- 接口说明：获取群成员详细 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetChatroomMemberDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "" +} +``` + +#### 4.16.7 `POST /group/GetChatroomQrCode` + +- 接口说明：获取群二维码 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetChatroomQrCodeModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "" +} +``` + +#### 4.16.8 `POST /group/InviteChatroomMembers` + +- 接口说明：邀请群成员 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `InviteChatroomMembersModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.9 `POST /group/MoveToContract` + +- 接口说明：获取群聊 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `MoveContractModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Val` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Val": 0 +} +``` + +#### 4.16.10 `POST /group/QuitChatroom` + +- 接口说明：退出群聊 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetChatroomMemberDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "" +} +``` + +#### 4.16.11 `POST /group/ScanIntoUrlGroup` + +- 接口说明：扫码入群 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ScanIntoUrlGroupModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + +#### 4.16.12 `POST /group/SendDelDelChatRoomMember` + +- 接口说明：删除群成员 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `InviteChatroomMembersModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `UserList` | `array` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "UserList": [ + "string" + ] +} +``` + +#### 4.16.13 `POST /group/SendPat` + +- 接口说明：群拍一拍功能 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SendPatModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Scene` | `integer` | 否 | 待补充 | +| `ToUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Scene": 0, + "ToUserName": "" +} +``` + +#### 4.16.14 `POST /group/SendTransferGroupOwner` + +- 接口说明：转让群 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `TransferGroupOwnerModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `NewOwnerUserName` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "NewOwnerUserName": "" +} +``` + +#### 4.16.15 `POST /group/SetChatroomAccessVerify` + +- 接口说明：设置群聊邀请开关 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `SetChatroomAccessVerifyModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Enable` | `boolean` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Enable": false +} +``` + +#### 4.16.16 `POST /group/SetChatroomAnnouncement` + +- 接口说明：设置群公告 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `UpdateChatroomAnnouncementModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Content` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Content": "" +} +``` + +#### 4.16.17 `POST /group/SetChatroomName` + +- 接口说明：设置群昵称 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatroomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Nickname` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Nickname": "" +} +``` + +#### 4.16.18 `POST /group/SetGetChatRoomInfoDetail` + +- 接口说明：获取群公告 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `GetChatroomMemberDetailModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "" +} +``` + +#### 4.16.19 `POST /group/SetGroupNickname` + +- 接口说明：设置我在本群的昵称 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChatroomNameModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `ChatRoomName` | `string` | 否 | 群聊ID：xxx@chatroom | +| `Nickname` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "ChatRoomName": "", + "Nickname": "" +} +``` + +#### 4.16.20 `POST /group/ToJoinGroup` + +- 接口说明：同意入群 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ConsentToJoinGroupModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Url` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Url": "" +} +``` + + +### 4.17 视频号 + +- 套餐分布：初级版 0，高级版 4，定制版 0，白标/OEM 0 + +#### 4.17.1 `POST /finder/ChannelsLogin` + +- 接口说明：视频号助手扫码登录 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `ChannelsLoginModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `finderUsername` | `string` | 否 | 指定要登录的视频号用户名，为空则选择第一个 | +| `url` | `string` | 否 | 视频号助手扫码登录确认链接 | + +**请求体代码示例** + +```json +{ + "finderUsername": "", + "url": "" +} +``` + +#### 4.17.2 `POST /finder/FinderFollow` + +- 接口说明：关注取消 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FinderFollowModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Cook` | `string` | 否 | 待补充 | +| `FinderUserName` | `string` | 否 | 待补充 | +| `OpType` | `integer` | 否 | 待补充 | +| `PosterUsername` | `string` | 否 | 待补充 | +| `RefObjectId` | `string` | 否 | 待补充 | +| `Userver` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Cook": "", + "FinderUserName": "", + "OpType": 0, + "PosterUsername": "", + "RefObjectId": "", + "Userver": 0 +} +``` + +#### 4.17.3 `POST /finder/FinderSearch` + +- 接口说明：视频号搜索 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FinderSearchModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Index` | `integer` | 否 | 待补充 | +| `UserKey` | `string` | 否 | 待补充 | +| `Userver` | `integer` | 否 | 待补充 | +| `Uuid` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Index": 0, + "UserKey": "", + "Userver": 0, + "Uuid": "" +} +``` + +#### 4.17.4 `POST /finder/FinderUserPrepare` + +- 接口说明：视频号中心 +- 对应套餐：**高级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `FinderUserPrepareModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `Userver` | `integer` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "Userver": 0 +} +``` + + +### 4.18 设备 + +- 套餐分布：初级版 4，高级版 0，定制版 0，白标/OEM 0 + +#### 4.18.1 `POST /equipment/DelSafeDevice` + +- 接口说明：删除安全设备 +- 对应套餐：**初级版** +- 请求 Content-Type：`application/json` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | +| `body` | `body` | `object` | 是 | 请求参数 | + +**请求体模型** + +- `DelSafeDeviceModel` + +**字段级说明** + +| 字段名 | 类型 | Required | 字段说明 | +|---|---|---|---| +| `DeviceUUID` | `string` | 否 | 待补充 | + +**请求体代码示例** + +```json +{ + "DeviceUUID": "" +} +``` + +#### 4.18.2 `GET /equipment/GetBoundHardDevice` + +- 接口说明：获取硬件设备情况 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.18.3 `GET /equipment/GetOnlineInfo` + +- 接口说明：获取在线设备信息 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 + +#### 4.18.4 `POST /equipment/GetSafetyInfo` + +- 接口说明：获取安全设备列表 +- 对应套餐：**初级版** +- 请求 Content-Type：`-` +- 响应 Content-Type：`application/json` +- 响应状态码：`200` + +**请求参数** + +| 参数名 | 位置 | 类型 | Required | 参数说明 | +|---|---|---|---|---| +| `key` | `query` | `string` | 是 | 账号唯一标识 | + +**请求体模型** + +- 无 + +**字段级说明** + +- 无请求体字段 + +**请求体代码示例** + +- 无 diff --git a/admin/src/api/subscription/user_server.js b/admin/src/api/subscription/user_server.js index b00411b..bc31eac 100644 --- a/admin/src/api/subscription/user_server.js +++ b/admin/src/api/subscription/user_server.js @@ -19,10 +19,19 @@ class UserServer { return window.framework.http.get(`/biz_user/detail?id=${encodeURIComponent(id)}`, {}); } + /** 下拉：全部业务用户（与 GET /biz_user/all 对应） */ + async all() { + return window.framework.http.get('/biz_user/all', {}); + } + async disable(row) { return window.framework.http.post("/biz_user/disable", row); } + async enable(row) { + return window.framework.http.post("/biz_user/enable", row); + } + async exportRows(row) { return window.framework.http.post("/biz_user/export", row); } diff --git a/admin/src/mixins/subscriptionRelations.js b/admin/src/mixins/subscriptionRelations.js new file mode 100644 index 0000000..3d728de --- /dev/null +++ b/admin/src/mixins/subscriptionRelations.js @@ -0,0 +1,45 @@ +import userServer from '@/api/subscription/user_server.js' +import planServer from '@/api/subscription/plan_server.js' + +/** + * 业务用户 / 套餐关联下拉：依赖后端 GET /biz_user/all、GET /biz_plan/all + */ +export default { + data() { + return { + bizUserOptions: [], + bizPlanOptions: [], + } + }, + methods: { + async loadBizRelationOptions() { + try { + const [u, p] = await Promise.all([userServer.all(), planServer.all()]) + if (u && u.code === 0) { + this.bizUserOptions = Array.isArray(u.data) ? u.data : [] + } else { + this.bizUserOptions = [] + } + if (p && p.code === 0) { + this.bizPlanOptions = Array.isArray(p.data) ? p.data : [] + } else { + this.bizPlanOptions = [] + } + } catch (e) { + this.bizUserOptions = [] + this.bizPlanOptions = [] + } + }, + bizUserLabel(row) { + if (!row || row.id == null) return '' + const name = row.name || '' + const mobile = row.mobile ? ` ${row.mobile}` : '' + return `#${row.id} ${name}${mobile}`.trim() + }, + bizPlanLabel(row) { + if (!row || row.id == null) return '' + const name = row.plan_name || row.plan_code || '' + return `#${row.id} ${name}`.trim() + }, + }, +} diff --git a/admin/src/views/subscription/subscriptions.vue b/admin/src/views/subscription/subscriptions.vue index 5c5db79..a645ad0 100644 --- a/admin/src/views/subscription/subscriptions.vue +++ b/admin/src/views/subscription/subscriptions.vue @@ -6,15 +6,27 @@
- - - - - + + + + + + + @@ -26,21 +38,23 @@
- +
- - + + + + + + @@ -73,7 +87,11 @@ - + + + @@ -84,9 +102,11 @@