查询自动外呼任务详情

最近更新时间:2024-10-31 01:14:23

我的收藏

1. 接口描述

接口请求域名: ccc.tencentcloudapi.com 。

查询自动外呼任务详情

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAutoCalloutTask。
Version String 公共参数,本接口取值:2020-02-10。
Region String 公共参数,此参数为可选参数。
SdkAppId Integer 应用 ID(必填),可以查看 https://console.cloud.tencent.com/ccc
示例值:1400000000
TaskId Integer 任务Id
示例值:3

3. 输出参数

参数名称 类型 描述
Name String 任务名
示例值:任务1
Description String 任务描述
示例值:任务描述
NotBefore Integer 任务起始时间戳
示例值:1729905740
NotAfter Integer 任务结束时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1729905750
Callers Array of String 主叫列表
示例值:["008610086"]
Callees Array of AutoCalloutTaskCalleeInfo 被叫信息列表
示例值:[{"State":1,"Callee":"foobar","Sessions":["foobar"]}]
IvrId Integer 任务使用的IvrId
示例值:2
State Integer 任务状态 0初始 1运行中 2已完成 3结束中 4已终止
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询任务

输入示例

POST / HTTP/1.1
Host: ccc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAutoCalloutTask
<公共请求参数>

{
    "SdkAppId": 1,
    "TaskId": 2
}

输出示例

{
    "Response": {
        "IvrId": 1,
        "Name": "foobar",
        "NotBefore": 1729905740,
        "NotAfter": 1729905750,
        "State": 1,
        "Callers": [
            "008610086"
        ],
        "RequestId": "foobar",
        "Callees": [
            {
                "State": 1,
                "Callee": "foobar",
                "Sessions": [
                    "foobar"
                ]
            }
        ],
        "Description": "foobar"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.DBError 内部数据库访问失败。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。