开放接口API说明-客户信息接口

参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 新增客户
接口编码 addCustomer
接口URL https://openapi.waiqin365.com/api/customer/v1/addCustomer/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,来源于第三方系统的唯一客户标识,有效字符详见附录:编码类型参照表
cm_name VARCHAR(100) 客户名称,有效字符详见附录:编码类型参照表
cm_code VARCHAR(32) 客户编码,状态为正常的客户编码唯一,有效字符详见附录:编码类型参照表
cm_manager_id VARCHAR(4000) 客户经理唯一标识,多客户经理唯一标识间以“,”分隔。来源于第三方系统的员工唯一标识和员工信息中emp_id对应。 如:EMP0001, EMP0002, EMP0003
cm_manager VARCHAR(4000) 客户经理名称,多客户经理名称间以“,”分隔。如果和cm_manager_id同时传入时,以cm_manager_id数据为准。如:张三,李四,王五
cm_type_code VARCHAR(100) 客户类型编码
cm_type VARCHAR(100) 客户类型名称,如果和客户类型编码cm_type_code都传时,以cm_type_code数据为准
cm_district_waiqin365_id VARCHAR(32) 客户所属销售区域ID,来源于外勤365的销售区域唯一ID。
cm_district VARCHAR(1000) 客户所属销售区域名称,此字段需要销售区域的完整层级结构名称,多层级间以“,”分隔。如果和外勤365客户销售区域IDcm_district_waiqin365_id同时传入时,以cm_district_waiqin365_id数据为准。如:华中大区,南京分区,秦淮社区
cm_dept_waiqin365_id VARCHAR(32) 客户所属部门ID,来源于外勤365部门唯一ID
cm_dept_id VARCHAR(32) 客户所属部门唯一标识,来源于第三方系统的部门唯一标识和部门信息中org_id对应,如果和外勤365部门IDcm_dept_waiqin365_id同时传入时,以cm_dept_waiqin365_id数据为准
cm_mss_province VARCHAR(32) 客户所属行政区域-省名称
cm_mss_city VARCHAR(32) 客户所属行政区域-市名称
cm_mss_area VARCHAR(32) 客户所属行政区域-区县名称
cm_addr VARCHAR(4000) 客户地址
cm_cooperate_status_name VARCHAR(32) 合作状态:终止合作/合作中/未合作/有意向/{自定义的},如果同时传入cm_cooperate_status字段,则以cm_cooperate_status数据为准
cm_cooperate_status CHAR(1) 合作状态, 0-终止合作 1-合作中, 2-未合作, 3-有意向
cm_uper_customer VARCHAR(100) 上级客户
cm_level VARCHAR(100) 客户级别
cm_source VARCHAR(100) 客户来源
cm_trade VARCHAR(100) 客户行业
cm_scale VARCHAR(100) 客户人员规模
cm_tel VARCHAR(32) 客户电话, 如:02544550010或025-44550010
cm_fax VARCHAR(32) 客户传真, 如:02544550010或025-44550010
cm_post VARCHAR(32) 客户邮编
cm_remarks VARCHAR(4000) 客户备注
linkmans[].cm_linkman_name VARCHAR(100) 客户联系人名称
linkmans[].cm_linkman_job VARCHAR(32) 客户联系人职务
linkmans[].cm_linkman_mobile VARCHAR(32) 客户联系人手机
linkmans[].cm_linkman_office_tel VARCHAR(32) 客户联系人固定电话, 如:02544550010或025-44550010
linkmans[].cm_linkman_fax VARCHAR(32) 客户联系人传真, 如:02544550010或025-44550010
linkmans[].cm_linkman_sex VARCHAR(1) 客户联系人性别,F-女性 M-男性,默认值:M
linkmans[].cm_linkman_birthday timestamp 客户联系人生日
linkmans[].cm_linkman_email VARCHAR(100) 客户联系人电子邮件
linkmans[].cm_linkman_remarks VARCHAR(4000) 客户联系人备注
linkmans[].cm_linkman_main VARCHAR(1) 是否为主联系人,0-否 1-是,默认值:0
linkmans[].cm_linkman_qq VARCHAR(100) 客户联系人qq
linkmans[].cm_linkman_weixin VARCHAR(100) 客户联系人微信
linkmans[].cm_linkman_dept VARCHAR(200) 客户联系人部门
deliverys[].cm_delivery_main VARCHAR(1) 是否为默认收获地址,0-否 1-是,默认值:0
deliverys[].cm_delivery_name VARCHAR(32) 收货人名称
deliverys[].cm_delivery_tel VARCHAR(32) 收货电话
deliverys[].cm_delivery_phone VARCHAR(32) 收货手机号
deliverys[].cm_delivery_addr VARCHAR(32) 收货地址
deliverys[].cm_delivery_ex1 VARCHAR(200) 收货地址扩展字段1
deliverys[].cm_delivery_ex2 VARCHAR(200) 收货地址扩展字段2
deliverys[].cm_delivery_ex3 VARCHAR(200) 收货地址扩展字段3
exts[].cm_ext_key VARCHAR(100) 客户信息扩展字段key值,客户信息扩展字段需先在外勤365系统客户管理中创建自定义字段。
exts[].cm_ext_value VARCHAR(4000) 客户信息扩展字段value值对多个选项值,以“,”分隔拼接。
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "cm_name": "苏果夫子庙店",
    "cm_code": "suguo_fzmd",
    "cm_manager": "王伟,张强,吴为",
    "cm_manager_id": "emp001,emp002",
    "cm_type": "大型超市",
    "cm_district": "华中大区,南京分区,秦淮社区",
    "cm_mss_province": "江苏省",
    "cm_mss_city": "南京市",
    "cm_mss_area": "秦淮区",
    "cm_addr": "南京市秦淮区大全福巷1号",
    "cm_cooperate_status": "1",
    "cm_uper_customer": "苏果新街口店",
    "cm_source": "老客户介绍",
    "cm_trade": "服务业",
    "cm_scale": "200人以上",
    "cm_tel": "02552416854",
    "cm_fax": "02552416854",
    "cm_post": "210010",
    "cm_remarks": "",
    "deliverys": [
        {
            "cm_delivery_main": "1",
            "cm_delivery_name": "张三",
            "cm_delivery_tel": "52365895",
            "cm_delivery_phone": "13052125555",
            "cm_delivery_addr": "南京路XXXX号",
            "cm_delivery_ex1":"",
            "cm_delivery_ex2":"",
            "cm_delivery_ex3":""
        }
    ],
    "linkmans": [
        {
            "cm_linkman_name": "张三",
            "cm_linkman_job": "店主",
            "cm_linkman_mobile": "13052125555",
            "cm_linkman_office_tel": "52365895",
            "cm_linkman_fax": "25758545",
            "cm_linkman_sex": "M",
            "cm_linkman_birthday": "1980-02-06",
            "cm_linkman_email": "abc@163.com",
            "cm_linkman_remarks": "",
            "cm_linkman_main": "1",
            "cm_linkman_qq": "qq",
            "cm_linkman_weixin": "微信",
            "cm_linkman_dept": "部门"
        },
        {
            "cm_linkman_name": "李四",
            "cm_linkman_job": "店员",
            "cm_linkman_mobile": "13022215212",
            "cm_linkman_office_tel": "58755254",
            "cm_linkman_fax": "",
            "cm_linkman_sex": "F",
            "cm_linkman_birthday": "1981-02-14",
            "cm_linkman_email": "",
            "cm_linkman_remarks": "",
            "cm_linkman_main": "0",
            "cm_linkman_qq": "qq",
            "cm_linkman_weixin": "微信",
            "cm_linkman_dept": "部门"
        }
    ],
    "exts": [
        {
            "cm_ext_key": "级别",
            "cm_ext_value": "四星"
        },
        {
            "cm_ext_key": "主营商品",
            "cm_ext_value": "食品,电器,日化用品"
        }
    ]
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 修改客户信息
接口编码 modifyCustomer
接口URL https://openapi.waiqin365.com/api/customer/v1/modifyCustomer/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
cm_waiqin365_id VARCHAR(32) cm_id和cm_waiqin365_id
按照cm_waiqin365_id、cm_id的顺序有效,
并且至少提供一个
cm_name VARCHAR(100) 客户名称,唯一,有效字符详见附录:编码类型参照表
cm_code VARCHAR(32) 客户编码,有效字符详见附录:编码类型参照表
cm_manager VARCHAR(4000) 客户经理,多客户经理名称间以“,”分隔。如果和cm_manager_id同时传入时,以cm_manager_id数据为准。如:张三,李四,王五
cm_manager_id VARCHAR(4000) 客户经理唯一标识,多客户经理唯一标识间以“,”分隔。来源于第三方系统的员工唯一标识和员工信息中emp_id对应。 如:EMP0001, EMP0002, EMP0003
cm_type VARCHAR(100) 客户类型名称,如果和客户类型编码cm_type_code都传时,以cm_type_code数据为准
cm_type_code VARCHAR(100) 客户类型编码
cm_district VARCHAR(1000) 客户所属销售区域名称,此字段需要销售区域的完整层级结构名称,多层级间以“,”分隔。如果和外勤365客户销售区域IDcm_district_waiqin365_id同时传入时,以cm_district_waiqin365_id数据为准。如:华中大区,南京分区,秦淮社区
cm_district_waiqin365_id VARCHAR(32) 客户所属销售区域唯一标识,来源于外勤365的客户销售区域唯一ID。
cm_dept_id VARCHAR(32) 部门唯一标识,来源于第三方系统的部门唯一标识和部门信息中org_id对应,如果和外勤365部门IDcm_dept_waiqin365_id同时传入时,以cm_dept_waiqin365_id数据为准
cm_dept_waiqin365_id VARCHAR(32) 客户部门ID,开源于外勤365部门唯一ID
cm_mss_province VARCHAR(32) 客户所属行政区域-省
cm_mss_city VARCHAR(32) 客户所属行政区域-市
cm_mss_area VARCHAR(32) 客户所属行政区域-县
cm_addr VARCHAR(4000) 客户地址
cm_cooperate_status CHAR(1) 合作状态, 0-终止合作 1-合作中, 2-未合作, 3-有意向
cm_cooperate_status_name VARCHAR(32) 合作状态:终止合作/合作中/未合作/有意向/{自定义的},
如果同时传入cm_cooperate_status字段,
则以cm_cooperate_status为准
cm_uper_customer VARCHAR(100) 上级客户
cm_level VARCHAR(100) 客户级别
cm_source VARCHAR(100) 客户来源
cm_trade VARCHAR(100) 客户行业
cm_scale VARCHAR(100) 客户人员规模
cm_tel VARCHAR(32) 客户电话, 如:02544550010或025-44550010
cm_fax VARCHAR(32) 客户传真, 如:02544550010或025-44550010
cm_post VARCHAR(32) 客户邮编
cm_remarks VARCHAR(4000) 客户备注
status VARCHAR(1) 客户状态,1正常、0删除
linkmans[].cm_linkman_name VARCHAR(100) 客户联系人名称
linkmans[].cm_linkman_job VARCHAR(32) 客户联系人职务
linkmans[].cm_linkman_mobile VARCHAR(32) 客户联系人手机
linkmans[].cm_linkman_office_tel VARCHAR(32) 客户联系人固定电话, 如:02544550010或025-44550010
linkmans[].cm_linkman_fax VARCHAR(32) 客户联系人传真, 如:02544550010或025-44550010
linkmans[].cm_linkman_sex VARCHAR(1) 客户联系人性别F女性 M 男性,默认值“M”
linkmans[].cm_linkman_birthday timestamp 客户联系人生日
linkmans[].cm_linkman_email VARCHAR(100) 客户联系人电子邮件
linkmans[].cm_linkman_remarks VARCHAR(4000) 客户联系人备注
linkmans[].cm_linkman_main VARCHAR(1) 是否为主联系人,0-否 1-是,默认值:0
linkmans[].cm_linkman_qq VARCHAR(100) 客户联系人qq
linkmans[].cm_linkman_weixin VARCHAR(100) 客户联系人微信
linkmans[].cm_linkman_dept VARCHAR(200) 客户联系人部门
exts[].cm_ext_key VARCHAR(100) 客户信息扩展字段key值,客户信息扩展字段需先在外勤365系统客户管理中创建自定义字段。
exts[].cm_ext_value VARCHAR(4000) 客户信息扩展字段value值对多个选项值,以“,”分隔拼接。
deliverys[].cm_delivery_main VARCHAR(1) 是否为默认收获地址,0-否 1-是,默认值:0
deliverys[].cm_delivery_name VARCHAR(32) 收货人名称
deliverys[].cm_delivery_tel VARCHAR(32) 收货电话
deliverys[].cm_delivery_phone VARCHAR(32) 收货手机号
deliverys[].cm_delivery_addr VARCHAR(32) 收货地址
deliverys[].cm_delivery_ ex1 VARCHAR(200) 收货地址扩展字段1
deliverys[].cm_delivery_ ex2 VARCHAR(200) 收货地址扩展字段2
deliverys[].cm_delivery_ ex3 VARCHAR(200) 收货地址扩展字段3
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "cm_name": "苏果夫子庙店",
    "cm_code": "suguo_fzmd",
    "cm_manager": "王伟,张强,吴为",
    "cm_manager_id": "emp01,emp02",
    "cm_type": "大型超市",
    "cm_district": "华中大区,南京分区,秦淮社区",
    "cm_mss_province": "江苏省",
    "cm_mss_city": "南京市",
    "cm_mss_area": "秦淮区",
    "cm_addr": "南京市秦淮区大全福巷1号",
    "cm_cooperate_status": "1",
    "cm_uper_customer": "苏果新街口店",
    "cm_source": "老客户介绍",
    "cm_trade": "服务业",
    "cm_scale": "200人以上",
    "cm_tel": "02552416854",
    "cm_fax": "02552416854",
    "cm_post": "210010",
    "cm_remarks": "",
    "cm_status": "1",
    "linkmans": [
        {
            "cm_linkman_name": "张三",
            "cm_linkman_job": "店主",
            "cm_linkman_mobile": "13052125555",
            "cm_linkman_office_tel": "52365895",
            "cm_linkman_fax": "25758545",
            "cm_linkman_sex": "M",
            "cm_linkman_birthday": "1980-02-06",
            "cm_linkman_email": "abc@163.com",
            "cm_linkman_remarks": "",
            "cm_linkman_main": "1",
            "cm_linkman_qq": "qq",
            "cm_linkman_weixin": "微信",
            "cm_linkman_dept": "部门"
        },
        {
            "cm_linkman_name": "李四",
            "cm_linkman_job": "店员",
            "cm_linkman_mobile": "13022215212",
            "cm_linkman_office_tel": "58755254",
            "cm_linkman_fax": "",
            "cm_linkman_sex": "F",
            "cm_linkman_birthday": "1981-02-14",
            "cm_linkman_email": "",
            "cm_linkman_remarks": "",
            "cm_linkman_main": "0",
            "cm_linkman_qq": "qq",
            "cm_linkman_weixin": "微信",
            "cm_linkman_dept": "部门"
        }
    ],
        "deliverys":[{
        "cm_ delivery_main":"1",
        "cm_delivery_name":"张三",
        "cm_delivery_tel":"52365895",
        "cm_delivery_phone":"13052125555",
        "cm_delivery_addr":"南京路XXXX号",
        "cm_delivery_ex1":"",
        "cm_delivery_ex2":"",
        "cm_delivery_ex3":""
    }],
    
    
    "exts": [
        {
            "cm_ext_key": "级别",
            "cm_ext_value": "四星"
        },
        {
            "cm_ext_key": "主营商品",
            "cm_ext_value": "食品,电器,日化用品"
        }
    ]
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 删除客户信息
接口编码 removeCustomer
接口URL https://openapi.waiqin365.com/api/customer/v1/removeCustomer/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 查询客户信息
接口编码 queryCustomer
接口URL https://openapi.waiqin365.com/api/customer/v1/queryCustomer/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
page_number INT 页码默认1,每页最大1000条
status CHAR(1) 记录状态,0-已删除 1-正常
id VARCHAR(32) 外勤365客户唯一ID
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
cm_name VARCHAR(100) 客户名称,唯一,有效字符详见名称类型参照表
cm_code VARCHAR(32) 客户编码,有效字符详见附录:编码类型参照表
cm_manager_id VARCHAR(4000) 客户经理唯一标识,多客户经理唯一标识间以“,”分隔。来源于第三方系统的员工唯一标识和员工信息中emp_id对应。 如:EMP0001, EMP0002, EMP0003
cm_type VARCHAR(100) 客户类型,根据客户类型名称精确查询
after_create_date CHAR(19) 创建时间之后,格式:“yyyy-MM-dd HH:mm:ss”
after_modify_date CHAR(19) 更新时间之后,格式:“yyyy-MM-dd HH:mm:ss”
create_date CHAR(10) 创建日期,格式:“yyyy-MM-dd”
modify_date CHAR(10) 修改日期,格式:“yyyy-MM-dd”
响应信息 参照表响应信息格式
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
cm_name VARCHAR(100) 客户名称,唯一,有效字符详见附录:编码类型参照表
cm_code VARCHAR(32) 客户编码,有效字符详见附录:编码类型参照表
cm_manager VARCHAR(4000) 客户经理。多客户经理名称间以“,”分隔。如:张三,李四,王五,
cm_manager_source_code VARCHAR(4000) 客户经理的source_code。多个以“,”分隔。
cm_assistant_name VARCHAR(4000) 客户协助员名称。多个以“,”分隔。
cm_assistant_source_code VARCHAR(4000) 客户协助员的source_code。多个以“,”分隔。
cm_type VARCHAR(100) 客户类型名称
cm_dept_id VARCHAR(100) 客户部门唯一主键
cm_dept_name VARCHAR(100) 客户部门名称
cm_dept_waiqin365_id VARCHAR(100) 客户部门ID,开源于外勤365部门唯一ID
cm_district VARCHAR(1000) 客户所属销售区域名称
cm_mss_province VARCHAR(32) 客户所属行政区域-省
cm_mss_city VARCHAR(32) 客户所属行政区域-市
cm_mss_area VARCHAR(32) 客户所属行政区域-县
cm_addr VARCHAR(4000) 客户地址
cm_cooperate_status CHAR(1) 合作状态, 0-终止合作 1-合作中, 2-未合作, 3-有意向
cm_uper_customer VARCHAR(100) 上级客户
cm_source VARCHAR(100) 客户来源
cm_trade VARCHAR(100) 客户行业
cm_scale VARCHAR(100) 客户人员规模
cm_tel VARCHAR(32) 客户电话, 如:02544550010或025-44550010
cm_fax VARCHAR(32) 客户传真, 如:02544550010或025-44550010
cm_post VARCHAR(32) 客户邮编
cm_remarks VARCHAR(4000) 客户备注
tradingarea_big VARCHAR(100) 大商圈
tradingarea VARCHAR(100) 商圈
cm_district_id VARCHAR(32) 外勤365销售区域id
cm_district_create_time CHAR(19) 销售区域创建时间,格式:“yyyy-MM-dd HH:mm:ss”
cm_district_modify_time CHAR(19) 销售区域修改时间,格式:“yyyy-MM-dd HH:mm:ss”
cm_district_creator_name VARCHAR(100) 销售区域创建人
cm_district_modifyier_name VARCHAR(100) 销售区域修改人
cm_district_status CHAR(1) 销售区域状态,默认1正常,0删除
linkmans[].cm_linkman_name VARCHAR(100) 客户联系人名称
linkmans[].cm_linkman_job VARCHAR(32) 客户联系人职务
linkmans[].cm_linkman_mobile VARCHAR(32) 客户联系人手机
linkmans[].cm_linkman_office_tel VARCHAR(32) 客户联系人固定电话, 如:02544550010或025-44550010
linkmans[].cm_linkman_fax VARCHAR(32) 客户联系人传真, 如:02544550010或025-44550010
linkmans[].cm_linkman_sex VARCHAR(1) 客户联系人性别,F-女性 M-男性
linkmans[].cm_linkman_birthday timestamp 客户联系人生日
linkmans[].cm_linkman_email VARCHAR(100) 客户联系人电子邮件
linkmans[].cm_linkman_remarks VARCHAR(4000) 客户联系人备注
linkmans[].cm_linkman_main VARCHAR(1) 是否为主联系人,0-否 1-是
linkmans[].cm_linkman_qq VARCHAR(100) 客户联系人QQ
linkmans[].cm_linkman_weixin VARCHAR(100) 客户联系人微信
linkmans[].cm_linkman_dept VARCHAR(200) 客户联系人部门
deliverys[].cm_delivery_main VARCHAR(1) 是否为默认收获地址,0-否 1-是,默认值:0
deliverys[].cm_delivery_name VARCHAR(32) 收货人名称
deliverys[].cm_delivery_tel VARCHAR(32) 收货电话
deliverys[].cm_delivery_phone VARCHAR(32) 收货手机号
deliverys[].cm_delivery_addr VARCHAR(32) 收货地址
deliverys[].cm_delivery_ex1 VARCHAR(200) 收货地址扩展字段1
deliverys[].cm_delivery_ex2 VARCHAR(200) 收货地址扩展字段2
deliverys[].cm_delivery_ex3 VARCHAR(200) 收货地址扩展字段3
exts[].cm_ext_key VARCHAR(100) 客户信息扩展字段key值,客户信息扩展字段需先在外勤365系统客户管理中创建自定义字段。
exts[].cm_ext_value VARCHAR(4000) 客户信息扩展字段value值对多个选项值,以“,”分隔拼接。
id VARCHAR(32) 外勤365客户唯一ID
cm_cooperate_status_id VARCHAR(32) 合作状态id
cm_level_id VARCHAR(32) 外勤365客户等级ID
cm_approval_status char(1) 客户审批状态1-待审批 2-审批打回 3-审批通过
cm_status CHAR(1) 客户删除状态:0-删除 1-正常
create_time CHAR(19) 创建日期,格式:“yyyy-MM-dd HH:mm:ss”

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "cm_name": "苏果夫子庙店",
    "cm_code": "suguo_fzmd",
    "cm_manager": "王伟,张强,吴为",
    "cm_type": "大型超市",
    "cm_district": "华中大区,南京分区,秦淮社区",
    "create_date": "2015-05-12",
    "modify_date": "2015-05-12"
}

