GEWE framework friendly link: geweapi.com Click to visit.
Contact/Group List
hint:
- Note that the group needs to save the address book to display
Request URL:
- http://domain address/api/contacts/listings
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 |
current_chat_room_contact_seq | yes | number | By default, 0 is passed for the first time, and then the current_chat_room_contact_seq returned last time is passed |
current_wxcontact_seq | yes | number | By default, 0 is passed for the first time, and then the current_wxcontact_seq returned last time is passed |
return data:
parameter name | type of data | illustrate |
---|---|---|
ret | number | 0: success |
msg | string | Feedback |
data | object | |
data.ContactUsernameList | object | Contact information list (the beginning of gh represents the official account chatroom and the end represents group chat, and the rest are contacts) |
Example request parameters:
{
"appid": "wx_nScLwnZhfNmlQlL0npc71",
"current_chat_room_contact_seq": 0,
"current_wxcontact_seq": 802070105
}
Example of successful return:
{
"ret": 0,
"msg": "success",
"data": {
"BaseResponse": {
"ret": 0,
"errMsg": {
"string": ""
}
},
"CurrentWxcontactSeq": 706991681,
"CurrentChatRoomContactSeq": 706988914,
"CountinueFlag": 0,
"ContactUsernameList": [
"gh_3dfda90e39d6",
"wxid_oh1x6dthgu4h22",
"weixinhao",
"47482870178@chatroom"
]
}
}
Example error return:
{
"ret": -1,
"msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
}
Contact Relationship Detection
hint:
- Query whether the relationship with a contact is normal
- Note that you can query up to 20 contacts each time
Request URL:
- http://domain address/api/contacts/check
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 | user wxid |
return data:
parameter name | type of data | illustrate |
---|---|---|
ret | number | 0: success |
msg | string | Feedback |
data | object |
Example request parameters:
{
"appid": "wx_nScLwnZhfNmlQlL0npc71",
"to_wxid_list": [
"wxid_4bxxxxxxxxxxx22"
]
}
Example of successful return:
{
"ret": 0,
"msg": "success",
"data": {
"result": [
{
"to_wxid": "wxid_4bxxxxxxxxxxx22",
"state": "正常关系"
}
]
}
}
Example error return:
{
"ret": -1,
"msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
}
delete contact
hint:
- delete a contact
- Note that there is a limit to delete contacts per day
Request URL:
- http://domain name address/api/contacts/delete
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 | yes | string | user wxid |
return data:
parameter name | type of data | illustrate |
---|---|---|
ret | number | 0: success |
msg | string | Feedback |
data | object |
Example request parameters:
{
"appid": "wx_nScLwnZhfNmlQlL0npc71",
"to_wxid": "wxid_4bxxxxxxxxxxx22",
}
Example of successful return:
{
"ret": 0,
"msg": "success",
"data": {
"ret": 0,
"oplogRet": {
"count": 1,
"ret": "AA=="
}
}
}
Example error return:
{
"ret": -1,
"msg_err": "[wx_bpPSNW0kK0xYSM6ldubd]设备不存在或已离线"
}