客户接口

获取客户列表

该接口用于一次获取多个客户信息 该接口最多只能获取10000条数据, 如果无法需要获取更多的数据, 请使用[客户导出接口][]

请求方法

GET /customers

请求参数(Query String)

参数名 类型 必填 说明 限制
filter_id 整型 客户过滤器id
query 字符串 客户搜索时的关键字
page 整型 页码,从1开始,默认为1
page_size 整型 每页数量,默认20,最大100

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
meta 对象 分页信息,详见通用数据
customers 数组 客户列表,每个客户的说明参见客户数据

示例

curl http://demo.udesk.cn/open_api_v1/customers?page=1&page_size=10&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 1
    },
    "customers": [
        {
            "id": 1,
            "nick_name": "测试用户",
            "level": "normal",
            "description": null,
            "owner_id": 1,
            "owner_group_id": 1,
            "custom_fields": {
                "SelectField_1": ["0"],
                "SelectField_2": ["0"]
            },
            "open_api_token": null,
            "organization_id": null,
            "is_blocked": false,
            "tags": [],
            "first_contact_at": null,
            "last_contact_at": null,
            "first_contact_at_via_phone": null,
            "last_contact_at_via_phone": null,
            "first_contact_at_via_im": null,
            "last_contact_at_via_im": null,
            "email": "customer@sample.com",
            "other_emails": [],
            "cellphones": [
                {
                  "id": 1,
                  "content": "13000000001"
                }
            ],
            "platform": "手工录入",
            "source_channel": "手动创建",
            "weixins": [
                {
                    "appid": "wxf54489a1azz51885",
                    "openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
                    "unionid": ""
                }
            ]
        }
    ]
}

获取客户详情

该接口用于获取指定条件的客户信息

请求方法

GET /customers/get_customer

请求参数(Query String)

参数名 类型 必填 说明 限制
type 字符串 条件类型,详见下文
content 字符串 条件内容

条件类型

取值 对应content的含义
id 客户id
email 客户邮箱
cellphone 客户电话
token 客户外部唯一标识
weixin_open_id 客户微信openid
weibo_id 客户微博openid
sdk_token 客户sdk标识

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
customer 对象 客户信息,参见客户数据

示例

curl http://demo.udesk.cn/open_api_v1/customers/get_customer?type=email&content=customer@sample.com&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "customer": {
        "id": 1,
        "nick_name": "测试用户",
        "level": "normal",
        "description": null,
        "owner_id": 1,
        "owner_group_id": 1,
        "custom_fields": {
            "SelectField_1": ["0"],
            "SelectField_2": ["0"]
        },
        "open_api_token": null,
        "organization_id": null,
        "is_blocked": false,
        "tags": [],
        "first_contact_at": null,
        "last_contact_at": null,
        "first_contact_at_via_phone": null,
        "last_contact_at_via_phone": null,
        "first_contact_at_via_im": null,
        "last_contact_at_via_im": null,
        "email": "customer@sample.com",
        "other_emails": [],
        "cellphones": [
            {
              "id": 1,
              "content": "13000000001"
            }
        ],
        "platform": "手工录入",
        "source_channel": "手动创建",
        "weixins": [
            {
                "appid": "wxf54489a1azz51885",
                "openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
                "unionid": ""
            }
        ]

    }
}

创建客户

该接口用于创建客户

请求方法

POST /customers

请求参数(Request Body)

参数名 类型 必填 说明 限制
customer 对象 客户信息,详见下文
other_emails 数组 其他邮箱列表,具体参见示例
tags 字符串 标签列表,多个标签已逗号分隔

customer

参数名 类型 必填 说明 限制
email 字符串 主邮箱地址 最大长度255个字符
open_api_token 字符串 外部唯一标识 最大长度255个字符
nick_name 字符串 姓名 最大长度255个字符
organization_id 整型 客户公司id
description 字符串 描述 最大长度255个字符
owner_id 整型 负责客服id
owner_group_id 整型 负责客服组id
level 字符串 等级,默认为'normal',取值见客户数据
is_blocked 布尔 是否加入黑名单,默认为false
cellphones 数组 电话列表,详见下文
weixins 数组 微信列表,详见下文
custom_fields 对象 自定义字段

cellphones

