文档

ListCallDetailRecords - 获取通话详情列表

更新时间:

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

接口说明

为了保证查询效率,返回数据中的 TotalCount 字段,只会在查询第一页时赋值,查询其他页时返回 0。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

100
StartTimelong

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

1532448000000
EndTimelong

获取的历史数据的终止时间,默认为当前时间,格式为 Unix 时间戳,单位毫秒。

1532707199000
ContactTypestring

按通话类型过滤。

枚举值:
  • Outbound呼出
  • Back2Back双呼
  • PrivacyDial加密通话
  • Internal内部呼叫
  • Predictive预测式外呼
  • Inbound呼入
  • Conference会议
Outbound
ContactDispositionstring

按挂断类型过滤,注意:语音邮箱、转人工失败、排队超时、排队溢出、IVR 异常的挂断原因需要客户配置挂断原因节点才能体现出来,如果没有配置且 IVR 中无转人工模块,这时候的挂断原因默认为 IVR 放弃。

枚举值:
  • AbandonedInQueue排队放弃
  • NoAnswer客户未接
  • QueuingTimeout排队超时
  • Voicemail转语音邮箱
  • QueuingFailed转人工失败
  • QueuingOverflow排队溢出
  • AbandonedInVoiceNavigator智能导航中放弃
  • Success正常结束
  • IVRExceptionIVR异常
  • AbandonedInRing振铃放弃
  • AbandonedInIVRIVR放弃
  • Reject客户拒接
  • ForwardToOutsideNumber转外线
Success
ContactIdstring

通过指定的 contactId 来查询某一通电话的记录,contactId 可以通过软电话 SDK 发生通话时获取到。如果传入该参数,则自动忽略其他查询参数。

job-12515239414412****
AgentIdstring

按坐席 ID 过滤。

agent@ccc-test
SkillGroupIdstring

按技能组 ID 过滤。

skillgroup@ccc-test
SortOrderstring

排序方式,非必填,默认为降序。

枚举值:
  • ASC升序
  • DESC降序
DESC
InstanceIdstring

实例 ID。

ccc-test
OrderByFieldstring

排序字段,非必填,默认为 startTime(通话开始时间)。

枚举值:
  • callDuration通话时长
  • ringTime响铃时长
  • talkTime通话时长
  • dialingTime拨号时长
  • startTime通话开始时间
  • ivrTimeIVR时长
  • queueTime排队时长
startTime
Criteriastring

根据主叫或被叫号码模糊查询,格式为 JSON 字符串,仅包含一个字段 phoneNumber,填主叫或被叫号码的全部或者一部分。

{"phoneNumber":"0735"}
CallingNumberstring

按主叫号码过滤。

07353988****
CalledNumberstring

按被叫号码过滤。

1320523****
SatisfactionListstring

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

["1","3"]
SatisfactionSurveyChannelstring

按满意度调查渠道过滤。

枚举值:
  • IVR语音满意度
  • SMS短信满意度
IVR
SatisfactionDescriptionListstring

按满意度描述列表过滤,描述内容由客户自定义。

["满意","一般"]
EarlyMediaStateListstring

按未接通原因列表过滤。

枚举值:
  • NoAnswer无人接听
  • OutOfService停机
  • NotExist空号
  • Restricted呼叫受限
  • Busy占线
  • NotConnected无法接通
  • PowerOff关机
["NotConnected","NoAnswer"]
ContactDispositionListstring

按挂断原因列表过滤。

枚举值:
  • AbandonedInQueue排队放弃
  • NoAnswer客户未接
  • QueuingTimeout排队超时
  • Voicemail转语音邮箱
  • QueuingFailed转人工失败
  • QueuingOverflow排队溢出
  • AbandonedInVoiceNavigator智能导航中放弃
  • Success正常结束
  • IVRExceptionIVR异常
  • AbandonedInRing振铃放弃
  • AbandonedInIVRIVR放弃
  • Reject客户拒接
  • ForwardToOutsideNumber转外线
["Success","NoAnswer"]
ContactTypeListstring

按通话类型列表过滤。

枚举值:
  • Outbound呼出
  • Back2Back双呼
  • PrivacyDial加密通话
  • Internal内部呼叫
  • Predictive预测式外呼
  • Inbound呼入
  • Conference会议
["Internal","Inbound"]

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Dataobject

数据。

PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
TotalCountinteger

总数,只有 PageNumber 为 1 才会返回真实数值,其他都是 0。

11
Listobject []

通话记录列表。

ContactDispositionstring

通话结束原因。

枚举值:
  • AbandonedInQueue排队放弃
  • NoAnswer客户未接
  • QueuingTimeout排队超时
  • Voicemail转语音邮箱
  • QueuingFailed转人工失败
  • QueuingOverflow排队溢出
  • AbandonedInVoiceNavigator智能导航中放弃
  • Success正常结束
  • IVRExceptionIVR异常
  • AbandonedInRing振铃放弃
  • AbandonedInIVRIVR放弃
  • Reject客户拒接
  • ForwardToOutsideNumber转外线
Success
ContactTypestring

通话类型。

枚举值:
  • Outbound呼出
  • Back2Back双呼
  • PrivacyDial加密通话
  • Internal内部呼叫
  • Predictive预测式外呼
  • Inbound呼入
  • Conference会议
Outbound
EstablishedTimelong

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

1532448000000
CalledNumberstring

被叫号码。

1332315****
AdditionalBrokerstring

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

0533128****
SatisfactionIndexinteger

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

1
SatisfactionSurveyChannelstring

满意度调查渠道。

枚举值:
  • IVR语音满意度
  • SMS短信满意度
IVR
ReleaseTimelong

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

1532707199000
WaitTimelong

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

5
SkillGroupNamesstring

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

测试技能组
IvrTimelong

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

8
SatisfactionDescriptionstring

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

满意
ReleaseInitiatorstring

挂断方。

枚举值:
  • agent坐席
  • customer客户
customer
AgentIdsstring

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

agent@ccc-test
CallDurationstring

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

30
RecordingReadyboolean

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

true
InstanceIdstring

实例 ID。

ccc-test
RingTimelong

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

5
SatisfactionSurveyOfferedboolean

是否发起了满意度调查。

true
AgentNamesstring

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

坐席小王
StartTimelong

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

1532448000000
ContactIdstring

通话 ID。

job-12515239414412****
RecordingDurationlong

录音时长,单位秒。

10
CallingNumberstring

主叫号码。

0533128****
QueueTimelong

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

0
Brokerstring

中间号码。

0533127****
SkillGroupIdsstring

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

skillgroup@ccc-test
CallerLocationstring

主叫归属地。

北京市-北京
CalleeLocationstring

被叫归属地。

山东省-济南
EarlyMediaStatestring

未接通原因。

枚举值:
  • NoAnswer无人接听
  • OutOfService停机
  • NotExist空号
  • Restricted呼叫受限
  • Busy占线
  • NotConnected无法接通
  • PowerOff关机
NotConnected
ReleaseReasonstring

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

486:USER_BUSY
DialingTimelong

拨号时长,单位秒。

0
TalkTimelong

通话时间,单位为秒

0
HeldTimelong

保持时间,单位为秒

12

示例

正常返回示例

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
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Parameter.FormatThe format of parameter %s is invalid. %s该参数的格式不合法。
500InternalService.CommonAn internal service error occurred. %s内部服务错误。

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

变更历史

变更时间变更内容概要操作
2023-10-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-03-20OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