wechatWeb/_docs/文档.md

WeChat智能托管 API 接口说明文档

1. 文档说明

• 数据来源：API文档
• 解析口径：严格按 Swagger 输出参数与字段说明
• 接口总数：193（Method + Path）

2. 套餐统计

套餐	接口数量
初级版	68
高级版	79
定制版	37
白标/OEM	9

上表「接口数量」之和为 193，与 §1 接口总数一致（每个 Method + Path 仅归属一个套餐）。

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
合计	193	68	79	37	9

说明：每行「接口数量」等于该行四个套餐列之和；合计行与 §1、§2 一致。

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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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

请求体代码示例

{
  "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

请求体代码示例

{
  "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

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	添加好友时的(招呼语/验证信息)

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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号等)

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	添加好友时的(招呼语/验证信息)

请求体代码示例

{
  "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

请求体代码示例

{
  "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

请求体代码示例

{
  "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

请求体代码示例

{
  "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

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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

请求体代码示例

{
  "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

请求体代码示例

{
  "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	否	收款备注

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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编码

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	提醒好友看列表

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	消息体数组

请求体代码示例

{
  "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	否	视频数据

请求体代码示例

{
  "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内容

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	下载数据的总长度

请求体代码示例

{
  "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	否	下载数据的总长度

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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, 同步所有消息

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	消息体数组

请求体代码示例

{
  "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	否	消息体数组

请求体代码示例

{
  "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	否	消息体数组

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	消息接收者

请求体代码示例

{
  "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编码

请求体代码示例

{
  "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	否	是否启用回调

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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, 其余自行探索

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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

字段级说明

• 无请求体字段

请求体代码示例

{}

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	否	待补充

请求体代码示例

{
  "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

字段级说明

• 无请求体字段

请求体代码示例

{}

4.13.15 POST /user/SetKeywordReply

• 接口说明：设置关键词自动回复
• 对应套餐：初级版
• 请求 Content-Type：application/json
• 响应 Content-Type：application/json
• 响应状态码：200

请求参数

参数名	位置	类型	Required	参数说明
key	query	string	是	账号唯一标识
body	body	object	是	请求参数

请求体模型

• SetKeywordReplyModel

字段级说明

• 无请求体字段

请求体代码示例

{}

4.13.16 POST /user/SetKickKeyword

• 接口说明：设置踢人关键词配置
• 对应套餐：初级版
• 请求 Content-Type：application/json
• 响应 Content-Type：application/json
• 响应状态码：200

请求参数

参数名	位置	类型	Required	参数说明
key	query	string	是	账号唯一标识
body	body	object	是	请求参数

请求体模型

• SetKickKeywordModel

字段级说明

• 无请求体字段

请求体代码示例

{}

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	否	待补充

请求体代码示例

{
  "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

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "Alisa": ""
}

4.13.23 POST /user/SetWelcome

• 接口说明：设置欢迎词配置
• 对应套餐：初级版
• 请求 Content-Type：application/json
• 响应 Content-Type：application/json
• 响应状态码：200

请求参数

参数名	位置	类型	Required	参数说明
key	query	string	是	账号唯一标识
body	body	object	是	请求参数

请求体模型

• SetWelcomeModel

字段级说明

• 无请求体字段

请求体代码示例

{}

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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	手机号

请求体代码示例

{
  "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	否	手机号

请求体代码示例

{
  "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

请求体代码示例

{
  "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	否	验证码

请求体代码示例

{
  "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	否	验证码

请求体代码示例

{
  "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

请求体代码示例

{
  "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

请求体代码示例

{
  "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:删除授权码相关的所有数据

请求体代码示例

{
  "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

请求体代码示例

{
  "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

请求体代码示例

{
  "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永久（数字为标识，非准确天数）

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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

请求体代码示例

{
  "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

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	视频号助手扫码登录确认链接

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	否	待补充

请求体代码示例

{
  "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	是	账号唯一标识

请求体模型

• 无

字段级说明

• 无请求体字段

请求体代码示例

• 无