云真机

API接口文档


获取单个联系人(客户)详情

<h5>简要描述</h5> <ul> <li>单个联系人(客户)详情</li> </ul> <h5>请求URL</h5> <ul> <li><code>https://oapi-yzj.miaokol.com/wechat/contactDetail</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;">wxid</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>联系人微信ID,示例: wxids=7xxx</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code>GET /wechat/contactDetail?app_id=xxx&amp;amp;access_token=xxxx&amp;amp;rel_wxid=xxxx&amp;amp;wxid=xxxx 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;:1,         &amp;quot;user_id&amp;quot;:1,         &amp;quot;sub_user_id&amp;quot;:0,         &amp;quot;rel_wxid&amp;quot;:&amp;quot;1688857904364268&amp;quot;,         &amp;quot;wxid&amp;quot;:&amp;quot;7881302978110667&amp;quot;,         &amp;quot;nickname&amp;quot;:&amp;quot;11111&amp;quot;,         &amp;quot;nickname_pinyin&amp;quot;:&amp;quot;11111&amp;quot;,         &amp;quot;avatar&amp;quot;:&amp;quot;\/\/wx.qlogo.cn\/mmhead\/KydxAIB52xnoic3UdRtmiaJZXR3Kht8qiaeRI3BjTXb9PYHJXFGNZ4qQg\/0&amp;quot;,         &amp;quot;gender&amp;quot;:2,         &amp;quot;wechat_type&amp;quot;:1,         &amp;quot;corp_wxid&amp;quot;:&amp;quot;1970325234026788&amp;quot;,         &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;&amp;quot;,         &amp;quot;bitval&amp;quot;:2057,         &amp;quot;source_type&amp;quot;:1,         &amp;quot;make_time&amp;quot;:1657608079,         &amp;quot;ctime&amp;quot;:1657608081,         &amp;quot;utime&amp;quot;:1657608081,         &amp;quot;call_name&amp;quot;:&amp;quot;&amp;quot;,         &amp;quot;memo&amp;quot;:&amp;quot;&amp;quot;,         &amp;quot;alias&amp;quot;:&amp;quot;&amp;quot;,         &amp;quot;real_name&amp;quot;:&amp;quot;&amp;quot;,         &amp;quot;wx_nickname&amp;quot;:&amp;quot;11111&amp;quot;,         &amp;quot;verify_msg&amp;quot;:&amp;quot;&amp;quot;,         &amp;quot;dept_wxid&amp;quot;:&amp;quot;0&amp;quot;,         &amp;quot;last_send_msg_time&amp;quot;:0,         &amp;quot;related_wxb_uid&amp;quot;:0,         &amp;quot;corp_name&amp;quot;:&amp;quot;&amp;quot;,         &amp;quot;desc&amp;quot;:&amp;quot;&amp;quot;,         &amp;quot;phone_list&amp;quot;:&amp;quot;&amp;quot;,         &amp;quot;smart_tag_ids&amp;quot;:&amp;quot;&amp;quot;,         &amp;quot;custom_bitval&amp;quot;:0,         &amp;quot;one_way_time&amp;quot;:0,         &amp;quot;ban_time&amp;quot;:0,         &amp;quot;loss_time&amp;quot;:0,         &amp;quot;zombie_time&amp;quot;:0,         &amp;quot;last_rcv_msg_time&amp;quot;:0,         &amp;quot;corp&amp;quot;:{             &amp;quot;id&amp;quot;:6865,             &amp;quot;user_id&amp;quot;:1,             &amp;quot;sub_user_id&amp;quot;:0,             &amp;quot;corp_id&amp;quot;:1,             &amp;quot;wxid&amp;quot;:&amp;quot;1970325134026788&amp;quot;,             &amp;quot;verified&amp;quot;:0,             &amp;quot;full_name&amp;quot;:&amp;quot;微信&amp;quot;,             &amp;quot;short_name&amp;quot;:&amp;quot;微信&amp;quot;,             &amp;quot;address&amp;quot;:&amp;quot;&amp;quot;,             &amp;quot;legal_person_name&amp;quot;:&amp;quot;111&amp;quot;,             &amp;quot;legal_person_wxid&amp;quot;:&amp;quot;1688852464890720&amp;quot;,             &amp;quot;logo&amp;quot;:&amp;quot;https:\/\/p.qlogo.cn\/bizmail\/uOmaiaLrOd3dyqSleaj7ibkyMHTAet6q0prrCyYJSUFA\/0&amp;quot;,             &amp;quot;ctime&amp;quot;:1635663505,             &amp;quot;utime&amp;quot;:1652769630         },         &amp;quot;rel_corp_id&amp;quot;:16     },     &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>昵称</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> </tbody> </table>

页面列表

ITEM_HTML