获取指定实例下指定搜索条件过滤后的通话详情列表。
接口说明
ListCallDetailRecords 已废弃,用来替换 ListCallDetailRecords 接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 是 | 分页序号,范围 1-100。 | 1 |
PageSize | integer | 是 | 分页大小,范围 1-100。 | 100 |
StartTime | long | 否 | 获取的历史数据的起始时间,默认为当天的 0 时,格式为 Unix 时间戳,单位毫秒。 | 1657853640015 |
EndTime | long | 否 | 获取的历史数据的终止时间,默认为当前时间,格式为 Unix 时间戳,单位毫秒。 | 1657879880010 |
SortOrder | string | 否 | 排序方式,默认为降序。 枚举值: ASC:升序。 DESC:降序。 | DESC |
InstanceId | string | 是 | 呼叫中心实例 ID | ccc-test |
OrderByField | string | 否 | 排序字段,非必填,默认为 startTime(通话开始时间)。 枚举值: startTime:通话开始时间。 | startTime |
SearchPattern | string | 否 | 自定义查询文本,遵循 Lucene 查询语法。 支持查询字段和查询类型列表: accessChannelUserId: 访客 ID,支持精准查询和模糊查询。 accessChannelName: 渠道名称,支持精准查询和模糊查询。 text: 会话文本,支持模糊查询。 | text:请稍后 AND accessChannelUserId:af1a0-afaa-5086e2946e0b* AND accessChannelName:专属开发渠道* |
MediaType | string | 否 | 媒体类型。 枚举值: AUDIO:语音。 VIDEO:视频。 CHAT: 消息。 ALL: 所有。 | AUDIO |
ContactIdList | string | 否 | 通话 ID 列表。 | ["job-123456789","job-234567891"] |
ContactTypeList | string | 否 | 按通话类型列表过滤。 枚举值: OUTBOUND:呼出。 BACK2BACK:双呼。 PRIVACY_DIAL:加密通话。 INTERNAL:内部呼叫。 PREDICTIVE:预测式外呼。 INBOUND:呼入。 CONFERENCE:会议。 | ["INBOUND","OUTBOUND"] |
ContactDispositionList | string | 否 | 按挂断原因列表过滤。 枚举值: AbandonedInQueue:排队放弃。 NoAnswer:客户未接。 QueuingTimeout:排队超时。 Voicemail:转语音邮箱。 QueuingFailed:转人工失败。 QueuingOverflow:排队溢出。 AbandonedInVoiceNavigator:智能导航中放弃。 Success:正常结束。 IVRException:IVR 异常。 AbandonedInRing:振铃放弃。 AbandonedInIVR:IVR 放弃。 Reject:客户拒接。 ForwardToOutsideNumber:转外线。 | ["Success","NoAnswer"] |
EarlyMediaStateList | string | 否 | 按未接通原因列表过滤。 枚举值: NoAnswer:无人接听。 OutOfService:停机。 NotExist:空号。 Restricted:呼叫受限。 Busy:占线。 NotConnected:无法接通。 PowerOff:关机。 | ["NotConnected","NoAnswer"] |
SatisfactionSurveyChannel | string | 否 | 满意度调查渠道。 枚举值: IVR:语音满意度。 SMS:短信满意度。 CHAT: 消息满意度。 | IVR |
SatisfactionRateList | string | 否 | 按满意度列表过滤,多个满意度结果使用英文逗号隔开。 | ["1","3"] |
SatisfactionDescriptionList | string | 否 | 按满意度描述列表过滤,描述内容由客户自定义。 | ["满意","一般"] |
SkillGroupIdList | string | 否 | 坐席所属技能组 ID 列表。 | [ "skg1@ccc-test", "skg2@ccc-test" ] |
AgentId | string | 否 | 坐席 ID。 | agent@ccc-test |
FirstAgentId | string | 否 | 首个参与通话的坐席 ID。 | agent@ccc-test |
CallingNumber | string | 否 | 主叫号码。 | 191***9993 |
CalledNumber | string | 否 | 被叫号码。 | 191***9993 |
Number | string | 否 | 电话号码。 | 191***9993 |
Broker | string | 否 | 中间号码,需要是实例下可用的外呼号码,双呼时会使用该号码先后呼叫主叫和被叫。 | 021****4972 |
AccessChannelTypeList | string | 否 | 访客渠道类型列表。 枚举列表: Web: 网页。 DingTalkServiceWindow:钉钉服务窗。 AliMe:对话机器人。 DingTalkRobot:钉钉机器人。 | ["Web","AliMe"] |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "无",
"RequestId": "01B12EE4-6AF2-4730-8B78-EC15F4E5C025",
"Data": {
"PageNumber": 1,
"PageSize": 100,
"TotalCount": 10,
"List": [
{
"ContactDisposition": "Success",
"ContactType": "OUTBOUND",
"EstablishedTime": 1532448000000,
"CalledNumber": "1332315****",
"AdditionalBroker": "0533128****",
"SatisfactionIndex": 1,
"SatisfactionSurveyChannel": "IVR",
"ReleaseTime": 1532707199000,
"WaitTime": 5,
"SkillGroupNames": "测试技能组1,测试技能组2",
"IvrTime": 8,
"SatisfactionDescription": "满意",
"ReleaseInitiator": "customer",
"AgentIds": "agent@ccc-test",
"CallDuration": "16",
"RecordingReady": true,
"InstanceId": "ccc-test",
"RingTime": 5,
"SatisfactionSurveyOffered": true,
"AgentNames": "云呼测试坐席",
"StartTime": 1631440860000,
"ContactId": "job-2255019651513856",
"RecordingDuration": 10,
"CallingNumber": "0533128****",
"QueueTime": 0,
"Broker": "053xxxx3127",
"SkillGroupIds": "skg-default@ccc-test",
"CallerLocation": "北京市-北京",
"CalleeLocation": "山东省-济南",
"EarlyMediaState": "NotConnected",
"ReleaseReason": "486:USER_BUSY",
"DialingTime": 0,
"TalkTime": 0,
"HeldTime": 12,
"EarlyMediaText": "正在通话中",
"OffSiteAgentIds": "skg-default@ccc-test",
"OffsiteAgentDestinationNumbers": "80312348",
"MessagesSent": 10,
"MessagesSentByCustomer": 5,
"MessagesSentByAgent": 5,
"FirstResponseTime": 10,
"MediaType": "CHAT",
"TransferCount": 1,
"AccessChannelType": "Web",
"AccessChannelName": "测试渠道",
"AccessChannelUserId": "test-user-id",
"AccessChannelUserName": "测试访客",
"ClientIpAddress": "10.100.2.1",
"ClientLocation": "---",
"ClientUserAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36",
"ClientAppName": "未知",
"OffsiteAgentOriginatorNumbers": "0101257****",
"CallIds": "",
"AnalyticsReportReady": true,
"AnalyticsReport": {
"ProblemSolving": {
"TaskId": "",
"Success": true,
"Solved": true,
"Problem": "",
"Solution": ""
},
"Emotion": {
"TaskId": "",
"Success": true,
"Type": "",
"Confidence": 0,
"Remark": ""
},
"Satisfaction": {
"TaskId": "",
"Success": true,
"SatisfactionDescription": "",
"Remark": ""
},
"TodoList": {
"TaskId": "",
"Success": true,
"Tasks": [
""
]
}
}
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Parameter.Format | The format of parameter %s is invalid. %s | 该参数的格式不合法。 |
500 | InternalService.Common | An internal service error occurred. %s | 内部服务错误。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-06 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |