AI 助理
文档备案控制台
官方文档
首页 伶鹊 智能外呼机器人 开发参考 API参考 API目录 外呼任务管理 SearchTask - 搜索任务

SearchTask - 搜索任务

更新时间：
复制 MD 格式
产品详情
我的收藏

搜索任务。

调试

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

调试

授权信息

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

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

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:SearchTask

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
InstanceId

string

是

实例 ID

d481cebe-0bb6-4d13-9649-42ce5074fb75
TaskCreateTimeGte

integer

否

任务开始时间

说明

与任务结束时间参数 TaskCreateTimeLte 必须同时真实存在，不然会失效。

1646792941
TaskCreateTimeLte

integer

否

任务结束时间

说明

与任务开始时间参数 TaskCreateTimeGte 必须同时真实存在，不然会失效。

1646792941
JobGroupId

string

否

任务组 ID

3a30ae7c-27b2-4305-9444-7185ced9d51f
JobGroupNameQuery

string

否

作业组名字

国寿财住院保续保_20220301_134130
JobId

string

否

作业 ID

11994321-e6bc-47bb-8b1c-8eef8f2f768b
CalledNumber

string

否

被叫号码

15126426342
UserIdMatch

string

否

用户 ID，用户的唯一标识符号

说明

该字段是在上传外呼名单时传入的。

  • 若是通过 json 上传则用户 ID 为 referenceId 的值

  • 若是通过 excel 文件上传外呼名单则用户 ID 为 contactId 的值

C01
TaskId

string

否

任务 ID

744b27f3-437f-4a8c-a181-f668e492fd24
ActualTimeGte

integer

否

通话开始时间

1646582400000
ActualTimeLte

integer

否

通话结束时间

1643126399000
RecordingDurationGte

integer

否

振铃搜索最小时间

10
RecordingDurationLte

integer

否

振铃搜索最小时间

60
PageIndex

integer

否

页号

说明

此接口页号默认从 0 开始

2
PageSize

integer

否

个数

说明

当该参数为空时，值默认为 10

10
OtherId

string

否

其他 id

包括以下：

  • sessionID

  • taskid

  • jobid

AVD-2021-39685
SortBy

string

否

排序方式，默认为 actualTime

actualTime
SortOrder

string

否

排序顺序。取值范围：

  • asc（升序）

  • desc（默认值）：降序

desc
CallDurationGte

integer

否

通话时长搜索最小时间，单位毫秒

12341155
CallDurationLte

integer

否

通话时长搜索最大时间，单位毫秒

12341155
JobStatusStringList

string

否

作业状态，多个以英文逗号分隔，当该字段不为空时，会将 jobStatusList 覆盖

  • Scheduling：调度中。

  • Executing：执行中。

  • Succeeded：结束-已触达。

  • Paused：已停止。

  • Failed：结束-未触达。

  • Cancelled：已取消。

Succeeded
TaskStatusStringList

string

否

