調用ListCallDetailRecords獲取指定實例下指定搜索條件過濾后的通話詳情列表。接口不再迭代更新,建議優先使用ListCallDetailRecordsV2接口。
接口說明
為了保證查詢效率,返回數據中的 TotalCount 字段,只會在查詢第一頁時賦值,查詢其他頁時返回 0。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 是 | 分頁序號,范圍 1-100。 | 1 |
PageSize | integer | 是 | 分頁大小,范圍 1-100。 | 100 |
StartTime | long | 否 | 獲取的歷史數據的起始時間,默認為當天的 0 時,格式為 Unix 時間戳,單位毫秒。 | 1532448000000 |
EndTime | long | 否 | 獲取的歷史數據的終止時間,默認為當前時間,格式為 Unix 時間戳,單位毫秒。 | 1532707199000 |
ContactType | string | 否 | 按通話類型過濾。 枚舉值:
| Outbound |
ContactDisposition | string | 否 | 按掛斷類型過濾,注意:語音郵箱、轉人工失敗、排隊超時、排隊溢出、IVR 異常的掛斷原因需要客戶配置掛斷原因節點才能體現出來,如果沒有配置且 IVR 中無轉人工模塊,這時候的掛斷原因默認為 IVR 放棄。 枚舉值:
| Success |
ContactId | string | 否 | 通過指定的 contactId 來查詢某一通電話的記錄,contactId 可以通過軟電話 SDK 發生通話時獲取到。如果傳入該參數,則自動忽略其他查詢參數。 | job-12515239414412**** |
AgentId | string | 否 | 按坐席 ID 過濾。 | agent@ccc-test |
SkillGroupId | string | 否 | 按技能組 ID 過濾。 | skillgroup@ccc-test |
SortOrder | string | 否 | 排序方式,非必填,默認為降序。 枚舉值:
| DESC |
InstanceId | string | 是 | 實例 ID。 | ccc-test |
OrderByField | string | 否 | 排序字段,非必填,默認為 startTime(通話開始時間)。 枚舉值:
| startTime |
Criteria | string | 否 | 根據主叫或被叫號碼模糊查詢,格式為 JSON 字符串,僅包含一個字段 phoneNumber,填主叫或被叫號碼的全部或者一部分。 | {"phoneNumber":"0735"} |
CallingNumber | string | 否 | 按主叫號碼過濾。 | 07353988**** |
CalledNumber | string | 否 | 按被叫號碼過濾。 | 1320523**** |
SatisfactionList | string | 否 | 按滿意度列表過濾,多個滿意度結果使用英文逗號隔開。 | ["1","3"] |
SatisfactionSurveyChannel | string | 否 | 按滿意度調查渠道過濾。 枚舉值:
| IVR |
SatisfactionDescriptionList | string | 否 | 按滿意度描述列表過濾,描述內容由客戶自定義。 | ["滿意","一般"] |
EarlyMediaStateList | string | 否 | 按未接通原因列表過濾。 枚舉值:
| ["NotConnected","NoAnswer"] |
ContactDispositionList | string | 否 | 按掛斷原因列表過濾。 枚舉值:
| ["Success","NoAnswer"] |
ContactTypeList | string | 否 | 按通話類型列表過濾。 枚舉值:
| ["Internal","Inbound"] |
返回參數
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "無",
"RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
"Data": {
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 11,
"List": [
{
"ContactDisposition": "Success",
"ContactType": "Outbound",
"EstablishedTime": 1532448000000,
"CalledNumber": "1332315****",
"AdditionalBroker": "0533128****",
"SatisfactionIndex": 1,
"SatisfactionSurveyChannel": "IVR",
"ReleaseTime": 1532707199000,
"WaitTime": 5,
"SkillGroupNames": "測試技能組",
"IvrTime": 8,
"SatisfactionDescription": "滿意",
"ReleaseInitiator": "customer",
"AgentIds": "agent@ccc-test",
"CallDuration": "30",
"RecordingReady": true,
"InstanceId": "ccc-test",
"RingTime": 5,
"SatisfactionSurveyOffered": true,
"AgentNames": "坐席小王",
"StartTime": 1532448000000,
"ContactId": "job-12515239414412****",
"RecordingDuration": 10,
"CallingNumber": "0533128****",
"QueueTime": 0,
"Broker": "0533127****",
"SkillGroupIds": "skillgroup@ccc-test",
"CallerLocation": "北京市-北京",
"CalleeLocation": "山東省-濟南",
"EarlyMediaState": "NotConnected",
"ReleaseReason": "486:USER_BUSY",
"DialingTime": 0,
"TalkTime": 0,
"HeldTime": 12,
"CallIds": ""
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Parameter.Format | The format of parameter %s is invalid. %s | 該參數的格式不合法。 |
500 | InternalService.Common | An internal service error occurred. %s | 內部服務錯誤。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-07-29 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-10-09 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-03-20 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |