本产品(
智能联络中心/2019-10-15
)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
热线监控数据
API | 标题 | API概述 |
---|---|---|
GetHotlineServiceStatistics | 获取热线监控下服务统计量 | 获取热线监控下服务统计量。 |
GetSkillGroupAndAgentStatusSummary | 获取热线监控下技能组坐席汇总状态量 | 获取热线监控下技能组坐席汇总状态量。 |
GetDepartmentalLatitudeAgentStatus | 获取热线监控下部门纬度状态量 | 获取热线监控下部门纬度状态量。 |
GetSkillGroupLatitudeState | 获取热线下监控技能组纬度状态量 | 获取热线下监控技能组纬度状态量。 |
GetAgentBasisStatus | 获取热线监控下坐席纬度状态量 | 获取热线监控下坐席纬度状态量。 |
GetAgentStatistics | 获取热线监控下坐席纬度统计量 | 获取热线监控下坐席纬度统计量。 |
在线监控数据
API | 标题 | API概述 |
---|---|---|
GetOnlineServiceVolume | 获取在线监控下在线服务量 | 获取在线监控下在线服务量。 |
GetSeatInformation | 获取在线监控下部门坐席服务能力数据 | 获取在线监控下部门坐席服务能力数据。 |
GetSkillGroupServiceCapability | 获取在线监控下技能组纬度服务能力数据 | 获取在线监控下技能组纬度服务能力数据。 |
GetSkillGroupAgentStatusDetails | 获取技能组服务状态量 | 获取技能组服务状态量。 |
GetOnlineSeatInformation | 获取在线监控下在线坐席信息数据 | 获取在线监控下在线坐席信息数据。 |
GetQueueInformation | 获取在线监控下技能组纬度队列信息 | 调用GetQueueInformation接口获取在线监控下技能组纬度队列信息。 |
热线报表数据
API | 标题 | API概述 |
---|---|---|
GetSkillGroupStatusTotal | 获取热线报表下技能组状态总量 | 获取热线报表下技能组状态总量。 |
GetAgentDetailReport | 获取热线报表下热线坐席详情汇总数据 | 获取热线报表下热线坐席详情汇总数据。 |
在线报表数据
API | 标题 | API概述 |
---|---|---|
GetSkillGroupServiceStatus | 获取在线报表下技能组服务状态量 | 调用GetSkillGroupServiceStatus接口获取在线报表下技能组服务状态量。 |
GetAgentServiceStatus | 获取在线报表下坐席服务状态量 | 调用GetAgentServiceStatus接口获取在线报表下坐席服务状态量。 |
坐席管理
API | 标题 | API概述 |
---|---|---|
CreateAgent | 创建坐席 | 调用CreateAgent接口创建悉犀客服工作台坐席账号,并返回坐席ID。 |
DeleteAgent | 删除坐席 | 调用DeleteAgent接口根据坐席账号名称,删除悉犀客服工作台坐席账号。 |
UpdateAgent | 更新坐席数据 | 调用UpdateAgent接口根据坐席账号名称修改悉犀客服工作台坐席信息。 |
GetAgent | 获取坐席信息 | 根据坐席账号名称查询悉犀客服工作台坐席信息。 |
ListAgentBySkillGroupId | 获取技能组下坐席信息 | 根据技能组ID查询悉犀客服工作台坐席列表。 |
GetHotlineAgentStatus | 获取热线坐席状态 | 调用GetHotlineAgentStatus接口根据坐席账号名称查询悉犀客服工作台热线坐席状态。 |
RemoveAgentFromSkillGroup | 从技能组移除坐席账号 | 调用RemoveAgentFromSkillGroup接口从技能组移除坐席账号。 |
GetHotlineAgentDetail | 获取热线坐席详情 | 调用GetHotlineAgentDetail接口根据坐席账号获取热线坐席当前服务详情。 |
技能组管理
API | 标题 | API概述 |
---|---|---|
CreateSkillGroup | 创建技能组 | 调用CreateSkillGroup接口根据技能组名称和渠道类型创建技能组。 |
UpdateSkillGroup | 修改技能组 | 根据技能组ID更新悉犀客服工作台技能组信息。 |
RemoveSkillGroup | 删除技能组 | 调用RemoveSkillGroup接口根据技能组ID删除悉犀客服工作台技能组。 |
QuerySkillGroups | 查询技能组 | 调用QuerySkillGroups接口查询悉犀客服工作台技能组列表。 |
ListSkillGroup | 查询技能组 | 调用ListSkillGroup接口根据技能组渠道类型查询悉犀客服工作台技能组。 |
GetDepGroupTreeData | 查询技能组分组和技能组列表 | 调用GetDepGroupTreeData接口查询技能组分组和技能组列表。 |
部门管理
API | 标题 | API概述 |
---|---|---|
CreateDepartment | 创建部门信息 | 调用CreateDepartment接口创建部门信息。 |
GetAllDepartment | 获取所有部门信息 | 调用GetAllDepartment接口获取所有部门信息。 |
DeleteDepartment | 删除部门信息 | 调用DeleteDepartment接口删除部门信息。 |
UpdateDepartment | 更新部门信息 | 调用UpdateDepartment接口更新部门信息。 |
通道
API | 标题 | API概述 |
---|---|---|
GenerateWebSocketSign | 生成messagbox通道签名 | 生成消息通道访问签名。 |
通话详情
API | 标题 | API概述 |
---|---|---|
HotlineSessionQuery | 批量查询通话详情 | 调用HotlineSessionQuery接口查询通话详情。 |
GetRecordData | 获取录音文件 | 调用GetRecordData接口获取录音文件。 |
GetRecordUrl | 获取语音双呼录音链接 | 调用GetRecordUrl接口获取语音双呼录音链接。 |
DescribeRecordData | 获取通话记录 | 调用DescribeRecordData接口获取通话信息。 |
数据统计
API | 标题 | API概述 |
---|---|---|
GetIndexCurrentValue | 获取当前数据统计指标 | 调用GetIndexCurrentValue接口获取当前数据统计指标(实时数据)。 |
GetAgentIndexRealTime | 获取热线坐席实时数据详情 | 调用GetAgentIndexRealTime接口获取坐席详情实时数据(实时数据)。 |
GetHotlineAgentDetailReport | 获取热线坐席维度(T+1)数据详情 | 调用GetHotlineAgentDetailReport接口获取热线坐席维度(T+1)数据详情。 |
GetHotlineGroupDetailReport | 获取热线技能组维度T+1数据详情 | 调用GetHotlineGroupDetailReport接口获取热线技能组维度(T+1)数据详情。 |
会话数据
API | 标题 | API概述 |
---|---|---|
QueryTouchList | 查询接触数据 | 调用QueryTouchList接口查询接触数据。 |
GetCustomerInfo | 获取会员信息 | 调用GetCustomerInfo接口根据工作台会员ID获取会员详情。 |
GetHotlineMessageLog | 获取热线消息记录 | 调用GetHotlineMessageLog接口获取热线消息记录。 |
GetHotlineCallAction | 查询话务动作结果数据 | 调用GetHotlineCallAction接口查询话务动作结果数据。 |
机器人外呼
API | 标题 | API概述 |
---|---|---|
RobotCall | 发起机器人外呼 | 调用RobotCall接口发起机器人外呼。 |
ListRobotCallDialog | 查询对话记录 | 调用ListRobotCallDialog接口查询对话记录。 |
ListAiccsRobot | 获取话术列表 | 调用ListAiccsRobot接口获取话术列表。 |
ListRobotParams | 查询机器人参数列表 | 调用ListRobotParams接口查询机器人参数列表。 |
GetCallSoundRecord | 获取通话录音文件 | 调用GetCallSoundRecord接口获取通话录音文件。 |
ListRobotNode | 获取机器人节点信息列表 | 调用ListRobotNode接口获取机器人节点信息列表。 |
机器人外呼任务
API | 标题 | API概述 |
---|---|---|
CreateTask | 创建任务 | 调用CreateTask接口创建任务。 |
AttachTask | 追加明细 | 调用AttachTask接口追加明细。 |
StartTask | 启动任务 | 调用StartTask接口启动任务。 |
StopTask | 暂停任务 | 调用StopTask接口暂停任务。 |
CancelTask | 取消任务 | 调用CancelTask接口取消任务。 |
ListTask | 获取任务列表 | 调用ListTask接口获取任务列表。 |
ListTaskDetail | 获取任务明细信息 | 调用ListTaskDetail接口获取任务明细信息。 |
ListDialog | 查询对话记录 | 调用ListDialog接口查询对话记录。 |
智能语音交互
API | 标题 | API概述 |
---|---|---|
SendCcoSmartCall | 发起智能外呼 | 调用SendCcoSmartCall接口发起智能语音交互通话。 |
SendCcoSmartCallOperate | 发起智能外呼 | 调用SendCcoSmartCallOperate接口在智能外呼通话中,发起指定动作,仅用于并行转人工,人工坐席可旁听人机对话等场景。 |
智能外呼任务
API | 标题 | API概述 |
---|---|---|
CreateAiOutboundTask | 创建智能外呼任务 | 调用CreateAiOutboundTask接口创建智能外呼任务。 |
CreateAiOutboundTaskBatch | 创建智能外呼任务的任务批次 | 调用CreateAiOutboundTaskBatch接口创建智能外呼任务的任务批次,使得任务下的数据可以按批次查询。 |
DeleteAiOutboundTask | 删除智能外呼任务 | 调用DeleteAiOutboundTask接口删除智能外呼任务。 |
GetAiOutboundTaskBizData | 查询本次呼叫关联的业务信息 | 调用GetAiOutboundTaskBizData接口查询本次呼叫关联的业务信息。 |
GetAiOutboundTaskExecDetail | 获取任务执行详情 | 调用GetAiOutboundTaskExecDetail接口获取任务执行详情。 |
GetAiOutboundTaskDetail | 获取外呼任务详情 | 调用GetAiOutboundTaskDetail接口获取外呼任务详情。 |
UpdateAiOutboundTask | 更新外呼任务 | 调用UpdateAiOutboundTask接口更新外呼任务。 |
InsertAiOutboundPhoneNums | 导入外呼被叫号码 | 调用InsertAiOutboundPhoneNums接口导入外呼被叫号码。 |
GetAiOutboundTaskProgress | 获取外呼任务进展 | 调用GetAiOutboundTaskProgress接口获取外呼任务进展。 |
StopAiOutboundTask | 暂停外呼任务 | 调用StopAiOutboundTask接口暂停外呼任务。 |
TerminateAiOutboundTask | 终止外呼任务 | 调用TerminateAiOutboundTask接口终止外呼任务。 |
GetAiOutboundTaskList | 获取外呼任务列表 | 调用GetAiOutboundTaskList接口获取外呼任务列表。 |
StartAiOutboundTask | 启动外呼任务 | 调用StartAiOutboundTask接口启动外呼任务。 |
号码管理
API | 标题 | API概述 |
---|---|---|
AddHotlineNumber | 新增热线号码 | 调用AddHotlineNumber接口新增热线号码。 |
DeleteHotlineNumber | 删除配置的热线号码 | 调用DeleteHotlineNumber接口删除配置的热线号码。 |
ResetHotlineNumber | 重置热线号码 | 调用ResetHotlineNumber接口重置热线号码的呼入(IVR流程)、呼出(生效范围)配置信息。 |
QueryHotlineNumber | 查询热线号码配置列表 | 调用QueryHotlineNumber接口查询热线号码配置列表。 |
GetConfigNumList | 获取热线设置号码列表 | 调用GetConfigNumList接口获取热线设置号码列表。 |
话务管理
API | 标题 | API概述 |
---|---|---|
AnswerCall | 接听来电 | 调用AnswerCall接听来电。 |
FinishHotlineService | 结束热线服务 | 调用FinishHotlineService结束热线服务。 |
GetNumLocation | 获取号码归属地 | |
GetRtcToken | 获取移动坐席Token | 调用GetRtcToken获取移动坐席Token。 |
HangupCall | 挂断电话 | 调用HangupCall执行坐席挂机操作。 |
ListHotlineRecord | 获取热线录音列表 | 调用ListHotlineRecord根据热线会话ID查询热线录音列表。 |
ListOutboundPhoneNumber | 获取外呼号码信息 | 调用ListOutboundPhoneNumber获取指定坐席下的主叫外呼电话号码。 |
MakeDoubleCall | 通过服务端SDK发起呼叫 | 调用MakeDoubleCall通过服务端SDK发起呼叫。 |
SendHotlineHeartBeat | 发送热线心跳 | 调用SendHotlineHeartBeat发送热线心跳请求。 |
StartCall | 坐席发起外呼 | 调用StartCall发起外呼。 |
StartHotlineService | 开始热线服务 | 调用StartHotlineService进行热线坐席签入,开始热线服务。 |
SuspendHotlineService | 暂停热线服务 | 调用SuspendHotlineService在热线坐席小休时,暂停热线服务。 |