1. 九、AI助手
帮我吧API接口文档v1
  • 接口地图
  • 一、快速入门
    • 帮我吧数据接口 - 开发向导
    • 1.1 获取 Token
      POST
  • 二、核心业务实体
    • 2.1 客户与联系人
      • 联系人管理
        • 获取联系人列表
        • 搜索联系人
        • 批量获取联系人
        • 获取单个联系人
        • 创建联系人
        • 更新联系人
        • 删除单个联系人
        • 批量删除联系人
      • 客户分组
        • 获取分组列表
        • 获取分组详情
        • 批量分组详情
        • 创建分组
        • 修改分组
        • 获取分组用户
      • 联系人字段
        • 获取联系人字段列表
      • 公司管理
        • 获取公司列表
        • 搜索公司
        • 批量获取公司
        • 获取单个公司
        • 获取公司服务记录
        • 创建公司
        • 更新公司
        • 删除单个公司
        • 批量删除公司
      • 公司字段
        • 获取公司字段列表
        • 获取公司联系人
      • 远程 ID 管理
        • 获取远程ID信息
        • 修改远程ID备注
        • 远程ID绑定联系人
        • 解绑远程 ID
    • 2.2 工单
      • 工单管理
        • 获取工单列表
        • 获取工单详情
        • 批量工单详情
        • 搜索工单
        • 创建工单
        • 修改工单
        • 批量修改工单
        • 工单拆单
      • 工单回复
        • 获取工单回复列表
      • 工单附件
        • 上传工单附件
      • 工单字段
        • 自定义字段外部扩展
        • 获取工单自定义字段
        • 获取工单所有字段
        • 覆盖字段选项
        • 更新字段选项
        • 删除字段选项
      • 工单模板
        • 获取模板列表
        • 批量工单模板
        • 获取模板详情
        • 获取模板字段
      • 工单查询器
        • 获取查询器列表
        • 获取查询器详情
        • 获取查询器的工单列表
        • 获取查询器的工单总数
        • 批量获取查询器工单数量
      • 工单签名
        • 查看、提交工单免登录动态签名规则
    • 2.3 服务记录
      • IM 服务记录
        • 获取 IM 聊天记录
        • 获取 IM 会话列表
        • 获取 IM 会话详情
        • 获取服务总结(IM)
      • CC 服务记录
        • 获取呼叫中心记录列表
        • 获取呼叫中心记录详情
        • 获取指定客服的通话记录列表
        • 获取服务总结(CC)
        • 录音解冻
      • 远程协助记录
        • 获取远程记录列表
        • 获取坐席远程记录
        • 获取远程记录的聊天记录
        • 获取服务总结(远程协助)
      • 服务总结
        • 获取业务模板列表
        • 获取业务模板详情
        • 获取业务记录列表
        • 获取业务记录详情
        • 修改业务记录
    • 2.4 知识库
      • 知识库分类
        • 获取知识库分类列表
        • 新增知识库分类
        • 修改知识库分类
        • 删除知识库分类
      • 知识库条目
        • 获取知识库列表
        • 获取知识库详情
        • 获取多条知识库
        • 创建知识库
        • 修改知识库
        • 上传知识库附件
  • 三、人员与组织
    • 3.1 客服管理
      • 获取客服列表
      • 获取客服详情
      • 搜索客服
      • 获取多个客服信息
      • 创建客服
      • 修改客服信息
      • 删除客服信息
      • 恢复删除的客服
      • 客服授权
      • 查看客服状态
      • 修改客服状态
      • 获取客服签到列表
      • 创建客服签到
      • 获取客服排班列表
      • 新增客服排班
      • 更新客服排班
      • 删除客服排班
    • 3.2 客服组管理
      • 获取客服组列表
      • 获取客服组详情
      • 获取客服组下的客服
      • 创建客服组
      • 修改客服组
      • 删除客服组
  • 四、系统配置
    • 4.1 表单管理
      • 获取表单列表
      • 获取表单详情
      • 创建表单
      • 修改表单
      • 删除表单
    • 4.2 表单字段
      • 查询指定表单的字段列表
      • 表单字段选项增加、更新
    • 4.3 资产表
      • 获取指定资产表的所有数据
      • 给指定资产表添加一行数据
      • 给指定资产表添加多行数据
      • 根据唯一值更新指定资产表一行数据
      • 更新指定资产表一行数据
      • 删除一行数据
      • 搜索资产表中的资产数据
    • 4.4 自定义字段配置
      • 列表
        • 获取字段列表-工单
        • 获取字段列表-企业
        • 获取字段列表-联系人
        • 获取字段列表-客服
        • 获取字段列表-服务总结
        • 获取字段列表-表单/资产表
      • 创建
        • 创建-单行文本 (type=2)
        • 创建-多行文本 (type=3)
        • 创建-正整数 (type=4)
        • 创建-小数 (type=5)
        • 创建-复选框 (type=6)
        • 创建-正则表达式 (type=7)
        • 创建-日期 (type=8)
        • 创建-文件上传 (type=12)
        • 创建-下拉列表 (type=1)
        • 创建-下拉列表-带外部映射ID
        • 创建-高级复选框 (type=14)
        • 创建-级联 (type=18)
        • 创建-评分 (type=13)
        • 创建-文本电话 (type=17)
        • 创建-地理位置 (type=19)
        • 创建-表格文本 (type=21)
        • 创建-签名 (type=23)
        • 创建-支付 (type=24)
        • 创建-计算字段 (type=25)
        • 创建-日期时间 (type=26)
      • 更新
        • 更新字段-基本信息
        • 更新字段-选项列表 (type=1/14)
        • 更新字段-级联 (type=18)
        • 更新字段-文本 (type=2/3)
        • 更新字段-文件上传 (type=12)
        • 更新字段-计算字段 (type=25)
      • 删除
        • 删除字段
        • 删除字段-表单/资产表
      • 查询联系人字段列表
      • 查询公司字段列表
      • 查询工单自定义字段列表
      • 查询工单字段列表(包含系统字段)
      • 下拉字段选项全量覆盖
      • 新增、修改字段选项内容
      • 删除字段选项内容
    • 4.5 客服分组管理
      • 获取客服分组列表
      • 获取客服分组详情
      • 创建客服分组
      • 修改客服分组
      • 删除客服分组
    • 4.6 工单查询器管理
      • 获取查询器列表
      • 获取查询器详情
      • 获取查询器的工单列表
      • 获取查询器的工单总数
      • 批量获取查询器工单数量
    • 4.7 工单模板管理
      • 获取模板列表
      • 批量工单模板
      • 获取模板详情
      • 获取模板字段
    • 4.8 客户分组管理
      • 获取分组列表
      • 获取分组详情
      • 批量分组详情
      • 创建分组
      • 修改分组
      • 获取分组用户
    • 4.9 短信接口
      • 获取模板列表
      • 发送短信
    • 4.10 服务商设置
      • 获取服务商账号到期时间
    • 4.11 外部扩展集成
      • 扩展系统配置文档
      • 扩展页接口文档
      • 适用客户
  • 五、呼叫中心
    • 5.1 获取客服话机状态
      • 获取客服话机状态
    • 5.2 接听模式切换
      • 获取接听模式
      • 切换接听模式
    • 5.3 SDK网页集成(CC)
      • 适用场景
      • 快速集成
      • 高级对接
  • 六、在线客服
    • 6.1 SDK网页集成(IM)
      • 适用场景
      • 快速集成
      • 高级对接
  • 七、公共接口
    • 7.1 获取 Token
      • 获取 OAuth2 Token
    • 7.2 标签接口
      • 获取标签列表
  • 八、远程工具
    • 8.1 SDK客户端集成
      • 适用场景
      • 集成方式
  • 九、AI助手
    • 9.1 MCP接入指南
  1. 九、AI助手

