使用GEWE框架进行微信群组管理（三）

iPad协议个微协议2023-08-12 16:57

友情链接：GEWE框架官网 geweapi.com 点击访问即可。

邀请或添加联系人进群

小提示：

  • 不管是添加40人以内还是以上都用此接口
  • cause填写邀请进群的理由

请求URL：

请求方式：

  • POST

请求头：

  • Content-Type：application/json

  • X-GEWE-TOKEN: 后台获取

参数：

参数名 必填 数据类型 说明
appid 是 string 设备id
group_id 是 string 群id
cause 是 string 邀请进群的理由
to_wxid 是 array 被邀请人wxid

返回数据：

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

请求参数示例：

   {
       "appid": "wxid_p3r6ddddvqcl22",
       "cause": "通过一下",
       "group_id": "34876481524@chatroom",
       "to_wxid": [
           "wxid_phyyedw9xap22"
       ]
   }

成功返回示例：

    {
        "ret": 0,
        "msg": "success",
        "data": {
            "baseResponse": {
                "ret": 0,
                "errMsg": {
                    "string": "Everything is OK"
                }
            },
            "MemberCount": 1,   #被邀请人数量
            "MemberList": [     #被邀请人详情
                {
                    "MemberName": {
                        "string": "wxid_4bxxxxxxxxxxx22"
                    },
                    "MemberStatus": 0,
                    "NickName": {   #昵称
                        "string": "xahya"
                    },
                    "PYInitial": {  
                        "string": "XAHYA"
                    },
                    "QuanPin": {
                        "string": "xahya"
                    },
                    "Sex": 1,   #性别
                    "Remark": {
                        "string": "xahya"   #群里的昵称
                    },
                    "RemarkPyinitial": {
                        "string": "XAHYA"
                    },
                    "RemarkQuanPin": {
                        "string": "xahya"
                    },
                    "ContactType": 0,
                    "Province": "Jiangsu",  #省份
                    "City": "Xuzhou",   #城市
                    "Signature": "123",     #个性签名
                    "PersonalCard": 1,  #个人名片
                    "VerifyFlag": 0,
                    "Country": "CN"
                }
            ]
        }
    }

错误返回示例：

    {
        "ret": 0,
        "msg": "success",
        "data": {
            "baseResponse": {
                "ret": -2,
                "errMsg": {
                    "string": "<e>\n<ShowType>1</ShowType>\n<Content><![CDATA[添加参与人失败]]></Content>\n<Url><![CDATA[]]></Url>\n<DispSec>30</DispSec>\n<Title><![CDATA[]]></Title>\n<Action>4</Action>\n<DelayConnSec>0</DelayConnSec>\n<Countdown>0</Countdown>\n<Ok><![CDATA[]]></Ok>\n<Cancel><![CDATA[]]></Cancel>\n<Icon>0</Icon>\n</e>\n"
                }
            },
            "MemberCount": 0
        }
    }

获取群组成员信息

小提示：

  • 支持企微群
  • 查询出来的信息可能存在偏差

请求URL：

请求方式：

  • POST

请求头：

  • Content-Type：application/json

  • X-GEWE-TOKEN: 后台获取

参数：

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

返回数据：

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

请求参数示例：

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

