对话记录接口 - Udesk | 开发者中心

获取对话记录列表

请求地址

POST /v1/sessions

请求参数

Request fields

Path	Type	Optional	Description
robotId	Integer	false	机器人id.
startTime	DateTime	false	开始时间，格式为yyyy-MM-dd HH:mm:ss，如2019-12-31 00:00:00
endTime	DateTime	false	结束时间，格式为yyyy-MM-dd HH:mm:ss，如2020-01-07 00:00:00
pageNum	Integer	true	当前页，大于0, 默认为1
pageSize	Integer	true	页大小，大于0小于100，默认为10
keywords	String	true	搜索关键词.
keywordsSource	Integer	true	关键字查询来源：0.全部对话消息（默认） 1.机器人消息 2.客户消息 3.客服消息 4.客户ID 5.客户外部ID
conditionList	Array	true	过滤条件列表
conditionList[].field	String	true	过滤条件的字段名
conditionList[].operator	String	true	过滤条件的操作条件
conditionList[].value	Object	true	过滤条件的字段值，不同过滤条件对应不同的值类型

过滤条件说明

Name	Field	Operator	Value
渠道	platform	is	多选，Array类型，可用整数值. 0.web 1.微信 2.安卓 3.ios 4.微博 5.api 6.多商户 7.微信小程序 8.企业微信
场景	channelId	is	多选，Array类型,场景的ID
来源插件	webPluginName	is	多选，Array类型, 插件名字
来源	src	is	多选，Array类型,来源名字
应用名称	appId	is	String，名称值
IP所在地	ipLocation	is	String,IP值
客户消息数	customerMsgCount	greater_than,less_than,is,between	Integer,数值,例如between的值类型为"0,8"
直接回答数	directResponseCount	同上	同上
引导选择回答	suggestQuestionCount	同上	同上
引导未选择回答	unSuggestQuestionCount	同上	同上
机器人消息数	robotMsgCount	同上	同上
匹配答案数	robotRepliedCount	同上	同上
未知回答	unknownQuestionCount	同上	同上
有用回答数	usefulResponseCount	同上	同上
无用回答数	uselessResponseCount	同上	同上
是否转人工	isSwitchStaff	is	Integer, 0.无 1.有
评价	surveyOption	is	String,评价值以分号组合. 1.未评价 2.满意 3.一般 4.不满意例如: "1,2,3"

请求结果

Path	Type	Description
code	Integer	执行结果码
message	String	执行结果说明
paging	Object	分页信息
paging.pageNum	Integer	页数
paging.pageSize	Integer	页大小
paging.total	Integer	总数
data	Array	会话信息
data[].id	Integer	会话ID
data[].startTime	String	对话开始时间
data[].endTime	String	对话结束时间
data[].totalCount	Integer	对话总数
data[].customerMsgCount	Integer	客户消息数
data[].robotMsgCount	Integer	机器人消息数
data[].robotRepliedCount	Integer	机器人匹配回答数
data[].unknownQuestionCount	Integer	未知回答数
data[].usefulResponseCount	Integer	有用回答数
data[].uselessResponseCount	Integer	无用回答数
data[].surveyOption	Integer	评价 1.未评价 2.满意 3.一般 4.不满意
data[].isSwitchStaff	Integer	是否转人工 0.无 1.有
data[].appName	String	应用名称
data[].channelId	Integer	场景ID
data[].channelName	String	场景
data[].directResponseCount	Integer	直接回答数
data[].suggestQuestionCount	Integer	引导选择回答数
data[].unSuggestQuestionCount	Integer	引导未选择回答数
data[].customer	Object	客户信息对象
data[].customer.id	Integer	客户ID
data[].customer.nickname	String	客户名称
data[].customer.ip	String	IP地址
data[].customer.province	String	所在省
data[].customer.city	String	所在城市
data[].customer.platform	String	渠道
data[].customer.src	String	来源
data[].customer.srcUrl	String	来源url
data[].customer.webPluginName	String	来源插件
data[].customer.orgName	String	公司名称
data[].customer.email	String	客户邮箱
data[].customer.phone	String	客户电话
data[].customer.tags	String	客户标签
data[].customer.desc	String	描述
data[].customer.level	String	客户等级
data[].customer.generatedChannel	String	自定义渠道信息
data[].customer.loginUrl	String	访问着陆页
data[].customer.sessionUrl	String	对话发起页
data[].customer.dialogueDesc	String	对话描述信息

示例

