tt/docs/swagger.yaml
2024-05-28 08:47:31 +08:00

5391 lines
129 KiB
YAML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

definitions:
api.CommonStringResponse:
properties:
code:
type: integer
data:
type: string
msg:
type: string
type: object
core.AcceptFriendRequest:
properties:
encryptusername:
type: string
scene:
type: integer
ticket:
type: string
type: object
core.AddFriendRequest:
properties:
remark:
type: string
room_wxid:
type: string
source_type:
type: integer
wxid:
type: string
type: object
core.AddSearchWxUserRequest:
properties:
remark:
type: string
v1:
type: string
v2:
type: string
type: object
core.AddTagRequest:
properties:
label_name:
type: string
type: object
core.AddTagResponseData:
properties:
label_id:
type: integer
label_name:
type: string
type: object
core.AddTagToUserRequest:
properties:
labelid_list:
type: string
wxid:
type: string
type: object
core.AddTagToUserResponseData:
properties:
baseResponse:
properties:
errMsg:
properties:
string:
type: string
type: object
ret:
type: integer
type: object
type: object
core.AutoAcceptAddFriendRequest:
properties:
auto:
description: 1自动同意 0取消自动同意
type: integer
type: object
core.AutoAcceptCardRequest:
properties:
auto:
description: 1自动接收 0取消自动接收
type: integer
type: object
core.AutoAcceptRoomRequest:
properties:
auto:
description: 0不自动 1自动
type: integer
type: object
core.AutoAcceptWCPayRequest:
properties:
auto:
description: 1自动接收 0取消自动接收
type: integer
type: object
core.CDNDownloadRequest:
properties:
aes_key:
type: string
file_id:
type: string
file_type:
type: integer
save_path:
type: string
type: object
core.CDNDownloadResponseData:
properties:
error_code:
type: integer
file_id:
type: string
file_size:
type: integer
save_path:
type: string
type: object
core.CDNInitialResponseData:
properties:
status:
type: integer
type: object
core.CDNSendCardLinkMsgRequest:
properties:
desc:
type: string
image_url:
type: string
title:
type: string
to_wxid:
type: string
url:
type: string
type: object
core.CDNSendCardLinkMsgResponseData:
properties:
actionFlag:
type: integer
aeskey:
type: string
appId:
type: string
baseResponse:
properties:
errMsg:
type: object
ret:
type: integer
type: object
clientMsgId:
type: string
createTime:
type: integer
fromUserName:
type: string
msgId:
type: integer
msgSource:
type: string
newMsgId:
type: string
toUserName:
type: string
type:
type: integer
type: object
core.CDNSendCardMsgRequest:
properties:
avatar:
type: string
nickname:
type: string
to_wxid:
type: string
username:
type: string
type: object
core.CDNSendCardMsgResponseData:
properties:
baseResponse:
properties:
ret:
type: integer
type: object
count:
type: integer
msgResponseList:
items:
properties:
clientMsgId:
type: integer
createTime:
type: integer
msgId:
type: integer
newMsgId:
type: string
ret:
type: integer
serverTime:
type: integer
toUserName:
properties:
string:
type: string
type: object
type:
type: integer
type: object
type: array
type: object
core.CDNSendFileMsgRequest:
properties:
aes_key:
type: string
file_id:
type: string
file_md5:
type: string
file_name:
type: string
file_size:
type: integer
to_wxid:
type: string
type: object
core.CDNSendFileMsgResponseData:
properties:
actionFlag:
type: integer
aeskey:
type: string
appId:
type: string
baseResponse:
properties:
ret:
type: integer
type: object
clientMsgId:
type: string
createTime:
type: integer
fromUserName:
type: string
msgId:
type: integer
msgSource:
type: string
newMsgId:
type: string
toUserName:
type: string
type:
type: integer
type: object
core.CDNSendGifMsgNewRequest:
properties:
path:
type: string
to_wxid:
type: string
type: object
core.CDNSendGifMsgNewResponseData:
properties:
md5:
type: string
size:
type: integer
to_wxid:
type: string
type: object
core.CDNSendGifMsgRequest:
properties:
aes_key:
type: string
file_id:
type: string
file_md5:
type: string
file_size:
type: integer
to_wxid:
type: string
type: object
core.CDNSendGifMsgResponseData:
properties:
actionFlag:
type: integer
aeskey:
type: string
appId:
type: string
baseResponse:
properties:
ret:
type: integer
type: object
clientMsgId:
type: string
createTime:
type: integer
fromUserName:
type: string
msgId:
type: integer
msgSource:
type: string
newMsgId:
type: string
toUserName:
type: string
type:
type: integer
type: object
core.CDNSendImageMsgRequest:
properties:
aes_key:
type: string
crc32:
type: integer
file_id:
type: string
file_md5:
type: string
file_size:
type: integer
thumb_file_size:
type: integer
to_wxid:
type: string
type: object
core.CDNSendImageMsgResponseData:
properties:
aes_key:
type: string
crc32:
type: integer
file_id:
type: string
file_md5:
type: string
file_size:
type: integer
thumb_file_size:
type: integer
to_wxid:
type: string
type: object
core.CDNSendLocationMsgRequest:
properties:
address:
type: string
latitude:
type: number
longitude:
type: number
title:
type: string
to_wxid:
type: string
type: object
core.CDNSendLocationMsgResponseData:
properties:
baseResponse:
properties:
ret:
type: integer
type: object
count:
type: integer
msgResponseList:
items:
properties:
clientMsgId:
type: integer
createTime:
type: integer
msgId:
type: integer
newMsgId:
type: string
ret:
type: integer
serverTime:
type: integer
toUserName:
properties:
string:
type: string
type: object
type:
type: integer
type: object
type: array
type: object
core.CDNSendMiniProgramMsgRequest:
properties:
aes_key:
type: string
appicon:
type: string
appid:
type: string
appname:
type: string
file_id:
type: string
file_md5:
type: string
file_size:
type: integer
page_path:
type: string
title:
type: string
to_wxid:
type: string
username:
type: string
type: object
core.CDNSendMiniProgramMsgResponseData:
properties:
actionFlag:
type: integer
aeskey:
type: string
appId:
type: string
baseResponse:
properties:
ret:
type: integer
type: object
clientMsgId:
type: string
createTime:
type: integer
fromUserName:
type: string
msgId:
type: integer
msgSource:
type: string
newMsgId:
type: string
toUserName:
type: string
type:
type: integer
type: object
core.CDNSendRevokeMsgRequest:
properties:
client_msgid: {}
create_time:
type: integer
new_msgid:
type: string
to_wxid:
type: string
type: object
core.CDNSendRevokeMsgResponseData:
properties:
baseResponse:
properties:
ret:
type: integer
type: object
introduction:
type: string
sysWording:
type: string
type: object
core.CDNSendTextMsgRequest:
properties:
at_all:
description: 群消息时候1是at所有人
type: integer
at_list:
description: 群消息时候使用
items:
type: string
type: array
content:
type: string
to_wxid:
type: string
type: object
core.CDNSendTextMsgResponseData:
properties:
baseResponse:
properties:
ret:
type: integer
type: object
count:
type: integer
msgResponseList:
items:
properties:
clientMsgId:
type: integer
createTime:
type: integer
msgId:
type: integer
newMsgId:
type: string
ret:
type: integer
serverTime:
type: integer
toUserName:
properties:
string:
type: string
type: object
type:
type: integer
type: object
type: array
type: object
core.CDNSendVideoMomentMsgRequest:
properties:
avatar:
type: string
desc:
type: string
nickname:
type: string
object_id:
type: string
object_nonce_id:
type: string
thumb_url:
type: string
to_wxid:
type: string
url:
type: string
username:
type: string
type: object
core.CDNSendVideoMomentMsgResponseData:
properties:
actionFlag:
type: integer
aeskey:
type: string
appId:
type: string
baseResponse:
properties:
ret:
type: integer
type: object
clientMsgId:
type: string
createTime:
type: integer
fromUserName:
type: string
msgId:
type: integer
msgSource:
type: string
newMsgId:
type: string
toUserName:
type: string
type:
type: integer
type: object
core.CDNSendVideoMsgRequest:
properties:
aes_key:
type: string
file_id:
type: string
file_md5:
type: string
file_size:
type: integer
thumb_file_size:
type: integer
to_wxid:
type: string
type: object
core.CDNSendVideoMsgResponseData:
properties:
actionFlag:
type: integer
aeskey:
type: string
baseResponse:
properties:
ret:
type: integer
type: object
clientMsgId:
type: string
msgId:
type: integer
msgSource:
type: string
newMsgId:
type: string
rawAeskey:
type: string
rawVideoNeedReupload:
type: boolean
thumbStartPos:
type: integer
videoNeedReupload:
type: boolean
videoStartPos:
type: integer
type: object
core.CDNSendXmlMsgRequest:
properties:
content:
description: '"<appmsg appid=\"wx6618f1cfc6c132f8\" sdkver=\"0\"><title>1658934822522.gif<...
...</weappinfo><websearch /></appmsg>",'
type: string
to_wxid:
type: string
type: object
core.CDNSendXmlMsgResponseData:
properties:
actionFlag:
type: integer
aeskey:
type: string
appId:
type: string
baseResponse:
properties:
ret:
type: integer
type: object
clientMsgId:
type: string
createTime:
type: integer
fromUserName:
type: string
msgId:
type: integer
msgSource:
type: string
newMsgId:
type: string
toUserName:
type: string
type:
type: integer
type: object
core.CDNUploadRequest:
properties:
file_path:
type: string
file_type:
type: integer
type: object
core.CDNUploadResponseData:
properties:
aes_key:
type: string
crc32:
type: integer
error_code:
type: integer
file_id:
type: string
file_key:
type: string
file_md5:
type: string
file_path:
type: string
file_size:
type: integer
thumb_file_md5:
type: string
thumb_file_size:
type: integer
type: object
core.ChatMsgNotNotifyRequest:
properties:
status:
description: 1开启 0关闭
type: integer
wxid:
type: string
type: object
core.ChatSessionTopRequest:
properties:
status:
type: integer
wxid:
type: string
type: object
core.CommentMomentRequest:
properties:
content:
type: string
object_id:
type: string
type: object
core.CommentMomentResponseData:
properties:
baseResponse:
properties:
errMsg:
type: object
ret:
type: integer
type: object
snsObject:
properties:
blackList:
items: {}
type: array
blackListCount:
type: integer
commentCount:
type: integer
commentUserList:
items:
properties:
commentFlag:
type: integer
commentId:
type: integer
commentId2:
type: string
content:
type: string
createTime:
type: integer
deleteFlag:
type: integer
isNotRichText:
type: integer
nickname:
type: string
replyCommentId:
type: integer
replyCommentId2:
type: string
replyUsername:
type: string
source:
type: integer
type:
type: integer
username:
type: string
type: object
type: array
commentUserListCount:
type: integer
createTime:
type: integer
deleteFlag:
type: integer
extFlag:
type: integer
groupCount:
type: integer
groupList:
items: {}
type: array
groupUser:
items: {}
type: array
groupUserCount:
type: integer
id:
type: string
isNotRichText:
type: integer
likeCount:
type: integer
likeFlag:
type: integer
likeUserList:
items:
properties:
commentFlag:
type: integer
commentId:
type: integer
commentId2:
type: string
content:
type: string
createTime:
type: integer
deleteFlag:
type: integer
isNotRichText:
type: integer
nickname:
type: string
replyCommentId:
type: integer
replyCommentId2:
type: string
replyUsername:
type: string
source:
type: integer
type:
type: integer
username:
type: string
type: object
type: array
likeUserListCount:
type: integer
nickname:
type: string
noChange:
type: integer
objectDesc:
properties:
buffer:
type: string
iLen:
type: integer
type: object
objectOperations:
properties:
buffer:
type: string
iLen:
type: integer
type: object
preDownloadInfo:
properties:
noPreDownloadRange:
type: string
preDownloadNetType:
type: integer
preDownloadPercent:
type: integer
type: object
referId:
type: string
referUsername:
type: string
snsRedEnvelops:
properties:
reportId:
type: integer
reportKey:
type: integer
resourceId:
type: integer
rewardCount:
type: integer
rewardUserList:
items: {}
type: array
type: object
username:
type: string
weAppInfo:
properties:
appId:
type: integer
mapPoiId:
type: string
redirectUrl:
type: string
score:
type: integer
showType:
type: integer
userName:
type: string
type: object
withUserCount:
type: integer
withUserList:
items: {}
type: array
withUserListCount:
type: integer
type: object
type: object
core.CreateChatRoomByProtocolResponseData:
properties:
baseResponse:
properties:
errMsg:
properties:
string:
type: string
type: object
ret:
type: integer
type: object
bigHeadImgUrl:
type: string
chatRoomName:
properties:
string:
type: string
type: object
imgBuf:
properties:
buffer:
type: string
iLen:
type: integer
type: object
memberCount:
type: integer
memberList:
items:
properties:
city:
type: string
contactType:
type: integer
country:
type: string
memberName:
properties:
string:
type: string
type: object
memberStatus:
type: integer
nickName:
properties:
string:
type: string
type: object
personalCard:
type: integer
province:
type: string
pyInitial:
properties:
string:
type: string
type: object
quanPin:
properties:
string:
type: string
type: object
remark:
type: object
remarkPYInitial:
type: object
remarkQuanPin:
type: object
sex:
type: integer
signature:
type: string
verifyFlag:
type: integer
verifyInfo:
type: string
type: object
type: array
pyInitial:
type: object
quanPin:
type: object
smallHeadImgUrl:
type: string
topic:
type: object
type: object
core.CreateRoomRequest:
properties:
wxids:
items:
type: string
type: array
type: object
core.DecryptImgRequest:
properties:
dest_file:
type: string
src_file:
type: string
type: object
core.DelChatRoomMemberRequest:
properties:
member_list:
items:
type: string
type: array
room_wxid:
type: string
type: object
core.DelChatRoomRequest:
properties:
room_wxid:
type: string
type: object
core.DeleteTagRequest:
properties:
label_id:
type: integer
type: object
core.DeleteTagResponseData:
properties:
baseResponse:
properties:
errMsg:
type: object
ret:
type: integer
type: object
type: object
core.EditChatRoomMemberRequest:
properties:
name:
type: string
room_wxid:
type: string
type: object
core.EditChatRoomNoticeRequest:
properties:
notice:
type: string
room_wxid:
type: string
type: object
core.EditFriendRemarkRequest:
properties:
remark:
type: string
wxid:
type: string
type: object
core.EditRoomMineNickNameRequest:
properties:
nickname:
type: string
room_wxid:
type: string
type: object
core.ForwardMsgRequest:
properties:
msgid:
type: string
to_wxid:
type: string
type: object
core.GetA8KeyRequest:
properties:
scene:
type: integer
url:
type: string
type: object
core.GetA8KeyResponseData:
properties:
a8Key:
type: string
actionCode:
type: integer
antispamTicket:
type: string
baseResponse:
properties:
errMsg:
type: object
ret:
type: integer
type: object
content:
type: string
cookie:
properties:
buffer:
type: string
iLen:
type: integer
type: object
deepLinkBitSet:
properties:
bitValue:
type: string
type: object
fullUrl:
type: string
generalControlBitSet:
properties:
bitValue:
type: integer
type: object
headImg:
type: string
httpHeaderCount:
type: integer
httpHeaderList:
items:
properties:
key:
type: string
value:
type: string
type: object
type: array
jsapicontrolBytes:
properties:
buffer:
type: string
iLen:
type: integer
type: object
jsapipermission:
properties:
bitValue:
type: integer
bitValue2:
type: integer
bitValue3:
type: integer
bitValue4:
type: integer
type: object
menuWording:
type: string
mid:
type: string
scopeCount:
type: integer
scopeList:
items: {}
type: array
shareUrl:
type: string
ssid:
type: string
title:
type: string
userName:
type: string
wording:
type: string
type: object
core.GetChatRoomListResponseDataItem:
properties:
avatar:
type: string
is_manager:
type: integer
manager_wxid:
type: string
member_list:
items:
type: string
type: array
nickname:
type: string
remark:
type: string
total_member:
type: integer
wxid:
type: string
type: object
core.GetChatRoomMemberListResponseData:
properties:
extend:
type: string
group_wxid:
type: string
member_list:
items:
properties:
account:
type: string
avatar:
type: string
city:
type: string
country:
type: string
display_name:
type: string
nickname:
type: string
province:
type: string
remark:
type: string
sex:
type: integer
wxid:
type: string
type: object
type: array
total:
type: integer
type: object
core.GetCollectListResponseData:
properties:
items:
items:
properties:
from_user:
type: string
local_id:
type: integer
room_member:
type: string
title:
type: string
type:
type: integer
update_time:
type: integer
xml:
type: string
type: object
type: array
status:
type: integer
type: object
core.GetFriendBriefInfoByProtocolResponseData:
properties:
account:
type: string
avatar:
type: string
city:
type: string
country:
type: string
nickname:
type: string
province:
type: string
remark:
type: string
sex:
type: integer
signature:
type: string
small_avatar:
type: string
sns_pic:
type: string
source_type:
type: integer
status:
type: integer
v1:
type: string
v2:
type: string
wxid:
type: string
type: object
core.GetFriendDetailInfoByProtocolResponseDataContactListItem:
properties:
addContactScene:
type: integer
additionalContactList:
properties:
linkedinContactItem:
type: object
type: object
albumBgImgId:
type: string
albumFlag:
type: integer
albumStyle:
type: integer
alias:
type: string
bigHeadImgUrl:
type: string
bitMask:
type: integer
bitVal:
type: integer
cardImgUrl:
type: string
chatRoomData:
type: string
chatRoomNotify:
type: integer
chatRoomOwner:
type: string
chatroomInfoVersion:
type: integer
chatroomMaxCount:
type: integer
chatroomType:
type: integer
chatroomVersion:
type: integer
city:
type: string
contactType:
type: integer
country:
type: string
customizedInfo:
properties:
brandFlag:
type: integer
brandIconURL:
type: string
brandInfo:
type: string
externalInfo:
type: string
type: object
deleteFlag:
type: integer
description:
type: string
domainList:
type: object
encryptUserName:
type: string
extInfo:
type: string
hasWeiXinHdHeadImg:
type: integer
headImgMd5:
type: string
idcardNum:
type: string
imgBuf:
properties:
buffer:
type: string
iLen:
type: integer
type: object
imgFlag:
type: integer
labelIdList:
type: string
level:
type: integer
mobileFullHash:
type: string
mobileHash:
type: string
myBrandList:
type: string
newChatroomData:
properties:
chatRoomMemberList:
items: {}
type: array
infoMask:
type: integer
memberCount:
type: integer
type: object
nickName:
properties:
string:
type: string
type: object
personalCard:
type: integer
phoneNumListInfo:
properties:
count:
type: integer
phoneNumList:
items: {}
type: array
type: object
province:
type: string
pyInitial:
properties:
string:
type: string
type: object
quanPin:
properties:
string:
type: string
type: object
realName:
type: string
remark:
type: object
remarkPYInitial:
type: object
remarkQuanPin:
type: object
roomInfoCount:
type: integer
roomInfoList:
items: {}
type: array
sex:
type: integer
signature:
type: string
smallHeadImgUrl:
type: string
snsUserInfo:
properties:
snsBgImgId:
type: string
snsBgObjectId:
type: string
snsFlag:
type: integer
snsFlagEx:
type: integer
type: object
source:
type: integer
userName:
properties:
string:
type: string
type: object
verifyContent:
type: string
verifyFlag:
type: integer
verifyInfo:
type: string
weiDianInfo:
type: string
weibo:
type: string
weiboFlag:
type: integer
weiboNickname:
type: string
type: object
core.GetFriendListResponseDateItem:
properties:
account:
description: 微信账号,友情的直接连线
type: string
avatar:
description: 头像的风景画,好友的形象代言
type: string
city:
description: 都市的温馨角落,好友的日常坐标
type: string
country:
description: 国界的另一端,好友的远方故事
type: string
labelid_list:
description: 标签的彩虹桥,连接不同朋友圈的密码
type: string
nickname:
description: 昵称的诗篇,好友的个性签名
type: string
province:
description: 省份的风土人情,好友的地域色彩
type: string
remark:
description: 备注的小秘密,只有你知道的代号
type: string
sex:
description: 性别的罗盘1为蓝海2为红颜
type: integer
wxid:
description: 微信ID好友的唯一坐标
type: string
type: object
core.GetFriendMomentRequest:
properties:
first_page_md5:
type: string
max_id:
type: string
username:
type: string
type: object
core.GetFriendMomentResponseData:
properties:
baseResponse:
properties:
errMsg:
type: object
ret:
type: integer
type: object
continueId:
type: string
firstPageMd5:
type: string
limitedId:
type: string
newRequestTime:
type: integer
objectCount:
type: integer
objectCountForSameMd5:
type: integer
objectList:
items: {}
type: array
objectTotalCount:
type: integer
retTips:
type: string
serverConfig:
properties:
copyAndPasteWordLimit:
type: integer
postMentionLimit:
type: integer
type: object
snsUserInfo:
properties:
snsBgImgId:
type: string
snsBgObjectId:
type: string
snsFlag:
type: integer
snsFlagEx:
type: integer
type: object
type: object
core.GetLoginUserInfoResponseData:
properties:
account:
type: string
avatar:
type: string
nickname:
type: string
phone:
type: string
pid:
type: integer
unread_msg_count:
type: integer
wx_user_dir:
type: string
wxid:
type: string
type: object
core.GetMiniProgramCodeRequest:
properties:
appid:
type: string
type: object
core.GetMiniProgramCodeResponseData:
properties:
appIconUrl:
type: string
appName:
type: string
baseResponse:
properties:
errMsg:
properties:
string:
type: string
type: object
ret:
type: integer
type: object
code:
type: string
jsApiBaseResponse:
properties:
errcode:
type: integer
errmsg:
type: string
type: object
liftSpan:
type: integer
openId:
type: string
scopeList:
items: {}
type: array
sessionKey:
type: string
sessionTicket:
type: string
signature:
type: string
state:
type: string
type: object
core.GetMomentRequest:
properties:
max_id:
type: string
type: object
core.GetPublicUserListResponseData:
properties:
avatar:
type: string
nickname:
type: string
wxid:
type: string
type: object
core.GetRoomMemberInviteListResponseData:
properties:
member_list:
items:
properties:
avatar:
type: string
flag:
type: integer
invite_by:
type: string
nickname:
type: string
wxid:
type: string
type: object
type: array
room_wxid:
type: string
type: object
core.GetTagListByWxidRequest:
properties:
wxid:
type: string
type: object
core.GetTagListByWxidResponseData:
properties:
labelid_list:
type: string
wxid:
type: string
type: object
core.GetTagListResponseDataItem:
properties:
label_id:
type: string
label_name:
type: string
type: object
core.GetWorkWxChatRoomMemberRequest:
properties:
room_wxid:
type: string
type: object
core.GetWorkWxChatRoomMemberResponseData:
properties:
member_list:
items:
properties:
avatar:
type: string
nickname:
type: string
sex:
type: integer
wxid:
type: string
type: object
type: array
room_wxid:
type: string
type: object
core.GetWorkWxRoomListResponseDataItem:
properties:
avatar:
type: string
manager_wxid:
type: string
nickname:
type: string
room_wxid:
type: string
total_member:
type: integer
type: object
core.GetWorkWxUserListResponseDataItem:
properties:
avatar:
type: string
nickname:
type: string
sex:
type: integer
wxid:
type: string
type: object
core.HttpCallBackRequest:
properties:
timeout:
description: 默认5秒
type: integer
url:
type: string
type: object
core.InviteToRoomRequest:
properties:
member_list:
items:
type: string
type: array
room_wxid:
type: string
type: object
core.InviteToRoomResponseData:
properties:
baseResponse:
properties:
errMsg:
properties:
string:
type: string
type: object
ret:
type: integer
type: object
memberCount:
type: integer
memberList:
items:
properties:
city:
type: string
contactType:
type: integer
country:
type: string
memberName:
properties:
string:
type: string
type: object
memberStatus:
type: integer
nickName:
properties:
string:
type: string
type: object
personalCard:
type: integer
province:
type: string
pyInitial:
properties:
string:
type: string
type: object
quanPin:
properties:
string:
type: string
type: object
remark:
type: object
remarkPYInitial:
type: object
remarkQuanPin:
type: object
sex:
type: integer
signature:
type: string
verifyFlag:
type: integer
verifyInfo:
type: string
type: object
type: array
type: object
core.LikeMomentRequest:
properties:
object_id:
type: string
type: object
core.LikeMomentResponseData:
properties:
baseResponse:
properties:
errMsg:
type: object
ret:
type: integer
type: object
snsObject:
properties:
blackList:
items: {}
type: array
blackListCount:
type: integer
commentCount:
type: integer
commentUserList:
items:
properties:
commentFlag:
type: integer
commentId:
type: integer
commentId2:
type: string
content:
type: string
createTime:
type: integer
deleteFlag:
type: integer
isNotRichText:
type: integer
nickname:
type: string
replyCommentId:
type: integer
replyCommentId2:
type: string
replyUsername:
type: string
source:
type: integer
type:
type: integer
username:
type: string
type: object
type: array
commentUserListCount:
type: integer
createTime:
type: integer
deleteFlag:
type: integer
extFlag:
type: integer
groupCount:
type: integer
groupList:
items: {}
type: array
groupUser:
items: {}
type: array
groupUserCount:
type: integer
id:
type: string
isNotRichText:
type: integer
likeCount:
type: integer
likeFlag:
type: integer
likeUserList:
items:
properties:
commentFlag:
type: integer
commentId:
type: integer
commentId2:
type: string
content:
type: string
createTime:
type: integer
deleteFlag:
type: integer
isNotRichText:
type: integer
nickname:
type: string
replyCommentId:
type: integer
replyCommentId2:
type: string
replyUsername:
type: string
source:
type: integer
type:
type: integer
username:
type: string
type: object
type: array
likeUserListCount:
type: integer
nickname:
type: string
noChange:
type: integer
objectDesc:
properties:
buffer:
type: string
iLen:
type: integer
type: object
objectOperations:
properties:
buffer:
type: string
iLen:
type: integer
type: object
preDownloadInfo:
properties:
noPreDownloadRange:
type: string
preDownloadNetType:
type: integer
preDownloadPercent:
type: integer
type: object
referId:
type: string
referUsername:
type: string
snsRedEnvelops:
properties:
reportId:
type: integer
reportKey:
type: integer
resourceId:
type: integer
rewardCount:
type: integer
rewardUserList:
items: {}
type: array
type: object
username:
type: string
weAppInfo:
properties:
appId:
type: integer
mapPoiId:
type: string
redirectUrl:
type: string
score:
type: integer
showType:
type: integer
userName:
type: string
type: object
withUserCount:
type: integer
withUserList:
items: {}
type: array
withUserListCount:
type: integer
type: object
type: object
core.LiveEnterRequest:
properties:
live_id:
type: string
object_id:
type: string
object_nonce_id:
type: string
type: object
core.LiveGetOnlineUserRequest:
properties:
last_buff:
type: string
live_id:
type: string
object_id:
type: string
object_nonce_id:
type: string
type: object
core.LiveGetShelfRequest:
properties:
live_username:
type: string
request_id:
type: string
type: object
core.LiveSendMsgRequest:
properties:
content:
type: string
type: object
core.ModifyTagRequest:
properties:
label_id:
type: integer
label_name:
type: string
type: object
core.RefreshLoginQrCodeResponseData:
properties:
file:
type: string
pid:
type: integer
qrcode:
type: string
type: object
core.RoomShowNickNameRequest:
properties:
room_wxid:
type: string
status:
description: 1显示 0隐藏
type: integer
type: object
core.SaveRoomSaveToContactRequest:
properties:
room_wxid:
type: string
status:
description: 1保存 2移出
type: integer
type: object
core.SearchWxUserResponseData:
properties:
account:
type: string
avatar:
type: string
city:
type: string
country:
type: string
keyword:
type: string
nickname:
type: string
provice:
type: string
search:
type: string
sex:
type: integer
signature:
type: string
small_avatar:
type: string
status:
type: integer
v1:
type: string
v2:
type: string
wxid:
type: string
type: object
core.SendCardMsgRequest:
properties:
card_wxid:
type: string
to_wxid:
type: string
type: object
core.SendCollectMsgByMsgIdRequest:
properties:
msgid:
type: string
type: object
core.SendCollectRequest:
properties:
local_id:
type: integer
to_wxid:
type: string
type: object
core.SendFileMsgRequest:
properties:
file:
type: string
to_wxid:
type: string
type: object
core.SendGifMsgRequest:
properties:
file:
type: string
to_wxid:
type: string
type: object
core.SendImageMsgRequest:
properties:
file:
description: 例如 "C:\\a.jpg"
type: string
to_wxid:
type: string
type: object
core.SendLinkMsgRequest:
properties:
desc:
type: string
image_url:
type: string
title:
type: string
to_wxid:
type: string
url:
type: string
type: object
core.SendMomentRequest:
properties:
object_desc:
type: string
type: object
core.SendMomentResponseData:
properties:
baseResponse:
properties:
errMsg:
type: object
ret:
type: integer
type: object
snsObject:
properties:
blackList:
items: {}
type: array
blackListCount:
type: integer
commentCount:
type: integer
commentUserList:
items: {}
type: array
commentUserListCount:
type: integer
createTime:
type: integer
deleteFlag:
type: integer
extFlag:
type: integer
groupCount:
type: integer
groupList:
items: {}
type: array
groupUser:
items: {}
type: array
groupUserCount:
type: integer
id:
type: string
isNotRichText:
type: integer
likeCount:
type: integer
likeFlag:
type: integer
likeUserList:
items: {}
type: array
likeUserListCount:
type: integer
nickname:
type: string
noChange:
type: integer
objectDesc:
properties:
buffer:
type: string
iLen:
type: integer
type: object
objectOperations:
properties:
buffer:
type: string
iLen:
type: integer
type: object
preDownloadInfo:
properties:
noPreDownloadRange:
type: string
preDownloadNetType:
type: integer
preDownloadPercent:
type: integer
type: object
referId:
type: string
referUsername:
type: string
snsRedEnvelops:
properties:
reportId:
type: integer
reportKey:
type: integer
resourceId:
type: integer
rewardCount:
type: integer
rewardUserList:
items: {}
type: array
type: object
username:
type: string
weAppInfo:
properties:
appId:
type: integer
mapPoiId:
type: string
redirectUrl:
type: string
score:
type: integer
showType:
type: integer
userName:
type: string
type: object
withUserCount:
type: integer
withUserList:
items: {}
type: array
withUserListCount:
type: integer
type: object
spamTips:
type: string
type: object
core.SendTextMsgRequest:
properties:
at_list:
description: 群消息时候使用 "notify@all" @所有人
items:
type: string
type: array
content:
type: string
to_wxid:
type: string
type: object
core.SendVideoMsgRequest:
properties:
file:
type: string
to_wxid:
type: string
type: object
core.SendXmlMsgRequest:
properties:
to_wxid:
type: string
xml:
type: string
type: object
core.SwitchSessionRequest:
properties:
to_wxid:
type: string
type: object
core.UploadMomentImageRequest:
properties:
path:
type: string
type: object
core.UploadMomentImageResponseData:
properties:
baseResponse:
properties:
ret:
type: integer
type: object
bufferUrl:
properties:
type:
type: integer
url:
type: string
type: object
clientId:
type: string
id:
type: integer
startPos:
type: integer
thumbUrlCount:
type: integer
thumbUrls:
items:
properties:
type:
type: integer
url:
type: string
type: object
type: array
totalLen:
type: integer
type:
type: integer
type: object
core.VideoMomentCreateVirtualNickNameRequest:
properties:
headimg_url:
type: string
nickname:
type: string
type: object
core.VideoMomentFollowRequest:
properties:
username:
type: string
type: object
core.VideoMomentFollowResponseData:
properties:
baseResponse:
properties:
errMsg:
properties:
string:
type: string
type: object
ret:
type: integer
type: object
contact:
properties:
archievementInfo:
type: object
authInfo:
properties:
appName:
type: string
authGuarantor:
type: object
authIconType:
type: integer
authIconUrl:
type: string
authProfession:
type: string
authVerifyIdentity:
type: integer
customerType:
type: integer
detailLink:
type: string
realName:
type: string
verifyStatus:
type: integer
type: object
bindInfo:
items: {}
type: array
coverEntranceFlag:
type: integer
coverImgUrl:
type: string
coverUrl:
type: string
extFlag:
type: integer
extInfo:
properties:
birthDay:
type: integer
birthMonth:
type: integer
birthYear:
type: integer
city:
type: string
country:
type: string
province:
type: string
sex:
type: integer
type: object
fansCount:
type: integer
feedCount:
type: integer
followFlag:
type: integer
followTime:
type: integer
foreignUserFlag:
type: integer
friendFollowCount:
type: integer
guestInfo:
type: object
headUrl:
type: string
liveCoverImgUrl:
type: string
liveInfo:
properties:
anchorStatusFlag:
type: string
lotterySetting:
properties:
attendType:
type: integer
settingFlag:
type: string
type: object
micSetting:
properties:
settingFlag:
type: string
settingSwitchFlag:
type: string
type: object
switchFlag:
type: integer
type: object
liveNoticeInfo:
type: object
liveStatus:
type: integer
loggingoutWording:
type: string
menu:
items: {}
type: array
msgInfo:
type: object
nickname:
type: string
oneTimeFlag:
type: integer
originalEntranceFlag:
type: integer
originalFlag:
type: integer
originalInfo:
type: object
seq:
type: integer
signature:
type: string
spamStatus:
type: integer
userFlag:
type: integer
userMode:
type: integer
username:
type: string
vestNickname:
type: string
wxUsernameV5:
type: string
type: object
liveStatusFlag:
type: integer
type: object
core.VideoMomentGetSessionIdRequest:
properties:
roleType:
type: integer
to_username:
type: string
type: object
core.VideoMomentGetSessionIdResponseData:
properties:
baseResponse:
properties:
errMsg:
type: object
ret:
type: integer
type: object
enableAction:
type: integer
sessionId:
type: string
sessionInfo:
properties:
enableAction:
type: integer
msgExtInfo:
type: string
rejectMsg:
type: integer
sessionId:
type: string
toUsername:
type: string
type: object
toUsername:
type: string
type: object
core.VideoMomentInitResponseData:
properties:
aliasInfo:
items:
properties:
aliasMsgName:
type: string
aliasVersion:
type: integer
headImgUrl:
type: string
nickname:
type: string
roleType:
type: integer
type: object
type: array
baseResponse:
properties:
errMsg:
properties:
string:
type: string
type: object
ret:
type: integer
type: object
cmdlist:
items: {}
type: array
continueFlag:
type: integer
currentAliasRoleType:
type: integer
finderUsernameList:
items:
properties:
finderUsernameList:
type: string
type: object
type: array
keybuf:
properties:
buffer:
type: string
iLen:
type: integer
type: object
myacct:
items:
properties:
archievementInfo:
type: object
authInfo:
type: object
bindInfo:
items: {}
type: array
coverEntranceFlag:
type: integer
coverImgUrl:
type: string
coverUrl:
type: string
extFlag:
type: integer
extInfo:
properties:
birthDay:
type: integer
birthMonth:
type: integer
birthYear:
type: integer
city:
type: string
country:
type: string
province:
type: string
sex:
type: integer
type: object
fansCount:
type: integer
feedCount:
type: integer
followFlag:
type: integer
followTime:
type: integer
foreignUserFlag:
type: integer
friendFollowCount:
type: integer
guestInfo:
type: object
headUrl:
type: string
liveCoverImgUrl:
type: string
liveInfo:
properties:
anchorStatusFlag:
type: string
lotterySetting:
type: object
micSetting:
properties:
settingFlag:
type: string
settingSwitchFlag:
type: string
type: object
switchFlag:
type: integer
type: object
liveNoticeInfo:
type: object
liveStatus:
type: integer
loggingoutWording:
type: string
menu:
items: {}
type: array
msgInfo:
type: object
nickname:
type: string
oneTimeFlag:
type: integer
originalEntranceFlag:
type: integer
originalFlag:
type: integer
originalInfo:
properties:
postNeedCheckFlag:
type: integer
punishYearFlag:
type: integer
restApplyOriginalCount:
type: integer
restPunishDay:
type: integer
restRepostCount:
type: integer
type: object
seq:
type: string
signature:
type: string
spamStatus:
type: integer
userFlag:
type: integer
userMode:
type: integer
username:
type: string
vestNickname:
type: string
wxUsernameV5:
type: string
type: object
type: array
nextAliasModAvailableTime:
type: string
retryDelaySecond:
type: integer
ringtoneConfig:
type: object
slideUpGuideConfig:
items: {}
type: array
tabInfos:
items:
properties:
displayTabType:
type: integer
tabName:
type: string
type: object
type: array
teenmodeSetting:
type: object
teenmodeTipsConfig:
type: object
userNotCreatedFlag:
type: integer
userver:
type: integer
userverForH5:
type: integer
wxPersonalizedSetting:
type: object
wxUserAttr:
properties:
notAvailableFlag:
type: integer
wording:
type: string
type: object
wxUsernameForH5:
type: string
type: object
core.VideoMomentLikeRequest:
properties:
object_id:
type: string
object_nonce_id:
type: string
type: object
core.VideoMomentLikeResponseData:
properties:
baseResponse:
properties:
errMsg:
properties:
string:
type: string
type: object
ret:
type: integer
type: object
likeid:
type: integer
type: object
core.VideoMomentSearchRequest:
properties:
last_buff:
type: string
query:
type: string
scene:
type: integer
type: object
core.VideoMomentSendMsgRequest:
properties:
content:
type: string
session_id:
type: string
to_username:
type: string
type: object
core.VideoMomentSendMsgResponseData:
properties:
baseResponse:
properties:
errMsg:
properties:
string:
type: string
type: object
ret:
type: integer
type: object
newmsgid:
type: integer
type: object
core.VideoMomentSwitchVirtualNickNameRequest:
properties:
role_type:
type: integer
type: object
core.VideoMomentUserHomeRequest:
properties:
last_buff:
type: string
username:
type: string
type: object
core.VideoMomentVideoDetailRequest:
properties:
last_buff:
type: string
object_id:
type: string
object_nonce_id:
type: string
type: object
core.VoiceToTextRequest:
properties:
msgid:
type: string
type: object
core.VoiceToTextResponseData:
properties:
from_wxid:
type: string
msgid:
type: string
room_wxid:
type: string
status:
type: integer
text:
type: string
to_wxid:
type: string
wx_type:
type: integer
type: object
core.WorkWxCdnDownloadRequest:
properties:
aes_key:
type: string
auth_key:
type: string
save_path:
type: string
url:
type: string
type: object
core.WorkWxCdnDownloadResponseData:
properties:
error_code:
type: integer
save_path:
type: string
type: object
info:
contact: {}
description: 微信hook接口文档
title: WxHelper API
version: 3.9.10.19
paths:
/api/v1/cdn/download:
post:
consumes:
- application/json
description: CDN下载接口
parameters:
- description: 下载数据
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNDownloadRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNDownloadResponseData'
type: object
summary: CDN下载
tags:
- CDN
/api/v1/cdn/initial:
post:
consumes:
- application/json
description: CDN初始化接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNInitialResponseData'
type: object
summary: CDN初始化
tags:
- CDN
/api/v1/cdn/send/card:
post:
consumes:
- application/json
description: 发送名片消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendCardMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendCardMsgResponseData'
type: object
summary: 发送名片消息
tags:
- CDN发送消息
/api/v1/cdn/send/card_link:
post:
consumes:
- application/json
description: 发送卡片链接消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendCardLinkMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendCardLinkMsgResponseData'
type: object
summary: 发送卡片链接消息
tags:
- CDN发送消息
/api/v1/cdn/send/file:
post:
consumes:
- application/json
description: 发送文件消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendFileMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendFileMsgResponseData'
type: object
summary: 发送文件消息
tags:
- CDN发送消息
/api/v1/cdn/send/gif:
post:
consumes:
- application/json
description: 发送GIF消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendGifMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendGifMsgResponseData'
type: object
summary: 发送GIF消息
tags:
- CDN发送消息
/api/v1/cdn/send/gif_new:
post:
consumes:
- application/json
description: 发送GIF消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendGifMsgNewRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendGifMsgNewResponseData'
type: object
summary: 发送GIF消息
tags:
- CDN发送消息
/api/v1/cdn/send/image:
post:
consumes:
- application/json
description: 发送图片消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendImageMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendImageMsgResponseData'
type: object
summary: 发送图片消息
tags:
- CDN发送消息
/api/v1/cdn/send/location:
post:
consumes:
- application/json
description: 发送位置消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendLocationMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendLocationMsgResponseData'
type: object
summary: 发送位置消息
tags:
- CDN发送消息
/api/v1/cdn/send/mini_program:
post:
consumes:
- application/json
description: 发送小程序消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendMiniProgramMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendMiniProgramMsgResponseData'
type: object
summary: 发送小程序消息
tags:
- CDN发送消息
/api/v1/cdn/send/revoke:
post:
consumes:
- application/json
description: 发送撤回消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendRevokeMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendRevokeMsgResponseData'
type: object
summary: 发送撤回消息
tags:
- CDN发送消息
/api/v1/cdn/send/text:
post:
consumes:
- application/json
description: 发送文本消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendTextMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendTextMsgResponseData'
type: object
summary: 发送文本消息
tags:
- CDN发送消息
/api/v1/cdn/send/video:
post:
consumes:
- application/json
description: 发送视频消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendVideoMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendVideoMsgResponseData'
type: object
summary: 发送视频消息
tags:
- CDN发送消息
/api/v1/cdn/send/video_number:
post:
consumes:
- application/json
description: 发送视频号消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendVideoMomentMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendVideoMomentMsgResponseData'
type: object
summary: 发送视频号消息
tags:
- CDN发送消息
/api/v1/cdn/send/xml:
post:
consumes:
- application/json
description: 发送xml消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNSendXmlMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNSendXmlMsgResponseData'
type: object
summary: 发送xml消息
tags:
- CDN发送消息
/api/v1/cdn/upload:
post:
consumes:
- application/json
description: CDN上传接口
parameters:
- description: 上传数据
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CDNUploadRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CDNUploadResponseData'
type: object
summary: CDN上传
tags:
- CDN
/api/v1/cdn/workwx/download:
post:
consumes:
- application/json
description: 企业微信CDN下载接口
parameters:
- description: 下载数据
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.WorkWxCdnDownloadRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.WorkWxCdnDownloadResponseData'
type: object
summary: 企业微信CDN下载
tags:
- CDN
/api/v1/collect/list:
get:
consumes:
- application/json
description: 获取收藏列表接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetCollectListResponseData'
type: object
summary: 获取收藏列表
tags:
- 收藏
/api/v1/collect/send:
post:
consumes:
- application/json
description: 发送收藏(旧)接口
parameters:
- description: 收藏信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendCollectRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送收藏(旧)
tags:
- 收藏
/api/v1/collect/send/msgid:
post:
consumes:
- application/json
description: 收藏指定消息(旧)接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendCollectMsgByMsgIdRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 收藏指定消息(旧)
tags:
- 收藏
/api/v1/contact/accept/wc_pay/auto:
post:
consumes:
- application/json
description: 自动接收好友转账接口
parameters:
- description: 自动接收好友转账
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AutoAcceptWCPayRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 自动接收好友转账
tags:
- 联系人
/api/v1/contact/friend/{wxid}:
get:
consumes:
- application/json
description: 获取单个好友信息接口
parameters:
- description: 微信ID
in: path
name: wxid
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetFriendListResponseDateItem'
type: object
summary: 获取单个好友信息
tags:
- 联系人
/api/v1/contact/friend/accept:
post:
consumes:
- application/json
description: 通过好友申请接口
parameters:
- description: 通过好友申请信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AcceptFriendRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 通过好友申请
tags:
- 联系人
/api/v1/contact/friend/add:
post:
consumes:
- application/json
description: 通过群聊加好友-发送好友申请接口
parameters:
- description: 添加好友信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AddFriendRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 通过群聊加好友-发送好友申请
tags:
- 联系人
/api/v1/contact/friend/add/auto:
post:
consumes:
- application/json
description: 自动同意好友申请接口
parameters:
- description: 自动加好友
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AutoAcceptAddFriendRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 自动同意好友申请
tags:
- 联系人
/api/v1/contact/friend/add/search:
post:
consumes:
- application/json
description: 添加搜索微信用户为好友接口
parameters:
- description: 添加搜索微信用户为好友信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AddSearchWxUserRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 添加搜索微信用户为好友
tags:
- 联系人
/api/v1/contact/friend/card/auto:
post:
consumes:
- application/json
description: 自动接收名片接口
parameters:
- description: 自动接收名片
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AutoAcceptCardRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 自动接收名片
tags:
- 联系人
/api/v1/contact/friend/check/{wxid}:
post:
consumes:
- application/json
description: 检测好友状态(发送无痕清粉消息)接口
parameters:
- description: 微信ID
in: path
name: wxid
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 检测好友状态(发送无痕清粉消息)
tags:
- 联系人
/api/v1/contact/friend/delete/{wxid}:
post:
consumes:
- application/json
description: 删除好友接口
parameters:
- description: 微信ID
in: path
name: wxid
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 删除好友
tags:
- 联系人
/api/v1/contact/friend/list:
get:
consumes:
- application/json
description: 获取好友列表接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.GetFriendListResponseDateItem'
type: array
type: object
summary: 获取好友列表
tags:
- 联系人
/api/v1/contact/friend/protocol/brief/{wxid}:
get:
consumes:
- application/json
description: 获取好友简要信息(协议)接口
parameters:
- description: 微信ID
in: path
name: wxid
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetFriendBriefInfoByProtocolResponseData'
type: object
summary: 获取好友简要信息(协议)
tags:
- 联系人
/api/v1/contact/friend/protocol/detail:
post:
consumes:
- application/json
description: 批量获取好友详细信息(协议)接口
parameters:
- description: 微信ID列表
in: body
name: body
required: true
schema:
items:
type: string
type: array
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.GetFriendDetailInfoByProtocolResponseDataContactListItem'
type: array
type: object
summary: 批量获取好友详细信息(协议)
tags:
- 联系人
/api/v1/contact/friend/protocol/detail/{wxid}:
get:
consumes:
- application/json
description: 获取微信好友详细信息(协议)接口
parameters:
- description: 微信ID
in: path
name: wxid
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.GetFriendDetailInfoByProtocolResponseDataContactListItem'
type: array
type: object
summary: 获取微信好友详细信息(协议)
tags:
- 联系人
/api/v1/contact/friend/remark:
post:
consumes:
- application/json
description: 编辑好友备注接口
parameters:
- description: 好友备注信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.EditFriendRemarkRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 编辑好友备注
tags:
- 联系人
/api/v1/contact/friend/search:
get:
consumes:
- application/json
description: 搜索微信用户接口
parameters:
- description: 搜索字符串
in: query
name: keyword
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.SearchWxUserResponseData'
type: array
type: object
summary: 搜索微信用户
tags:
- 联系人
/api/v1/contact/public/list:
get:
consumes:
- application/json
description: 获取公众号列表接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.GetPublicUserListResponseData'
type: array
type: object
summary: 获取公众号列表
tags:
- 联系人
/api/v1/contact/room/accept/auto:
post:
consumes:
- application/json
description: 自动接受群邀请接口
parameters:
- description: 自动接受群邀请
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AutoAcceptRoomRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 自动接受群邀请
tags:
- 群管理
/api/v1/contact/room/create:
post:
consumes:
- application/json
description: 创建群聊接口
parameters:
- description: 微信ID列表
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CreateRoomRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 创建群聊
tags:
- 群管理
/api/v1/contact/room/delete:
post:
consumes:
- application/json
description: 退出群聊接口
parameters:
- description: 推出的群聊
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.DelChatRoomRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 退出群聊
tags:
- 群管理
/api/v1/contact/room/friend/add:
post:
consumes:
- application/json
description: 添加群成员为好友接口
parameters:
- description: 添加好友信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AddFriendRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 添加群成员为好友
tags:
- 群管理
/api/v1/contact/room/list:
get:
consumes:
- application/json
description: 获取群列表接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.GetChatRoomListResponseDataItem'
type: array
type: object
summary: 获取群列表
tags:
- 群管理
/api/v1/contact/room/member/delete:
post:
consumes:
- application/json
description: 踢除群成员接口
parameters:
- description: 成员信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.DelChatRoomMemberRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 踢除群成员
tags:
- 群管理
/api/v1/contact/room/member/invite:
post:
consumes:
- application/json
description: 邀请好友进群接口
parameters:
- description: 邀请信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.InviteToRoomRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.InviteToRoomResponseData'
type: object
summary: 邀请好友进群
tags:
- 群管理
/api/v1/contact/room/member/list/{roomWxid}:
get:
consumes:
- application/json
description: 获取群成员列表接口
parameters:
- description: 微信群ID
in: path
name: roomWxid
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetChatRoomMemberListResponseData'
type: object
summary: 获取群成员列表
tags:
- 群管理
/api/v1/contact/room/member/nickname/show:
post:
consumes:
- application/json
description: 是否显示群成员昵称接口
parameters:
- description: 昵称信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.RoomShowNickNameRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 是否显示群成员昵称
tags:
- 群管理
/api/v1/contact/room/mine/nickname/modify:
post:
consumes:
- application/json
description: 修改我在本群的昵称接口
parameters:
- description: 昵称信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.EditRoomMineNickNameRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 修改我在本群的昵称
tags:
- 群管理
/api/v1/contact/room/name/modify:
post:
consumes:
- application/json
description: 修改群聊名称接口
parameters:
- description: 成员信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.EditChatRoomMemberRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 修改群聊名称
tags:
- 群管理
/api/v1/contact/room/notice/modify:
post:
consumes:
- application/json
description: 修改群公告接口
parameters:
- description: 公告信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.EditChatRoomNoticeRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 修改群公告
tags:
- 群管理
/api/v1/contact/room/protocol/create:
post:
consumes:
- application/json
description: 创建群聊(协议)接口
parameters:
- description: 微信ID列表
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CreateRoomRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CreateChatRoomByProtocolResponseData'
type: object
summary: 创建群聊(协议)
tags:
- 群管理
/api/v1/contact/room/protocol/detail/{roomWxid}:
get:
consumes:
- application/json
description: 获取微信群详细信息(协议)接口
parameters:
- description: 微信群ID
in: path
name: roomWxid
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.GetFriendDetailInfoByProtocolResponseDataContactListItem'
type: array
type: object
summary: 获取微信群详细信息(协议)
tags:
- 群管理
/api/v1/contact/room/protocol/invite/list/{roomWxid}:
get:
consumes:
- application/json
description: 获取群成员邀请关系(协议)接口
parameters:
- description: 微信群ID
in: path
name: roomWxid
required: true
type: string
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetRoomMemberInviteListResponseData'
type: object
summary: 获取群成员邀请关系(协议)
tags:
- 群管理
/api/v1/contact/room/to_contact/save:
post:
consumes:
- application/json
description: 保存到/移出通讯录接口
parameters:
- description: 昵称信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SaveRoomSaveToContactRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 保存到/移出通讯录
tags:
- 群管理
/api/v1/live/enter:
post:
consumes:
- application/json
description: 进入直播间接口
parameters:
- description: 直播间信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.LiveEnterRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 进入直播间
tags:
- 直播
/api/v1/live/get/change/info:
post:
consumes:
- application/json
description: 获取直播间变动信息(人气,实时发言等))接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
type: object
type: object
summary: 获取直播间变动信息(人气,实时发言等))
tags:
- 直播
/api/v1/live/get/online/user:
post:
consumes:
- application/json
description: 获取直播间在线用户接口
parameters:
- description: 直播间信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.LiveGetOnlineUserRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
type: object
type: object
summary: 获取直播间在线用户
tags:
- 直播
/api/v1/live/get/shelf:
post:
consumes:
- application/json
description: 获取直播间货架接口
parameters:
- description: 直播间信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.LiveGetShelfRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
type: object
type: object
summary: 获取直播间货架
tags:
- 直播
/api/v1/live/send/msg:
post:
consumes:
- application/json
description: 发送直播间消息接口
parameters:
- description: 直播间信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.LiveSendMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送直播间消息
tags:
- 直播
/api/v1/login/exit:
post:
consumes:
- application/json
description: 退出微信接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 退出微信
tags:
- 登录
/api/v1/login/logout:
post:
consumes:
- application/json
description: 注销微信登录接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 注销微信登录
tags:
- 登录
/api/v1/login/qrcode/refresh:
post:
consumes:
- application/json
description: 刷新登录二维码接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.RefreshLoginQrCodeResponseData'
type: object
summary: 刷新登录二维码
tags:
- 登录
/api/v1/login/userinfo:
get:
consumes:
- application/json
description: 获取登录用户信息接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetLoginUserInfoResponseData'
type: object
summary: 获取登录用户信息
tags:
- 登录
/api/v1/login/version:
get:
consumes:
- application/json
description: 获取微信版本号接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 获取微信版本
tags:
- 登录
/api/v1/message/register_msg_http_callback:
post:
consumes:
- application/json
description: 注册消息回调接口
parameters:
- description: 回调
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.HttpCallBackRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 注册消息回调
tags:
- 发送消息
/api/v1/message/send/card:
post:
consumes:
- application/json
description: 发送名片消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendCardMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送名片消息
tags:
- 发送消息
/api/v1/message/send/file:
post:
consumes:
- application/json
description: 发送文件消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendFileMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送文件消息
tags:
- 发送消息
/api/v1/message/send/forward:
post:
consumes:
- application/json
description: 转发任意类型消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.ForwardMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 转发任意类型消息
tags:
- 发送消息
/api/v1/message/send/git:
post:
consumes:
- application/json
description: 发送gif消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendGifMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送gif消息
tags:
- 发送消息
/api/v1/message/send/image:
post:
consumes:
- application/json
description: 发送图片消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendImageMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送图片消息
tags:
- 发送消息
/api/v1/message/send/link:
post:
consumes:
- application/json
description: 发送链接消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendLinkMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送链接消息
tags:
- 发送消息
/api/v1/message/send/text:
post:
consumes:
- application/json
description: 发送文本消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendTextMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送文本消息
tags:
- 发送消息
/api/v1/message/send/video:
post:
consumes:
- application/json
description: 发送视频文件消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendVideoMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送视频文件消息
tags:
- 发送消息
/api/v1/message/send/xml:
post:
consumes:
- application/json
description: 发送XML消息接口
parameters:
- description: 消息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendXmlMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 发送XML消息
tags:
- 发送消息
/api/v1/mini/program/code:
post:
consumes:
- application/json
description: 获取小程序授权Code接口
parameters:
- description: 小程序信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.GetMiniProgramCodeRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetMiniProgramCodeResponseData'
type: object
summary: 获取小程序授权Code
tags:
- 小程序
/api/v1/moment/comment:
post:
consumes:
- application/json
description: 评论朋友圈接口
parameters:
- description: 评论信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.CommentMomentRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.CommentMomentResponseData'
type: object
summary: 评论朋友圈
tags:
- 朋友圈
/api/v1/moment/friend/list:
post:
consumes:
- application/json
description: 获取好友朋友圈接口
parameters:
- description: 好友朋友圈信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.GetFriendMomentRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetFriendMomentResponseData'
type: object
summary: 获取好友朋友圈
tags:
- 朋友圈
/api/v1/moment/like:
post:
consumes:
- application/json
description: 点赞朋友圈接口
parameters:
- description: 点赞信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.LikeMomentRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.LikeMomentResponseData'
type: object
summary: 点赞朋友圈
tags:
- 朋友圈
/api/v1/moment/list:
post:
consumes:
- application/json
description: 获取朋友圈接口
parameters:
- description: 朋友圈信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.GetMomentRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data: {}
type: object
summary: 获取朋友圈
tags:
- 朋友圈
/api/v1/moment/send:
post:
consumes:
- application/json
description: 发送朋友圈接口
parameters:
- description: 发送信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SendMomentRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.SendMomentResponseData'
type: object
summary: 发送朋友圈
tags:
- 朋友圈
/api/v1/moment/upload/image:
post:
consumes:
- application/json
description: 上传朋友圈图片接口
parameters:
- description: 上传图片信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.UploadMomentImageRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.UploadMomentImageResponseData'
type: object
summary: 上传朋友圈图片
tags:
- 朋友圈
/api/v1/other/decrypt_img:
post:
consumes:
- application/json
description: 解密图片接口
parameters:
- description: 解密图片请求
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.DecryptImgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 解密图片
tags:
- 其他
/api/v1/other/get_a8_key:
post:
consumes:
- application/json
description: 获取A8Key接口
parameters:
- description: A8Key请求
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.GetA8KeyRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetA8KeyResponseData'
type: object
summary: 获取A8Key
tags:
- 其他
/api/v1/tag/add:
post:
consumes:
- application/json
description: 添加标签接口
parameters:
- description: 标签信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AddTagRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.AddTagResponseData'
type: object
summary: 添加标签
tags:
- 标签
/api/v1/tag/add/user:
post:
consumes:
- application/json
description: 为用户添加标签接口
parameters:
- description: 标签信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.AddTagToUserRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.AddTagToUserResponseData'
type: object
summary: 为用户添加标签
tags:
- 标签
/api/v1/tag/delete:
post:
consumes:
- application/json
description: 删除标签接口
parameters:
- description: 标签信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.DeleteTagRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.DeleteTagResponseData'
type: object
summary: 删除标签
tags:
- 标签
/api/v1/tag/list:
get:
consumes:
- application/json
description: 获取标签列表接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.GetTagListResponseDataItem'
type: array
type: object
summary: 获取标签列表
tags:
- 标签
/api/v1/tag/list/user:
post:
consumes:
- application/json
description: 获取用户标签列表接口
parameters:
- description: 标签信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.GetTagListByWxidRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetTagListByWxidResponseData'
type: object
summary: 获取用户标签列表
tags:
- 标签
/api/v1/tag/modify:
post:
consumes:
- application/json
description: 修改标签接口
parameters:
- description: 标签信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.ModifyTagRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 修改标签
tags:
- 标签
/api/v1/ui/chat/msg/not/notify:
post:
consumes:
- application/json
description: 消息免打扰接口
parameters:
- description: 消息免打扰
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.ChatMsgNotNotifyRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 消息免打扰
tags:
- 界面
/api/v1/ui/chat/session/top:
post:
consumes:
- application/json
description: 置顶会话接口
parameters:
- description: 会话
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.ChatSessionTopRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 置顶会话
tags:
- 界面
/api/v1/ui/clear/chat/record:
post:
consumes:
- application/json
description: 清空聊天记录接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 清空聊天记录
tags:
- 界面
/api/v1/ui/switch/session:
post:
consumes:
- application/json
description: 切换会话接口
parameters:
- description: 会话
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.SwitchSessionRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 切换会话
tags:
- 界面
/api/v1/video_moment/create/virtual_nickname:
post:
consumes:
- application/json
description: 创建虚拟昵称接口
parameters:
- description: 昵称信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VideoMomentCreateVirtualNickNameRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
type: object
type: object
summary: 创建虚拟昵称
tags:
- 视频号
/api/v1/video_moment/delete/virtual_nickname:
post:
consumes:
- application/json
description: 删除虚拟昵称接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
$ref: '#/definitions/api.CommonStringResponse'
summary: 删除虚拟昵称
tags:
- 视频号
/api/v1/video_moment/follow:
post:
consumes:
- application/json
description: 关注视频号接口
parameters:
- description: 关注信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VideoMomentFollowRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.VideoMomentFollowResponseData'
type: object
summary: 关注视频号
tags:
- 视频号
/api/v1/video_moment/get/session_id:
post:
consumes:
- application/json
description: 获取私信sessionId接口
parameters:
- description: sessionId信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VideoMomentGetSessionIdRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.VideoMomentGetSessionIdResponseData'
type: object
summary: 获取私信sessionId
tags:
- 视频号
/api/v1/video_moment/init:
post:
consumes:
- application/json
description: 视频号初始化接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.VideoMomentInitResponseData'
type: object
summary: 视频号初始化
tags:
- 视频号
/api/v1/video_moment/like:
post:
consumes:
- application/json
description: 点赞视频接口
parameters:
- description: 点赞信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VideoMomentLikeRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.VideoMomentLikeResponseData'
type: object
summary: 点赞视频
tags:
- 视频号
/api/v1/video_moment/search:
post:
consumes:
- application/json
description: 搜索视频号接口
parameters:
- description: 搜索信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VideoMomentSearchRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
type: object
type: object
summary: 搜索视频号
tags:
- 视频号
/api/v1/video_moment/send/msg:
post:
consumes:
- application/json
description: 发送私信接口
parameters:
- description: 发送信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VideoMomentSendMsgRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.VideoMomentSendMsgResponseData'
type: object
summary: 发送私信
tags:
- 视频号
/api/v1/video_moment/switch/virtual_nickname:
post:
consumes:
- application/json
description: 切换虚拟昵称接口
parameters:
- description: 昵称信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VideoMomentSwitchVirtualNickNameRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
type: object
type: object
summary: 切换虚拟昵称
tags:
- 视频号
/api/v1/video_moment/user/home:
post:
consumes:
- application/json
description: 视频号用户主页接口
parameters:
- description: 用户信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VideoMomentUserHomeRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
type: object
type: object
summary: 视频号用户主页
tags:
- 视频号
/api/v1/video_moment/video/detail:
post:
consumes:
- application/json
description: 查看视频详细信息(包含评论)接口
parameters:
- description: 视频信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VideoMomentVideoDetailRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
type: object
type: object
summary: 查看视频详细信息(包含评论)
tags:
- 视频号
/api/v1/voice/to/text:
post:
consumes:
- application/json
description: 语音转文字接口
parameters:
- description: 语音信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.VoiceToTextRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.VoiceToTextResponseData'
type: object
summary: 语音转文字
tags:
- 语音转文字
/api/v1/workwx/room/list:
get:
consumes:
- application/json
description: 获取企业微信群列表接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.GetWorkWxRoomListResponseDataItem'
type: array
type: object
summary: 获取企业微信群列表
tags:
- 企业微信
/api/v1/workwx/room/member/list:
post:
consumes:
- application/json
description: 获取企业微信群成员列表接口
parameters:
- description: 群信息
in: body
name: body
required: true
schema:
$ref: '#/definitions/core.GetWorkWxChatRoomMemberRequest'
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
$ref: '#/definitions/core.GetWorkWxChatRoomMemberResponseData'
type: object
summary: 获取企业微信群成员列表
tags:
- 企业微信
/api/v1/workwx/user/list:
get:
consumes:
- application/json
description: 获取企业微信用户列表接口
produces:
- application/json
responses:
"200":
description: '{\"code\":0, ....}'
schema:
allOf:
- $ref: '#/definitions/api.CommonStringResponse'
- properties:
Data:
items:
$ref: '#/definitions/core.GetWorkWxUserListResponseDataItem'
type: array
type: object
summary: 获取企业微信用户列表
tags:
- 企业微信
swagger: "2.0"