成功返回示例：

    {
        "ret": 0,
        "msg": "success",
        "data": {
            "BaseResponse": {
                "ret": 0,
                "errMsg": {}
            },
            "ChatroomUserName": "34876481524@chatroom",     #群wxid
            "ServerVersion": 700000008,
            "NewChatroomData": {    #群成员信息
                "MemberCount": 3,   #群成员人数
                "ChatRoomMember": [
                    {
                        "UserName": "wxid_vr2kwrzbg0q622",    #微信号
                        "NickName": "尤某人",   #昵称
                        "BigHeadImgUrl": "https://wx.qlppaz9QKlFfsjzQ/0",   #大号头像
                        "SmallHeadImgUrl": "https://wx.qlogo.cn/mzQ/132",   #小号头像
                        "ChatroomMemberFlag": 2049,
                        "InviterUserName": "wxid_p3r6ddddvqcl22" 邀请人wxid
                    },
                    {
                        "UserName": "wxid_p3r6ddddvqcl22",
                        "NickName": "Z💭",
                        "BigHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/pBuLcF8bHgbiaSQozgotYOSfgOBpgpD0WQPDTt7iaox7Cga7ibvfqYxnbpGoCkicicPRYEiaI3esA9ZJ8xiceMHZ1qNkhIYm9c3uI2JDiaeuZKXqGxQ/0",
                        "SmallHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/pBuLcF8bHgbiaSQozgotYOSfgOBpgpD0WQPDTt7iaox7Cga7ibvfqYxnbpGoCkicicPRYEiaI3esA9ZJ8xiceMHZ1qNkhIYm9c3uI2JDiaeuZKXqGxQ/132",
                        "ChatroomMemberFlag": 1
                    },
                    {
                        "UserName": "wxid_4bxxxxxxxxxxx22",
                        "NickName": "xahya",
                        "BigHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/GvJjOhWuoibaPk2wuib8UuFYPdRgdTFKXh1gUvVts5UrWGmmew8iccBGymJibm1ydlGBSZ3orWkrf56fbWAH3Ds5XN2t1dUG11DQQtEEGSqdvkM/0",
                        "SmallHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/GvJjOhWuoibaPk2wuib8UuFYPdRgdTFKXh1gUvVts5UrWGmmew8iccBGymJibm1ydlGBSZ3orWkrf56fbWAH3Ds5XN2t1dUG11DQQtEEGSqdvkM/132",
                        "ChatroomMemberFlag": 1,
                        "InviterUserName": "wxid_p3r6ddddvqcl22"
                    }
                ],
            }
        }
    }

错误返回示例：

    {
        "ret": 0,
        "msg": "success",
        "data": {
            "BaseResponse": {
                "ret": -2,
                "errMsg": {
                    "string": ""
                }
            }
        }
    }

保存到通讯录

小提示：

  • 将群组保存到通讯录,方便下次能从通讯录中获取

请求URL：

请求方式：

  • POST

请求头：

  • Content-Type：application/json

  • X-GEWE-TOKEN: 后台获取

参数：

参数名 必填 数据类型 说明
appid 是 string 设备id
group_id 是 string 群id
value 是 number 3添加 2移除

返回数据：

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

请求参数示例：

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

成功返回示例：

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

错误返回示例：

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

一键添加群组联系人

小提示：

  • 注意不要频繁添加
  • 注意内容,避免风控

请求URL：

请求方式：

  • POST

请求头：

  • Content-Type：application/json

  • X-GEWE-TOKEN: 后台获取

参数：

参数名 必填 数据类型 说明
appid 是 string 设备id
content 是 string 添加好友验证信息
group_id 是 string 群id
to_wxid 是 string 群用户wxid

返回数据：

参数名 数据类型 说明
ret number 0：成功
msg string 反馈信息
data object
data.v1 string 好友凭证

请求参数示例：

   {
       "appid": "wxid_p3r6ddddvqcl22",
       "content": "jj",
       "group_id": "34876481524@chatroom",
       "to_wxid": "wxid_4bxxxxxxxxxxx22"
   }

成功返回示例：

  {
    "ret": 0,
    "msg": "success",
    "data": {
        "BaseResponse": {
            "ret": 0,
            "errMsg": {}
        },
        "v1": "v3_020b3826fd030100000000004f7920779e51ed000000501ea9a3dba12f95f6b60a0536a1adb6ab682894369b025a10e371ac2d27b824de65d74f5c0cf2708093d87013902b40a661568c0d2e0043e9308ffd3ab9ab63caa45065152775b510e30df23d@stranger"
    }
  }

错误返回示例：

    {
    "ret": -1,
    "msg": "fail",
    "msg_err": "无法正常获取[Ticket]请检查要添加的群组成员是否已存在好友关系",
    "data": null
}

查询群成员信息

小提示：

  • 返回的信息和查询联系人信息基本一致
  • 每次查询不得超过20位群成员

请求URL：

请求方式：

  • POST

请求头：

  • Content-Type：application/json

  • X-GEWE-TOKEN: 后台获取

参数：

参数名 必填 数据类型 说明
appid 是 string 设备id
content 是 string 添加好友验证信息
group_id 是 string 群id
to_wxid_list 是 array 群成员的wxid

返回数据：

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

请求参数示例：

   {
       "appid": "wxid_p3r6ddddvqcl22",
       "group_id": "34876481524@chatroom",
       "to_wxid_list": [
           "wxid_4bxxxxxxxxxxx22"
       ]
   }

