客户相关API

获取客户元数据

请求地址

GET https://deal-api.kuick.cn/api/v1.7/metadata/customer

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
app_id string 项目id

正常返回结果

{
    "status": 1,
    "data": [
        {
            "appId": "4fc6e1e8-454d-4065-a6fd-68fee7a77b0d",
            "name": "phone",
            "type": "phone",
            "title": "手机号",
            "isExt": false,
            "unique": true,
            "required": true,
            "visiable": true,
            "index": 3,
            "defaultValue": "false",
            "optionValues": null,
            "readonly": 0
        },
        {
            "appId": "4fc6e1e8-454d-4065-a6fd-68fee7a77b0d",
            "name": "address",
            "type": "text",
            "title": "详细地址",
            "isExt": false,
            "unique": false,
            "required": false,
            "visiable": true,
            "index": 9,
            "defaultValue": "false",
            "optionValues": null,
            "readonly": 0
        },
        ...
    ]
}

正常返回结果说明

字段名称 字段类型 字段说明
appId string 项目id
name string 属性名称
type string 属性字段类型
title string 属性标题
isExt boolean 是否为扩展属性
unique boolean 是否为唯一属性
required boolean 是否为必填属性
visiable boolean 是否为可见属性
index int 属性顺序
defaultValue string 属性默认值
optionValues string 属性类型为选项类型时,选项值json字符串
readonly int 是否为只读,1:只读,0:非只读

创建客户

请求地址

POST https://deal-api.kuick.cn/api/v1.7/app/{app-id}/member/{kuick-user-id}/customers

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
app-id string 项目id
kuick-user-id string kuick用户ID
参数名称 参数类别 是否必填 参数说明
name string 根据客户元数据配置来 客户名称
sex string 根据客户元数据配置来 性别 0:女;1:男;2:未知
age_state string 根据客户元数据配置来 年龄段:-1:未知;0:(0-18);1:(18-25):2:(25-30):3:(30-40):4:(50-60):5:(60-)
phone string 根据客户元数据配置来 手机号
fixed_phone string 根据客户元数据配置来 座机
email string 根据客户元数据配置来 email
title string 根据客户元数据配置来 职位
company string 根据客户元数据配置来 公司名称
province string 根据客户元数据配置来 省份
city string 根据客户元数据配置来 城市
county string 根据客户元数据配置来 区/县城
address string 根据客户元数据配置来 详细地址
intentionality string 根据客户元数据配置来 意向度,可选值参考该项目的客户元数据配置
grade string 根据客户元数据配置来 客户等级,可选值参考该项目的客户元数据配置
lead_source string 根据客户元数据配置来 线索来源,可选值参考该项目的客户元数据配置
kuickUserId string 根据客户元数据配置来 客户所属销售Kuick用户ID
create_way string 根据客户元数据配置来 客户创建方式,可选值参考该项目的客户元数据配置
platform string 根据客户元数据配置来 客户来源平台,可选值参考该项目的客户元数据配置
from string 根据客户元数据配置来 客户来源
utm_medium string 根据客户元数据配置来 客户来源之utm媒介
utm_campaign string 根据客户元数据配置来 客户来源之utm活动
utm_content string 根据客户元数据配置来 客户来源之utm内容
buyed_keyword string 根据客户元数据配置来 客户来源之utm关键词,或者购买的关键词
search_keyword string 根据客户元数据配置来 客户来源之搜索词
promoter_id string 根据客户元数据配置来 客户来源之推广人KuickUserId
from_content_title string 根据客户元数据配置来 客户来源之来源内容标题
from_content_link string 根据客户元数据配置来 客户来源之来源内容链接
from_province string 根据客户元数据配置来 客户来源之省份
from_city string 根据客户元数据配置来 客户来源之城市
get_way string 根据客户元数据配置来 客户来源之获取方式,可选值参考该项目的客户元数据配置
source string 根据客户元数据配置来 客户来源
deal_user_id string 根据客户元数据配置来 deal用户ID

正常返回结果

