API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(aiccs/2019-10-15)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

通信智能体

API

标题

API概述

QueryAiVoiceAgentDetailNew 查询通信智能体详情(新模式) 查询指定智能体的详细信息,包括基础信息、分支信息、版本信息等。
PageQueryAgentListNew 分页查询智能体列表(新模式) 分页查询智能体列表(代运营模式V2)
QueryAiVoiceAgentDetail 查询通信智能体详情信息 查询通信智能体详情信息。
PageQueryAgentList 查询通信智能体列表 分页查询智能体列表。

通信智能引擎

API

标题

API概述

AddInboundNumber 添加呼入号码 添加呼入号码
UpdateLargeModel 更新大模型网关配置 更新大模型网关配置。
AddLargeModel 添加大模型网关 AddLargeModel
AddModelApplication 创建大模型应用 新增模型应用。
UpdateModelApplication 更新大模型应用配置 修改模型应用
LlmSmartCall 大模型智能呼叫 基于大模型的智能外呼。
LlmSmartCallEncrypt 大模型加密号智能外呼 基于大模型加密号码智能呼叫。
HangupOperate 通信智能引擎主动挂断通话 通信智能引擎中主动挂断通话。
ListAvailableTts 获取大模型呼叫支持的TTS音色列表 获取大模型外呼支持的TTS音色列表,包括系统预置音色和个性化音色。
GetCallDialogContent 通过CallId查询近一个月通话已结束的通话对话内容 通过CallId查询对话内容,只支持查询近一个月通话已结束的通话对话内容。

大模型通信呼叫任务

API

标题

API概述

ImportOneTaskPhoneNumber 导入单个号码数据 导入单个号码数据。
QueryConversationDetailInfo 呼叫通话详情 查询呼叫通话详情信息。
QueryAiCallDetailPage 呼叫任务明细 分页查询呼叫任务明细。
StopAiCallTask 停止呼叫任务 停止呼出任务。
CancelAiCallDetails 取消呼叫任务 呼叫任务取消呼叫,如明细记录已经进入待呼队列或者正在呼叫,则无法取消。
StartAiCallTask 启动呼叫任务 启动呼叫任务。
UpdateAiCallTask 更新呼叫任务 更新呼叫任务配置。
QueryAiCallTaskPage 查询呼叫任务列表 查询呼叫任务列表。
QueryAiCallTaskDetail 查询呼叫任务基础信息 查询呼叫任务基础信息。
ImportTaskNumberDatas 导入被叫数据 呼叫任务导入被叫数据。
CreateAiCallTask 创建呼叫任务 创建呼叫任务。

通话智能分析

API

标题

API概述

GetAudioNoteUploadUrl 获取语音小记OSS上传信息 获取录音小记上传地址
SubmitAudioNote 提交离线语音小记 提交录音小记任务。

热线监控数据

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 获取热线坐席详情 根据实例ID、坐席账号名称获取热线坐席当前服务详情。

技能组管理

API

标题

API概述

CreateSkillGroup 创建技能组 根据技能组名称和渠道类型创建技能组。
UpdateSkillGroup 修改技能组 根据AICCS实例ID、技能组ID更新悉犀客服工作台技能组信息。支持更新技能组描述、技能组对外显示名称。
RemoveSkillGroup 删除技能组 根据AICCS实例ID、技能组ID删除悉犀客服工作台技能组。
QuerySkillGroups 查询技能组 根据实例ID查询悉犀客服工作台技能组列表。
ListSkillGroup 查询技能组 根据实例ID、技能组渠道类型查询悉犀客服工作台技能组。
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 批量查询通话详情 根据实例ID查询通话详情。
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 智能联络机器人呼出 发起智能联络机器人呼出。
ListRobotCallDialog 查询通话记录 查询智能联络机器人通话记录。
ListAiccsRobot 获取话术列表 获取机器人话术列表。包含机器人类型、机器人名称、机器人ID、所属业务、行业信息。
ListRobotParams 查询机器人参数列表 根据机器人ID,即话术ID,查询机器人参数列表。
GetCallSoundRecord 获取通话录音文件 根据呼叫创建时间、呼叫唯一ID获取通话录音文件URL,根据URL获取通话录音文件。
ListRobotNode 获取机器人节点信息列表 根据机器人ID,即话术ID,获取机器人节点信息列表。

机器人外呼任务

API

标题

API概述

