获取/刷新客户群成员列表
<p>目录:</p>
<h4><a href="#getList"><strong> 【获取客户群成员列表】</strong></a></h4>
<h4><a href="#refresh"><strong> 【刷新客户群成员信息】</strong></a></h4>
<p><br></p>
<h5>简要描述</h5>
<p><a id="getList"></a></p>
<h2>1、获取客户群成员列表</h2>
<h5>请求URL</h5>
<ul>
<li><code>https://oapi-yzj.miaokol.com/wechat/roomMembers</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;">room_wxid</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>群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>群成员wxid，多个以","分隔,示例:wxids=xxxxxx,xxxxxx</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/roomMembers?app_id=xxx&amp;access_token=xxxx&amp;room_wxid=xxx&amp;page=1&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
{
&quot;data&quot;:[
{
&quot;id&quot;:8715,
&quot;user_id&quot;:1,
&quot;sub_user_id&quot;:0,
&quot;corp_id&quot;:3,
&quot;room_wxid&quot;:&quot;R:xxxxx&quot;,
&quot;wxid&quot;:&quot;xxxxx&quot;,
&quot;nickname&quot;:&quot;123456&quot;,
&quot;nickname_pinyin&quot;:&quot;123456&quot;,
&quot;avatar&quot;:&quot;&quot;,
&quot;remark&quot;:&quot;123456&quot;,
&quot;desc&quot;:&quot;&quot;,
&quot;entry_time&quot;:1634105433,
&quot;quit_time&quot;:1636105438,
&quot;inviter_wxid&quot;:&quot;1688850011722885&quot;,
&quot;is_admin&quot;:0,
&quot;is_owner&quot;:0,
&quot;is_deleted&quot;:0,
&quot;ctime&quot;:1635327199,
&quot;utime&quot;:1637218699,
&quot;gender&quot;:0,
&quot;wechat_type&quot;:1,
&quot;corp_wxid&quot;:&quot;xxxxxx&quot;,
&quot;display_name&quot;:&quot;&quot;,
&quot;display_name_pinyin&quot;:&quot;&quot;,
&quot;join_scene&quot;:1,
&quot;corp&quot;:{
&quot;id&quot;:22,
&quot;user_id&quot;:21,
&quot;sub_user_id&quot;:0,
&quot;corp_id&quot;:1,
&quot;wxid&quot;:&quot;xxxxxxx&quot;,
&quot;verified&quot;:0,
&quot;full_name&quot;:&quot;xxxxxx&quot;,
&quot;short_name&quot;:&quot;xxxxx&quot;,
&quot;address&quot;:&quot;&quot;,
&quot;ctime&quot;:1631268822,
&quot;utime&quot;:1636708872,
&quot;legal_person_name&quot;:&quot;xxxxx&quot;,
&quot;legal_person_wxid&quot;:&quot;xxxxxxx&quot;,
&quot;logo&quot;:&quot;https:\/\/p.qlogo.cn\/bizmail\/uOmaiaLWlMrh8NUq64HrOd3dyqSleaj7ibkyMHTAet6q0prrCyYJSUFA\/0&quot;
}
}
],
&quot;pager&quot;:{
&quot;page&quot;:1,
&quot;perPage&quot;:10,
&quot;numRecords&quot;:26,
&quot;numPages&quot;:3,
&quot;firstRecord&quot;:0,
&quot;lastRecord&quot;:9
},
&quot;errcode&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>群成员微信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;">display_name</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;">gender</td>
<td style="text-align: left;">int</td>
<td>群成员性别：0未知；1男；2女；</td>
</tr>
<tr>
<td style="text-align: left;">inviter_wxid</td>
<td style="text-align: left;">string</td>
<td>邀请者微信id</td>
</tr>
<tr>
<td style="text-align: left;">entry_time</td>
<td style="text-align: left;">int</td>
<td>最近一次的入群时间戳（秒）</td>
</tr>
<tr>
<td style="text-align: left;">quit_time</td>
<td style="text-align: left;">int</td>
<td>最近一次的退群时间戳（秒）</td>
</tr>
<tr>
<td style="text-align: left;">is_owner</td>
<td style="text-align: left;">int</td>
<td>是否群主</td>
</tr>
<tr>
<td style="text-align: left;">is_admin</td>
<td style="text-align: left;">int</td>
<td>是否管理员</td>
</tr>
<tr>
<td style="text-align: left;">wechat_type</td>
<td style="text-align: left;">int</td>
<td>微信类型,1个人微信，2企业微信</td>
</tr>
<tr>
<td style="text-align: left;">join_scene</td>
<td style="text-align: left;">int</td>
<td>添加来源：1直接邀请入群；2链接入群；3扫描入群</td>
</tr>
<tr>
<td style="text-align: left;">ctime</td>
<td style="text-align: left;">int</td>
<td>创建时间</td>
</tr>
<tr>
<td style="text-align: left;">utime</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>
</tbody>
</table>
<p><br><br><br></p>
<p><a id="refresh"></a></p>
<h2>2、刷新群成员列表获取完整成员信息（异步执行后通过回调事件：roomMembers返回）</h2>
<ul>
<li>在使用API过程中，遇到群成员列表中有成员昵称、头像等信息为空的情况，可在业务页面增加刷新群成员按钮，点击按钮请求该接口触发更新群成员。此处建议手动人为触发刷新而不是程序批量快速刷新，是出于企微使用安全考虑，此接口也限制了10分钟内同一个群最多刷新一次成员信息。</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>https://oapi-yzj.miaokol.com/wechat/refreshRoomMembers</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>说明</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;">room_wxid</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>群wxid，从群列表获取，格式如:R:xxx</td>
</tr>
</tbody>
</table>
<h5>请求示例</h5>
<pre><code>POST /wechat/refreshRoomMembers HTTP/1.1
Host:oapi-yzj.miaokol.com
Content-Type: application/json; charset=UTF-8
{
&quot;app_id&quot;:&quot;xxx&quot;,
&quot;access_token&quot;:&quot;xxx&quot;,
&quot;room_wxid&quot;:&quot;R:xxx&quot;
}
</code></pre>
<h5>响应示例</h5>
<pre><code>HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
&quot;errcode&quot;:0//errcode为0表示指令完成执行；errcode非0表示指令未执行，原因通过message查看。
}
</code></pre>