企业微信按手机号搜索 API

请求地址

POST https://api.qingluanbot.com/qingluan/api/contact/phoneNumberSearch

请求示例

curl -X POST 'https://api.qingluanbot.com/qingluan/api/contact/phoneNumberSearch' \
  -H 'X-Qingluan-Key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "ql_appid": "inst_xxxxxxxxxxxx",
  "phone": "13800000000"
}'

请求参数

响应判断

能力层接口返回包含 code、message、time 与 data 等字段；请以 code=0 判断业务成功。HTTP 200 只表示网关已返回响应，不能替代业务状态判断。

可能的响应状态

200 响应示例

{
  "code": 0,
  "data": [
    {
      "contactInfo": {
        "alias": "示例别名",
        "attr": 134285632,
        "attr2": 240779404,
        "attr3": 0,
        "corpDescInfo": {},
        "corpId": 1000000000000002,
        "customInfo": {},
        "englishName": "ZhangSan",
        "externalCustomInfo": {},
        "gender": 1,
        "gid": 1000000000000019,
        "iconUrl": "<省略>",
        "isNameVerified": true,
        "isSyncInnerPosition": true,
        "mainPartyId": 1000000000000003,
        "mobile": "",
        "name": "张三",
        "nameVerifyStatus": 1,
        "realName": "张三",
        "schoolUserType": 1,
        "uin": 1000000000000018,
        "unionId": "<省略>",
        "vCode": "<省略>"
      },
      "contactInfoWx": {
        "gender": 1,
        "iconUrl": "<省略>",
        "name": "示例微信昵称",
        "uin": 1000000000000020
      },
      "corpInfo": {
        "authCorpStatus": 1,
        "authExpireTime": 1816654520,
        "authLicenceStatus": 3,
        "authTime": 0,
        "authedDomain": "",
        "bAuthedLicence": true,
        "cmSubmitTime": 0,
        "corpAppWxaInfo": {
          "appId": "<省略>",
          "enterPath": "/pages/index/index.html",
          "userName": "gh_303bdfa3334c@app",
          "version": 0,
          "versionType": 0
        },
        "corpCardUrl": "<省略>",
        "corpDesc": "",
        "corpFullName": "示例企业科技有限公司",
        "corpId": 1000000000000002,
        "corpLogo": "<省略>",
        "corpName": "示例企业",
        "corpStat": 2,
        "corpType": 15,
        "createSourceInfo": "",
        "createTime": 1785116462,
        "hasInfoCorp": false,
        "isAccepted": true,
        "isInitModUser": false,
        "joinNeedVerify": false,
        "language": 1,
        "modUserInfo": {
          "name": "",
          "vid": 0
        },
        "ownerName": "示例法人",
        "pstnOfficePhoneState": 0,
        "sCorpId": "<省略>",
        "staffInfo": {
          "alias": "示例别名",
          "headImage": "https://example.com/...",
          "internationCode": "86",
          "mail": "",
          "name": "张三",
          "phone": "13800000000"
        },
        "staffNum": 0,
        "trust": true,
        "verifyMsg": "",
        "vid": 1000000000000018,
        "virtualCreateDomainName": ""
      },
      "flag": 0,
      "openid": "<省略>",
      "relation": 0,
      "resultType": 1,
      "searchStatus": 1,
      "wxTicket": "<省略>"
    }
  ]
}

接入步骤

1. 在青鸾开发者控制台创建或查看 API Key。
2. 在「实例与回调」接入企业微信账号，取得 ql_appid。
3. 请求头携带 X-Qingluan-Key，按当前契约提交 JSON 请求。
4. 读取响应中的 code；仅当 code=0 时按成功流程处理。