根据任务结果查询任务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
outboundbot:QueryJobsWithResult |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PageNumber |
integer |
否 |
页数 重要 该参数必填 |
1 |
| PageSize |
integer |
否 |
分页大小 重要 该参数必填 |
10 |
| JobGroupId |
string |
是 |
任务组 ID |
ad16fc35-d824-4102-a606-2be51c1aa6dd |
| QueryText |
string |
否 |
搜索内容,可以根据号码进行搜索 |
1882020**** |
| JobStatusFilter |
string |
否 |
作业状态筛选
|
Succeeded |
| HasAnsweredFilter |
boolean |
否 |
是否接通 |
true |
| HasHangUpByRejectionFilter |
boolean |
否 |
是否拒识挂机 |
false |
| HasReachedEndOfFlowFilter |
boolean |
否 |
是否完结 |
true |
| InstanceId |
string |
是 |
实例 ID |
9d53cd72-4050-4419-8c17-acc0bf158147 |
| TaskStatusFilter |
string |
否 |
通话状态,["Executing","Succeeded"],多个以英文逗号分隔 取值范围 (注:Succeeded 状态已细分原因,不会展示 Succeeded:1(已接通)状态,之后返回均为具体细分原因类型。)
|
["Executing"] |
| JobFailureReasonsFilter |
string |
否 |
作业失败原因列表 枚举值:
|
["NoAnswer"] |
| StartActualTimeFilter |
integer |
否 |
通话开始时间过滤条件 |
1579055782000 |
| EndActualTimeFilter |
integer |
否 |
通话结束时间过滤条件 |
1579055783000 |
| LabelsJson |
array |
否 |
通话对应标签筛选条件 说明
该条件只能通过配置了具体枚举标签值的标签进行筛选,也就是在大模型场景中配置了具体标签值的标签。 |
|
|
string |
否 |
需要筛选的标签以及对应标签值。 说明
筛选出所有通话中特定标签以及对应的特定标签值。 如:{"ValueList":["满意","不满意"],"Name":"是否满意"},表示筛选出所有通话中“是否满意”标签对应的标签值为“满意”以及“不满意”的通话信息 |
{ "ValueList": [ "满意", "不满意" ], "Name": "是否满意" } |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果对象 |
||
| HttpStatusCode |
integer |
HTTP 状态码 |
200 |
| Code |
string |
Code |
OK |
| Message |
string |
接口提示消息 |
Success |
| RequestId |
string |
请求 ID |
9bdaa1d1-a036-4451-ab11-ca0373679091 |
| Success |
boolean |
是否成功 |
true |
| VariableNames |
array |
需收集的标签名称 |
|
|
string |
标签 key 全集 |
是否已经接通 |
|
| Jobs |
object |
作业 |
|
| PageNumber |
integer |
页数 |
1 |
| PageSize |
integer |
分页大小 |
10 |
| PageCount |
integer |
总页数 |
1 |
| RowCount |
integer |
总条数 |
1 |
| List |
array<object> |
作业列表 |
|
|
array<object> |
Job 对象 |
||
| Status |
string |
作业状态。
|
Succeeded |
| StatusName |
string |
作业状态名称 |
结束-已触达 |
| JobFailureReason |
string |
作业失败原因 |
- Unknown(未知错误) - NoAnswer(无人接听) - InvalidStrategy(无效的策略,策略配置不正确) - TimeUp(调度时发现超时) - NoStrategy(策略为空或没有找到) - CallFailed(呼叫失败) -PerDayCallCountLimit(号码每日呼叫次数限制) - ContactBlockList(禁止外呼名单) - EmptyNumber(空号不再外呼) - JobPerDayCallCountLimit(号码每日呼叫次数限制) - VerificationCancelled(呼叫前验证不通过取消) - ContactSuspended(止呼) - InArrears(欠费) - OutOfService(停机) - NoneRepeatableJobMaxAttemptCountLimit( 任务最大尝试次数, 当RepeatBy(@see )为None时生效) |
| Id |
string |
作业 ID |
cc231a1d-3c05-4739-8926-193ecf4097ba |
| LatestTask |
object |
最新通话 |
|
| Status |
string |
通话状态 |
Succeeded |
| TaskEndReason |
string |
通话结果 |
FINISHED |
| HasAnswered |
boolean |
是否接听 |
true |
| CallDuration |
integer |
通话时长 |
40000 |
| HasReachedEndOfFlow |
boolean |
是否完结 |
true |
| StatusName |
string |
通话状态名称 |
未呼出-超出每日上限 |
| CallTime |
integer |
通话时间 |
1615363297000 |
| CallDurationDisplay |
string |
通话时长 |
40 |
| HasHangUpByRejection |
boolean |
是否拒识挂机 |
false |
| Extras |
array<object> |
需收集的标签名称 |
|
|
object |
随路参数对象 |
||
| Key |
string |
标签 Key |
是否已经接通 |
| Value |
string |
标签 Value |
是 |
| TagHits |
array<object> |
标签命中信息【旧画布返回】 |
|
|
object |
标签命中对象【旧画布返回】 |
||
| TagName |
string |
标签名称 |
猫幼年期,猫幼年期 |
| TagGroup |
string |
标签所在标签组 |
动物 |
| Contact |
object |
联系人 |
|
| Round |
integer |
轮次 |
151 |
| JobUuid |
string |
作业 ID |
cc231a1d-3c05-4739-8926-193ecf4097ba |
| PreferredPhoneNumber |
string |
交流中被叫人自己指定的电话号码,填入后,会实际呼叫该号码。 说明
客户自定义,在接口调用执行外呼任务时方式时通过 json 方式传入 |
134123**** |
| PhoneNumber |
string |
联系人的电话号码 |
1882020**** |
| State |
string |
该联系人的状态, 比如正常(Available),号码错误(WrongNumber), 或者是空号(DoesNotExist)等 说明
客户自定义,在接口调用执行外呼任务时方式时通过 json 方式传入 |
Available |
| Honorific |
string |
对联系人的尊称,不填入默认与 name 相同 说明
客户自定义,在接口调用执行外呼任务时方式时通过 json 方式传入 |
张先生 |
| Name |
string |
联系人姓名,比如张三 |
张三 |
| Role |
string |
该联系人在此外呼业务中的角色,不指定则不区分。对于催收业务中,联系人的角色可以分为借款人,共同借款人,担保人等。 说明
客户自定义,在接口方式时通过 json 方式传入 |
借款人 |
| Id |
string |
联系人 ID,上传外呼名单时系统生成唯一标识 |
63860deb-6218-45df-b1e0-76f2b166e790 |
| ReferenceId |
string |
客户自己上传的联系人 ID,需要由业务方提供,这主要是避免重名现象。 |
C01 |
| HasLastPlaybackCompleted |
boolean |
挂断时是否完成播报 |
true |
| DialExceptionCodes |
array<object> |
通话异常码 |
|
|
object |
通话异常码 |
||
| Code |
string |
错误码 |
0 |
| Hint |
string |
错误提示信息 |
无 |
| HangUpDirection |
string |
被叫用户 |
|
| Labels |
array<object> |
可做筛选条件的标签信息。 说明
显示该任务组中所有具有枚举值的标签信息 |
|
|
object |
标签对象 |
||
| Name |
string |
标签名字 |
是否满意 |
| ValueList |
array |
标签值列表。 |
|
|
string |
标签值。 |
["否","是"] |
示例
正常返回示例
JSON格式
{
"HttpStatusCode": 200,
"Code": "OK",
"Message": "Success",
"RequestId": "9bdaa1d1-a036-4451-ab11-ca0373679091",
"Success": true,
"VariableNames": [
"是否已经接通"
],
"Jobs": {
"PageNumber": 1,
"PageSize": 10,
"PageCount": 1,
"RowCount": 1,
"List": [
{
"Status": "Succeeded",
"StatusName": "结束-已触达",
"JobFailureReason": "- Unknown(未知错误)\n- NoAnswer(无人接听)\n- InvalidStrategy(无效的策略,策略配置不正确)\n- TimeUp(调度时发现超时)\n- NoStrategy(策略为空或没有找到)\n- CallFailed(呼叫失败)\n-PerDayCallCountLimit(号码每日呼叫次数限制)\n- ContactBlockList(禁止外呼名单)\n- EmptyNumber(空号不再外呼)\n- JobPerDayCallCountLimit(号码每日呼叫次数限制)\n- VerificationCancelled(呼叫前验证不通过取消)\n- ContactSuspended(止呼)\n- InArrears(欠费)\n- OutOfService(停机)\n- NoneRepeatableJobMaxAttemptCountLimit( 任务最大尝试次数, 当RepeatBy(@see )为None时生效)",
"Id": "cc231a1d-3c05-4739-8926-193ecf4097ba",
"LatestTask": {
"Status": "Succeeded",
"TaskEndReason": "FINISHED",
"HasAnswered": true,
"CallDuration": 40000,
"HasReachedEndOfFlow": true,
"StatusName": "未呼出-超出每日上限",
"CallTime": 1615363297000,
"CallDurationDisplay": "40",
"HasHangUpByRejection": false,
"Extras": [
{
"Key": "是否已经接通",
"Value": "是"
}
],
"TagHits": [
{
"TagName": "猫幼年期,猫幼年期",
"TagGroup": "动物"
}
],
"Contact": {
"Round": 151,
"JobUuid": "cc231a1d-3c05-4739-8926-193ecf4097ba\n",
"PreferredPhoneNumber": "134123****",
"PhoneNumber": "1882020****",
"State": "Available",
"Honorific": "张先生",
"Name": "张三",
"Role": "借款人",
"Id": "63860deb-6218-45df-b1e0-76f2b166e790",
"ReferenceId": "C01"
},
"HasLastPlaybackCompleted": true,
"DialExceptionCodes": [
{
"Code": "0",
"Hint": "无"
}
],
"HangUpDirection": "被叫用户"
}
}
]
},
"Labels": [
{
"Name": "是否满意",
"ValueList": [
"[\"否\",\"是\"]"
]
}
]
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。