API overview-阿里云帮助中心

API standards and multilingual preset SDKs

The OpenAPI of this product (Qualitycheck/2019-01-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.

Data upload

API	Title	Description
UploadAudioData	Upload audio quality inspection	Uploads offline voice quality inspection data (recording session files). This operation is applicable to hotline agent scenarios. Scenario 1: Natively integrates with Alibaba Cloud Call Center (CCC), requiring no development. You can enable one-click push of call data to SCA. Scenario 2: Integrates with your own call center system. Each time the call center generates a recording, it pushes the recording to SCA for analysis.
UploadDataV4	Upload text quality inspection data V4	Uploads offline text quality inspection data (plain text conversations) applicable to online agent scenarios. We recommend using the UploadDataV4 operation. Differences between UploadDataV4 and UploadData: 1. V4 supports only POST requests. 2. V4 supports longer JsonStr values.
UploadData	UploadData	Upload offline plain text quality inspection data (plain text sessions). This applies to online agent scenarios. Use the UploadDataV4 API. Differences between UploadDataV4 and UploadData include the following: UploadDataV4 supports only POST requests, and it supports longer JsonStr values.
UpdateQualityCheckData	Update ad-hoc recording data	Update session recording data (third-party business fields) to facilitate statistics and queries across more business dimensions.

Quality inspection rules and plans

API	Title	Description
Quality inspection rule management	Quality inspection rule management
AddRuleV4	Create Rule (New Quality Inspection)	This operation creates a rule on the Quality Inspection Rule Configuration page. For Apsara Stack, the URL is ip:port/api/client/UpdateRuleById.json.
UpdateRuleV4	Update Rule (New Quality Inspection)	Corresponding frontend feature location: Rule Configuration - Update. Apsara Stack URL: ip:port/api/client/UpdateRuleById.json.
ListRulesV4	Obtain Rule List (New Quality Inspection Version)	Frontend location: Quality inspection rule configuration — List. Apsara Stack URL: ip:port/api/rule/GetRulesCountList.json.
GetRuleV4	Obtain Rule Details (New Quality Inspection)	This API is located in the frontend at Quality Check Rule Configuration > Query. The Apsara Stack URL is ip:port/api/client/GetRuleById.json.
DeleteRuleV4	Delete Rule (New Quality Inspection)	Frontend feature location: Quality Inspection Rule Configuration — Delete. Apsara Stack URL: ip:port/api/client/DeleteRule.json.
TestRuleV4	Test Rules (New Quality Inspection)	Frontend location: Quality Check Rule Configuration > Test. Apsara Stack URL: http://:/api/client/TestRule.json.
Quality inspection plan management	Quality inspection plan management
DeleteCheckTypeToScheme	Delete a quality inspection scheme dimension	Deletes a dimension from a quality inspection scheme.
CreateQualityCheckScheme	Create Quality Inspection Plan	You can access this operation from the Quality Check Plan Management page in the console. The Apsara Stack endpoint is ip:port/api/qcs/CreateQualityCheckScheme.json.
UpdateQualityCheckScheme	Update Quality Inspection Plan	Updates a quality check scheme.
GetQualityCheckScheme	Obtain Quality Inspection Plan Details	This operation implements the query feature in quality check plan management on the frontend. The Apsara Stack URL is ip:port/api/qcs/GetQualityCheckScheme.json.
ListQualityCheckScheme	Obtain the quality inspection plan list	Retrieves a list of quality check schemes.
DeleteQualityCheckScheme	Delete Quality Check Scheme	You can delete a quality check plan from the Quality Check Plan Management page by clicking the Delete button on the right side of the plan. The Apsara Stack API endpoint is ip:port/api/qcs/DeleteQualityCheckScheme.json.
UpdateRuleToScheme	Update rules in a quality inspection plan	Frontend location: Quality Check Plan Management > Create or edit a quality check task > Associate quality check rules. Apsara Stack URL: ip:port/api/qcs/UpdateRuleToScheme.json.
CreateCheckTypeToScheme	Add Quality Inspection Dimension	UI path: Quality Check Plan Management > Add or Edit Quality Check Dimension > Add Quality Check Dimension. Apsara Stack API endpoint: ip:port/api/qcs/CreateCheckTypeToScheme.json.
UpdateCheckTypeToScheme	Update Quality Inspection Dimension	You can access this operation from the frontend by navigating to Plan Management > Create Quality Inspection Task or Edit > Edit icon next to the quality inspection dimension name. The Apsara Stack endpoint is ip:port/api/qcs/UpdateCheckTypeToScheme.json.
Quality inspection rule categories	Quality inspection rule categories
AddRuleCategory	Add a rule category	Add a rule category.
GetRuleCategory	Obtain the rule type list	Retrieves a list of rule types.
DelRuleCategory	Delete rule category	Deletes a rule category.
Quality inspection rule applicable business	Quality inspection rule applicable business
AddBusinessCategory	Add a business category	Adds a business category.
DeleteBusinessCategory	Delete the applicable business	Deletes a business category.
GetBusinessCategoryList	Obtain the list of applicable businesses	Obtain the list of applicable businesses.

Call center quality inspection task management

API	Title	Description
GetSchemeTaskConfig	Obtain Quality Inspection Job	Obtain the configuration details of a quality inspection task.
CreateSchemeTaskConfig	Create Quality Inspection Job	Corresponding frontend feature location: Plan Management > Create Quality Inspection Job. Apsara Stack URL: ip:port/api/task/CreateSchemeTaskConfig.json.
UpdateSchemeTaskConfig	Update Quality Inspection Job	Frontend path: Task Management > Edit any data on the right. Apsara Stack URL: ip:port/api/task/UpdateSchemeTaskConfig.json.
ListSchemeTaskConfig	Batch Retrieve Quality Inspection Jobs	This operation is used for the Task Management feature on the frontend. The Apsara Stack URL is ip:port/api/task/ListSchemeTaskInfo.json.

Conversation analysis agent

API	Title	Description
AI analysis assistant	AI analysis assistant
ListAgentMJobInfo	List AI analysis assistant tasks	Lists AI analysis assistant tasks.
GetAgentMJobInfo	Query single agentM task details	Queries the details of a single AgentM task.
Agent management	Agent management
CreateAgent	Create an agent	Creates an agent.
GetAgent	Get agent details	Retrieves the details of an agent.
UpdateAgent	Modify an agent	Modifies an agent.
DeleteAgent	Delete an agent	Deletes an agent.
Analysis tasks	Analysis tasks
CreateAgentTask	Create an agent task	Creates an Agent batch task for conversation analysis. Application calls support HTTP invocations to complete customer responses.
GetAgentTaskResult	Retrieve agent task results	Retrieves the task result of an agent node.
Tag management	Tag management
CreateTag	Create a label node	Creates a label node.
GetTag	Query label node details	Queries the details of a label node.
UpdateTag	Update label node	Updates a label node.
ListTag	Query label node list	Queries the list of label nodes.
DeleteTag	Delete a label node	Deletes a label node.

Datasets

API	Title	Description
SubmitQualityCheckTask	Create a dataset quality inspection job	Create a new dataset quality check task.
SaveConfigDataSet	Save Speaker Role Configuration for Dataset	Saves the speaker role configuration for a dataset.
ListDataSet	Batch retrieve datasets	This feature is located in the Dataset management section of the frontend. The Apsara Stack URL is ip:port/api/dataset/ListDataSet.json.

Quality inspection results

API	Title	Description
Quality inspection results	Quality inspection results
GetResult	Retrieve Quality Inspection Results	Query quality inspection results. Some fields require the requiredFields parameter to be explicitly specified in the request. Set the service endpoint (Region) to Hangzhou (cn-hangzhou).
GetResultToReview	Obtain quality inspection result details for review	Retrieves the quality inspection results for a specified file. The response includes the transcript, audio URL, and details of detected rule hits. You can use this information to review the file by listening to the audio, reading the transcript, and locating where rules were triggered.
Session group quality inspection	Session group quality inspection
ListSessionGroup	Retrieve session group list	This API corresponds to the frontend location: Task Management > View Results > Task Result > Session Group Results tab. The Apsara Stack URL is: ip:port/api/session/group/ListSessionGroup.json. It aggregates multi-turn sessions by their session group ID for unified management. You must pass the `sessionGroupId` field. For more information, see the UploadData and UploadAudioData API documentation.
AssignReviewerBySessionGroup	Assign Session Group	Frontend location: Quality Check Plan Management > Task Results > Session Groups > Batch Assign. Apsara Stack URL: ip:port/api/job/AssignReviewerBySessionGroup.json.
RevertAssignedSessionGroup	Batch Revoke (Session Group Dimension)	You can use this feature in the frontend console under Plan Management > Task Result > Session Group > Batch Revoke. The Apsara Stack URL for this operation is `ip:port/api/job/RevertAssignedSessionGroup.json`.
Appeals, reviews, and assignments	Appeals, reviews, and assignments
SubmitReviewInfoV4	Save Review Result	Review quality inspection results
AssignReviewer	Assign Quality Inspector	Manually assign quality reviewers.
SubmitComplaint	Submit Appeal	Submits a complaint.
HandleComplaint	Handle an appeal	Handles a complaint.
RevertAssignedSession	Batch Revoke (Single-channel Session Dimension)	Frontend location: Task Management > Task Results > Batch Revoke. Apsara Stack URL: ip:port/api/job/RevertAssignedSession.json.

Speech model training

API	Title	Description
Hotword models	Hotword models
CreateAsrVocab	Create Hotword Group	Uploads a set of speech hotwords to the server and obtains the hotword ID in the response.
UpdateAsrVocab	Update Hotword Group	Updates the hotword vocabulary.
GetAsrVocab	Retrieve the details of a specified hotword group	Retrieves details for a specified hotword group.
ListAsrVocab	Retrieve hotword group list	Retrieves a list of vocabulary groups without their specific content.
DeleteAsrVocab	Delete a hotword group	Deletes a hotword group.
Language models	Language models
GetCustomizationConfigList	Obtain language model List	Retrieves a list of language models.
DeleteCustomizationConfig	Delete Language Model	Deletes a language model.

System management

API	Title	Description
User management	User management
CreateUser	Create a user	Create a user
ListUsers	Retrieve User List	Retrieves a list of users. Set the service endpoint to China (Hangzhou) (cn-hangzhou).
UpdateUser	Edit User	Update users by modifying their roles in batches.
Review management	Review management
CreateTaskAssignRule	Create an automatic allocation rule for review jobs	Creates an automatic allocation rule for quality review tasks.
UpdateTaskAssignRule	Update the automatic allocation rule for review tasks	Update the automatic allocation rule for quality review tasks.
ListTaskAssignRules	Obtain the list of automatic allocation rules for review tasks.	Lists automatic allocation rules for review tasks.
DeleteTaskAssignRule	Delete the automatic allocation rule for review tasks	Deletes an automatic allocation rule for review tasks.
Alert management	Alert management
CreateWarningConfig	Create Alert Configuration	Create a warning configuration.
UpdateWarningConfig	Update Alert Configuration	Updates the warning configuration.
ListWarningConfig	Obtain the warning configuration list	Lists warning configurations.
DeleteWarningConfig	Delete Alert Configuration	Deletes a warning configuration.
Skill group management	Skill group management
CreateSkillGroupConfig	Create Configuration	Create a configuration.
UpdateSkillGroupConfig	Update Configuration	You can call UpdateSkillGroupConfig to update a configuration.
GetSkillGroupConfig	Obtain Skill Group Rule Configuration Details by ID	Retrieves the configuration that is specified by its ID.
ListSkillGroupConfig	Retrieve configuration list	You can call ListSkillGroupConfig to obtain the configuration list.
DeleteSkillGroupConfig	Delete Configuration	Delete a configuration.

Not recommended or whitelist access

API	Title	Description
Tag generation	Tag generation
GenerateLabel	Generate labels	Generates labels.
GetLabelGeneratedResult	Query label generation result	Queries the result of a label generation task.
Tag analysis	Tag analysis
AnalyzeLabel	Tag categorization	Performs tag categorization.
GetLabelAnalysisResult	Query tag categorization analysis results	Queries the results of tag categorization analysis.
Real-time quality inspection	Real-time quality inspection
ApplyWsToken	Apply for a Token for Real-Time Speech Quality Inspection	Apply for the token required for real-time speech processing.
SyncQualityCheck	SyncQualityCheck	Perform real-time quality inspection for hotlines.
UpdateSyncQualityCheckData	Maintain recording information	Maintain the recording information after real-time quality inspection is completed, which is used to play back the recording during review. After the recording information is maintained, the task status will change to Succeeded.
UploadDataSync	Real-time text quality inspection	Performs real-time text-based quality inspection.
UploadDataSyncForLLM	Real-time text quality inspection - large language model	Performs real-time text quality inspection using a large language model.
Other	Other
ExecuteAgent	Run an agent	Runs an agent.
RunCompletionMessage	Invoke a large language model by using native prompts	Invokes a large language model in the Message protocol format to obtain analysis results. The API supports standard HTTP and HTTP Server-Sent Events (SSE) protocols. You can select a protocol based on your requirements.
CreateMiningTask	Create a mining analysis job	Creates a label mining task.
GetMiningTaskResult	Obtain Mining Analysis Job Result	Retrieve the result of a tag mining task.
DeleteSchemeTaskConfig	Delete Quality Inspection Job	This feature is not available on the frontend. The Apsara Stack API endpoint is ip:port/api/task/DeleteSchemeTaskConfig.json.

Deprecated in V4

API	Title	Description
Rule management	Rule management
DeleteRule	Delete Quality Inspection Rule	This operation deletes a quality check rule. You can access it from the Quality Check Rule Configuration page in the Apsara Stack console. The API endpoint is ip:port/api/client/DeleteRule.json.
ListRules	Retrieve Rule List	Lists rules.
GetRule	Retrieve basic information about rules	Retrieves basic information about rules.
GetRuleById	Get Rule Details by ID	Retrieves the details of a specific quality inspection rule. It corresponds to the Edit action on the Quality Inspection Rule Configuration page. The URL for this operation in a private cloud is `ip:port/api/client/GetRuleById.json`.
GetRulesCountList	Batch retrieve the quality inspection rule list.	Corresponds to the frontend feature location: Quality Inspection Rule Configuration > List. Apsara Stack URL: ip:port/api/rule/GetRulesCountList.json.
UpdateRuleById	Create or Update a Quality Inspection Rule	This API maps to the frontend function location: Quality Inspection Rule Configuration - Create & Update. The Apsara Stack URL is: ip:port/api/client/UpdateRuleById.json.
UpdateRule	Update Rule	Update rule information.
UploadRule	Creation of a rule	Creates a rule. You can use this operation to provide your own rule editing interface.
GetRuleDetail	Obtain Detail Information of a Rule	Retrieves the detailed information of a rule.
InvalidRule	Delete Rules	Delete rules.
Other	Other
GetSyncResult	Obtain real-time quality inspection results	You can obtain the real-time quality inspection result of the hotline.
DeleteDataSet	Delete a dataset	Deletes a dataset.
SubmitReviewInfo	Save review result (Smart Conversation Analysis legacy version only)	Save review results. This is only supported by the legacy Smart Conversation Analysis.
BatchSubmitReviewInfo	Batch Review	This operation implements the Batch Review feature, which is available in the frontend under Task Management > Task Result. For private cloud deployments, use the URL: ip:port/api/qcsBatchSubmitReviewInfo.json. You can use this operation to perform a batch review on all filtered data. Note: This operation updates a large volume of data. The changes may take some time to appear.
Manual evaluation	Manual evaluation
GetNextResultToVerify	Obtain details of the next file for manual validation	Retrieve the next file details for manual verification.