API开放平台

TIP

# 客户实名认证策略接口

# 新增客户实名认证策略

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

{      
    "strategy_remark": "备注1",
    "strategy_qince_dept_id": "5237580799511500761",
    "strategy_type": "1",
    "strategy_cm_level": "测试111,测试325",
    "strategy_cm_label_name": "关联企微,黄金门店",
    "strategy_qince_district_id": "7746732503466230871,6501896969301471753",
    "strategy_district_id": "123,22",
    "strategy_trade_type": "3",
    "strategy_auth_type": "4",
    "strategy_id": "csApi001",
    "strategy_dept_id": "100065",
    "strategy_cm_type_code": "shangchao,type1",
    "strategy_exts": [
        {
            "cm_ext_value": "中国人民银行",
            "cm_ext_key": "银行类别"
        },
        {
            "cm_ext_value": "餐饮渠道",
            "cm_ext_key": "渠道类型"
        }
    ],
    "strategy_cm_id": "ceshi224,ceshi233",
    "strategy_qince_cm_id": "7242751762064014520,8622155216670157685",
    "strategy_code": "csApi001",
    "strategy_direct_sale": "是",
    "strategy_name": "openapi测试1"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
strategy_id VARCHAR(100) 是 第三方系统的客户实名认证策略唯一ID
strategy_code VARCHAR(100) 是 策略编码
strategy_name VARCHAR(100) 是 策略名称
strategy_trade_type CHAR(1) 是 策略对象，2:经销商; 3:终端门店
strategy_auth_type CHAR(1) 是 认证方式，4:企业四要素; 3:企业三要素
strategy_type CHAR(1) 否 选择策略条件，1:按客户属性选择; 0:按指定客户选择
strategy_remark VARCHAR(200) 否 备注
strategy_dept_id VARCHAR(4000) 否 部门唯一标识，来源于第三方系统的部门唯一标识,和部门信息中org_id对应，部门ID和部门唯一标识如果同时存在优先取部门ID。选择策略条件为按客户属性选择时，部门必填；选择策略条件为按指定客户选择时，部门非必填；
strategy_qince_dept_id VARCHAR(4000) 否 部门ID，来源于勤策部门唯一ID。选择策略条件为按客户属性选择时，部门必填；选择策略条件为按指定客户选择时，部门非必填；
strategy_district_id VARCHAR(4000) 否 销售区域唯一标识，来源于第三方系统的唯一销售区域标识
strategy_qince_district_id VARCHAR(4000) 否 销售区域ID，来源于勤策的客户销售区域唯一ID，销售区域ID和销售区域唯一标识如果同时存在优先取销售区域ID
strategy_cm_type_code VARCHAR(4000) 否 客户类型编码
strategy_cm_level VARCHAR(4000) 否 客户级别
strategy_cm_label_name VARCHAR(4000) 否 客户标签名称。多标签以“,”分隔
strategy_direct_sale VARCHAR(10) 否 是否直接交易客户。只能填写“是”、“否”
strategy_cm_id VARCHAR(4000) 否 客户唯一标识，来源于第三方系统的客户唯一标识，客户ID和客户唯一标识如果同时存在优先取客户ID。
strategy_qince_cm_id VARCHAR(4000) 否 客户ID，来源于勤策客户唯一ID
strategy_exts.cm_ext_key VARCHAR(100) 否 客户信息扩展字段key值，客户信息扩展字段需先在勤策系统客户管理中创建自定义下拉字段
strategy_exts.cm_ext_value VARCHAR(100) 否 客户信息扩展字段value值对多个选项值，以“,”分隔拼接

响应示例：

{
    "msg_id": "{ msg_id }",
    "return_code": 0,
    "return_msg": "策略新增成功"
}

参数说明：

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

# 修改客户实名认证策略

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

{
         "strategy_remark": "备注1",
         "strategy_qince_dept_id": "5237580799511500761",
         "strategy_type": "1",
         "strategy_cm_level": "测试111,测试325",
         "strategy_cm_label_name": "关联企微,黄金门店",
         "strategy_qince_district_id": "7746732503466230871,6501896969301471753",
         "strategy_district_id": "123,22",
         "strategy_trade_type": "3",
         "strategy_auth_type": "4",
         "strategy_id": "csApi001",
         "strategy_dept_id": "100065",
         "strategy_cm_type_code": "shangchao,type1",
         "strategy_exts": [
             {
                 "cm_ext_value": "中国人民银行",
                 "cm_ext_key": "银行类别"
             },
             {
                 "cm_ext_value": "餐饮渠道",
                 "cm_ext_key": "渠道类型"
             }
         ],
         "strategy_cm_id": "ceshi224,ceshi233",
         "strategy_qince_cm_id": "7242751762064014520,8622155216670157685",
         "strategy_code": "csApi001",
         "strategy_direct_sale": "是",
         "strategy_name": "openapi测试1"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
strategy_id VARCHAR(100) 是 第三方系统的客户实名认证策略唯一ID
strategy_code VARCHAR(100) 是 策略编码
strategy_name VARCHAR(100) 是 策略名称
strategy_trade_type CHAR(1) 是 策略对象，2:经销商; 3:终端门店
strategy_auth_type CHAR(1) 是 认证方式，4:企业四要素; 3:企业三要素
strategy_type CHAR(1) 否 选择策略条件，1:按客户属性选择; 0:按指定客户选择
strategy_remark VARCHAR(200) 否 备注
strategy_dept_id VARCHAR(4000) 否 部门唯一标识，来源于第三方系统的部门唯一标识,和部门信息中org_id对应，部门ID和部门唯一标识如果同时存在优先取部门ID。选择策略条件为按客户属性选择时，部门必填；选择策略条件为按指定客户选择时，部门非必填；
strategy_qince_dept_id VARCHAR(4000) 否 部门ID，来源于勤策部门唯一ID。选择策略条件为按客户属性选择时，部门必填；选择策略条件为按指定客户选择时，部门非必填；
strategy_district_id VARCHAR(4000) 否 销售区域唯一标识，来源于第三方系统的唯一销售区域标识
strategy_qince_district_id VARCHAR(4000) 否 销售区域ID，来源于勤策的客户销售区域唯一ID，销售区域ID和销售区域唯一标识如果同时存在优先取销售区域ID
strategy_cm_type_code VARCHAR(4000) 否 客户类型编码
strategy_cm_level VARCHAR(4000) 否 客户级别
strategy_cm_label_name VARCHAR(4000) 否 客户标签名称。多标签以“,”分隔
strategy_direct_sale VARCHAR(10) 否 是否直接交易客户。只能填写“是”、“否”
strategy_cm_id VARCHAR(4000) 否 客户唯一标识，来源于第三方系统的客户唯一标识，客户ID和客户唯一标识如果同时存在优先取客户ID。
strategy_qince_cm_id VARCHAR(4000) 否 客户ID，来源于勤策客户唯一ID
strategy_exts.cm_ext_key VARCHAR(100) 否 客户信息扩展字段key值，客户信息扩展字段需先在勤策系统客户管理中创建自定义下拉字段
strategy_exts.cm_ext_value VARCHAR(100) 否 客户信息扩展字段value值对多个选项值，以“,”分隔拼接

响应示例：

{
    "msg_id": "{ msg_id }",
    "return_code": 0,
    "return_msg": "策略新增成功"
}

参数说明：

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

# 删除客户实名认证策略

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

{
         "strategy_id": "csApi001",
         "strategy_qince_id": "9108707916691308959"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
strategy_id VARCHAR(4000) 否 第三方系统的客户实名认证策略唯一ID，多个ID以“,”分隔拼接；和勤策的客户实名认证策略唯一ID不能同时为空
strategy_qince_id VARCHAR(4000) 否 勤策的客户实名认证策略唯一ID，多个ID以“,”分隔拼接；和第三方系统的客户实名认证策略唯一ID不能同时为空，strategy_qince_id和strategy_id都有值优先取strategy_qince_id

响应示例：

{
    "msg_id": "{ msg_id }",
    "return_code": 0,
    "return_msg": "策略删除成功"
}

参数说明：

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

# 查询客户实名认证策略

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

{
         "page_number": "1",
         "strategy_trade_type": "3",
         "strategy_id": "csApi001",
         "strategy_remark": "备注1",
         "strategy_status": "1",
         "strategy_type": "1",
         "strategy_qince_id": "9108707916691308959",
         "strategy_code": "csApi001",
         "strategy_name": "openapi测试1"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
page_number INT 否 分页页码，默认1
strategy_id VARCHAR(4000) 否 第三方系统的客户实名认证策略唯一ID，多个ID以“,”分隔拼接；
strategy_qince_id VARCHAR(4000) 否 勤策的客户实名认证策略唯一ID，多个ID以“,”分隔拼接；
strategy_status CHAR(1) 否 策略状态，0:删除;1:正常
strategy_code VARCHAR(200) 否 策略编码
strategy_name VARCHAR(200) 否 策略名称
strategy_trade_type VARCHAR(200) 否 策略对象，2:经销商; 3:终端门店
strategy_remark VARCHAR(200) 否 备注
strategy_type CHAR(1) 否 选择策略条件，1:按客户属性选择; 0:按指定客户选择

响应示例：

{
    "msg_id": "{ msg_id }",
    "return_code": 0,
    "return_data": "<<DATA>>",
    "return_msg": "策略查询成功"
}

数据DATA示例:

{
    "count": 1,
    "page_no": 1,
    "strategyList": [
        {
            "strategy_id": "csApi001",
            "strategy_qince_id": "9108707916691308959",
            "strategy_code": "csApi001",
            "strategy_name": "openapi测试1",
            "strategy_trade_type": "3",
            "strategy_auth_type": "4",
            "strategy_remark": "备注1",
            "strategy_type": "1",
            "strategy_dept_id": "100065,100077",
            "strategy_dept_name": "长沙仓,华中区",
            "strategy_qince_dept_id": "5237580799511500761,5238038512389716597",
            "strategy_district_id": "123,22",
            "strategy_district_name": "南京,浙江",
            "strategy_qince_district_id": "7746732503466230871,6501896969301471753",
            "strategy_cm_type_code": "",
            "strategy_cm_type_name": "",
            "strategy_cm_level": null,
            "strategy_cm_label_name": "",
            "strategy_direct_sale": "是",
            "strategy_exts": [
                {
                    "cm_ext_column": "exdf_828506",
                    "cm_ext_key": "银行类别",
                    "cm_ext_value": "中国人民银行"
                },
                {
                    "cm_ext_column": "exdf_198305",
                    "cm_ext_key": "渠道类型",
                    "cm_ext_value": "餐饮渠道"
                }
            ]
        }
    ]
}

参数说明：

参数 类型 说明
count INT 总数
page_no INT 页码
strategy_id VARCHAR(100) 第三方系统的客户实名认证策略唯一ID
strategy_code VARCHAR(100) 策略编码
strategy_name VARCHAR(100) 策略名称
strategy_trade_type CHAR(1) 策略对象，2:经销商; 3:终端门店
strategy_auth_type CHAR(1) 认证方式，4:企业四要素; 3:企业三要素
strategy_type CHAR(1) 选择策略条件，1:按客户属性选择; 0:按指定客户选择
strategy_remark VARCHAR(200) 备注
strategy_dept_id VARCHAR(4000) 部门唯一标识，来源于第三方系统的部门唯一标识,和部门信息中org_id对应，部门ID和部门唯一标识如果同时存在优先取部门ID。选择策略条件为按客户属性选择时，部门必填；选择策略条件为按指定客户选择时，部门非必填；
strategy_qince_dept_id VARCHAR(4000) 部门ID，来源于勤策部门唯一ID。选择策略条件为按客户属性选择时，部门必填；选择策略条件为按指定客户选择时，部门非必填；
strategy_dept_name VARCHAR(4000) 部门名称
strategy_district_id VARCHAR(4000) 销售区域唯一标识，来源于第三方系统的唯一销售区域标识
strategy_qince_district_id VARCHAR(4000) 销售区域ID，亲测的客户销售区域唯一ID，销售区域ID和销售区域唯一标识如果同时存在优先取销售区域ID
strategy_district_name VARCHAR(4000) 销售区域名称
strategy_cm_type_code VARCHAR(4000) 客户类型编码
strategy_cm_type_name VARCHAR(4000) 客户类型名称
strategy_cm_level VARCHAR(4000) 客户级别
strategy_cm_label_name VARCHAR(4000) 客户标签名称。多标签以“,”分隔
strategy_direct_sale VARCHAR(10) 是否直接交易客户。只能填写“是”、“否”
strategy_cm_id VARCHAR(4000) 客户唯一标识，来源于第三方系统的客户唯一标识，客户ID和客户唯一标识如果同时存在优先取客户ID。
strategy_qince_cm_id VARCHAR(4000) 客户ID，来源于勤策客户唯一ID
strategy_exts.cm_ext_key VARCHAR(100) 客户信息扩展字段key值，客户信息扩展字段需先在勤策系统客户管理中创建自定义下拉字段
strategy_exts.cm_ext_value VARCHAR(100) 客户信息扩展字段value值对多个选项值，以“,”分隔拼接
strategy_exts.cm_ext_column VARCHAR(100) 来源于勤策中自定义字段的code，以“,”分隔拼接

← 客户实名认证接口 →