API开放平台

TIP

# KOL活动管理接口

# 新增KOL活动管理

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

{
  "activity_code": "kolActivity2024012200000055",
  "name": "kolActivity2024012200000055",
  "activity_desc": "新增活动类型",
  "activity_type": "7idSmsF2",
  "remark": "备注1",
  "mss_province": "江苏省",
  "mss_city": "南京市",
  "mss_district": "鼓楼区",
  "mss_street": "湖南路街道",
  "mss_address": "江苏省南京市鼓楼区汉口路汉口路小区",
  "mss_location_lon": "118.789089",
  "mss_location_lat": "32.055289",
  "mss_location_c": "江苏省南京市鼓楼区汉口路汉口路小区",
  "picture": [{
        "path": "http://image-test.waiqin365.com/6928113655533238100/kol/202407/20240726105839142.jpg",
        "name": "头像"
      }],
  "owner":"张三",
  "department":"部门1",
  "extFields": {
    "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"
      }
    ]
  },
  "kol_activity_report":[
	{
		"kol_id":"KOL1",
		"owner":"张三",
		"department":"部门1",
		"extFields": {
			"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"
		}
	}
  ],
  "kol_activity_product_details":[
	{
		"linkgoods":"可口可乐",
		"amount":3,
		"owner":"张三",
		"department":"部门1",
		"extFields": {
			"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"
		}
	}
  ]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
activity_code VARCHAR(200) 否 KOL活动编码，若是自动编码，传入也会保存覆盖
name VARCHAR(200) 是 KOL活动名称 必填
activity_desc VARCHAR(4000) 否 KOL活动描述
activity_type VARCHAR(200) 否 KOL活动类型，支持传入KOL活动类型的选项值名称、编码、id
remark VARCHAR(4000) 否 备注
mss_province VARCHAR(200) 否 省，支持传入省名称、省编码
mss_city VARCHAR(200) 否 市，支持传入市名称、市编码
mss_district VARCHAR(200) 否 区，支持传入区名称、区编码
mss_street VARCHAR(200) 否 街道/乡镇，支持传入街道/乡镇名称、街道/乡镇编码
mss_address VARCHAR(4000) 否 详细地址，支持传入详细地址名称
mss_location_lon VARCHAR(200) 否 定位--经度
mss_location_lat VARCHAR(200) 否 定位--纬度
mss_location_c VARCHAR(200) 否 标注位置字段展示的地址中文
picture List 否 json array格式.每个单元包含以下变量，path表示 文件全路径(带域名) name表示 图片名称，可传可不传,不传默认文件名称根据url上截取
owner VARCHAR(200) 否 负责人 ，支持传入负责人 名称、负责人 id
department VARCHAR(200) 否 部门，支持传入部门名称、部门id
extFields Map 否 扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)
kol_activity_report[].kol_id VARCHAR(200) 否 KOL，支持传入KOL名称、编码、id
kol_activity_report[].extFields Map 否 扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)
kol_activity_report[].owner VARCHAR(200) 否 负责人 ，支持传入负责人 名称、负责人 id
kol_activity_report[].department VARCHAR(200) 否 部门，支持传入部门名称、部门id
kol_activity_product_details[].linkgoods VARCHAR(200) 否 商品名称，支持传入商品名称名称、编码、id
kol_activity_product_details[].amount VARCHAR(200) 否 数量
kol_activity_product_details[].extFields Map 否 扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)
kol_activity_product_details[]owner VARCHAR(200) 否 负责人 ，支持传入负责人 名称、负责人 id
kol_activity_product_details[]department VARCHAR(200) 否 部门，支持传入部门名称、部门id

响应示例：