{
   "status": 1,
   "data": {
          "id": "840dfe1d-7ae8-4fcc-9d83-2a9c8369dfea",
          "appId": "4cd57004-436f-4881-b2ec-5ebae3e82dec",
          "groupId": "4cd57004-436f-4881-b2ec-5ebae3e82dec",
          "name": "XX用户",
          "title": "测试工程师",
          "email": "xxxxx@qq.com",
          "phone": "xxxx",
          "company": "西会科技",
          "sex": 1,
          "address": "",
          "ageState": 1,
          "fixedPhone": "010 - 123456",
          "status": 1,
          "headportraitUrl": null,
          "createdAt": "2016-04-25 17:49:16",
          "updatedAt": "2016-04-25 17:49:16",
        "from": null,
        "getWay": null,
        "promoterId": null,
        "fromContentTitle": null,
        "fromContentLink": null,
        "searchKeyword": null,
        "buyedKeyword": null,
        "platform": null,
        "createWay": null,
        "fromProvince": null,
        "fromCity": null,
        "utmMedium": null,
        "utmCampaign": null,
        "utmContent": null,
        "whetherMerge": 1,
        "allocationData": {
            "allocationKuickUserId": "5953"
        },
        "kuickUserId": "5953"
        "mergedCustomerId": "agaga1d-7ae8-4fcc-9d83-2a9c8369dfea",
   }
}

返回结果说明

字段名称 字段类型 字段说明
event_type string 事件类型,创建客户时值为create
domainType string 领域类型,Customer:客户类型,BehaviourLog:行为类型
domainId string 客户id
body object 客户对象
id string 客户id
appId string 项目id
name string 客户姓名
headportraitUrl string 客户头像
company string 客户公司名称
title string 客户职位
phone string 客户手机号
email string 客户E-mail
kuickUserId string 客户所属人id,即KuickDeal用户id
groupId string 客户所属分组id
sex string 客户性别,0:女,1:男,2:未知
ageState int 客户年龄段, -1:未选择,0:25~35,1:35~45,2:45~55:,3:55~65,4:65以上
fixedPhone string 客户座机号
industry string 客户所属行业
province string 客户公司所在省份
city string 客户公司所在城市
county string 客户公司所在县区
address string 客户公司详细地址
intentionality int 客户意向度等级,默认值,1:低,2:中,3:高,可通过修改客户元数据进行变更
grade int 客户等级,默认值,1:A(重点客户),2:B(普通客户),3:C(非优先客户),可通过修改客户元数据进行变更
leadSource string 线索来源,默认值,400信息,陌拜信息,会员信息,转介绍信息,其他,可通过修改客户元数据进行变更
createWay int 客户创建方式,0:其他,1:登录,2:咨询客服,3:关注公众号,4:400电话,5:表单填写,6:手动创建,7:批量上传,8:销售易同步,9:CRM插件同步,11:注册
platform string 客户创建平台,pc_web:PC网站,mobile_web:移动网站,app:App,weixin:微信
from string utm来源
utmMedium string utm媒介
utmCampaign string utm活动
utmContent string utm内容
buyedKeyword string utm关键词
searchKeyword string 搜索词
promoterId string 推广人id
fromContentTitle string 来源内容标题
fromContentLink string 来源内容链接
fromProvince string 区域省份
fromCity string 区域城市
getWay int 获取方式,0:免费,1:付费
source string 来源json字符串,暂无其他意义
allocationData object 客户分配数据
allocationKuickUserId string 客户分配给KuickDeal用户id
status string 新客户状态,1:正常; 0:删除
whetherMerge string 标记该客户是否需要被合并。 1:需要;0:不需要
mergedCustomerId string 合并状态,为空时未合并; 非空时已合并,值为产生的新的客户ID
createdAt string 创建时间
updatedAt string 修改时间

修改客户

请求地址

PUT https://deal-api.kuick.cn/api/v1.7/app/{app-id}/member/{kuick-user-id}/customer/{customer-id}

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
app-id string 应用ID
kuick-user-id string kuick用户ID
customer-id string 客户ID
参数名称 参数类别 是否必填 参数说明
name string 根据客户元数据配置来 客户名称
sex string 根据客户元数据配置来 性别 0:女;1:男;2:未知
age_state string 根据客户元数据配置来 年龄段:-1:未知;0:(0-18);1:(18-25):2:(25-30):3:(30-40):4:(50-60):5:(60-)
phone string 根据客户元数据配置来 手机号
fixed_phone string 根据客户元数据配置来 座机
email string 根据客户元数据配置来 email
title string 根据客户元数据配置来 职位
company string 根据客户元数据配置来 公司名称
province string 根据客户元数据配置来 省份
city string 根据客户元数据配置来 城市
county string 根据客户元数据配置来 区/县城
address string 根据客户元数据配置来 详细地址
intentionality string 根据客户元数据配置来 意向度,可选值参考该项目的客户元数据配置
grade string 根据客户元数据配置来 客户等级,可选值参考该项目的客户元数据配置
lead_source string 根据客户元数据配置来 线索来源,可选值参考该项目的客户元数据配置
kuickUserId string 根据客户元数据配置来 客户所属销售Kuick用户ID
create_way string 根据客户元数据配置来 客户创建方式,可选值参考该项目的客户元数据配置
platform string 根据客户元数据配置来 客户来源平台,可选值参考该项目的客户元数据配置
from string 根据客户元数据配置来 客户来源
utm_medium string 根据客户元数据配置来 客户来源之utm媒介
utm_campaign string 根据客户元数据配置来 客户来源之utm活动
utm_content string 根据客户元数据配置来 客户来源之utm内容
buyed_keyword string 根据客户元数据配置来 客户来源之utm关键词,或者购买的关键词
search_keyword string 根据客户元数据配置来 客户来源之搜索词
promoter_id string 根据客户元数据配置来 客户来源之推广人KuickUserId
from_content_title string 根据客户元数据配置来 客户来源之来源内容标题
from_content_link string 根据客户元数据配置来 客户来源之来源内容链接
from_province string 根据客户元数据配置来 客户来源之省份
from_city string 根据客户元数据配置来 客户来源之城市
get_way string 根据客户元数据配置来 客户来源之获取方式,可选值参考该项目的客户元数据配置
source string 根据客户元数据配置来 客户来源
deal_user_id string 根据客户元数据配置来 deal用户ID

