智能标签
<p>目录:</p>
<h4><a href="#getList"><strong> 【智能标签|—获取自定义标签分组及标签列表】</strong></a></h4>
<h4><a href="#add"><strong> 【智能标签|—创建/编辑标签或标签分组】</strong></a></h4>
<h4><a href="#delete"><strong> 【智能标签|—删除标签或标签分组】</strong></a></h4>
<h4><a href="#batchAdd"><strong> 【智能标签|—批量新增标签到标签分组】</strong></a></h4>
<h4><a href="#addTag"><strong> 【智能标签|—给客户打智能标签】</strong></a></h4>
<p><br></p>
<p><a id="getList"></a></p>
<h3><strong> 获取自定义标签列表</strong></h3>
<h5>请求URL</h5>
<ul>
<li><code>URL:/smart-tag/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;">with_tags</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>是否返回标签组下标签:0否；1是</td>
</tr>
<tr>
<td style="text-align: left;">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 /smart-tag/list?app_id=xxx&amp;access_token=xxxx&amp;page=1&amp;page_size=10&amp;with_tags=1&amp;id=1 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;:1,
&quot;name&quot;:&quot;api分组&quot;,
&quot;type&quot;:2,
&quot;number&quot;:0,
&quot;tags&quot;:[
{
&quot;id&quot;:&quot;2&quot;,
&quot;name&quot;:&quot;删&quot;,
&quot;parent_id&quot;:&quot;1&quot;,
&quot;sort&quot;:&quot;2&quot;,
&quot;contact_cnt&quot;:0
},
{
&quot;id&quot;:&quot;3&quot;,
&quot;name&quot;:&quot;增&quot;,
&quot;parent_id&quot;:&quot;1&quot;,
&quot;sort&quot;:&quot;1&quot;,
&quot;contact_cnt&quot;:0
}
]
}
],
&quot;pager&quot;:{
&quot;page&quot;:1,
&quot;perPage&quot;:20,
&quot;numRecords&quot;:1,
&quot;numPages&quot;:1,
&quot;firstRecord&quot;:0,
&quot;lastRecord&quot;:0
},
&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;">tags</td>
<td style="text-align: left;">object []</td>
<td>分组下的标签列表</td>
</tr>
<tr>
<td style="text-align: left;">tags[0].id</td>
<td style="text-align: left;">int</td>
<td>标签ID</td>
</tr>
<tr>
<td style="text-align: left;">tags[0].name</td>
<td style="text-align: left;">string</td>
<td>标签名称</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="add"></a></p>
<h3><strong> 创建/编辑标签或标签分组</strong></h3>
<h5>请求URL</h5>
<ul>
<li><code>URL:/smart-tag/add</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;">id</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>分组或标签ID，传0表示新建，否则表示编辑</td>
</tr>
<tr>
<td style="text-align: left;">name</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>分组或标签名称</td>
</tr>
<tr>
<td style="text-align: left;">type</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int</td>
<td>1:标签；2:标签分组;</td>
</tr>
<tr>
<td style="text-align: left;">parent_id</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>当type=1即新增/编辑标签时，带上该参数，取值为分组id，默认为0</td>
</tr>
</tbody>
</table>
<h5>请求示例</h5>
<pre><code>POST /smart-tag/add
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;name&quot;:&quot;api分组&quot;
}
</code></pre>
<h5>响应示例</h5>
<pre><code>HTTP/1.1 200 OK
{
&quot;data&quot;:{
&quot;id&quot;:1,
&quot;user_id&quot;:2,
&quot;sub_user_id&quot;:0,
&quot;corp_id&quot;:0,
&quot;module&quot;:47,
&quot;name&quot;:&quot;api分组&quot;,
&quot;type&quot;:2,
&quot;is_delete&quot;:0,
&quot;number&quot;:0,
&quot;parent_id&quot;:0,
&quot;ctime&quot;:1655969708,
&quot;utime&quot;:1655969708,
&quot;sort&quot;:0,
&quot;extra&quot;:null
},
&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>
</tbody>
</table>
<p><br>
<a id="delete"></a></p>
<h3><strong> 删除标签或标签分组</strong></h3>
<h5>请求URL</h5>
<ul>
<li><code>URL:/smart-tag/delete</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;">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 /smart-tag/delete
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;id&quot;:1
}
</code></pre>
<h5>响应示例</h5>
<pre><code>HTTP/1.1 200 OK
{
&quot;data&quot;:null,
&quot;errcode&quot;:0
}
</code></pre>
<h5>响应说明</h5>
<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成功；1异常</td>
</tr>
</tbody>
</table>
<p><br>
<a id="batchAdd"></a></p>
<h3><strong> 批量新增标签到标签分组</strong></h3>
<h5>请求URL</h5>
<ul>
<li><code>URL:/smart-tag/batchAddTag</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;">group_id</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">int</td>
<td>分组ID，传0表示新建分组，则group_name不能为空</td>
</tr>
<tr>
<td style="text-align: left;">group_name</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>分组名称</td>
</tr>
<tr>
<td style="text-align: left;">tag_names</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string []</td>
<td>标签名称，数组，如: ["增","删"]</td>
</tr>
</tbody>
</table>
<h5>请求示例</h5>
<pre><code>POST /smart-tag/batchAddTag
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;group_id&quot;:1,
&quot;tag_names&quot;:[&quot;增&quot;,&quot;删&quot;]
}
</code></pre>
<h5>响应示例</h5>
<pre><code>HTTP/1.1 200 OK
{
&quot;data&quot;:null,
&quot;errcode&quot;:0
}
</code></pre>
<h5>响应说明</h5>
<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成功；1异常</td>
</tr>
</tbody>
</table>
<p><br>
<a id="addTag"></a></p>
<h3><strong> 给客户打智能标签</strong></h3>
<h5>请求URL</h5>
<ul>
<li><code>URL:/smart-tag/updateContact</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;">rel_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;">contact_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;">smart_tag_ids</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">int []</td>
<td>标签ID，数组如: [1,2]，全量覆盖</td>
</tr>
</tbody>
</table>
<h5>请求示例</h5>
<pre><code>POST /smart-tag/updateContact
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;rel_wxid&quot;:&quot;1688851873049028&quot;,
&quot;contact_wxid&quot;:&quot;7881302795046315&quot;,
&quot;smart_tag_ids&quot;:[1,2]
}
</code></pre>
<h5>响应示例</h5>
<pre><code>HTTP/1.1 200 OK
{
&quot;data&quot;:{}//客户信息
&quot;errcode&quot;:0
}
</code></pre>
<h5>响应说明</h5>
<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成功；1异常</td>
</tr>
</tbody>
</table>