API overview-Artificial Intelligence Cloud Call Service(AICCS)-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (aiccs/2019-10-15) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Communication agent

API	Title	Description
QueryAiVoiceAgentDetailNew	Query communication agent details (new mode)	Queries the details of a specified agent, including basic information, branch information, and version information.
PageQueryAgentListNew	Query agents by paging (new pattern)	Queries agents by paging (managed pattern V2).
QueryAiVoiceAgentDetail	Query communication agent details	Queries the details of a communication agent.
PageQueryAgentList	Query communication agent list	Queries the list of communication agents.

Communication intelligence engine

API	Title	Description
AddInboundNumber	AddInboundNumber	Adds one or more inbound numbers.
TestLargeModel	Test gateway large language model	Tests a gateway large language model.
UpdateLargeModel	UpdateLargeModel	Updates a large language model.
AddLargeModel	AddLargeModel	Adds a large language model.
AddModelApplication	Create an LLM application	Creates a large language model application.
UpdateModelApplication	Update large language model application configuration	Modifies a model application.
LlmSmartCall	LLM-based Intelligent Calling	Intelligent outbound call based on an LLM.
LlmSmartCallEncrypt	LLM-based Intelligent Outbound Calling with Encrypted Numbers	Initiates a smart call to an encrypted number using a large language model.
HangupOperate	Intelligent Engine Proactively Hangs Up a Call in Communication	Hangs up a call in Communication Intelligence Engine.
ListAvailableTts	Obtain the List of TTS Voices Supported by the LLM Calling Feature	Lists the system and custom TTS voices available for large model-based outbound calls.
GetCallDialogContent	Query conversation content of calls that ended within the past month by CallId	Retrieves the dialog content for a call by using its call ID. You can retrieve content for calls completed within the last 30 days.

Large model communication call tasks

API	Title	Description
ImportOneTaskPhoneNumber	Import a single phone number record	Imports a single phone number record.
QueryConversationDetailInfo	Query call details	Queries the details of a call.
QueryAiCallDetailPage	Voice call task details	Queries the details of voice call tasks by page.
StopAiCallTask	Stop the Intelligent Agent outbound calling job	Stops an outbound call task.
CancelAiCallDetails	Cancel Calls for Communication Agent Call Jobs	This operation cancels calls from a call task. You cannot cancel a call if its detail record is already in the pending call queue or is in progress.
StartAiCallTask	Start an outbound call job for the communication agent	Starts a call task.
UpdateAiCallTask	Update a call task	Updates the configuration of a voice call task.
QueryAiCallTaskPage	Query voice call task list	Queries the list of voice call tasks.
QueryAiCallTaskDetail	Query basic information of a voice call task	Queries the basic information of a voice call task.
ImportTaskNumberDatas	Import callee data	Imports callee data for a voice call task.
CreateAiCallTask	Create a voice call task	Creates a voice call task.
QueryConversationDetailInfoNew	Call task details and call conversation details	Queries the details of a call task and call conversation information.

Intelligent call analysis

API	Title	Description
GetAudioNoteUploadUrl	Retrieve voice memo OSS upload information	Retrieves the upload address for a voice memo recording.
SubmitAudioNote	Submit offline voice notes	Submits a recording notes task.

Hotline monitoring data

API	Title	Description
GetHotlineServiceStatistics	Obtain service statistics under hotline monitoring	Obtain service statistics under hotline monitoring. Supports grouped queries by instance, time dimension, agent, department, and skill group.
GetSkillGroupAndAgentStatusSummary	Obtain the aggregated agent status metrics under hotline monitoring for skill groups	Obtain the aggregated agent status metrics for skill groups under hotline monitoring. Supports grouped queries by instance, time range, department, and skill group.
GetDepartmentalLatitudeAgentStatus	Obtain department-level status metrics under hotline monitoring	Obtain department-level status metrics under hotline monitoring. Supports queries by instance, time range, and department group.
GetSkillGroupLatitudeState	Obtain Hotline Monitoring Status Metrics by Skill Group Dimension	Obtain the hotline monitoring status metrics by skill group dimension. Supports queries grouped by instance, time range, department, and skill group.
GetAgentBasisStatus	Obtain Agent-Level Status Metrics for Hotline Monitoring	Obtain the agent-level status metrics under hotline monitoring. Supports queries by instance, time range, agent, and department group.
GetAgentStatistics	Obtain agent-level statistics under hotline monitoring	Obtain agent-level statistics under hotline monitoring. Supports querying by instance, time range, agent, and department group.

Online monitoring data

API	Title	Description
GetOnlineServiceVolume	Obtain the Number of Online Services Under Online Monitoring	Obtain the volume of Online Services under online monitoring. Support grouped queries by instance, time range, agent, department, and skill group.
GetSeatInformation	Obtain department-based agent service capability data from real-time monitoring	Obtain agent service capacity data under online monitoring. Supports queries by instance, time range, and department group.
GetSkillGroupServiceCapability	Obtain service capability data by skill group dimension under online monitoring	Retrieve skill group–level service capacity data under online monitoring. Supports queries grouped by instance, time range, department, and skill group.
GetSkillGroupAgentStatusDetails	Obtain Skill Group Service Status Metrics	Obtain the service status metrics of skill groups. Support grouped queries by instance, time range, department, and skill group.
GetOnlineSeatInformation	Retrieve Online Agent Information from Real-Time Monitoring	Obtain online agent information data under real-time monitoring. Support queries by instance, time range, agent, and department group.
GetQueueInformation	Obtain queue information by skill group dimension under online monitoring	Obtain queue information under the skill group dimension in online monitoring. Supports queries grouped by instance, time range, department, and skill group.

Hotline report data

API	Title	Description
GetSkillGroupStatusTotal	Obtain the total status quantity of skill groups under the hotline report	Obtain the total status count of skill groups under hotline reports. Supports grouped queries by instance, time range, agent, department, and skill group.
GetAgentDetailReport	Retrieve summary data of hotline agent details under a hotline report	Retrieve the summary data of hotline agent details under hotline reports. Supports queries by instance, time range, agent, and department group.

Online report data

API	Title	Description
GetSkillGroupServiceStatus	Obtain the service status metrics of skill groups under an online report	Obtain the service status metrics of skill groups in online reports.
GetAgentServiceStatus	Retrieve Agent Service Status Metrics from Online Reports	Obtain the agent service status metrics from online reports. Supports queries by instance, time range, agent, and department group.

Agent management

API	Title	Description
CreateAgent	Create Agent	Create an agent account in the Cloud Customer Service System and return the agent ID.
DeleteAgent	Delete Agent	Deletes an agent account in the Cloud Customer Service System based on the instance ID and agent account name.
UpdateAgent	Update Agent Data	Modify agent information in the Cloud Customer Service System based on the instance ID and agent account name. You can modify the agent's display name and the skill groups to which the agent belongs.
GetAgent	Obtain agent information	Query agent information in the Cloud Customer Service System by instance ID and agent account name, such as agent ID.
ListAgentBySkillGroupId	Obtain Agent Information under a Skill Group	Query the agent list in the Cloud Customer Service System by AICCS instance ID and skill group ID.
GetHotlineAgentStatus	Obtain Hotline Agent Status	Queries the hotline agent status in the Cloud Customer Service System by AICCS instance ID and agent account name.
RemoveAgentFromSkillGroup	Remove Agent Accounts from a Skill Group	Remove agent accounts from a skill group by specifying the skill group and agent IDs.
GetHotlineAgentDetail	Obtain Hotline Agent Details	Obtain the current service details of a hotline agent based on the instance ID and agent account name.

Skill group management

API	Title	Description
CreateSkillGroup	Create a Skill Group	Create a skill group based on the skill group name and channel type.
UpdateSkillGroup	Modify a Skill Group	Update the skill group information in the Cloud Customer Service System based on the AICCS instance ID and skill group ID. This API supports updating the skill group description and display name.
RemoveSkillGroup	Delete Skill Group	Deletes a skill group in the Cloud Customer Service System based on the AICCS instance ID and skill group ID.
QuerySkillGroups	Query skill groups	Queries the skill group list of the Cloud Customer Service System by instance ID.
ListSkillGroup	Query Skill Groups	Query skill groups in the Cloud Customer Service System by instance ID and skill group channel type.
GetDepGroupTreeData	Query the list of skill groups and their groupings	Queries skill group categories and the skill group list by AICCS instance ID and agent ID.

Department management

API	Title	Description
CreateDepartment	Create Department Information	Creates department information based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and department name. Upon successful creation, the department ID is returned.
GetAllDepartment	Obtain all department information	getAllDepartment
DeleteDepartment	Delete Department Information	Deletes department information based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and department ID.
UpdateDepartment	Update Department Information	Update the department name based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and department ID.

Channels

API	Title	Description
GenerateWebSocketSign	Generate MessageBox Channel Signature	Generate a message channel access signature based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and agent account name.

Call details

API	Title	Description
HotlineSessionQuery	Batch query call details	Queries call details by instance ID.
GetRecordData	Obtain a Recording File	Invoke the GetRecordData API to obtain a recording file.
GetRecordUrl	Obtain the incoming and outgoing calls recording link	Invoke the GetRecordUrl API to obtain the incoming and outgoing calls recording link.
DescribeRecordData	Retrieve Call Records	Invoke the DescribeRecordData API to retrieve call information.

Data statistics

API	Title	Description
GetIndexCurrentValue	Retrieve current data statistics metrics	Retrieves current data statistics metrics (real-time data), supporting queries grouped by instance ID, department, or skill group.
GetAgentIndexRealTime	Obtain real-time data details of hotline agents	Obtain real-time agent detail data grouped by instance, department, and skill group (real-time data).
GetHotlineAgentDetailReport	Obtain Hotline Agent Dimension (T+1) Data Details	Obtain detailed data metrics by hotline agent dimension (T+1). Supports grouping queries by instance, time range, department, and skill group.
GetHotlineGroupDetailReport	Obtain T+1 Data Details by Hotline Skill Group Dimension	Retrieve detailed (T+1) data by hotline skill group dimension. Supports grouping by instance, time range, department, and skill group.

Session data

API	Title	Description
QueryTouchList	Query contact data	Queries contact data based on instance, contact ID list, session ID list, and other conditions.
GetCustomerInfo	Retrieve membership information	You can invoke the GetCustomerInfo API to obtain membership details by Workbench membership ID.
GetHotlineMessageLog	Retrieve Hotline Message Records	Invoke the GetHotlineMessageLog API to retrieve hotline message records.
GetHotlineCallAction	Query Call Action Result Data	Invoke the GetHotlineCallAction API to query the result data of call actions.

Bot outbound calls

API	Title	Description
RobotCall	Initiate an intelligent contact robot outbound call	Initiates an outbound call from an intelligent contact robot.
ListRobotCallDialog	Query call records	Queries the call records of an intelligent contact robot.
ListAiccsRobot	Retrieve script list	Retrieves the list of robot scripts, including the robot type, robot name, robot ID, associated business, and industry information.
ListRobotParams	Query Robot Parameter List	Queries the list of robot parameters by robot ID, which is also the script ID.
GetCallSoundRecord	Obtain Call Recording File	Obtain the URL of a call recording file based on the call creation time and the unique call ID, and then retrieve the call recording file using the URL.
ListRobotNode	Retrieve the list of robot node information	Retrieves the list of robot node information based on the robot ID, which is the script ID.

Bot outbound call tasks

API	Title	Description
CreateTask	Create Job	Create an Artificial Intelligence Cloud Call Service robot outbound calling job.
AttachTask	Append Details	Append job details.
StartTask	Start Job	Start a successfully created Intelligent Contact Robot calling job.
StopTask	Pause Job	Pause an Intelligent Contact Robot calling job that has been successfully started.
CancelTask	Cancel Job	Cancel an Intelligent Contact Robot calling job.
ListTask	List Jobs	Perform a paged query to retrieve the list of Intelligent Contact Robot call jobs. The response includes the total number of jobs and job details.
ListTaskDetail	Retrieve call task details	Retrieves the details of a call task for an intelligent contact robot.
ListDialog	Query conversation records	Query Intelligent Contact Bot conversation records.

