DocsICP FilingConsole
官方文档
首页

UpdateAiCallTask

更新时间：
复制 MD 格式
产品详情
我的收藏

Updates a call task configuration.

Operation description

Ensure the call task is stopped before you update its configuration.

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:UpdateAiCallTask

update

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
TaskName

string

Yes

The task name. The name must be unique within an Alibaba Cloud account.

测试任务
VirtualNumber

string

Yes

The service instance used for outbound calls.

0537022*****
StartType

string

Yes

The startup method. Valid values:

  • IMMEDIATE: Start immediately.

  • SCHEDULE: Start at a specified time.

IMMEDIATE
MissCallRetry

boolean

No

Specifies whether to enable retry. Valid values:

  • true: Yes.

  • false (default): No.

true
CallRetryReason

array

No

The call failure statuses that trigger a retry.

string

No

A call failure status that triggers a retry. Valid values:

  • CALL_REJECTED: The call was rejected.

  • USER_BUSY: The user is busy.

  • SUSPEND: The service is suspended.

  • INVALID_NUMBER: The number is invalid.

  • POWERED_OFF: The phone is powered off.

  • NETWORK_BUSY: The network is busy.

  • NO_ANSWER: No answer.

CALL_REJECTED
CallRetryTimes

integer

No

The number of retries. The maximum value is 3.

2
CallRetryInterval

integer

No

The retry interval in minutes. The maximum value is 120.

25
CallTime

array

Yes

The callable time windows.

string

No

The time window for calls. The format is as follows:

{"startTime":"09:00:00","endTime":"10:00:00"}

In this format, startTime and endTime define the start and end of a time window. The system makes outbound calls only during these windows. If a call is scheduled outside a time window, the system waits for the next available window to begin.

Note

  • Due to carrier policies, the actual execution time is subject to platform scheduling. You can check the restricted calling periods for your numbers in Real Number Management.

{"startTime":"09:00:00","endTime":"10:00:00"}
CallDay

array

Yes

The days of the week when calls can be made.

string

No

A day of the week on which calls can be made. Valid values:

  • MONDAY: Monday.

  • TUESDAY: Tuesday.

  • WEDNESDAY: Wednesday.

  • THURSDAY: Thursday.

  • FRIDAY: Friday.

  • SATURDAY: Saturday.

  • SUNDAY: Sunday.

Valid values:

  • WEDNESDAY :

  • MONDAY :

  • THURSDAY :

  • SUNDAY :

  • TUESDAY :

  • FRIDAY :

  • SATURDAY :

MONDAY
TaskStartTime

integer

No

The scheduled start time for the task, specified as a Unix timestamp in milliseconds. This parameter is required when StartType is set to SCHEDULE.

1748923429000
TaskId

string

Yes

The ID of the task to update.

1187**************
TaskCps

integer

Yes

The number of concurrent calls per second (CPS) for the task. The maximum value is 500.

57

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

The reason why access was denied.

None
Message

string

The error message that is returned when an error occurs.

参数不合法
RequestId

string

The request ID.

FCD94A7F-316D-54D1-9BFC-814006CB1C34
Data

boolean

Indicates whether the task was updated successfully. Valid values:

  • true: The update is successful.

  • false: The update failed.

true
Code

string

The status code.

OK
Success

boolean

Indicates whether the API call was successful. Valid values:

  • true: Successful.

  • false: Failed.

false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "参数不合法",
  "RequestId": "FCD94A7F-316D-54D1-9BFC-814006CB1C34",
  "Data": true,
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.