智能联络中心_API文档

智能联络中心 - OpenAPI 概览2019-10-15
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
通信智能引擎
OpenAPI 名称描述操作
HangupOperate通信智能引擎中主动挂断通话查看文档去调试
LlmSmartCallhot基于大模型的智能外呼查看文档去调试
热线监控数据
OpenAPI 名称描述操作
GetHotlineServiceStatisticshot获取热线监控下服务统计量。支持实例、时间纬度、坐席、部门、技能组分组查询查看文档去调试
GetSkillGroupAndAgentStatusSummary获取热线监控下技能组坐席汇总状态量。支持实例、时间区间、部门、技能组分组查询查看文档去调试
GetDepartmentalLatitudeAgentStatus获取热线监控下部门纬度状态量。支持实例、时间区间、部门分组查询查看文档去调试
GetSkillGroupLatitudeState获取热线下监控技能组纬度状态量。支持实例、时间区间、部门、技能组分组查询查看文档去调试
GetAgentBasisStatus获取热线监控下坐席纬度状态量。支持实例、时间区间、坐席、部门分组查询查看文档去调试
GetAgentStatistics获取热线监控下坐席纬度统计量。支持实例、时间区间、坐席、部门分组查询查看文档去调试
在线监控数据
OpenAPI 名称描述操作
GetOnlineServiceVolume获取在线监控下在线服务量。支持实例、时间区间、坐席、部门、技能组分组查询查看文档去调试
GetSeatInformation获取在线监控下部门坐席服务能力数据。支持实例、时间区间、部门分组查询查看文档去调试
GetSkillGroupServiceCapability获取在线监控下技能组纬度服务能力数据。支持实例、时间区间、部门、技能组分组查询查看文档去调试
GetSkillGroupAgentStatusDetails获取技能组服务状态量。支持实例、时间区间、部门、技能组分组查询查看文档去调试
GetOnlineSeatInformation获取在线监控下在线坐席信息数据。支持实例、时间区间、坐席、部门分组查询查看文档去调试
GetQueueInformation获取在线监控下技能组纬度队列信息。支持实例、时间区间、部门、技能组分组查询查看文档去调试
热线报表数据
OpenAPI 名称描述操作
GetSkillGroupStatusTotal获取热线报表下技能组状态总量。支持实例、时间区间、坐席、部门、技能组分组查询查看文档去调试
GetAgentDetailReport获取热线报表下热线坐席详情汇总数据。支持实例、时间区间、坐席、部门分组查询查看文档去调试
在线报表数据
OpenAPI 名称描述操作
GetSkillGroupServiceStatus获取在线报表下技能组服务状态量查看文档去调试
GetAgentServiceStatus获取在线报表下坐席服务状态量。支持实例、时间区间、坐席、部门分组查询查看文档去调试
坐席管理
OpenAPI 名称描述操作
CreateAgent创建悉犀客服工作台坐席账号,并返回坐席ID查看文档去调试
GetAgent根据实例ID、坐席账号名称查询悉犀客服工作台坐席信息,如坐席ID等查看文档去调试
ListAgentBySkillGroupId根据AICCS实例ID、技能组ID查询悉犀客服工作台坐席列表查看文档去调试
GetHotlineAgentStatus根据AICCS实例ID、坐席账号名称查询悉犀客服工作台热线坐席状态查看文档去调试
GetHotlineAgentDetail根据实例ID、坐席账号名称获取热线坐席当前服务详情查看文档去调试
UpdateAgent根据实例ID、坐席账号名称修改悉犀客服工作台坐席信息。支持修改坐席对外显示名称、坐席所属技能组查看文档去调试
DeleteAgent根据实例ID及坐席账号名称,删除悉犀客服工作台坐席账号查看文档去调试
RemoveAgentFromSkillGroup通过指定技能组及坐席ID,从技能组移除坐席账号查看文档去调试
技能组管理
OpenAPI 名称描述操作
CreateSkillGroup根据技能组名称和渠道类型创建技能组查看文档去调试
QuerySkillGroups根据实例ID查询悉犀客服工作台技能组列表查看文档去调试
ListSkillGroup根据实例ID、技能组渠道类型查询悉犀客服工作台技能组查看文档去调试
GetDepGroupTreeData根据AICCS实例ID、坐席ID查询技能组分组和技能组列表查看文档去调试
UpdateSkillGroup根据AICCS实例ID、技能组ID更新悉犀客服工作台技能组信息。支持更新技能组描述、技能组对外显示名称查看文档去调试
RemoveSkillGroup根据AICCS实例ID、技能组ID删除悉犀客服工作台技能组查看文档去调试
部门管理
OpenAPI 名称描述操作
CreateDepartment根据AICCS实例ID、部门名称创建部门信息,创建成功后会返回部门ID查看文档去调试
GetAllDepartment根据AICCS实例ID获取所有部门信息,可获取部门ID、部门名称查看文档去调试
UpdateDepartment根据AICCS实例ID、部门ID更新部门名称查看文档去调试
DeleteDepartment根据AICCS实例ID、部门ID删除部门信息查看文档去调试
通道
OpenAPI 名称描述操作
GenerateWebSocketSign根据AICCS实例ID和坐席账号名称,生成消息通道访问签名查看文档去调试
通话详情
OpenAPI 名称描述操作
GetRecordDatahot获取录音文件查看文档去调试
GetRecordUrl获取语音双呼录音链接查看文档去调试
DescribeRecordData获取通话信息查看文档去调试
HotlineSessionQueryhot根据实例ID查询通话详情查看文档去调试
数据统计
OpenAPI 名称描述操作
GetIndexCurrentValue获取当前数据统计指标(实时数据),支持实例ID、部门、技能组分组查询查看文档去调试
GetAgentIndexRealTime根据实例、部门、技能组分组获取坐席详情实时数据(实时数据)查看文档去调试
GetHotlineAgentDetailReport获取热线坐席维度(T+1)数据详情。支持实例、时间区间、部门、技能组分组查询查看文档去调试
GetHotlineGroupDetailReport获取热线技能组维度(T+1)数据详情。支持实例、时间区间、部门、技能组分组获取查看文档去调试
会话数据
OpenAPI 名称描述操作
QueryTouchList根据实例、接触ID列表、会话ID列表等查询接触数据查看文档去调试
GetCustomerInfo根据工作台会员ID获取会员详情查看文档去调试
GetHotlineMessageLog获取热线消息记录查看文档去调试
GetHotlineCallAction查询话务动作结果数据查看文档去调试
机器人外呼
OpenAPI 名称描述操作
ListRobotCallDialoghot查询对话记录。支持根据呼叫唯一ID和呼叫创建时间查询,对话记录包含对话内容角色、话术内容、节点类型、开始时间、意图标签查看文档去调试
ListAiccsRobot获取话术列表。包含机器人类型、机器人名称、机器人ID、所属业务、行业信息查看文档去调试
ListRobotParams根据机器人ID,即话术ID,查询机器人参数列表查看文档去调试
GetCallSoundRecordhot根据呼叫创建时间、呼叫唯一ID获取通话录音文件URL,根据URL获取通话录音文件查看文档去调试
ListRobotNode根据机器人ID,即话术ID,获取机器人节点信息列表查看文档去调试
RobotCallhot发起机器人外呼。支持根据配置好的机器人ID,即话术ID,通过外呼主叫号码呼叫被叫号码,可选择通话过程是否录音等功能查看文档去调试
机器人外呼任务
OpenAPI 名称描述操作
CreateTaskhot根据任务名称、机器人ID、外呼主叫号码等创建任务查看文档去调试
ListTask获取任务列表。包含任务总数、任务信息查看文档去调试
ListTaskDetail根据任务ID获取任务明细信息查看文档去调试
ListDialog根据任务ID和被叫号码,查询对话记录查看文档去调试
AttachTask根据任务ID和呼叫字符,追加明细查看文档去调试
StartTask根据任务ID启动任务查看文档去调试
StopTask根据任务ID暂停任务查看文档去调试
CancelTask根据任务ID取消任务查看文档去调试
智能语音交互
OpenAPI 名称描述操作
SendCcoSmartCallhot根据被叫显号、被叫号码、智能外呼放音文件发起智能语音交互通话查看文档去调试
SendCcoSmartCallOperate在智能外呼通话中,发起指定动作,仅用于并行转人工,人工坐席可旁听人机对话等场景查看文档去调试
智能外呼任务
OpenAPI 名称描述操作
CreateAiOutboundTaskhot创建智能外呼任务。支持创建时设置任务类型、任务名、外呼主叫号码、被叫号码重复策略等查看文档去调试
CreateAiOutboundTaskBatch根据实例ID、任务ID创建智能外呼任务的任务批次,使得任务下的数据可以按批次查询查看文档去调试
GetAiOutboundTaskBizData根据实例ID、会话ID查询本次呼叫关联的业务信息查看文档去调试
GetAiOutboundTaskExecDetail根据实例ID、任务ID获取任务执行详情查看文档去调试
GetAiOutboundTaskDetail根据实例ID、任务ID获取外呼任务详情查看文档去调试
GetAiOutboundTaskProgress根据实例ID、任务ID获取外呼任务进展查看文档去调试
GetAiOutboundTaskList根据实例ID、任务类型获取外呼任务列表查看文档去调试
UpdateAiOutboundTask根据实例ID、任务ID更新外呼任务查看文档去调试
StopAiOutboundTask根据实例ID、任务ID暂停外呼任务查看文档去调试
StartAiOutboundTask根据实例ID、任务ID启动外呼任务查看文档去调试
DeleteAiOutboundTask根据实例ID、任务ID删除智能外呼任务。删除后,获取外呼任务列表时无法获取到该任务查看文档去调试
InsertAiOutboundPhoneNums根据实例ID、任务ID导入外呼被叫号码查看文档去调试
TerminateAiOutboundTask根据实例ID、任务ID终止外呼任务查看文档去调试
号码管理
OpenAPI 名称描述操作
AddHotlineNumber新增热线号码查看文档去调试
QueryHotlineNumber根据实例ID查询热线号码配置列表,支持通过热线号码模糊查询查看文档去调试
GetConfigNumList获取热线设置号码列表查看文档去调试
DeleteHotlineNumber删除配置的热线号码查看文档去调试
ResetHotlineNumber重置热线号码的呼入(IVR流程)、呼出(生效范围)配置信息查看文档去调试
话务管理
OpenAPI 名称描述操作
AnswerCall接听来电查看文档去调试
FinishHotlineService根据实例ID、坐席账号名称结束热线服务查看文档去调试
GetNumLocation根据实例ID、电话号码获取该号码的归属地信息查看文档去调试
GetRtcToken获取移动坐席Token查看文档去调试
HangupCall执行坐席挂机操作查看文档去调试
ListHotlineRecord根据热线会话ID查询热线录音列表查看文档去调试
ListOutboundPhoneNumber根据实例ID、坐席账号名称获取指定坐席下的主叫外呼电话号码查看文档去调试
MakeDoubleCall通过服务端SDK发起呼叫查看文档去调试
SendHotlineHeartBeat根据实例ID、坐席账号名称、心跳签名发送热线心跳请求查看文档去调试
StartCall根据实例ID、坐席账号名称、热线外呼主叫号码、被叫号码发起外呼查看文档去调试
StartHotlineService根据实例ID、坐席账号名称进行热线坐席签入,开始热线服务查看文档去调试
SuspendHotlineService在热线坐席小休时,暂停热线服务查看文档去调试
其他
OpenAPI 名称描述操作
AddOuterAccount添加外部账号查看文档去调试
AiccsSmartCall发起智能语音交互通话查看文档去调试
AiccsSmartCallOperate在智能外呼通话中,发起指定动作,仅用于并行转人工,人工坐席可旁听人机对话等场景查看文档去调试
BatchCreateQualityProjects批量创建质检任务查看文档去调试
ChangeChatAgentStatus修改在线客服状态查看文档去调试
ChangeQualityProjectStatus更改质检任务状态查看文档去调试
CreateOutboundTask创建任务查看文档去调试
CreateQualityProject创建质检任务查看文档去调试
CreateQualityRule创建质量监控规则查看文档去调试
CreateThirdSsoAgent根据用户账号创建免登到客服工作台的坐席查看文档去调试
DeleteOutboundTask删除任务查看文档去调试
DeleteOuterAccount根据外部账号ID删除外部账号查看文档去调试
DeleteQualityProject删除质检项目查看文档去调试
DeleteQualityRule删除规则查看文档去调试
EditQualityProject编辑质检项目查看文档去调试
EditQualityRule编辑质检规则查看文档去调试
EditQualityRuleTag编辑质检规则标签查看文档去调试
EncryptPhoneNum将用户手机号码进行加密查看文档去调试
FetchCall取回\恢复通话查看文档去调试
GetAgentById根据ID获取坐席查看文档去调试
GetHotlineRuntimeInfo查询热线运行信息查看文档去调试
GetHotlineWaitingNumber获取热线会员排队数查看文档去调试
GetInstanceList获取实例列表查看文档去调试
GetMcuLvsIp查询热线服务器IP查看文档去调试
GetOutbounNumList获取外部热线号码列表查看文档去调试
GetQualityProjectDetail获取质检任务详情查看文档去调试
GetQualityProjectList获取质检任务列表查看文档去调试
GetQualityProjectLog获取质检任务日志查看文档去调试
GetQualityResult获取质检任务报告查看文档去调试
GetQualityRuleDetail获取质检规则详情查看文档去调试
GetQualityRuleList获取质检规则列表查看文档去调试
GetQualityRuleTagList获取质检规则标签列表查看文档去调试
HangUpDoubleCall取消双呼查看文档去调试
HangupThirdCall挂断第三方通话查看文档去调试
HoldCall保持通话查看文档去调试
InsertTaskDetail往已有外呼任务中创建detail查看文档去调试
JoinThirdCall将第三方加入到通话中查看文档去调试
ListChatRecordDetail根据时间段查询在线会话详情查看文档去调试
ListHotlineRecordDetail根据时间段查询热线详情列表查看文档去调试
ListRoles获取一个租户下的所有角色列表查看文档去调试
MakeCall发起呼叫查看文档去调试
QueryHotlineInQueue根据技能组ID获取热线技能组坐席数据查看文档去调试
QueryOutboundTask查询任务查看文档去调试
QueryTaskDetail查询任务明细查看文档去调试
QueryTickets查询工单信息查看文档去调试
RestartOutboundTask重启任务查看文档去调试
StartCallV2发起外呼V2查看文档去调试
StartChatWork设置在线坐席为上班状态查看文档去调试
StartMicroOutbound发起外呼请求查看文档去调试
SuspendOutboundTask暂停任务查看文档去调试
UpdateOuterAccount根据外部账号ID更新外部账号查看文档去调试
TransferCallToSkillGroup执行单/双步转交到技能组查看文档去调试
AddSkillGroup创建外部技能组查看文档去调试
DeleteSkillGroup根据技能组id、技能组渠道类型,删除外部技能组查看文档去调试
2024年08月20日