查询客户详情 - API接口文档

请求参数

Query 参数

token

string

必需

企业级token, 调用接口凭证

示例值:

1c7090c6d0894856982a07ea7a8dd0a4

Body 参数application/json

systemData

object

可选

imBotId

string

托管账号的系统联系人id

必需

imContactId

string

客户系统联系人id

必需

wecomData

object

可选

wecomUserId

string

托管账号的企业微信员工id

必需

externalUserId

string

客户企业微信外部联系人id

必需

示例

{
    "systemData": {
        "imBotId": "string",
        "imContactId": "string"
    },
    "wecomData": {
        "wecomUserId": "string",
        "externalUserId": "string"
    }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://aa-hub.ddregion.com/api/v2/customer/detail?token=1c7090c6d0894856982a07ea7a8dd0a4' \
--header 'Content-Type: application/json' \
--data-raw '{
    "systemData": {
        "imBotId": "string",
        "imContactId": "string"
    },
    "wecomData": {
        "wecomUserId": "string",
        "externalUserId": "string"
    }
}'

返回响应

🟢200成功

application/json

Body

errcode

number

返回码

必需

1 无效token 2 无效参数 400100 未找到对应的bot信息 400200 未找到对应的联系人

errmsg

string

对返回码的文本描述内容

必需

data

object

必需

imContactId

string

客户的系统联系人id

必需

name

string

客户姓名

必需

avatar

string

客户头像

必需

gender

string

客户性别

必需

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

remark

string

当前员工给当前客户打的备注信息

必需

createTimestamp

string

客户添加该员工时间戳（毫秒）

必需

remarkMobiles

array[number]

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

必需

imInfo

object

IM工具特有信息

必需

botInfo

object

必需

systemTags

array [object {3}]

自定义标签信息

必需

customerName

string

称呼

必需

description

string

描述

必需

示例

{
    "errcode": 0,
    "errmsg": "string",
    "data": {
        "imContactId": "string",
        "name": "string",
        "avatar": "string",
        "gender": "string",
        "remark": "string",
        "createTimestamp": "string",
        "remarkMobiles": [
            0
        ],
        "imInfo": {
            "type": "string",
            "tags": [
                {
                    "tagName": "string",
                    "type": "3",
                    "groupName": "string",
                    "tagId": "string"
                }
            ],
            "externalUserId": "string",
            "unionId": "string",
            "followUser": {
                "wecomUserId": "string",
                "state": "string"
            }
        },
        "botInfo": {
            "botId": "string",
            "imBotId": "string",
            "name": "string",
            "avatar": "string"
        },
        "systemTags": [
            {
                "groupName": "string",
                "tagName": "string",
                "tagId": "string"
            }
        ],
        "customerName": "string",
        "description": "string"
    }
}