文档

API概览

本产品(智能联络中心/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获取在线监控下技能组纬度队列信息获取在线监控下技能组纬度队列信息。支持实例、时间区间、部门、技能组分组查询。

热线报表数据

API标题API概述
GetSkillGroupStatusTotal获取热线报表下技能组状态总量获取热线报表下技能组状态总量。支持实例、时间区间、坐席、部门、技能组分组查询。
GetAgentDetailReport获取热线报表下热线坐席详情汇总数据获取热线报表下热线坐席详情汇总数据。支持实例、时间区间、坐席、部门分组查询。

在线报表数据

API标题API概述
GetSkillGroupServiceStatus获取在线报表下技能组服务状态量获取在线报表下技能组服务状态量。
GetAgentServiceStatus获取在线报表下坐席服务状态量获取在线报表下坐席服务状态量。支持实例、时间区间、坐席、部门分组查询。

坐席管理

API标题API概述
CreateAgent创建坐席创建悉犀客服工作台坐席账号,并返回坐席ID。
DeleteAgent删除坐席根据实例ID及坐席账号名称,删除悉犀客服工作台坐席账号。
UpdateAgent更新坐席数据根据实例ID、坐席账号名称修改悉犀客服工作台坐席信息。支持修改坐席对外显示名称、坐席所属技能组。
GetAgent获取坐席信息根据实例ID、坐席账号名称查询悉犀客服工作台坐席信息,如坐席ID等。
ListAgentBySkillGroupId获取技能组下坐席信息根据AICCS实例ID、技能组ID查询悉犀客服工作台坐席列表。
GetHotlineAgentStatus获取热线坐席状态根据AICCS实例ID、坐席账号名称查询悉犀客服工作台热线坐席状态。
RemoveAgentFromSkillGroup从技能组移除坐席账号通过指定技能组及坐席ID,从技能组移除坐席账号。
GetHotlineAgentDetail获取热线坐席详情调用GetHotlineAgentDetail接口根据坐席账号获取热线坐席当前服务详情。

技能组管理

API标题API概述
CreateSkillGroup创建技能组调用CreateSkillGroup接口根据技能组名称和渠道类型创建技能组。
UpdateSkillGroup修改技能组根据AICCS实例ID、技能组ID更新悉犀客服工作台技能组信息。支持更新技能组描述、技能组对外显示名称。
RemoveSkillGroup删除技能组根据AICCS实例ID、技能组ID删除悉犀客服工作台技能组。
QuerySkillGroups查询技能组调用QuerySkillGroups接口查询悉犀客服工作台技能组列表。
ListSkillGroup查询技能组调用ListSkillGroup接口根据技能组渠道类型查询悉犀客服工作台技能组。
GetDepGroupTreeData查询技能组分组和技能组列表根据AICCS实例ID、坐席ID查询技能组分组和技能组列表。

部门管理

API标题API概述
CreateDepartment创建部门信息根据AICCS实例ID、部门名称创建部门信息,创建成功后会返回部门ID。
GetAllDepartment获取所有部门信息根据AICCS实例ID获取所有部门信息,可获取部门ID、部门名称。
DeleteDepartment删除部门信息根据AICCS实例ID、部门ID删除部门信息。
UpdateDepartment更新部门信息根据AICCS实例ID、部门ID更新部门名称。

通道

API标题API概述
GenerateWebSocketSign生成MessageBox通道签名根据AICCS实例ID和坐席账号名称,生成消息通道访问签名。

通话详情

API标题API概述
HotlineSessionQuery批量查询通话详情调用HotlineSessionQuery接口查询通话详情。
GetRecordData获取录音文件调用GetRecordData接口获取录音文件。
GetRecordUrl获取语音双呼录音链接调用GetRecordUrl接口获取语音双呼录音链接。
DescribeRecordData获取通话记录调用DescribeRecordData接口获取通话信息。

数据统计

API标题API概述
GetIndexCurrentValue获取当前数据统计指标获取当前数据统计指标(实时数据),支持实例ID、部门、技能组分组查询。
GetAgentIndexRealTime获取热线坐席实时数据详情根据实例、部门、技能组分组获取坐席详情实时数据(实时数据)。
GetHotlineAgentDetailReport获取热线坐席维度(T+1)数据详情获取热线坐席维度(T+1)数据详情。支持实例、时间区间、部门、技能组分组查询。
GetHotlineGroupDetailReport获取热线技能组维度T+1数据详情获取热线技能组维度(T+1)数据详情。支持实例、时间区间、部门、技能组分组获取。

会话数据

API标题API概述
QueryTouchList查询接触数据根据实例、接触ID列表、会话ID列表等查询接触数据。
GetCustomerInfo获取会员信息调用GetCustomerInfo接口根据工作台会员ID获取会员详情。
GetHotlineMessageLog获取热线消息记录调用GetHotlineMessageLog接口获取热线消息记录。
GetHotlineCallAction查询话务动作结果数据调用GetHotlineCallAction接口查询话务动作结果数据。

机器人外呼

API标题API概述
RobotCall发起机器人外呼调用RobotCall接口发起机器人外呼。
ListRobotCallDialog查询对话记录调用ListRobotCallDialog接口查询对话记录。
ListAiccsRobot获取话术列表获取话术列表。包含机器人类型、机器人名称、机器人ID、所属业务、行业信息。
ListRobotParams查询机器人参数列表根据机器人ID,即话术ID,查询机器人参数列表。
GetCallSoundRecord获取通话录音文件调用GetCallSoundRecord接口获取通话录音文件。
ListRobotNode获取机器人节点信息列表根据机器人ID,即话术ID,获取机器人节点信息列表。

机器人外呼任务

API标题API概述
CreateTask创建任务根据任务名称、机器人ID、外呼主叫号码等创建任务。
AttachTask追加明细根据任务ID和呼叫字符,追加明细。
StartTask启动任务根据任务ID启动任务。
StopTask暂停任务根据任务ID暂停任务。
CancelTask取消任务根据任务ID取消任务。
ListTask获取任务列表获取任务列表。包含任务总数、任务信息。
ListTaskDetail获取任务明细信息根据任务ID获取任务明细信息。
ListDialog查询对话记录根据任务ID和被叫号码,查询对话记录。

智能语音交互

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在热线坐席小休时,暂停热线服务。
  • 本页导读 (1)