获取联系人(客户)列表
<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<font color="red">(弃用)</font></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;access_token=xxxx&amp;rel_wxid=xxxx&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/x-www-form-urlencoded
{
&quot;data&quot;:[
{
&quot;id&quot;:1057,
&quot;user_id&quot;:0,
&quot;sub_user_id&quot;:0,
&quot;rel_corp_id&quot;:2,
&quot;rel_wxid&quot;:&quot;xxxx&quot;,
&quot;wxid&quot;:&quot;xxxxx&quot;,
&quot;nickname&quot;:&quot;**&quot;,
&quot;nickname_pinyin&quot;:&quot;**&quot;,
&quot;avatar&quot;:&quot;\/\/wework.qpic.cn\/bizmail\/buJJ3mbXFPhljxdnib4weuPd5mH28T7NP8MODa11Q4BqKr5CITu8J5w\/0&quot;,
&quot;gender&quot;:1,
&quot;wechat_type&quot;:2,
&quot;country&quot;:&quot;&quot;,
&quot;province&quot;:&quot;&quot;,
&quot;city&quot;:&quot;&quot;,
&quot;remark&quot;:&quot;**&quot;,
&quot;corp_tag_wxids&quot;:&quot;xxxx&quot;,
&quot;ctime&quot;:1635931939,
&quot;utime&quot;:1637291498,
&quot;corp_wxid&quot;:&quot;xxxx&quot;,
&quot;bitval&quot;:2057,
&quot;make_time&quot;:1635931940,
&quot;source_type&quot;:4,
&quot;call_name&quot;:&quot;&quot;,
&quot;phone_list&quot;:&quot;130xxxxxxxx,132xxxxxxxx&quot;,
&quot;smart_tag_ids&quot;:&quot;&quot;,
&quot;alias&quot;:&quot;xxx&quot;,
&quot;real_name&quot;:&quot;xxxx&quot;,
&quot;wx_nickname&quot;:&quot;xxxx&quot;,
&quot;verify_msg&quot;:&quot;&quot;,
&quot;corp&quot;:{
&quot;id&quot;:68,
&quot;user_id&quot;:21,
&quot;sub_user_id&quot;:0,
&quot;corp_id&quot;:2,
&quot;wxid&quot;:&quot;xxxx&quot;,
&quot;verified&quot;:0,
&quot;full_name&quot;:&quot;xxxxx&quot;,
&quot;short_name&quot;:&quot;xxxx&quot;,
&quot;address&quot;:&quot;&quot;,
&quot;ctime&quot;:1631779195,
&quot;utime&quot;:1636708872,
&quot;legal_person_name&quot;:&quot;xxxx&quot;,
&quot;legal_person_wxid&quot;:&quot;xxxxxx&quot;,
&quot;logo&quot;:&quot;https:\/\/p.qlogo.cn\/bizmail\/icIv7pBmIagicflYrolbXbtLCYIHlp0PmUUNarcAM1ibStdlsOv8mGGqA\/0&quot;
}
}
],
&quot;pager&quot;:{
&quot;page&quot;:1,
&quot;perPage&quot;:10,
&quot;numRecords&quot;:19,
&quot;numPages&quot;:2,
&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;">wx_nickname</td>
<td style="text-align: left;">string</td>
<td>昵称<客户原昵称></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>手机号,空位空字符串,多个以逗号分隔,如:""; "131xxxxxxxx"; "130xxxxxxxx,132xxxxxxxx"</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>