Gewechat

获取群/好友详细信息

POST

/contacts/getDetailInfo

请求参数

Header 参数

X-GEWE-TOKEN

string

必需

示例值:

Body 参数application/json

appId

string

设备ID

必需

wxids

array[string]

好友的wxid

必需

>= 1 items<= 20 items

示例

{
  "appId": "{{appid}}",
  "wxids": [
    "yc-081726"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/contacts/getDetailInfo' \
--header 'X-GEWE-TOKEN: {{gewe-token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appId": "{{appid}}",
    "wxids": [
        "yc-081726"
    ]
}'

返回响应

🟢200成功

application/json

Body

ret

integer

必需

msg

string

必需

data

array [object {20}]

必需

userName

string

好友的wxid

可选

nickName

string

好友的昵称

可选

pyInitial

null

可选

好友昵称的拼音首字母

quanPin

string

好友昵称的全拼

可选

sex

integer

好友的性别

可选

remark

null

好友备注

可选

remarkPyInitial

null

可选

好友备注的拼音首字母

remarkQuanPin

null

好友备注的全拼

可选

signature

string

好友的签名

可选

alias

string

好友的微信号

可选

snsBgImg

string

朋友圈背景图链接

可选

country

string

国家

可选

bigHeadImgUrl

string

大尺寸头像链接

可选

smallHeadImgUrl

string

小尺寸头像链接

可选

description

null

好友的描述

可选

cardImgUrl

null

好友描述的图片链接

可选

labelList

null

好友的标签ID

可选

province

null

省份

可选

city

null

城市

可选

phoneNumList

null

好友的手机号码

可选

示例

{
  "ret": 200,
  "msg": "获取联系人信息成功",
  "data": [
    {
      "userName": "wxid_phyyedw9xap22",
      "nickName": "Ashley",
      "pyInitial": null,
      "quanPin": "Ashley",
      "sex": 2,
      "remark": null,
      "remarkPyInitial": null,
      "remarkQuanPin": null,
      "signature": "山林不向四季起誓 枯荣随缘。",
      "alias": "zero-one_200906",
      "snsBgImg": "http://shmmsns.qpic.cn/mmsns/UaAfqYic92wm7ZCrsEwlQMXSmBLs8dpwBzrXnrOyyP3B8bDibCCFInJ9PicC9LPYY17uWH1yIOmBYQ/0",
      "country": "AD",
      "bigHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/buiaXybHTBK3BuGr1edN72zBDermWVFJ7YC8Jib2RcCSdiauAtZcPgUQpdhE9KY5NsumDAWD16fsg3A6OKuhdEr97VAHdTGgk6R1Eibuj7ZNwJ4/0",
      "smallHeadImgUrl": "https://wx.qlogo.cn/mmhead/ver_1/buiaXybHTBK3BuGr1edN72zBDermWVFJ7YC8Jib2RcCSdiauAtZcPgUQpdhE9KY5NsumDAWD16fsg3A6OKuhdEr97VAHdTGgk6R1Eibuj7ZNwJ4/132",
      "description": null,
      "cardImgUrl": null,
      "labelList": null,
      "province": null,
      "city": null,
      "phoneNumList": null
    }
  ]
}

修改于 2024-07-23 06:42:10

获取群/好友简要信息

设置好友仅聊天