tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateCallOutSession

Last updated: 2024-09-09 17:58:00

1. API Description

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

This API is used to create outbound sessions. Currently, only dual call is supported. That is, firstly, please use the platform number to call the agent's cell phone. After the agent answers, then please make outbound calls to the user. Due to ISP frequency restrictions, the agent's phone number must first be added to the allowlist to avoid frequency control which may lead to the failure of the outbound call.

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: CreateCallOutSession.
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
UserId Yes String Customer Service User ID usually refers to the customer service email.
Callee Yes String Called number must be preceded by 0086.
Caller No String Caller number (obsolete one and use Callers) must be preceded by 0086.
Callers.N No Array of String Designated caller number list. If the prior number fails, it will automatically switch to the next number that must be preceded by 0086.
IsForceUseMobile No Boolean Whether to force the use of cell phone outbound call or not, currently only supports true, if true, please ensure that the allowlist has been configured.
UUI No String Custom data, length limited to 1024 bytes.

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 Calling Outbound Call API

This example shows you how to trigger outbound calls through this API in the backend, without loading the front-end SDK. Currently, only outbound call back through the mobile end (first dialing the customer service mobile phone) is supported, and make sure that the addition of outbound call allowlist has been applied and passed.

Input Example

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCallOutSession
<Common request parameters>
{
    "IsForceUseMobile": "true",
    "Callee": "008612300000000",
    "UUI": "fooandbar",
    "UserId": "FooOrBar@tencent.com",
    "SdkAppId": 1400000000
}

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

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.CalleeIsLimited Limited outbound called number.
FailedOperation.CallerOverFrequency Outbound over-frequency caller number.
FailedOperation.NoCallOutNumber No available outbound call numbers.
FailedOperation.SeatStatusBusy Agent is busy.
InternalError.DBError Internal database access failure.
InvalidParameter.InstanceNotExist The instance does not exist.
InvalidParameterValue parameter value is invalid.
InvalidParameterValue.AccountNotExist Account does not exist.
OperationDenied.NotInWhiteList Not in the allowlist.
UnsupportedOperation Unsupported operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy