云真机

API接口文档


获取联系人(客户)列表

<h5>简要描述</h5> <ul> <li>联系人列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/wechat/contacts</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;">rel_wxid</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>企微号微信ID</td> </tr> <tr> <td style="text-align: left;">start_wxid&lt;font color=&quot;red&quot;&gt;(弃用)&lt;/font&gt;</td> <td style="text-align: left;">否(全量拉取时要传该参数)</td> <td style="text-align: left;">string</td> <td>上次请求返回的最后一个联系人的wxid,首次调用可传0表示从开始拉取</td> </tr> <tr> <td style="text-align: left;">start_make_time</td> <td style="text-align: left;">否(可用于获取某时间范围内的增量客户)</td> <td style="text-align: left;">int</td> <td>添加客户时间过滤,开始时间,时间戳(秒)</td> </tr> <tr> <td style="text-align: left;">end_make_time</td> <td style="text-align: left;">否(可用于获取某时间范围内的增量客户)</td> <td style="text-align: left;">int</td> <td>添加客户时间过滤,结束时间,时间戳(秒)</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/contacts?app_id=xxx&amp;amp;access_token=xxxx&amp;amp;rel_wxid=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 Content-Type: application/x-www-form-urlencoded { &amp;quot;data&amp;quot;:[ { &amp;quot;id&amp;quot;:1057, &amp;quot;user_id&amp;quot;:0, &amp;quot;sub_user_id&amp;quot;:0, &amp;quot;rel_corp_id&amp;quot;:2, &amp;quot;rel_wxid&amp;quot;:&amp;quot;xxxx&amp;quot;, &amp;quot;wxid&amp;quot;:&amp;quot;xxxxx&amp;quot;, &amp;quot;nickname&amp;quot;:&amp;quot;**&amp;quot;, &amp;quot;nickname_pinyin&amp;quot;:&amp;quot;**&amp;quot;, &amp;quot;avatar&amp;quot;:&amp;quot;\/\/wework.qpic.cn\/bizmail\/buJJ3mbXFPhljxdnib4weuPd5mH28T7NP8MODa11Q4BqKr5CITu8J5w\/0&amp;quot;, &amp;quot;gender&amp;quot;:1, &amp;quot;wechat_type&amp;quot;:2, &amp;quot;country&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;province&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;city&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;remark&amp;quot;:&amp;quot;**&amp;quot;, &amp;quot;corp_tag_wxids&amp;quot;:&amp;quot;xxxx&amp;quot;, &amp;quot;ctime&amp;quot;:1635931939, &amp;quot;utime&amp;quot;:1637291498, &amp;quot;corp_wxid&amp;quot;:&amp;quot;xxxx&amp;quot;, &amp;quot;bitval&amp;quot;:2057, &amp;quot;make_time&amp;quot;:1635931940, &amp;quot;source_type&amp;quot;:4, &amp;quot;call_name&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;phone_list&amp;quot;:&amp;quot;130xxxxxxxx,132xxxxxxxx&amp;quot;, &amp;quot;smart_tag_ids&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;alias&amp;quot;:&amp;quot;xxx&amp;quot;, &amp;quot;real_name&amp;quot;:&amp;quot;xxxx&amp;quot;, &amp;quot;wx_nickname&amp;quot;:&amp;quot;xxxx&amp;quot;, &amp;quot;verify_msg&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;corp&amp;quot;:{ &amp;quot;id&amp;quot;:68, &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;xxxx&amp;quot;, &amp;quot;verified&amp;quot;:0, &amp;quot;full_name&amp;quot;:&amp;quot;xxxxx&amp;quot;, &amp;quot;short_name&amp;quot;:&amp;quot;xxxx&amp;quot;, &amp;quot;address&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;ctime&amp;quot;:1631779195, &amp;quot;utime&amp;quot;:1636708872, &amp;quot;legal_person_name&amp;quot;:&amp;quot;xxxx&amp;quot;, &amp;quot;legal_person_wxid&amp;quot;:&amp;quot;xxxxxx&amp;quot;, &amp;quot;logo&amp;quot;:&amp;quot;https:\/\/p.qlogo.cn\/bizmail\/icIv7pBmIagicflYrolbXbtLCYIHlp0PmUUNarcAM1ibStdlsOv8mGGqA\/0&amp;quot; } } ], &amp;quot;pager&amp;quot;:{ &amp;quot;page&amp;quot;:1, &amp;quot;perPage&amp;quot;:10, &amp;quot;numRecords&amp;quot;:19, &amp;quot;numPages&amp;quot;:2, &amp;quot;firstRecord&amp;quot;:0, &amp;quot;lastRecord&amp;quot;:9 }, &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>联系人微信ID</td> </tr> <tr> <td style="text-align: left;">nickname</td> <td style="text-align: left;">string</td> <td>昵称&lt;企微宝云端版页面显示的昵称&gt;</td> </tr> <tr> <td style="text-align: left;">wx_nickname</td> <td style="text-align: left;">string</td> <td>昵称&lt;客户原昵称&gt;</td> </tr> <tr> <td style="text-align: left;">real_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;">make_time</td> <td style="text-align: left;">int</td> <td>加好友时间戳(秒)</td> </tr> <tr> <td style="text-align: left;">phone_list</td> <td style="text-align: left;">string</td> <td>手机号,空位空字符串,多个以逗号分隔,如:&quot;&quot;; &quot;131xxxxxxxx&quot;; &quot;130xxxxxxxx,132xxxxxxxx&quot;</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">string</td> <td>备注</td> </tr> <tr> <td style="text-align: left;">source_type</td> <td style="text-align: left;">string</td> <td>来源:1扫一扫;2手机号;3名片;4群聊;6微信好友;8第三方应用专属客服;其他值如-1、100等表示:其他。</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;">bitval</td> <td style="text-align: left;">int</td> <td>用于判断好友是否删除当前企微号;二进制位从低位开始数第4位是0表示被删,是1表示未被删;也可与十进制数字“8”按位与:结果是0表示对方删掉自己了,非0表示对方没有删掉自己。比如:bitval的值是1,1 按位与 8 = 0;表示好友已删除自己;</td> </tr> <tr> <td style="text-align: left;">corp_tag_wxids</td> <td style="text-align: left;">sting</td> <td>标签ID,多个英文逗号分隔,如:14073749326635410,14073749925634841</td> </tr> <tr> <td style="text-align: left;">smart_tag_ids</td> <td style="text-align: left;">sting</td> <td>智能标签ID,多个英文逗号分隔,如:1063971,1063968</td> </tr> <tr> <td style="text-align: left;">corp_wxid</td> <td style="text-align: left;">string</td> <td>联系人所属企业wxid</td> </tr> <tr> <td style="text-align: left;">corp</td> <td style="text-align: left;">object</td> <td>联系人所属企业信息</td> </tr> <tr> <td style="text-align: left;">corp.name</td> <td style="text-align: left;">string</td> <td>企业名称</td> </tr> <tr> <td style="text-align: left;">corp.short_name</td> <td style="text-align: left;">string</td> <td>企业简称</td> </tr> <tr> <td style="text-align: left;">corp.legal_person_name</td> <td style="text-align: left;">string</td> <td>企业注册者名称</td> </tr> <tr> <td style="text-align: left;">corp.legal_person_id</td> <td style="text-align: left;">string</td> <td>企业注册者Id</td> </tr> <tr> <td style="text-align: left;">rel_wxid</td> <td style="text-align: left;">string</td> <td>企微号微信ID</td> </tr> <tr> <td style="text-align: left;">rel_corp_id</td> <td style="text-align: left;">string</td> <td>企微号所在企业ID(企微宝云端版)</td> </tr> <tr> <td style="text-align: left;">utime</td> <td style="text-align: left;">int</td> <td>数据更新时间戳(秒)</td> </tr> </tbody> </table>

页面列表

ITEM_HTML