侧边栏

文档首页


CRM扩展

数据接口

呼叫能力

Android IM SDK手册(暂停使用)

iOS IM SDK手册(暂停使用)

Android SIP SDK手册

iOS SIP SDK手册

客户端标准版快速集成

帮我吧远程SDK版本

网页在线客服集成

微信接入

服务记录接口:在线聊天

在线聊天会话记录

此接口用来获取从微信、网页、机器人、帮我吧客户端来的历史会话记录。

会话JSON格式

名称 类型 注释
r_id int 会话id
type tinyint 会话来源:1-客户端,2-网页,3-微信,4-机器人,5-客服
support_id int 处理客服id
support_name varchar 处理客服名字
client_id varchar 用户id
client_name varchar 用户名字
create_time datetime 创建时间,格式为:2017-8-20 10:23:34
client_ip varchar 用户IP
ip_info datetime 用户IP详情
evaluate tinyint 评价:1-满意,2-一般,3-不满意
contents array 聊天内容

消息JSON格式

名称 类型 注释
spokesman varchar 发言人的名字
spokesman_identity tinyint 发言人的身份:1-客服,2-用户,3-机器人
msg text 聊天内容
msg_type tinyint 聊天内容类型:1-普通文本,2-图片
create_time datetime 消息发送时间

JSON示例

{
   "r_id": 122,
   "type": 2,
   "support_id": 2321,
   "client_id": u2314,
   "create_time": "2017-8-23 12:23:12",
   "client_ip": ”114.248.128.190“,
   "ip_info":  "归属地为北京市",
   "evaluate": 1,
   "contents": [
      {
 	 "spokesman": 213,
  	 "spokesman_identity": 1,
         "msg": "这里是具体的聊天内容",
  	 "msg_type": 1,
  	 "create_time": 2017-8-23 13:12:23
      },
      {
 	 "spokesman": 234,
  	 "spokesman_identity": 1,
         "msg": "这里是具体的聊天内容",
  	 "msg_type": 1,
  	 "create_time": 2017-8-23 13:12:23
      }
   ]

}

会话列表

GET /api/v1/imchat/histories.json

说明:返回所有的会话记录,默认按编号升序排列。

调用者权限

所有客服

调用参数

名称 必需的 类型 注释
client_id int 按用户id筛选
starttime datetime 按创建时间筛选,开始时间,格式为:2017-8-27
endtime datetime 按创建时间筛选,结束时间,格式为:2017-8-29
page int 分页获取,默认为1
per_page int 每页大小,默认为100
curl https://www.bangwo8.com/api/v1/imchat/histories.json -v -u {account}:{password}

返回值示例

{
	"chatrecords": [
		{
			"r_id": 111,
			"type": "1",
			...
		},
		{
			"r_id": 112,
			"type": "2",
			...
		}
                ...
	],
        "count": 42,
        "next_page": "https://www.bangwo8.com/api/v1/visitrecord/histories.json?per_page=40&page=2",
        "previous_page": null
}

查看会话

GET /api/v1/imchat/histories/{id}.json

调用者权限

所有客服

调用参数

名称 必需的 类型 注释
client_id int 按用户id筛选
starttime datetime 按创建时间筛选,开始时间,格式为:2017-8-27
endtime datetime 按创建时间筛选,结束时间,格式为:2017-8-29
page int 分页获取,默认为1
page int 每页大小,默认为100

调用示例

curl https://www.bangwo8.com/api/v1/imchat/histories/{id}.json -v -u {account}:{password}

返回值示例

Status: 200 OK

{
	"chat": {
		"r_id": 1,
		"type": 2,
		...
	}
}

页面工具