tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateAutoCalloutTask

Last updated: 2024-03-27 16:13:59

1. API Description

Domain name for API request: ccc.tencentcloudapi.com.

This API is used to create the automatic outbound call task.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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 for this API.
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 Yes Integer IVR used for calling.
Name No String Task name.
Description No String Task description.
NotAfter No Integer Task stop timestamp. Unix second-level timestamp.
Tries No Integer Maximum attempts.
Variables.N No Array of Variable Custom variables (supported only in advanced versions).
UUI No String UUI
CalleeAttributes.N No Array of CalleeAttribute Property of the called.

3. Output Parameters

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.

4. Example

Example1 Creating Task

This example shows you how to create task

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAutoCalloutTask
<Common request parameters>
{
    "SdkAppId": 1400123455,
    "NotBefore": 1642500621,
    "Callees": [
        "008613012345678"
    ],
    "Callers": [
        "008602012345678"
    ],
    "IvrId": 8
}

Output Example

{
    "Response": {
        "TaskId": 1,
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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 The parameter value is invalid.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy