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

Operation description

You can invoke this API to cancel an Intelligent Contact Robot calling job, or manually cancel the job in the Task Management interface.
After an Intelligent Contact Robot calling job is canceled, it cannot be started again. Proceed with caution.
If you want to pause a job and restart it later, you can manually pause the job in the Task Management interface or pause it by using the StopTask API.

Queries per second (QPS) limits

Per-user invocation frequency: No rate limiting.
API frequency: 500 queries per second (QPS).

Note

If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aiccs:CancelTask

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	integer	Yes	The unique job ID of the robot calling task. You can view it in the Task Management interface or obtain it by using the CreateTask API.	12****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
Message	string	Description of the status code.	OK
Data	boolean	Indicates whether the operation succeeded. Valid values: true: Succeeded. false: Failed.	true
Code	string	Request status code. A value of OK indicates that the request succeeded.	OK
Success	boolean	Indicates whether the API was invoked successfully. Valid values: true: Succeeded. false: Failed.	true

Examples

Success response

JSON format

{
  "RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
  "Message": "OK",
  "Data": true,
  "Code": "OK",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	PermissionInsufficient	Insufficient permissions. Please contact the Alibaba Cloud account administrator.
400	ParameterError	The parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.