Kchat对话接口
此接口提供给客服和管理员，用来查看Kchat历史对话记录。
对话JSON格式
| Name | Type | Comment |
|---|---|---|
| id | number | 对话ID |
| type | string | 对话类型 |
| started_by | string | 对话创建者的身份类型 |
| status | string | 对话状态 |
| agent_id | string | 对话受理坐席ID |
| rating | string | 满意度评分 |
| visitor_id | string | 访客ID |
| user_id | number | 已关联的工单系统用户ID |
| created_at | string | 对话创建时间 |
| assigned_at | string | 对话受理时间 |
| end_at | string | 对话结束时间 |
| messages | array | 对话的消息列表 |
消息JSON格式
| Name | Type | Comment |
|---|---|---|
| id | number | 消息ID |
| chat_id | number | 所属对话ID |
| type | string | 消息状态 |
| name | string | 访客姓名 |
| msg | string | 消息内容 |
| is_read | number | 是否已读 |
| created_at | string | 消息发送时间 |
| upload_id | number | 文件ID |
| upload | object | 文件内容 |
对话JSON示例
{
"id": 290,
"type": "chat",
"started_by": "visitor",
"status": "close",
"agent_id": 2192,
"rating": null,
"visitor_id": 547,
"user_id": 45190,
"created_at": "2015-04-25 08:04:12",
"assigned_at": "2015-04-25 08:04:41",
"end_at": "2015-04-30 09:55:01",
"messages": [
{
"id": 2619,
"chat_id": 290,
"type": "chat.memberjoin",
"name": "访客5",
"msg": "你好",
"upload_id": null,
"is_read": 1,
"created_at": "2015-04-25 08:04:12",
"upload": null
},
{
"id": 2620,
"chat_id": 290,
"type": "chat.msg",
"name": "访客5",
"msg": "你好，在吗？",
"upload_id": null,
"is_read": 1,
"created_at": "2015-04-25 08:04:12",
"upload": null
}
]
}对话列表
GET /apiv2/chats.json
返回所有对话记录，默认按编号升序排列。
调用权限
agent
Query参数
| Name | Required | Type | Comment |
|---|---|---|---|
| visitor_id | 否 | number | 筛选指定访客的对话列表 |
| start | 否 | string | 按创建时间筛选，开始时间，如：2016-01-01 |
| end | 否 | string | 按创建时间筛选，结束时间，如：2016-01-01 |
| user_id | 否 | number | 工单系统用户ID（IM访客已关联工单系统用户） |
| page | 否 | number | 页码，默认为 1 |
| per_page | 否 | number | 分页尺寸，默认为 100 |
curl示例
curl https://{subdomain}.kf5.com/apiv2/chats.json -v -u {email_address}:{password}
curl https://{subdomain}.kf5.com/apiv2/chats.json?visitor_id={visitor_id}&per_page={per_page}&page={page} \
-v -u {email_address}:{password}
返回示例
Status: 200 OK
{
"chats": [
{
"id": 1,
"type": "chat",
...
},
{
"id": 2,
"type": "chat",
...
}
]
}查看对话
GET /apiv2/chats/{id}.json
调用权限
agent
curl示例
curl https://{subdomain}.kf5.com/apiv2/chats/{id}.json -v -u {email_address}:{password}
返回示例
Status: 200 OK
{
"chat": {
"id": 1,
"type": "chat",
...
}
}