1.1 接口说明

在优音云客服系统中，可通过客户ID（customer_id）来查询客户详细信息。
其中：客户ID（customer_id）可从4.2工单流出章节 1.4请求参数部分、6.1获取座席的客户信息章节 获取。

1.2 调用形式

https://ykf.uincall.com/openapi/customer/detail/customer_id?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=670253572927b24acffc41078ddxxxxx

1.3 调用方式

GET

1.4 传入参数

非必填参数，调用接口时请传递参数名，参数值可为空

序号 名称 类型 是否必填 说明
1 customer_id String 是 客户id

1.5 回应参数

序号 名称 类型 是否必填 说明
1 errcode Number 是 状态码：0成功，及其他非0错误码，详见错误码列表
2 errmsg String 是 状态说明
3 data Object数组 是 结果集（有数据时返回最新10条数据）
3.1 id String 是 Object数组中：客户唯一标识
3.2 truename String 是 Object数组中：客户真实姓名
3.3 nickname String 否 Object数组中：客户昵称
3.4 mobile String 是 Object数组中：客户手机号
3.5 mobileDesc String 否 Object数组中：客户手机描述
3.6 mail String 否 Object数组中：客户邮箱
3.7 mailDesc String 否 Object数组中：客户邮件描述
3.8 qq String 否 Object数组中：客户QQ号
3.9 wechat String 否 Object数组中：微信
3.10 wechatDesc String 否 Object数组中：客户微信号描述
3.11 website String 否 Object数组中：公司网站
3.12 summary String 否 Object数组中：备注
3.13 province String 是 Object数组中：省份
3.14 city String 是 Object数组中：城市
3.15 district String 否 Object数组中：地区
3.16 address String 否 Object数组中：客户地址
3.17 fields JSON 否 Object数组中：客户自定义字段
3.18 created_at String 是 Object数组中：客户创建时间

1.6 使用样例

调用：

url：https://ykf.uincall.com/openapi/customer/detail/00055c3cb623438995d56cxxxxxxxxxx?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=670253572927b24acffc41078ddxxxxx

响应：

{
    "errcode": 0,
    "errmsg": "success",
    "data": {
        "id": "39867647e1e75e81xxxxxxxxxxxxxxxx",
        "truename": "张三",
        "nickname": "",
        "mobile": "13012345678",
        "mobileDesc": "",
        "mail": "",
        "mailDesc": "",
        "qq": "",
        "wechat": "",
        "wechatDesc": "",
        "website": "website测试",
        "summary": "summary测试",
        "province": "",
        "city": "",
        "district": "",
        "address": "火星",
        "fields": {
            "rows": [{
                "is_system": false,
                "hidden": false,
                "show_hidden": true,
                "kind": 2,
                "editable": true,
                "display": "自定义单选",
                "is_disabled": false,
                "show_required": true,
                "alias_name": "自定义单选",
                "required": false,
                "searchable": true,
                "name": "a9d5b7f3afddd6a5422cad289dca3800",
                "options": {
                    "items": [{
                        "val": "云客服",
                        "id": 1627029060753
                    },
                    {
                        "val": "云坐席",
                        "id": 1627029078946
                    }]
                },
                "id": "a9d5b7f3afddd6a5422cad289dca3800",
                "items": [],
                "value": "优音热线",
                "show_searchable": true,
                "is_dict": false
            }]
        },
        "created_at": "2021-12-02 14:55:22"
    }
}
文档更新时间: 2024-03-25 15:20   作者：admin