本文档所描述的内容属于神策客景的高级使用功能,涉及较多技术细节,适用于对相关功能有经验的用户参考。如果对文档内容有疑惑,请咨询您的数据咨询顾问获取一对一的协助。

神策客景除了强大的功能,还提供了完善的 API。

数据导入 API 主要用于将 CRM 业务相关数据同步更新至客景。

部分实体之间存在依赖,建议导入(更新)顺序如下:

  • 用户(员工)→  客户 → 其他(合同、客户联系人、跟进记录、自定义实体)

调用方法

请参见 API 文档 中的调用方法描述。

用户导入

url示例参考:

http://$WEB_URL/api/v2/sj/import/object?domain=user&project=$PROJECT&token=$API_SECRET

输入参数示例:

[POST v2/sj/import/object?domain=user]
 
Request (application/json)
 
  
[    
  {
    "username": "string",
    "user_cname": "string",
    "email": "string",
    "phone": "string",
    "position": "string"
  }
]

参数说明如下:

参数

字段描述

类型/是否必传

说明

username账号String/YESusername 参数过长,最大限度为 40 个字符
user_cname用户名称String/YESuser_came 参数过长,最大限度为 40 个字符
email邮箱String/NOemail需要满足邮箱格式,最大限度为 50 个字符
phone电话String/NOphone 最大限度为 50 个字符
position职务String/NOposition 最大限度为 50 个字符

返回结果示例:

{
  "total_count": 0,
  "success_count": 0,
  "insert_count": 0,
  "update_count": 0,
  "error_count": 0,
  "error_reason": "string",
  "error_info_list": [
    {
    "number": 0,
    "bean": {},
    "error_reason": "string",
    }
  ],
  "success_keys":[
  ],
  "fail_keys":[
  ]
}

返回结果说明:

参数

字段描述

类型

说明

total_count上传数据的总条数Integer
success_count导入成功的条数Integer
insert_count新增插入的条数Integer
update_count更新的条数Integer
error_count错误总条数Integer
error_reason错误原因String
number导入的行号Number
bean错误的源数据信息
error_reason错误原因String
success_keys导入成功的字段String
fail_keys导入失败的字段String

1.检查数据表是否存在字段

2.检查字段是否为可导入字段

客户导入

url示例参考:

http://$WEB_URL/api/v2/sj/import/object?domain=customer&project=$PROJECT&token=$API_SECRET

输入参数示例:

[POST /v2/sj/import/object?domain=customer]
 
Request (application/json)
 
 
[    
  {
    "csm_customer_cname": "string",
    "external_id": "string"
  }
]

参数说明如下:

参数

字段描述

类型/是否必传

说明

csm_customer_cname客户名称String/YEScsm_customer_cname 参数过长,最大限度为 255 个字符
external_id外部关联IDString/YESexternal_id 参数过长,最大限度为 50 个字符

返回结果示例:

{
  "total_count": 0,
  "success_count": 0,
  "insert_count": 0,
  "update_count": 0,
  "error_count": 0,
  "error_reason": "string",
  "error_info_list": [
    {
    "number": 0,
    "bean": {},
    "error_reason": "string",
    }
  ]
}

返回结果说明:

参数

字段描述

类型

说明

total_count上传数据的总条数Integer
success_count导入成功的条数Integer
insert_count新增插入的条数Integer
update_count更新的条数Integer
error_count错误总条数Integer
error_reason错误原因String
number导入的行号Number
bean错误的源数据信息
error_reason错误原因String
success_keys导入成功的字段String
fail_keys导入失败的字段String

1.检查数据表是否存在字段

2.检查字段是否为可导入字段

合同导入

url示例参考:

http://$WEB_URL/api/v2/sj/import/object?domain=contract&project=$PROJECT&token=$API_SECRET

输入参数示例:

[POST /v2/sj/import/object?domain=contract]
 
Request (application/json)
 
 
[    
  {
    "customer_id": "string",
    "external_id": "string",
    "order_no": "string",
    "type": "string",
    "begin_time": "string",
    "contract_no": "string",
    "status": "string",
    "original_contract_end_time": "string",
    "actual_end_time": "string",
    "money": 0,
    "owner": "string",
    "renew_amount": 0,
    "company_name": "string",
    "owner_department": "string"
  }
]

参数说明如下:

参数

字段描述

类型/是否必传

说明

customer_id客户idString/YES客户实体数据的 external_id ,合同会根据这个字段和客户进行关联
external_id外部关联IDString/YES该合同的唯一标识,用于识别业务系统( CRM )中客户、合同订单的关联关系
order_no销售订单编号String/YES表示业务含义上的销售订单编号
type合同类型String/YES新签、续费、增购、含续费的增购
begin_time合同开始时间String/YES签订的纸质合同上的合同开始日期,格式 yyyy-MM-dd
contract_no合同编号String/YES表示业务含义上的合同编号
status生效状态String/YES

表示合同在业务含义上的生效状态:

