企业🤖AI Agent构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
# 好友去重模块接口文档 ##### 作者:黄文榕 ##### 时间:2020-05-07 ##### 版本:V4.2.0 ##### 修改: |更新时间|更新人|作用| |--|--|--| ### 新增去重任务接口 - url: /wechat_api/repetionFriend/start - 调用方式: post ##### 作用: 新增去重任务接口 ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- |---| --- uins | List<String> | Y | 传入的微信号 departStruct | String | N | 传入当时的部门结构 ``` { "uins":["1575045774","2245246006"] } ``` ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | msg | String | data | {} | 数据 data: 属性名 | 类型| 备注 ---|--- | --- repetionFriendId | Integer | 去重任务的id status | Integer | 任务处于的状态(0:进行中 1:完成 4:失败) adminUserId |Integer | 账号id repetionFriendNum | Integer | 重复好友数量 createTime | String | 创建时间 departStruct | String | 部门结构 ``` { "code": 200, "msg": "操作成功!", "data": { "repetionFriendId": 32, "status": 0, "adminUserId": 14, "repetionFriendNum": 0, "createTime": "2020-05-07 13:59:03", "departStruct": null } }或 { { "code": 400, "msg": "uin至少填入1个最多填入100个"/"uins不能为空", "data": null } ``` ##### 异步推送: 属性名 | 类型| 备注 ---|--- | --- MTYPE | String | 好友去重完成为: reFriend content | Map | noticeMessage content adminUserId | Long | 用户Id content | String | 内容 msgCode | Integer | 提醒类型 好友去重完成为:3 isRead | Integer | 是否阅读 createTime | time | 创建时间 title | String | 标题 ### 查询任务列表(分页) - url: /wechat_api/repetionFriend/page - 调用方式: get ##### 作用: 查询任务列表 ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- |---| --- limit | Integer | Y | 限制数 pageNo | Integer | Y | 页码 status | Integer | N | 状态(0:进行中 1:完成 4:失败) ``` /wechat_api/repetionFriend/page?limit=10&pageNo=1 ``` ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | msg | String | data | map | 数据 data: 属性名 | 类型| 备注 ---|--- | --- count | Integer | 总数 data | list |数据 pageNo | Integer | 页码 limit | Integer | 限制数 data.data: 属性名 | 类型| 备注 ---|--- | --- repetionFriendId | Integer | 去重任务的id status | Integer | 任务处于的状态 adminUserId |Integer | 账号id repetionFriendNum | Integer | 重复好友数量 createTime | String | 创建时间 departStruct | String | 部门结构 repetionFriendUinVOS | list | 微信号详情 data.data.repetionFriendUinVOS: 属性名 | 类型| 备注 ---|--- | --- uin | String | uin headImgUrl |String | 头像链接 nickName | String | 个性昵称 | departId | Integer | 部门id ``` { "code": 200, "msg": "操作成功!", "data": { "count": 12, "data": [ { "repetionFriendId": 35, "status": 1, "adminUserId": 14, "repetionFriendNum": 57, "createTime": "2020-05-07 15:26:37", "repetionFriendUinVOS": [ { "uin": "1575045774", "headImgUrl": "http://wx.qlogo.cn/mmhead/ver_1/usSaGQ4wCY6892IYfUqecKHopsicHgIER5Dib5kP7wIUb5AIq369RicGHlLG8QBau9kkA2HNTjOxYFzbvqgbYvrBUicRjSWu4wQrFyW4d8TgWCM/0", "nickName": "你看那山花烂漫", "departId": null }, { "uin": "2245246006", "headImgUrl": "http://wx.qlogo.cn/mmhead/ver_1/QO4juXsibLFA1Fic1Ou52Kd2BRUwQxq5zGaGoxuf4YdmsG2GwLTsmjLiaVV0OibtjaB8yoibQ535niabLJnp2I1lP1weQSib1DUUUeYavw5VCic6PtY/0", "nickName": "undefine", "departId": null }, { "uin": "2368771701", "headImgUrl": "http://wx.qlogo.cn/mmhead/ver_1/JRmibsM00VpaVK8BoDcSsdmxr5aiaZXaVicyKLRjICoFymNfoCeGC3YqfNzAV9lacAUpY0LgeYficicv34vMKq7hkcIia0evUWyViaOzjBZ1598z5w/0", "nickName": "小争小吵小任性。", "departId": null } ] } ], "pageNo": 1, "limit": 1 } } 或 { { "code": 400, "msg": "limit不为空"/"pageNo不为空", "data": null } ``` ### 删除去重任务接口 - url: /wechat_api/repetionFriend/delete - 调用方式: post ##### 作用: 删除去重任务 ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- |---| --- ids | List | Y | 删除ID ``` [20] ``` ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | msg | String | data | {} | 数据 ``` { "code": 200, "msg": "刪除成功", "data": null } 或 { "code": 400, "msg": "删除任务必须在1到10以内", "data": null } ``` ### 删除去重任务详情接口 - url: /wechat_api/repetionFriendDetails/delete - 调用方式: post ##### 作用: 删除去重任务详情 ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- |---| --- ids | List | Y | 删除ID ``` [241,242] ``` ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | msg | String | data | {} | 数据 ``` { "code": 200, "msg": "刪除成功", "data": null } 或 { "code": 400, "msg": "删除任务必须在1到10以内", "data": null } ``` ##### 异步推送: 属性名 | 类型| 备注 ---|--- | --- MTYPE | String | 好友去重完成为: delReFriend content | Map | noticeMessage content adminUserId | Long | 用户Id content | String | 内容 msgCode | Integer | 提醒类型 好友去重完成为:4 isRead | Integer | 是否阅读 createTime | time | 创建时间 title | String | 标题 ### 查询任务详情列表(分页) - url: /wechat_api/repetionFriendDetails/userNamePage - 调用方式: get ##### 作用: 查询任务详情列表 ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- |---| --- limit | Integer | Y | 限制数 pageNo | Integer | Y | 页码 repetionFriendId | Integer | Y | 任务id ``` /userNamePage?limit=10&pageNo=1&repetionFriendId=24 ``` ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | msg | String | data | map | 数据 data: 属性名 | 类型| 备注 ---|--- | --- count | Integer | 总数 data | list |数据 pageNo | Integer | 页码 limit | Integer | 限制数 data.data 属性名 | 类型| 备注 ---|--- | --- nickName | String | 昵称 userName | String | userName count | Integer | 总数 headImgUrl | String | 头像 ``` { "code": 200, "msg": "操作成功!", "data": { "count": 35, "data": [ { "nickName": "st.c", "userName": "cc5200cc", “headImgUrl”:"" "count": 2 } ], "pageNo": 1, "limit": 1 } } 或 { { "code": 400, "msg": "limit不为空"/"pageNo不为空"/"repetionFriendId不能为空", "data": null } ``` ### 查询任务微信号详情列表(分页) - url: /wechat_api/repetionFriendDetails/page - 调用方式: get ##### 作用: 查询任务微信号详情列表 ##### 传参: 属性名 | 类型| 是否必要 | 备注 ---|--- |---| --- limit | Integer | Y | 限制数 pageNo | Integer | Y | 页码 repetionFriendId | Integer | Y | 任务id userName | String | Y | user_name ``` /page?limit=10&pageNo=1&repetionFriendId=24&userName=wxid_15s48dvw9f7s22 ``` ##### 出参: 属性名 | 类型| 备注 ---|--- | --- code | Integer | msg | String | data | map | 数据 data: 属性名 | 类型| 备注 ---|--- | --- count | Integer | 总数 data | list |数据 pageNo | Integer | 页码 limit | Integer | 限制数 data.data 属性名 | 类型| 备注 ---|--- | --- repetionFriendDetailId | Integer | uin | String | uin userName | String | userName nickName | String | 微信号昵称 remarkName | String | 备注 tags | String | 标签 customerNickName | String | 个性昵称 lastMessageTime | String | 最后回复时间 messageCount | String | 消息总数 addTime | String | 添加时间 status | Integer | 在线状态 0:不在线 1在线 wechatNickName | String | 微信号昵称 | ``` { "code": 200, "msg": "操作成功!", "data": { "count": 2, "data": [ { "repetionFriendDetailId": 480, "uin": "1575045774", "userName": "wxid_15s48dvw9f7s22", "nickName": "小争小吵小任性。", "remarkName": "小琳", "tags": null, "customerNickName": "小琳", "messageCount": "0", "lastMessageTime": null, "addTime": null }, { "repetionFriendDetailId": 515, "uin": "2245246006", "userName": "wxid_15s48dvw9f7s22", "nickName": "小争小吵小任性。", "remarkName": "小琳222", "tags": null, "customerNickName": null, "messageCount": "0", "lastMessageTime": null, "addTime": "2020-04-27 17:37:37.0" } ], "pageNo": 1, "limit": 10 } } 或 { { "code": 400, "msg": "limit不为空"/"pageNo不为空"/"repetionFriendId不能为空"/"userName不能为空", "data": null } ```