通话状态，多个以英文逗号分隔， 取值范围 （注：Succeeded 状态已细分原因，不会展示 Succeeded：1（已接通）状态，之后返回均为具体细分原因类型。）

  • Executing：0（正在拨打）。

  • Succeeded：1（已接通）。

  • NoAnswer：2（未接通-无人接听）。

  • NotExist：3（未接通-空号）。

  • Busy：4（未接通-占线）。

  • Cancelled：5（未呼出-任务停止）。

  • Failed：6（失败）。

  • NotConnected：7（未接通-无法接通）。

  • PoweredOff：8（未接通-关机）。

  • OutOfService：9（未接通-被叫停机）。

  • InArrears：10（未接通-被叫欠费）。

  • EmptyNumber：11（未呼出-空号不外呼）。

  • PerDayCallCountLimit：12（未呼出-超出每日上限）。

  • ContactBlockList：13（未呼出-黑名单）。

  • CallerNotRegistered：14（未呼出-主叫号码未注册）。

  • Terminated：15（未呼出-被终止）。

  • VerificationCancelled：16（未呼出-呼叫前验证不通过取消）。

  • OutOfServiceNoCall：17（未呼出-被叫停机不外呼）。

  • InArrearsNoCall：18（未呼出-被叫欠费不外呼）。

  • CallingNumberNotExist：19（未呼出-主叫号码不存在）。

  • SucceededFinish：20（已接通-正常完结）。

  • SucceededChatbotHangUpAfterNoAnswer：21（已接通-拒识后机器人挂机）。

  • SucceededChatbotHangUpAfterSilence：22（已接通-静默超时挂机）。

  • SucceededClientHangUpAfterNoAnswer：23（已接通-拒识后用户挂机）。

  • SucceededClientHangUp：24（已接通-用户无理由挂机）。

  • SucceededTransferByIntent：25（已接通-命中意图转人工）。

  • SucceededTransferAfterNoAnswer：26（已接通-拒识转人工）。

  • SucceededInoInterAction：27（已接通-用户侧无交互）。

  • SucceededError：28（已接通-系统异常中断）。

  • SucceededSpecialInterceptVoiceAssistant：29（已接通-特殊情况拦截-语音助手）。

  • SucceededSpecialInterceptExtensionNumberTransfer：30（已接通-特殊情况拦截-分机号转接）。

  • SucceededSpecialInterceptCustomSpecialIntercept：31（已接通-特殊情况拦截-自定义拦截）。

  • HighRiskSipCode：32（未呼出-高风险不外呼）

Executing
ScriptNameQuery

string

否

场景名称

国寿财
CallingNumber

string

否

主叫号码

051085500215
LabelsJson

array

否

通话对应标签筛选条件

说明

该条件只能通过配置了具体枚举标签值的标签进行筛选，也就是在大模型场景中配置了具体标签值的标签。

string

否

需要筛选的标签以及对应标签值。

说明

筛选出所有通话中特定标签以及对应的特定标签值。 如：{"ValueList":["满意","不满意"],"Name":"是否满意"}，表示筛选出所有通话中“是否满意”标签对应的标签值为“满意”以及“不满意”的通话信息

{ "ValueList": [ "满意", "不满意" ], "Name": "是否满意" }

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 状态码

200
PageIndex

integer

页号

0
RequestId

string

请求 ID

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

boolean

是否成功

true
Code

string

请求状态码

OK
Message

string

接口提示信息

Success
PageSize

integer

个数

10
Total

integer

总计个数

2
SearchTaskInfoList

array<object>

任务列表

[]

array<object>

任务列表

JobGroupName

string

作业组名字

85成新（有笔记划线）2021_11_14_18_00_51
UserId

string

用户 ID

12334134
ActualTime

integer

实际执行时间

1643436089677
CalledNumber

string

被叫号码

15205879599
TaskStatusString

string

任务状态 取值范围 （注：Succeeded 状态已细分原因，不会展示 Succeeded：1（已接通）状态，之后返回均为具体细分原因类型。）

  • Executing：0（正在拨打）。

  • Succeeded：1（已接通）。

  • NoAnswer：2（未接通-无人接听）。

  • NotExist：3（未接通-空号）。

  • Busy：4（未接通-占线）。

  • Cancelled：5（未呼出-任务停止）。

  • Failed：6（失败）。

  • NotConnected：7（未接通-无法接通）。

  • PoweredOff：8（未接通-关机）。

  • OutOfService：9（未接通-被叫停机）。

  • InArrears：10（未接通-被叫欠费）。

  • EmptyNumber：11（未呼出-空号不外呼）。

  • PerDayCallCountLimit：12（未呼出-超出每日上限）。

  • ContactBlockList：13（未呼出-黑名单）。

  • CallerNotRegistered：14（未呼出-主叫号码未注册）。

  • Terminated：15（未呼出-被终止）。

  • VerificationCancelled：16（未呼出-呼叫前验证不通过取消）。

  • OutOfServiceNoCall：17（未呼出-被叫停机不外呼）。

  • InArrearsNoCall：18（未呼出-被叫欠费不外呼）。

  • CallingNumberNotExist：19（未呼出-主叫号码不存在）。

  • SucceededFinish：20（已接通-正常完结）。

  • SucceededChatbotHangUpAfterNoAnswer：21（已接通-拒识后机器人挂机）。

  • SucceededChatbotHangUpAfterSilence：22（已接通-静默超时挂机）。

  • SucceededClientHangUpAfterNoAnswer：23（已接通-拒识后用户挂机）。

  • SucceededClientHangUp：24（已接通-用户无理由挂机）。

  • SucceededTransferByIntent：25（已接通-命中意图转人工）。

  • SucceededTransferAfterNoAnswer：26（已接通-拒识转人工）。

  • SucceededInoInterAction：27（已接通-用户侧无交互）。

  • SucceededError：28（已接通-系统异常中断）。

  • SucceededSpecialInterceptVoiceAssistant：29（已接通-特殊情况拦截-语音助手）。

  • SucceededSpecialInterceptExtensionNumberTransfer：30（已接通-特殊情况拦截-分机号转接）。

  • SucceededSpecialInterceptCustomSpecialIntercept：31（已接通-特殊情况拦截-自定义拦截）。

  • HighRiskSipCode：32（未呼出-高风险不外呼）。

