API
>
客户接口定义
客户接口定义
更新时间：2021/07/06 10：34
客户批量新增
接口地址：https://api.51lianlian.cn/api/cust/insertCustomers
最多一次新增500条客户信息
请求参数
| 字段名称 | 字段类型 | 约束 | 说明 |
|---|---|---|---|
| ts | int | 必填 | 时间戳 |
| batchName | string(20) | 非必填 | 批次名称，如果系统里没有该批次，会自动创建该批次。 |
| customers | json Array对象字符串 | 必填 | 包含以下所有字段 |
| customers | |||
| customerNo | string(50) | 必选 | 客户编号，公司内客户编号必须唯一，由字母和数字组成，不能含有标点符号和特殊字符。 |
| name | string(50) | 非必填 | 客户姓名，如果不填写，默认值为未知 |
| sex | string(20) | 非必填 | 性别，可选值为男、女、不详，不填写默认值为不详。 |
| phone | string(20) | 必填 | 客户常用电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 |
| urgentPhone | 非必填 | 客户紧急联系电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 | |
| source | string(20) | 非必填 | 来源，为选项值，具体选项值需要登录系统后台配置。 |
| ownerType | int | 必填 | 客户归属类型，0为归属员工，1为归属客户池。 |
| ownerName | string(20) | 必填 | 归属名称，当ownerType为0时，该参数为员工编号，当ownerType为1时，该参数为客户池名称；当ownerType为1，ownerName为0时，表示无归属。 |
| label | string(225) | 非必填 | 客户标签，具体标签选项值需要登录系统后台配置，多个标签值以英文逗号分割。 |
| stage | string(20) | 非必填 | 阶段，选项值，具体选项值需要登录系统后台配置。 |
| sort | string(20) | 非必填 | 分类，选项值，具体选项值需要登录系统后台配置 |
| customerLevel | string(20) | 非必填 | 等级，选项值，具体选项值需要登录系统后台配置 |
| tag | string(20) | 非必填 | 标记，选项值，具体选项值需要登录系统后台配置 |
| nextContactTime | string(20) | 非必填 | 下次联系日期，格式为YYYY-MM-DD，如2020-12-05 |
| remark s | tring(225) | 非必填 | 备注信息 |
| job | string(20) | 非必填 | 职业 |
| age | string(20) | 非必填 | 年龄 |
| idCard | string(20) | 非必填 | 证件号码 |
| corporation | string(20) | 非必填 | 所在公司 |
| title | string(20) | 非必填 | 职位 |
| province | string(20) | 非必填 | 所在省/市，具体值见附件省市名称定义 |
| city | string(20) | 非必填 | 所在地/市，具体值见附件地市名称定义 |
| salary | string(20) | 非必填 | 收入 |
| industry | string(20) | 非必填 | 行业，具体见附件行业分类定义 |
| customedFields | json Array对象字符串 | 非必填 | 自定义字段，json Array对象字符串 |
| customedFields | |||
| 自定义字段名称1 | string(500) | 非必填 | 字段值 |
| 自定义字段名称2 | string(500) | 非必填 | 字段值 |
| 自定义字段名称… | string(500) | 非必填 | 字段值 |
返回格式
| 字段名称 | 字段类型 | 约束 | 说明 |
|---|---|---|---|
| code | int | 必填 |
状态码
成功
1签名验证错误
2参数错误
5企业相关错误
6其他错误
|
| message | string | 必填 | 结果消息 |
| errorCustomersInfo | json Array对象字符串 | 非必填 | 新增失败的客户数据信息，包含以下所有字段 |
| errorCustomersInfo | |||
| errorMsg | string(50) | 必选 | 新增失败说明 |
| customerNo | string(50) | 必选 | 客户编号，公司内客户编号必须唯一 |
| name | string(50) | 非必填 | 客户姓名，如果不填写，默认值为未知 |
| sex | string(20) | 非必填 | 性别，可选值为男、女、不详，不填写默认值为不详。 |
| phone | string(20) | 必填 | 客户常用电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 |
| urgentPhone | string(20) | 非必填 | 客户紧急联系电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 |
| source | string(20) | 非必填 | 来源，为选项值，具体选项值需要登录系统后台配置。 |
| ownerType | int | 必填 | 客户归属类型，0为归属员工，1为归属客户池。 |
| ownerName | string(50) | 必填 | 当ownerType为0时，该参数为用户名，当ownerType为1时，该参数为客户池名称；当ownerType为1，ownerName为0时，表示无归属。 |
| label | string(225) | 客户标签，具体标签选项值需要登录系统后台配置，多个标签值以英文逗号分割。 | |
| stage | string(20) | 非必填 | 阶段，选项值，具体选项值需要登录系统后台配置。 |
| sort | string(20) | 非必填 | 分类，选项值，具体选项值需要登录系统后台配置。 |
| customerLevel | string(20) | 非必填 | 等级，选项值，具体选项值需要登录系统后台配置。 |
| tag | string(20) | 非必填 | 标记，选项值，具体选项值需要登录系统后台配置。 |
| nextContactTime | string(20) | 非必填 | 下次联系日期，格式为YYYY-MM-DD，如2020-12-05 |
| remark | string(225) | 非必填 | 备注信息 |
| job | string(20) | 非必填 | 职业 |
| age | string(20) | 非必填 | 年龄 |
| idCard | string(20) | 非必填 | 证件号码 |
| corporation | string(20) | 非必填 | 所在公司 |
| title | string(20) | 非必填 | 职位 |
| province | string(20) | 非必填 | 所在省/市 |
| city | string(20) | 非必填 | 所在地/市 |
| salary | string(20) | 非必填 | 收入 |
| industry | string(20) | 非必填 | 行业 |
| customedFields | json Array对象字符串 | 非必填 | 自定义字段，json Array对象字符串 |
| customedFields | |||
| 自定义字段名称1 | string(500) | 非必填 | 字段值 |
| 自定义字段名称2 | string(500) | 非必填 | 字段值 |
| 自定义字段名称… | string(500) | 非必填 | 字段值 |
客户批量修改
接口地址：https://api.51lianlian.cn/api/cust/updateCustomer
最多一次更新500条客户信息
请求参数
| 字段名称 | 字段类型 | 约束 | 说明 |
|---|---|---|---|
| ts | int | 必填 | 时间戳 |
| customers | json Array对象字符串 | 必填 | 包含以下所有字段 |
| customers | |||
| customerNo | string(50) | 必选 | 客户编号，公司内客户编号必须唯一，由字母和数字组成，不能含有标点符号和特殊字符。 |
| name | string(50) | 非必填 | 客户姓名 |
| sex | string(20) | 非必填 | 性别，可选值为男、女、不详，不填写默认值为不详。 |
| phone | string(20) | 非必填 | 客户常用电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 |
| urgentPhone | 非必填 | 客户紧急联系电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 | |
| source | string(20) | 非必填 | 来源，为选项值，具体选项值需要登录系统后台配置。 |
| ownerType | int | 要么都不填值，有么都填值 | 客户归属类型，0为归属员工，1为归属客户池。 |
| ownerName | string(50) |
当ownerType为0时，该参数为员工编号；
当ownerType为1时，该参数为客户池名称；
当ownerType为1，ownerName为0时，表示无归属。
|
|
| label | 客户标签，具体标签选项值需要登录系统后台配置，多个标签值以英文逗号分割。 | ||
| stage | string(20) | 非必填 | 阶段，选项值，具体选项值需要登录系统后台配置 |
| sort | string(20) | 非必填 | 分类，选项值，具体选项值需要登录系统后台配置 |
| customerLevel | string(20) | 非必填 | 等级，选项值，具体选项值需要登录系统后台配置 |
| tag | string(20) | 非必填 | 标记，选项值，具体选项值需要登录系统后台配置 |
| nextContactTime | string(20) | 非必填 | 下次联系日期，格式为YYYY-MM-DD，如2020-12-05 |
| remark | string(225) | 非必填 | 备注信息 |
| job | string(20) | 非必填 | 职业 |
| age | string(20) | 非必填 | 年龄 |
| idCard | string(20) | 非必填 | 证件号码 |
| corporation | string(20) | 非必填 | 所在公司 |
| title | string(20) | 非必填 | 职位 |
| province | string(20) | 非必填 | 所在省/市，具体值见附件省市名称定义 |
| city | string(20) | 非必填 | 所在地/市，具体值见附件地市名称定义 |
| salary | string(20) | 非必填 | 收入 |
| industry | string(20) | 非必填 | 行业，具体见附件行业分类定义 |
| customedFields | json Array对象字符串 | 非必填 | 自定义字段，json Array对象字符串 |
| customedFields | |||
| 自定义字段名称1 | string(500) | 非必填 | 字段值 |
| 自定义字段名称2 | string(500) | 非必填 | 字段值 |
| 自定义字段名称… | string(500) | 非必填 | 字段值 |
返回格式
| 字段名称 | 字段类型 | 约束 | 说明 |
|---|---|---|---|
| code | int | 必填 |
状态码
0成功
1签名验证错误
2参数错误
5企业相关错误
6其他错误
|
| message | string | 必填 | 结果消息 |
| errorCustomersInfo | json Array对象字符串 | 非必填 | 修改失败的客户数据信息，包含以下所有字段 |
| errorCustomersInfo | |||
| errorMsg | string(50) | 必选 | 修改失败说明 |
| customerNo | string(50) | 必选 | 客户编号，公司内客户编号必须唯一 |
| name | string(50) | 非必填 | 客户姓名，如果不填写，默认值为未知 |
| sex | string(20) | 非必填 | 性别，可选值为男、女、不详，不填写默认值为不详。 |
| phone | string(20) | 非必填 | 客户常用电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 |
| urgentPhone | 非必填 | 客户紧急联系电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 | |
| source | string(20) | 非必填 | 来源，为选项值，具体选项值需要登录系统后台配置。 |
| ownerType | int | 非必填 | 客户归属类型，0为归属员工，1为归属客户池。 |
| ownerName | string(50) | 非必填 | 当ownerType为0时，该参数为用户名，当ownerType为1时，该参数为客户池名称；当ownerType为1，ownerName为0时，表示无归属。 |
| label | 客户标签，具体标签选项值需要登录系统后台配置，多个标签值以英文逗号分割。 | ||
| stage | string(20) | 非必填 | 阶段，选项值，具体选项值需要登录系统后台配置。 |
| sort | string(20) | 非必填 | 分类，选项值，具体选项值需要登录系统后台配置。 |
| customerLevel | string(20) | 非必填 | 等级，选项值，具体选项值需要登录系统后台配置。 |
| tag | string(20) | 非必填 | 标记，选项值，具体选项值需要登录系统后台配置。 |
| nextContactTime | string(20) | 非必填 | 下次联系日期，格式为YYYY-MM-DD，如2020-12-05 |
| remark | string(225) | 非必填 | 备注信息 |
| job | string(20) | 非必填 | 职业 |
| age | string(20) | 非必填 | 年龄 |
| idCard | string(20) | 非必填 | 证件号码 |
| corporation | string(20) | 非必填 | 所在公司 |
| title | string(20) | 非必填 | 职位 |
| province | string(20) | 非必填 | 所在省/市 |
| city | string(20) | 非必填 | 所在地/市 |
| salary | string(20) | 非必填 | 收入 |
| industry | string(20) | 非必填 | 行业 |
| customedFields | |||
| customedFields | json Array对象字符串 | 非必填 | 自定义字段，json Array对象字符串 |
| 自定义字段名称1 | string(500) | 非必填 | 字段值 |
| 自定义字段名称2 | string(500) | 非必填 | 字段值 |
| 自定义字段名称… | string(500) | 非必填 | 字段值 |
客户分页查询
接口地址：https://api.51lianlian.cn/api/cust/queryCustomers
请求参数
| 字段名称 | 字段类型 | 约束 | 说明 |
|---|---|---|---|
| ts | int | 必选 | 时间戳 |
| customerNo | string(20) | 非必填 | 客户编号 |
| name | string(20) | 非必填 | 客户姓名 |
| phone | string(20) | 非必填 | 客户电话号码 |
| userName | string(20) | 非必填 | 归属员工编号（isNoOwner为0值时，参数userName和poolName只能一个有值） |
| poolName | string(20) | 非必填 | 归属客户池名称（isNoOwner为0值时，参数userName和poolName只能一个有值） |
| isNoOwner | int | 非必填 | 为1时查询无归属客户（参数userName和poolName只能为空值），0值表示归属员工或客户池 |
| label | string(200) | 非必填 | 客户标签，多个客户标签以英文逗号分割 |
| stage | string(20) | 非必填 | 客户阶段 |
| sort | string(20) | 非必填 | 客户分类 |
| customerLevel | string(20) | 非必填 | 客户等级 |
| tag | string(200) | 非必填 | 客户标记，多个客户标签以英文逗号分割， |
| source | string(20) | 非必填 | 客户来源 |
| page | int | 必填 | 页码 |
| pageSize | int | 必填 | 每页大小，不超过50 |
返回格式
| 字段名称 | 字段类型 | 约束 | 说明 | code | int | 必填 |
状态码
0成功
1签名验证错误
2参数错误
5企业相关错误
6其他错误
|
|---|---|---|---|
| message | string | 必填 | 结果消息 |
| total | int | 必填 | 客户总数 |
| pageSize | int | 必填 | 当前查询结果数量 |
| customers |
Array
Object
|
客户列表 | |
| customers | |||
| customerNo | string(50) | 必选 | 客户编号，公司内客户编号必须唯一 |
| name | string(50) | 非必填 | 客户姓名，如果不填写，默认值为未知 |
| sex | string(20) | 非必填 | 性别，可选值为男、女、不详，不填写默认值为不详。 |
| phone | string(20) | 必填 | 客户常用电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 |
| urgentPhone | 非必填 | 客户紧急联系电话号码，可以是手机电话号码或固定电话号码，固定电话号码时前面必须带区号，格式为：区号电话号码，如01081743443 | |
| source | string(20) | 非必填 | 来源，为选项值，具体选项值需要登录系统后台配置。 |
| ownerType | int | 必填 | 客户归属类型，0为归属员工，1为归属客户池。 |
| ownerName | string(50) | 必填 | 当ownerType为0时，该参数为用户名，当ownerType为1时，该参数为客户池名称；当ownerType为1，ownerName为0时，表示无归属。 |
| label | 客户标签，具体标签选项值需要登录系统后台配置，多个标签值以英文逗号分割。 | ||
| stage | string(20) | 非必填 | 阶段，选项值，具体选项值需要登录系统后台配置。 |
| sort | string(20) | 非必填 | 分类，选项值，具体选项值需要登录系统后台配置。 |
| customerLevel | string(20) | 非必填 | 等级，选项值，具体选项值需要登录系统后台配置。 |
| tag | string(20) | 非必填 | 标记，选项值，具体选项值需要登录系统后台配置。 |
| nextContactTime | string(20) | 非必填 | 下次联系日期，格式为YYYY-MM-DD，如2020-12-05 |
| batchName | string(20) | 非必填 | 批次名称，如果系统里没有该批次，会自动创建该批次。 |
| remark | string(225) | 非必填 | 备注信息 |
| job | string(20) | 非必填 | 职业 |
| age | string(20) | 非必填 | 年龄 |
| idCard | string(20) | 非必填 | 证件号码 |
| corporation | string(20) | 非必填 | 所在公司 |
| title | string(20) | 非必填 | 职位 |
| province | string(20) | 非必填 | 所在省/市 |
| city | string(20) | 非必填 | 所在地/市 |
| salary | string(20) | 非必填 | 收入 |
| industry | string(20) | 非必填 | 行业 |
| customedFields | json Array对象字符串 | 非必填 | 自定义字段，json Array对象字符串 |
| customedFields | |||
| 自定义字段名称1 | string(500) | 非必填 | 字段值 |
| 自定义字段名称2 | string(500) | 非必填 | 字段值 |
| 自定义字段名称… | string(500) | 非必填 | 字段值 |
客户批量删除
接口地址：https://api.51lianlian.cn/api/cust/deleteCustomers
请求参数
| 字段名称 | 字段类型 | 约束 | 说明 |
|---|---|---|---|
| ts | int | 必选 | 时间戳 |
| customerNoStr | string(1000) | 必选 | 客户编号字符串列表，多个客户编号以英文逗号分割。 |
返回格式
| 字段名称 | 字段类型 | 约束 | 说明 |
|---|---|---|---|
| code | int | 必选 |
状态码
0成功
1签名验证错误
2参数错误
5企业相关错误
6其他错误
|
| message | string | 结果消息 |