ListCallDetailRecordsV2 - 获取通话详情列表

更新时间:
复制 MD 格式

获取指定实例下指定搜索条件过滤后的通话详情列表。

接口说明

ListCallDetailRecordsV2 用来替代 ListCallDetailRecords 接口,后续新增字段和查询条件会在 ListCallDetailRecordsV2 持续优化。另外为了保证查询效率,返回数据中的 TotalCount 字段,只会在查询第一页时赋值,查询其他页时返回 0。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

分页序号,范围 1-100。

1

PageSize

integer

分页大小,范围 1-100。

100

StartTime

integer

获取的历史数据的起始时间,默认为当天的 0 时,格式为 Unix 时间戳,单位毫秒。

1657853640015

EndTime

integer

获取的历史数据的终止时间,默认为当前时间,格式为 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

按满意度列表过滤,多个满意度结果使用英文逗号隔开。

枚举值:

-2:未发送。

-1:未评价。

其他正数:自定义满意度评价数值。

["-1","3"] [">2"] ["<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"]

ReleaseInitiatorList

string

挂断方

[\"AGENT\"]

ReleaseReasonList

string

挂断原因

[\"VisitorInitiatedClosure\",\"AgentInitiatedClosure\"]

AnalyticsReportReady

boolean

AI 话后分析报告是否已完成

true

返回参数

名称

类型

描述

示例值

object

Code

string

响应码。

OK

HttpStatusCode

integer

HTTP 状态码

200

Message

string

响应信息。

RequestId

string

请求 ID。

01B12EE4-6AF2-4730-8B78-EC15F4E5C025

Data

object

数据。

PageNumber

integer

分页序号。

1

PageSize

integer

分页大小。

100

TotalCount

integer

总记录数。

10

List

array<object>

通话记录列表。

array<object>

通话记录。

ContactDisposition

string

通话结束原因,枚举列表见 ContactDispositionList 查询参数。

Success

ContactType

string

通话类型,枚举列表见 ContactTypeList 查询参数。

OUTBOUND

EstablishedTime

integer

通话建立的时间,如果通话没有建立,此值为空,格式为 Unix 时间戳,单位毫秒。

1532448000000

CalledNumber

string

被叫号码。

1332315****

AdditionalBroker

string

附加中间号码,双呼场景下可能用到。

0533128****

SatisfactionIndex

integer

满意度,即满意度按键数字(1 位数字)的值。

1

SatisfactionSurveyChannel

string

满意度调查渠道。

IVR

ReleaseTime

integer

通话结束时间,格式为 Unix 时间戳,单位毫秒。

1532707199000

WaitTime

integer

客户等待时长,即 QueueTime+RingTime,若客户等待期间放弃,则为 0,单位秒。

5

SkillGroupNames

string

参与通话的座席所属的技能组名称,多个技能组以英文逗号分隔。

测试技能组1,测试技能组2

IvrTime

integer

IVR 时长,即从开始进入 IVR 到开始进入转人工队列(或客户放弃)之间的时长,单位秒。

8

SatisfactionDescription

string

满意度描述,对应于满意度 IVR 中满意度模块的配置,客户自行定义。

满意

ReleaseInitiator

string

挂断方。

枚举值:

agent:坐席。

customer:客户。

customer

AgentIds

string

坐席 ID 列表,多个值用逗号分隔。

agent@ccc-test

CallDuration

string

通话时长,呼入从通话进入 IVR 开始计时,呼出从接通开始计时,单位秒。

16

RecordingReady

boolean

录音是否已经生成。若通话没有建立,则返回 false。

true

InstanceId

string

呼叫中心实例 ID。

ccc-test

RingTime

integer

振铃时长,即从坐席振铃到坐席接起(或客户放弃)之间的时长,单位秒。

5

SatisfactionSurveyOffered

boolean

是否发送了满意度。

true

AgentNames

string

通话涉及到的坐席名称列表,多个坐席之间使用英文逗号隔开。

云呼测试坐席

StartTime

integer

通话开始时间,内呼从进入 IVR 开始,外呼从拨号开始计算,格式为 Unix 字符串,单位毫秒。

1631440860000

ContactId

string

通话 ID。

job-2255019651513856

RecordingDuration

integer

录音时长,单位秒。

10

CallingNumber

string

主叫号码。

0533128****

QueueTime

integer

排队时长,即从开始进入转人工队列到坐席开始振铃(或客户放弃,队列超时,队列溢出)之间的时长,单位秒。

0

Broker

string

中间号码。

053xxxx3127

SkillGroupIds

string

参与通话的座席所属的技能组 ID,多个技能组以逗号分隔。

skg-default@ccc-test

CallerLocation

string

主叫归属地。

北京市-北京

CalleeLocation

string

被叫归属地。

山东省-济南

EarlyMediaState

string

早媒体状态。

NotConnected

ReleaseReason

string

话务通道的挂断原因,表示当前话务通道为什么会被挂断,取值来自 SIP 协议中定义的响应码,请客户参考 SIP 协议分析挂断原因。

486:USER_BUSY

DialingTime

integer

拨号时长,单位秒。

0

TalkTime

integer

通话时间,单位为秒

0

HeldTime

integer

保持时间,单位为秒

12

EarlyMediaText

string

早媒体文本。

正在通话中

OffSiteAgentIds

string

参与通话的场外坐席 ID 列表,多个坐席之间使用英文逗号隔开。

skg-default@ccc-test

OffsiteAgentDestinationNumbers

string

分配的坐席是场外坐席时,呼叫的场外坐席号码。

80312348

MessagesSent

integer

消息总量,MediaType 为 CHAT 时有值。

10

MessagesSentByCustomer

integer

客户发送消息总数,MediaType 为 CHAT 时有值。

5

MessagesSentByAgent

integer

坐席发送消息总数,MediaType 为 CHAT 时有值。

5

FirstResponseTime

integer

坐席首次回复客户消息花费的时长,MediaType 为 CHAT 时有值。

10

MediaType

string

媒体类型。

枚举列表:

AUDIO:语音。

CHAT:消息。

VIDEO:视频。

CHAT

TransferCount

integer

转接次数。

1

AccessChannelType

string

渠道类型,MediaType 为 CHAT 时有值。

Web

AccessChannelName

string

渠道名称,MediaType 为 CHAT 时有值。

测试渠道

AccessChannelUserId

string

访客 ID,MediaType 为 CHAT 时有值。

test-user-id

AccessChannelUserName

string

访客名称,MediaType 为 CHAT 时有值。

测试访客

ClientIpAddress

string

访客客户端地址,MediaType 为 CHAT 时有值。

10.100.2.1

ClientLocation

string

访客客户端归属地,MediaType 为 CHAT 时有值。

---

ClientUserAgent

string

访客客户端信息,MediaType 为 CHAT 时有值。

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

string

访客客户端名称,MediaType 为 CHAT 时有值。

未知

OffsiteAgentOriginatorNumbers

string

分配的坐席是场外坐席时,发起呼叫场外坐席的号码。

0101257****

CallIds

string

SIP 协议的 CallId 列表。

dxxx1sdf,xkkwwwa

AnalyticsReportReady

boolean

AI 话后分析报告是否完工。

true

AnalyticsReport

object

话后分析报告。

ProblemSolving

object

问题完结情况

TaskId

string

任务 Id。

8bf18b7a10064b29a75946a8d5b8469a

Success

boolean

是否调用成功。

  • true:调用成功。

  • false:调用失败。

false

Solved

boolean

是否解决。

true

Problem

string

问题描述。

告警问题

Solution

string

解决方案。

富化服务自动关闭原始告警

Emotion

object

情绪分析。

TaskId

string

任务 ID。

0ff07fe35670423089dbdf12766d962f

Success

boolean

是否调用成功。

  • true:调用成功。

  • false:调用失败。

true

Type

string

情绪类型。

中性

Confidence

integer

置信度。

50

Remark

string

情绪详细分析备注。

客户没情绪变化

Satisfaction

object

满意度分析。

TaskId

string

任务 ID

cb67479ce28243b28ff39948feaa0806

Success

boolean

是否调用成功。

  • true:调用成功。

  • false:调用失败。

true

SatisfactionDescription

string

满意度描述。

满意

Remark

string

满意度分析详情备注。

客户表示满意

TodoList

object

待办事情。

TaskId

string

任务 ID。

cb67479ce28243b28ff39948feaa0806

Success

boolean

是否调用成功。

  • true:调用成功。

  • false:调用失败。

true

Tasks

array

待办事项。

string

待办事项描述。

回访

OutsideNumberReleaseReason

string

转外线时挂断原因

NoAnswer

SummaryIndex

object

小结索引

Keywords

string

关键词

客服

VoicebotOriginatorNumber

string

从智能外呼转接过来时携带的外呼主叫号码

021xxxxxxx

VoicebotDestinationNumber

string

从智能外呼转接过来时携带的外呼被叫号码

134xxxxxx

OffsiteAgentReleaseReason

string

分配的最后一个场外坐席挂断原因

IVRException

OutsideNumberDestinationNumber

string

转外线的被叫号码

134xxxxxx

示例

正常返回示例

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": "dxxx1sdf,xkkwwwa",
        "AnalyticsReportReady": true,
        "AnalyticsReport": {
          "ProblemSolving": {
            "TaskId": "8bf18b7a10064b29a75946a8d5b8469a",
            "Success": false,
            "Solved": true,
            "Problem": "告警问题",
            "Solution": "富化服务自动关闭原始告警"
          },
          "Emotion": {
            "TaskId": "0ff07fe35670423089dbdf12766d962f",
            "Success": true,
            "Type": "中性",
            "Confidence": 50,
            "Remark": "客户没情绪变化"
          },
          "Satisfaction": {
            "TaskId": "cb67479ce28243b28ff39948feaa0806",
            "Success": true,
            "SatisfactionDescription": "满意",
            "Remark": "客户表示满意"
          },
          "TodoList": {
            "TaskId": "cb67479ce28243b28ff39948feaa0806",
            "Success": true,
            "Tasks": [
              "回访"
            ]
          }
        },
        "OutsideNumberReleaseReason": "NoAnswer",
        "SummaryIndex": {
          "Keywords": "客服"
        },
        "VoicebotOriginatorNumber": "021xxxxxxx",
        "VoicebotDestinationNumber": "134xxxxxx",
        "OffsiteAgentReleaseReason": "IVRException",
        "OutsideNumberDestinationNumber": "134xxxxxx"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 Parameter.Format The format of parameter %s is invalid. %s 该参数的格式不合法。
500 InternalService.Common An internal service error occurred. %s 内部服务错误。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情