1. 接口描述
接口请求域名: ccc.tencentcloudapi.com 。
创建关联 IVR 的会话,仅高级版支持,目前支持呼入和自动外呼两种 IVR 类型。收到请求后 TCCC 会先尝试呼通被叫,然后进入 IVR 流程。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateIVRSession。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-10。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SdkAppId | 是 | Integer | 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc 示例值:1400000000 |
Callee | 是 | String | 被叫 示例值:+8613012345678 |
IVRId | 是 | Integer | 指定的 IVR Id,目前支持呼入和自动外呼两种类型 示例值:4600 |
Callers.N | 否 | Array of String | 主叫号码列表 |
Variables.N | 否 | Array of Variable | 自定义变量 |
UUI | 否 | String | 用户数据 示例值:foobar |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SessionId | String | 新创建的会话 ID 示例值:adcf61b8-dbb9-4c20-87bf-c0744c04bade |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建关联 IVR 的会话示例
输入示例
POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateIVRSession
<公共请求参数>
{
"Callee": "008612300000000",
"SdkAppId": 1400000000,
"IVRId": 4500
}
输出示例
{
"Response": {
"RequestId": "6bb56a09-2787-40bc-80c5-dc6dab783eff",
"SessionId": "6bb56a09278740bc80c5dc6dab783eff"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.CallOutFailed | 外呼失败。 |
FailedOperation.CalleeIsBlackUser | 高风险用户,请勿呼叫 |
FailedOperation.CallerOverFrequency | 主叫号码外呼超频。 |
FailedOperation.CalloutRuleBlindArea | 触发默认被叫规则,呼叫盲区 |
FailedOperation.CalloutRuleMaxCallCountCalleeIntervalTime | 触发默认外呼规则,被叫一段时间内呼叫量 |
FailedOperation.CalloutRuleMaxCallCountCalleePerDayAppID | 触发默认外呼规则,被叫每日最大呼叫量 |
FailedOperation.CalloutRuleNotWorkTime | 触发默认外呼规则,不在可外呼时间 |
FailedOperation.NoCallOutNumber | 无可用的外呼号码。 |
FailedOperation.PermissionDenied | 权限不足。 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InstanceNotExist | 实例不存在。 |
LimitExceeded.BasePackageExpired | 套餐包耗尽 |