每个元素都是一个数组:[电话id, 电话文本] 新增电话时,电话idnull,详见示例。

weixins

每个元素都是一个对象,包含以下属性:

参数名 类型 必填 说明 限制
action 字符串 执行动作 可选值: "new": 新增, "delete": 删除
appid 字符串 微信应用id
openid 字符串 客户的微信openid
unionid 字符串 客户的微信unionid

注意:

返回数据

获取客户详情接口相同。

示例

curl http://demo.udesk.cn/open_api_v1/customers?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-X POST \
-H 'content-type: application/json' \
-d '
{
    "customer": {
        "email": "customer2@sample.com",
        "nick_name": "测试客户2",
        "owner_id": 1,
        "owner_group_id": 1,
        "level": "vip",
        "is_blocked": false,
        "cellphones": [
            [null, "13100000002"],
            [null, "13200000002"]
        ],
        "custom_fields": {
            "TextField_1": "普通文本内容",
            "TextField_2": "多行文本内容1\r\n多行文本内容2",
            "TextField_3": "2016-08-11",
            "TextField_4": "14:44:36",
            "TextField_5": "2017-05-03 14:44",
            "TextField_6": "http://www.sample.com",
            "TextField_7": "13",
            "TextField_8": "13.33",
            "SelectField_1": ["0"],
            "SelectField_2": ["0"],
            "SelectField_3": ["0","3"]
        },
        "weixins": [
            {
                "action": "new",
                "appid": "wxf54489a1azz51885",
                "openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
                "unionid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
            },
            {
                "action": "delete",
                "appid": "wxf54489a1azz51885",
                "openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
            }
        ]
    },
    "other_emails": [
        [null, "customer2@sina.com"],
        [null, "customer2@qq.com"]
    ],
    "tags": "标签1,标签2"
}'

返回

{
    "code": 1000,
    "customer": {
        "id": 1,
        "nick_name": "测试用户",
        "level": "normal",
        "description": null,
        "owner_id": 1,
        "owner_group_id": 1,
        "custom_fields": {
            "TextField_1": "普通文本内容",
            "TextField_2": "多行文本内容1\r\n多行文本内容2",
            "TextField_3": "2016-08-11",
            "TextField_4": "14:44:36",
            "TextField_5": "2017-05-03 14:44",
            "TextField_6": "http://www.sample.com",
            "TextField_7": "13",
            "TextField_8": "13.33",
            "SelectField_1": ["0"],
            "SelectField_2": ["0"],
            "SelectField_3": ["0","3"]
        },
        "open_api_token": null,
        "organization_id": null,
        "is_blocked": false,
        "tags": [
            {
                "id": 1,
                "name": "标签1",
                "company_id": 1
            },
            {
                "id": 1,
                "name": "标签2",
                "company_id": 1
            }
        ],
        "email": "customer@sample.com",
        "other_emails": [
            [3,"customer2@sina.com"],
            [4,"customer2@qq.com"]
        ],
        "cellphones": [
            {
                "id": 3,
                "content": "13100000002"
            },
            {
                "id": 4,
                "content": "13200000002"
            }
        ],
        "platform": "手工录入",
        "source_channel": "手动创建",
        "weixins": [
            {
                "appid": "wxf54489a1azz51885",
                "openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
            },
            {
                "appid": "wxf54489a1azz51885",
                "openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
                "unionid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
            }
        ]
    }
}

更新客户

该接口用于修改客户信息

请求方法

PUT /customers/update_customer

请求参数(Query String)

参数名 必填 说明
type 条件类型
content 条件内容

详见获取客户详情接口

请求参数(Request Body)

创建客户接口相同

返回数据

获取客户详情接口相同。

示例

curl http://demo.udesk.cn/open_api_v1/customers/update_customer?type=email&content=customer@sample.com&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-X PUT \
-H 'content-type: application/json' \
-d '
{
    "customer": {
        "level": "normal",
        "custom_fields": {
            "TextField_1": "普通文本内容",
            "TextField_2": "多行文本内容1\r\n多行文本内容2",
            "TextField_3": "2016-08-11",
            "TextField_4": "14:44:36",
            "TextField_5": "2017-05-03 14:44",
            "TextField_6": "http://www.sample.com",
            "TextField_7": "13",
            "TextField_8": "13.33",
            "SelectField_1": ["0"],
            "SelectField_2": ["0"],
            "SelectField_3": ["0","3"]
        },
        "weixins": [
            {
                "action": "new",
                "appid": "wxf54489a1azz51885",
                "openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
                "unionid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
            },
            {
                "action": "delete",
                "appid": "wxf54489a1azz51885",
                "openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk",
            }
        ]
    },
    "other_emails": [
        [3, "customer2@sina1.com"]
    ]
}'

