查询会话列表

服务描述

会话列表是查询所有的会话。可以关联特定的会话。查询会话的详细信息。

开发须知

调用本接口前，请先获取appId

服务地址

POST https://{您的专属域名}/imchat/openapi/v1/report/session/list

请求参数

参数 位置 类型 是否必填 说明
appId header String Y 应用ID
timestamp header String Y 时间戳，毫秒
sign header String Y 签名
Content-Type header String Y application/json
pageSize body int N 分页大小
beginIndex body int N 分页起始行，从0开始
startTimeStr body String Y/N 开始时间戳，单位毫秒（以会话开始时间刷选）
endTimeStr body String Y/N 结束时间戳，单位毫秒（以会话开始时间刷选）
staffId body String N 客服id
staffGroupId body Long N 技能组ID
productId body String N 渠道id
questions body String[] N 会话小结，多级会话小结用“,”隔开。 例如：["小结1，小结2","小结3"]
appraiseResult body int N 满意度 。1：满意；2：不满意；3：非常满意；4：非常不满意
invalidTag body int N 会话类型：0：无效会话，1：有效会话
estartTimeStr body String Y/N 开始时间戳，单位毫秒（以会话结束时间刷选）
eendTimeStr body String Y/N 结束时间戳，单位毫秒（以会话结束时间刷选）
sessionId body String N 会话id

注意：以会话开始时间刷选和以会话结束时间刷选至少要传一对数据（开始时间戳和结束时间戳）。并且开始时间和结束时间间隔不能超过90天！！

请求数据示例：
POST https://{您的专属域名}/imchat/openapi/v1/report/session/list

返回结果

参数 类型 说明
code String 结果码
message String 结果描述
data SessionResponseDTO 会话列表数据
SessionResponseDTO
参数 类型 说明
totalNum int 实体总数
entity List<Entity> 实体列表
Entity
参数 类型 说明
sessionId String 会话ID
questionval String 会话小结，多级会话小结用“-”隔开。
totalTime Long 会话时长，单位：毫秒
createTimeStr String 会话开始时间
effective int 会话类型（1：有效会话 0:无效会话）
effectiveStr String 会话类型中文描述
endTimeStr String 会话结束时间
userName String 客户名称
customerMessageNum int 客户消息数（咨询人工消息数）
staffCode String 客服工号
staffName String 最后接线客服
productId String 来源渠道ID
productName String 来源渠道名称
appraiseResult int 满意度评价，1：满意；2：不满意；3：非常满意；4：非常不满意;可关联接口：满意度列表中返回的ID
createTime Date 会话创建时间
chatWarn <ImChatWarn> 会话提醒
distributeStatus Integer 0-预分配客服，1-正式分配客服，-1 非正常分配
fromUser String 当前会话消息的发送者（值为customerID）
toUser String 当前会话消息的接受者（值为坐席ID）
mStatus Integer 会话的状态：0:正在会话 1:结束会话
offlineStatus Integer 0-非自动结束；1-自动结束，离线会话；2-自动结束，已关闭会话（客服进行了问题标记）
satisfaction String 满意度名称
solved int 会话是否已解决咨询的问题；1：解决 0：未解决
queueTime Long 排队时长，单位：毫秒
queueStatus int 排队状态（0：未排队会话，1：排队会话）
endType int 会话结束方式（0：坐席手动结束、1：超时未回复自动结束，:2：客户离开超时自动结束）
userMsgCount Long 人工回复数
userSendEvaluate Boolean 客服发起邀评（true：是，false:否）
externalId String 外部系统用户ID
skillGroupName String 进线技能组
transferNum int 转接次数
firstStaffName String 首接客服
questionvalCustom_id String 自定义业务记录字段，这个字段”_id“是业务字段的id值 获取业务记录字段列表

注意：如果要获取会话策略路由信息的话，根据会话id集合进行查询 获取会话策略路由信息列表

ImChatWarn
参数 类型 说明
sessionId String 会话id
warnType Integer 提醒类型时长 1-30秒提醒，2-1分钟提醒
businessType Integer 业务类型 1-客服长时间未回复用户提醒
返回结果示例：
{
    "code": "10000",
    "data": {
        "entity": [{
            "appraiseResult": "1",
            "chatWarn": {
                "sessionId": "E8DB7A5AFD24CD9356C858063A4683C2",
                  "warnType": 1,
                  "businessType": 1
            },
            "createTime": 1602666042000,
            "createTimeStr": "2020-10-14 17:00:42",
            "customerMessageNum": 4,
            "distributeStatus": 1,
            "effective": 1,
            "effectiveStr": "有效会话",
            "endTime": 1602666520000,
            "endTimeStr": "2020-10-14 17:08:40",
            "fromUser": "c342a4376a76455fa50905c02a335ace",
            "mStatus": 1,
            "offlineStatus": 0,
            "productId": "73a31742f5004413b8ec88df7c43daee",
            "productName": "服务号1014",
            "questionval": "",
            "satisfaction": "满意",
            "sessionId": "E8DB7A5AFD24CD9356C858063A4683C2",
            "solved": 1,
            "staffCode": "132257",
            "staffName": "洋洋1",
            "toUser": "19881202",
            "totalTime": 477677,
            "totalTimeStr": "7分58秒",
            "updateTime": 1602666520000,
            "userName": "李洋",
            "queueTime": 23331,
            "queueStatus": 0,
            "endType": 1,
            "userMsgCount": 5,
            "userSendEvaluate": true,
            "externalId": "xxxx1",
            "questionvalCustom_1243" : "xx"
        }, {
            "chatWarn": {
                "sessionId": "274CCDBC35D3A53E60000C545CE625E2",
                  "warnType": 2,
                  "businessType": 1
            },
            "createTime": 1602665886000,
            "createTimeStr": "2020-10-14 16:58:06",
            "customerMessageNum": 6,
            "distributeStatus": 1,
            "effective": 1,
            "effectiveStr": "有效会话",
            "endTime": 1602665917000,
            "endTimeStr": "2020-10-14 16:58:37",
            "fromUser": "c342a4376a76455fa50905c02a335ace",
            "mStatus": 1,
            "offlineStatus": 0,
            "productId": "73a31742f5004413b8ec88df7c43daee",
            "productName": "服务号1014",
            "questionval": "",
            "satisfaction": "",
            "sessionId": "274CCDBC35D3A53E60000C545CE625E2",
            "staffCode": "132257",
            "staffName": "洋洋1",
            "toUser": "19881202",
            "totalTime": 30784,
            "totalTimeStr": "31秒",
            "updateTime": 1602665917000,
            "userName": "李洋",
            "queueTime": 23332,
            "queueStatus": 0,
            "endType": 2,
            "userMsgCount": 6,
            "userSendEvaluate": false,
            "externalId": "xxxx2",
            "questionvalCustom_1243" : "xx"
        }],
        "totalNum": 54
    },
    "message": "请求成功"
}
结果码说明
结果码 说明
10000 请求成功
20001 请求失败
21002 认证失败,请重新登录

FAQ:

results matching ""

    No results matching ""