调用ListCallDetailRecords获取指定实例下指定搜索条件过滤后的通话详情列表。
接口说明
为了保证查询效率，返回数据中的TotalCount字段，只会在查询第一页时赋值，查询其他页时返回0。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageNumber | integer | 是 | 分页序号，范围1-100。 | 1 |
| PageSize | integer | 是 | 分页大小，范围1-100。 | 100 |
| StartTime | Long | 否 | 获取的历史数据的起始时间，默认为当天的0时，格式为Unix时间戳，单位毫秒。 | 1532448000000 |
| EndTime | Long | 否 | 获取的历史数据的终止时间，默认为当前时间，格式为Unix时间戳，单位毫秒。 | 1532707199000 |
| ContactType | string | 否 | 按通话类型过滤。 | Outbound 枚举值： - Outbound: 呼出 - Back2Back: 双呼 - PrivacyDial: 加密通话 - Internal: 内部呼叫 - Predictive: 预测式外呼 - Inbound: 呼入 - Conference: 会议 |
| ContactDisposition | string | 否 | 按挂断类型过滤，注意：语音邮箱、转人工失败、排队超时、排队溢出、IVR异常的挂断原因需要客户配置挂断原因节点才能体现出来，如果没有配置且IVR中无转人工模块，这时候的挂断原因默认为IVR放弃。 | Success 枚举值： - AbandonedInQueue: 排队放弃 - NoAnswer: 客户未接 - QueuingTimeout: 排队超时 - Voicemail: 转语音邮箱 - QueuingFailed: 转人工失败 - QueuingOverflow: 排队溢出 - Success: 正常结束 - IVRException: IVR异常 - AbandonedInRing: 振铃放弃 - AbandonedInIVR: IVR放弃 - Reject: 客户拒接 - ForwardToOutsideNumber: 转外线 |
| ContactId | string | 否 | 通过指定的contactId来查询某一通电话的记录，contactId可以通过软电话SDK发生通话时获取到。如果传入该参数，则自动忽略其他查询参数。 | job-12515239414412**** |
| AgentId | string | 否 | 按坐席ID过滤。 | agent@ccc-test |
| SkillGroupId | string | 否 | 按技能组ID过滤。 | skillgroup@ccc-test |
| SortOrder | string | 否 | 排序方式，非必填，默认为降序。 | DESC 枚举值： - ASC: 升序 - DESC: 降序 |
| InstanceId | string | 是 | 实例ID。 | ccc-test |
| OrderByField | string | 否 | 排序字段，非必填，默认为startTime（通话开始时间）。 | startTime 枚举值： - callDuration: 通话时长 - ringTime: 响铃时长 - talkTime: 通话时长 - dialingTime: 拨号时长 - startTime: 通话开始时间 - ivrTime: IVR时长 - queueTime: 排队时长 |
| Criteria | string | 否 | 根据主叫或被叫号码模糊查询，格式为JSON字符串，仅包含一个字段phoneNumber，填主叫或被叫号码的全部或者一部分。 | {"phoneNumber":"0735"} |
| CallingNumber | string | 否 | 按主叫号码过滤。 | 07353988**** |
| CalledNumber | string | 否 | 按被叫号码过滤。 | 1320523**** |
| SatisfactionList | string | 否 | 按满意度列表过滤，多个满意度结果使用英文逗号隔开。 | ["1","3"] |
| SatisfactionSurveyChannel | string | 否 | 按满意度调查渠道过滤。 | IVR 枚举值： - IVR: 语音满意度 - SMS: 短信满意度 |
| SatisfactionDescriptionList | string | 否 | 按满意度描述列表过滤，描述内容由客户自定义。 | ["满意","一般"] |
| EarlyMediaStateList | string | 否 | 按未接通原因列表过滤。 | ["NotConnected","NoAnswer"] 枚举值： - NoAnswer: 无人接听 - OutOfService: 停机 - NotExist: 空号 - Restricted: 呼叫受限 - Busy: 占线 - NotConnected: 无法接通 - PowerOff: 关机 |
| ContactDispositionList | string | 否 | 按挂断原因列表过滤。 | ["Success","NoAnswer"] 枚举值： - AbandonedInQueue: 排队放弃 - NoAnswer: 客户未接 - QueuingTimeout: 排队超时 - Voicemail: 转语音邮箱 - QueuingFailed: 转人工失败 - QueuingOverflow: 排队溢出 - Success: 正常结束 - IVRException: IVR异常 - AbandonedInRing: 振铃放弃 - AbandonedInIVR: IVR放弃 - Reject: 客户拒接 - ForwardToOutsideNumber: 转外线 |
| ContactTypeList | string | 否 | 按通话类型列表过滤。 | ["Internal","Inbound"] 枚举值： - Outbound: 呼出 - Back2Back: 双呼 - PrivacyDial: 加密通话 - Internal: 内部呼叫 - Predictive: 预测式外呼 - Inbound: 呼入 - Conference: 会议 |
返回参数
示例
正常返回示例
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"
}
]
}
}错误码
| Http code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Parameter.Format | The format of parameter %s is invalid. %s | 该参数的格式不合法。 |
| 500 | InternalService.Common | An internal service error occurred. %s | 内部服务错误。 |
访问错误中心查看更多错误码。