云真机

API接口文档


获取客户群列表

<h5>简要描述</h5> <ul> <li>客户群列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/wechat/rooms</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST </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 style="text-align: left;">说明</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 style="text-align: left;">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 style="text-align: left;">Access Token</td> </tr> <tr> <td style="text-align: left;">page</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td style="text-align: left;">页码,默认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 style="text-align: left;">每页条数,默认10,最大100</td> </tr> <tr> <td style="text-align: left;">rel_wxid</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">在群服务的企微号wxid</td> </tr> <tr> <td style="text-align: left;">wxids</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td style="text-align: left;">群wxid,多个以英文逗号分隔,如:R:xxx1,R:xxx2</td> </tr> <tr> <td style="text-align: left;">tag_ids</td> <td style="text-align: left;">否</td> <td style="text-align: left;">array</td> <td style="text-align: left;">群标签ID,数组,如:[&quot;9884&quot;], &lt;font color=&quot;red&quot;&gt;<strong>必须使用POST请求</strong>&lt;/font&gt;</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code>POST /wechat/rooms HTTP/1.1 Host:oapi-yzj.miaokol.com Content-Type: application/json; charset=UTF-8 {     &amp;quot;app_id&amp;quot;:&amp;quot;xxx&amp;quot;,     &amp;quot;access_token&amp;quot;:&amp;quot;xxx&amp;quot;,     &amp;quot;page&amp;quot;:1,     &amp;quot;page_size&amp;quot;:100 } </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;id&amp;quot;:1,             &amp;quot;user_id&amp;quot;:21,             &amp;quot;sub_user_id&amp;quot;:0,             &amp;quot;corp_id&amp;quot;:1,             &amp;quot;wxid&amp;quot;:&amp;quot;R:&amp;quot;,             &amp;quot;avatar&amp;quot;:&amp;quot;//qiyunbao.oss-cn-hangzhou.aliyuncs.com/avatar/1688850011358436/c9bf9a6964c59388c2a0e343a3851b54.png&amp;quot;,             &amp;quot;owner_wxid&amp;quot;:&amp;quot;xxxxx&amp;quot;,             &amp;quot;wx_ctime&amp;quot;:1599007442,             &amp;quot;corp_tag_wxids&amp;quot;:&amp;quot;&amp;quot;,             &amp;quot;ctime&amp;quot;:1631268821,             &amp;quot;utime&amp;quot;:1631268821,             &amp;quot;nickname&amp;quot;:&amp;quot;&amp;quot;,             &amp;quot;nickname_pinyin&amp;quot;:&amp;quot;&amp;quot;,             &amp;quot;member_count&amp;quot;:3,             &amp;quot;biz_bitval&amp;quot;:0,             &amp;quot;announcement&amp;quot;:null, &amp;quot;invite_confirm&amp;quot;:0         }     ],     &amp;quot;pager&amp;quot;:{         &amp;quot;page&amp;quot;:1,         &amp;quot;perPage&amp;quot;:10,         &amp;quot;numRecords&amp;quot;:592,         &amp;quot;numPages&amp;quot;:60,         &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;">user_id</td> <td style="text-align: left;">int</td> <td>用户id</td> </tr> <tr> <td style="text-align: left;">wxid</td> <td style="text-align: left;">string</td> <td>群微信id</td> </tr> <tr> <td style="text-align: left;">owner_wxid</td> <td style="text-align: left;">string</td> <td>群主微信id</td> </tr> <tr> <td style="text-align: left;">nickname</td> <td style="text-align: left;">string</td> <td>群名称</td> </tr> <tr> <td style="text-align: left;">member_count</td> <td style="text-align: left;">int</td> <td>群成员人数</td> </tr> <tr> <td style="text-align: left;">invite_confirm</td> <td style="text-align: left;">int</td> <td>群聊邀请是否需要确认:0否;1是;</td> </tr> <tr> <td style="text-align: left;">tag_id</td> <td style="text-align: left;">array</td> <td>群标签id,[]或[xxx,xxx],&lt;font color=&quot;red&quot;&gt;<strong>POST请求时才有该字段</strong>&lt;/font&gt;</td> </tr> <tr> <td style="text-align: left;">tags</td> <td style="text-align: left;">array</td> <td>群标签名称,[]或[xxx,xxx],&lt;font color=&quot;red&quot;&gt;<strong>POST请求时才有该字段</strong>&lt;/font&gt;</td> </tr> <tr> <td style="text-align: left;">pager</td> <td style="text-align: left;">object</td> <td>分页信息</td> </tr> </tbody> </table>

页面列表

ITEM_HTML