DescribeJobGroup - 查询任务数据_智能外呼机器人(Outbound Bot)-阿里云帮助中心

查询智能外呼任务数据。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID	af81a389-91f0-4157-8d82-720edd02b66a
JobGroupId	string	是	任务 ID。	46a9ad0c-3e11-44da-a9a7-2c21bf5ce185
BriefTypes	array	否	过滤条件（历史参数，已废弃）。
	string	否	过滤条件，业务结果。	回访成功

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码。	200
Code	string	接口状态码。	OK
Message	string	接口提示信息。	Success
RequestId	string	请求 ID。	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	是否成功。	true
JobGroup	object	任务信息。
CreationTime	long	创建时间。	1578881227404
Status	string	任务状态。	Completed
JobGroupName	string	任务名称。	催收作业组
ScriptId	string	话术场景 ID。	49f00b0d-78ac-4d51-91de-a9e8e92b8470
JobGroupId	string	任务 ID。	46a9ad0c-3e11-44da-a9a7-2c21bf5ce185
ScenarioId	string	场景 ID（旧画布参数，新画布场景同 ScriptId）。	fce6c599-8ede-40e3-9f78-0928eda7b4e8
JobFilePath	string	任务名单上传后的 OSS Filekey	da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx
JobGroupDescription	string	任务描述。	催收作业组
JobDataParsingTaskId	string	任务名单解析操作 ID。	da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx
ScriptName	string	话术场景名称。	催收话术
ModifyTime	string	修改时间。	1578881227404
ScriptVersion	string	话术场景版本号。	49f00b0d-78ac-4d51-91de-a9e8e92b8470
CallingNumbers	array	主叫号码列表。
	string	主叫号码列表。	["1****6"]
ExportProgress	object	导出进度
Status	string	导出状态	FINISHED
FileHttpUrl	string	文件地址	https://oss-cn-shanghai.aliyuncs.com/xx.zip
Progress	string	导出进度	1
Progress	object	任务进展情况。
TotalNotAnswered	integer	到当前时间为止未接通作业数量。	1
Status	string	任务整体执行状况。	Executing
StartTime	long	开始执行的时间。	1578881227404
Failed	integer	失败的作业数量。	0
Executing	integer	执行中的作业数量。	2
TotalJobs	integer	总作业数量	10
TotalCompleted	integer	总计完成的作业数量	2
Duration	integer	任务执行时间。	1000
Scheduling	integer	调度中的作业数量	5
Paused	integer	暂停的作业数量	0
Cancelled	integer	取消的作业数量	0
Briefs	array<object>	业务结果信息
	object
Key	string	业务结果名字	score
Value	string	业务结果值	5
Categories	array<object>	key vaule 形式的统计信息
	object
Key	string	自定义的统计信息字段名字	success
Value	string	自定义的统计信息值	10
Strategy	object	作业的执行策略
Type	string	策略类型	Repeatable
StrategyName	string	策略名字	催收策略名字
MaxAttemptsPerDay	integer	未接通情况下每日最大呼叫次数	2
FollowUpStrategy	string	执行周期结束后的处理方式（历史参数，已不再使用）。	NONE
EndTime	long	调度策略的总结束时间	1579881227404
Customized	string	策略的自定义数据（历史参数，已不再使用）。	{}
IsTemplate	boolean	是否是模版	false
StartTime	long	策略总的开始时间	1578881227404
StrategyId	string	策略 ID	a2bff22c-2604-4df2-83d6-5952e2438c5a
RoutingStrategy	string	号码路由策略	LocalFirst
MinAttemptInterval	integer	重新拨打的间隔时间	10
StrategyDescription	string	策略描述	催收策略
RepeatBy	string	作业重复方式	Once
WorkingTime	array<object>	工作时间段
	object
EndTime	string	开始时间	12:00:00
BeginTime	string	结束时间	09:00:00
RepeatDays	array	重复执行的日期，和 RepeatBy 结合使用。若重复周期为“周”，0 表示周日，1-6 分别表示周一至周六。若重复周期为“月”，1-31 分别表示 1 至 31 日，没有该指定日期的月份不执行，如：若选定 30 日，二月份不执行。
	string	重复执行的天	[1,2,3,4,5]
