獲取歷史記錄
獲取歷史記錄接口是云通訊平臺為開發者提供的隔天獲取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日