获取历史记录接口是云通讯平台为开发者提供的隔天获取im历史记录的接口。该接口支持按天获取,获取的是应用下所有账号的消息记录。
如果要使用该接口,需要在控制台IM管理页面—>选择应用—>点击IM专业版功能配置—>进入历史消息页面,勾选按天生成历史消息记录。当天勾选后,第二天可以获取历史记录。
1、请求地址
POST /2013-12-26/Application/{appId}/IM/GetMsgRecordsFile
2、请求包头
请参阅《鉴权说明》
3、请求包体
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
date | String | 可选 |
消息日期,如不填默认取前一天或前一周 time_type为day时,为消息数据当天日期,格式‘yyyy-mm-dd’; |
type | String | 可选 | 时间类型,天:day |
4、请求示例
POST /2013-12-26/Application/20150314000000110000000000000010/MsgRecordsNew?sig=C1F20E7A97 HTTP/1.1 Accept:application/json; Content-Type:application/json;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyM= {"date":"2017-12-23","type":"day"}
5、响应包体
注: 使用fileUrl下载时,请在fileUrl后拼接?fileToken={fileToken},fileToken为响应中的fileToken。返回的消息记录文件只能下载一次,请注意保存消息文件。
属性 | 类型 | 约束 | 说明 |
---|---|---|---|
statusCode | String | 必选 | 请求状态码,取值000000(成功)。 |
fileToken | String | 必选 | 下载文件校验码 |
fileUrl | String | 必选 | 下载URL |
6、响应示例
HTTP/1.1 200 OK Content-Length:586 { HTTP/1.1 200 OK Content-Length: 641 { "statusCode":"000000", "fileToken":"e861b00fd412fc4ae4ca0b02746b8e93", "fileUrl":"http://ip:port/imdown/aaf98f894f16fdb7014f24ff7a93122a/2015-11-08/0ee53128dddb4731b344698f82e78e67_ aaf98f894f16fdb7014f24ff7a93122a_2015-11-08_day.zip" }
7、历史文件参数说明
属性 | 说明 |
---|---|
app_id_sender | 发送方appkey |
msg_sender | 发送者 |
app_id_receiver | 接收方appkey |
msg_receiver | 接收者 |
device_type | 发送者设备类型 1: Android Phone 2: iPhone 10: iPad 11: Android Pad 20: PC 21: H5
|
msg_len | 消息长度 |
msg_type | 消息类型 1:文本消息 2:语音消息 3:视频消息 4:图片消息 5:位置消息 6:文件
|
msg_content | 消息内容 |
msg_file_url | 附件下载地址 |
msg_file_name | 附件名称 |
group_id | 群组ID |
msg_id | 消息ID |
msg_file_size | 附件大小,单位字节 |
date_created | 创建时间 |
msg_domain | 自定义数据,需要based64解密 |
ext_opts | 平台扩展信息 |
文档更新时间:2018年1月4日