What's New
Cloud Contact Center Terminology Update
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.
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. |
| MaxRingTimeoutSecond | No | Integer | Maximum ringing duration. auto hang up when the duration threshold is reached. only own number supports this 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. |
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
}
{
"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.AIConcurrentNoPackage | No available AI concurrency licenses. please proceed to purchase on the console. |
| FailedOperation.AIConcurrentOverFrequency | AI concurrent overfrequency. |
| 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. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários