获取客户详情 - API接口文档

请求参数

Query 参数

token

string

必需

企业级token, 调用接口凭证

externalUserId

string

必需

示例值:

wmaHgNCAAA7kfv0u7oZpt752dGYF9SCQ

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/api/v1/customer/detail?token=&externalUserId=wmaHgNCAAA7kfv0u7oZpt752dGYF9SCQ' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

errcode

integer

返回码

必需

errmsg

string

对返回码的文本描述内容

必需

data

array [object {10}]

必需

externalUserId

string

客户id

必需

unionId

string

客户unionId

可选

name

string

客户姓名

可选

avatar

string

客户头像

可选

gender

integer

客户性别

必需

0 -未知 1 -男性 2 -女性

type

integer

客户的类型

必需

1 表示该客户是微信用户，2 表示该客户是企业微信用户

followUser

array [object {6}]

必需

tags

array [object {4}]

可选

mhTags

array [object {4}]

可选

remarkMobiles

array[string]

该成员对此客户备注的手机号码

必需

total

number

客户总数

必需

示例

{
  "errcode": 0,
  "errmsg": "string",
  "data": [
    {
      "externalUserId": "string",
      "unionId": "string",
      "name": "string",
      "avatar": "string",
      "gender": 0,
      "type": 0,
      "followUser": [
        {
          "userId": "string",
          "name": "string",
          "avatar": "string",
          "remark": "string",
          "state": "string",
          "createTimestamp": 0
        }
      ],
      "tags": [
        {
          "tagName": "string",
          "type": "string",
          "groupName": "string",
          "tagId": "string"
        }
      ],
      "mhTags": [
        {
          "groupName": "string",
          "tagName": "string",
          "type": "string",
          "tagId": "string"
        }
      ],
      "remarkMobiles": [
        "string"
      ]
    }
  ],
  "total": 0
}