AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

ListCallDetailRecords - 获取通话详情列表

更新时间：
复制为 MD 格式
产品详情
我的收藏

调用ListCallDetailRecords获取指定实例下指定搜索条件过滤后的通话详情列表。接口不再迭代更新，建议优先使用ListCallDetailRecordsV2接口。

接口说明

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

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值
PageNumber

integer

是

分页序号，范围 1-100。

1
PageSize

integer

是

分页大小，范围 1-100。

100
StartTime

integer

否

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

1532448000000
EndTime

integer

否

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

1532707199000
ContactType

string

否

按通话类型过滤。

枚举值：

  • Outbound :

    呼出

  • Back2Back :

    双呼

  • PrivacyDial :

    加密通话

  • Internal :

    内部呼叫

  • Predictive :

    预测式外呼

  • Inbound :

    呼入

  • Conference :

    会议

Outbound
ContactDisposition

string

否

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

枚举值：

  • AbandonedInQueue :

    排队放弃

  • NoAnswer :

    客户未接

  • QueuingTimeout :

    排队超时

  • Voicemail :

    转语音邮箱

  • QueuingFailed :

    转人工失败

  • QueuingOverflow :

    排队溢出

  • AbandonedInVoiceNavigator :

    智能导航中放弃

  • Success :

    正常结束

  • IVRException :

    IVR 异常

  • AbandonedInRing :

    振铃放弃

  • AbandonedInIVR :

    IVR 放弃

  • Reject :

    客户拒接

  • ForwardToOutsideNumber :

    转外线

Success
ContactId

string

否

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

job-12515239414412****
AgentId

string

否

按坐席 ID 过滤。

agent@ccc-test
SkillGroupId

string

否

按技能组 ID 过滤。

skillgroup@ccc-test
SortOrder

string

否

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

枚举值：

  • ASC :

    升序

  • DESC :

    降序

DESC
InstanceId

string

是

实例 ID。

ccc-test
OrderByField

string

否

排序字段，非必填，默认为 startTime（通话开始时间）。

枚举值：

  • callDuration :

    通话时长

  • ringTime :

    响铃时长

  • talkTime :

    通话时长

  • dialingTime :

    拨号时长

  • startTime :

    通话开始时间

  • ivrTime :

    IVR 时长

  • queueTime :

    排队时长

startTime
Criteria

string

否

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

{"phoneNumber":"0735"}
CallingNumber

string

否

按主叫号码过滤。

07353988****
CalledNumber

string

否

按被叫号码过滤。

1320523****
SatisfactionList

string

否

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

["1","3"]
SatisfactionSurveyChannel

string

否

按满意度调查渠道过滤。

枚举值：

  • IVR :

    语音满意度

  • SMS :

    短信满意度

IVR
SatisfactionDescriptionList

string

否

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

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

string

否

按未接通原因列表过滤。

枚举值：

  • NoAnswer :

    无人接听

  • OutOfService :

    停机

  • NotExist :

    空号

  • Restricted :

    呼叫受限

  • Busy :

    占线

  • NotConnected :

    无法接通

  • PowerOff :

    关机

["NotConnected","NoAnswer"]
ContactDispositionList

string

否

按挂断原因列表过滤。

枚举值：

  • AbandonedInQueue :

    排队放弃

  • NoAnswer :

    客户未接

  • QueuingTimeout :

    排队超时

  • Voicemail :

    转语音邮箱

  • QueuingFailed :

    转人工失败

  • QueuingOverflow :

    排队溢出

  • AbandonedInVoiceNavigator :

    智能导航中放弃

  • Success :

    正常结束

  • IVRException :

    IVR 异常

  • AbandonedInRing :

    振铃放弃

  • AbandonedInIVR :

    IVR 放弃

  • Reject :

    客户拒接

  • ForwardToOutsideNumber :

    转外线

["Success","NoAnswer"]
ContactTypeList

string

否

按通话类型列表过滤。

枚举值：

  • Outbound :

    呼出

  • Back2Back :

    双呼

  • PrivacyDial :

    加密通话

  • Internal :

    内部呼叫

  • Predictive :

    预测式外呼

  • Inbound :

    呼入

  • Conference :

    会议

