基于ipad协议的gewe框架进行微信群组管理（二）

友情链接  geweapi.com 点击访问即可。

 

获取群组详情

小提示：

• 该接口可以一次查询20个群组
• 查询出来的信息是不带公告的

请求URL：

• http://域名地址/api/group/detail

请求方式：

• POST

请求头：

• Content-Type：application/json

• X-GEWE-TOKEN: 后台获取

参数：

参数名	必填	数据类型	说明
appid	是	string	设备id
group_id_list	是	array	群id

返回数据：

参数名	数据类型	说明
ret	number	0：成功
msg	string	反馈信息

请求参数示例：

   {
       "appid": "wx_nScLwnZhfNmlQlL0npc71",
       "group_id_list": [
           "18890011481@chatroom",
       ]
   }

成功返回示例：

    {
        "ret": 0,
        "msg": "success",
        "data": {
            "ContactCount": 1,
            "ContactList": [
                {
                    "UserName": {
                        "string": "34876481524@chatroom"    #群id
                    },
                    "NickName": {},     #群名称
                    "Pyinitial": {},    #群名称拼音缩写
                    "QuanPin": {},      #群名称拼音全写
                    "ChatRoomNotify": 1,    #群通知
                    "ChatRoomOwner": "wxid_p3r6ddddvqcl22",     #群主
                    "SmallHeadImgUrl": "https://wx.qlogo.cn/mmcrhead/9M0PhLTmTIfS3uZuXib55mfHBkWMpuzOhFQzWpSaAb5GUvhtJeG2LETarGFSfgUHvicVrMj3w2eic9SAOvdgDhPC538ZFo1hNTc/0",    #群头像
                    "CustomizedInfo": {
                        "BrandFlag": 0
                    },
                    "ChatroomMaxCount": 500,    #群成员最大人数
                    "ChatroomAccessType": 0,
                    "NewChatroomData": {    #群组详情
                        "MemberCount": 2,   #群成员人数
                        "ChatRoomMember": [     #群成员详情
                            {
                                "UserName": "wxid_vr2kwrzbg0q622",  #群成员wxid
                                "NickName": "尤某人",   #群成员昵称
                                "ChatroomMemberFlag": 2049,
                                "InviterUserName": "wxid_p3r6ddddvqcl22"    #邀请人wxid
                            },
                            {
                                "UserName": "wxid_p3r6ddddvqcl22",
                                "NickName": "Z💭",
                                "ChatroomMemberFlag": 1
                            }
                        ],
                    },
                }
            ],
            "Ret": [
                0
            ],
            "Ticket": [
                {}
            ]
        }
    }

错误返回示例：

    {
        "ret": -1,
        "msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
    }

解散群组

小提示：

• 该接口需要管理员操作权限
• 非管理员权限无法操作

请求URL：

• http://域名地址/api/group/dismiss

请求方式：

• POST

请求头：

• Content-Type：application/json

• X-GEWE-TOKEN: 后台获取

参数：

参数名	必填	数据类型	说明
appid	是	string	设备id
group_id	是	string	群id

返回数据：

参数名	数据类型	说明
ret	number	0：成功
msg	string	反馈信息
data	object

请求参数示例：

   {
       "appid": "wx_nScLwnZhfNmlQlL0npc71",
       "group_id": "34876481524@chatroom",
   }

成功返回示例：

   {
        "ret": 0,
        "msg": "success",
        "data": {
            "baseResponse": {
                "ret": 0,
                "errMsg": {}
            }
        }
    }

错误返回示例：

    {
        "ret": -1,
        "msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
    }

获取群组二维码

小提示：

• 获取的群组二维码可以让其他联系人扫码进群
• 支持企业群组

请求URL：

• http://域名地址/api/group/getqrcode

请求方式：

• POST

请求头：

• Content-Type：application/json

• X-GEWE-TOKEN: 后台获取

参数：

参数名	必填	数据类型	说明
appid	是	string	设备id
group_id	是	string	群id

返回数据：

参数名	数据类型	说明
ret	number	0：成功
msg	string	反馈信息
data	object
data.qrcode	buffer	群二维码base64数据

请求参数示例：

   {
       "appid": "wxid_p3r6ddddvqcl22",
       "group_id": "34876481524@chatroom",
   }

