云真机

API接口文档


获取群聊和私聊聊天记录

<h5>简要描述</h5> <ul> <li>聊天记录</li> </ul> <h5>请求URL</h5> <ul> <li><code>URL:/wechat/chatLogs</code></li> </ul> <h5>请求方式</h5> <ul> <li>GET </li> </ul> <h5>请求参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">app_id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>APP ID</td> </tr> <tr> <td style="text-align: left;">access_token</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>Access Token</td> </tr> <tr> <td style="text-align: left;">msg_type</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>消息类型(参见“说明-聊天消息”章节)</td> </tr> <tr> <td style="text-align: left;">wxid</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>企微号微信ID</td> </tr> <tr> <td style="text-align: left;">chat_wxid</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>群微信ID或联系人微信ID</td> </tr> <tr> <td style="text-align: left;">chat_type</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>0全部,1私聊,2群聊</td> </tr> <tr> <td style="text-align: left;">svrid</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>消息唯一标识,可配合参数direction向前(direction=1)或向后(direction=2)查找消息</td> </tr> <tr> <td style="text-align: left;">direction</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>配合参数svrid使用,默认取值1。1:表示从后向前查找消息,且从满足条件的消息里倒序取page_size条;&lt;br/&gt;2: 表示从前向后查找消息,且从满足条件的消息里正序取page_size条。&lt;font color=&quot;red&quot;&gt;但返回的数据都是以msg_time正序返回的。&lt;/font&gt;</td> </tr> <tr> <td style="text-align: left;">start_date</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>聊天记录开始日期时间(支持时分秒),如:2021-11-11、2021-11-11 21:21:00</td> </tr> <tr> <td style="text-align: left;">end_date</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>聊天记录结束日期时间(支持时分秒),如:2021-11-11、2021-11-11 21:21:11</td> </tr> <tr> <td style="text-align: left;">start_time</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>聊天记录开始时间戳(秒),如:1651802460</td> </tr> <tr> <td style="text-align: left;">end_time</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>聊天记录结束时间戳(秒),如:1651802460</td> </tr> <tr> <td style="text-align: left;">page</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>页码,默认1</td> </tr> <tr> <td style="text-align: left;">page_size</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>每页条数,默认10,最大100</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code>GET /wechat/chatLogs?app_id=xxx&amp;amp;access_token=xxxx&amp;amp;page=1&amp;amp;page_size=10 HTTP/1.1 Host:oapi-yzj.miaokol.com content-type: application/x-www-form-urlencoded </code></pre> <h5>响应示例</h5> <pre><code>HTTP/1.1 200 OK Content-Type: application/json; charset=UTF-8 { &amp;quot;data&amp;quot;:[ { &amp;quot;client_id&amp;quot;:&amp;quot;CIGABBClt9yMBhihqI6VlICAAyAD&amp;quot;, &amp;quot;content&amp;quot;:{ &amp;quot;items&amp;quot;:[ { &amp;quot;text&amp;quot;:&amp;quot;xxxxxx&amp;quot;, &amp;quot;type&amp;quot;:&amp;quot;text&amp;quot; } ] }, &amp;quot;from_wxid&amp;quot;:&amp;quot;xxxxx&amp;quot;, &amp;quot;msg_hash&amp;quot;:&amp;quot;CIGABBClt9yMBhihqI6VlICAAyAD&amp;quot;, &amp;quot;msg_time&amp;quot;:1637292965000, &amp;quot;msg_type&amp;quot;:&amp;quot;text&amp;quot;, &amp;quot;to_wxid&amp;quot;:&amp;quot;R:xxxxx&amp;quot;, &amp;quot;wx_msgid&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;wx_svrid&amp;quot;:&amp;quot;1003501&amp;quot;, &amp;quot;user_id&amp;quot;:21, &amp;quot;sub_user_id&amp;quot;:0, &amp;quot;corp_id&amp;quot;:2, &amp;quot;wxid&amp;quot;:&amp;quot;xxxxx&amp;quot;, &amp;quot;svrid&amp;quot;:&amp;quot;R:xxxxx,CIGABBClt9yMBhihqI6VlICAAyAD&amp;quot;, &amp;quot;chat_wxid&amp;quot;:&amp;quot;R:xxxxxxx&amp;quot;, &amp;quot;chat_type&amp;quot;:2, &amp;quot;search_content&amp;quot;:&amp;quot;\u7761\u773c\u60fa\u5fea\u60a8\u516c\u660e\u72d7\u72d7\u516c\u6c11\u7ea2\u7c73\u4f60\u4f60\u4f60\u78e8\u5408&amp;quot;, &amp;quot;_id&amp;quot;:&amp;quot;Vx1ENn0BuWaB_AsnAhhs&amp;quot;, &amp;quot;from_wechat&amp;quot;:{ &amp;quot;wxid&amp;quot;:&amp;quot;xxxxxx&amp;quot;, &amp;quot;display_name&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;nickname&amp;quot;:&amp;quot;xxxxxxx&amp;quot;, &amp;quot;avatar&amp;quot;:&amp;quot;https:\/\/wework.qpic.cn\/bizmail\/SXXnqFgLeDkhtLm2b2z021GAbIICbw6vN5cEKB2TLlt5FLVkTFJVTA\/0&amp;quot;, &amp;quot;corp_wxid&amp;quot;:&amp;quot;xxxxxx&amp;quot;, &amp;quot;wechat_type&amp;quot;:2 }, &amp;quot;to_wechat&amp;quot;:{ &amp;quot;wxid&amp;quot;:&amp;quot;R:xxxxx&amp;quot;, &amp;quot;nickname&amp;quot;:&amp;quot;xxxxx&amp;quot;, &amp;quot;avatar&amp;quot;:&amp;quot;\/\/qiyunbao.oss-cn-hangzhou.aliyuncs.com\/avatar\/1688858141235096\/dc542f343140fb37055de061e1c03110.png&amp;quot; } } ], &amp;quot;pager&amp;quot;:{ &amp;quot;page&amp;quot;:1, &amp;quot;perpage&amp;quot;:10, &amp;quot;numRecords&amp;quot;:2522, &amp;quot;numPages&amp;quot;:253, &amp;quot;firstRecord&amp;quot;:0, &amp;quot;lastRecord&amp;quot;:9 }, &amp;quot;errcode&amp;quot;:0 } </code></pre> <h5>响应说明</h5> <ul> <li>data类型为数组,数组项格式说明如下</li> </ul> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">msg_time</td> <td style="text-align: left;">int</td> <td>消息时间戳(毫秒)</td> </tr> <tr> <td style="text-align: left;">msg_type</td> <td style="text-align: left;">string</td> <td>消息类型,详见说明-&lt;a href=&quot;<a href="https://www.showdoc.com.cn/yunzhenji/11490690012909560&quot;&gt;聊天消息&lt;/a&gt">https://www.showdoc.com.cn/yunzhenji/11490690012909560&quot;&gt;聊天消息&lt;/a&gt</a>;</td> </tr> <tr> <td style="text-align: left;">svrid</td> <td style="text-align: left;">string</td> <td>消息全局唯一ID</td> </tr> <tr> <td style="text-align: left;">content</td> <td style="text-align: left;">string</td> <td>消息展示内容,详见说明-&lt;a href=&quot;<a href="https://www.showdoc.com.cn/yunzhenji/11490690012909560&quot;&gt;聊天消息&lt;/a&gt">https://www.showdoc.com.cn/yunzhenji/11490690012909560&quot;&gt;聊天消息&lt;/a&gt</a>;</td> </tr> <tr> <td style="text-align: left;">chat_type</td> <td style="text-align: left;">int</td> <td>0全部,1私聊,2群聊</td> </tr> <tr> <td style="text-align: left;">from_wechat</td> <td style="text-align: left;">object</td> <td>发送者信息</td> </tr> <tr> <td style="text-align: left;">to_wechat</td> <td style="text-align: left;">object</td> <td>接收者信息</td> </tr> <tr> <td style="text-align: left;">from_wxid</td> <td style="text-align: left;">string</td> <td>发送者wxid</td> </tr> <tr> <td style="text-align: left;">to_wxid</td> <td style="text-align: left;">string</td> <td>接收者wxid</td> </tr> <tr> <td style="text-align: left;">wxid</td> <td style="text-align: left;">string</td> <td>企微号wxid</td> </tr> <tr> <td style="text-align: left;">chat_wxid</td> <td style="text-align: left;">string</td> <td>客户或客户群wxid</td> </tr> </tbody> </table>

页面列表

ITEM_HTML