GetCampaign - 获取任务信息

更新时间:
复制 MD 格式

获取外呼活动详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:GetCampaign

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

外呼实例 ID

024f8cf0-c842-4c01-b74b-c8667e4579c7

CampaignId

string

外呼任务 ID。

6ac878ab-115b-4170-a5d8-547481273364

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 状态码

200

Code

string

结果码

OK

Message

string

错误信息

RequestId

string

请求 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC

Success

boolean

请求是否成功

true

Data

object

外呼活动详情

CampaignId

string

活动 ID

6ac878ab-115b-4170-a5d8-547481273364

Name

string

活动名称

满意度调研

State

string

活动状态

Completed

TotalCases

integer

case 总数

100

CasesAborted

integer

已终止的 case 数

0

CasesConnected

integer

已接通的 case 数

50

CasesUncompleted

integer

未完成的 case 数

0

CasesUncompletedAfterAttempted

integer

已尝试但未完成的 case 数

0

CompletedRate

number

完成率

0.5

MaxAttemptCount

integer

最大重试次数

2

MinAttemptInterval

integer

最小重试间隔

5

ScriptId

string

场景 ID。

d13ad2d3-3fe6-4352-b38b-bd6559047de8

PlannedStartTime

integer

计划开始时间

1634054400000

PlannedEndTime

integer

计划结束时间

1634054500000

ActualStartTime

integer

实际开始时间

1634054400000

ActualEndTime

integer

实际结束时间

1634054500000

CreatedTime

integer

创建时间

1735660800000

UpdatedTime

integer

更新时间

1735660800000

RunUntilEndTime

boolean

联系人均拨打完成时是否持续执行至活动结束时间

false

FixedQuota

integer

固定并发数

0

Weight

integer

活动权重

1

Numbers

array

主叫号码列表

string

主叫号码

01012345678

Params

array

错误信息参数列表

string

错误信息参数

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Data": {
    "CampaignId": "6ac878ab-115b-4170-a5d8-547481273364",
    "Name": "满意度调研",
    "State": "Completed",
    "TotalCases": 100,
    "CasesAborted": 0,
    "CasesConnected": 50,
    "CasesUncompleted": 0,
    "CasesUncompletedAfterAttempted": 0,
    "CompletedRate": 0.5,
    "MaxAttemptCount": 2,
    "MinAttemptInterval": 5,
    "ScriptId": "d13ad2d3-3fe6-4352-b38b-bd6559047de8",
    "PlannedStartTime": 1634054400000,
    "PlannedEndTime": 1634054500000,
    "ActualStartTime": 1634054400000,
    "ActualEndTime": 1634054500000,
    "CreatedTime": 1735660800000,
    "UpdatedTime": 1735660800000,
    "RunUntilEndTime": false,
    "FixedQuota": 0,
    "Weight": 1,
    "Numbers": [
      "01012345678"
    ]
  },
  "Params": [
    "无"
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情