手机号搜索

按手机号搜索用户，拿到添加好友所需的票据（wxTicket）与身份（openid / uin / corpId），供后续加好友接口使用。只搜不加。

说明与注意

• 响应 data 是数组，每项含 {contactInfo, contactInfoWx, corpInfo, wxTicket, openid, searchStatus, resultType}；加个人微信取 openid + wxTicket（作为 ticket）；加企业微信取 contactInfo.uin（作为 userid）+ contactInfo.corpId（作为 corpId）+ wxTicket（作为 ticket）。用 resultType / searchStatus 判断用户类型与是否可添加。

请求参数

参数	必填	类型	说明
appid	是	string	实例 appid，标识操作哪个已登录账号。示例：we_xxxxxxxxxxxxxxx
phone	是	string	手机号。示例：17311125550

请求示例

HTTP

POST {BASE_URL}/wx-api/api/contact/phoneNumberSearch
Authorization: Bearer <你的 App Token>
Content-Type: application/json

{
  "appid": "we_xxxxxxxxxxxxxxx",
  "phone": "17311125550"
}

curl

curl -X POST '{BASE_URL}/wx-api/api/contact/phoneNumberSearch' \
  -H 'Authorization: Bearer <你的 App Token>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "appid": "we_xxxxxxxxxxxxxxx",
  "phone": "17311125550"
}'

Python

import requests

url = "{BASE_URL}/wx-api/api/contact/phoneNumberSearch"
headers = {"Authorization": "Bearer <你的 App Token>", "Content-Type": "application/json"}
body = """{
  "appid": "we_xxxxxxxxxxxxxxx",
  "phone": "17311125550"
}"""

resp = requests.post(url, headers=headers, data=body.encode("utf-8"))
print(resp.text)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String url = "{BASE_URL}/wx-api/api/contact/phoneNumberSearch";
String body = "{\n" +
    "  \"appid\": \"we_xxxxxxxxxxxxxxx\",\n" +
    "  \"phone\": \"17311125550\"\n" +
    "}";

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder(URI.create(url))
    .header("Authorization", "Bearer <你的 App Token>")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

PHP

<?php

$url = '{BASE_URL}/wx-api/api/contact/phoneNumberSearch';
$body = <<<'JSON'
{
  "appid": "we_xxxxxxxxxxxxxxx",
  "phone": "17311125550"
}
JSON;

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer <你的 App Token>',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

响应示例

解析响应前确认字段

返回字段见本页「说明与注意」和联系人模块总览。完整响应格式及未列出的字段，请通过开通与支持联系对接人确认后再解析。

响应字段

字段	类型	说明
code	int64	统一封套状态码：0=成功，负数=失败
data	array<object>	搜索结果列表，每项含 contactInfo、contactInfoWx、corpInfo、wxTicket、openid、searchStatus、resultType
detail	string	附加明细，通常为空
message	string	文案：成功为 ok；失败形如 -码|描述
time	string	服务端处理时间 YYYY-MM-DD HH:MM:SS

下一步

• 联系人模块总览
• 错误码
• 快速开始