云真机

API接口文档


黑白名单列表

<p>目录:</p> <h4>&lt;a href=&quot;#blackContactList&quot;&gt;<strong> 【黑名单列表】</strong>&lt;/a&gt;</h4> <h4>&lt;a href=&quot;#whiteContactList&quot;&gt;<strong> 【白名单列表】</strong>&lt;/a&gt;</h4> <p>&lt;br&gt;</p> <p>&lt;a id=&quot;blackContactList&quot;&gt;&lt;/a&gt;</p> <h3><strong> 获取黑名单列表</strong></h3> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/wechat/blackContactList</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;">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/blackContactList?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;data&amp;quot;:[         {             &amp;quot;id&amp;quot;:1149497,             &amp;quot;user_id&amp;quot;:21,             &amp;quot;sub_user_id&amp;quot;:0,             &amp;quot;corp_id&amp;quot;:0,             &amp;quot;wxid&amp;quot;:&amp;quot;1111&amp;quot;,             &amp;quot;nickname&amp;quot;:&amp;quot;111&amp;quot;,             &amp;quot;nickname_pinyin&amp;quot;:&amp;quot;111&amp;quot;,             &amp;quot;avatar&amp;quot;:&amp;quot;&amp;quot;,             &amp;quot;gender&amp;quot;:1,             &amp;quot;wechat_type&amp;quot;:2,             &amp;quot;corp_wxid&amp;quot;:&amp;quot;111&amp;quot;,             &amp;quot;add_from&amp;quot;:2,             &amp;quot;ctime&amp;quot;:1667978152,             &amp;quot;utime&amp;quot;:1667978152,             &amp;quot;corp&amp;quot;:{                 &amp;quot;id&amp;quot;:42,                 &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;1111&amp;quot;,                 &amp;quot;verified&amp;quot;:2,                 &amp;quot;full_name&amp;quot;:&amp;quot;1111&amp;quot;,                 &amp;quot;short_name&amp;quot;:&amp;quot;111&amp;quot;,                 &amp;quot;address&amp;quot;:&amp;quot;&amp;quot;,                 &amp;quot;legal_person_name&amp;quot;:&amp;quot;111&amp;quot;,                 &amp;quot;legal_person_wxid&amp;quot;:&amp;quot;1111&amp;quot;,                 &amp;quot;logo&amp;quot;:&amp;quot;https:1111&amp;quot;,                 &amp;quot;ctime&amp;quot;:1635158651,                 &amp;quot;utime&amp;quot;:1667465395             }         }     ],     &amp;quot;pager&amp;quot;:{         &amp;quot;page&amp;quot;:1,         &amp;quot;perPage&amp;quot;:10,         &amp;quot;numRecords&amp;quot;:1,         &amp;quot;numPages&amp;quot;:1,         &amp;quot;firstRecord&amp;quot;:0,         &amp;quot;lastRecord&amp;quot;:0     },     &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;">avatar</td> <td style="text-align: left;">string</td> <td>黑名单成员头像</td> </tr> <tr> <td style="text-align: left;">corp</td> <td style="text-align: left;">object</td> <td>黑名单成员所属企业信息</td> </tr> </tbody> </table> <p>&lt;br&gt; &lt;a id=&quot;whiteContactList&quot;&gt;&lt;/a&gt;</p> <h3><strong> 获取白名单列表</strong></h3> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/wechat/whiteContactList</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;">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/whiteContactList?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;data&amp;quot;:[         {             &amp;quot;id&amp;quot;:1149497,             &amp;quot;user_id&amp;quot;:21,             &amp;quot;sub_user_id&amp;quot;:0,             &amp;quot;corp_id&amp;quot;:0,             &amp;quot;wxid&amp;quot;:&amp;quot;1111&amp;quot;,             &amp;quot;nickname&amp;quot;:&amp;quot;111&amp;quot;,             &amp;quot;nickname_pinyin&amp;quot;:&amp;quot;111&amp;quot;,             &amp;quot;avatar&amp;quot;:&amp;quot;&amp;quot;,             &amp;quot;gender&amp;quot;:1,             &amp;quot;wechat_type&amp;quot;:2,             &amp;quot;corp_wxid&amp;quot;:&amp;quot;111&amp;quot;,             &amp;quot;add_from&amp;quot;:2,             &amp;quot;ctime&amp;quot;:1667978152,             &amp;quot;utime&amp;quot;:1667978152,             &amp;quot;corp&amp;quot;:{                 &amp;quot;id&amp;quot;:42,                 &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;1111&amp;quot;,                 &amp;quot;verified&amp;quot;:2,                 &amp;quot;full_name&amp;quot;:&amp;quot;1111&amp;quot;,                 &amp;quot;short_name&amp;quot;:&amp;quot;111&amp;quot;,                 &amp;quot;address&amp;quot;:&amp;quot;&amp;quot;,                 &amp;quot;legal_person_name&amp;quot;:&amp;quot;111&amp;quot;,                 &amp;quot;legal_person_wxid&amp;quot;:&amp;quot;1111&amp;quot;,                 &amp;quot;logo&amp;quot;:&amp;quot;https:1111&amp;quot;,                 &amp;quot;ctime&amp;quot;:1635158651,                 &amp;quot;utime&amp;quot;:1667465395             }         }     ],     &amp;quot;pager&amp;quot;:{         &amp;quot;page&amp;quot;:1,         &amp;quot;perPage&amp;quot;:10,         &amp;quot;numRecords&amp;quot;:1,         &amp;quot;numPages&amp;quot;:1,         &amp;quot;firstRecord&amp;quot;:0,         &amp;quot;lastRecord&amp;quot;:0     },     &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;">avatar</td> <td style="text-align: left;">string</td> <td>白名单成员头像</td> </tr> <tr> <td style="text-align: left;">corp</td> <td style="text-align: left;">object</td> <td>白名单成员所属企业信息</td> </tr> </tbody> </table>

页面列表

ITEM_HTML