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

高级对接

概述#

高级对接可以自定义更多的内容,除了跟快速集成一样能够自定义弹屏的信息页面外,还可以自定义收到不同系统消息推送时(比如振铃消息、接听消息、挂断消息等)的操作。
具体请参考高级接口文档说明及 Demo 源码。Demo 源码请到 callcentersdk_v1.zip 下载。

高级接口函数#

1. 初始化及登录#

函数说明
参数说明
名称类型注释
usernamestring帮我吧的客服账号
pwdstring客服账号对应的密码
onConnection回调函数用来接收系统消息推送。如果该参数为空,则执行系统默认消息处理。具体消息参见 Demo
onError回调函数用来接收系统错误消息。具体请参考返回值格式
说明:仅需在程序开始的时候调用一次。

2. 外呼#

函数说明
参数说明
名称类型注释
numberstring拨打的电话号码。支持手机和座机,如果对方是座机,则拨号为 01063701717

3. 通话挂断#

函数说明

4. 呼叫弹屏#

函数说明
参数说明
名称类型注释
urlstring弹屏里面要显示的第三方系统的信息页面。该页面默认宽度为 593px,高度为 362px
typebool为 true 时,表示要弹屏;为 false 时,表示要关闭弹屏。默认为 false
说明:如果您想自定义弹屏样式,请直接修改函数里面的 CSS 样式。

5. 获取来电号码#


6. 获取 callid#


7. 开启 debug 模式#


转接功能接口#

接口地址#

GET /api/v1/callCenter.json

请求参数#

名称类型必传注释
actionstring是操作类型:serviceList-客服列表、groupList-客服组列表、transferService-转客服、transferGroup-转客服组
callIdstring是(转给具体客服、客服组时)函数中获取的 callId
transferIdstring两个参数至少写一个(转给客服时)有呼叫中心权限的客服可以指定 ID 转接
mobilestring两个参数至少写一个(转给客服时)没有呼叫中心的客服只能通过具体的号码转接
groupIdstring是(转给客服组时)客服组 ID

1. 转接客服列表#

获取有呼叫中心权限的在线空闲客服列表,以及没有呼叫中心的客服列表。
调用示例
返回参数
名称类型注释
call_dataarray有呼叫中心权限的在线空闲的客服列表
except_call_dataobject没有呼叫中心的客服列表
active_tabstring默认打开的 tab,kfgroup-客服组,kf-客服
返回示例
{
    "call_data": [],
    "except_call_data": {
        "189106": {
            "sId": "189106",
            "realName": "cctest002",
            "mobile": "18770918874",
            "sNum": "002"
        },
        "189109": {
            "sId": "189109",
            "realName": "cctest003勿动舞动舞动舞动",
            "mobile": "17773896237",
            "sNum": "003"
        }
    },
    "active_tab": "kfgroup"
}

2. 转接客服组列表#

调用示例
返回参数
名称类型注释
groupobject客服组列表
active_tabstring默认打开的 tab,kfgroup-客服组,kf-客服
返回示例
{
    "group": {
        "7339": {
            "groupId": "7339",
            "groupName": "流云"
        },
        "8957": {
            "groupId": "8957",
            "groupName": "标签测试组"
        }
    },
    "active_tab": "kfgroup"
}

3. 转接(客服)操作#

调用示例
返回结果
status=200:转接成功
其他:转接失败
返回示例
{
    "status": "7",
    "message": "{\"msg\":\"Failed to connect to 47.104.61.120 port 1858: Connection refused\",\"data\":{\"action\":\"<?xml version='1.0' encoding='UTF-8'?><Response userdata='-189106-17600208764--2323232-transfer--'><Play_1 async='false' stop_on_input='true' global_sound_file='true'>transfering.wav<\\/Play_1><Play_2 async='true' stop_on_input='true' global_sound_file='true'>background.wav<\\/Play_2><Dial onActionCallback='call_busy' onEndCallback='transfer_end' onAccept='bridge' onAcceptCallback='' record='true' recordingStatusCallback='voice_record' timeout='30'><Number url='agent_transfer' statusCallback='agent_state' StatusCallbackEvent='' LineNumber='' DisplayNumber=''>17600208764<\\/Number><\\/Dial><Hangup><\\/Hangup><\\/Response>\"},\"uri\":\"https:\\/\\/47.104.61.120:1858\\/v1\\/accounts\\/9afb90c41a0bbfc6\\/apps\\/a02d35242988c233\\/calls\"}"
}

4. 转接(客服组)操作#

调用示例
返回结果
status=200:转接成功
其他:转接失败
返回示例
{
    "status": "404",
    "message": "group member is empty"
}

通用说明#

认证方式: HTTP Basic Auth(Authorization: Basic {base64})
基础URL: 根据部署环境不同,使用对应的 API 地址
数据格式: JSON
修改于 2026-04-14 12:38:33
上一页
快速集成
下一页
适用场景
Built with