尘锋SCRM开放平台
  1. 接入前准备
尘锋SCRM开放平台
  • 接入前准备
    • 接口鉴权说明
    • 回调接入指南
    • 报错code码说明
    • 省市区code码
    • 获取附件URL访问签名
    • 更新日志
  • 对接方案介绍
    • 联系人架构介绍
    • 员工概览
    • ERP打通
    • 客户信息打通
    • 订单打通
    • 微信unionid互通场景
    • 获客助手对接场景
  • API文档
    • 客户
      • 联系人
        • 联系人管理
          • 查询联系人
          • 新增联系人
          • 编辑联系人
          • 删除联系人
          • 编辑联系人状态
          • 获取联系客户统计数据
          • 外部ID
            • 删除联系人外部ID
            • 更新联系人外部ID
            • 绑定外部ID与联系人ID
        • 联系人字段ID
          • 查询联系人自定义字段模板
          • 查询跟进状态列表
          • 查询联系人公海列表
          • 无效&放弃&删除原因查询
          • 联系人类型与标签和自定义字段关联关系
          • 联系人类型
          • 联系人联系方式
          • 多级联选列表
          • 来源
            • 来源列表查询(企业&联系人)
            • 编辑来源
            • 创建来源
        • 标签库
          • 给联系人打标签
          • 好友标签(企业微信标签)
            • 查询好友标签列表
            • 编辑好友标签
            • 新增好友标签
          • 联系人标签
            • 编辑联系人标签值
            • 新增联系人标签组
            • 编辑联系人标签组
            • 新增联系人标签值
            • 查询联系人标签列表
        • 跟进团队
          • 编辑(联系人/企业)共享人
          • 查询创建⼈跟进⼈和共享⼈
        • 跟进提醒
          • 查询跟进提醒
          • 新增跟进提醒
          • 编辑跟进提醒
          • 完成跟进提醒
          • 删除跟进提醒
        • 跟进记录
          • 查询跟进记录
          • 查询跟进记录模板
          • 新增跟进记录
        • 在职继承
          • 分配在职成员联系人
          • 查询接替状态
        • 签到
          • 查询签到记录
        • 行为轨迹
          • 轨迹参数说明
          • 上报轨迹事件
          • 查询轨迹事件
          • 查询旅程项目
      • 企业
        • 企业字段ID
          • 查询企业字段ID
          • 查询企业跟进状态
          • 查询企业公海列表
          • 来源列表查询(企业&联系人)
          • 查询企业类型
          • 查询企业删除原因
          • 查询多级联选
        • 企业管理
          • 查询企业列表
          • 新增企业
          • 编辑企业
          • 删除企业
          • 企业绑定联系人
          • 更新企业跟进人
          • 放弃企业到公海
          • 分配公海中企业
        • 企业标签
          • 查询企业标签
      • 好友
        • 查询好友列表
        • 编辑好友信息
        • 好友关联联系人
        • 好友取消关联联系人
        • unionId上传&关联externalUserId
      • 客户群
        • 查询客户群列表
        • 查询客户群详情
        • 编辑客户群标签
        • 查询群标签列表
        • 查询群聊数据统计-按群主聚合方式
        • 查询群聊数据统计-按自然日聚合方式
    • 销售机会
      • 销售机会管理
        • 查询销售机会列表
        • 新增销售机会
        • 编辑销售机会
        • 删除销售机会
        • 新增销售机会协同人
        • 移除销售机会协同人
        • 销售机会绑定订单
        • 销售机会解绑订单
        • 销售机会阶段变更记录
      • 销售机会字段ID
        • 查询销售机会字段ID
        • 查询销售机会类型
        • 查询销售机会阶段
        • 查询协同角色ID
        • 查询竞争对手
        • 查询丢单原因
        • 查询销售机会多级联选选项
        • 修改销售机会多级联选选项
    • 交易
      • 订单
        • 查询订单列表
        • 新增&编辑订单
        • 查询订单自定义字段ID
        • 修改订单归属人/归属部门
        • 订单发货
        • 查询物流公司列表
        • 查询订单来源
        • 编辑自主下单
      • 售后单
        • 查询售后单列表
        • 创建售后单
        • 售后单操作退款
      • 回款单
        • 查询回款单列表
        • 创建回款单
      • 会员积分
        • 查询会员列表
        • 新增会员
        • 变更会员等级
        • 查询会员等级变更明细
        • 变更会员积分
        • 变更会员成长值
        • 查询会员积分变更明细
      • 商品类
        • 查询商品列表
        • 查询商品详情
        • 新增商品
        • 商品图片/视频上传
        • 编辑商品库存
    • 员工
      • 查询员工信息
      • 编辑员工信息
      • 部门信息查询
      • 批量为员工启用系统
      • 给员工发送企微通知
    • 预约单
      • 查询预约列表
    • 评论
      • 查询评论列表接口
    • 运营
      • 活码
        • 查询活码详情
        • 查询活码列表
      • 表单
        • 查询表单字段模板
        • 查询表单填写内容
      • sop
        • 查询sop列表
        • 查询sop执行情况列表
      • 素材
        • 查询素材列表
        • 查询素材详情
        • 查询员工发送素材明细
      • 营销任务
        • 查询营销任务执行情况
        • 查询营销任务列表
      • 朋友圈
        • 获取企业发布的朋友圈员工执行情况
        • 获取朋友圈的互动数据
        • 获取企业全部发布列表
      • 获客助手短链
        • 查询获客助手来源及链接信息
        • 查询获客助手配置列表
        • 获取专属短链详情列表
        • 生成用户专属短链接
    • 会话存档
      • 上传会话存档记录
    • 通话短信
      • 查询通话记录列表
      • 电销手机外呼
      • 查询通话录音转文字结果
      • 查询短信记录列表
    • 页面嵌入
      • 页面嵌入配置说明
      • 解密嵌入页面传参
      • 菜单嵌入说明
    • 应用
      • 楼盘管理
        • 查询楼盘
        • 新增楼盘
        • 删除楼盘
      • 外联盟管理
        • 查询外联盟
        • 新增外联盟
        • 编辑外联盟
        • 删除外联盟
        • 启停用外联盟
        • 查询外联盟字段ID
        • 外联盟多级联选选项
  • 事件推送
    • 联系人
      • 新增联系人事件
      • 编辑联系人事件
      • 联系人跟进状态变更事件
      • 删除联系人事件
      • 联系人合并事件
      • 跟进提醒
        • 联系人跟进提醒状态变更
      • 联系人流转
        • 跟进团队变更事件
        • 联系人流转事件
      • 跟进记录
        • 跟进记录操作事件
    • 好友
      • 添加好友事件
      • 好友与联系人绑定事件
      • 好友与联系人解绑事件
      • 好友主动删除员工事件
      • 员工主动删除好友事件
      • 更新好友信息事件
    • 客户群
      • 新增客户群事件
      • 变更客户群事件
      • 解散客户群事件
    • 销售机会
      • 销售机会负责人变更
      • 销售机会协同人变更
      • 销售机会操作事件
    • 企业
      • 企业跟进团队流转事件
      • 企业新增事件
      • 编辑企业事件
      • 企业跟进状态变更事件
      • 企业删除事件
    • 交易
      • 推送说明
      • 订单
        • 新增订单事件
        • 编辑订单事件
        • 订单状态变更事件
        • 订单支付完成事件
        • 删除订单事件
      • 售后单
        • 售后单创建事件
        • 编辑售后单事件
        • 售后单状态变更事件
        • 删除售后单事件
        • 售后单退款成功事件
      • 商品
        • 新增商品事件
        • 商品库存变更事件
        • 编辑商品事件
        • 商品状态变更事件
      • 会员积分
        • 新增会员事件
        • 会员合并事件
        • 成长值变更事件
        • 会员等级变更事件
        • 会员积分变更事件
    • 工单
      • 新增工单事件
      • 流转工单事件
      • 编辑工单事件
    • 运营
      • 提交表单事件
    • 通话短信
      • 通话记录操作事件
      • 短信记录操作事件
    • 预约单
      • 新增预约单事件
    • 应用
      • 楼盘
        • 新增楼盘事件
        • 编辑楼盘事件
        • 删除楼盘事件
      • 外联盟
        • 新增外联盟事件
        • 编辑外联盟事件
        • 删除外联盟事件
        • 启/停外联盟事件
        • 外联盟审批完成事件
  1. 接入前准备

