1. 接入前准备
尘锋SCRM开放平台
  • 接入前准备
    • 接口鉴权说明
    • 回调接入指南
    • 报错code码说明
    • 省市区code码
    • 民族id对应关系
    • 获取附件URL访问签名
    • 更新日志
    • AI编程指南
  • 对接方案介绍
    • 联系人架构介绍
    • 员工概览
    • 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. 接入前准备

AI编程指南

为了让大家写代码、对接接口时更简单快捷,我们已将系统的最新 API 文档接入了 AI。完成以下两步简单配置后,你的 AI 助手(Cursor、Claude 等)将能直接阅读我们的最新接口文档!

🟢 第一步:安装运行环境#

AI 助手需要一个小插件来读取网上的文档。我们使用目前最快的工具 uv 来运行它。请打开你电脑上的命令行终端(Mac用户打开 Terminal,Windows用户打开 PowerShell),复制并执行以下命令:
🍎 Mac / Linux 用户请复制:
🪟 Windows 用户请复制:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
⚠️ 关键提醒:安装完成后,必须完全关闭当前终端窗口,重新打开一个新的终端!
在新终端里输入 uv --version,如果出现版本号(如 uv 0.x.x),说明安装成功!

🔵 第二步:配置 AI 编程软件#

我们系统的文档地址为:https://pdm.dustess360.com/llms.txt 。请根据你日常使用的 AI 软件,选择对应的配置教程(只需选一个你用的就行):

Cursor IDE#

1.
打开 Cursor,按下快捷键 Cmd + , (Mac) 或 Ctrl + , (Windows) 打开设置。
2.
在左侧菜单点击 Features,往下滚动找到 MCP 区域。
3.
点击 + Add New MCP Server 按钮。
4.
按下方要求填写:
Type: 选择 command
Name: 填写 SystemAPI
Command: 复制并粘贴以下整段代码(记得替换你的域名):
5.
点击 Save(保存)。
6.
🎉 完成! 看到前方亮起绿色小圆点,即可去 Cursor Chat 里对话了。

Claude 桌面端 (Claude Desktop)#

1.
点击打开你电脑里的配置文件:
Mac 用户:打开终端,输入 open "~/Library/Application Support/Claude/",找到 claude_desktop_config.json 文件并双击打开。
Windows 用户:按下 Win + R,输入 %APPDATA%\Claude 回车,找到 claude_desktop_config.json 文件用记事本打开。
(如果找不到这个文件,请手动新建一个同名文件)
2.
将以下代码全部复制并粘贴到该文件中:
{
  "mcpServers": {
    "scrm-api-docs": {
      "command": "uvx",
      "args": [
        "--from",
        "mcpdoc",
        "mcpdoc",
        "--urls",
        "ScrmApiDocs:https://pdm.dustess360.com/llms.txt"
      ]
    }
  }
}
3.
保存文件。彻底退出 Claude 软件(Mac按 Cmd+Q),然后重新打开。
4.
🎉 完成! 点击聊天框右下角的“小锤子/插头”图标,看到 SystemAPI 即可。

Claude Code#

1.
打开终端。
2.
直接复制并运行以下命令(记得替换你的域名):
3.
🎉 完成!

Windsurf IDE#

1.
点击打开 Windsurf 的配置文件:
Mac 用户:打开终端,输入 open ~/.codeium/windsurf/,找到 mcp_config.json。
Windows 用户:打开文件夹 %USERPROFILE%\.codeium\windsurf\,找到 mcp_config.json。
(如果没有此文件,手动创建一个)
2.
填入与 Claude Desktop完全相同的 JSON 代码并保存。
3.
重启 Windsurf。🎉 完成!

🎯 第三步:如何向 AI 提问?(测试一下)#

配置完成后,请在 AI 软件的聊天框(比如 Cursor Chat)里直接发送这句话进行测试:
“请查阅 MCP 资源 scrm-api-docs,告诉我系统接口文档里有哪些模块?”
如果 AI 成功列出了我们系统的接口分类(如“用户模块”、“订单模块”),说明跑通了!
修改于 2026-05-13 05:47:48
上一页
更新日志
下一页
联系人架构介绍
Built with