正常返回结果

{
    "status": 1,
    "data": {
        "id": "df627bed-5aef-4da6-a9e1-7099d75ec952",
        "appId": "cfc082ad-4dcf-4d3a-a6b2-297dca7a9636",
        "name": "slience",
        "title": null,
        "email": null,
        "phone": null,
        "company": null,
        "sex": 2,
        "address": null,
        "ageState": -1,
        "fixedPhone": null,
        "province": null,
        "city": null,
        "county": null,
        "status": 1,
        "mergedCustomerId": null,
        "headportraitUrl": "http://cdn-img.prod.kuick.cn/user/header/77e71a55-bcdb-4a03-a1eb-6969bdea4628.png",
        "groupId": null,
        "leadSource": null,
        "grade": null,
        "industry": null,
        "intentionality": null,
        "source": "{\"origin\":\"default\",\"context\":{}}",
        "createdAt": "2018-02-06 17:20:14",
        "updatedAt": "2018-02-06 18:00:03",
        "from": null,
        "getWay": null,
        "promoterId": null,
        "fromContentTitle": null,
        "fromContentLink": null,
        "searchKeyword": null,
        "buyedKeyword": null,
        "platform": null,
        "createWay": null,
        "fromProvince": null,
        "fromCity": null,
        "utmMedium": null,
        "utmCampaign": null,
        "utmContent": null,
        "kuickUserId": "5953"
    }
}

返回结果说明

注意:返回结果字段说明参照客户创建返回的字段说明。

获取客户详情

请求地址

GET https://deal-api.kuick.cn/api/v1.7/customer/{customer_id}/detail

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
customer_id string 客户ID

正常返回结果

{
    "status": 1,
    "data": {
        "id": "b6083165-e92c-4dc3-8d29-800f5ab87e62",
        "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
        "name": "测试",
        "title": "",
        "email": "",
        "phone": "18604082649",
        "company": "",
        "sex": 2,
        "address": "",
        "ageState": -1,
        "fixedPhone": "",
        "province": "",
        "city": "",
        "county": "",
        "status": 1,
        "mergedCustomerId": null,
        "headportraitUrl": "http://cdn-img.prod.kuick.cn/user/header/f782413a-f0f1-4fe4-94d4-7207b15973f9.png",
        "groupId": null,
        "leadSource": "",
        "grade": 0,
        "industry": "",
        "intentionality": 0,
        "source": "{\"origin\":\"singleCreate\",\"context\":{}}",
        "createdAt": "2018-02-01 15:22:34",
        "updatedAt": "2018-02-01 15:25:41",
        "from": "",
        "getWay": 0,
        "promoterId": null,
        "fromContentTitle": "",
        "fromContentLink": "",
        "searchKeyword": "",
        "buyedKeyword": "",
        "platform": "",
        "createWay": 6,
        "fromProvince": "",
        "fromCity": "",
        "utmMedium": "",
        "utmCampaign": "",
        "utmContent": "",
        "kuickUserId": "4840"
    }
}

返回结果说明

注意:返回结果字段说明参照客户创建返回的字段说明。

获取客户列表

请求地址

GET https://deal-api.kuick.cn/api/v1.7/app/{app-id}/member/{kuick-user-id}/customers

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
start_index int 分页开始索引
count int 每页显示条数
参数名称 参数类别 是否必填 参数说明
app-id string 应用ID
kuick-user-id string kuick用户ID

正常返回结果