成功返回示例：

    {
        "ret": 0,
        "msg": "success",
        "data": {
            "BaseResponse": {
                "ret": 0,
                "errMsg": {}
            },
            "ContactCount": 1,  #群成员数量
            "ContactList": [    #群成员信息列表
                {
                    "UserName": {   #群成员wxid
                        "string": "wxid_4bxxxxxxxxxxx22"
                    },
                    "NickName": {   #群成员昵称
                        "string": "xahya"
                    },
                    "Pyinitial": {  #群成员昵称拼音大写
                        "string": "XAHYA"
                    },
                    "QuanPin": {      #群成员昵称全拼
                        "string": "xahya"
                    },
                    "Sex": 1,   #性别
                    "ImgBuf": {
                        "iLen": 0
                    },
                    "Remark": {},   群里的昵称
                    "ContactType": 0,
                    "Province": "Jiangsu",  #省份
                    "City": "Xuzhou",   #城市
                    "Signature": "123", #个性签名
                    "Alias": "_xahya",  #微信号
                    "BigHeadImgUrl": "https://fA0rWibpibG2WNjPrOTE/0",  #大号头像
                    "SmallHeadImgUrl": "https://wx.qlogNTE/132",    #小号头像
                    "NewChatroomData": {
                        "MemberCount": 1,
                        "ChatRoomMember": [
                            {
                                "UserName": "wxid_4bxxxxxxxxxxx22",
                                "ChatroomMemberFlag": 0,
                                "InviterUserName": "wxid_p3r6ddddvqcl22"  #邀请人wxid
                            }
                        ],
                    },
                    "ChatroomStatus": 0,
                    "textStatusFlag": 2,
                }
            ],
            "Ret": [
                0
            ],
            "Ticket": [
                {}
            ]
        }
    }

错误返回示例：

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

设置群组公告

小提示：

  • 默认会@群组全员
  • 注意内容,避免风控

请求URL：

请求方式：

  • POST

请求头：

  • Content-Type：application/json

  • X-GEWE-TOKEN: 后台获取

参数：

参数名 必填 数据类型 说明
appid 是 string 设备id
content 是 string 添加好友验证信息
group_id 是 string 群id

返回数据：

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

请求参数示例：

   {
       "appid": "wxid_p3r6ddddvqcl22",
       "content": "设置群公告",
       "group_id": "34876481524@chatroom",
   }

成功返回示例：

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

错误返回示例：

    {
        "ret": -1,
        "msg_err": "[{{appidd}}]设备不存在或已离线"
    }
相关推荐
2401_8459375314 小时前
PHP一键约课高效健身智能健身管理系统小程序源码
微信·微信小程序·小程序·微信公众平台·微信开放平台
CHEtuzki15 小时前
微信这样回复客户高效又方便
微信·自动回复
2401_856654512 天前
员工疯狂打CALL！解锁企业微信新玩法，2024年必学秘籍来啦！
安全·微服务·微信·电脑·企业微信
龙哥·三年风水2 天前
微信支付开发-前端api实现
微信·php·支付系统
鲸天千流4 天前
鲸天科技外卖会员卡系统更专业
网络·科技·微信·小程序
2401_845937534 天前
PHP即刻送达同城派送小程序系统
微信·微信小程序·小程序·微信公众平台·微信开放平台
2401_845936455 天前
PHP一键约课高效健身智能健身管理系统小程序源码
微信·微信小程序·小程序·微信公众平台·微信开放平台
2401_845936145 天前
PHP即刻送达同城派送小程序系统
微信·微信小程序·小程序·微信公众平台·微信开放平台
2401_844139035 天前
PHP全程可视化防伪溯源一体化管理系统小程序源码
微信·微信小程序·小程序·微信公众平台·微信开放平台·防伪溯源一体化
2401_844137955 天前
PHP悦读随行一键借阅图书小程序
微信·微信小程序·小程序·微信公众平台·微信开放平台·图书馆借阅小程序
热门推荐
01RAG 实践- Ollama+RagFlow 部署本地知识库02组基轨迹建模 GBTM的介绍与实现（Stata 或 R）032024年高教社杯数学建模国赛C题超详细解题思路分析04苍穹外卖面试总结05yolov8实战第五天——yolov8+ffmpg实时视频流检测并进行实时推流——（推流，保姆教学）06【2024数模国赛赛题思路公开】国赛B题思路丨附可运行代码丨无偿自提07Coze扣子平台完整体验和实践（附国内和国际版对比）08CCF-CSP认证考试 202406-3 文本分词 100分题解09【2024高教社杯全国大学生数学建模竞赛】B题 生产过程中的决策问题——解题思路 代码 论文10借助 LocatorJS ，快速定位本地代码