1. 6.1 SDK网页集成(IM)
帮我吧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. 6.1 SDK网页集成(IM)

高级对接

对于集成IM客户端的网页,如果您希望用户咨询时,能携带业务参数,如:来源、用户身份等信息,就需要额外对接。
这里以用户身份识别为例,对于用户身份识别有两种方式,
一种是通过接口预先导入到帮我吧系统,进线使用帮我吧的联系人识别逻辑,展示联系人的相关信息,实现效果如图:
image.png
另一种,如果不导入联系人资料的话,就需要使用 4.11 外部扩展 集成的方式,创建工作台组件,通过外部扩展页面来展示用户信息,帮我吧只负责收集参数,并完整传递给外部扩展链接,识别逻辑由外部系统来实现。实现效果如图:
image.png

使用组件对接业务信息#

您需要在集成im客户端sdk的网页上,将业务相关参数放在一个id标识为 bw8-third-party 固定元素上,使用data-thirdparty='{"key":"value"}',将所有要传递的参数都放在其中,用户点击咨询按钮时,会获取相关参数,拼到进线链接上,用于系统识别或传递给外部扩展链接。如:
<span style="display: none" id="bw8-third-party" data-thirdparty='{"vendorID":"18","field_key":"authAccount","field_value":"894433","customInfo":""}'></span>

使用URL对接业务信息#

您只需将业务参数和值,追加在IM进线链接上即可,如果开启了签名校验,需要按照签名规则进行签名。

帮我吧 IM 客户端动态签名规则说明#

注意:此规则仅当后台开启"客户端动态签名"选项时才生效。

1. URL 必传参数#

参数名说明
signature签名 Token
timestamp13 位时间戳
nonce随机数

2. 签名规则说明#

对除 signature 外的全部参数进行签名
签名步骤:先字典升序,后 Hash
sha1(private_key, timestamp, nonce, param1...)
参数说明
private_key密钥(在后台设置中生成和重置)
timestamp时间戳,1 小时内有效
nonce随机数
param1...其余参数根据实际需要传递
重要:中文参数使用 UTF-8 编码,必须 URL Encode

3. 签名代码示例#

① PHP 版本#


② Java 版本#


4. 最终生成的带签名 URL 链接示例#

https://www.bangwo8.com/osp2016/im/pc/index.php?vendorID=128789&uid=u6_128789_1234567890&timestamp=1566385123983&nonce=862739&signature=588370c3a10858fde89e16cc26ea775e0f87129c

关键要点总结#

项目说明
签名算法SHA1
参数排序按值字典升序(SORT_STRING)
时间戳精度13 位毫秒级时间戳
时间戳有效期1 小时
编码要求UTF-8,中文必须 URL Encode
必传参数private_key、timestamp、nonce + 业务参数
UID 格式u6_{vendorID}_{第三方系统账号}(API 方式对接时)
修改于 2026-04-14 12:45:57
上一页
快速集成
下一页
获取 OAuth2 Token
Built with