返回

{
    "code": 1000,
    "customer": {
        "id": 1,
        "nick_name": "测试用户",
        "level": "normal",
        "description": null,
        "owner_id": 1,
        "owner_group_id": 1,
        "first_contact_at": null,
        "last_contact_at": null,
        "first_contact_at_via_phone": null,
        "last_contact_at_via_phone": null,
        "first_contact_at_via_im": null,
        "last_contact_at_via_im": null,
        "custom_fields": {
            "TextField_1": "普通文本内容",
            "TextField_2": "多行文本内容1\r\n多行文本内容2",
            "TextField_3": "2016-08-11",
            "TextField_4": "14:44:36",
            "TextField_5": "2017-05-03 14:44",
            "TextField_6": "http://www.sample.com",
            "TextField_7": "13",
            "TextField_8": "13.33",
            "SelectField_1": ["0"],
            "SelectField_2": ["0"],
            "SelectField_3": ["0","3"]
        },
        "open_api_token": null,
        "organization_id": null,
        "is_blocked": false,
        "tags": [
            {
                "id": 1,
                "name": "标签1",
                "company_id": 1
            },
            {
                "id": 1,
                "name": "标签2",
                "company_id": 1
            }
        ],
        "email": "customer@sample.com",
        "other_emails": [
            [3,"customer2@sina1.com"]
        ],
        "cellphones": [
            {
                "id": 3,
                "content": "13100000002"
            },
            {
                "id": 4,
                "content": "13200000002"
            }
        ],
        "platform": "手工录入",
        "source_channel": "手动创建",
        "weixins": [
            {
                "appid": "wxf54489a1azz51885",
                "openid": "og8dL0nfmm7wVjIVzk1deqt9Vkdk"
            }
        ]
    }
}

删除客户

该接口用于删除客户信息

请求方法

DELETE /customers/destroy_customer

请求参数(Query String)

参数名 必填 说明
type 条件类型
content 条件内容

详见获取客户详情接口

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
customer_id 整型 删除的客户id

示例

curl http://demo.udesk.cn/open_api_v1/customers/destroy_customer?type=id&content=1&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 -X DELETE

返回

{
    "code": 1000,
    "customer_id": 1
}

获取客户历史记录列表

该接口用于获取指定条件客户的历史记录信息

请求方法

GET /customers/feeds

请求参数(Query String)

属性名 必填 说明
type 条件类型
content 条件内容
page 页码,从1开始,默认为1
page_size 每页数量,默认20,最大100

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
feeds 数组 客户历史列表,详见下文
meta 对象 分页信息,详见通用数据

feeds元素

feeds的元素分为五类,所有类型的元素,都包含以下属性:

属性名 类型 说明
feed_type 字符串 类型

其取值范围如下:

取值 含义
Ticket 工单
CallLog 通话记录
ImSubSession 对话记录
CustomerFollowUp 跟进记录
Alternation 变更记录

同时,不同类型,还包含各自独有的属性:

Ticket

属性名 类型 说明
id 整型 工单id
subject 字符串 标题
content 字符串 内容
user_id 整型 负责客服id
user_group_id 整型 负责客服组id
status_zh_name 字符串 工单状态中文名称

CallLog

属性名 类型 说明
id 整型 通话记录id
call_type 字符串 呼叫类型
result 字符串 通话结果
duration 整型 通话时长

ImSubSession

属性名 类型 说明
id 整型 对话记录id
platform 字符串 对话平台
customer_msg_num 整型 客户消息数
agent_msg_num 整型 客服消息数

CustomerFollowUp

属性名 类型 说明
id 整型 跟进记录id
user_id 整型 记录客服id
content 字符串 记录内容

Alternation