Intelligent outbound call tasks

API	Title	Description
CreateAiOutboundTask	Create an intelligent outbound call task	Creates an intelligent outbound call task. You can set the task type, task name, outbound caller numbers, callee number deduplication policy, and more when creating the task.
CreateAiOutboundTaskBatch	Create a batch for an Intelligent Outbound Calling job	Creates a batch for an Intelligent Outbound Calling job based on the instance ID and job ID, enabling data under the job to be queried by batch.
DeleteAiOutboundTask	Delete an Intelligent Outbound Calling Job	Deletes an Intelligent Outbound Calling job by instance ID and job ID. After deletion, the job will no longer appear in the outbound calling job list.
GetAiOutboundTaskBizData	Query the business information associated with this call	Query the business information associated with this call by instance ID and session ID.
GetAiOutboundTaskExecDetail	Get Job Execution Details	Obtain task execution details by instance ID and job ID.
GetAiOutboundTaskDetail	Retrieve outbound call task details	Retrieves the details of an outbound call task based on the instance ID and task ID.
UpdateAiOutboundTask	Update an outbound call task	Updates an outbound call task based on the instance ID and task ID.
InsertAiOutboundPhoneNums	Import callee numbers for outbound calls	Import outbound call callee numbers based on the instance ID and job ID.
GetAiOutboundTaskProgress	Get outbound job progress	Obtain the outbound call job progress by instance ID and job ID.
StopAiOutboundTask	Pause an outbound calling job	Pause an outbound calling job by instance ID and job ID.
TerminateAiOutboundTask	Terminate Outbound Call Job	Terminate an outbound call job by instance ID and job ID.
GetAiOutboundTaskList	Obtain the Outbound Call Job List	Retrieve the outbound call job list by instance ID and Task Type.
StartAiOutboundTask	Start an outbound calling job	Start an outbound calling job by instance ID and job ID.

Number management

API	Title	Description
AddHotlineNumber	Add Hotline Number	Invoke the AddHotlineNumber API to add a hotline number.
DeleteHotlineNumber	Delete a configured hotline number	Invoke the DeleteHotlineNumber API to delete a configured hotline number.
ResetHotlineNumber	Reset Hotline Number	Invoke the ResetHotlineNumber API to reset the inbound (IVR flow) and outbound (effective scope) configuration information of a hotline number.
QueryHotlineNumber	Query Hotline Number Configuration List	Query the hotline number configuration list by instance ID. Fuzzy query by hotline number is supported.
GetConfigNumList	Obtain the hotline settings number list	Invoke the GetConfigNumList API to obtain the hotline settings number list.

Call traffic management

API	Title	Description
AnswerCall	Answer Incoming Call	Invoke AnswerCall to answer an incoming call.
FinishHotlineService	End hotline service	Ends a hotline service based on the instance ID and agent account name.
GetNumLocation	Obtain Number归属地	Obtain the number's归属地 information based on the instance ID and phone number.
GetRtcToken	Obtain Token for Mobile Agent	Invoke GetRtcToken to obtain the token for a shift agent.
HangupCall	Hang Up Call	Invoke HangupCall to execute the agent hang-up operation.
ListHotlineRecord	Obtain Hotline Recording List	Invoke ListHotlineRecord to query the hotline recording list by hotline session ID.
ListOutboundPhoneNumber	Obtain Outbound Number Information	Obtain the outbound caller phone numbers for a specified agent based on the instance ID and agent account name.
MakeDoubleCall	Initiate a call by using the server-side SDK	You can invoke MakeDoubleCall to initiate a call by using the server-side software development kit (SDK).
SendHotlineHeartBeat	Send Hotline Heartbeat	Send a hotline heartbeat request based on the instance ID, agent account name, and heartbeat signature.
StartCall	Agent-initiated outbound call	Initiate an outbound call based on the instance ID, agent account name, hotline outbound caller number, and callee number.
StartHotlineService	Start hotline service	Signs in a hotline agent based on the instance ID and agent account name to start the hotline service.
SuspendHotlineService	Pause Hotline Service	Pause hotline service when an agent takes a short break.