未生效、已生效、已作废
original_contract_end_time原合同结束时间String/YES签订的纸质合同上的合同结束日期格式 yyyy-MM-dd
actual_end_time合同实际结束时间String/YES默认为原合同结束日期,当由于某些原因,双方合作提前终止或者有赠送延期时,需要更新为实际结束日期,格式 yyyy-MM-dd
money合同金额Float/YES签订的纸质合同上的合同金额
owner归属人String/YES员工的英文名称( username )
renew_amount续订金额Float/YES合同到期后,去除一次性服务费、买断费之后,客户续约时应缴的金额
company_name公司名称String/NO业务含义,具体合同上的企业名称
owner_department归属部门String/YES合同收益的归属部门,通常是销售人员所在的部门


返回结果示例:

{
  "total_count": 0,
  "success_count": 0,
  "insert_count": 0,
  "update_count": 0,
  "error_count": 0,
  "error_reason": "string",
  "error_info_list": [
    {
    "number": 0,
    "bean": {},
    "error_reason": "string",
    }
  ]
}

返回结果说明:

参数

字段描述

类型

说明

total_count上传数据的总条数Integer
success_count导入成功的条数Integer
insert_count新增插入的条数Integer
update_count更新的条数Integer
error_count错误总条数Integer
error_reason错误原因String
number导入的行号Number
bean错误的源数据信息
error_reason错误原因String
success_keys导入成功的字段String
fail_keys导入失败的字段String

1.检查数据表是否存在字段

2.检查字段是否为可导入字段

客户联系人导入

url示例参考:

http://$WEB_URL/api/v2/sj/import/object?domain=customer_contact&project=$PROJECT&token=$API_SECRET

输入参数示例:

[POST /v2/sj/import/object?domain=customer_contact]
 
Request (application/json)
 
 
[    
  {
    "customer_id": "string",
    "external_id": "string",
    "name": "string",
    "title": "string",
    "phone": "string",
    "wechat": "string",
    "email":"",
    "qq":"",
    "dingding":"",
    "remarks":"",
    "key_contact": true
  }
]

参数说明如下:

参数

字段描述

类型/是否必传

说明

customer_id客户idString/YES客户实体数据的 external_id ,客户联系人会根据这个字段和客户进行关联
external_id外部关联IDString/YES客户联系人的唯一标识
name联系人名称String/YES
title职称String/NO
phone电话String/NO
wechat微信String/NO
email邮箱String/NO邮箱格式校验
qqqqString/NO
dingding钉钉String/NO
remarks备注String/NO
key_contact是否关键联系人Boolean/NO

返回结果示例:

{
  "total_count": 0,
  "success_count": 0,
  "insert_count": 0,
  "update_count": 0,
  "error_count": 0,
  "error_reason": "string",
  "error_info_list": [
    {
    "number": 0,
    "bean": {},
    "error_reason": "string",
    }
  ]
}

返回结果说明:

参数

字段描述

类型

说明

total_count上传数据的总条数Integer
success_count导入成功的条数Integer
insert_count新增插入的条数Integer
update_count更新的条数Integer
error_count错误总条数Integer
error_reason错误原因String
number导入的行号Number
bean错误的源数据信息
error_reason错误原因String
success_keys导入成功的字段String
fail_keys导入失败的字段String

1.检查数据表是否存在字段

2.检查字段是否为可导入字段

跟进记录导入

url示例参考:

http://$WEB_URL/api/v2/sj/import/object?domain=interactive_record&project=$PROJECT&token=$API_SECRET

输入参数示例:

[POST api/v2/import/object?domain=interactive_record]
 
Request (application/json)  
 
[    
  {
    "customer_id": "a88c573821214d45b6cbcc60ed127302",
    "external_id": "string",
    "stage": "实施交付",
    "description": "string",
    "type": "string"
  }
]

参数说明如下:

参数

字段描述

类型/是否必传

说明

customer_id客户idString/YES客户实体数据的 external_id,跟进记录会根据这个字段和客户进行关联
external_id外部关联IDString/YES跟进记录的唯一标识
stage业务主题String/YES业务主题中文名
description跟进内容String/YES跟进记录
type跟进方式String/YES

微信, 拜访, 电话, 其他

customer_contact对接人Integer/NO客户联系人的 external_id,可以将客户联系人关联跟进记录


返回结果示例:

{
  "total_count": 0,
  "success_count": 0,
  "insert_count": 0,
  "update_count": 0,
  "error_count": 0,
  "error_reason": "string",
  "error_info_list": [
    {
    "number": 0,
    "bean": {},
    "error_reason": "string",
    }
  ]
}

返回结果说明:

参数

字段描述

类型

说明

total_count上传数据的总条数Integer
success_count导入成功的条数Integer
insert_count新增插入的条数Integer
update_count更新的条数Integer
error_count错误总条数Integer
error_reason错误原因String
number导入的行号Number
bean错误的源数据信息
error_reason错误原因String


success_keys导入成功的字段String
fail_keys导入失败的字段String

1.检查数据表是否存在字段

2.检查字段是否为可导入字段