// 响应信息示例:
{
    "return_code": "0",
    "return_msg": "",
    "msg_id": "X000001",
    "response_data": "[
        {
            "id": "7863150652620035205",
            "cm_id": "CM0001",
            "cm_name": "苏果夫子庙店",
            "cm_code": "suguo_fzmd",
            "cm_manager": "王伟,张强,吴为",
            "cm_district": "秦淮社区",
            "cm_type": "大型超市",
            "cm_mss_province": "江苏省",
            "cm_mss_city": "南京市",
            "cm_mss_area": "秦淮区",
            "cm_addr": "南京市秦淮区大全福巷1号",
            "cm_cooperate_status": "1",
            "cm_uper_customer": "苏果新街口店",
            "cm_source": "老客户介绍",
            "cm_trade": "服务业",
            "cm_scale": "200人以上",
            "cm_tel": "02552416854",
            "cm_fax": "02552416854",
            "cm_post": "210010",
            "cm_remarks": "",
            "cm_cooperate_status_id": "2",
            "cm_level_id": "7287736961434231483",
            "cm_approval_status":"1",
            "tradingarea_big ":"核心区域",
            "tradingarea":"新街口",
            "create_time":"2017-09-09 13:14:11",
            "cm_district_id":"6081235751236711020",
            "cm_district_create_time":"2017-09-09 13:14:11",
            "cm_district_modify_time":"2017-10-09 23:14:11",
            "cm_district_creator_name":"张三",
            "cm_district_modifyier_name":"李四",
            "cm_district_status":"1",
            "linkmans": [
                {
                    "cm_linkman_name": "张三",
                    "cm_linkman_job": "店主",
                    "cm_linkman_mobile": "13052125555",
                    "cm_linkman_office_tel": "52365895",
                    "cm_linkman_fax": "25758545",
                    "cm_linkman_sex": "M",
                    "cm_linkman_birthday": "1980-02-06",
                    "cm_linkman_email": "abc@163.com",
                    "cm_linkman_remarks": "",
                    "cm_linkman_main": "1",
                    "cm_linkman_qq": "qq",
                    "cm_linkman_weixin": "微信",
                    "cm_linkman_dept": "部门"
                },
                {
                    "cm_linkman_name": "李四",
                    "cm_linkman_job": "店员",
                    "cm_linkman_mobile": "13022215212",
                    "cm_linkman_office_tel": "58755254",
                    "cm_linkman_fax": "",
                    "cm_linkman_sex": "F",
                    "cm_linkman_birthday": "1981-02-14",
                    "cm_linkman_email": "",
                    "cm_linkman_remarks": "",
                    "cm_linkman_main": "0"
                }
            ],
            "deliverys": [
            {
                "cm_delivery_main": "1",
                "cm_delivery_name": "张三",
                "cm_delivery_tel": "52365895",
                "cm_delivery_phone": "13052125555",
                "cm_delivery_addr": "南京路XXXX号",
                "cm_delivery_ex1":"",
                "cm_delivery_ex2":"",
                "cm_delivery_ex3":"",

            }
           ],
            "exts": [
                {
                    "cm_ext_key": "级别",
                    "cm_ext_value": "四星"
                },
                {
                    "cm_ext_key": "主营商品",
                    "cm_ext_value": "食品,电器,日化用品"
                }
            ]
        }
    ]"
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 合作状态变更
接口编码 modifyCustomerCooperateStatus
接口URL https://openapi.waiqin365.com/api/customer/v1/modifyCustomerCooperateStatus/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
cm_waiqin365_id VARCHAR(32) 外勤365客户唯一标识,当cm_id与本字段同时传入,以cm_waiqin365_id为准
cm_cooperate_status CHAR(1) 合作状态, 0-终止合作 1-合作中, 2-未合作, 3-有意向
cm_cooperate_status_name VARCHAR(32) 合作状态:终止合作/合作中/未合作/有意向/{自定义的},
如果同时传入cm_cooperate_status字段,
则以cm_cooperate_status为准
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "cm_cooperate_status": "0"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 客户分配到员工
接口编码 assignCustomerToEmp
接口URL https://openapi.waiqin365.com/api/customer/v1/assignCustomerToEmp/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
emp_id VARCHAR(4000) 员工唯一标识,多员工间以“,”分隔。
如:EMP0001, EMP0002, EMP0003
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "emp_id": " EMP0001, EMP0002, EMP0003"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 客户分配到部门
接口编码 assignCustomerToOrg
接口URL https://openapi.waiqin365.com/api/customer/v1/assignCustomerToOrg/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
org_id VARCHAR(4000) 部门唯一标识,多个部门间以“,”分隔。
如:ORG0001, ORG0002, ORG0003
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "org_id": " ORG0001, ORG0002, ORG0003"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 修改客户关联第三方ID
接口编码 modifyMainLinkman
接口URL https://openapi.waiqin365.com/api/customer/v1/modifyMainLinkman/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
cm_waiqin365_id VARCHAR(32) 外勤365中客户的id(和cm_name传一个即可两个都传就同时当条件判断更新cm_id)
linkman_mobile VARCHAR(32) 联系人手机号
is_main VARCHAR(32) 是否是主联系人:0-不是 1-是
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "cm_waiqin365_id": "",
    "linkman_mobile": "12322222222",
    "is_main": "1"
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 修改客户关联第三方ID
接口编码 modifyCustomerSourceCode
接口URL https://openapi.waiqin365.com/api/customer/v1/modifyCustomerSourceCode/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
cm_name VARCHAR(32) 客户名称
cm_waiqin365_id VARCHAR(32) 外勤365中客户的id(和cm_name传一个即可两个都传就同时当条件判断更新cm_id)
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "cm_name": "客户001",
    "cm_waiqin365_id": ""
}

