tencent cloud

CreateCallOutSession
Last updated: 2025-11-11 10:19:55
CreateCallOutSession
Last updated: 2025-11-11 10:19:55

1. API Description

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

This API is used to create an outbound call session. Currently, only dual calls are supported. That is, first use the platform number to call the agent mobile phone. After the agent answers, then make an outbound call to the user. Moreover, due to ISP frequency restrictions, the agent phone number must be added to the allowlist first to avoid frequency control leading to the failure of the outbound call. Therefore, before calling this API, the following operations have been completed.

  1. The agent specified by UserId has already bound the mobile number. https://www.tencentcloud.com/document/product/679/76067?from_cn_redirect=1#.E6.AD.A5.E9.AA.A42.EF.BC.9A.E5.AE.8C.E5.96.84.E8.B4.A6.E5.8F.B7.E4.BF.A1.E6.81.AF.
  2. The agent's bound mobile number has applied for and passed the outbound call allowlist.
    This API is used to make calls. Currently, the agent side can only call the user's mobile phone, so the IsForceMobile field must be true.
  3. Do not fill in the mobile number bound to the current UserId for the callee, otherwise it can lead to call failure due to a busy line.

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.
SdkAppId Yes Integer Application id.
UserId Yes String Customer service user ID, generally the customer service email. ensure that the mobile number has been bound. https://www.tencentcloud.com/document/product/679/76067?from_cn_redirect=1#.E6.AD.A5.E9.AA.A42.EF.BC.9A.E5.AE.8C.E5.96.84.E8.B4.A6.E5.8F.B7.E4.BF.A1.E6.81.AF.
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 mobile outbound call. currently only supports true. if set to true, ensure the allowlist is configured. https://www.tencentcloud.com/document/product/679/76744?from_cn_redirect=1#.E6.93.8D.E4.BD.9C.E6.AD.A5.E9.AA.A4.
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 Outbound Call API Call Example

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.intl.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 Caller ID exceeds the outbound call limit.
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 Invalid Parameter
InvalidParameterValue.AccountNotExist Account does not exist.
OperationDenied.NotInWhiteList Not in the allowlist.
UnsupportedOperation Unsupported operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback