Domain name for API request: ccc.intl.tencentcloudapi.com.
This API is used to create bulk automatic outbound calls. The system will automatically initiate outbound calls to the designated called number list based on task configuration. This API can call the configured Intelligent Agent to perform batch outbound call tasks. You can create a voice Intelligent Agent in the management console-Intelligent Agent Management and configure the dialogue process (https://www.tencentcloud.comom/document/product/679/119796?from_cn_redirect=1). To create a single Intelligent Agent outbound call task, refer to the documentation (https://www.tencentcloud.comom/document/product/679/115681?from_cn_redirect=1).
The feature requires purchase of the Intelligent Agent call package and is only available for own telephone number. For details, refer to the Intelligent Agent Call Purchase Guide.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateAutoCalloutTask. |
| Version | Yes | String | Common Params. The value used for this API: 2020-02-10. |
| Region | No | String | Common Params. This parameter is not required. |
| SdkAppId | Yes | Integer | Application id (required) can be found at https://console.tencentcloud.com/ccc. |
| NotBefore | Yes | Integer | Task starting timestamp. unix second-level timestamp. |
| Callees.N | Yes | Array of String | List of called numbers. |
| Callers.N | Yes | Array of String | List of calling numbers. |
| IvrId | No | Integer | IVR Id used for calling. if not filled, AIAgentId needs to be filled. |
| Name | No | String | Task name. |
| Description | No | String | |
| NotAfter | No | Integer | Task stop timestamp. unix second-level timestamp. |
| Tries | No | Integer | Maximum attempts, 1-3 times. |
| Variables.N | No | Array of Variable | Custom variable (advanced edition support). using the same variable in the CalleeAttributes field will overwrite here. |
| UUI | No | String | User-Defined data. specifies that using UUI in the CalleeAttributes field will overwrite here. |
| CalleeAttributes.N | No | Array of CalleeAttribute | Property of the called. |
| TimeZone | No | String | IANA time zone name. see https://datatracker.ietf.org/doc/html/draft-ietf-netmod-iana-timezones. |
| AvailableTime.N | No | Array of TimeRange | Available time period. |
| AIAgentId | No | Integer | Intelligent agent ID. if not filled, IvrId needs to be filled. |
| RetryInterval | No | Integer | Retry interval for task failure. value range: 600-86400 seconds. |
| MaxRingTimeoutSecond | No | Integer | Maximum ringing duration. auto hang up when the duration threshold is reached. only own number supports this parameter. |
| Parameter Name | Type | Description |
|---|---|---|
| TaskId | Integer | Task id. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Create a task
POST / HTTP/1.1
Host: ccc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAutoCalloutTask
<Common request parameters>
{
"SdkAppId": 1400123455,
"NotBefore": 1642500621,
"Callees": [
"008613012345678"
],
"Callers": [
"008602012345678"
],
"IvrId": 8
}{
"Response": {
"TaskId": 1,
"RequestId": "a561d5e7-2680-481f-b86e-a9ad7316f4d5"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.PermissionDenied | Insufficient permissions. |
| InternalError | An internal error occurs. |
| InternalError.DBError | Internal database access failure. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Invalid Parameter |
| InvalidParameterValue.ExperienceAccount | The intelligent agent of the use experience account does not support this operation. |
文档反馈