# 客户标签接口
# 创建客户标签属性
请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/cusLabel/v1/createCusLabel/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：
参数说明：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| trade_type | VARCHAR(1) | 是 | 客户分类。1：客户，2：经销商，3：门店 |
| label_name | VARCHAR(100) | 是 | 标签名称（将要创建的客户标签的名称） |
| color | VARCHAR(100) | 是 | 按钮颜色 |
| border_color | VARCHAR(100) | 是 | 边界颜色 |
| background_color | VARCHAR(100) | 是 | 背景颜色 |
| forbid_manual_modify | CHAR(1) | 否 | 允许手工修改（传空），不允许手工修改（传1） |
| group_name | VARCHAR(100) | 否 | 标签分组，只允许传输一个，传分组中文名称，查询无对应分组，到默认分组：手工设置标签。为空，到默认分组：手工设置标签 |
响应示例：
{
"return_code": 0,
"return_msg": "响应信息",
"msg_id": "{ msg_id }"
}
# 查询客户标签属性
请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/cusLabel/v1/queryCusLabel/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：
参数说明：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| trade_type | VARCHAR(100) | 否 | 客户分类。1：客户，2：经销商，3：门店 |
| label_name | VARCHAR(100) | 否 | 标签名称，如果该传入字段为空，则默认返回指定客户类型的所有标签。如果该传入字段不为空，则仅返回要查询的标签 |
响应示例：
{
"return_code": 0,
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"trade_type":"1",
"label_name":"test4",
"label_id":8939187171037089569,
"create_time": "2022-01-01 00:10:00",
"modify_time": "2022-03-01 00:10:00",
"sub_labels": [
{
"label_name": "child-label",
"label_id": 8939187171037089569
}
]
},
{
"trade_type":"1",
"label_name":"test5",
"label_id":8939187171123459265,
"create_time": "2022-01-01 00:10:00",
"modify_time": "2022-03-01 00:10:00",
"sub_labels": []
}
]
参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| trade_type | VARCHAR(1) | 客户分类。1：客户，2：经销商，3：门店 |
| label_id | VARCHAR(100) | 客户标签在365系统中的唯一标识 |
| label_name | VARCHAR(100) | 标签名称 |
| create_time | VARCHAR(100) | 创建时间。格式：yyyy-MM-dd HH:mm:ss |
| modify_time | VARCHAR(100) | 更新时间。格式：yyyy-MM-dd HH:mm:ss |
| sub_labels | LIST | 子标签列表 |
| sub_labels.label_id | VARCHAR(100) | 客户子标签在365系统中的唯一标识 |
| sub_labels.label_name | VARCHAR(100) | 子标签名称 |
# 批量客户打标签属性
请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/cusLabel/v1/batchAddCusLabel/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：
参数说明：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| trade_type | VARCHAR(1) | 是 | 客户分类。1：客户，2：经销商，3：门店 |
| lst_ids | VARCHAR(100) | 是 | 需要打标签的客户列表，传入客户ID，lst_codes 有值则可为空 |
| lst_codes | VARCHAR(100) | 是 | 需要打标签的客户列表，传入客户编码，lst_ids 有值则可为空，同时有值时，优先取lst_ids字段值 |
| label_name | VARCHAR(100) | 否 | 标签名称。优先读取标签id字段，如果标签id为空，则再读取标签名称字段 |
| label_id | VARCHAR(100) | 否 | 标签id，这是客户标签在365系统中的唯一标识。如果该字段不为空，则不再读取标签名称字段值 |
响应示例：
{
"return_code": 0,
"return_msg": "响应信息",
"msg_id": "{ msg_id }"
}
# 批量客户清空标签属性
请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/cusLabel/v1/batchClearCusLabel/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：
参数说明：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| trade_type | VARCHAR(1) | 是 | 客户分类。1：客户，2：经销商，3：门店 |
| lst_ids | VARCHAR(100) | 是 | 需要清空标签的客户列表，传入客户ID，lst_codes 有值则可为空 |
| lst_codes | VARCHAR(100) | 是 | 需要清空标签的客户列表，传入客户编码，lst_ids 有值则可为空，同时有值时，优先取lst_ids |
| label_name | VARCHAR(100) | 否 | 标签名称。优先读取标签id字段，如果标签id为空，再读取标签名称字段，并对传入的所有客户，清空该字段对应的标签。如果标签id、标签名称均为空，则表示清空传入客户的所有标签 |
| label_id | VARCHAR(100) | 否 | 标签id，这是客户标签在365系统中的唯一标识。如果该字段不为空，则不再读取标签名称字段值，并对传入的所有客户，清空该字段对应的标签 |
响应示例：
{
"return_code": 0,
"return_msg": "响应信息",
"msg_id": "{ msg_id }"
}
# 删除客户标签属性
请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/cusLabel/v1/deleteCusLabel/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：
参数说明：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| trade_type | VARCHAR(1) | 是 | 客户分类。1：客户，2：经销商，3：门店 |
| label_name | VARCHAR(100) | 否 | 标签名称。优先读取标签id字段，如果标签id为空，再读取标签名称字段。删除标签的同时，所有打上该标签的客户会自动删除该标签 |
| label_id | VARCHAR(100) | 否 | 客户标签在365系统中的唯一标识。如果该字段不为空，则不再读取标签名称字段值。删除标签的同时，所有打上该标签的客户会自动删除该标签 |
响应示例：
{
"return_code": 0,
"return_msg": "响应信息",
"msg_id": "{ msg_id }"
}
# 查询客户标签关系记录
请求方式： POST（HTTPS）
请求地址： https://openapi.qince.com/api/cusLabel/v1/queryCusLabelRel/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：
参数说明：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| label_id | VARCHAR(100) | 否 | 标签ID，非必传，若传空，则默认需要返回所有的客户标签关系记录 |
| page_number | VARCHAR(100) | 否 | 分页页码，默认值为1 |
| page_size | VARCHAR(100) | 否 | 每页数据条数，默认1000条 |
响应示例：
{
"return_code": 0,
"return_msg": "响应信息",
"msg_id": "{ msg_id }",
"response_data": "<<DATA>>"
}
数据DATA示例:
[
{
"id":"23423234",
"label_id":"1978908007",
"sub_label_id":"865758587587856",
"cm_id":"CM001",
"cm_waiqin365_id":"8939187171030000001"
},
{
"id":"54634636",
"label_id":"1346534635",
"sub_label_id":"858576366363",
"cm_id":"CM002",
"cm_waiqin365_id":"89391871710370000002"
}
]
参数说明：
| 参数 | 类型 | 说明 |
|---|---|---|
| id | VARCHAR(100) | 关系记录id |
| label_id | VARCHAR(100) | 父标签id |
| sub_label_id | VARCHAR(100) | 子标签id |
| cm_id | VARCHAR(100) | 来源于第三方系统的客户唯一ID |
| cm_waiqin365_id | VARCHAR(100) | 勤策的客户唯一ID |