尘锋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. 对接方案介绍

客户信息打通

自有CRM系统和尘锋SCRM的客户信息对接方案
尘锋业务架构图
​ img
专业名称解释:
名次解释描述
unionId微信用户的统一标识。,针对一个微信开放平台帐号下的应用,同一用户的unionid是唯一的。
external_userid企业微信用于表示企业的外部联系人而设立的id
联系人员工维护的个人客户档案,可以与添加的企微好友关联
联系人公海公共联系人线索池
联系人自定义字段在系统内自定义的档案字段
适用于将尘锋系统的所有联系人信息统一同步至三方系统。以及将尘锋系统后续新增的联系人信息同步至三方系统。
​ img
第一步:获取联系人信息存量数据获取:可调用“查询联系人列表接口”来获取联系人的信息增量数据获取:可订阅联系人变更推送事件并判断 data.body.type=“add(新增联系人)”时,接收新增的联系人数据信息
第二步:联系人关联映射将尘锋的联系人和三方系统的联系人建立映射关系。目前提供的关联方式有两种:
unionId关联:如三方系统的联系人也有微信用户的unionId信息,可通过uniondId实现和好友及联系人的打通(微信unionid互通场景)
手机号关联:如三方系统只有联系人的手机号信息,可通过通过尘锋的“查询联系人”接口的返回参数(data.mobiles)进行联系人关联
第三步:联系人跟进员工获取通过“查询联系人”接口的返回参数data.owner的数据,来调用 “查询员工信息”接口 获取联系人的主跟进员工信息员工关联:可通过查询员工信息返回的手机号信息进行员工信息的关联。(也可选择员工名称进行关联,但是需确保名称唯一)
第四步:联系人跟进员工关联:可根据获取的员工信息,将联系人绑定到指定员工
第五步:联系人标签获取:通过“查询联系人”接口的返回参数data.tags的数据,来调用 “查询标签列表和明细”接口 获取联系人标签的详细信息。
第六步**:联系人标签关联**:可将获取的联系人标签信息存储下来
第七步**:联系人自定义字段获取**:通过“查询联系人”接口的返回参数data.custom_fields.id的数据,来调用 “查询字段模版”接口 获取联系人标签的详细信息。
第八步: 联系人自定义字段关联:可将获取的联系人标签信息存储下来
涉及接口清单:
接口名称接口备注
查询联系人使用接口鉴权说明调用授权。
新增联系人事件使用接口鉴权说明调用授权。
查询好友标签列表使用接口鉴权说明调用授权。
查询员工信息使用接口鉴权说明调用授权。
查询字段模版使用接口鉴权说明调用授权。

1.2三方系统联系人资料同步至尘锋系统#

适用于在对接初始化时将三方系统的所有联系人资料统一同步至尘锋。以及将三方系统后续新增的联系人资料同步至尘锋。在联系人导入中,有两种场景:
场景A:将三方系统的客户信息指定到某个销售
场景B:将三方系统的客户信息指定到公海中
场景A举例:XX电商以前有自己的客户管理系统,想要把自己系统中的客户同步到尘锋,同时指定销售人员去跟进这些客户信息
​ img
当企业需要将客户导入尘锋系统且指定对应的员工去跟进时,可先调用“查询员工信息”接口获取员工信息,然后调用“批量新增联系人”接口将三方系统的客户资料导入至尘锋系统。 此外后续三方系统如果有新增客户资料,也可通过该接口将客户资料导入至尘锋!
注意:在批量新增联系人接口中,需把员工ID 放在customer_list.owner字段中
接口名称接口备注
查询员工信息使用接口鉴权说明调用授权。
新增联系人使用接口鉴权说明调用授权。用于第三方系统的客户信息导入至尘锋(批量导入和单个导入)
场景B举例:XX电商以前有自己的客户管理系统,想要把自己系统中的客户同步到尘锋,同时指定进公海中。
​ img
当企业需要将客户导入尘锋系统且指定公海时,可先调用“获取公海”接口来获取公海信息,然后调用“批量新增联系人”接口将三方系统的客户资料导入至尘锋系统。 此外后续三方系统如果有新增客户资料,也可通过该接口将客户资料导入至尘锋!
注意:在批量新增联系人接口中,需把公海ID 放在customer_list.pool字段中
涉及接口清单:
接口名称接口备注
查询联系人公海列表使用接口鉴权说明调用授权。
新增联系人使用接口鉴权说明调用授权。用于第三方系统的客户信息导入至尘锋(批量导入和单个导入)

1.3三方系统的联系人扩展信息同步至尘锋系统#

场景举例:客户之前有使用企微,但是用了别的服务商产生了一些客户资料,现在改用尘锋,想将之前的联系人的跟进记录信息、好友标签信息、跟进员工信息同步至尘锋系统。
​ img
当客户 需要将尘锋系统的扩展信息(跟进记录、好友标签、跟进员工)数据导入至三方系统时,需进行以下操作:
第一步:**跟进模版获取:**调用“查询跟进类型”接口,来获取跟进类型的信息
跟进类型应用场景:举例:比如XX整形医院想针对联系人的跟进类型进行不同分类,以便销售后续进行跟进。
​ img
第二步:联系人跟进记录创建 :调用“批量创建联系人跟进记录”接口创建联系人的跟进记录信息,如后台开启跟进类型开关,则该字段必传。
第三步:**联系人标签创建:**可调用“编辑联系人标签”接口维护联系人标签库。
**联系人标签编辑:**可调用“编辑联系人的标签信息”接口给联系人打上“联系人标签”。
第四步:**指定员工跟进:**可调用“批量编辑联系人”接口编辑联系人的主跟进人ID信息
涉及接口清单:
接口名称接口备注
查询跟进记录模板使用接口鉴权说明调用授权。
新增跟进记录使用接口鉴权说明调用授权。
新增联系人标签使用接口鉴权说明调用授权。
编辑联系人标签使用接口鉴权说明调用授权。
编辑联系人使用接口鉴权说明调用授权。
上一页
ERP打通
下一页
订单打通
Built with