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
枚举值:
- Outbound: 呼出
- Back2Back: 双呼
- PrivacyDial: 加密通话
- Internal: 内部呼叫
- Predictive: 预测式外呼
- Inbound: 呼入
- Conference: 会议
ContactDispositionstring

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

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

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

job-12515239414412****
AgentIdstring

按坐席ID过滤。

agent@ccc-test
SkillGroupIdstring

按技能组ID过滤。

skillgroup@ccc-test
SortOrderstring

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

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

实例ID。

ccc-test
OrderByFieldstring

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

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

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

{"phoneNumber":"0735"}
CallingNumberstring

按主叫号码过滤。

07353988****
CalledNumberstring

按被叫号码过滤。

1320523****
SatisfactionListstring

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

["1","3"]
SatisfactionSurveyChannelstring

按满意度调查渠道过滤。

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

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

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

按未接通原因列表过滤。

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

按挂断原因列表过滤。

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

按通话类型列表过滤。

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

返回参数

名称类型描述示例值
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
Listarray

通话记录列表。

object

通话记录。

ContactDispositionstring

通话结束原因。

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

通话类型。

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

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

1532448000000
CalledNumberstring

被叫号码。

1332315****
AdditionalBrokerstring

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

0533128****
SatisfactionIndexinteger

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

1
SatisfactionSurveyChannelstring

满意度调查渠道。

IVR
枚举值:
- IVR: 语音满意度
- SMS: 短信满意度
ReleaseTimeLong

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

1532707199000
WaitTimeLong

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

5
SkillGroupNamesstring

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

测试技能组
IvrTimeLong

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

8
SatisfactionDescriptionstring

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

满意
ReleaseInitiatorstring

挂断方。

customer
枚举值:
- agent: 坐席
- 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

未接通原因。

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

示例

正常返回示例

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错误码错误信息描述
400Parameter.FormatThe format of parameter %s is invalid. %s该参数的格式不合法。
500InternalService.CommonAn internal service error occurred. %s内部服务错误。

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

阿里云首页 云呼叫中心 相关技术圈