属性名 类型 说明
time 日期时间 变更发生时间
author 对象 操作人
summary 字符串 变更描述

其中,author的格式如下:

属性名 类型 说明
id 整型 客服id
nick_name 字符串 客服昵称

示例

curl http://demo.udesk.cn/open_api_v1/customers/feeds?type=id&content=1&email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "feeds": [
        {
            "feed_type": "Ticket",
            "id": 1,
            "content": "<p>测试工单</p>",
            "subject": "测试工单",
            "user_id": 1,
            "user_group_id": 1,
            "status_zh_name": "开启"
        },
        {
            "feed_type": "Alteration",
            "time": "2006-01-02T15:04:05.000+08:00",
            "author": {
                "id": null,
                "nick_name": null
            },
            "summary": "负责人:  <空>---->测试客服1"
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "total_count": 6
    }
}

获取客户过滤器列表

该接口用于获取全部客户过滤器信息

请求方法

GET /customers/filters

请求参数

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
customer_filters 数组 客户过滤器列表,详见下文

customer_filters元素

属性名 类型 说明
id 整型 唯一标识
name 字符串 名称
active 布尔 是否启用

示例

curl http://demo.udesk.cn/open_api_v1/customers/filters?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "customer_filters": [
        {
            "id": 1,
            "name": "测试过滤器1",
            "active": true,
        },
        {
            "id": 2,
            "name": "测试过滤器2",
            "active": false,
        }
    ]
}

获取客户自定义字段(废弃)

该接口用于获取全部客户自定义字段信息

请求方法

GET /customers/custom_fields

请求参数

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
custom_fields 数组 客户自定义字段列表,详见下文

custom_fields元素

属性名 类型 说明
id 整型 唯一标识
agent_permission 整型 客服权限
customer_permission 整型 客户权限
custom_field_name 字符串 唯一标识名,通常是“SelectField_”或者“TextField_”前缀加id
title 字符串 字段名
comment 字符串 描述
content_type 字符串 类型
options 数组 选择类型字段的选项,见示例

agent_permission

取值 含义
1 必填
2 选填

customer_permission

取值 含义
0 不可见
1 可见
2 可见且可编辑
3 必填

示例

curl http://demo.udesk.cn/open_api_v1/customers/custom_fields?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8

返回

{
    "code": 1000,
    "custom_fields": [
        {
            "id": 1,
            "agent_permission": 1,
            "customer_permission": 2,
            "title": "单行文本字段",
            "comment": "",
            "content_type": "text",
            "custom_field_name": "TextField_1",
            "options": null
        },
        {
            "id": 2,
            "agent_permission": 1,
            "customer_permission": 1,
            "title": "多行文本字段",
            "comment": "",
            "content_type": "area_text",
            "custom_field_name": "TextField_2",
            "options": null
        },
        {
            "id": 3,
            "agent_permission": 1,
            "customer_permission": 3,
            "title": "日期字段",
            "comment": "",
            "content_type": "date",
            "custom_field_name": "TextField_3",
            "options": null
        },
        {
            "id": 4,
            "agent_permission": 1,
            "customer_permission": 3,
            "custom_field_name": "TextField_4",
            "title": "时间字段",
            "content_type": "time",
            "comment": "",
            "options": null
        },
        {
            "id": 5,
            "agent_permission": 1,
            "customer_permission": 3,
            "custom_field_name": "TextField_5",
            "title": "日期时间字段",
            "content_type": "datetime",
            "comment": "",
            "options": null
        },
        {
            "id": 6,
            "agent_permission": 1,
            "customer_permission": 3,
            "custom_field_name": "TextField_6",
            "title": "链接字段",
            "content_type": "link",
            "comment": "",
            "options": null
        },
        {
            "id": 7,
            "agent_permission": 1,
            "customer_permission": 3,
            "custom_field_name": "TextField_7",
            "title": "正整数字段",
            "content_type": "number",
            "comment": "",
            "options": null
        },
        {
            "id": 8,
            "agent_permission": 1,
            "customer_permission": 3,
            "custom_field_name": "TextField_8",
            "title": "数值字段",
            "content_type": "numeric",
            "comment": "",
            "options": null
        },
        {
            "id": 1,
            "agent_permission": 1,
            "customer_permission": 2,
            "custom_field_name": "SelectField_1",
            "title": "下拉列表字段",
            "content_type": "droplist",
            "comment": null,
            "options": [
                {"0": "下拉选项1"},
                {"1": "下拉选项2"},
                {"2": "下拉选项3"}
            ]
        },
        {
            "id": 2,
            "agent_permission": 1,
            "customer_permission": 2,
            "custom_field_name": "SelectField_2",
            "title": "单选框字段",
            "content_type": "radio",
            "comment": null,
            "options": [
                {"0": "单选框选项1"},
                {"1": "单选框选项2"}
            ]
        },
        {
            "id": 3,
            "agent_permission": 1,
            "customer_permission": 2,
            "custom_field_name": "SelectField_3",
            "title": "多选框字段",
            "content_type": "checkbox",
            "comment": null,
            "options": [
                {"0": "多选框选项1"},
                {"1": "多选框选项2"},
                {"2": "多选框选项3"},
                {"3": "多选框选项4"}
            ]
        }
    ]
}