成功返回示例：

    {
    "ret": 0,
    "msg": "success",
    "data": {
        "BaseResponse": {
            "ret": 0,
            "errMsg": {}
        },
        "qrcode": {
            "iLen": 4981,
            "buffer": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgK//2Q=="   
        },
        "revokeQrcodeWording": "该二维码7天内(7月28日前)有效，重新进入将更新"
    }
}

错误返回示例：

    {
        "ret": -1,
        "msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
    }

扫码进群

小提示：

• 用于操作扫码进群、扫描二维码等操作。
• 请先阅读文档

请求URL：

• http://域名地址/api/other/scaninroom

请求方式：

• POST

请求头：

• Content-Type：application/json

参数：

参数名称	数据类型	必填	说明
appid	string	是	设备id
config	string	是	二维码解析链接

返回数据：

参数名	数据类型	说明
ret	number	0：成功
msg	string	反馈信息
data	object

请求参数示例：

   {
       "appid": "wxid_p3r6ddddvqcl22",
       "config": "https://weixin.qq.com/g/AwYAALBQzXiBqrkUA6GzjbE4W-rfdXIduhjyg_I-UGTvo-gazUDDbJU9hUGGstZQ",
   }

成功返回示例：

  {
    "ret": 0,
    "msg": "success",
    "data": {
      "ret": 0,
      "oplogRet": {
        "count": 1,
        "ret": "AA=="
      }
    }
  }

错误返回示例：

  {
    "ret": -1,
    "msg": "fail",
    "msg_err": "地址读取失败,请重新尝试"
  }

同意进群组

小提示：

• 同意进入联系人邀请的群组
• 注意不要频繁进入群组,避免风控

请求URL：

• http://域名地址/api/group/goin

请求方式：

• POST

请求头：

• Content-Type：application/json

• X-GEWE-TOKEN: 后台获取

参数：

参数名	必填	数据类型	说明
appid	是	string	设备id
url	是	string	邀请进群链接（解析回调消息获取）

返回数据：

参数名	数据类型	说明
ret	number	0：成功
msg	string	反馈信息
data	object

请求参数示例：

   {
       "appid": "wxid_p3r6ddddvqcl22",
       "url": "https://support.weixin.qq.com/cgi-bin/mmsupport-bin/addchatroombyinvite?ticket=AenMdVYiWiXApTjH7nKGRQ%3D%3D",
   }

成功返回示例：

 {
	"ret": 0,
	"msg": "success",
	"data": {
		"ret": 0,
		"oplogRet": {
			"count": 1,
			"ret": "AA=="
		}
	}
}

错误返回示例：

  {
    "ret": -1,
    "msg": "fail",
    "msg_err": "Post \"http:\": http: no Host in request URL"
  }

获取群组信息详情

小提示：

• 不支持批量查询
• 注意本接口查询出来的信息带公告内容

请求URL：

• http://域名地址/api/group/infodetail

请求方式：

• POST

请求头：

• Content-Type：application/json

• X-GEWE-TOKEN: 后台获取

参数：

参数名	必填	数据类型	说明
appid	是	string	设备id
group_id	是	string	群id

返回数据：

参数名	数据类型	说明
ret	number	0：成功
msg	string	反馈信息
data	object
data.Announcement	string	群公告内容
data.AnnouncementPublishTime	string	群公告发布时间
data.AnnouncementEditor	string	群主wxid

请求参数示例：

   {
       "appid": "wxid_p3r6ddddvqcl22",
       "group_id": "34876481524@chatroom",
   }

成功返回示例：

    {
        "ret": 0,
        "msg": "success",
        "data": {
            "BaseResponse": {
                "ret": 0,
                "errMsg": {}
            },
            "Announcement": "测试",
            "ChatRoomInfoVersion": 13,
            "AnnouncementEditor": "wxid_p3r6ddddvqcl22",
            "AnnouncementPublishTime": 1689909184,
            "ChatRoomStatus": -2146959356,
            "ChatRoomBusinessType": 0,
            "RoomTools": {
                "RoomToolsWxAppCount": 0
            }
        }
    }

错误返回示例：

    {
        "ret": -1,
        "msg": "fail",
        "msg_err": "A8K地址读取失败,请重新尝试"
    }