Executing
TaskStatusName

string

通话状态展示内容 取值范围 （注：Succeeded 状态已细分原因，不会展示 Succeeded：1（已接通）状态，之后返回均为具体细分原因类型。）

  • Executing：0（正在拨打）。

  • Succeeded：1（已接通）。

  • NoAnswer：2（未接通-无人接听）。

  • NotExist：3（未接通-空号）。

  • Busy：4（未接通-占线）。

  • Cancelled：5（未呼出-任务停止）。

  • Failed：6（失败）。

  • NotConnected：7（未接通-无法接通）。

  • PoweredOff：8（未接通-关机）。

  • OutOfService：9（未接通-被叫停机）。

  • InArrears：10（未接通-被叫欠费）。

  • EmptyNumber：11（未呼出-空号不外呼）。

  • PerDayCallCountLimit：12（未呼出-超出每日上限）。

  • ContactBlockList：13（未呼出-黑名单）。

  • CallerNotRegistered：14（未呼出-主叫号码未注册）。

  • Terminated：15（未呼出-被终止）。

  • VerificationCancelled：16（未呼出-呼叫前验证不通过取消）。

  • OutOfServiceNoCall：17（未呼出-被叫停机不外呼）。

  • InArrearsNoCall：18（未呼出-被叫欠费不外呼）。

  • CallingNumberNotExist：19（未呼出-主叫号码不存在）。

  • SucceededFinish：20（已接通-正常完结）。

  • SucceededChatbotHangUpAfterNoAnswer：21（已接通-拒识后机器人挂机）。

  • SucceededChatbotHangUpAfterSilence：22（已接通-静默超时挂机）。

  • SucceededClientHangUpAfterNoAnswer：23（已接通-拒识后用户挂机）。

  • SucceededClientHangUp：24（已接通-用户无理由挂机）。

  • SucceededTransferByIntent：25（已接通-命中意图转人工）。

  • SucceededTransferAfterNoAnswer：26（已接通-拒识转人工）。

  • SucceededInoInterAction：27（已接通-用户侧无交互）。

  • SucceededError：28（已接通-系统异常中断）。

  • SucceededSpecialInterceptVoiceAssistant：29（已接通-特殊情况拦截-语音助手）。

  • SucceededSpecialInterceptExtensionNumberTransfer：30（已接通-特殊情况拦截-分机号转接）。

正在拨打
JobStatus

integer

作业状态

  • 0：调度中（Scheduling）

  • 1：执行中（Executing）

  • 2：结束-已触达（Succeeded）

  • 3：已停止（Paused）

  • 4：未接通-占线（Failed）

  • 5：已取消（Cancelled）

0
DialException

string

异常情况

[{"code":"OutboundCallError.SipCodeError", "params":[{"key":"SipCode","value":"500"}]}]
UserName

string

用户名

xxx
CallDurationDisplay

string

通话时长

47″
HasAnswered

boolean

有无应答

true
JobStatusName

string

