# KOL信息接口

# 新增KOL信息

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/kol/v1/addKol/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
  "name": "kol2024012200000055",
  "code": "kol2024012200000055",
  "type_id": "5384799970125672889",
  "type_code": "AA",
  "type_name": "类型A",
  "customer_level": "9059239336101111054",
  "customer_level_name": "级别2",
  "dept_waiqin365_id": "6351818345948560160",
  "dept_waiqin365_name": "产品部",
  "manager_id": "6915795285987735814",
  "manager_name": "王云",
  "assistant_ids": "5098161906671077675,6915795285987735814",
  "assistant_names": "王云,李青",
  "mss_province": "320000",
  "mss_province_name": "江苏省",
  "mss_city": "320100",
  "mss_city_name": "南京市",
  "mss_area": "320106",
  "mss_area_name": "鼓楼区",
  "mss_street": "320106003",
  "mss_street_name": "湖南路街道",
  "addr": "江苏省南京市鼓楼区汉口路汉口路小区",
  "address": "江苏省南京市鼓楼区汉口路汉口路小区",
  "longitude": "118.789089",
  "latitude": "32.055289",
  "cooperate_status": "1",
  "cooperate_status_name": "合作中",
  "sale_model": "0",
  "tel": "12323232132",
  "post": "330021",
  "fax": "86-999001",
  "website": "https://qince.com/",
  "remarks": "勤策公司",
  "sex": "1",
  "solar_birthday": "2000-02-01",
  "lunar_birthday": "2000-03-20",
  "hobby": "打篮球",
  "current_unit": "勤策公司",
  "current_tenure": "2.50",
  "city_id_code": "320100",
  "city_id_name": "",
  "exts": {
    "field_kig9p__cywdzm9": "10000.00",
    "field_dacfk__cxuv3jd": "1214123412341234",
    "field_puezh__cdc07gx": "12341234125463457634567",
    "field_db3nn__ctvj575": "2024-07-26",
    "field_xvw5t__cz8n029": "j8gKhgpu",
    "field_swe5j__cpzhpuj": "xA62mwYV,QlmleNPY",
    "field_hlwzg__ccnf37g": [
      {
        "path": "kol/202407/20240726105836448.jpg",
        "name": "",
        "url": "http://image-test.waiqin365.com/6928113655533238100/kol/202407/20240726105836448.jpg"
      },
      {
        "path": "kol/202407/20240726105839142.jpg",
        "name": "",
        "url": "http://image-test.waiqin365.com/6928113655533238100/kol/202407/20240726105839142.jpg"
      }
    ],
    "field_xwbzr__cme9olm": [
      {
        "path": "kol/202407261051786.zip",
        "fileSize": 19808,
        "name": "slidingscreen.zip",
        "url": "http://image-test.waiqin365.com/6928113655533238100/kol/202407261051786.zip"
      },
      {
        "path": "kol/202407261051258.jpg",
        "fileSize": 701562,
        "name": "R-C.jpg",
        "url": "http://image-test.waiqin365.com/6928113655533238100/kol/202407261051258.jpg"
      }
    ]
  }
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
name VARCHAR(100) KOL姓名,有效字符详见附录:有效字符说明 (opens new window)
code VARCHAR(32) KOL编码,状态为正常的客户编码唯一,有效字符详见附录:有效字符说明 (opens new window)
type_id VARCHAR(100) KOL类型id。
type_code VARCHAR(100) KOL类型编码。type_id 存在优先取type_id
type_name VARCHAR(100) KOL类型名称。type_code 存在优先取 type_code
customer_level VARCHAR(100) KOL级别编码
customer_level_name VARCHAR(100) KOL级别名称
dept_waiqin365_id VARCHAR(100) KOL所属部门ID,来源于勤策部门唯一ID
dept_waiqin365_name VARCHAR(100) KOL所属部门名称,来源于勤策部门名称
manager_id VARCHAR(4000) KOL客户经理唯一标识,多客户经理唯一标识间以“,”分隔。来源于勤策的员工唯一标识
manager_name VARCHAR(4000) KOL客户经理名称。多客户经理唯一标识间以“,”分隔。来源于勤策的员工名称
assistant_id VARCHAR(4000) KOL客户协助员唯一标识。 多协助员唯一标识以“,”分隔。来源于勤策员工唯一标识
assistant_name VARCHAR(4000) KOL客户协助员名称。多协助员以“,”分隔。来源于勤策的员工名称
mss_province VARCHAR(32) KOL所属行政区域-省编码,如是直辖市,省和市请传一样的值
mss_province_name VARCHAR(32) KOL所属行政区域-省名称,如是直辖市,省和市请传一样的值。优先取 mss_province
mss_city VARCHAR(32) KOL所属行政区域-市编码,如是直辖市,省和市请传一样的值
mss_city_name VARCHAR(32) KOL所属行政区域-市名称,如是直辖市,省和市请传一样的值。优先取 mss_city
mss_area VARCHAR(32) KOL所属行政区域-区县编码,如是直筒子市,市和县请传一样的值
mss_area_name VARCHAR(32) KOL所属行政区域-区县名称,如是直筒子市,市和县请传一样的值。优先取 mss_area
mss_street VARCHAR(100) KOL所属行政区域-乡镇街道编码
mss_street_name VARCHAR(100) KOL所属行政区域-乡镇街道名称。优先取 mss_street
addr VARCHAR(4000) KOL详细地址
address VARCHAR(4000) KOL定位地址
longitude VARCHAR(100) KOL定位地址,经度。如:32.055289
latitude VARCHAR(100) KOL定位地址,纬度。如:118.797087
cooperate_status CHAR(1) 合作状态。0:终止合作,1:合作中,2:未合作,3:有意向
cooperate_status_name VARCHAR(32) 合作状态:终止合作/合作中/未合作/有意向/{自定义的},cooperate_status,cooperate_status_name如果同时存在优先取cooperate_status
sale_model VARCHAR(100) 是否直接交易客户。只能填写“1”、“0”
tel VARCHAR(32) 电话, 如:02544550010或025-44550010
post VARCHAR(32) 邮编
fax VARCHAR(32) 传真, 如:02544550010或025-44550010
website VARCHAR(32) 网址
remarks VARCHAR(4000) 备注
sex VARCHAR(100) 性别。传入1 代表示男,传入0 代表女
solar_birthday VARCHAR(100) 阳历生日,格式yyyy-mm-dd
lunar_birthday VARCHAR(100) 农历生日,格式yyyy-mm-dd
hobby VARCHAR(100) 个人爱好
current_unit VARCHAR(100) 所在单位
current_tenure VARCHAR(100) 当前在职年限(年)。填写数字,如:1
city_id_code VARCHAR(32) 所在城市编码。所在城市配置手动维护时生效,对应省市区码。
city_id_mame VARCHAR(100) 所在城市名称。所在城市配置手动维护时生效,对应省市区名称(city_id_code存在则以该字段为准)
exts Map 客户信息扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)