报错code码说明

code码说明
0或者500200正常、成功
4000操作失败:指CURD失败,一般指数据库操作失败
4005参数解析错误:一般是参数校验失败或者序列化失败
4006没有操作权限
4100客户不存在
4101客户名称过长(上限20个字符)
4103职务名称过长(上限15个字符)
4104地址名称过长(上限350个字符)
4105email名称过长(上限50个字符)
4106描述过长(上限200个字符)
4126客户新增失败
4137公司不存在
4153联系⼈企业不匹配
4155公司未找到
4200订单不存在
4201商品类别超过最大数
4202订单名字过长
4203订单备注过长
4204预计成交月份错误
4205报价单已存在
4206订单阶段正被使用
4207销售机会必填字段缺失
4208销售机会提醒人超过最大人数
4209销售机会已关联订单
4210禁止修改已成单销售机会阶段
4212禁止修改销售机会阶段为已成单
4211地产定制,禁止修改销售机会阶段
4213禁止修改已成单阶段的金额
4214报价单不存在
4361公海分配达到企业持有量限制
4563公海分配错误
4904员⼯不存在
6300跟进提醒不存在
6302⽆权限创建该跟进记录
6303跟进类型不存在或未传参
6304跟进类型未启用
6305跟进开关未启用
6306跟进提醒定时任务创建失败
8006第三方拨打电话失败
10001系统未知错误
10002http请求失败
11000读取订单配置错误
11001获取审核人员错误
11002订单审核人员为空
11003获取发货人员错误
11004订单发货人员为空
11005获取退货审批人员错误
11006订单退货审批人员为空
11007获取当前用户错误
11008订单查询错误
11009订单更新错误
11010订单已删除
11011订单状态已变化,请刷新页面查看
11012订单没有操作权限
11020新增订单商品为空
11021新增订单商品重复
11022新增订单商品不存在(也可能是部分商品不存在)
11023新增订单凭证为空
11024新增订单手机错误
11025新增订单创建快照错误
11026新增订单获取收货地址错误
11027新增订单没有选择收货地址
11028新增订单收货地址省市区错误
11029新增订单新增收货地址错误
13000未选择公海或跟进人
13001添加客户号码重复
13002关联外部联系人无法删除
13003超过了删除最大数量
13004客户编辑单次操作超过了1000条
13005客户的公海不存在
13006客户备注不能为空
13007客户已经存在
13013电话号码校验不通过
13014当前联系人无公海id,必须要有跟进人
13015当前联系人有共享人,必须要有跟进人
13016当前联系人无跟进人,不能添加共享人
13017当前跟进人已经是共享人
13018当前共享人已经是跟进人
13019外部id重复(本批次内)
13020外部id已经存在
13021参数错误,请填写正确的id或external_id
13022外部id不存在
13023单批次超过最⼤数量
13028批次内有失败数据
13029查询跟进类型字段模板失败
13030查询跟进记录列表失败
13500不能小于当前时间
17000销售机会类型名称重复
17001销售机会类型数量超过上限
17002销售机会类型不存在
17003销售机会类型已被销售机会使用
17004默认销售机会类型不允许被删除
17005销售机会阶段不存在
17006特殊销售机会阶段无法修改
17007特殊销售机会阶段无法排序
17008默认销售机会阶段不允许被删除
17009销售机会阶段已被销售机会使用
17010销售机会阶段数量超过上限
17011销售机会自定义字段超过上限
17012丢单原因个数超过上限
17013销售机会表头获取失败
17014销售机会表头更新失败
17015销售机会阶段已被公海管理使用
17016销售机会阶段已被定期跟进任务使用
17017销售机会类型已被公海管理使用
17018销售机会类型已被定期跟进任务使用
17019销售机会配置不存在
17020销售机会配置缓存出错
17021销售机会配置选择出错
17022启用的销售机会类型至少需要n个
17023销售机会不存在
17024当前销售机会无权限
17025销售机会列表无权限
17026销售机会逾期提醒参数缺失
17027销售机会提醒人已删除
17028销售机会成单设置已启用,不能直接创建为『已成单』阶段
17029公海、回收站、已删除的联系人,不能新增销售机会
17030公海或回收站的联系人,不能编辑销售机会
17031销售机会阶段不存在或被禁用
17032订单id为空
17033请先创建报价单
17034销售机会绑定的订单超限,无法创建关联的销售机会
18000销售机会列表分页大小超过上限
18001没有销售机会菜单权限
18002没有开启大B开关的业务模式
18003丢单原因不存在或不可用
18004员工所在部门有误
18005没有该销售机会的编辑权限
21000共享人userid有误,未匹配到对应员工
21001当前员工为联系人跟进人,添加共享人失败
21002当前员工已离职,不能添加为共享人
21003添加共享人数量超过上限
21004跟进状态未找到
21005未填写无效原因
21006无效原因未找到
21007公海客户不能添加共享人
40000不允许2b场景数据
40001缺少access_token参数
40002access_token无效
40003ip白名单限制,需要配置请求服务所在的外网ip地址(并保证能访问到)
40004ip 未获取到
40005配置不存在
40006密钥无效
40007公司信息不存在
40012客户未找到
40013客户模板数据未找到
40014获取客户列表时间跨度太大
40015每分钟接口限流600次
40016获取客户跟进记录列表时间跨度太大
40017限流每分钟总量20000个
40018限流每分钟500次
40019删除跟进提醒的数据id不能为空
40020跟进模版查询状态错误,ex:1
40021客户id映射的内部id不匹配
40022通过外部客户id映射内部id失败
200001模板[%s]不存在或已删除!
200002渠道[%s]不存在或已删除!
200003模板[%s]已被禁用!
300001通知[%s]不存在!
300002通知码不存在!
300003通知已发送,请勿重复发送!
300004企微跳转URL为空!
300005群机器人WebHookUrl为空!
300006业务ID为空!
400001服务端错误!
400002对象转换时出现异常!
500001公司[%s]信息为空!
500002租户账号为空!
500003用户%s在企业微信不存在或已离职
500004消息类型不存在!
500005目标类型不存在!
500006目标ID为空!
500007不支持的目标类型!
500008小程序模板ID为空!
500009群机器人webHookUrl为空!
500010应用名称为空!
500011接收人不在应用可见范围内!
500012用户已取消订阅该通知!
500511企业绑定的联系人重复
6000003客户外部id不匹配
6000004不存在关联关系不能操作
6000005超过最大限制数量
20030201数据库操作失败
20030202请求数量超过限制100
20070200客户资料通用异常: %s
20070403联系人学历不存在
20070404联系人省市县不存在
20070405联系人民族不存在
20070406联系人来源不存在
20070407联系人类别不存在
20070408联系人企微标签不存在
20070409联系人合法性校验失败
20070410联系人externalUserID重复
20070411联系人unionID重复
20070412联系人手机号重复
20070413联系人唯一性校验失败
20070416联系人ID不存在
20070417联系人无效跟进状态ID
20070418联系人无效跟进状态原因ID
20070419联系人跟进状态不可为空
20070420联系人该跟进状态不可使用
20070421联系人跟进状态未启用
20070422联系人无效跟进状态需要无效原因
20070423联系人其它无效原因必填
20070424联系人合并未选择主体
20070425联系人合并未选择被合并体
20070426联系人合并最多选中10个
20070427联系人合并中
20070428联系人合并数据数量与库不匹配
20070431联系人必填字段缺失: %s
20070432联系人remark不能为空
20070433联系人不存在
20070434联系人已绑定企业
20070435无效的联系人类型
20070436联系人电话不能为空
20070437无效的联系人电话类型
20070438联系人手机号显示名不能为空
20070439错误的联系方式格式
20070440无效的年龄
20070441无效的性别
20070443联系人状态异常
20070444更新时间不能为空
20070445无效的生日
20070448无效的坐标
20070451联系人无绑定企业
20070452联系人来源未开启
20070453联系人来源必须是最小子集
20070454操作执行时主动忽略
20070455联系方式ID不存在
20070501字段配置尚未初始化
20070502字段ID不能为空
20070503字段ID不存在
20070504操作多级联选,传入fieldID不为多级联选类型
20070505多级联选id不能为空
20070506多级联选选项名不能为空
20070507多级联选选项总数超过5000
20070508多级联选同一子级选项总数超过100
20070509多级联选操作选项不存在
20070510多级联选选项名不可包含/,,=等特殊字符
20070511多级联选父选项ID不存在
20070512多级联选选项层级限制
20090100保存发生冲突, 请重试
20090400通用错误码(如联系人不存在、未知错误等)
20090401好友不存在
20090402好友已经被彻底删除
20090403好友绑定失败: 联系人已被绑定其它外部联系人
20090404好友状态不可用, 无法同步好友信息
20090511跟进团队通用异常: %s
20090502联系人id不存在
20090505跟进团队上限验证不通过
20090506跟进团队超出上限
20090508员工: %s,状态异常
20090509员工: %s,不存在
20090510团队成员重复 %s
20110202标签请求数量超过限制100
20110208来源名称不能包含特殊字符/
20110209来源名称不能为空
20110210来源名称的长度超过500个字符
20110211来源名称已存在
20110212来源个数已达上限
20110216预设来源不允许编辑
20110240标签名不能为空,最长为15个字符
20110241标签ID为空
20110242缺少必填参数
20110243关联部门为空
20110244标签排序值的有效的值范围是[0, 2^32)
20110245标签为空
20110246单次新增标签数超过限制
20110247标签组ID为空
20110248标签组名不能为空,最长为15个字符
20110249标签名称重复
20110250标签组标签数超过限制
20110251标签组不存在
20110252标签组名称重复
20110253部门标签组数量超限
20110254获取排序值失败
50022007外部ID已被绑定
50022008内部ID已被绑定
50022009外部ID不存在
50022010内部ID不存在
30040011查找数据失败
300400112参数 createUserIds 超过限定长度
300400113参数 startTime 和 endTime设置错误
上一页
回调接入指南
下一页
省市区code码
Built with