{
    "status": 1,
    "data": [
        {
            "id": "ce45a170-54d6-4bfb-9e79-676f614bd039",
            "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
            "name": "测试",
            "title": "",
            "email": "",
            "phone": "",
            "company": "",
            "headportraitUrl": "http://cdn-img.prod.kuick.cn/user/header/af62c277-48ea-47e0-808a-2f19d48fc70a.png",
            "status": 1,
            "mergedCustomerId": null,
            "createdAt": "2018-02-09 18:11:20",
            "updatedAt": "2018-02-09 18:11:20",
            "groupId": null,
            "sex": 2,
            "address": "",
            "ageState": -1,
            "fixedPhone": "",
            "province": "",
            "city": "",
            "county": "",
            "leadSource": "",
            "grade": 0,
            "industry": "",
            "intentionality": 0,
            "source": "{\"origin\":\"singleCreate\",\"context\":{}}",
            "from": null,
            "getWay": null,
            "promoterId": null,
            "fromContentTitle": null,
            "fromContentLink": null,
            "searchKeyword": null,
            "buyedKeyword": null,
            "platform": null,
            "createWay": 6,
            "fromProvince": null,
            "fromCity": null,
            "utmMedium": null,
            "utmCampaign": null,
            "utmContent": null,
            "whetherMerge": 0,
            "isNew": 1,
            "kuickUserId": "4840",
            "groupName": null,
            "newCount": 0
        },
        {
            "id": "e5dc28a2-66f7-40f7-880b-8ed0bf38f4e0",
            "appId": "2db3304b-2d5d-4f35-a860-6c4d315ade1a",
            "name": "RABBITEPRE某某",
            "title": "",
            "email": "",
            "phone": "18625915637",
            "company": "",
            "headportraitUrl": "http://cdn-img.prod.kuick.cn/user/header/9c05186c-06f8-463b-8394-d2d760bf2b75.png",
            "status": 1,
            "mergedCustomerId": null,
            "createdAt": "2018-02-07 15:43:26",
            "updatedAt": "2018-02-07 15:43:26",
            "groupId": null,
            "sex": 2,
            "address": null,
            "ageState": null,
            "fixedPhone": null,
            "province": null,
            "city": null,
            "county": null,
            "leadSource": null,
            "grade": null,
            "industry": null,
            "intentionality": null,
            "source": "{\"origin\":\"link\",\"context\":{}}",
            "from": "资料浏览",
            "getWay": null,
            "promoterId": "4840",
            "fromContentTitle": "旅行青蛙喊你回家过年",
            "fromContentLink": "http://h5.inxedu.com/mspa/vUJZR2jVX?link_id=4d7a7f74-6db3-4582-aaef-081aae019e11&share_token=39pYRE1s&mobile=1",
            "searchKeyword": null,
            "buyedKeyword": null,
            "platform": "weixin",
            "createWay": 5,
            "fromProvince": "北京市",
            "fromCity": "北京市",
            "utmMedium": null,
            "utmCampaign": null,
            "utmContent": null,
            "whetherMerge": 0,
            "isNew": 0,
            "kuickUserId": "4840",
            "groupName": null,
            "newCount": 18
        },
        ...
    ]
}

返回结果说明

注意:返回结果字段说明参照客户创建返回的字段说明。

搜索客户

请求地址

GET https://deal-api.kuick.cn/api/v1.7/app/{app-id}/customer/appSearch

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
condition string 手机号 or email
参数名称 参数类别 是否必填 参数说明
app-id string 应用ID

正常返回结果