作业状态展示内容

  • 0：调度中（Scheduling）

  • 1：执行中（Executing）

  • 2：结束-已触达（Succeeded）

  • 3：已停止（Paused）

  • 4：未接通-占线（Failed）

  • 5：已取消（Cancelled）

调度中
CallDuration

integer

通话时长，单位毫秒。

46000
TaskCreateTime

integer

任务创建时间

1646792941
JobStatusString

string

任务状态

  • Scheduling：调度中（0）

  • Executing：执行中（1）

  • Succeeded：结束-已触达（2）

  • Paused：已停止（3）

  • Failed：未接通-占线（4）

  • Cancelled：已取消（5）

Scheduling
HasReachedEndOfFlow

boolean

对话完成

true
InstanceId

string

实例 ID

73df6283-26b2-402d-bad0-ffa489923ea1
HasHangUpByRejection

boolean

拒识挂机

true
TaskEndReason

integer

任务结束原因

  • FINISHED(1,"正常完结"),

  • CHATBOT_HANGUP_AFTER_NOANSWER(2, "拒识后机器人挂机"),

  • CHATBOT_HANGUP_AFTER_SILENCE(3, "静默超时挂机"),

  • CLIENT_HANGUP_AFTER_NOANSWER(4, "拒识后用户挂机"),

  • CLIENT_HANGUP(5, "用户无理由挂机"),

  • TRANSFER_BY_INTENT(6, "命中意图转人工"),

  • TRANSFER_AFTER_NOANSWER(7, "拒识转人工"),

  • INO_INTERACTION(8, "用户侧无交互"),

  • ERROR(9, "系统异常中断"),

  • SPECIAL_INTERCEPT_VOICE_ASSISTANT(10, "特殊情况拦截-语音助手"),

  • SPECIAL_INTERCEPT_EXTENSION_NUMBER_TRANSFER(11, "特殊情况拦截-分机号转接"), ;

OutOfService
JobGroupId

string

作业组 ID

37db3113-ad34-4ba3-b930-468f016bbf95
TaskStatus

integer

取值范围 （注：Succeeded 状态已细分原因，不会展示 Succeeded：1（已接通）状态，之后返回均为具体细分原因类型。）

  • Executing：0（正在拨打）。

  • Succeeded：1（已接通）。

  • NoAnswer：2（未接通-无人接听）。

  • NotExist：3（未接通-空号）。

  • Busy：4（未接通-占线）。

  • Cancelled：5（未呼出-任务停止）。

  • Failed：6（失败）。

  • NotConnected：7（未接通-无法接通）。

  • PoweredOff：8（未接通-关机）。

  • OutOfService：9（未接通-被叫停机）。

  • InArrears：10（未接通-被叫欠费）。

  • EmptyNumber：11（未呼出-空号不外呼）。

  • PerDayCallCountLimit：12（未呼出-超出每日上限）。

  • ContactBlockList：13（未呼出-黑名单）。

  • CallerNotRegistered：14（未呼出-主叫号码未注册）。

  • Terminated：15（未呼出-被终止）。

  • VerificationCancelled：16（未呼出-呼叫前验证不通过取消）。

  • OutOfServiceNoCall：17（未呼出-被叫停机不外呼）。

  • InArrearsNoCall：18（未呼出-被叫欠费不外呼）。

  • CallingNumberNotExist：19（未呼出-主叫号码不存在）。

  • SucceededFinish：20（已接通-正常完结）。

  • SucceededChatbotHangUpAfterNoAnswer：21（已接通-拒识后机器人挂机）。

  • SucceededChatbotHangUpAfterSilence：22（已接通-静默超时挂机）。

  • SucceededClientHangUpAfterNoAnswer：23（已接通-拒识后用户挂机）。

  • SucceededClientHangUp：24（已接通-用户无理由挂机）。

  • SucceededTransferByIntent：25（已接通-命中意图转人工）。

  • SucceededTransferAfterNoAnswer：26（已接通-拒识转人工）。

  • SucceededInoInterAction：27（已接通-用户侧无交互）。

  • SucceededError：28（已接通-系统异常中断）。

  • SucceededSpecialInterceptVoiceAssistant：29（已接通-特殊情况拦截-语音助手）。

  • SucceededSpecialInterceptExtensionNumberTransfer：30（已接通-特殊情况拦截-分机号转接）。

