CreateAIAgentCall

This API is used to initiate outbound calls using an AI model, limited to owned phone numbers only. Currently, a limited-time free trial of Advanced Agents is available.

Before initiating a call, please ensure your AI model is compatible with OpenAI, Azure, or Minimax protocols, and visit the model provider's website to obtain relevant authentication information. For detailed feature descriptions, please refer to the documentation Tencent Cloud Contact Center AI Call Platform.

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: 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
PromptVariables.N	No	Array of Variable	Prompt variable.

3. Output Parameters

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.

4. Example

Example1 Initiate an Outbound Call Using AI Agent

This example shows you how to initiate an outbound call using AI Agent.

Input Example

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"
    ],
    "PromptVariables": [
        {
            "Key": "foo",
            "Value": "bar"
        }
    ]
}

Output Example

{
    "Response": {
        "RequestId": "6bb56a09-2787-40bc-80c5-dc6dab783eff",
        "SessionId": "6bb56a09278740bc80c5dc6dab783eff"
    }
}

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

Tencent Cloud CLI 3.0

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.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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Tencent Big Model

Internet of Things

Stream Services

Cloud Real-time Rendering

Management and Audit Tools

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Developer Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Voice Technology

Natural Language Processing

Communication

Media Process Services

Education Sevices

Monitor and Operation

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Image Creation

Optical Character Recognition

Interactive Video Services

Media SDK

Cloud Resource Management

More

1. API Description