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

外呼平台接入SCRM自检说明文档

外呼平台接入SCRM自检说明文档#

📋 文档说明#

文档用途:本文档用于帮助第三方呼叫平台技术人员快速判断自身系统是否符合尘锋SCRM呼叫中心的接入要求。
适用对象:第三方呼叫平台的技术负责人、架构师、开发工程师。
重要提示:
✅ 本文档为自检清单,用于初步判断接入可行性
✅ 自检通过后,尘锋技术人员会根据资料进行二次核对与确认
❌ 不支持软电话条方式接入;

🎯 接入流程概述#

尘锋SCRM呼叫中心的外呼流程已固定,第三方平台需支持以下标准流程:
1. 鉴权认证(如需) → 2. 发起外呼 → 3. 事件回调 → 4. 录音获取
交互流程:
尘锋调用三方系统鉴权接口获取token(如果需要)
尘锋调用第三方外呼接口
第三方系统在通话结束之后一次性将通话数据(包含录音地址)回调给尘锋系统;
核心原则:
所有接口均为 HTTP/HTTPS 协议
外呼发起采用 同步调用 方式
通话数据采用 异步回调(Webhook) 方式
录音文件可以通过 公网URL直接访问 方式获取
token必须是全局可用;
外呼和回调接口入参都单次只支持单条数据(不支持数组),不支持单次批量外呼和批量回调;

✅ 自检清单#

📌 维度一:鉴权机制与接口安全(如需)#

1.1 鉴权方式支持#

要求:支持以下任一鉴权方式
鉴权方式说明示例
✅ 静态API Key在HTTP Header/body中携带固定KeyAuthorization: api_key xxxxxxxx
✅ Bearer Token在HTTP Header/body中携带TokenAuthorization: Bearer xxxxxxxx
✅ 参数签名基于MD5的签名signature=md5(params+secret)
❌ 不支持的鉴权方式:
非标准的动态加密算法
复杂的多重鉴权机制
token非全局可用,每次外呼都需要进行token接口请求;

📌 维度二:发起外呼接口参数要求#

2.1 必填参数完整性#

要求:发起外呼接口必须支持以下核心参数
参数名称参数说明是否必填备注
被叫客户手机号✅ 必填如:callee、phone_number
主叫员工号码或唯一id✅ 必填如:caller、display_number
⚠️ 关键要求:
字段名可以不同,但语义必须具备
自检问题:
你们的发起外呼接口支持哪些参数?
该ID是否会在后续回调中返回?

2.2 接口调用方式#

要求:
请求方式:HTTP POST
请求格式:JSON 或 Form Data
响应格式:JSON
自检问题:
接口是否支持POST请求?
请求和响应格式是什么?

📌 维度三:事件回调与录音获取#

3.1 异步回调支持(Webhook)#

要求:必须支持Webhook机制,在通话结束时主动推送通话结果,必须包含录音地址(外网可以访问)
回调时机:
通话结束(必须)
回调方式:
请求方式:HTTP POST
请求格式:JSON
回调URL:由尘锋SCRM提供
自检问题:
你们的系统是否支持Webhook回调?
回调时机是否支持?
是否满足回调方式要求?

3.2 回调参数的关联性#

要求:回调数据中必须包含与外呼接口一致的主叫与被叫信息
必填回调参数:
**主叫ID(**与发起外呼时传入的主叫ID一致)
被叫ID(与发起外呼时传入的被叫ID一致)
通话状态
通话开始时间
通话结束时间
**录音地址
⚠️ 关键要求:
回调中必须包含尘锋SCRM传入的主被叫ID
录音地址必须是可以通过URL可以直接公网访问的地址
自检问题:
回调数据中包含哪些参数,是否满足要求?
回调中的主被叫ID是否与外呼接口入参传入的主被叫ID一致?
录音地址是否支持公网访问?

3.3 录音文件获取方式#

要求:回调数据中必须包含录音文件的URL
录音URL要求:
必须是公网HTTP/HTTPS链接
可直接在浏览器中播放或下载
可支持简单的URL签名或固定的Header Token
❌ 不支持需要额外调用接口下载二进制流的方式
❌ 不支持需要复杂解密的方式
自检问题:
回调数据中是否包含录音URL?
录音URL是否可直接访问?
是否需要特殊的鉴权或解密?

3.4 回调参数结构#

要求:回调参数必须是单条记录,不支持批处理
❌ 不支持的回调结构:
{
  "records": [
    {"call_id": "1", "status": "completed"},
    {"call_id": "2", "status": "completed"}
  ]
}
✅ 支持的回调结构:
{
  "call_id": "1",
  "status": "completed",
  "task_id": "123456",
  "record_url": "https://example.com/recording/1.mp3"
}
自检问题:
回调数据结构是单条还是多条?
是否单条数据回调(包含录音)?

📊 判断标准#

✅ 可接入(初步判断)#

满足以下所有条件:
鉴权方式符合要求(静态API Key / Bearer Token / 参数签名)
发起外呼接口支持业务关联ID
支持Webhook异步回调
回调中包含发起外呼时候的主被叫ID
回调中包含公网可直接访问的录音URL
外呼和回调中的参数结构为单条记录

❌ 无法接入#

满足以下任一条件:
不支持Webhook回调
录音无法通过公网URL直接获取
回调结构为批处理且无法转换

🔍 常见问题#

Q1:录音URL需要签名验证,是否可以?#

A:不支持。

Q2:我们的回调是批量推送的,是否可以接入?#

A:当前系统不支持批量回调,需要第三方平台改为单条推送。

文档版本:v1.0
更新日期:2026-04-15
维护方:尘锋技术团队
修改于 2026-04-27 01:58:57
上一页
获客助手对接场景
下一页
查询联系人
Built with