响应示例:

{
  "msg_id": "X000001",
  "return_code": 0,
  "return_msg": "",
  "response_data": null
}

参数说明:

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0:成功,1:失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
response_data String 响应数据

# 查询KOL信息

请求方式: POST(HTTPS
请求地址: https://openapi.waiqin365.com/api/kol/v1/queryKol/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
  "status": "1",
  "tel": "15100892132",
  "page": "1",
  "rows": "100",
  "sorts": [
    {
      "field_key": "create_time",
      "type": "desc"
    }
  ],
  "query_group": [
    {
      "connector": "OR",
      "filters": [
        {
          "field_key": "field_t648t__cbjfc8c",
          "operator": "ISN"
        }
      ]
    },
    {
      "connector": "OR",
      "filters": [
        {
          "field_key": "field_xjcv4__c1u5edm",
          "operator": "NQ",
          "field_values": [
            "1"
          ]
        }
      ]
    }
  ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
tel VARCHAR(30) 支持传入电话,查询电话字段等于企业入参值的KOL数据,按出参返回KOL数据
name VARCHAR(200) KOL姓名,精确查询符合企业入参的KOL姓名
create_time_start VARCHAR(200) 创建时间开始,格式:yyyy-MM-dd HH:mm
create_time_end VARCHAR(200) 创建时间结束,格式:yyyy-MM-dd HH:mm
modify_time_start VARCHAR(200) 修改时间开始,格式:yyyy-MM-dd HH:mm
modify_time_end VARCHAR(200) 修改时间结束,格式:yyyy-MM-dd HH:mm
manager_name TEXT 客户经理名称,查询包含企业入参的客户经理名称的KOL数据
status CHAR(1) 记录状态。0:已删除,1:正常。
page INT 页数,默认值为1。
rows INT 条数,默认值为100。
sorts List 排序,默认按创建时间倒序排序。
sorts.field_key VARCHAR(30) 排序字段。
sorts.type VARCHAR(4) 排序类型:asc 正序,desc 倒序。
query_group List 查询条件列表
query_group.connector List 组内查询条件,条件AND或OR
query_group.filters VARCHAR(4) 组内查询条件
query_group.filters.field_key VARCHAR(32) 字段key
query_group.filters.operator VARCHAR(10) 操作符,详见附录操作符说明 (opens new window)
query_group.filters.field_values List 字段值集合

响应示例:

{
  "return_code": "0",
  "return_msg": "响应信息",
  "msg_id": "{ msg_id }",
  "response_data": "<<DATA>>"
}

数据DATA示例:

[
  {
    "id": "7627093746525054454",
    "status": "1",
    "source_type": "1",
    "source_type_name": "自建",
    "name": "kol2024012200000055",
    "code": "kol2024012200000055",
    "type_id": "5384799970125672889",
    "type_name": "类型A",
    "customer_level": "9059239336101111054",
    "customer_level_name": "级别2",
    "dept_waiqin365_id": "6351818345948560160",
    "dept_waiqin365_name": "产品部",
    "manager_id": "6915795285987735814",
    "manager_name": "王云",
    "assistant_ids": "5098161906671077675,6915795285987735814",
    "assistant_names": "王云,李青",
    "mss_country": "86",
    "mss_country_name": "中国",
    "mss_province": "320000",
    "mss_province_name": "江苏省",
    "mss_city": "320100",
    "mss_city_name": "南京市",
    "mss_area": "320106",
    "mss_area_name": "鼓楼区",
    "mss_street": "320106003",
    "mss_street_name": "湖南路街道",
    "addr": "江苏省南京市鼓楼区汉口路汉口路小区",
    "address": "江苏省南京市鼓楼区汉口路汉口路小区",
    "longitude": "118.789089",
    "latitude": "32.055289",
    "cooperate_status": "1",
    "cooperate_status_name": "合作中",
    "sale_model": "0",
    "sale_model_name": "是",
    "tel": "12323232132",
    "post": "330021",
    "fax": "86-999001",
    "website": "https://qince.com/",
    "remarks": "勤策公司",
    "sex": "1",
    "sex_name": "男",
    "solar_birthday": "2000-02-01",
    "lunar_birthday": "2000-03-20",
    "hobby": "打篮球",
    "current_unit": "勤策公司",
    "current_tenure": "2.50",
    "city_id": "4649070459465534932",
    "city_id_name": "南京市",
    "creator_id": "998",
    "creator_name": "系统",
    "create_time": "2024-07-29 14:22:26",
    "modifyier_id": "998",
    "modifyier_name": "系统",
    "modify_time": "2024-07-29 14:22:26",
    "exts": {
      "field_kig9p__cywdzm9": "10000.00",
      "field_db3nn__ctvj575": {
        "format": "YYYY-MM-DD",
        "value": "2024-07-26"
      },
      "field_dacfk__cxuv3jd": "1214123412341234",
      "field_puezh__cdc07gx": "12341234125463457634567",
      "field_hlwzg__ccnf37g": [
        {
          "path": "kol/202407/20240726105836448.jpg",
          "name": "",
          "url": "http://image-test.waiqin365.com/6928113655533238100/kol/202407/20240726105836448.jpg"
        },
        {
          "path": "kol/202407/20240726105839142.jpg",
          "name": "",
          "url": "http://image-test.waiqin365.com/6928113655533238100/kol/202407/20240726105839142_88364b70.jpg"
        }
      ],
      "field_xvw5t__cz8n029": {
        "code": "j8gKhgpu",
        "label": "选项1",
        "status": ""
      },
      "field_xwbzr__cme9olm": [
        {
          "path": "kol/202407261051786.zip",
          "fileSize": 19808,
          "name": "slidingscreen.zip",
          "url": "http://image-test.waiqin365.com/6928113655533238100/kol/202407261051786.zip"
        },
        {
          "path": "kol/202407261051258.jpg",
          "fileSize": 701562,
          "name": "R-C.jpg",
          "url": "http://image-test.waiqin365.com/6928113655533238100/kol/202407261051258.jpg"
        }
      ],
      "field_swe5j__cpzhpuj": [
        {
          "code": "xA62mwYV",
          "label": "选项2",
          "status": ""
        },
        {
          "code": "QlmleNPY",
          "label": "选项1",
          "status": ""
        }
      ]
    }
  }
]

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 勤策的客户唯一ID
status CHAR(1) KOL删除状态。0:删除,1:正常
source_type VARCHAR(32) KOL数据来源。
source_type_name VARCHAR(32) KOL数据来源名称。
name VARCHAR(100) KOL姓名
code VARCHAR(32) KOL编码
type_id VARCHAR(100) KOL类型id
type_name VARCHAR(100) KOL类型名称
customer_level VARCHAR(100) KOL级别编码
customer_level_name VARCHAR(100) KOL级别名称
dept_waiqin365_id VARCHAR(100) KOL所属部门ID,来源于勤策部门唯一ID
dept_waiqin365_name VARCHAR(100) KOL所属部门名称,来源于勤策部门名称
manager_id VARCHAR(4000) KOL客户经理唯一标识,多客户经理唯一标识间以“,”分隔。来源于勤策的员工唯一标识
manager_name VARCHAR(4000) KOL客户经理名称。多客户经理唯一标识间以“,”分隔。来源于勤策的员工名称
assistant_id VARCHAR(4000) KOL客户协助员唯一标识。 多协助员唯一标识以“,”分隔。来源于勤策员工唯一标识
assistant_name VARCHAR(4000) KOL客户协助员名称。多协助员以“,”分隔。来源于勤策的员工名称
mss_country VARCHAR(32) KOL所属行政区域-国家编码。
mss_country_name VARCHAR(32) KOL所属行政区域-国家名称。
mss_province VARCHAR(32) KOL所属行政区域-省编码
mss_province_name VARCHAR(32) KOL所属行政区域-省名称
mss_city VARCHAR(32) KOL所属行政区域-市编码
mss_city_name VARCHAR(32) KOL所属行政区域-市名称
mss_area VARCHAR(32) KOL所属行政区域-县编码
mss_area_name VARCHAR(32) KOL所属行政区域-县名称
mss_street VARCHAR(32) KOL所属行政区域-乡镇/街道编码
mss_street_name VARCHAR(32) KOL所属行政区域-乡镇/街道名称
addr VARCHAR(4000) KOL详细地址
address VARCHAR(4000) KOL定位地址
longitude VARCHAR(100) KOL定位地址,经度。如:32.055289
latitude VARCHAR(100) KOL定位地址,纬度。如:118.797087
cooperate_status CHAR(1) 合作状态。0:终止合作,1:合作中,2:未合作,3:有意向
cooperate_status_name VARCHAR(32) 合作状态:终止合作/合作中/未合作/有意向/{自定义的}
sale_model VARCHAR(100) 是否直接交易客户。只能填写“1”、“0”
sale_model_name VARCHAR(100) 是否直接交易客户。只能填写“是”、“否”
tel VARCHAR(32) 电话, 如:02544550010或025-44550010
post VARCHAR(32) 邮编
fax VARCHAR(32) 传真, 如:02544550010或025-44550010
website VARCHAR(32) 网址
remarks VARCHAR(4000) 备注
sex VARCHAR(100) 性别。传入1 代表示男,传入0 代表女
sex_name VARCHAR(100) 性别名称。传入1 代表示男,传入0 代表女
solar_birthday VARCHAR(100) 阳历生日,格式yyyy-mm-dd
lunar_birthday VARCHAR(100) 农历生日,格式yyyy-mm-dd
hobby VARCHAR(100) 个人爱好
current_unit VARCHAR(100) 所在单位
current_tenure VARCHAR(100) 当前在职年限(年)
city_id VARCHAR(32) 所在城市id。
city_id_mame VARCHAR(100) 所在城市名称。
creator_id VARCHAR(100) 创建人id,来源勤策的唯一ID
creator_name VARCHAR(100) 创建人名称
create_time CHAR(19) 创建时间。格式:yyyy-MM-dd HH:mm:ss
modifyier_id VARCHAR(100) 修改人id,来源勤策的唯一ID
modifyier_name VARCHAR(100) 修改人名称
modify_time VARCHAR(100) 修改时间。格式:yyyy-MM-dd hh:mm:ss
exts Map 客户信息扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)
exts.key VARCHAR(100) 客户信息扩展字段key。对象自定义字段key。
exts.value VARCHAR(100) 客户信息扩展字段value。对象自定义字段值。
单行文本/多行文本/数值字段,值为字符串;
日期字段,值为{"format":"YYYY-MM-DD","value":"2024-07-26"};
单选字段,值为{"code":"","label":"","status":""};
多选字段,值为[{"code":"","label":"","status":""}];
图片/附件字段,值为[{"path":"","fileSize":1,"name":"","url":""}]