{
  "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/editKolActivity/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "id":"5817170219646182654",
  "activity_code": "kolActivity2024012200000055",
  "name": "kolActivity2024012200000055",
  "activity_desc": "新增活动类型",
  "activity_type": "7idSmsF2",
  "remark": "备注1",
  "mss_province": "江苏省",
  "mss_city": "南京市",
  "mss_district": "鼓楼区",
  "mss_street": "湖南路街道",
  "mss_address": "江苏省南京市鼓楼区汉口路汉口路小区",
  "mss_location_lon": "118.789089",
  "mss_location_lat": "32.055289",
  "mss_location_c": "江苏省南京市鼓楼区汉口路汉口路小区",
  "picture": [{
        "path": "http://image-test.waiqin365.com/6928113655533238100/kol/202407/20240726105839142.jpg",
        "name": "头像"
      }],
  "owner":"张三",
  "department":"部门1",
  "extFields": {
    "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"
      }
    ]
  },
  "kol_activity_report":[
	{
		"id":"6213577772908981787",
		"kol_id":"KOL1",
		"owner":"张三",
		"department":"部门1",
		"extFields": {
			"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"
		}
	}
  ],
  "kol_activity_product_details":[
	{
		"id":"5808825856684468756",
		"linkgoods":"可口可乐",
		"amount":3,
		"owner":"张三",
		"department":"部门1",
		"extFields": {
			"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"
		}
	}
  ]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
id VARCHAR(200) 是 KOL活动id
activity_code VARCHAR(200) 否 KOL活动编码，若是自动编码，传入也会保存覆盖
name VARCHAR(200) 是 KOL活动名称 必填
activity_desc VARCHAR(4000) 否 KOL活动描述
activity_type VARCHAR(200) 否 KOL活动类型，支持传入KOL活动类型的选项值名称、编码、id
remark VARCHAR(4000) 否 备注
mss_province VARCHAR(200) 否 省，支持传入省名称、省编码
mss_city VARCHAR(200) 否 市，支持传入市名称、市编码
mss_district VARCHAR(200) 否 区，支持传入区名称、区编码
mss_street VARCHAR(200) 否 街道/乡镇，支持传入街道/乡镇名称、街道/乡镇编码
mss_address VARCHAR(4000) 否 详细地址，支持传入详细地址名称
mss_location_lon VARCHAR(200) 否 定位--经度
mss_location_lat VARCHAR(200) 否 定位--纬度
mss_location_c VARCHAR(200) 否 标注位置字段展示的地址中文
picture List 否 json array格式.每个单元包含以下变量，path表示 文件全路径(带域名) name表示 图片名称，可传可不传,不传默认文件名称根据url上截取
owner VARCHAR(200) 否 负责人 ，支持传入负责人 名称、负责人 id
department VARCHAR(200) 否 部门，支持传入部门名称、部门id
extFields Map 否 扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)
kol_activity_report[].id VARCHAR(200) 否 KOL参与活动上报id
kol_activity_report[].kol_id VARCHAR(200) 否 KOL，支持传入KOL名称、编码、id
kol_activity_report[].extFields Map 否 扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)
kol_activity_report[].owner VARCHAR(200) 否 负责人 ，支持传入负责人 名称、负责人 id
kol_activity_report[].department VARCHAR(200) 否 部门，支持传入部门名称、部门id
kol_activity_product_details[].id VARCHAR(200) 否 KOL活动商品明细id
kol_activity_product_details[].linkgoods VARCHAR(200) 否 商品名称，支持传入商品名称名称、编码、id
kol_activity_product_details[].amount VARCHAR(200) 否 数量
kol_activity_product_details[].extFields Map 否 扩展字段集合。json数据格式为{"ext_keyA": "ext_valueA"}。参数格式参考 (opens new window)
kol_activity_product_details[].owner VARCHAR(200) 否 负责人 ，支持传入负责人 名称、负责人 id
kol_activity_product_details[].department VARCHAR(200) 否 部门，支持传入部门名称、部门id

响应示例：

