- Product Introduction
- Purchase Guide
- Preparation
- Getting Started
- Administrator Manual
- Telephone Operation Guide
- Customer Service Management
- Inbound IVR Management
- Outbound Number Assignment
- SIP Phone Registration
- Integration with Business System (Inbound Call Pop-Up)
- Online Status and On Break Reason
- Inbound Call Routing and Answering Settings
- Clicking to Dial on PC
- Hot Word Feature
- Outbound Call on Dial Pad
- Predictive Outbound Calling
- Call-out Then Customer Call-in Reception
- Call Features
- Customer Satisfaction Evaluation
- Number Privacy Protection
- Service Record Viewing and Playback
- Service Record Storage and Access
- Recording Storage and Access
- Data Analysis
- Real-Time Monitoring
- Telephone Operation Guide
- Agent Manual
- Phone Volume
- Hardware, Software, and Network Requirements
- Logging In and Going Online
- Agent Workstation
- Agent Status
- Answering Calls and Making Outbound Calls (via Web)
- Call Hold and Mute
- Direct Transfer to Skill Group/Agent
- Call Self-Service
- Entering Extension Number
- Agent Internal Call
- Phone Service Records and Recording
- Modify the mobile number
- Forgetting or Changing Password
- Going Offline and Logging Out
- Phone Volume
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Agent APIs
- Skill Group APIs
- Number APIs
- Dual Call APIs
- Automatic Outbound Call APIs
- CreateAutoCalloutTask
- DescribeAutoCalloutTasks
- StopAutoCalloutTask
- DescribeAutoCalloutTask
- UpdatePredictiveDialingCampaign
- ResumePredictiveDialingCampaign
- PausePredictiveDialingCampaign
- DescribePredictiveDialingSessions
- DescribePredictiveDialingCampaigns
- DescribePredictiveDialingCampaign
- DeletePredictiveDialingCampaign
- CreatePredictiveDialingCampaign
- AbortPredictiveDialingCampaign
- DescribeAgentCruiseDialingCampaign
- Telephone APIs
- Phone Service Record APIs
- Purchasing APIs
- Other APIs
- Outbound Call APIs
- Data Types
- Error Codes
- SDK Development Guide
- Data Push
- FAQs
- Service Agreement
- Contact Us
- Data Deletion Guide
- Glossary
- Product Introduction
- Purchase Guide
- Preparation
- Getting Started
- Administrator Manual
- Telephone Operation Guide
- Customer Service Management
- Inbound IVR Management
- Outbound Number Assignment
- SIP Phone Registration
- Integration with Business System (Inbound Call Pop-Up)
- Online Status and On Break Reason
- Inbound Call Routing and Answering Settings
- Clicking to Dial on PC
- Hot Word Feature
- Outbound Call on Dial Pad
- Predictive Outbound Calling
- Call-out Then Customer Call-in Reception
- Call Features
- Customer Satisfaction Evaluation
- Number Privacy Protection
- Service Record Viewing and Playback
- Service Record Storage and Access
- Recording Storage and Access
- Data Analysis
- Real-Time Monitoring
- Telephone Operation Guide
- Agent Manual
- Phone Volume
- Hardware, Software, and Network Requirements
- Logging In and Going Online
- Agent Workstation
- Agent Status
- Answering Calls and Making Outbound Calls (via Web)
- Call Hold and Mute
- Direct Transfer to Skill Group/Agent
- Call Self-Service
- Entering Extension Number
- Agent Internal Call
- Phone Service Records and Recording
- Modify the mobile number
- Forgetting or Changing Password
- Going Offline and Logging Out
- Phone Volume
- Practical Tutorial
- API Documentation
- History
- Introduction
- API Category
- Making API Requests
- Agent APIs
- Skill Group APIs
- Number APIs
- Dual Call APIs
- Automatic Outbound Call APIs
- CreateAutoCalloutTask
- DescribeAutoCalloutTasks
- StopAutoCalloutTask
- DescribeAutoCalloutTask
- UpdatePredictiveDialingCampaign
- ResumePredictiveDialingCampaign
- PausePredictiveDialingCampaign
- DescribePredictiveDialingSessions
- DescribePredictiveDialingCampaigns
- DescribePredictiveDialingCampaign
- DeletePredictiveDialingCampaign
- CreatePredictiveDialingCampaign
- AbortPredictiveDialingCampaign
- DescribeAgentCruiseDialingCampaign
- Telephone APIs
- Phone Service Record APIs
- Purchasing APIs
- Other APIs
- Outbound Call APIs
- Data Types
- Error Codes
- SDK Development Guide
- Data Push
- FAQs
- Service Agreement
- Contact Us
- Data Deletion Guide
- Glossary
1. API Description
Domain name for API request: ccc.intl.tencentcloudapi.com.
This API is used to query the predictive 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: DescribePredictiveDialingCampaign. |
| 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. |
| CampaignId | Yes | Integer | Task ID. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| CampaignId | Integer | Task ID. |
| Name | String | Task Name |
| CallOrder | Integer | Being called sequence: 0 for random 1 for in order. |
| SkillGroupId | Integer | ID of the used skill group of agents. |
| IVRId | Integer | Specified IVR ID. |
| Priority | Integer | Running priority of multiple tasks in the same application, from high to low 1 - 5. |
| ExpectedAbandonRate | Integer | Expected call drop rate, percentage, 5 - 50. |
| RetryTimes | Integer | Number of call retries, 0 - 2. |
| RetryInterval | Integer | Call retry interval, in seconds, [60 - 86,400]. |
| StartTime | Integer | Task start time. Unix timestamp. The task will automatically start after this time. |
| EndTime | Integer | Task termination time. Unix timestamp. The task will automatically terminate after this time. |
| 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 Querying Predictive Outbound Call Task
This example shows you how to query the predictive outbound call task.
Input Example
POST / HTTP/1.1
Host: ccc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePredictiveDialingCampaign
<Common request parameters>
{
"SdkAppId": 1400000000,
"CampaignId": 2569
}
Output Example
{
"Response": {
"CampaignId": 2569,
"Name": "New energy SUV recommendation",
"CallOrder": 0,
"SkillGroupId": 255,
"IVRId": 4600,
"Priority": 3,
"ExpectedAbandonRate": 10,
"RetryTimes": 1,
"RetryInterval": 1800,
"StartTime": 1708483433,
"EndTime": 1708485433,
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| InternalError.DBError | Internal database access failure. |
| InvalidParameterValue | parameter value is invalid. |
Yes
No
Was this page helpful?