1. 4.11 外部扩展集成
帮我吧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 自定义字段配置
      • 查询联系人字段列表
      • 查询公司字段列表
      • 查询工单自定义字段列表
      • 查询工单字段列表(包含系统字段)
      • 下拉字段选项全量覆盖
      • 新增、修改字段选项内容
      • 删除字段选项内容
    • 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 标签接口
      • 获取标签列表
  1. 4.11 外部扩展集成

适用客户

适用客户#

场景说明
场景一不希望将客户的任何信息同步到帮我吧,但希望在帮我吧工作台能看到第三方系统里的客户信息
场景二可以将客户的部分信息同步到帮我吧(如:公司名称、服务期限),但希望在帮我吧工作台能看到第三方系统里的其余信息
场景三希望在帮我吧工作台看到第三方系统的客户信息(如:订单信息、物流信息等)

对接效果#

下图中红框部分为信息页展示区域:
在线聊天:工作台侧边栏展示客户信息页
image.png
呼叫中心:通话时展示客户信息页
image.png
帮我吧客服端:远程服务时展示客户信息页
image.png

对接说明#

要实现对接,第三方系统需提供信息页,帮我吧工作台会以 iframe 的形式加载该页面。
重要提示:帮我吧登录是 HTTPS 的,所以信息页建议支持 HTTPS,否则使用者需要每次手动将帮我吧登录切换成 HTTP。

对接步骤#

1.
开发信息页 — 按照本文档规范开发客户信息展示页面
2.
部署信息页 — 将信息页存放到帮我吧可以访问的地址上
3.
配置信息页 — 将信息页的地址配置到帮我吧后台(具体参考系统配置文档)

参数传递#

帮我吧工作台根据客户来源不同分为四种方式,不同工作台有对应的用户标识。帮我吧默认将系统用户标识推送给信息页,工作台上也可设置其他字段推送给信息页。

1. IM(即时聊天)#

系统默认用户标识#

IM 来源的客户主要分为微信原生、微信 H5、网站三种,不同来源对应的系统用户标识不同:
标识字段说明
weChatId微信原生来的客户标识,即微信的 OpenID
webChatId微信 H5 和网站来的客户标识,由帮我吧系统自动生成

可设置的其他推送字段#

模式可推送字段
2B 模式公司和联系人的自定义字段
2C 模式联系人的自定义字段

特殊参数#

参数说明
custominfo第三方系统的用户身份标识,无需设置字段推送,默认已有。常用对接场景:第三方系统集成 IM 客户端时,将该标识传递给帮我吧,客服在帮我吧工作台上的扩展页面根据该标识显示客户信息

2. 远程#

系统默认用户标识#

标识字段说明
帮我吧客户端的 9 位 ID客户端安装时自动生成

特殊参数#

参数说明
custominfo第三方系统的用户标识,无需设置字段推送,默认已有。常用对接场景:第三方系统集成帮我吧客户端时,将该标识传递给帮我吧,客服在帮我吧工作台上的扩展页面根据该标识显示客户信息

3. 呼叫中心#

系统默认用户标识#

标识字段说明
联系人的系统字段"手机号码"来电号码匹配的客户手机号

可设置的其他推送字段#

模式可推送字段
2B 模式公司的系统字段"服务账号"、公司和联系人的自定义字段
2C 模式联系人的自定义字段

4. 工单#

系统默认用户标识#

标识字段说明
联系人的系统字段"手机号"工单关联客户的手机号

可设置的其他推送字段#

字段类型说明
联系人的系统字段"邮箱"
当前工单模板里的自定义字段工单模板中配置的所有自定义字段

通用说明#

数据格式: 参数通过 URL Query 参数传递给信息页
安全建议: 信息页建议支持 HTTPS,确保数据传输安全
身份验证: 信息页可根据传递的标识参数,向第三方系统请求客户详细信息
修改于 2026-04-14 12:32:21
上一页
扩展页接口文档
下一页
获取客服话机状态
Built with