{
  "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/kolActivity/v1/query/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "status": "1",
  "page": 1,
  "rows": 100,
  "sorts": [
    {
      "field_key" : "name",
      "type" : "asc"
    }
  ],
  "query_group": [
    {
      "connector": "or",
      "filters": [
        {
          "field_key": "name",
          "operator": "LIKE",
          "field_values": "object类型，可为list,string等"
        }
      ]
    }
  ]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
status VARCHAR(4) 否 记录状态。0：已删除，1：正常
page integer 否 页数，默认值为1
rows integer 否 条数，默认值为100
sorts List 否 排序，默认按创建时间倒序排序,格式参考示例
sorts.field_key VARCHAR(100) 否 排序字段
sorts.type VARCHAR(100) 否 排序类型：asc 正序，desc 倒序
query_group List 否 查询条件列表
query_group.connector VARCHAR(100) 否 组内查询条件，条件AND或OR
query_group.filters List 否 组内查询条件
query_group.filters.field_key VARCHAR(100) 否 字段key
query_group.filters.operator VARCHAR(100) 否 操作符，详见附录操作符说明
query_group.filters.field_values object 否 字段值集合

响应示例：

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

数据DATA示例:

[
    {
      "id" : "2024012200000055",
      "name" : "activity,",
      "activity_code" : "activity",
      "activity_desc" : "描述",
      "activity_type" : "activityTypeCode",
      "activity_type_name" : "typeName",
      "remark" : "备注",
      "owner" : "20240122000012342",
      "owner_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":"湖南路街道",
      "mss_address": "江苏省南京市鼓楼区汉口路汉口路小区",
      "mss_location" : "江苏省南京市鼓楼区汉口路汉口路小区",
      "picture" : "",
      "creator_id" : "20240122000012342",
      "creator_name" : "小张",
      "create_time" : "2022-01-22 15:02:02",
      "modifyier_id" : "20240122000012342",
      "modifyier_name" : "小张",
      "modify_time" : "2022-01-22 15:02:02",
      "status" : "1",
      "source_type" : "",
      "department_id" : "",
      "department_name" : "",
      "approval_status" : "1",
      "lock_status" : "0",
      "exts" : {
        "fieldKey" : {
          "code" : "",
          "value" : "",
          "status" : "",
          "label" : "",
          "format" : ""
        }
      }
    }
  ]

参数说明：

参数 类型 必填 说明
id VARCHAR(32) 是 ID
name VARCHAR(32) 是 名称
activity_code VARCHAR(32) 否 编码
activity_desc VARCHAR(200) 是 描述
activity_type VARCHAR(32) 是 KOL活动类型编码
activity_type_name VARCHAR(32) 是 KOL活动类型名称
remark VARCHAR(32) 是 备注
owner VARCHAR(200) 是 负责人id
owner_name VARCHAR(32) 是 负责人
mss_province VARCHAR(32) 是 省编码
mss_province_name VARCHAR(32) 是 省名称
mss_city VARCHAR(200) 是 市编码
mss_city_name VARCHAR(32) 是 市名称
mss_district VARCHAR(32) 是 区编码
mss_district_name VARCHAR(32) 是 街道编码
mss_address VARCHAR(200) 是 详细地址
mss_location VARCHAR(200) 是 标注位置地址
picture VARCHAR(32) 是 现场图片
creator_id VARCHAR(32) 是 创建人id
creator_name VARCHAR(200) 是 创建人
create_time VARCHAR(32) 是 创建时间
modifyier_id VARCHAR(32) 是 修改人id
modifyier_name VARCHAR(32) 是 修改人
modify_time VARCHAR(200) 是 修改时间
status VARCHAR(200) 是 状态
source_type VARCHAR(32) 是 来源
department_id VARCHAR(200) 是 部门id
department_name VARCHAR(32) 是 部门
approval_status VARCHAR(32) 是 审批状态
lock_status VARCHAR(32) 是 锁定状态
exts Map 是 自定义字段

# 删除KOL活动管理

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/kolActivity/v1/delete/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "ids": "2024012200000055,2024012200000056"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
ids VARCHAR 是 KOL活动管理id，多值逗号分隔

响应示例：

{
  "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活动上报接口 →