跳至主要內容

客户导入

大约 6 分钟

客户导入

客户导入接口

  • URI

/wscrm-bus-api/customer/api/batchImport

  • 请求方式

POST , Content-Type : application/json

  • 请求参数说明
参数名类型是否必填备注
tenantIdLong是公司id
userNameString是管理员账号
tokenString是token
createTimeString是创建时间
dataList是导入数据

data参数说明

参数名类型是否必填备注
agentAccountString是座席账号
whatsAppString是whatsApp
friendNameString后台设置姓名
sexString后台设置性别: 未知、男、女 （中文状态） unknown、male、female （英文状态）
birthdayString后台设置生日: 2020/03/08 （目前只支持这种格式）
addressString后台设置地址
emailString后台设置邮箱
professionString后台设置职业
incomeString后台设置收入
descString后台设置备注
tabNameStirng后台设置标签名称集合: 标签A,标签B （两个标签之间使用英文逗号隔开）
stageString后台设置客户阶段
sourceString后台设置客户来源
languageTagString后台设置客户语言: 后台下载模板 sheet2 中数据，根据后台中英文识别
例如：简体中文（中） Chinese Simplified （英）
welcomeString否欢迎语
扩展字段String后台配置详细查看下面解释
  • 请求示例:
{
        "tenantId": 82,
        "userName": "kubrick",
        "token": "48ac86f77f26e4719a62d3b2c569a67b",
        "createTime": "2021-03-08 14:25:00",
        "data":[
            {
                "agentAccount": "kubrick101",
                "whatsApp": "8615266667780",
                "friendName": "封常清",
                "sex": "男",
                "birthday": "2020/03/08",
                "address": "长安",
                "email": "fengchangqing@tang.com",
                "profession": "节度使",
                "income": "100金",
                "desc": "",
                "tabName": "军人,经略",
                "stage": "新客户",
                "source": "系统分配",
                "派系": "关陇集团",
                "扩展字段1": "这是扩展字段1的值",
                "languageTag": "Auto", // 客户语言 根据当前座席登录客户端的账号确认，可选择不填
                "welcome": "这是欢迎语"
            }
        ]
}
  • 参数获取方式

agentAccount: 为座席登录账号用来区分whatsApp归属座席，联系管理员获取。

  • 扩展字段解释

根据后台客户-设置 | 扩展字段传参 key 为 扩展字段名 ，value 为扩展字段值，
例如：
文本："哈嗨": "哈哈嗨"
数字："这是数字扩展字段": 123
日期："这是日期扩展字段": "2022-03-08"
时间："时间": "12:00:00"
单选："单选": "单选"
多选: "多选": "A,B"

  • 响应参数说明
参数名类型备注
dataString数据 (excel)
msgString错误信息
codeString返回的状态码 (200、500、-1) -1 代表参数错误

data参数说明

参数名备注
errExcel导入失败手机号，及导入失败的原因
errCount导入失败条数
  • 正确示例
{
        "code": 200,
        "message": "Success",
        "data": {
            "successExcel": [],
            "errExcel": [],
            "successCount": 2,
            "errCount": 0,
            "notFollowSuccessCount": "",
            "notFollowSuccessExcels": []
        }
}
  • 错误示例：
{
        "code": 200,
        "message": "Success",
        "data": {
            "successExcel": [],
            "errExcel": [
                {
                "errPhone": "",
                "errInfo": "PHONE_ERROR",
                "errCode": 28
                },
            ],
            "successCount": 0,
            "errCount": 2,
            "notFollowSuccessCount": "",
            "notFollowSuccessExcels": []
        }
}

客户导入接口(进导入池)

  • 导入池说明

    1、每次接口导入数据都会覆盖原来的数据，不同坐席之间不会影响。

        例如: 第一次给坐席王五导入了两个客户（861821733142,861272562622）。第二次又给王五导入了一个客户（861272562622） 此时王五只有（861272562622）这一个客户。

  • URI

/wscrm-bus-api/customer/api/batchImportWhatsContact

  • 请求方式

POST , Content-Type : application/json

  • 请求参数说明
参数名类型是否必填备注
tenantIdLong是公司id
userNameString是管理员账号
tokenString是
createTimeString是创建时间
dataList是导入数据

data参数说明

