Friendship link: geweapi.com Click to visit.
Administrator operation
hint:
- add, delete, transfer
- When multiple wxids are limited to adding/deleting administrators, 1 is added, 2 is deleted, and 3 is transferred
Request URL:
- http://domain name address/api/group/admin
Request method:
- POST
Request header:
-
Content-Type:application/json
-
X-GEWE-TOKEN: background acquisition
parameter:
parameter name | required | type of data | illustrate |
---|---|---|---|
appid | yes | string | device id |
group_id | yes | string | group id |
to_wxid_list | yes | array | Admin wxid |
value | yes | number | 1 Add 2 Delete 3 Transfer |
return data:
parameter name | type of data | illustrate |
---|---|---|
ret | number | 0: success |
msg | string | Feedback |
data | object |
Example request parameters:
{
"appid": "wx_nScLwnZhfNmlQlL0npc71",
"group_id": "34876481524@chatroom",
"to_wxid_list": [
"wxid_vr2kwrzbg0q622"
],
"value": 1,
}
Example of successful return:
{
"ret": 0,
"msg": "success",
"data": {
"BaseResponse": {
"ret": 0,
"errMsg": {
"string": ""
}
}
}
}
Example error return:
{
"ret": -1,
"msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
}
Invite into the group to apply for confirmation
hint:
- This interface is for administrators only
- Pay attention to parameters
Request URL:
- http://domain address/api/group/approvedaddchatroommember
Request method:
- POST
Request header:
-
Content-Type:application/json
-
X-GEWE-TOKEN: background acquisition
parameter:
parameter name | required | type of data | illustrate |
---|---|---|---|
appid | yes | string | device id |
group_id | yes | string | group id |
inviterWxid | yes | string | inviter wxid |
msgid | yes | number | message id |
ticket | yes | string | Application id (obtained by parsing the callback message) |
to_wxid_list | yes | array | Invitee wxid |
return data:
parameter name | type of data | illustrate |
---|---|---|
ret | number | 0: success |
msg | string | Feedback |
data | object |
Example request parameters:
{
"appid": "wx_nScLwnZhfNmlQlL0npc71",
"group_id": "34876481524@chatroom",
"inviterWxid": "wxid_p3r6ddddvqcl22",
"msgid": 1181540864,
"ticket": "AQAAAAEAAADIt9/NvtLHpCv0deeWnhAd7ilM+5i9aNpli+BDt67wfJCMktyGHwFPI3vdJGtemWZc7xurQnuB94jarnrAyFZk8wwkuA==",
"to_wxid_list": [
"wxid_zchk2n3lkccl22"
],
}
Example of successful return:
{
"ret": 0,
"msg": "success",
"data": {
"BaseResponse": {
"ret": 0,
"errMsg": {
"string": ""
}
}
}
}
Example error return:
{
"ret": -1,
"msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
}
create group
hint:
- Note: Create a group now only within 10 people do not need invitation confirmation
- At least two contacts are required
Request URL:
- http://domain name address/api/group/create
Request method:
- POST
Request header:
-
Content-Type:application/json
-
X-GEWE-TOKEN: background acquisition
parameter:
parameter name | required | type of data | illustrate |
---|---|---|---|
appid | yes | string | device id |
to_wxid_list | yes | array | Contact wxid, fill in at least two |
return data:
parameter name | type of data | illustrate |
---|---|---|
ret | number | 0: success |
msg | string | Feedback |
data | object | |
data.ChatRoomName | number | group wxid |
data.MemberCount | number | Number of group members |
data.MemberList | number | group member list |
data.MemberList.MemberName | string | group member wxid |
data.MemberList.NickName | string | Group member nickname |
data.MemberList.Remark | string | Remarks for group members |
data.MemberList.City | string | City |
Example request parameters:
{
"appid": "wx_nScLwnZhfNmlQlL0npc71",
"to_wxid_list": [
"wxid_vr2kwrzbg0q622",
"wxid_4bxxxxxxxxxxx22"
]
}
Example of successful return:
{
"ret": 0,
"msg": "success",
"data": {
"MemberCount": 2,
"MemberLis": [
{
"MemberName": {
"string": "wxid_vr2kwrzbg0q622"
},
"MemberStatus": 0,
"NickName": {
"string": "尤某人"
},
"PYInitial": {
"string": "YMR"
},
"QuanPin": {
"string": "youmouren"
},
"Sex": 1,
"Remark": {
"string": "尤敦帅"
},
"ContactType": 0,
"Province": "Jiangsu",
"City": "Xuzhou",
"Signature": "伴火同进者,终有一天会遇见命定之死!",
"PersonalCard": 1,
"VerifyFlag": 0,
"Country": "CN"
},
{
"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"
}
],
"ChatRoomName": {
"string": "34876481524@chatroom"
},
}
}
Example error return:
{
"ret": -1,
"msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
}
remove group members
A brief description:
- commonly known as kicking
Request URL:
- http://domain name address/api/group/delmember
Request method:
- POST
Request header:
-
Content-Type:application/json
-
X-GEWE-TOKEN: background acquisition
parameter:
parameter name | required | type of data | illustrate |
---|---|---|---|
appid | yes | string | device id |
group_id | yes | string | group id |
to_wxid_list | yes | array | group member wxid |
return data:
parameter name | type of data | illustrate |
---|---|---|
ret | number | 0: success |
msg | string | Feedback |
data | object | |
data.MemberCount | number | The number of deleted group members |
data.MemberList | number | List of deleted group members |
data.MemberList.MemberName | number | Deleted group member wxid |
Example request parameters:
{
"appid": "wx_nScLwnZhfNmlQlL0npc71",
"group_id": "34876481524@chatroom",
"to_wxid_list": [
"wxid_4bxxxxxxxxxxx22",
]
}
Example of successful return:
{
"ret": 0,
"msg": "success",
"data": {
"baseResponse": {
"ret": 0,
"errMsg": {}
},
"MemberCount": 1,
"MemberList": [
{
"MemberName": {
"string": "wxid_4bxxxxxxxxxxx22"
}
}
]
}
}
Example error return:
{
"ret": -1,
"msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
}