9.1 MCP接入指南

帮我吧 MCP — AI 助手接入指南#

本文档介绍如何将帮我吧工单系统接入 WorkBuddy 等 AI 助手,通过自然语言完成工单查询、创建、客户管理、知识库检索等日常操作。

目录#

一、获取认证信息
二、在 AI 助手中配置
三、日常使用
四、故障排查

一、获取认证信息#

帮我吧 MCP 使用 HTTP Basic Auth 进行身份认证,你需要从帮我吧后台获取 API 密钥并编码为认证头。

第 1 步:创建 API 密钥#

1.
登录帮我吧管理后台(https://www.bangwo8.com)
2.
进入 设置中心 → 开发与定制 → API 接口
3.
使用主账号创建一个 API 密钥,授权类型选择管理员权限的坐席授权
4.
记录下生成的 SecretID 和 SecretKey

第 2 步:生成认证头#

将 SecretID:SecretKey 拼接后进行 Base64 编码:
Windows(PowerShell):
[Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("你的SecretID:你的SecretKey"))
macOS / Linux(终端):
示例:
假设 SecretID 为 f4ff3173d4aae11b,SecretKey 为 62e54fae440ec7d893c250ec65e32e8e,则:
拼接:f4ff3173d4aae11b:62e54fae440ec7d893c250ec65e32e8e
编码结果:ZjRmZjMxNzNkNGFhZTExYjo2MmU1NGZhZTQ0MGVjN2Q4OTNjMjUwZWM2NWUzMmU4ZQ==
编码后的字符串将用于配置中的 Authorization 字段。

二、在 AI 助手中配置#

可用端点#

帮我吧 MCP 提供三个端点,按需选择:
端点工具数量包含功能适用角色
/mcp/user57 个工单管理、客户与联系人、服务记录、知识库、附件上传客服、一线使用者
/mcp/admin34 个自定义字段配置(查询/创建/更新/删除/选项管理)、附件上传系统管理员、实施人员
/mcp90 个以上所有功能的合集需要全部能力的场景
建议:日常使用优先选择 /mcp/user,仅当需要配置自定义字段时才使用 /mcp/admin。工具越少,AI 助手的响应越精准,因为给AI助手暴露太多的工具可能会让它在执行任务时犯迷糊。

在 WorkBuddy 中配置#

第 1 步:打开 MCP 配置
1.
打开 WorkBuddy
2.
点击左侧边栏的 专家-技能-连接器 入口
3.
点击右上角 自定义连接器 → 弹出窗口中点 配置 MCP
4.
打开 JSON 配置编辑器
第 2 步:填写配置
根据需要的端点,选择对应的配置模板(将 <你的Base64编码凭证> 替换为第一步生成的编码字符串):
用户端点(推荐):
{
  "mcpServers": {
    "bangwo8-user": {
      "url": "https://www.bangwo8.com/mcp/user",
      "headers": {
        "Authorization": "Basic <你的Base64编码凭证>"
      }
    }
  }
}
管理端点:
{
  "mcpServers": {
    "bangwo8-admin": {
      "url": "https://www.bangwo8.com/mcp/admin",
      "headers": {
        "Authorization": "Basic <你的Base64编码凭证>"
      }
    }
  }
}
全量端点:
{
  "mcpServers": {
    "bangwo8": {
      "url": "https://www.bangwo8.com/mcp",
      "headers": {
        "Authorization": "Basic <你的Base64编码凭证>"
      }
    }
  }
}
同时配置多个端点:如果需要同时使用用户端点和管理端点,请使用不同的名称(如 bangwo8-user 和 bangwo8-admin),避免进程去重导致只有一个生效。
第 3 步:信任并启用
1.
保存 JSON 配置
2.
在连接器列表中找到新增的帮我吧连接器
3.
点击 Trust(信任)按钮
4.
重启 WorkBuddy 使配置生效

在其他 AI 助手中配置#

对于支持 Streamable HTTP MCP 的其他客户端(如 Claude Desktop 通过 mcp-remote 桥接),配置方式类似:
{
  "mcpServers": {
    "bangwo8-user": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://www.bangwo8.com/mcp/user",
        "--header",
        "Authorization:Basic <你的Base64编码凭证>"
      ]
    }
  }
}

