会话记录查询接口

场景描述

给第三方接入方调用,实现智能会话信息记录的查询。

前提条件

请参考以下步骤开启“FLOWRECORDFLAG”参数。

选择“配置中心>机器人管理>流程配置”,进入流程配置页面。
选择“系统管理 > 系统设置”。在“系统参数”页签,在“FLOWRECORDFLAG”参数的后面点击“编辑”,然后选择开启,再点击“保存”开启该参数。
图1 开启参数

接口方法

设置成“POST”。

URL

https://IP:PORT/oifde/rest/api/queryRecordHistory

请求说明

表1 请求体参数
参数名称	数据类型	参数位置	必选/可选	描述
tenantId	String	body	True	租户ID
authToken	String	body	True	访问接口的有效Token值。有效Token信息通过获取Token接口获取。请参见C3 智能助手平台接口鉴权方式。
beginTime	String	body	False	开始时间格式： yyyy-MM-dd HH:mm:ss
endTime	String	body	False	结束时间格式： yyyy-MM-dd HH:mm:ss
pageNum	String	body	False	页码分页查询,查询第几页,首页为1 不传,默认页码为1
pageSize	String	body	False	每页多少条可配置：5,10,20,50,100 不传,默认一页100条
callId	String	body	False	callId(userMobile、callId和ctiCallId需要传其中一个)
userMobile	String	body	False	用户号码(userMobile、callId和ctiCallId需要传其中一个)
ctiCallId	String	body	False	ctiCallId (userMobile、callId和ctiCallId需要传其中一个)

响应说明

参数名称	数据类型	参数位置	必选/可选	描述
errorCode	int	body	False	错误码非0表示失败
errorMsg	String	body	False	错误描述
total	long	body	True	总条数
recordList	record[]	body	True	返回对话绑定关系列表（数组结构）

表2 record参数说明
参数名称	数据类型	参数位置	必选/可选	描述
logId	String	body	True	会话记录的唯一标识
tenantId	String	body	True	租户ID
callSorId	String	body	True	用户号码
callId	String	body	True	callId
ctiCallId	String	body	False	ctiCallId
callingNumber	String	body	True	主叫号码
calledNumber	String	body	True	被叫号码
startTime	long	body	False	通话起始时间格式为时间戳
endTime	long	body	False	通话结束时间格式为时间戳
lastUpdateTime	long	body	False	最后更新时间格式为时间戳
flowInstId	String	body	False	流程实例ID
dialogType	String	body	False	对话类型
callData	String	body	False	呼叫数据
locationId	int	body	False	录音节点,CTI POOL时有用
flag	String	body	False	标识
businessInfo	JSON String	body	True	录音文件等信息
businessInfoStr	JSON String	body	True	录音文件信息包括yugaoFileName、locationId（节点Id）、recordFileName（录音文件路径和名称）
recordDetials	RecordDetials[]	body	True	通话详细内容
qaRecords	qaRecords[]	body	True	问答详细内容

表3 RecordDetials参数说明
参数名称	数据类型	参数位置	必选/可选	描述
interNo	String	body	True	内部序号
userSaying	String	body	True	语音转写结果
intention	String	body	True	用户意图
systemReply	String	body	True	系统回复
timestamp	long	body	True	系统回复时间
requsetTime	long	body	True	用户请求时间
responseSource	int	body	True	回复来自机器人还是静默座席。机器人--0,静默座席--1
involveMode	int	body	True	流程的介入方式普通模式--0,监控模式--1,插入模式--2

表4 qaRecords参数说明
参数名称	数据类型	参数位置	必选/可选	描述
interNo	String	body	False	内部序号
seriesId	String	body	False	问答的系列标识
questionTitle	String	body	False	问题标题
questionType	String	body	False	问题类型
answerIntent	String	body	False	回答意图
originalAnswer	String	body	False	用户原始回答
createTime	long	body	False	创建时间

报文样例

请求消息样例

{ 
   "tenantId": "tenant001", 
   "authToken": "0dbe11892be840cf983453ea70b505de",
   "userMobile": "180****9999"  
}

响应消息样例

{
    "errorCode": 0,
    "errorMsg": "Success",
    "total": 1,
    "recordList": [
        {
            "logId": "7343-4256-a659-c7fe7682ef03",
            "tenantId": "xxxxxx",
            "callSorId": "10086",
            "callId": "16185589414826353c2c0036c0292e43ca7a4",
            "ctiCallId": null,
            "callingNumber": "10086",
            "calledNumber": "899149138753490944",
            "startTime": 1618558942000,
            "endTime": 1618559267000,
            "lastUpdateTime": 1618559267000,
            "flowInstId": "1234567892021041615422158916185589414826353c2c0036c0292e43ca7a4",
            "businessInfo": null,
            "businessInfoStr": "{\"yugaoFileName\":\"null\",\"locationId\":\"0\",\"recordFileName\":\"Y:/135/odfsrecord/20220720/1658313131-85918321361224.wav\"}",
            "recordDetials": [
                {
                    "interNo": "1",
                    "userSaying": "我有多少话费",
                    "intention": "话费查询",
                    "systemReply": "您好,您当月累计消费100元,话费余额100元",
                    "timestamp": 1618558954000,
                    "requsetTime": 1618558954000,
                    "responseSource": 0,
                    "involveMode": 0
                }
            ],
            "qaRecords": [
                {
                    "interNo": "1",
                    "seriesId": "100",
                    "questionTitle": "是否做过核酸",
                    "questionType": "2",
                    "answerIntent": "是",
                    "originalAnswer": "做过",
                    "createTime": 1650774697000
                }
            ]
        }
    ]
}

父主题：智能化模块接口参考

上一篇：交互记录查询接口

下一篇：FAQ配置接口