导入客户

该接口用于一次创建多个客户信息 注意:本方法一分钟内只允许调用一次

请求方法

POST /customers/batch_import_async

这个功能是异步的,每次最多导入100个客户。 接口返回code 1000,仅表示导入数据被成功接收,并不表示导入完成。 如果您关心导入结果,则需要配置通知地址,导入完成后,会向通知地址发送通知,具体参看配置通知地址

请求参数(Request Body)

参数名 类型 必填 说明
customers 数组 客户信息数组,详见下文

customers元素

参数名 类型 必填 说明 限制
nick_name 字符串 姓名 最大长度255个字符
description 字符串 描述 最大长度255个字符
emails 数组 邮箱数组
cellphones 数组 电话数组
organization_id 整型 客户公司id
owner_id 整型 负责客服id
owner_group_id 整型 负责客服组id
level 字符串 等级,详见客户数据,默认为"normal"
custom_fields 对象 自定义字段,详见客户数据
tags 字符串 标签,多个是以逗号分隔 最大长度255个字符

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功

示例

curl http://demo.udesk.cn/open_api_v1/customers/batch_import_async?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8 \
-X POST \
-H 'content-type: application/json' \
-d'
{
    "customers": [
        {
            "nick_name": "测试客户2",
            "emails": ["customer2@sample.com", "customer2@qq.com"],
            "cellphones": ["13100000002", "13200000002"],
            "owner_id": 1,
            "owner_group_id": 1,
            "custom_fields": {
                "TextField_1": "普通文本内容",
                "TextField_2": "多行文本内容1\r\n多行文本内容2",
                "TextField_3": "2016-08-11",
                "TextField_4": "14:44:36",
                "TextField_5": "2017-05-03 14:44",
                "TextField_6": "http://www.sample.com",
                "TextField_7": "13",
                "TextField_8": "13.33",
                "SelectField_1": ["0"],
                "SelectField_2": ["0"],
                "SelectField_3": ["0","3"]
            }
        }
    ]
}'

返回

{
    "code": 1000
}

客户导出

该接口用于导出的大量客户信息 支持按照指定过滤器筛选客户 支持按照关键字搜索客户

请求方法

GET /customers/export

该接口的使用方法:

  1. 使用 filter_id 或 query 调用该接口, 返回结果中包含第一批数据以及 scroll_id
  2. 数据处理完毕后, 使用上一次调用返回的 scroll_id 再次调用该接口(注意此时不需要在传入 filter_id 或 query), 返回结果中包含第二批数据及新的 scroll_id
  3. 重复第二步直至返回结果中的 customers 为空

注意: 后续每次调用时,需要使用上一次调用返回的新的 scroll_id

请求参数(Query String)

参数名 类型 必填 说明 限制
filter_id 整型 客户过滤器id, 导出该过滤器的筛选结果
query 字符串 客户搜索时的关键字, 导出该关键字的搜索结果
scroll_id 字符串 下一批数据的获取id, 从上一次调用本接口的结果中获取

返回数据

属性名 类型 说明
code 整型 执行结果码,1000代表成功
scroll_id 字符串 下一批数据的获取id
total 整型 数据总数
customers 数组 客户列表,详见客户数据

