所有api接口都需要鉴权规则，具体详情前往新平台鉴权规则查看

• 1.查询会话列表
• 2.查询会话详情
• 3.查询消息列表

1.查询会话列表

• 请求路径 /openapi/im-center/webchat/v1/list
• 请求参数

字段名称	字段类型	是否必传	字段描述	示例	备注
createTimeBegin	string	是	会话创建开始时间	'2021-01-04 00:00:00'
createTimeEnd	string	是	会话创建结束时间	'2021-01-05 00:00:00'
visitorName	string	否	访客昵称	'mqqqiioepyaSa'
sessionId	string	否	会话ID	'c2bd32e3-b1e2-4589-b5bb-70a7ab625533'
agentId	string	否	坐席ID	'5fd86ab7cde3f40e6a47f8a7'
platform	string	否	渠道	'pc'
accessId	string	否	接入号ID	'c2bd32e3-b1e2-4589-b5bb-70a7ab625533'
queueNumber	string	否	技能组ID	'2000113'
convertManualTimeBegin	string	否	转人工开始时间	'2021-01-04 00:00:00'
convertManualTimeEnd	string	否	转人工结束时间	['2021-01-05 00:00:00'
manualTimeBegin	string	否	转人工成功开始时间	'2021-01-04 00:00:00'
manualTimeEnd	string	否	转人工成功结束时间	'2021-01-05 00:00:00'
endTimeBegin	string	否	会话结束开始时间	'2021-01-04 00:00:00'
endTimeEnd	string	否	会话结束结束时间	'2021-01-05 00:00:00'
agentFirstReplyTimeBegin	string	否	坐席首次响应开始时间	'2021-01-04 00:00:00'
agentFirstReplyTimeEnd	string	否	坐席首次响应结束时间	'2021-01-05 00:00:00'
totalMessageCount	number	否	总消息数	10
visitorMessageCount	number	否	访客消息数	2
agentReplyMessageCount	number	否	坐席消息数	4
seoSource	string	否	搜索来源	'百度'
seoKeywords	string	否	搜索关键词	'七陌'
finishKey	string	否	结束类型	'session_to_leave_finish'	enum: ['system_error_finish', 'system_process_finish', 'queue_give_up', 'agent_finish', 'visitor_finish', 'system_auto_finish_session', 'session_to_leave_finish']
area	string	否	地域	'中国 北京 北京'	必须是 国家+空格+省份+空格+城市 的格式
ip	string	否	ip	'172.16.88.204'
limit	number	否	限制条数	10	最大不超过50
page	number	否	查询页	1
status	string	否	会话状态	enum: ['undeal', 'robot', 'queue', 'deal', 'finish']

• 请求示例

{
      "limit": 10,
      "page": 1,
      "createTimeBegin": "2021-01-04 00:00:00",
      "visitorName": "mqqqiioepyaSa",
      "sessionId": "c2bd32e3-b1e2-4589-b5bb-70a7ab625533",
      "agentId": "5fd86ab7cde3f40e6a47f8a7",
      "platform": "pc",
      "accessId": "c2bd32e3-b1e2-4589-b5bb-70a7ab625533",
      "queueNumber": "2000113",
      "convertManualTimeBegin": "2021-01-04 00:00:00",
      "manualTimeBegin": "2021-01-04 00:00:00",
      "endTimeBegin": "2021-01-04 00:00:00",
      "agentFirstReplyTimeBegin": "2021-01-04 00:00:00",
      "totalMessageCount": 2,
      "visitorMessageCount": 3,
      "agentReplyMessageCount": 1,
      "seoSource": "百度",
      "seoKeywords": "七陌",
      "finishKey": "session_to_leave_finish",
      "area": "中国 北京 北京",
      "ip": "172.16.88.204"
}

• 返回参数

字段名称	字段类型	字段描述
createTime	string	会话创建时间
visitorId	string	访客ID
_id	string	会话ID
agentId	string	坐席ID
accessId	string	接入号ID
convertManualTime	string	转人工时间
manualTime	string	转人工成功时间
endTime	string	会话结束时间
agentFirstReplyTime	string	坐席首次响应时间
totalMessageCount	number	总消息数
visitorMessageCount	number	访客消息数
agentReplyMessageCount	number	坐席消息数
seoSource	string	搜索来源
seoKeywords	string	搜索关键词
finishKey	string	结束类型
area	string	地域
ip	string	ip
status	string	会话状态
queueNumber	string	技能组编号
queueName	string	技能组名称
agentName	string	坐席名称
customerId	string	用户ID

• 返回示例

{
    "success":true,
    "message":"200 ok!",
    "list": [
      {
        "_id": "3f55dc77-770f-4395-af77-bf31e629e350",
        "area": "中国 四川省 成都市",
        "ip": "171.223.209.177",
        "agentReplyMessageCount": 2,
        "totalMessageCount": 6,
        "visitorMessageCount": 4,
        "agentId": "6062db21d316840011c6b992",
        "visitorId": "2000256@XhRRVj3VLLVYsoNA@cXgpaR4R@web",
        "createTime": "2021-09-07 10:22:04",
        "accessId": "XhRRVj3VLLVYsoNA",
        "visitorName": "访客",
        "status": "deal",
        "convertManualTime": "2021-09-07 10:22:24",
        "queueNumber": "10000147",
        "manualTime": "2021-09-07 10:22:24",
        "agentFirstReplyTime": "2021-09-07 10:22:35",
        "customerId": "60adeedf7d433727b3e33e5c",
        "agentName": "坐席",
        "queueName": "网页专用技能组"
      }
    ]
}

2.查询会话详情

• 请求路径 /openapi/im-center/webchat/v1/info
• 请求参数

字段名称	字段类型	是否必传	字段描述	示例
sessionId	string	是	会话Id	'c2bd32e3-b1e2-4589-b5bb-70a7ab625533'

• 请求示例

{
    "sessionId": "c2bd32e3-b1e2-4589-b5bb-70a7ab625533"
}

• 返回参数

chatSession

字段名称	字段类型	字段描述
_id	string	会话ID
userIds	string[]	处理过该会话的坐席
peerIds	string[]	处理过该会话的技能组id
autoClaimVersions	string[]	自动领取会话版本号
visitorId	string	访客ID
accountId	string	账户编号
createTime	string	会话创建时间
createTimestamp	number	会话创建时间戳
accessId	string	接入号ID
platform	string	渠道
autoClaimVersion	string	自动领取会话版本号
visitorName	string	访客名称
isNewVisitor	boolean	是否为新访客
status	string	会话状态
isInvite	boolean	是否为邀请会话
isNewSession	boolean	是否为新会话
processNodeId	string	流程ID
currentNodeId	string	当前节点ID
processName	string	流程名称
isVisitorBreak	boolean	访客是否离线
ip	string	ip
lastMessageTimestamp	number	最后一条消息时间戳
lastMessage	object	最后一天消息
leakNum	string	未读消息数
totalMessageCount	number	总消息数
toPeer	string	技能组ID
serviceMan	string	人工/机器人
agentId	string	坐席ID
agentClaimTimestamp	number	坐席领取会话时间戳
lastVisitorMessageTimestamp	number	访客最后一条消息时间戳
visitorStartWaitTimestamp	number	访客等待时间戳
agentReplyMessageCount	number	坐席回复消息数
lastAgentMessageTimestamp	number	坐席最后一天消息时间戳
accessName	string	接入号名称
inviteTimes	number	邀请会话次数
dialogueTimes	number	总会话次数
convertManualTime	string[]	转人工时间
manualTime	string[]	转人工成功时间
endTime	string[]	会话结束时间
finishKey	string	结束类型

scheduleHistory

字段名称	字段类型	字段描述
dateTime	string	节点时间
processNodeType	string	节点类型
processNodeId	string	节点ID
processNodeName	string	节点名称

• 返回示例

{
        "chatSession": {
            "_id": "c27dd9b1-9981-4780-a052-f60f9def08bf",
            "peerIds": [
                "10000147",
                "10000146"
            ],
            "area": "中国 四川省 成都市",
            "ip": "171.223.209.177",
            "agentReplyMessageCount": 2,
            "totalMessageCount": 5,
            "visitorMessageCount": 3,
            "userIds": [
                "6062db21d316840011c6b993",
                "6062db21d316840011c6b992"
            ],
            "agentNumber": "2000",
            "agentId": "6062db21d316840011c6b992",
            "visitorId": "2000256@XhRRVj3VLLVYsoNA@cXgpaR4R@web",
            "accountId": "2000256",
            "createTime": "2021-09-23 15:25:16",
            "createTimestamp": 1632381916143,
            "accessId": "XhRRVj3VLLVYsoNA",
            "platform": "pc",
            "visitorName": "婷婷子",
            "fromUrl": "https://v7-webchat.7moor.com/demo.html?accessId=XhRRVj3VLLVYsoNA",
            "urlTitle": "V7访客端测试页",
            "referrer": "https://v7-webchat.7moor.com/demo.html?accessId=XhRRVj3VLLVYsoNA",
            "isNewVisitor": false,
            "status": "finish",
            "landingPageUrl": "https://v7-webchat.7moor.com/demo.html?accessId=XhRRVj3VLLVYsoNA",
            "isNewSession": false,
            "processNodeId": "222e49d2-d29d-47c0-8d5d-07e72c78e8fd",
            "currentNodeId": "3c27004839394dc5a67d964afc848035",
            "processName": "测试网页的流程",
            "redisRecordDelayTimestamp": 1632381916161,
            "isVisitorBreak": true,
            "leakNum": 0,
            "lastMessage": {
                "content": "2001你好",
                "contentType": "text",
                "lastMessageFrom": "customer"
            },
            "lastMessageTimestamp": 1632381979657,
            "lastVisitorMessageTimestamp": 1632381979657,
            "convertManualTime": "2021-09-23 15:25:24",
            "convertManualTimestamp": 1632381924787,
            "queueNumber": "10000146",
            "welcomeFlag": "3c27004839394dc5a67d964afc848035",
            "recordConvertManualTimestamp": 1632381924875,
            "serviceMan": "manual",
            "agentClaimTimestamp": 1632381925038,
            "lastvisitorMessageTimestamp": 1632381925038,
            "manualTime": "2021-09-23 15:25:25",
            "manualTimestamp": 1632381925038,
            "userName": "李婷",
            "visitorStartWaitTimestamp": 1632381979657,
            "agentFirstReplyTime": "2021-09-23 15:25:41",
            "agentFirstReplyTimestamp": 1632381941283,
            "lastAgentMessageTimestamp": 1632381970285,
            "fromUser": "6062db21d316840011c6b993",
            "lastRedirectTimestamp": 1632381956106,
            "lastRedirectUserTimestamp": 1632381956106,
            "sessionType": "redirect",
            "endTime": "2021-09-23 15:26:24",
            "endTimestamp": 1632381984942,
            "finishKey": "agent_finish",
            "finishReason": "坐席关闭会话",
            "finishUser": "6062db21d316840011c6b992",
            "isSystemPushCsr": true,
            "satisfactionTimeout": 1632381985009,
            "satisfactionData": {
                "satisfactionType": "radioTagText",
                "satisfactionKey": "9a97650c-fcb0-4a09-9984-ca9eeeabde52",
                "satisfactionName": "满意",
                "satisfactionReason": [
                    "满意"
                ],
                "satisfactionProposal": "两个坐席聊天都很满意"
            },
            "sessionId": "c27dd9b1-9981-4780-a052-f60f9def08bf",
            "accessName": "测试网页",
            "dialogueTimes": 35,
            "customerId": "60adeedf7d433727b3e33e5c",
            "queueName": "默认技能组",
            "agentName": "李婷"
        },
        "scheduleHistory": [
            {
                "dateTime": "2021-09-23 15:25:16",
                "processNodeType": "im-node-start",
                "processNodeId": "startNode",
                "processNodeName": "开始节点",
                "type": "node"
            },
            {
                "dateTime": "2021-09-23 15:25:16",
                "processNodeType": "im-node-robot",
                "processNodeId": "49073a2af53b45b78a95842aef4503d8",
                "processNodeName": "机器人节点",
                "type": "node"
            },
            {
                "dateTime": "2021-09-23 15:25:24",
                "processNodeType": "im-node-robot",
                "processNodeId": "49073a2af53b45b78a95842aef4503d8-0",
                "processNodeName": "默认",
                "type": "condition"
            },
            {
                "dateTime": "2021-09-23 15:25:24",
                "processNodeType": "im-node-transfer",
                "processNodeId": "3c27004839394dc5a67d964afc848035",
                "processNodeName": "转人工",
                "type": "node"
            },
            {
                "dateTime": "2021-09-23 15:25:56",
                "processNodeType": "redirect",
                "processNodeId": "redirect",
                "processNodeName": "由李小星01转接到李婷",
                "type": "node"
            }
        ]
    }

3.查询消息列表

• 请求路径 /openapi/im-center/webchat/v1/history
• 请求参数

字段名称	字段类型	是否必传	字段描述	示例
visitorId	string	是	访客Id	'68faa192-a2b1-406c-b877-eda927a64f75'
sessionId	string	否	会话Id	'c2bd32e3-b1e2-4589-b5bb-70a7ab625533'
dateTimeBegin	number	是	消息生成开始时间	'2021-03-01 00:00:00'
dateTimeEnd	number	是	消息生成结束时间	'2021-03-15 00:00:00'
limit	number	否	限制条数	10
page	number	否	限制页数	1

• 请求示例

{

    "visitorId":"2000256@XhRRVj3VLLVYsoNA@cXgpaR4R@web",
    "dateTimeBegin":"2021-09-23 00:00:00",
    "dateTimeEnd":"2021-09-24 00:00:00",
    "sessionId": "68faa192-a2b1-406c-b877-eda927a64f75",
    "limit": 10,
    "page": 1
}

• 返回参数

字段名称	字段类型	字段描述
_id	string	消息ID
flowList	string	列表消息
contentList	string	答案列表
accountId	string	账户
visitorId	string	访客ID
contentType	string	消息类型
content	string	消息内容
platform	string	渠道
createTimestamp	number	创建时间戳
createTime	string	创建时间
type	string	类型 in/out
accessId	string	接入号ID
isShowHtml	boolean	是否展示Html
isHide	boolean	是否隐藏本条消息
dealCustomerMsg	boolean	访客发的消息是否被坐席阅读
dealUserMsg	boolean	坐席发的消息是否被访客阅读
sessionId	string	会话ID

• 返回示例

{
    "_id": "38de5083-ce33-4a6d-967e-21d6b268fc83",
    "visitorId": "2000256@XhRRVj3VLLVYsoNA@cXgpaR4R@web",
    "contentType": "text",
    "type": "out",
    "agentId": "6062db21d316840011c6b992",
    "platform": "pc",
    "createTimestamp": 1632381970324,
    "createTime": "2021-09-23 15:26:10",
    "accessId": "XhRRVj3VLLVYsoNA",
    "accountId": "2000256",
    "isShowHtml": false,
    "userName": "李小星",
    "userHeadImg": "2000256/common/20210728191539/1627470939236/c6baa618a970464ba64331c48fc227ff/微信图片_20210113145435.png",
    "dealUserMsg": true,
    "content": "2000为你服务",
    "sessionId": "c27dd9b1-9981-4780-a052-f60f9def08bf",
    "dealUser": "agent"
}