History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Domain name for API request: ccc.intl.tencentcloudapi.com.
Used to create one-time Intelligent Agent outbound calls. You can create a voice Intelligent Agent in the management console - Intelligent Agent Management and perform dialogue process configuration (https://www.tencentcloud.comom/document/product/679/119796?from_cn_redirect=1). This API is used to initiate a single outbound call task with a configured Intelligent Agent. To create batch Intelligent Agent outbound call tasks, refer to the documentation for creating automatic outbound call tasks (https://www.tencentcloud.comom/document/product/679/69194?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: CreateAIAgentCall. |
| 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. |
| AIAgentId | Yes | Integer | AI agent id. |
| Callee | Yes | String | Callee number. |
| Callers.N | No | Array of String | Caller number list |
| Variables.N | No | Array of Variable | Prompt variable welcome message variable welcome message delay playback (in seconds): welcome-message-delay dify variable .dify-inputs-xxx specifies the inputs variable for dify. 2. the dify-inputs-user specifies the user value for dify. 3. dify-inputs-conversation_id is the conversation_id value of dify. |
| MaxRingTimeoutSecond | No | Integer | Maximum ringing duration. auto hang up when the duration threshold is reached. only own number supports current parameter. |
| Parameter Name | Type | Description |
|---|---|---|
| SessionId | String | Newly created session 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. |
Use Intelligent Agent to initiate outbound call
POST / HTTP/1.1
Host: ccc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAIAgentCall
<Common request parameters>
{
"Callee": "008612300000000",
"SdkAppId": 1400000000,
"AIAgentId": 15,
"Callers": [
"008601012345678",
"008601012345679"
],
"Variables": [
{
"Key": "foo",
"Value": "bar"
},
{
"Key": "dify-inputs-key",
"Value": "value"
},
{
"Key": "dify-inputs-user",
"Value": "value"
},
{
"Key": "dify-inputs-conversation_id",
"Value": "value"
}
]
}
{
"Response": {
"RequestId": "6bb56a09-2787-40bc-80c5-dc6dab783eff",
"SessionId": "6bb56a09278740bc80c5dc6dab783eff"
}
}
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.AILicenseHasExpired | AI package expired. please renew or repurchase. |
| FailedOperation.CallOutFailed | Outbound call failure. |
| FailedOperation.CalleeIsBlackUser | High-risk users, do not call |
| FailedOperation.CallerOverFrequency | Caller ID exceeds the outbound call limit. |
| FailedOperation.CalloutRuleBlindArea | The number is in a restricted calling zone. |
| FailedOperation.CalloutRuleMaxCallCountCalleeIntervalTime | Exceeded call limit for the callee within a set time. |
| FailedOperation.CalloutRuleMaxCallCountCalleePerDayAppID | Exceeded daily call limit for the callee. |
| FailedOperation.CalloutRuleNotWorkTime | Calls are not allowed at this time. |
| FailedOperation.NoCallOutNumber | No available outbound call numbers. |
| FailedOperation.PermissionDenied | Insufficient permissions. |
| InternalError | An internal error occurs. |
| InvalidParameterValue | Invalid Parameter |
| InvalidParameterValue.InstanceNotExist | The SDKAppID does not exist. |
| LimitExceeded.BasePackageExpired | Your call package is used up. |
フィードバック