尘锋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. 接入前准备

回调接入指南

一、接入必读#

对接前需要在下图所示位置进行配置并提交保存,通过对应接口要求的信息与SCRM系统交互;
当尘锋系统内的联系人、企业、旅程、订单等业务内容发生变更时,支持推送变更事件给您,您需要在“设置-系统对接”页面完成 消息校验token、消息加解密key、消息与事件接受URL、调用数据加解密 四个参数的配置;
WX20241230-191711@2x.png
【加密解密】密文数据仅用于尘锋SCRM系统联系人管理部分接口主动向第三方系统服务端推送变更事件;
1、调用数据加密不论是否开启,在初次配置消息与事件接受URL时,均需要实现完整的数据解密逻辑,解密逻辑可参考本文《三、URL配置校验(GET请求)-2、三方系统-URL配置校验解密示例》
2、如暂时不确定对SCRM系统发起请求的服务器出口IP或者其他情况,可先设置为0.0.0.0调试,后期根据第三方系统的实际情况进行调整;
3、OpenAPI进行新增和编辑等操作不会触发对应事件变更回调

二、配置回调URL、加密参数#

【消息与事件接受URL】:避免使用"searchs"等关键字作为回调地址路径的一部分,回调地址URL需同时支持GET和POST请求;配置或更新回调地址时,尘锋SCRM会对目标回调地址发起一次GET请求,第三方系统需按照《三、URL配置校验(GET请求)》对请求进行正确的解密处理并返回要求内容才可以通过校验;
【调用数据加密】:选择数据加密后,所有的业务数据变更事件推送时,我们将对事件body进行加密并发送POST请求到“消息与事件接受URL”,您可参考 解密SDK对其解密后使用;
【配置提交保存】:点击提交按钮时,我们会向您填写的“消息与事件接受URL”发送GET请求校验URL的可用性,您需要配合解密SDK解密之后原样返回给我们,校验成功后才能配置成功。
1、所配置的回调地址URL需要确保能够在公网被访问;
2、GET请求用于验证秘文解密逻辑是否被正确实现,SCRM系统回调该接口时,第三方系统需要对推送的秘文进行解密并返回解密后的明文,返回示例参考:《三、URL配置校验(GET请求)- 3、三方系统-URL配置校验解密返回示例》;
3、POST请求用于后续验证推送内容时是否正确被接收,接收到请求后返回指定结构体即可。返回示例参考:《四、尘锋系统变更事件推送(POST请求)- 3、三方系统事件接收响应内容示例》;

三、URL配置校验(GET请求)#

1、尘锋SCRM-URL配置校验加密请求示例#

在尘锋系统配置完毕URL地址之后,尘锋系统会通过GET请求对目标地址发起加密请求;
下列代码仅展示示例,并不能用作调试使用,请使用您公司尘锋账户的相关参数进行调试

2、三方系统-URL配置校验解密示例#

三方系统接收到尘锋系统发起的GET加密请求之后,需要使用租户对应的加密信息对加密请求进行解密;
解密所需SDK点击这里跳转

3、三方系统-URL配置校验解密返回示例#

对GET请求解密后,您需要将解密后的内容原样返回给尘锋系统,如果与尘锋系统加密前的内容一致,尘锋系统将判定三方系统解密成功并且界面将成功保存,URL地址配置成功。
注意:返回时Header需设置Content-Type:text/plain,另外切勿额外携带 "" 包装返回内容;

4、异常处理#

报错原因为返回给尘锋的解密数据有错误,请严格根据文档说明进行解密返回。
image.png

四、尘锋系统变更事件推送(POST请求)#

URL地址配置完毕之后,当尘锋系统的客户数据有新增/删除/修改时,尘锋会主动向您填写的URL发送POST请求,携带回调数据。

1、尘锋推送加密请求示例#

⽬前联系人事件仅会推送变更客户的id,具体事件类型由body解密后的type判断。
type⽀持的值:add(新增客户)/del(删除客户)/update(客户更新)。
三⽅拿到客户id(cus_ids)后调⽤拉取接⼝获取客户的全量信息进⾏数据同步。
event代表事件分类,⽬前仅⽀持customer。
1、加密参数通过贵司的clientId、clientToken、clientKey参与生成,以下示例仅供参考结构,不支持解密!
2、删除客户的情况del_reason包括三种值:ordinaryDel(普通客户删除),userDel(员⼯删除外部联系⼈),externalDel(外部联系⼈删除员⼯)

2、三方系统解密后完整body示例#

解密所需SDK点击这里跳转
您可以根据我们传递的type自行规划业务逻辑

3、三方系统事件接收响应内容示例#

当您接收到我方推送的变更事件回调请求时,需返回JSON格式的code
数据类型为int
成功返回:1
失败返回:0
{
"code" : 1
}

1、回调服务需在3秒内完成响应,建议收到消息推送后⽴刻返回成功响应示例,避免⼀直占⽤请求连接,被判超时

2、切勿在回调处理逻辑内增加额外业务处理逻辑,避免延长响应时间,当推送事件较频繁时,可能会导致接口请求超时。


3、推送限制:多次响应超时、服务器⽆响应、多次响应失败,10分钟内达到100次,推送接⼝将降低所有推送事件频率为3⼩时⼀次。

五、加密SDK(自测)#

尘锋通过BizMsgCrypt.EncryptMsg(String replyMst)将数据加密并推送给您,您也可以通过此函数自行校验;
加密所需参数以您在尘锋系统里获取到的为准。
WX20241230-191459@2x.png
image.png

六、三方系统-接口处理代码示例#

Q1:处理GET请求时为什么要将" "全量替换为"+"?#

url传输过程中会将"+"替换为空格,导致解密失败,您可以使用此函数进行处理
image.png

Q2:java.security.InvalidKeyException: Illegal key size#

解决方案JCE无限制权限策略文件

Q3:commons-codec依赖#

当解密遇到以下报错时可以尝试添加此版本依赖解决
Exception in thread "main" java.lang.IllegalArgumentException: Last encoded character (before the paddings if any) is a valid base 64 alphabet but not a possible value
<dependency>
       <groupId>commons-codec</groupId>
       <artifactId>commons-codec</artifactId>
       <version>1.15</version>
</dependency>
上一页
接口鉴权说明
下一页
报错code码说明
Built with