云真机

API接口文档


获取登录过的企微号列表

<h5>简要描述</h5> <ul> <li>企微号列表(在智域管家.云真机平台登录过的企微号列表)</li> </ul> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/wechat/list</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;">online</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>当前是否在线,0否;1是;默认不传或传-1表示全部;</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/list?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 { &amp;quot;id&amp;quot;:199, &amp;quot;wxid&amp;quot;:&amp;quot;xxxxxxx&amp;quot;, &amp;quot;nickname&amp;quot;:&amp;quot;xxxxx&amp;quot;, &amp;quot;full_name&amp;quot;:&amp;quot;xxxxxx&amp;quot;, &amp;quot;avatar&amp;quot;:&amp;quot;https:\/\/wework.qpic.cn\/bizmail\/nSlfpbgLxHcbb63BAwU1ib4xLUjVQlMSpIia8lcleNBPjo2c2DB5M0SA\/0&amp;quot;, &amp;quot;mobile&amp;quot;:&amp;quot;1360xxxxxxx&amp;quot;, &amp;quot;group_id&amp;quot;:0, &amp;quot;corp_id&amp;quot;:2, &amp;quot;online&amp;quot;:1, &amp;quot;last_login_time&amp;quot;:1637291466, &amp;quot;last_offline_time&amp;quot;:0, &amp;quot;ctime&amp;quot;:1637291466, &amp;quot;utime&amp;quot;:1637291466, &amp;quot;corp&amp;quot;:{ &amp;quot;id&amp;quot;:2, &amp;quot;name&amp;quot;:&amp;quot;xxxxxx&amp;quot;, &amp;quot;wxid&amp;quot;:&amp;quot;xxxxx&amp;quot;, &amp;quot;remark&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;legal_person_name&amp;quot;:&amp;quot;xxxx&amp;quot;, &amp;quot;legal_person_id&amp;quot;:&amp;quot;xxxxxxx&amp;quot;, &amp;quot;ctime&amp;quot;:1631175780, &amp;quot;utime&amp;quot;:1637213332, &amp;quot;verify_type&amp;quot;:2, &amp;quot;short_name&amp;quot;:&amp;quot;xxxxx&amp;quot; } } ], &amp;quot;pager&amp;quot;:{ &amp;quot;page&amp;quot;:1, &amp;quot;perPage&amp;quot;:10, &amp;quot;numRecords&amp;quot;:54, &amp;quot;numPages&amp;quot;:6, &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;">wxid</td> <td style="text-align: left;">string</td> <td>企微号wxid</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;">full_name</td> <td style="text-align: left;">string</td> <td>全名(企微端对外信息显示名字)</td> </tr> <tr> <td style="text-align: left;">wx_alias</td> <td style="text-align: left;">string</td> <td>别名</td> </tr> <tr> <td style="text-align: left;">avatar</td> <td style="text-align: left;">string</td> <td>头像</td> </tr> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">string</td> <td>手机号</td> </tr> <tr> <td style="text-align: left;">sub_user_id</td> <td style="text-align: left;">int</td> <td>登录企微号的子账号ID,0表示主账号,子账号号列表参见&lt;a href=&quot;<a href="https://www.showdoc.com.cn/yunzhenji/11490711586735262&quot;&gt;[点击跳转]&lt;/a&gt">https://www.showdoc.com.cn/yunzhenji/11490711586735262&quot;&gt;[点击跳转]&lt;/a&gt</a>;</td> </tr> <tr> <td style="text-align: left;">group_id</td> <td style="text-align: left;">string</td> <td>企微号分组ID,0表示未分组企,多个会以逗号分隔;企微号分组列表参见&lt;a href=&quot;<a href="https://www.showdoc.com.cn/yunzhenji/11490712130071370&quot;&gt;[点击跳转]&lt;/a&gt">https://www.showdoc.com.cn/yunzhenji/11490712130071370&quot;&gt;[点击跳转]&lt;/a&gt</a>;</td> </tr> <tr> <td style="text-align: left;">corp_id</td> <td style="text-align: left;">int</td> <td>企业ID</td> </tr> <tr> <td style="text-align: left;">online</td> <td style="text-align: left;">int</td> <td>是否在线</td> </tr> <tr> <td style="text-align: left;">last_login_time</td> <td style="text-align: left;">int</td> <td>上次登录时间戳(秒)</td> </tr> <tr> <td style="text-align: left;">last_offline_time</td> <td style="text-align: left;">int</td> <td>上次下线时间戳(秒)</td> </tr> <tr> <td style="text-align: left;">corp</td> <td style="text-align: left;">object</td> <td>企业信息</td> </tr> <tr> <td style="text-align: left;">corp.name</td> <td style="text-align: left;">string</td> <td>企业名称</td> </tr> <tr> <td style="text-align: left;">corp.short_name</td> <td style="text-align: left;">string</td> <td>企业简称</td> </tr> <tr> <td style="text-align: left;">corp.legal_person_name</td> <td style="text-align: left;">string</td> <td>企业注册者名称</td> </tr> <tr> <td style="text-align: left;">corp.legal_person_id</td> <td style="text-align: left;">string</td> <td>企业注册者Id</td> </tr> <tr> <td style="text-align: left;">pager</td> <td style="text-align: left;">object</td> <td>分页信息,总数:pager.numRecords</td> </tr> </tbody> </table>

页面列表

ITEM_HTML