参数名类型是否必填备注
agentAccountString是座席账号
whatsAppString是whatsApp
friendNameString后台设置姓名
sexString后台设置性别: 未知、男、女 （中文状态） unknown、male、female （英文状态）
birthdayString后台设置生日: 2020/03/08 （目前只支持这种格式）
addressString后台设置地址
emailString后台设置邮箱
professionString后台设置职业
incomeString后台设置收入
descString后台设置备注
tabNameString后台设置标签名称集合: 标签 A,标签 B（两个标签之间使用英文逗号隔开）
stageString后台设置客户阶段
sourceString后台设置客户来源
languageTagString后台设置客户语言: 后台下载模板 sheet2 中数据，根据后台中英文识别
例如：简体中文（中） Chinese Simplified （英）
welcomeString否欢迎语
扩展字段String后台配置详细查看下面解释
  • 请求示例:
{
        "tenantId": 82,
        "userName": "kubrick",
        "token": "48ac86f77f26e4719a62d3b2c569a67b",
        "createTime": "2021-03-08 14:25:00",
        "data":[
            {
                "agentAccount": "kubrick101",
                "whatsApp": "8615266667780",
                "friendName": "李亨",
                "sex": "男",
                "birthday": "2020/03/08",
                "address": "长安",
                "email": "liheng@tang.com",
                "profession": "皇帝",
                "income": "10000金",
                "desc": "唐肃宗",
                "tabName": "忠王,收复两京",
                "stage": "新客户",
                "source": "系统分配",
                "派系": "皇室",
                "扩展字段1": "这是扩展字段1的值",
                "languageTag": "Auto", // 客户语言 根据当前座席登录客户端的账号确认，可选择不填
                "welcome": "这是欢迎语"
            }
        ]
}
  • 参数获取方式

agentAccount: 为座席登录账号用来区分whatsApp归属座席,联系管理员获取。

  • 扩展字段解释

根据后台客户-设置 | 扩展字段传参 key 为 扩展字段名 ，value 为扩展字段值。 例如:
文本： "哈嗨": "哈哈嗨"
数字： "这是数字扩展字段": 123
日期： "这是日期扩展字段": "2022-03-08"
时间： "时间": "12:00:00"
单选： "单选": "["单选"]"
多选: "多选": "A,B"

  • 返回参数说明
参数名类型备注
dataString数据 (excel)
msgString错误信息
codeString返回的状态码 (200、500、-1) -1 代表参数错误

data参数说明

参数名备注
errExcel导入失败手机号，及导入失败的原因
errCount导入失败条数
  • 正确示例
{
        "code": 200,
        "message": "Success",
        "data": {
        "successExcel": [],
        "errExcel": [],
        "successCount": 2,
        "errCount": 0,
        "notFollowSuccessCount": "",
        "notFollowSuccessExcels": []
        }
}
  • 导入成功，可在PC客户端(通讯录-导入池)进行查看。
      
  • 错误示例：
{
        "code": 200,
        "message": "Success",
        "data": {
            "successExcel": [],
            "errExcel": [
                {
                    "errPhone": "",
                    "errInfo": "PHONE_ERROR",
                    "errCode": 28
                },
            ],
            "successCount": 0,
            "errCount": 2,
            "notFollowSuccessCount": "",
            "notFollowSuccessExcels": []
        }
}

客户字段信息

要获取客户有哪些基本信息字段、扩展信息字段、标签信息 ，可以登录管理后台进行新增、修改。

  • 基本信息&扩展字段

客户字段信息配置

  • 标签信息

客户标签信息

快速查看客户的基本信息、扩展字段信息、标签信息open in new window

  • 可以登录客户端查看是否生效。

客户端查看用户画像信息

错误码

码值说明解释
-1token error / TenantId Is Null / Admin Cannot import data / Data Is Null公司、账号基本信息
10性别字段 sex 不符合格式要求sex 字段格式错误
14来源字段填写内容不存在source 内容不符合要求
15阶段字段填写内容不存在stage 内容不符合要求
16客户语言填写内容不存在languageTag 填写内容不存在
19超出一万条数据限制超出一万条数据限制
21扩展字段内容超出长度扩展字段内容超过指定长度
22必填项验证失败必填字段未填写
23扩展字段 - 数值类型格式错误不完全是数值类型
24扩展字段 - 日期类型格式错误 / 生日字段类型格式错误yyyy/MM/dd
25扩展字段 - 时间类型格式错误HH:mm:ss
26扩展字段 -单选类型格式错误选入多个或选择项已经不存在
27扩展字段 -多选类型格式错误选择项已经不存在
28手机号错误不是数字
29手机号为空whatsApp 为空
51不存在国家字段国家字段为空
56friendWhatsId 数据正在处理friendWhatsId 正在处理(一分钟间隔)
58扩展字段 - 附件类型 url 过长url 个数超过 10 张
59扩展字段 - 附件存在无效地址或者网络波动或文件过大无效地址或者网络波动或文件过大
60扩展字段 - 附件类型文件过大存在过大附件信息
上次编辑于:
贡献者: kubrick,kubrick,songjun,zhangzhuangzhuang