調試
您可以在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 返回結構發生變更 | 查看變更詳情 |