CloudGetTask - 获取呼叫任务信息

更新时间:
复制 MD 格式

根据任务Id,获取单个任务的配置信息。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

EnterpriseId

integer

是

呼叫中心 id

7000002

TaskId

integer

是

外呼任务 Id

31

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

本组参数已弃用,请忽略。

None

RequestId

string

请求 ID。

7BF47617-7851-48F7-A3A1-2021342A78E2

Message

string

响应信息。

OK

Data

object

返回数据。

TaskProperty

object

任务配置信息

CallVariables

string

座席通道变量,JsonArray 格式[{"key1":"value1"},{"key2":"value2"}]

[{"key1":"value1"},{"key2":"value2"}]

OverTime

string

任务结束时间

example

AdjustStep

string

adjustStep

5

CustomerClidType

string

客户侧外显规则,1.随机 2.按区号

2

CustomerVoice

string

客户侧提示音

example

EnterpriseId

string

企业编号

7000002

Name

string

任务名称

name1

Cnos

string

座席工号列表

111,222

CurlRetryTimes

string

已废弃。推送重试次数 最大 5 次

5

CallbackUrl

string

已废弃。给企业推送任务状态的 URL 地址

deprecated

Concurrency

string

最大并发限制

0

StatusDescription

string

任务状态描述

可用座席数小于1

CustomerClids

string

客户侧外显号码列表

""

AutoComplete

string

自动完成,0.关闭 1.开启

0

AutoStart

string

定时开始,0.关闭 1.开启

0

CustomerClidWeightFlag

string

外显号码比例配置开关,0.关闭 1.开启

0

Status

string

任务状态,0.初始 1.运行中 2.暂停 3.结束

3

PauseTime

string

任务暂停时间点

格式:yyyy-MM-dd HH:mm:ss。

2026-04-14 16:51:11

AutoStartDay

string

定时开始日期,格式:yyyy-MM-dd,如:2017-02-11

2026-02-11

ClidProperty

string

外显规则,Json 格式,外显号码选择规则:默认区号,是否匹配省会等;如:{"defaultAreaCode":"010", "isMatchCapital":"1"}

{"defaultAreaCode":"010", "isMatchCapital":"1"}

RetryStrategyOnlyToday

string

重试仅当天生效,0.关闭 1.开启,删除待重试的数据和待呼叫的数据 2.开启,删除待重试的数据 3.开启,删除待呼叫的数据

0

WarmUpDuration

string

任务预热时间,单位秒

300

PredictAdjust

string

超呼率

100

StartTime

string

任务开始时间

格式:yyyy-MM-dd HH:mm:ss。

2025-05-10 14:11:15

AutoTaskType

string

呼叫方式,0.连续呼叫 1.间隔呼叫

0

StandbyCnos

string

已废弃

deprecated

AutoStartTime

string

定时开始时间,格式:HH:mm:ss,如:08:00:00

08:00:00

IsRandom

string

随机呼叫,0.关闭 1.开启

0

ForceEndFlag

string

定时完成时强制结束任务。开启配置后,当任务到定时完成时间时无论任务中的号码是否已经呼完,均将任务状态设置为结束。适用于对数据有呼叫时间限制的场景。注:任务在结束状态时无法再次启动。

0

Id

string

外呼任务 Id

11059

Quotiety

string

骚扰率,支持小数,精确到小数点两位

3.0

AutoTriggerTimeStrategy

string

间隔呼叫时间段,呼叫的时间段配置。参数格式:时间条件编号。支持多个,多个使用英文","逗号隔开,如:9,22。

9,22

RetryStrategy

string

重试策略,「基础模式」数据结构为 Json 格式{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}格式说明:retry 是重试次数,round 是第几次重试,time 是第几次重试间隔的时间:1-1-1,第一个 1 是天,第二个 1 是小时,第三个 1 是分钟「高级模式」高级模式需要开启「号码状态识别」服务后。目前只支持「自动外呼」任务模式。数据结构为 JsonArray 格式 [{"condition":{"sipCause":[710,719]},"retry":1,"sort":1,"strategy":[{"round":1,"time":"0-0-10"}]},{"condition":{"sipCause":[800]},"retry":1,"sort":2,"strategy":[{"round":2,"time":"0-0-10"}]}]格式说明:condition 是重试条件,sort 是重试条件的顺序,其余字段与基础模式一致

{"retry":2,"strategy":[{"round":1,"time":"1-1-1"},{"round":2,"time":"2-2-2"}]}

CustomerTimeout

string

客户超时时间,单位秒

30

Description

string

任务描述

test

AutoStopDay

string

定时完成日期,格式:yyyy-MM-dd,如:2017-02-11

2026-02-11

TimeStrategy

string

禁止呼叫时间限制,在特定的时间段内禁止呼叫。参数格式:时间条件编号。支持多个,多个使用英文","逗号隔开,如:9,22。

9,22

CustomerClidWeight

string

外显号码比例配置内容,JsonArray 格式[{"number":"123,345","weight":"5"},{"number":"567,789","weight":"5"}]

[{"number":"123,345","weight":"5"},{"number":"567,789","weight":"5"}]

MinAvailableAgentCount

string

最小可用座席数

1

AgentTimeout

string

座席超时时间,单位秒

10

AnswerRate

string

初始化预计客户接通率

100

CustomerMoh

string

客户侧等待音

no

UserFields

string

任务自定义字段,JsonArray 格式[{"key1":"value1"},{"key2":"value2"}]

[{"key1":"value1"},{"key2":"value2"}]

ClidGroup

string

已废弃。热线号码组

deprecated

CreateTime

string

任务创建时间 ,格式为: yyyy-MM-dd HH:mm:ss

2025-05-10 14:07:22

OverCallLimitCnos

string

超过接听限制座席

""

PauseDuration

string

任务暂停时长(针对自动启动时间段) 单位分钟

0

AutoStop

string

定时完成,0.关闭 1.开启

0

Wrapup

string

座席整理时间,单位秒

30

MaxWaitTime

string

座席最大等待时间,单位秒

10

TaskFields

string

已废弃。任务级呼叫属性 json 格式{"key1":"value1","key2":"value2"},仅做呼叫控制用,不放通道变量

deprecated

Type

string

任务类型,1.预测外呼任务 2.自动外呼任务

1

AgentUtilization

string

已废弃。座席利用率

deprecated

IsRewarm

string

暂停后重新预热,0.关闭,1 开启

0

AutoStopTime

string

定时完成时间,格式:HH:mm:ss,如:17:00:00

17:00:00

CallLimitStrategy

string

座席当日接听数限制,JsonArray 格式[{"cnos":["2000","2001"],"limit":"5"}]

[{"cnos":["2000","2001"],"limit":"5"}]

CallStrategy

string

座席分配规则,1.随机 2.顺序 3.座席未进线最大时(从上一次呼叫结束到当前的总时长) 4.座席状态[空闲]最长时长(座席最近一次切换为空闲状态的持续时长)

2

IvrId

string

语音导航 Id

33

CustomerClidsCategory

string

客户侧外显号码类型,1.外显固话 2.外显手机号 4.外显号码池 5.外显导航

1

Code

string

状态码。返回 OK 代表请求成功,其他错误码详见错误码列表。

OK

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "RequestId": "7BF47617-7851-48F7-A3A1-2021342A78E2",
  "Message": "OK",
  "Data": {
    "TaskProperty": {
      "CallVariables": "[{\"key1\":\"value1\"},{\"key2\":\"value2\"}]",
      "OverTime": "example",
      "AdjustStep": "5",
      "CustomerClidType": "2",
      "CustomerVoice": "example",
      "EnterpriseId": "7000002",
      "Name": "name1",
      "Cnos": "111,222",
      "CurlRetryTimes": "5",
      "CallbackUrl": "deprecated",
      "Concurrency": "0",
      "StatusDescription": "可用座席数小于1",
      "CustomerClids": "\"\"",
      "AutoComplete": "0",
      "AutoStart": "0",
      "CustomerClidWeightFlag": "0",
      "Status": "3",
      "PauseTime": "2026-04-14 16:51:11",
      "AutoStartDay": "2026-02-11",
      "ClidProperty": "{\"defaultAreaCode\":\"010\", \"isMatchCapital\":\"1\"}",
      "RetryStrategyOnlyToday": "0",
      "WarmUpDuration": "300",
      "PredictAdjust": "100",
      "StartTime": "2025-05-10 14:11:15",
      "AutoTaskType": "0",
      "StandbyCnos": "deprecated",
      "AutoStartTime": "08:00:00",
      "IsRandom": "0",
      "ForceEndFlag": "0",
      "Id": "11059",
      "Quotiety": "3.0",
      "AutoTriggerTimeStrategy": "9,22",
      "RetryStrategy": "{\"retry\":2,\"strategy\":[{\"round\":1,\"time\":\"1-1-1\"},{\"round\":2,\"time\":\"2-2-2\"}]}",
      "CustomerTimeout": "30",
      "Description": "test",
      "AutoStopDay": "2026-02-11",
      "TimeStrategy": "9,22",
      "CustomerClidWeight": "[{\"number\":\"123,345\",\"weight\":\"5\"},{\"number\":\"567,789\",\"weight\":\"5\"}]",
      "MinAvailableAgentCount": "1",
      "AgentTimeout": "10",
      "AnswerRate": "100",
      "CustomerMoh": "no",
      "UserFields": "[{\"key1\":\"value1\"},{\"key2\":\"value2\"}]",
      "ClidGroup": "deprecated",
      "CreateTime": "2025-05-10 14:07:22",
      "OverCallLimitCnos": "\"\"",
      "PauseDuration": "0",
      "AutoStop": "0",
      "Wrapup": "30",
      "MaxWaitTime": "10",
      "TaskFields": "deprecated",
      "Type": "1",
      "AgentUtilization": "deprecated",
      "IsRewarm": "0",
      "AutoStopTime": "17:00:00",
      "CallLimitStrategy": "[{\"cnos\":[\"2000\",\"2001\"],\"limit\":\"5\"}]",
      "CallStrategy": "2",
      "IvrId": "33",
      "CustomerClidsCategory": "1"
    }
  },
  "Code": "OK"
}

错误码

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

变更历史

更多信息,参考变更详情。