验证连接#

重启后,在对话中输入:
请列出帮我吧 MCP 可用的工具列表
连接成功时,AI 助手会列出可用的帮我吧工具(如 list_tickets、create_ticket、search_contacts 等)。

三、日常使用#

配置完成后,直接用自然语言描述需求即可,AI 助手会自动选择并调用对应的帮我吧工具。无需特殊格式或命令。

工单管理#

查询我今天的待处理工单列表

帮我看一下工单 #36007290 的详细信息和最新回复

创建一个工单,标题是"打印机故障",描述是"三楼会议室打印机无法正常工作",优先级设为高

把工单 #36007290 的状态改为已解决,备注"已更换墨盒"

搜索所有包含"网络故障"关键词的工单

客户与联系人#

查一下公司"腾讯科技"的详细信息

帮我搜索联系人张三的联系方式

列出最近新增的客户公司

查看客户组"VIP客户"下面有哪些客户

服务记录#

查看今天的 IM 在线客服记录列表

帮我查一下最近跟客户李四的通话记录

看一下客服小王今天的远程协助记录

知识库#

搜索知识库中关于"密码重置"的文章

帮我创建一条知识库条目,标题是"如何修改登录密码"

更新知识库条目 #123 的内容

自定义字段配置(管理端点)#

列出工单模块的所有自定义字段

给工单模板添加一个下拉列表字段"故障类型",选项有:硬件故障、软件故障、网络故障

删除联系人模块的"备用邮箱"字段

更新工单下拉字段"优先级"的选项列表

参考信息#

工单状态:
状态码含义
1新建
2已开启
3待回应
4已解决
5自动关闭
6手动关闭
工单类型:
类型码含义
1问题
2事务
3故障
4任务
优先级:
优先级码含义
1低
2正常
3高
4紧急

四、故障排查#

常见问题#

Q: AI 助手中没有看到帮我吧的工具
确认 JSON 配置已保存且格式正确(无多余逗号、引号匹配)
确认已点击 Trust 按钮信任该连接器
重启 AI 助手(配置修改后通常需要重启才能加载新的 MCP Server)
Q: 工具调用时报认证错误(401 Unauthorized)
检查 Authorization 头的值是否以 Basic 开头(注意 Basic 后有一个空格)
检查 Base64 编码是否正确——可以反向解码验证:
输出应为 SecretID:SecretKey 的格式
确认 API 密钥未被我吧后台禁用或删除
Q: 配置了两个端点但只有一个生效
AI 助手可能按连接器名称做了进程去重。确保两个配置使用不同的名称(如 bangwo8-user 和 bangwo8-admin)
修改配置后重启 AI 助手
Q: 创建工单时不知道该用哪个模板
让 AI 助手分步引导:
1.
帮我列出所有工单模板
2.
查看"IT支持"模板有哪些字段
3.
用这个模板创建一个工单,标题是...
Q: 连接超时或无法连接
确认网络可以正常访问 https://www.bangwo8.com
在公司网络环境中可能需要配置代理
Q: AI 助手调用了管理端的工具(如创建自定义字段),但我只想给用户端权限
将配置中的 URL 从 /mcp 改为 /mcp/user,这样 AI 助手只能看到用户侧的 57 个工具,不会误触管理操作
修改于 2026-08-25 02:18:40
上一页
集成方式
Built with