{
   "status": 1,
   "data": [
        {
            "id": "df627bed-5aef-4da6-a9e1-7099d75ec952",
            "appId": "cfc082ad-4dcf-4d3a-a6b2-297dca7a9636",
            "name": "test",
            "title": "2",
            "email": "123@qq.com",
            "phone": "13932202581",
            "company": "1",
            "headportraitUrl": "http://cdn-img.prod.kuick.cn/user/header/b5996f57-baaa-485a-910c-aa9297deb478.png",
            "status": 1,
            "mergedCustomerId": null,
            "createdAt": "2018-02-06 17:20:14",
            "updatedAt": "2018-02-06 17:20:14",
            "groupId": null,
            "sex": 2,
            "address": null,
            "ageState": -1,
            "fixedPhone": null,
            "province": null,
            "city": null,
            "county": null,
            "leadSource": null,
            "grade": null,
            "industry": null,
            "intentionality": null,
            "source": "{\"origin\":\"default\",\"context\":{}}",
            "from": null,
            "getWay": null,
            "promoterId": null,
            "fromContentTitle": null,
            "fromContentLink": null,
            "searchKeyword": null,
            "buyedKeyword": null,
            "platform": null,
            "createWay": null,
            "fromProvince": null,
            "fromCity": null,
            "utmMedium": null,
            "utmCampaign": null,
            "utmContent": null,
            "whetherMerge": 1,
            "isNew": 0,
            "kuickUserId": "5953",
            "groupName": null,
            "newCount": 0
        },
        {
            "id": "e3ede4d3-d794-4363-b452-16593987a774",
            "appId": "cfc082ad-4dcf-4d3a-a6b2-297dca7a9636",
            "name": "test",
            "title": "2",
            "email": null,
            "phone": "13932202581",
            "company": "1",
            "headportraitUrl": "http://cdn-img.prod.kuick.cn/user/header/8cbc9995-53a3-4b98-98e9-9e1c795e6904.png",
            "status": 1,
            "mergedCustomerId": null,
            "createdAt": "2018-02-06 17:18:20",
            "updatedAt": "2018-02-06 17:18:20",
            "groupId": null,
            "sex": 2,
            "address": null,
            "ageState": -1,
            "fixedPhone": null,
            "province": null,
            "city": null,
            "county": null,
            "leadSource": null,
            "grade": null,
            "industry": null,
            "intentionality": null,
            "source": "{\"origin\":\"default\",\"context\":{}}",
            "from": null,
            "getWay": null,
            "promoterId": null,
            "fromContentTitle": null,
            "fromContentLink": null,
            "searchKeyword": null,
            "buyedKeyword": null,
            "platform": null,
            "createWay": null,
            "fromProvince": null,
            "fromCity": null,
            "utmMedium": null,
            "utmCampaign": null,
            "utmContent": null,
            "whetherMerge": 1,
            "isNew": 0,
            "kuickUserId": "5953",
            "groupName": null,
            "newCount": 0
        },
        ...
    ]
}

返回结果说明

注意:返回结果字段说明参照客户创建返回的字段说明。

转移客户所属人

请求地址

POST https://deal-api.kuick.cn/api/v1.7/app/{app_id}/customer/batch-app-member-transfers

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
app-id string 应用ID
参数名称 参数类别 是否必填 参数说明
datas json 示例:[{\"customerId\":\"0a127488-6a7d-4edf-8f38-1fa92d95f200\",\"srouceGroupId\":\"4e30142a-d947-4b3a-b578-ab4ed04fc3d5\",\"srouceKuickUserId\":\"114\"}]
target_kuick_userid string 目标销售的Kuick用户id
参数名称 参数类别 参数说明
customerId string 客户id
srouceGroupId string 原分组id
srouceKuickUserId string 原销售的Kuick用户id

正常返回结果

{
   "status": 1,
   "data": true
}

正常返回结果说明

字段名称 字段类型 字段说明
status int 调用状态,1:成功,0:失败
data boolean 转移客户所属人成功

获取客户分组列表

请求地址

GET https://deal-api.kuick.cn/api/v1.7/app/{app_id}/customer-groups

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
app-id string 项目id
参数名称 参数类别 是否必填 参数说明
kuick_user_id string 销售对应的Kuick用户ID

正常返回结果

{
   "status": 1,
   "data": [ 
        {
            "id": "b99f2849-9fb5-419b-8a71-2e685843ca41",
            "name": "未跟进",
            "customerCount": 19,
            "createdAt": "2017-11-20 14:24:09"
        },
        {
            "id": "f3a7443b-dc0f-4663-8edb-88c7a3307390",
            "name": "已跟进",
            "customerCount": 1,
            "createdAt": "2017-11-20 14:24:10"
        },
       ...
     ]
}

返回结果说明

字段名称 字段类型 字段说明
id string 组id
name string 组名
customerCount int 组内客户数量
createdAt string 创建时间

转移客户分组

请求地址

POST https://deal-api.kuick.cn/api/v1.7/app/{app_id}/customer/group-transfers

是否需要认证

参数说明

参数名称 参数类别 是否必填 参数说明
app-id string 项目id
参数名称 参数类别 是否必填 参数说明
source_group_id string 原分组id
target_group_id string 目标分组Id
customer_ids string 客户ID列表(逗号分隔)

正常返回结果

{
       "status": 1,
       "data": true
}

正常返回结果说明

字段名称 字段类型 字段说明
status int 调用状态,1:成功,0:失败
data boolean 转移客户分组成功
北京西会科技有限公司©2015-2018 all right reserved,powered by Gitbook该文件修订时间: 2019-08-31 00:11:38

results matching ""

    No results matching ""