1. 接口描述
接口请求域名: ccc.tencentcloudapi.com 。
创建外呼会话,当前仅支持双呼,即先使用平台号码呼出到坐席手机上,坐席接听后,然后再外呼用户,而且由于运营商频率限制,坐席手机号必须先加白名单,避免频控导致外呼失败。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateCallOutSession。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-10。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SdkAppId | 是 | Integer | 应用 ID 示例值:14000000000 |
UserId | 是 | String | 客服用户 ID,一般为客服邮箱 示例值:foo@tencent.com |
Callee | 是 | String | 被叫号码,须带 0086 前缀 示例值:008613012345678 |
Caller | 否 | String | 主叫号码(废弃,使用Callers),须带 0086 前缀 示例值:008610086 |
Callers.N | 否 | Array of String | 指定主叫号码列表,如果前面的号码失败了会自动换成下一个号码,须带 0086 前缀 示例值:["0086075512345678","0086075512345679"] |
IsForceUseMobile | 否 | Boolean | 是否强制使用手机外呼,当前只支持 true,若为 true 请确保已配置白名单 示例值:true |
UUI | 否 | String | 自定义数据,长度限制 1024 字节 示例值:dGhpcyBpcyBhIGV4YW1wbGU |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SessionId | String | 新创建的会话 ID 示例值:adcf61b8-dbb9-4c20-87bf-c0744c04bade |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 外呼接口调用示例
在不加载前端 SDK 的场景下,可以通过在后台触发此接口进行外呼,当前只支持通过手机端回拨外呼(先拨通客服手机),并且确认已经申请并通过添加外呼白名单。
输入示例
POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCallOutSession
<公共请求参数>
{
"IsForceUseMobile": "true",
"Callee": "008612300000000",
"UUI": "fooandbar",
"UserId": "FooOrBar@tencent.com",
"SdkAppId": 1400000000
}
输出示例
{
"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.CalleeIsLimited | 被叫号码外呼受限。 |
FailedOperation.CallerOverFrequency | 主叫号码外呼超频。 |
FailedOperation.NoCallOutNumber | 无可用的外呼号码。 |
FailedOperation.SeatStatusBusy | 坐席处于忙碌状态。 |
InternalError.DBError | 内部数据库访问失败。 |
InvalidParameter.InstanceNotExist | 实例不存在。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.AccountNotExist | 账号不存在。 |
OperationDenied.NotInWhiteList | 不在白名单中。 |
UnsupportedOperation | 操作不支持。 |