手机号查询客户信息 - 小裂变-开放平台

请求参数

Query 参数

phone

string <string>

手机号

必需

staffId

string <string>

成员id，非必传

可选

Header 参数

Authorization

string <string>

认证令牌

必需

示例值:

Bearer 64FMJbvkyQC2EHY8

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://w.xiaoliebian.com/api/demo-wechat-work/open/api/customer/phone/list?phone&staffId' \
--header 'Authorization: Bearer 64FMJbvkyQC2EHY8'

返回响应

🟢200OK

application/json

Body

array of:

success

boolean

成功标识

可选

示例值:

true

code

integer <int32>

错误编码

可选

示例值:

0

msg

string <string>

错误信息

可选

示例值:

value

array[object (WecomOpenAppCustomDetailResponse_response) {8}]

返回对象

可选

gender

integer <int32>

可选

性别 0:未知 1:男 2:女

示例值:

0

avatar

string <string>

头像

可选

示例值:

name

string <string>

姓名

可选

示例值:

externalUserId

string <string>

外部联系人Id

可选

示例值:

type

integer <int32>

可选

客户类型 1:微信用户 2:企业微信客户

示例值:

0

staffList

array[object (WecomOpenAppStaffDetailResponse_response) {13}]

可选

所属成员
1、返回与客户有对应手机号的成员数据
2、如传递成员id参数，只返回相对应成员数据

groupChatList

array[object (WecomOpenAppCustomGroupChatResponse_response) {3}]

可选

所属群聊，无所属群时，无数据

unionId

string <string>

可选

外部联系人在微信开放平台的唯一身份标识（微信unionid）
无对应关系时，无值

示例值:

traceId

string <string>

链路ID

可选

示例值:

示例

{
  "success": true,
  "code": 0,
  "msg": "",
  "value": [
    {
      "gender": 0,
      "avatar": "",
      "name": "",
      "externalUserId": "",
      "type": 0,
      "staffList": [
        {
          "staffId": "",
          "staffName": "",
          "state": "",
          "relation": 0,
          "spread": 0,
          "remark": "",
          "createTime": "yyyy-MM-dd HH:mm:ss",
          "lifeCircleId": "",
          "lifeCircleName": "",
          "extendVoList": [
            {
              "name": "",
              "value": ""
            }
          ],
          "tagList": [
            {
              "groupName": "",
              "tagName": "",
              "tagId": ""
            }
          ],
          "remarkMobileList": [
            ""
          ]
        }
      ],
      "groupChatList": [
        {
          "chatId": "",
          "name": "",
          "joinTime": "yyyy-MM-dd HH:mm:ss"
        }
      ],
      "unionId": ""
    }
  ],
  "traceId": ""
}