// 响应信息示例:
{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 修改客户编码
接口编码 modifyCustomerCode
接口URL https://openapi.waiqin365.com/api/customer/v1/modifyCustomerCode/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一标识,有效字符详见附录:编码类型参照表
cm_code VARCHAR(32) 客户编码
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明
return_data String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "cm_code": "updateCode"
}

// 响应信息示例:
{
    "return_code":"0",
    "return_msg":null,
    "msg_id":"ORG00001",
    "response_data":null
}
                  
参数名称 参数值
应用编码 customer
应用版本 v1
接口名称 修改客户名称
接口编码 modifyCustomerName
接口URL https://openapi.waiqin365.com/api/customer/v1/modifyCustomerName/{ openid }/{ timestamp }/{ digest }/{ msg_id }
请求信息 参数 类型 必填 说明
cm_id VARCHAR(32) 客户唯一id,注意:此字段传的本系统的id
cm_name VARCHAR(32) 客户名称
响应信息 参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码,0-成功, 1-失败, 其他参照附件错误码
return_msg String 响应说明
return_data String 响应说明

// 请求消息体示例:
{
    "cm_id": "CM0001",
    "cm_name": "新名称"
}

// 响应信息示例:
{
    "return_code":"0",
    "return_msg":null,
    "msg_id":"ORG00001",
    "response_data":null
}