CreateTask 创建任务 创建智能联络机器人呼叫任务。
AttachTask 追加明细 追加任务明细。
StartTask 启动任务 启动已创建成功的智能联络机器人呼叫任务。
StopTask 暂停任务 暂停已成功启动的智能联络机器人呼叫任务。
CancelTask 取消任务 取消智能联络机器人呼叫任务。
ListTask 获取任务列表 分页查询智能联络机器人呼叫任务列表。包含任务总数、任务信息。
ListTaskDetail 获取任务明细信息 获取智能联络机器人呼叫任务明细信息。
ListDialog 查询对话记录 查询智能联络机器人对话记录。

智能外呼任务

API

标题

API概述

CreateAiOutboundTask 创建智能外呼任务 创建智能外呼任务。支持创建时设置任务类型、任务名、外呼主叫号码、被叫号码重复策略等。
CreateAiOutboundTaskBatch 创建智能外呼任务的任务批次 根据实例ID、任务ID创建智能外呼任务的任务批次,使得任务下的数据可以按批次查询。
DeleteAiOutboundTask 删除智能外呼任务 根据实例ID、任务ID删除智能外呼任务。删除后,获取外呼任务列表时无法获取到该任务。
GetAiOutboundTaskBizData 查询本次呼叫关联的业务信息 根据实例ID、会话ID查询本次呼叫关联的业务信息。
GetAiOutboundTaskExecDetail 获取任务执行详情 根据实例ID、任务ID获取任务执行详情。
GetAiOutboundTaskDetail 获取外呼任务详情 根据实例ID、任务ID获取外呼任务详情。
UpdateAiOutboundTask 更新外呼任务 根据实例ID、任务ID更新外呼任务。
InsertAiOutboundPhoneNums 导入外呼被叫号码 根据实例ID、任务ID导入外呼被叫号码。
GetAiOutboundTaskProgress 获取外呼任务进展 根据实例ID、任务ID获取外呼任务进展。
StopAiOutboundTask 暂停外呼任务 根据实例ID、任务ID暂停外呼任务。
TerminateAiOutboundTask 终止外呼任务 根据实例ID、任务ID终止外呼任务。
GetAiOutboundTaskList 获取外呼任务列表 根据实例ID、任务类型获取外呼任务列表。
StartAiOutboundTask 启动外呼任务 根据实例ID、任务ID启动外呼任务。

号码管理

API

标题

API概述

AddHotlineNumber 新增热线号码 调用AddHotlineNumber接口新增热线号码。
DeleteHotlineNumber 删除配置的热线号码 调用DeleteHotlineNumber接口删除配置的热线号码。
ResetHotlineNumber 重置热线号码 调用ResetHotlineNumber接口重置热线号码的呼入(IVR流程)、呼出(生效范围)配置信息。
QueryHotlineNumber 查询热线号码配置列表 根据实例ID查询热线号码配置列表,支持通过热线号码模糊查询。
GetConfigNumList 获取热线设置号码列表 调用GetConfigNumList接口获取热线设置号码列表。

话务管理

API

标题

API概述

AnswerCall 接听来电 调用AnswerCall接听来电。
FinishHotlineService 结束热线服务 根据实例ID、坐席账号名称结束热线服务。
GetNumLocation 获取号码归属地 根据实例ID、电话号码获取该号码的归属地信息。
GetRtcToken 获取移动坐席Token 调用GetRtcToken获取移动坐席Token。
HangupCall 挂断电话 调用HangupCall执行坐席挂机操作。
ListHotlineRecord 获取热线录音列表 调用ListHotlineRecord根据热线会话ID查询热线录音列表。
ListOutboundPhoneNumber 获取外呼号码信息 根据实例ID、坐席账号名称获取指定坐席下的主叫外呼电话号码。
MakeDoubleCall 通过服务端SDK发起呼叫 调用MakeDoubleCall通过服务端SDK发起呼叫。
SendHotlineHeartBeat 发送热线心跳 根据实例ID、坐席账号名称、心跳签名发送热线心跳请求。
StartCall 坐席发起外呼 根据实例ID、坐席账号名称、热线外呼主叫号码、被叫号码发起外呼。
StartHotlineService 开始热线服务 根据实例ID、坐席账号名称进行热线坐席签入,开始热线服务。
SuspendHotlineService 暂停热线服务 在热线坐席小休时,暂停热线服务。