管理一洽业务数据·一洽客服系统
目录
1. 设置会话数据业务标记
2. 获取对话记录显示页面地址
1.设置会话数据业务状态
通过此接口开发者可对一洽系统中产生的会话(机器人对话、人工对话、留言、推送)信息设置企业自己的业务标记,比如:是否提交了工单等。
接口地址
http请求方式: POST
https://${apiServer}/manage/setVisitorChatSign/${appId}/1.1?accessToken=${accessToken}
访问限制
每个账号24小时内限制请求50000次
get参数说明
参数 | 是否必须 | 说明 |
---|---|---|
accessToken | 是 | 接口调用凭证 |
Post数据说明
json数据解释
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
visitorId | string | 是 | 当前访客ID。 服务器交互下发给开发者的visitorData中的visitorId。 企业业务系统集成中js获取到的visitorData的visitorId。 |
uniqueRecordId | string | 是 | 会话记录的ID。 服务器交互下发给开发者的chatData中的chatRecordId。 企业业务系统集成中js获取到的chatData的uniqueRecordId。 |
chatSign | int | 是 | 设置的业务状态。允许的值0和1 |
示例:
{ "uniqueRecordId":"1_6464608",
"chatSign":"1",
"visitorId":"web2440352055"
}
返回说明
返回数据格式:json
正确返回示例:
{"errcode":0,"errmsg":"success"}
错误返回示例:
{"errcode":104,"errmsg":"accessToken错误"}
2.获取对话记录显示页面地址
通过此接口开发者可获取某一条记录或者某一个访客的历史记录显示地址,开发者可将此地址动态显示在需要显示的位置,从而实现格式化的消息记录展示,每个页面地址只能加载一次,加载完成后地址失效。
如需要加载访客的所有对话记录,查看上一条下一条对话记录的操作2个小时内有效,如果2个小时内没有查看则本页面失效。
接口地址
http请求方式: GET
https://${apiServer}/history/chatContentUrl/${appId}?accessToken=${accessToken}
访问限制
每个账号24小时内限制请求100000次
参数说明
参数 | 是否必须 | 说明 |
---|---|---|
accessToken | 是 | 接口调用凭证 |
chatRecordId | 否 | 需要查看的历史记录的chatRecordId,服务器交互下发给开发者的chatRecordId |
visitorId | 否 | 访客id: 1、只传visitorId 显示访客的所有消息记录:默认显示最近一条记录。可以手动点击查看历史记录。 2、传chatRecordId+visitorId 消息定位到chatRecordId该对话中。可以手动点击查看历史记录 |
返回说明
返回数据格式:json
字段 | 类型 | 可为空 | 说明 |
---|---|---|---|
chatContentUrl | int | 否 | 查看指定ID或者指定访客的页面地址 |
返回示例
{
"result": {
"data": {
"chatContentUrl": "https://e.echatsoft.com/visitor/common/externalRecord.html?appid=9DE6D14FFF9806D4BCD1EF555BE766CD&token=hif21f86831c3a470f9a92e2b1179d17c7&queryType=1"
},
"dataType": 3
},
"successful": 1
}