Gewechat

搜索好友

POST

/contacts/search

搜索的联系人信息若已经是好友，响应结果的v3则为好友的wxid
本接口返回的数据可通过添加联系人接口发送添加好友请求

请求参数

Header 参数

X-GEWE-TOKEN

string

必需

示例值:

Body 参数application/json

appId

string

设备ID

必需

contactsInfo

string

必需

搜索的联系人信息，微信号、手机号...

示例

{
  "appId": "{{appid}}",
  "contactsInfo": "zhangch"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/contacts/search' \
--header 'X-GEWE-TOKEN: {{gewe-token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "{{appid}}",
    "contactsInfo": "zhangch"
}'

返回响应

🟢200成功

application/json

Body

ret

integer

必需

msg

string

必需

data

object

必需

string

必需

搜索好友的v3，添加好友时使用

nickName

string

搜索好友的昵称

必需

sex

integer

搜索好友的性别

必需

signature

null

搜索好友的签名

必需

bigHeadImgUrl

string

必需

搜索好友的大尺寸头像

smallHeadImgUrl

string

必需

搜索好友的小尺寸头像

string

必需

搜索好友的v4，添加好友时使用

示例

成功示例异常示例

{
  "ret": 200,
  "msg": "操作成功",
  "data": {
    "v3": "v3_020b3826fd030100000000006c20217514f7f2000000501ea9a3dba12f95f6b60a0536a1adb690dcccc9bf58cc80765e6eb16bc2678a36a0ed264e1b22596f787de6acc71a4beb20b69ab88bfd6d71aa1858b3@stranger",
    "nickName": "zhang",
    "sex": 1,
    "signature": "学习、成长、锻炼",
    "bigHeadImgUrl": "http://wx.qlogo.cn/mmhead/ver_1/yoYJGtDmGicz9QGOFRb71Ns6onQO63bnfJibicBwEmO73m18N7BicrGzeYsdxOrUf5qwJq9mMaQbDwEBA92uPOuibZg/0",
    "smallHeadImgUrl": "http://wx.qlogo.cn/mmhead/ver_1/yoYJGtDmGicz9QGOFRb71Ns6onQO63bnfJibicBwEmO73m18N7BicrGzeYsdxOrUf5qwJq9mMaQbDwEBA92uPOuibZg/132",
    "v4": "v4_000b708f0b04000001000000000056d3690365e0eefe00ef467a8e651000000050ded0b020927e3c97896a09d47e6e9ec65e1f9d32b06f86df4790587a6308149b3c8a90185e824efccd5b41bd75f6240ab020f9dd4b5915a083c6784a5cfcb806f53ca340b4c95b24f474d6e3fc0661301b3b3b741aac3eb5@stranger"
  }
}

修改于 2024-07-23 07:59:06

获取通讯录列表缓存

添加联系人/同意添加好友