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 标签接口
获取标签列表
5.3 SDK网页集成(CC)
复制页面
快速集成
概述
#
快速集成使用的是系统
默认的弹屏界面
,即弹屏上的电话条及弹出的客户信息页的大小都是固定的(具体弹屏效果可参考概述里的 Demo 效果图)。
对接步骤
#
1. 引入头文件(依赖 jQuery)
#
注意
:该 SDK 依赖 jQuery,请确保页面已引入 jQuery。
2. 初始化系统
#
说明
:
1.
请将该操作放在外呼操作的前面,尽量往前放
2.
仅需初始化一次
3. 外呼
#
说明
:
1.
请将该操作放在需要打电话的地方
2.
如果您想获取本次通话的唯一标识,请参考高级接口里的获取
callid
函数,直接在外呼函数的下面调用即可
3.
外呼结束后建议 10s 后再获取本次通话记录
,因为录音生成需要一定的时间
弹屏参数说明
#
来电弹屏时,系统会以
GET
方式将以下参数传给配置的弹屏 URL:
参数名
说明
phoneNumber
来电号码
完整示例
#
注意事项
#
事项
说明
初始化时机
尽量放在页面加载完成后的最早时机
初始化次数
整个页面生命周期仅需初始化一次
录音延迟
外呼结束后建议等待 10s 再获取通话记录
依赖库
必须引入 jQuery
修改于
2026-04-14 12:38:29
上一页
适用场景
下一页
高级对接