获取手机通讯录

GeHub 接入说明（Token、节点和幂等要求）

X-GEHUB-TOKEN 请在后台「客户端」创建或重置凭据后复制（不是 Client Secret 本身），仅通过 HTTPS 发送。节点由客户端默认绑定决定，appId 为兼容占位，不用于选择节点。写操作必须提供新的 Idempotency-Key（8–128 位字母、数字、点、下划线、冒号或短横线）；同一操作重试必须复用原值。危险操作另需 X-Confirm-Risk: destructive。首次微信登录和回调配置请在后台完成。客户端需启用对应模块权限。

POST

/gehub/v2/api/contacts/getPhoneAddressList

请求参数

Header 参数

X-GEHUB-TOKEN

string

必需

示例:

Body 参数application/json

appId

string

兼容占位，可省略；按客户端绑定选择节点

phones

array[string]

可选

获取哪些手机号的好友详情，不传获取所有

示例

{
    "appId": "{{appid}}",
    "phones": []
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://wxapi.xiaoyu.fan/gehub/v2/api/contacts/getPhoneAddressList' \
--header 'X-GEHUB-TOKEN: {{gehub-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "appId": "",
    "phones": []
}'

返回响应

🟢200成功

application/json

Bodyapplication/json

ret

integer

必需

msg

string

必需

data

array [object]

必需

userName

string

可选

null

可选

nickName

null

可选

sex

integer

可选

phoneMd5

string

可选

signature

string

可选

alias

null

可选

country

string

可选

bigHeadImgUrl

string

可选

smallHeadImgUrl

string

可选

province

string

可选

city

string

可选

personalCard

integer

可选

示例

{
    "ret": 200,
    "msg": "获取手机通讯录成功",
    "data": [
        {
            "userName": "wxid_ddgsghdfafaphh22",
            "v4": null,
            "nickName": null,
            "sex": 1,
            "phoneMd5": "d36f4cc1c8bca1ef41b93d2215133cdb",
            "signature": "......",
            "alias": null,
            "country": "CN",
            "bigHeadImgUrl": "http://wx.qlogo.cn/mmhead/ver_1/vwGdLRK5jtpXagA7dfXlUiaU9VayWNSqia1c2Wib7icJNhPd6WHhqMIVuYuNDfEqPRC2TnmlRSkfYrib9fHyYONwdccv17gibCls7ia8elaunvgMmYicAw22wUJQ3CDw0Cm5ibrOT/0",
            "smallHeadImgUrl": "http://wx.qlogo.cn/mmhead/ver_1/vwGdLRK5jtpXagA7dfXlUiaU9VayWNSqia1c2Wib7icJNhPd6WHhqMIVuYuNDfEqPRC2TnmlRSkfYrib9fHyYONwdccv17gibCls7ia8elaunvgMmYicAw22wUJQ3CDw0Cm5ibrOT/132",
            "province": "Jiangsu",
            "city": "Xuzhou",
            "personalCard": 0
        }
    ]
}

修改于将近 2 年前

设置好友备注

上传手机通讯录