["Internal","Inbound"]

返回参数

名称

类型

描述

示例值

object

Code

string

响应码。

OK
HttpStatusCode

integer

HTTP 状态码。

200
Message

string

响应信息。

无
RequestId

string

请求 ID。

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

object

数据。

PageNumber

integer

分页序号，范围 1-100。

1
PageSize

integer

分页大小，范围 1-100。

10
TotalCount

integer

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

11
List

array<object>

通话记录列表。

object

通话记录。

ContactDisposition

string

通话结束原因。

枚举值：

  • AbandonedInQueue :

    排队放弃

  • NoAnswer :

    客户未接

  • QueuingTimeout :

    排队超时

  • Voicemail :

    转语音邮箱

  • QueuingFailed :

    转人工失败

  • QueuingOverflow :

    排队溢出

  • AbandonedInVoiceNavigator :

    智能导航中放弃

  • Success :

    正常结束

  • IVRException :

    IVR 异常

  • AbandonedInRing :

    振铃放弃

  • AbandonedInIVR :

    IVR 放弃

  • Reject :

    客户拒接

  • ForwardToOutsideNumber :

    转外线

Success
ContactType

string

通话类型。

枚举值：

  • Outbound :

    呼出

  • Back2Back :

    双呼

  • PrivacyDial :

    加密通话

  • Internal :

    内部呼叫

  • Predictive :

    预测式外呼

  • Inbound :

    呼入

  • Conference :

    会议

Outbound
EstablishedTime

integer

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

1532448000000
CalledNumber

string

被叫号码。

1332315****
AdditionalBroker

string

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

0533128****
SatisfactionIndex

integer

满意度，即满意度按键数字（1 位数字）的值。

1
SatisfactionSurveyChannel

string

满意度调查渠道。

枚举值：

  • IVR :

    语音满意度

  • SMS :

    短信满意度

IVR
ReleaseTime

integer

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

1532707199000
WaitTime

integer

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

5
SkillGroupNames

string

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

测试技能组
IvrTime

integer

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

8
SatisfactionDescription

string

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

满意
ReleaseInitiator

string

挂断方。

枚举值：

  • agent :

    坐席

  • customer :

    客户

customer
AgentIds

string

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

agent@ccc-test
CallDuration

string

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

30
RecordingReady

boolean

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

true
InstanceId

string

实例 ID。

ccc-test
RingTime

integer

振铃时长，即从坐席振铃到坐席接起（或客户放弃）之间的时长，单位秒。

5
SatisfactionSurveyOffered

boolean

是否发起了满意度调查。

true
AgentNames

string

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

坐席小王
StartTime

integer

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

1532448000000
ContactId

string

通话 ID。

job-12515239414412****
RecordingDuration

integer

录音时长，单位秒。

10
CallingNumber

string

主叫号码。

0533128****
QueueTime

integer

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

0
Broker

string

中间号码。

0533127****
SkillGroupIds

string

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

skillgroup@ccc-test
CallerLocation

string

主叫归属地。

北京市-北京
CalleeLocation

string

被叫归属地。

山东省-济南
EarlyMediaState

string

未接通原因。

枚举值：

  • NoAnswer :

    无人接听

  • OutOfService :

    停机

  • NotExist :

    空号

  • Restricted :

    呼叫受限

  • Busy :

    占线

  • NotConnected :

    无法接通

  • PowerOff :

    关机

NotConnected
ReleaseReason

string

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

486:USER_BUSY
DialingTime

integer

拨号时长，单位秒。

0
TalkTime

integer

通话时间，单位为秒

0
HeldTime

integer

保持时间，单位为秒

12
CallIds

string

通信底层 SIP 协议中 Call-Id 字段，如果需要获取号码提供商侧的通话 ID 可以从这个字段获取。

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

示例

正常返回示例

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": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\n"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

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

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

变更历史

更多信息，参考变更详情。

上一篇：ListAgentStateLogs - 获取坐席状态日志列表下一篇：ListCallDetailRecordsV2 - 获取通话详情列表