差别
这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 | ||
im:server:basics:chatrecord [2019/11/01 06:39] huanxinfudh |
im:server:basics:chatrecord [2021/09/06 04:42] allenwang |
||
---|---|---|---|
行 14: | 行 14: | ||
|from|发送人username| | |from|发送人username| | ||
|to|接收人的username或者接收group的ID| | |to|接收人的username或者接收group的ID| | ||
- | |chat_type|用来判断单聊还是群聊。chat: 单聊;groupchat: 群聊| | + | |chat_type|用来判断单聊、群聊还是聊天室。chat: 单聊;groupchat: 群聊;chatroom: 聊天室| |
|payload|消息bodies,不同的消息类型;消息ext,自定义扩展属性等| | |payload|消息bodies,不同的消息类型;消息ext,自定义扩展属性等| | ||
行 197: | 行 197: | ||
====== REST API ====== | ====== REST API ====== | ||
- | 导出聊天记录接口不是实时接口,获取成功存在一定的延时,不能够作为实时拉取消息的接口使用。目前提供两种方式来导出聊天记录,即**下载历史消息文件**和**拉取历史消息**两个接口,''其中拉取历史消息接口为旧有接口并于2017年3月1日起停止使用,建议使用下载历史消息文件接口''。以下所有 API 均需要企业管理员权限才能访问。 | + | 导出聊天记录接口不是实时接口,获取成功存在一定的延时,不能够作为实时拉取消息的接口使用。以下 API 均需要企业管理员权限才能访问。 |
需要使用 REST API 导出聊天记录,可以通过使用文档中嵌入的[[http://api-docs.easemob.com/|Easemob REST API]]进行在线测试。 | 需要使用 REST API 导出聊天记录,可以通过使用文档中嵌入的[[http://api-docs.easemob.com/|Easemob REST API]]进行在线测试。 | ||
行 203: | 行 203: | ||
^名称^请求^描述^ | ^名称^请求^描述^ | ||
|获取历史消息文件|/{org_name}/{app_name}/chatmessages/${time}|根据请求的时间范围返回数据的文件,下载查看| | |获取历史消息文件|/{org_name}/{app_name}/chatmessages/${time}|根据请求的时间范围返回数据的文件,下载查看| | ||
- | |拉取历史消息''已停用''|/{org_name}/{app_name}/chatmessages|根据请求的时间范围实时获取历史聊天记录| | ||
行 214: | 行 213: | ||
**重要提醒:**获取 token 时服务器会返回 token 有效期,具体值参考接口返回的 expires_in 字段值。由于网络延迟等原因,系统不保证 token 在此值表示的有效期内绝对有效,如果发现 token 使用异常请重新获取新的 token,比如“http response code”返回 401。另外,请不要频繁向服务器发送获取 token 的请求,同一账号发送此请求超过一定频率会被服务器封号,切记,切记!! | **重要提醒:**获取 token 时服务器会返回 token 有效期,具体值参考接口返回的 expires_in 字段值。由于网络延迟等原因,系统不保证 token 在此值表示的有效期内绝对有效,如果发现 token 使用异常请重新获取新的 token,比如“http response code”返回 401。另外,请不要频繁向服务器发送获取 token 的请求,同一账号发送此请求超过一定频率会被服务器封号,切记,切记!! | ||
- | client_id 和 client_secret 可以在环信管理后台的 [[http://www.google.com|APP 详情页面]]看到。 | + | ''此接口一次只能获取一个小时的历史消息'' |
+ | |||
+ | client_id 和 client_secret 可以在环信管理后台的 [[https://console.easemob.com/app/applicationOverview/detail|APP 详情页面]]看到。 | ||
=== HTTP Request === | === HTTP Request === | ||
行 257: | 行 258: | ||
"applicationName": "testapp" | "applicationName": "testapp" | ||
} | } | ||
+ | |||
+ | 注意:url是有过期时间的,url中的Expires对应的时间戳就是过期时间(秒),请及时通过url下载聊天记录文件,过期后会下载不到,需要重新调用"获取历史消息文件"接口获取新的url。 | ||
</code> | </code> | ||
行 285: | 行 288: | ||
> 提示 | > 提示 | ||
+ | |||
+ | 极少数情况下,聊天记录中的消息可能重复地被记录。 | ||
查询的时间格式为10位数字形式(YYYYMMDDHH),例如要查询2016年12月10号7点到8点的历史记录,则需要输入2016121007,7:00:00的信息也会包含在这个文件里。 | 查询的时间格式为10位数字形式(YYYYMMDDHH),例如要查询2016年12月10号7点到8点的历史记录,则需要输入2016121007,7:00:00的信息也会包含在这个文件里。 |