$ curl 'https://km.udesk.cn/api/v1/sessions?email=admin@udesk.cn&timestamp=1529402458&sign=29beefc01662bd040a74880346f3da4491a357cf' -i -X POST -H 'Content-Type: application/json' -d '{
    "robotId":83,
    "startTime": "2019-12-31 00:00:00",
    "endTime": "2020-01-07 23:59:59",
    "pageNum": 1,
    "pageSize": 2,
    "keywordsSource":0,
    "keywords":"",
    "conditionList":[{"field":"customerMsgCount","operator":"greater_than","value":"0"}]
}'

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 2,
        "total": 4088
    },
    "data": [
        {
            "id": 457955,
            "robotId": 83,
            "startTime": "2019-11-27 18:41:23",
            "endTime": "2019-11-27 18:43:05",
            "totalCount": 8,
            "ipLocation": null,
            "customerMsgCount": 4,
            "robotMsgCount": 4,
            "robotRepliedCount": 2,
            "unknownQuestionCount": 1,
            "usefulResponseCount": 0,
            "uselessResponseCount": 0,
            "surveyOption": 1,
            "surveyComment": null,
            "isSwitchStaff": 0,
            "appName": "测试1·",
            "channelId": 82,
            "channelName": null,
            "customer": {
               "id": 1415457662,
               "nickname": "",
               "ip": "",
               "province": "北京",
                "city": "北京",
                "level": "normal",
                "platform": "web",
                "src": "",
                "srcUrl": "",
                "webPluginName": "",
                "sessionUrl": ""
            },
            "callId": null,
            "dialogueDesc": null,
            "directResponseCount": 2,
            "suggestQuestionCount": 0,
            "unSuggestQuestionCount": 0
        },
        {
            "id": 457954,
            "robotId": 83,
            "startTime": "2019-11-27 18:23:27",
            "endTime": "2019-11-27 18:24:37",
            "totalCount": 4,
            "ipLocation": null,
            "customerMsgCount": 2,
            "robotMsgCount": 2,
            "robotRepliedCount": 0,
            "unknownQuestionCount": 0,
            "usefulResponseCount": 0,
            "uselessResponseCount": 0,
            "surveyOption": 1,
            "surveyComment": null,
            "isSwitchStaff": 0,
            "appName": "测试1·",
            "channelId": 82,
            "channelName": null,
            "customer": null,
            "callId": null,
            "dialogueDesc": null,
            "directResponseCount": 0,
            "suggestQuestionCount": 0,
            "unSuggestQuestionCount": 0
        }
    ]
}

获取对话记录详情

请求地址

GET /v1/sessions/:id/logs

请求参数

Path parameters

Parameter	Type	Optional	Description
id	int	false	对话记录ID.

Query parameters

Parameter	Type	Optional	Description
pageNum	Integer	true	当前页, 大于0, 默认为1
pageSize	Integer	true	页大小, 大于0小于100, 默认为10

请求结果

Path	Type	Description
code	Integer	执行结果码
message	String	执行结果说明
paging	Object	分页信息
paging.pageNum	Integer	页数
paging.pageSize	Integer	页大小
paging.total	Integer	总数
data	Array	对话记录消息
data[].id	Integer	对话消息ID
data[].userType	Integer	记录发出者类型, 1.机器人 2.用户
data[].content	String	记录内容
data[].sessionId	Integer	对话ID
data[].createTime	String	记录创建时间
data[].source	Integer	log来源
data[].leadingWord	String	引导语
data[].sessionLogSuggestFoundResponseList	Array	建议问题列表
data[].sessionLogSuggestFoundResponseList[].id	Integer	ID
data[].sessionLogSuggestFoundResponseList[].logId	Integer	记录对话ID
data[].sessionLogSuggestFoundResponseList[].questionId	Integer	问题ID
data[].sessionLogSuggestFoundResponseList[].questionContent	String	问题内容

示例

$ curl 'https://km.udesk.cn/api/v1/sessions/457955/logs?pageNum=1&pageSize=2&email=admin@udesk.cn&timestamp=1529402455&sign=d4be213127c62bb5b53dea5f5e52eaad06b2362f' -i -H 'Accept: application/json'

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 2,
        "total": 9
    },
    "data": [
        {
            "id": 849457,
            "userType": 1,
            "content": "Urobot欢迎语\n \n",
            "sessionId": 457955,
            "createTime": "2019-11-27 18:41:23"
        },
        {
            "id": 849458,
            "userType": 2,
            "content": "如何更换银行预留手机号",
            "sessionId": 457955,
            "createTime": "2019-11-27 18:41:28",
            "queryResult": 4,
            "source": 1
        }
    ]
}

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search

获取对话记录列表

请求地址

请求参数

Request fields

过滤条件说明

请求结果

示例

返回

获取对话记录详情

请求地址

请求参数

Path parameters

Query parameters

请求结果

示例

返回

文档反馈