Repeatable	boolean	是否为循环任务	false
RecallStrategy	object	重呼策略
EmptyNumberIgnore	boolean	空号不再外呼	false
InArrearsIgnore	boolean	欠费不再外呼	false
OutOfServiceIgnore	boolean	停机不再外呼	false
Result	object	统计信息（历史参数，已不再提供）
TimeoutHangupNum	integer	超时挂机数量	1
FinishedNum	integer	完成数量	1
NoInteractNum	integer	没有交互数量	1
ClientHangupNum	integer	客户挂机数量	1
UnrecognizedNum	integer	拒识数量	1
RingingDuration	long	振铃时长	30
Priority	string	优先级	1
MinConcurrency	long	最小并发	1
FlashSmsExtras	object	闪信推送的配置参数，JSON 格式，包含第三方闪信的配置信息。
ConfigId	string	闪信配置 ID。	bebe23e6e2604f50bbeb12900c07703d
TemplateId	string	闪信模板 ID。	e080d737-5c0b-4350-b7d4-1162530579e7
RecallCallingNumbers	array
	string	重呼主叫号码列表	["1****6"]

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "JobGroup": {
    "CreationTime": 1578881227404,
    "Status": "Completed",
    "JobGroupName": "催收作业组",
    "ScriptId": "49f00b0d-78ac-4d51-91de-a9e8e92b8470",
    "JobGroupId": "46a9ad0c-3e11-44da-a9a7-2c21bf5ce185",
    "ScenarioId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
    "JobFilePath": "da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx",
    "JobGroupDescription": "催收作业组",
    "JobDataParsingTaskId": "da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx",
    "ScriptName": "催收话术",
    "ModifyTime": "1578881227404",
    "ScriptVersion": "49f00b0d-78ac-4d51-91de-a9e8e92b8470",
    "CallingNumbers": [
      "[\"1****6\"]"
    ],
    "ExportProgress": {
      "Status": "FINISHED",
      "FileHttpUrl": "https://oss-cn-shanghai.aliyuncs.com/xx.zip",
      "Progress": "1"
    },
    "Progress": {
      "TotalNotAnswered": 1,
      "Status": "Executing",
      "StartTime": 1578881227404,
      "Failed": 0,
      "Executing": 2,
      "TotalJobs": 10,
      "TotalCompleted": 2,
      "Duration": 1000,
      "Scheduling": 5,
      "Paused": 0,
      "Cancelled": 0,
      "Briefs": [
        {
          "Key": "score",
          "Value": "5"
        }
      ],
      "Categories": [
        {
          "Key": "success",
          "Value": "10"
        }
      ]
    },
    "Strategy": {
      "Type": "Repeatable",
      "StrategyName": "催收策略名字",
      "MaxAttemptsPerDay": 2,
      "FollowUpStrategy": "NONE",
      "EndTime": 1579881227404,
      "Customized": "{}",
      "IsTemplate": false,
      "StartTime": 1578881227404,
      "StrategyId": "a2bff22c-2604-4df2-83d6-5952e2438c5a",
      "RoutingStrategy": "LocalFirst",
      "MinAttemptInterval": 10,
      "StrategyDescription": "催收策略",
      "RepeatBy": "Once",
      "WorkingTime": [
        {
          "EndTime": "12:00:00",
          "BeginTime": "09:00:00"
        }
      ],
      "RepeatDays": [
        "[1,2,3,4,5]"
      ],
      "Repeatable": false
    },
    "RecallStrategy": {
      "EmptyNumberIgnore": false,
      "InArrearsIgnore": false,
      "OutOfServiceIgnore": false
    },
    "Result": {
      "TimeoutHangupNum": 1,
      "FinishedNum": 1,
      "NoInteractNum": 1,
      "ClientHangupNum": 1,
      "UnrecognizedNum": 1
    },
    "RingingDuration": 30,
    "Priority": "1",
    "MinConcurrency": 1,
    "FlashSmsExtras": {
      "ConfigId": "bebe23e6e2604f50bbeb12900c07703d",
      "TemplateId": "e080d737-5c0b-4350-b7d4-1162530579e7"
    },
    "RecallCallingNumbers": [
      "[\"1****6\"]"
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	NotExist.Instance	The specified Instance does not exist.	指定的实例不存在。
404	NotExist.JobGroup	The specified JobGroup does not exist.	指定的任务组不存在。
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.	内部错误。建议重试，如果多次重试报错请提交工单。

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

变更历史

变更时间	变更内容概要	操作
2024-07-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-06-24	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-04	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情