友情鏈接：GEWE框架官網? geweapi.com? 點擊訪問即可。

邀請或添加聯系人進群

小提示：

• 不管是添加40人以內還是以上都用此接口
• cause填寫邀請進群的理由

請求URL：

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

請求方式：

• 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：

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

請求方式：

• 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：

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

請求方式：

• 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：

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

請求方式：

• 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：

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

請求方式：

• 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：

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

請求方式：

• 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}}]設備不存在或已離線"}