群活码
<p>目录:</p>
<h4><a href="#getList"><strong> 【群活码—获取活码列表】</strong></a></h4>
<h4><a href="#getRoomCode"><strong> 【群活码—通过活码ID获取展示的群二维码】</strong></a></h4>
<h4><a href="#reportPress"><strong> 【群活码—上报活码长按次数用于统计】</strong></a></h4>
<p><font color="red">注意：由于群活码接口是依赖web端群活码功能，所以为了能保证web相关统计的准确，此处可通过该接口上报用户长按活码获取群二维码的行为。</font>
<br></p>
<p><a id="getList"></a></p>
<h3><strong> 获取自定义标签列表</strong></h3>
<h5>请求URL</h5>
<ul>
<li><code>URL:/index/liveCodeList</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;">corp_id</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>企业ID，可通过企业列表接口获取</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 /index/liveCodeList?app_id=xxx&amp;access_token=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
{
&quot;data&quot;:[
{
&quot;id&quot;:xx,
&quot;name&quot;:&quot;我是分组群活码&quot;,
&quot;pop_url&quot;:&quot;xxx&quot;,
&quot;pop_qrcode&quot;:&quot;xxxx&quot;,
&quot;pause&quot;:2,
&quot;status&quot;:2
}
],
&quot;pager&quot;:{
&quot;page&quot;:1,
&quot;perPage&quot;:10,
&quot;numRecords&quot;:200,
&quot;numPages&quot;:20,
&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;">id</td>
<td style="text-align: left;">int</td>
<td>群活码id</td>
</tr>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">string</td>
<td>群活码名称</td>
</tr>
<tr>
<td style="text-align: left;">pop_url</td>
<td style="text-align: left;">string</td>
<td>群活码名称</td>
</tr>
<tr>
<td style="text-align: left;">pop_qrcode</td>
<td style="text-align: left;">string</td>
<td>群活码名称</td>
</tr>
<tr>
<td style="text-align: left;">pause</td>
<td style="text-align: left;">int</td>
<td>0可用；1手动暂停；2自动暂停；</td>
</tr>
<tr>
<td style="text-align: left;">status</td>
<td style="text-align: left;">int</td>
<td>1正常可用；2已停用</td>
</tr>
<tr>
<td style="text-align: left;">pager</td>
<td style="text-align: left;">object</td>
<td>分页信息，总数：pager.numRecords</td>
</tr>
</tbody>
</table>
<p><br>
<a id="getRoomCode"></a></p>
<h3><strong> 通过活码ID获取展示的群二维码</strong></h3>
<h5>请求URL</h5>
<ul>
<li><code>URL:/index/showQrcode</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;">openid</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>用户标识，用于向同个用户展示同一个群二维码，比如可取小程序获取到的openid或其他可标识用户的字段值</td>
</tr>
<tr>
<td style="text-align: left;">code_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>活码列表获取到的id</td>
</tr>
</tbody>
</table>
<h5>请求示例</h5>
<pre><code>POST /index/showQrcode HTTP/1.1
Host:oapi-yzj.miaokol.com
Content-Type: application/json; charset=UTF-8
{
&quot;app_id&quot;:&quot;44n2AsVZArKefJbuaE&quot;,
&quot;access_token&quot;:&quot;2550fae1f260f21489ceaed103ec472d&quot;,
&quot;openid&quot;:&quot;xxx&quot;,
&quot;code_id&quot;:xxx
}
</code></pre>
<h5>响应示例</h5>
<pre><code>HTTP/1.1 200 OK
{
&quot;data&quot;:{
&quot;qrcode&quot;:&quot;//yunzhenji.oss-cn-hangzhou.aliyuncs.com/media/public/wechatdata/1688851824187948/rc860e792cc489580052381c0c2bec0cd.png?r=1699435416&quot;,
&quot;room&quot;:{
&quot;wxid&quot;:&quot;R:10929639807813262&quot;,
&quot;nickname&quot;:&quot;前期那倩倩1踢人&quot;,
&quot;avatar&quot;:&quot;//yunzhenji.oss-cn-hangzhou.aliyuncs.com/public/wechatdata/avatar/21/7d580090f860bbdfb5ca40a4371292a7.png&quot;
}
},
&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;">id</td>
<td style="text-align: left;">int</td>
<td>群活码id</td>
</tr>
<tr>
<td style="text-align: left;">qrcode</td>
<td style="text-align: left;">string</td>
<td>群二维码地址，协议头可自行拼接https</td>
</tr>
<tr>
<td style="text-align: left;">room.wxid</td>
<td style="text-align: left;">string</td>
<td>群wxid</td>
</tr>
<tr>
<td style="text-align: left;">room.nickname</td>
<td style="text-align: left;">string</td>
<td>群昵称</td>
</tr>
<tr>
<td style="text-align: left;">room.avatar</td>
<td style="text-align: left;">string</td>
<td>群头像</td>
</tr>
</tbody>
</table>
<p><br>
<a id="reportPress"></a></p>
<h3><strong> 上报活码长按次数用于统计</strong></h3>
<h5>请求URL</h5>
<ul>
<li><code>URL:/index/statPressQrcode</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;">openid</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>用户标识，比如可取小程序获取到的openid或其他可标识用户的字段值</td>
</tr>
<tr>
<td style="text-align: left;">code_id</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>活码列表获取到的id</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>展示群二维码接口返回的data.room.wxid</td>
</tr>
</tbody>
</table>
<h5>请求示例</h5>
<pre><code>POST /index/statPressQrcode
HTTP/1.1
Host:oapi-yzj.miaokol.com
Content-Type: application/json; charset=UTF-8
{
&quot;app_id&quot;:&quot;44n2AsVZArKefJbuaE&quot;,
&quot;access_token&quot;:&quot;2550fae1f260f21489ceaed103ec472d&quot;,
&quot;openid&quot;:&quot;xxx&quot;,
&quot;code_id&quot;:xxx,
&quot;room_wxid&quot;:&quot;xxx&quot;
}
</code></pre>
<h5>响应示例</h5>
<pre><code>HTTP/1.1 200 OK
{
&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;">errcode</td>
<td style="text-align: left;">int</td>
<td>0表示上报数据成功，非0表示异常，异常信息见message字段</td>
</tr>
<tr>
<td style="text-align: left;">message</td>
<td style="text-align: left;">string</td>
<td>errcode非0时，有该字段，表示异常信息</td>
</tr>
</tbody>
</table>