调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
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 | 否 | 通话状态 | Succeeded |
JobFailureReasonsFilter | string | 否 | 作业失败原因列表 枚举值:
| ["NoAnswer"] |
返回参数
示例
正常返回示例
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": "无"
}
]
}
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-02-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2021-11-24 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |