APIs

企业若使用APIs访问工作台的对话、留言、客户等资源，需要在「设置中心 - 开发者 - APIs」中获取“APPID”和密钥，后续调用以下 APIs 时都需要使用 。

注意：使用开放接口需要一定技术能力，请由网站技术人员参考本文代码对接实现。

请求的 Header 需要带上以下参数：

参数	类型	说明
accountid	int	账号id
appid	string	appid
secret	string	密钥

获取单个会话

通过HTTP Post 方式请求 /api/open/getsession，参数如下：

参数	类型	说明
visitorid	string	访客id

响应：

{
	error_code：0， //错误码
	description："success", 
	data：{
	      单个会话信息，具体参数可去webhooks中查找会话模型
	      }
}

获取单个客户

通过HTTP Post 方式请求 /api/open/getcustomer，参数如下：

参数	类型	说明
visitorid	string	访客id

响应：

{
	"data": {
		"id": "标识id",  
		"visitorid": "访客id",
		"name": "姓名",
		"sex": 0, //性别 
		"age": 0 //年龄
	},
	"error_code": 0,
	"description": "success"
}

获取单个留言消息

通过HTTP Post 方式请求 /api/open/getleavemessages，参数如下：

参数	类型	说明
sessionid	string	访客会话id

响应：

{
	"data": [{
		"createtime": "创建时间",  
		"contenttype": "内容类型",
		"msgtype": "消息类别",
		"content": "留言内容",
		"operatorid": "客服id",
		"groupid": "客服组",
	}],
	"error_code": 0,
	"description": "success"
}

获取留言会话，翻页查询

通过HTTP Post 方式请求 /api/open/getleavesessions，参数如下：

参数	类型	说明
page	int	页码
size	int	每页行数
timebegin	datetime	时间范围 开始
timeend	datetime	时间范围 结束

响应：

{
	"data": {
		"page": "页码",  
		"count": "总数",
		"items": "留言会话列表", //数据格式见留言会话模型
	},
	"error_code": 0, //错误码
	"description": ""
}

留言消息模型

参数	类型	说明
createtime	datetime	留言创建时间
contenttype	int	留言内容类别
msgtype	int	消息类别
content	string	留言内容，根据消息类别存储为json格式
operatorid	int	最后处理客服id
groupid	int	最后处理客服分组id

留言会话模型

参数	类型	说明
sessionid	string	会话id
visitorid	string	访客永久身份
createtime	datetime	留言创建时间
accessway	int	会话接入方式/渠道
nickname	string	访客昵称
remark	string	访客备注
appid	string	应用接入appid
appname	string	应用名称
email	string	客人邮箱地址
status	int	处理状态
updateby	int	更新人
updatetime	datetime	最后修改时间
operatorid	int	最后处理客服id
groupid	int	最后处理客服分组id