0
JobId

string

作业 ID

6203248e-e652-4ef8-a1eb-586ed7b54dc2
RecordingDuration

integer

振玲时长，单位秒。

10
TaskId

string

任务 ID

479aea04-3a92-4ac3-935d-c8798c667850
DialExceptionOld

string

异常情况

["OutboundCallError.SipTrunkError"]
DialExceptionCodes

array

备注信息页面展示使用字段

string

接口异常码列表

[ { "code":"OutboundCallError.SipCodeError", "hint":"线路侧异常码:480, 首先确定主叫和被叫正确，其次再联系号码和线路的供应商处理!" } ]
HasLastPlaybackCompleted

boolean

挂断时最后一句是否播报完成

true
ScriptName

string

场景名称

慢病线索
CallingNumber

string

主叫号码

02152739269
Labels

array<object>

当前外呼通话的标签命中情况

object

K

string

标签名称

是否满意
V

string

命中的标签值

是
VariableNames

array

标签名称 key 的全集

string

标签 key 全集

["是否满意","是否是本人","是否收到"]
Labels

array<object>

可做筛选条件的标签信息。

说明

显示该任务组中所有具有枚举值的标签信息

object

Name

string

标签名称

是否满意
ValueList

array

标签值列表

string

标签值

["否","是"]

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "PageIndex": 0,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Code": "OK",
  "Message": "Success",
  "PageSize": 10,
  "Total": 2,
  "SearchTaskInfoList": [
    {
      "JobGroupName": "85成新（有笔记划线）2021_11_14_18_00_51",
      "UserId": "12334134",
      "ActualTime": 1643436089677,
      "CalledNumber": "15205879599",
      "TaskStatusString": "Executing",
      "TaskStatusName": "正在拨打",
      "JobStatus": 0,
      "DialException": "[{\"code\":\"OutboundCallError.SipCodeError\", \"params\":[{\"key\":\"SipCode\",\"value\":\"500\"}]}]",
      "UserName": "xxx",
      "CallDurationDisplay": "47″",
      "HasAnswered": true,
      "JobStatusName": "调度中",
      "CallDuration": 46000,
      "TaskCreateTime": 1646792941,
      "JobStatusString": "Scheduling",
      "HasReachedEndOfFlow": true,
      "InstanceId": "73df6283-26b2-402d-bad0-ffa489923ea1",
      "HasHangUpByRejection": true,
      "TaskEndReason": 0,
      "JobGroupId": "37db3113-ad34-4ba3-b930-468f016bbf95",
      "TaskStatus": 0,
      "JobId": "6203248e-e652-4ef8-a1eb-586ed7b54dc2",
      "RecordingDuration": 10,
      "TaskId": "479aea04-3a92-4ac3-935d-c8798c667850",
      "DialExceptionOld": "[\"OutboundCallError.SipTrunkError\"]",
      "DialExceptionCodes": [
        "[\t\t\t\t\t{\t\t\t\t\t\"code\":\"OutboundCallError.SipCodeError\",\t\t\t\t\t\"hint\":\"线路侧异常码:480, 首先确定主叫和被叫正确，其次再联系号码和线路的供应商处理!\"\t\t\t}\t\t\t\t]"
      ],
      "HasLastPlaybackCompleted": true,
      "ScriptName": "慢病线索",
      "CallingNumber": "02152739269",
      "Labels": [
        {
          "K": "是否满意",
          "V": "是"
        }
      ]
    }
  ],
  "VariableNames": [
    "[\"是否满意\",\"是否是本人\",\"是否收到\"]"
  ],
  "Labels": [
    {
      "Name": "是否满意",
      "ValueList": [
        "[\"否\",\"是\"]"
      ]
    }
  ]
}

错误码

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

变更历史

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

上一篇：GetPublicKey - 获取非对称加密公钥下一篇：QueryJobsWithResult - 根据任务结果查询任务