tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateIVRSession

Last updated: 2024-11-26 16:02:53

1. API Description

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

Create a session associated with IVR. This feature is supported only in the Advanced Version. Currently, it supports inbound and automatic outbound IVR types. Upon receiving the request, TCCC will first attempt to call the callee, then enter the IVR flow.

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: CreateIVRSession.
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.
Callee Yes String Called.
IVRId Yes Integer Specified IVR Id. Currently, it supports inbound and automatic outbound types
Callers.N No Array of String List of calling numbers.
Variables.N No Array of Variable Custom variable
UUI No String User Data

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 Create a session associated with IVR example

Input Example

POST / HTTP/1.1
Host: ccc.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIVRSession
<Common request parameters>

{
    "Callee": "008612300000000",
    "SdkAppId": 1400000000,
    "IVRId": 4500
}

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.CalleeIsBlackUser High-risk users, do not call
FailedOperation.CallerOverFrequency Outbound over-frequency caller number.
FailedOperation.CalloutRuleBlindArea Trigger Default Inbound Rule, Call Blind Spot
FailedOperation.CalloutRuleMaxCallCountCalleeIntervalTime Trigger Default Outbound Rule, Call Volume for Called Party within a Period
FailedOperation.CalloutRuleMaxCallCountCalleePerDayAppID Trigger Default Outbound Rule, Daily Maximum Calls for Called Party
FailedOperation.CalloutRuleNotWorkTime Trigger Default Outbound Rule, Not in Outbound Time
FailedOperation.NoCallOutNumber No available outbound call numbers.
FailedOperation.PermissionDenied Insufficient permissions.
InternalError An internal error occurs.
InvalidParameterValue parameter value is invalid.
InvalidParameterValue.InstanceNotExist The instance does not exist.
LimitExceeded.BasePackageExpired Package quota exhausted
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy