云真机

API接口文档


智能标签

<p>目录:</p> <h4>&lt;a href=&quot;#getList&quot;&gt;<strong> 【智能标签|—获取自定义标签分组及标签列表】</strong>&lt;/a&gt;</h4> <h4>&lt;a href=&quot;#add&quot;&gt;<strong> 【智能标签|—创建/编辑标签或标签分组】</strong>&lt;/a&gt;</h4> <h4>&lt;a href=&quot;#delete&quot;&gt;<strong> 【智能标签|—删除标签或标签分组】</strong>&lt;/a&gt;</h4> <h4>&lt;a href=&quot;#batchAdd&quot;&gt;<strong> 【智能标签|—批量新增标签到标签分组】</strong>&lt;/a&gt;</h4> <h4>&lt;a href=&quot;#addTag&quot;&gt;<strong> 【智能标签|—给客户打智能标签】</strong>&lt;/a&gt;</h4> <p>&lt;br&gt;</p> <p>&lt;a id=&quot;getList&quot;&gt;&lt;/a&gt;</p> <h3><strong> 获取自定义标签列表</strong></h3> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/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;amp;access_token=xxxx&amp;amp;page=1&amp;amp;page_size=10&amp;amp;with_tags=1&amp;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 {     &amp;quot;data&amp;quot;:[         {             &amp;quot;id&amp;quot;:1,             &amp;quot;name&amp;quot;:&amp;quot;api分组&amp;quot;,             &amp;quot;type&amp;quot;:2,             &amp;quot;number&amp;quot;:0,             &amp;quot;tags&amp;quot;:[                 {                     &amp;quot;id&amp;quot;:&amp;quot;2&amp;quot;,                     &amp;quot;name&amp;quot;:&amp;quot;删&amp;quot;,                     &amp;quot;parent_id&amp;quot;:&amp;quot;1&amp;quot;,                     &amp;quot;sort&amp;quot;:&amp;quot;2&amp;quot;,                     &amp;quot;contact_cnt&amp;quot;:0                 },                 {                     &amp;quot;id&amp;quot;:&amp;quot;3&amp;quot;,                     &amp;quot;name&amp;quot;:&amp;quot;增&amp;quot;,                     &amp;quot;parent_id&amp;quot;:&amp;quot;1&amp;quot;,                     &amp;quot;sort&amp;quot;:&amp;quot;1&amp;quot;,                     &amp;quot;contact_cnt&amp;quot;:0                 }             ]         }     ],     &amp;quot;pager&amp;quot;:{         &amp;quot;page&amp;quot;:1,         &amp;quot;perPage&amp;quot;:20,         &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;">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>&lt;br&gt; &lt;a id=&quot;add&quot;&gt;&lt;/a&gt;</p> <h3><strong> 创建/编辑标签或标签分组</strong></h3> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/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 { &amp;quot;app_id&amp;quot;:&amp;quot;44n2AsVZArKefJbuaE&amp;quot;, &amp;quot;access_token&amp;quot;:&amp;quot;2550fae1f260f21489ceaed103ec472d&amp;quot;, &amp;quot;name&amp;quot;:&amp;quot;api分组&amp;quot; } </code></pre> <h5>响应示例</h5> <pre><code>HTTP/1.1 200 OK {     &amp;quot;data&amp;quot;:{         &amp;quot;id&amp;quot;:1,         &amp;quot;user_id&amp;quot;:2,         &amp;quot;sub_user_id&amp;quot;:0,         &amp;quot;corp_id&amp;quot;:0,         &amp;quot;module&amp;quot;:47,         &amp;quot;name&amp;quot;:&amp;quot;api分组&amp;quot;,         &amp;quot;type&amp;quot;:2,         &amp;quot;is_delete&amp;quot;:0,         &amp;quot;number&amp;quot;:0,         &amp;quot;parent_id&amp;quot;:0,         &amp;quot;ctime&amp;quot;:1655969708,         &amp;quot;utime&amp;quot;:1655969708,         &amp;quot;sort&amp;quot;:0,         &amp;quot;extra&amp;quot;:null     },     &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;">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>&lt;br&gt; &lt;a id=&quot;delete&quot;&gt;&lt;/a&gt;</p> <h3><strong> 删除标签或标签分组</strong></h3> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/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 { &amp;quot;app_id&amp;quot;:&amp;quot;44n2AsVZArKefJbuaE&amp;quot;, &amp;quot;access_token&amp;quot;:&amp;quot;2550fae1f260f21489ceaed103ec472d&amp;quot;, &amp;quot;id&amp;quot;:1 } </code></pre> <h5>响应示例</h5> <pre><code>HTTP/1.1 200 OK {     &amp;quot;data&amp;quot;:null,     &amp;quot;errcode&amp;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>&lt;br&gt; &lt;a id=&quot;batchAdd&quot;&gt;&lt;/a&gt;</p> <h3><strong> 批量新增标签到标签分组</strong></h3> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/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>标签名称,数组,如: [&quot;增&quot;,&quot;删&quot;]</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 { &amp;quot;app_id&amp;quot;:&amp;quot;44n2AsVZArKefJbuaE&amp;quot;, &amp;quot;access_token&amp;quot;:&amp;quot;2550fae1f260f21489ceaed103ec472d&amp;quot;, &amp;quot;group_id&amp;quot;:1, &amp;quot;tag_names&amp;quot;:[&amp;quot;增&amp;quot;,&amp;quot;删&amp;quot;] } </code></pre> <h5>响应示例</h5> <pre><code>HTTP/1.1 200 OK {     &amp;quot;data&amp;quot;:null,     &amp;quot;errcode&amp;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>&lt;br&gt; &lt;a id=&quot;addTag&quot;&gt;&lt;/a&gt;</p> <h3><strong> 给客户打智能标签</strong></h3> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/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 { &amp;quot;app_id&amp;quot;:&amp;quot;44n2AsVZArKefJbuaE&amp;quot;, &amp;quot;access_token&amp;quot;:&amp;quot;2550fae1f260f21489ceaed103ec472d&amp;quot;, &amp;quot;rel_wxid&amp;quot;:&amp;quot;1688851873049028&amp;quot;, &amp;quot;contact_wxid&amp;quot;:&amp;quot;7881302795046315&amp;quot;, &amp;quot;smart_tag_ids&amp;quot;:[1,2] } </code></pre> <h5>响应示例</h5> <pre><code>HTTP/1.1 200 OK {     &amp;quot;data&amp;quot;:{}//客户信息     &amp;quot;errcode&amp;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>

页面列表

ITEM_HTML