注意: 一次获取 customers 的最大数量为1000条; 当返回结果中 customers 数量为0时, 表示导出结束

示例

# 第一次调用
curl http://demo.udesk.cn/open_api_v1/customers/export?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8&filter_id=1
# 后续调用
curl http://demo.udesk.cn/open_api_v1/customers/export?email=admin@udesk.cn&timestamp=1494474404&sign=2f4c2c3d0b4c24cfa4feca76e237da0c368a00d8&scroll_id=DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAABHFnVvTTZEQXFwUkZ5S2wtSkdabmVBbWcAAAAAAAAASBZ1b002REFxcFJGeUtsLUpHWm5lQW1nAAAAAAAAAEkWdW9NNkRBcXBSRnlLbC1KR1puZUFtZwAAAAAAAABKFnVvTTZEQXFwUkZ5S2wtSkdabmVBbWcAAAAAAAAASxZ1b002REFxcFJGeUtsLUpHWm5lQW1n

返回

{
    "code": 1000,
    "scroll_id": "DnF1ZXJ5VGhlbkZldGNoBQAAAAAAAABHFnVvTTZEQXFwUkZ5S2wtSkdabmVBbWcAAAAAAAAASBZ1b002REFxcFJGeUtsLUpHWm5lQW1nAAAAAAAAAEkWdW9NNkRBcXBSRnlLbC1KR1puZUFtZwAAAAAAAABKFnVvTTZEQXFwUkZ5S2wtSkdabmVBbWcAAAAAAAAASxZ1b002REFxcFJGeUtsLUpHWm5lQW1n",
    "total": 10000,
    "customers": [...]
}

数据结构-客户

客户

属性名 类型 说明 限制
id 整型 唯一标识
nick_name 字符串 姓名 最大长度255个字符
level 字符串 客户等级
description 字符串 描述 最大长度255个字符
owner_id 整型 负责客服id
owner_group_id 整型 负责客服组id
custom_fields 对象 自定义字段,具体详见下文自定义字段说明
open_api_token 字符串 外部唯一标识 最大长度255个字符
organization_id 整型 客户公司id
organization_ids 数组(整型) 客户公司列表
default_organization_id 整型 默认公司id
is_blocked 布尔 是否被加入黑名单
tags 数组 标签列表
email 字符串 主邮箱 最大长度255个字符
other_emails 数组 其他邮箱列表
cellphones 数组 联系电话列表
weixins 数组 微信信息
platform 字符串 创建渠道中文名称(该字段将会逐步废弃)
source_channel 字符串 客户来源中文名称
first_contact_at 日期时间 首次联系时间
last_contact_at 日期时间 最后联系时间
first_contact_at_via_phone 日期时间 首次电话联系时间
last_contact_at_via_phone 日期时间 最后电话联系时间
first_contact_at_via_im 日期时间 首次在线客服联系时间
last_contact_at_via_im 日期时间 最后在线客服联系时间

level

取值 含义
normal 普通
vip VIP

source_channel

中文名称 英文名称
手动创建 manual
电话呼入 weibo
电话呼出 callout
微信 wechat
微博 weibo
在线客服 web_im
API或SDK api
反馈表单 feedback
邮件 mail
批量导入 import

platform

中文名称 英文名称
邮件 email
微博 weibo
微信 wechat
即时聊天 im
电话 call
反馈标签 feedback
帮助中心 hc
手工录入 manual_input
API api

custom_fields

custom_fields 示例:

{
    "custom_fields": {
        "TextField_1": "普通文本内容",                    // 普通文本
        "TextField_2": "多行文本内容1\r\n多行文本内容2",  // 多行文本
        "TextField_3": "2016-08-11",                      // 日期
        "TextField_4": "14:44:36",                        // 时间
        "TextField_5": "2017-05-03 14:44",                // 日期时间
        "TextField_6": "http://www.sample.com",           // 链接
        "TextField_7": "13",                              // 正整数
        "TextField_8": "13.33",                           // 数值
        "SelectField_1": ["0"],                           // 下拉列表,下拉选项1
        "SelectField_2": ["0"],                           // 单选框,单选框选项1
        "SelectField_3": ["0","3"]                        // 多选框,多选框选项1、多选框选项4
    }
}