# 微信号管理模块
|更新时间|更新人|作用|
|--|--|--|
2020-05-22 | 李小琳 | 根据V4.3.0 增加查询部门树下微信号接口
## **Web端交互**
> *****
## **API相关文档**
> ******
- API infomation
接口描述 | **获取系统账号下的微信号信息**
---|---
URL | /wechat_api/wechatPool/searchWechatUser
请求方式 | get
请求参数 | ?realName=&nickName=&status=&type=2
- params infomation
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | realName | string | Y |系统账号名称（管理员有权限其子账号的微信号信息）
| 请求参数 | status | Integer | Y |微信号在线状态{1:在线；0:离线}
| 请求参数 | nickName | string | Y |微信号昵称
| 请求参数 | type | string | Y |值默认为2
- response example
```
{
"msg":"获取成功",
"code":200,
"data":\[
{
"wechatUserId":67,
"uin":"2123131667",
"userName":"wxid\_lbejkr1i6jl922",
"nickName":"呵呵海",
"headImgUrl":"[http://wx.qlogo.cn/mmhead/ver\_1/Eo51yzdqojt7g5I2uNlaCsLNGqrsCsKBnbuZ6P8pK3iaHtrqRB11zQPxxMibAZOTkQW9RdEkiacLoGorFns7IWuNn4gxGH4Y7R2bibjQ4Pcibpn4/0](http://wx.qlogo.cn/mmhead/ver_1/Eo51yzdqojt7g5I2uNlaCsLNGqrsCsKBnbuZ6P8pK3iaHtrqRB11zQPxxMibAZOTkQW9RdEkiacLoGorFns7IWuNn4gxGH4Y7R2bibjQ4Pcibpn4/0)",
"remarkName":null,
"remarkPYInitial":null,
"remarkPYQuanPin":null,
"sex":null,
"status":1,
"verifyFlag":"0",
"adminUserId":1,
"createTime":null,
"lastLoginTime":1578576224000,
"lastLoginIP":"/events/PC/1",
"secName":null,
"flag":null,
"wechatMeta":null,
"serverId":"Ipad\_001",
"childId":"04",
"mqServerId":"Ipad\_001\_04",
"snsBg":null,
"area":null,
"signature":null,
"phone":null,
"bindQQ":null,
"isAutoReply":0,
"maxLimit":null,
"adminUserRealName":"superadmin",
"type":0,
"pyinitial":null,
"pyquanPin":null
}
\]
}
```
> *****
接口描述 | **分配微信号**
---|---
URL | /wechat_api/wechatAssign/assign
请求方式 | post
请求参数 | {targetAdminUserId:"33726",wechatUser:[{"sourceAdminUserId":33726,"uin":"2964685533","wechatUserId":57221,"nickName":"小陶同学"}]}
返回值 | {"msg":"分配成功","code":200}
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | targetAdminUserId| Long| Y |分配的目标账号ID
| 请求参数 | sourceAdminUseId| string| Y |源账号ID
| 请求参数 | uin| string| Y |被分配的用户微信ID
| 请求参数 | wechatUserId| Long | Y |被分配的微信号ID（数据库主键字段）
| 请求参数 | nickName | string| Y |被分配的微信号昵称
> *****
接口描述 | **加入微信号码池**
---|---
URL | /wechat_api/wechatPool/batchJoinPool
请求方式 | post
请求参数 | {wechatUserIds:"57221"，uins:"2964685533"}
返回值 |{"msg":"加入微信池成功","code":200}
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | wechatUserIds| string | Y |要加入微信池的微信号ID(数据库主键字段)
| 请求参数 | uins| string | Y |要加入微信池的微信号ID
> *****
接口描述 | **查看微信池**
---|---
URL | /wechat_api/wechatPool/findJoins
请求方式 | get
请求参数 | {nickName:"陶成",online:"2"}
返回值 |[{"name":"陶成","wechatUser":{"wechatUserId":57221,"uin":"2964685533","userName":"wxid_mjxv8kbxje8b22","nickName":"小陶同学","headImgUrl":"http://wx.qlogo.cn/mmhead/ver_1/1YA7qsrPxCh7BeiacD1Yh6LFoQThxmb290PFZEo6Q3jkcJD5ibkLAOcrBIz44Ruzd0oibKEepFI1OkK5sfc1QicvNCgpOUhT2dgWk1yibL7giaoRs/0","status":1,"verifyFlag":"0","adminUserId":33726,"lastLoginTime":1564716060000,"lastLoginIP":"null","serverId":"Ipad_guangzhou_010","childId":"11","mqServerId":"Ipad_guangzhou_010_11"}}]
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | nickName| string | Y |微信号昵称
| 请求参数 | online| Interger| Y |是否在线
> *****
接口描述 | **从微信池领取到当前账号**
---|---
URL | /wechat\_api/wechatPool/batchReceive
请求方式 | post
请求参数 | {uins:"2964685533"}
返回值 |{"msg":"批量领取微信号成功","code":200}
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | uins| string | Y |用户微信ID
> *****
接口描述 | **从微信池撤回微信号**
---|---
URL | /wechat_api/wechatPool/removeFromPool
请求方式 | post
请求参数 | {wechatUserId:"57221"}
返回值 |{"msg":"从微信池撤回微信号","code":200}
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | wechatUserId| Long| Y |微信号ID
> *****
接口描述 | **下线微信号**
---|---
URL | /wechat\_api/websocket/logout
请求方式 | post
请求参数 | {uin:"2964685533",loginer:"33726"}
返回值 |{{"msg":"下线成功","code":200}
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | uin| string| Y |用户微信ID
| 请求参数 | loginer| Y |string|adminUserId帐号id
> *****
接口描述 | **删除微信号**
---|---
URL | /wechat\_api/wechatuser/accountLogout
请求方式 | get
请求参数 | {uin:"2964685533",loginer:"33726"}
返回值 |{"msg":"登出成功！","code":200}
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | uin| string| Y |用户微信ID
| 请求参数 | loginer| string| Y |adminUserId帐号id
> *****
接口描述 | **导出好友微信号**
---|---
URL | /wechat\_api/report/exportWechatFriendReport
请求方式 | get
请求参数 | {wechatNiceName:"售前-陶成",uin:"663329897"}
返回值 |{"msg":"已经收到您的下载请求，后台正在生成，请稍后。","code":200}
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | wechatNiceName| string| Y |导出的微信号昵称
| 请求参数 | uin| string| Y |导出的用户微信ID
> *****
接口描述 | **更新微信号加载状态**
---|---
URL|/wechat_api/wechatuser/updateWechatUserLoadingStatus
请求方式 | get
请求参数 | uin
返回值 |{ code: 200 ,msg : 修改成功}
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | uin| string| Y |导出的用户微信ID
> *****
接口描述 | **获取微信号加载状态**
---|---
URL|/wechat_api/wechatuser/updateWechatUserLoadingStatus
请求方式 | get
请求参数 | uin
返回值 |{ code: 200 data : //wechatUserLoadingStatus: + uin 中的数据 }
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | uin| string| Y |导出的用户微信ID
> *****
接口描述 | **根据公共池状态搜索**
---|---
URL|/wechat_api/wechatPool/findByStatus
请求方式 | get
请求参数 | realName,type,nickName,status
返回值 | [{name:"谭煜辰",wechatUser:{wechatUserId:597,uin:"3180227369",...}}]
| Sort | Param | Type | required | Description |
| --- | --- | --- | --- |--- |
| 请求参数 | nickName| string| N|微信号昵称
| 请求参数 | status| string| N|状态
| 请求参数 | realName| string| N|真实姓名
| 请求参数 | type| Interger| Y |类型
### V4.3.0 查询部门微信树
- url: /wechat_api/wechatuser/findWeChatDataByDepartTree
- 调用方式：get
##### 传参：
属性名 | 类型| 是否必要 | 备注
---|--- | --- | ---
adminUserName | String| N | 账号
realName| String| N | 姓名
##### 出参：
属性名 | 类型| 备注
---|--- | ---
code | Integer | 状态码
msg | String | 消息
data | Object|
name| String|部门名称
departId| Long|部门id
childList| List| 子部门
account| List| 该部门下的账号列表
curr| List| 该部门下的微信号列表
##### 出参示例：
```
{
"code":200,
"msg":"操作成功!",
"data":[
{
"name":"组织架构",
"departId":0,
"childList":[
Object{...}
],
"account":[
{
"adminUserId":11855,
"realName":"hhhaaa",
"adminUserName":"lixiaolin",
"curr":[
{
"wechatUserId":663,
"uin":2368771701,
"userName":"wxid\_15s48dvw9f7s22",
"nickName":"小争小吵小任性。",
"headImgUrl":"http://wx.qlogo.cn/mmhead/ver_1/JRmibsM00VpaVK8BoDcSsdmxr5aiaZXaVicyKLRjICoFymNfoCeGC3YqfNzAV9lacAUeab4cFQFNQ0OyWaOpVpBvZ8XcgSKwSAZZbB66jxFs2U/0",
"remarkName":null,
"secName":"啊啊啊啊",
"adminUserId":11855,
"departId":0,
"departName":null,
"parentId":0,
"realName":"hhhaaa",
"adminUserName":"lixiaolin",
"onLineStatus":1
}
]
}
]
}
]
}
```
- 首页
- 系统登录注册模块
- 登录模块
- 注册模块
- 忘记密码模块
- 功能首页渲染模块
- 会话面板模块
- 微信号登录模块
- 会话联系人模块
- 通讯录模块
- 聊天窗口模块
- 快捷回复模块
- 客户录入模块
- 群管理模块
- 历史消息面板模块
- 群发助手面板模块
- 群发设置模块
- 群发管理模块
- 群发演示模块
- 朋友圈面板模块
- 发朋友圈模块
- 朋友圈互动模块
- 朋友圈历史记录模块
- 客户管理面板模块
- 客户查询模块
- 服务记录模块
- 批量标签模块
- 标签管理模块
- 昵称管理模块
- 个性称呼模块
- 批量导入客户模块
- 报表面板模块
- 微信好友报表
- 被删好友报表
- 新增好友报表
- 添加好友报表
- 服务记录报表
- 转账记录报表
- 红包统计报表
- 会话统计报表
- 电话统计报表
- 标签统计报表
- 账号管理面板模块
- 微信号管理模块
- 部门管理模块
- 子账号管理模块
- 在线日志模块
- 机器人模块
- 自动通过好友模块
- 小程序商城模块
- 微信号分配模块
- 帮助中心面板模块
- 个人中心模块
- 我的账号模块
- 系统设置模块
- 第三方能力接口对接
- 第三方登录模块
- 联系人模块
- 系统账号模块
- 服务版本接口迭代说明
- 素材库
- 好友去重
- V群模块