云真机

API接口文档


对接说明

<h2>简介:</h2> <p>对有自建客户系统对接需求且具备一定开发能力的用户,我们提供侧边栏自定义页面的能力。可在在线聊天-聊天配置-侧边栏配置中设置。</p> <p>&lt;font color=&quot;red&quot;&gt;<strong>说明</strong>&lt;/font&gt;:聊天侧边栏也支持群聊信息,配置的url上会带上群昵称和群创建时间。群聊相关请拉到页面最后查看。</p> <h2>配置:</h2> <p><strong>1、跳转url(业务方url):</strong></p> <p>配置方式:登录本系统,点击在线聊天-侧边栏设置可进行设置,示例:<a href="https://www.test.com">https://www.test.com</a>;</p> <p>配置完成后,当打开与客户的聊天窗口点击右侧侧边栏的自定义页面时,会跳转到地址: <a href="https://www.test.com?wxid=1688851873049028&amp;chat_wxid=7881302848173300&amp;timestamp=1656059696&amp;sub_userid=0&amp;sub_username=&amp;corp_name=%E9%80%90%E5%85%89%E7%BD%91%E7%BB%9C&amp;corp_user_name=%E8%8C%83%E6%B5%8B%E8%AF%95&amp;corp_user_mobile=15000000000&amp;corp_user_avatar=%2F%2Fwework.qpic.cn%2Fwwpic%2F212456_0Kveg3kXQry1pTI_1662386683%2F0&amp;external_contact_name=Jenny&amp;external_contact_avatar=%2F%2Fwx.qlogo.cn%2Fmmhead%2FPiajxSqBRaEKbf7Pc7v5ia5pfic7DFibo3CBfFAia6VD3Qib9hpiaNYgEd2cw%2F0&amp;add_time=1655360148&amp;wx_corp_id=wwa64d29ed4d57273e&amp;wx_userid=33&amp;wx_unionid=oCQfpjp0sL7OIFAbZe3rJMHj6kU0&amp;wx_corp_id=ww82d8c231564bb98b&amp;wx_userid=TuiZhuShou&amp;wx_unionid=ol9KOuHRRTuRfR20-hDV0oN6o9bI&amp;wx_external_userid=wm-btLCAAAGfMKkHO0jpuf5BdB-wJv3g&amp;sign=2a47d1f67ef15589fb0e9d43e13b336c">https://www.test.com?wxid=1688851873049028&amp;chat_wxid=7881302848173300&amp;timestamp=1656059696&amp;sub_userid=0&amp;sub_username=&amp;corp_name=%E9%80%90%E5%85%89%E7%BD%91%E7%BB%9C&amp;corp_user_name=%E8%8C%83%E6%B5%8B%E8%AF%95&amp;corp_user_mobile=15000000000&amp;corp_user_avatar=%2F%2Fwework.qpic.cn%2Fwwpic%2F212456_0Kveg3kXQry1pTI_1662386683%2F0&amp;external_contact_name=Jenny&amp;external_contact_avatar=%2F%2Fwx.qlogo.cn%2Fmmhead%2FPiajxSqBRaEKbf7Pc7v5ia5pfic7DFibo3CBfFAia6VD3Qib9hpiaNYgEd2cw%2F0&amp;add_time=1655360148&amp;wx_corp_id=wwa64d29ed4d57273e&amp;wx_userid=33&amp;wx_unionid=oCQfpjp0sL7OIFAbZe3rJMHj6kU0&amp;wx_corp_id=ww82d8c231564bb98b&amp;wx_userid=TuiZhuShou&amp;wx_unionid=ol9KOuHRRTuRfR20-hDV0oN6o9bI&amp;wx_external_userid=wm-btLCAAAGfMKkHO0jpuf5BdB-wJv3g&amp;sign=2a47d1f67ef15589fb0e9d43e13b336c</a></p> <p>其中sign为签名字段,用户可根据下方签名规则验签。对该url进行urldecode后,各字段表示的含义见下方签名规则。</p> <p><strong>2、签名规则:</strong></p> <p>参数进行ASCII正序排列,再进行key和value拼接,最后拼接上secret_key进行MD5加密</p> <p><strong>sceret_key:登录系统,点击在线聊天-侧边栏设置可获取</strong></p> <p>示例值:4b7ee5e6210e056fb00ff518d1653878</p> <p>签名示例:</p> <table> <thead> <tr> <th style="text-align: left;">业务参数</th> <th style="text-align: left;">备注</th> <th style="text-align: left;">示例值</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">wxid</td> <td style="text-align: left;">企微号wxid (系统中获取)</td> <td style="text-align: left;">1xxx</td> </tr> <tr> <td style="text-align: left;">chat_wxid</td> <td style="text-align: left;">聊天对象wxid(系统中获取)</td> <td style="text-align: left;">7xxx</td> </tr> <tr> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">秒级时间戳</td> <td style="text-align: left;">1636905600</td> </tr> <tr> <td style="text-align: left;">sub_userid</td> <td style="text-align: left;">当前登录的子账号ID,主账号登录该字段为0</td> <td style="text-align: left;">0</td> </tr> <tr> <td style="text-align: left;">sub_username</td> <td style="text-align: left;">当前登录的子账号昵称</td> </tr> <tr> <td style="text-align: left;">corp_name</td> <td style="text-align: left;">企业名称</td> <td style="text-align: left;">逐光网络</td> </tr> <tr> <td style="text-align: left;">corp_user_name</td> <td style="text-align: left;">企微号(员工)名称</td> <td style="text-align: left;">范测试</td> </tr> <tr> <td style="text-align: left;">corp_user_avatar</td> <td style="text-align: left;">企微号(员工)头像</td> <td style="text-align: left;">//wework.qpic.cn/wwpic/212456_0Kveg3kXQry1pTI_1662386683/0 未带协议头</td> </tr> <tr> <td style="text-align: left;">corp_user_mobile</td> <td style="text-align: left;">企微号(员工)手机号</td> <td style="text-align: left;">150xxx</td> </tr> <tr> <td style="text-align: left;">external_contact_name</td> <td style="text-align: left;">客户(联系人)昵称</td> <td style="text-align: left;">Jenny</td> </tr> <tr> <td style="text-align: left;">external_contact_avatar</td> <td style="text-align: left;">客户(联系人)头像</td> <td style="text-align: left;">//wx.qlogo.cn/mmhead/PiajxSqBRaEJxzYgQ2kIuGjibkYst5liclwgGrq138yo5Ga44jR4J3sag/0</td> </tr> <tr> <td style="text-align: left;">add_time</td> <td style="text-align: left;">添加客户(联系人)时间,秒级时间戳</td> <td style="text-align: left;">1638247453</td> </tr> <tr> <td style="text-align: left;">wx_corp_id</td> <td style="text-align: left;">企微号归属企业wxid(&lt;font color=&quot;red&quot;&gt;企业微信官方字段,自建应用获取&lt;/font&gt;)</td> <td style="text-align: left;">ww82d8c231564bb98b</td> </tr> <tr> <td style="text-align: left;">wx_userid</td> <td style="text-align: left;">企微号UserID(&lt;font color=&quot;red&quot;&gt;企业微信官方字段,自建应用获取&lt;/font&gt;)</td> <td style="text-align: left;">TuiXiaoZhuShou</td> </tr> <tr> <td style="text-align: left;">wx_unionid</td> <td style="text-align: left;">聊天对象unionid(&lt;font color=&quot;red&quot;&gt;企业微信官方字段,自建应用获取&lt;/font&gt;)</td> <td style="text-align: left;">ol9KOuHRRTuRfR20-hDV0oN6o9bI</td> </tr> <tr> <td style="text-align: left;">wx_external_userid</td> <td style="text-align: left;">聊天对象UserID(&lt;font color=&quot;red&quot;&gt;企业微信官方字段,自建应用获取&lt;/font&gt;)</td> <td style="text-align: left;">wo-btLCAAAEjEBPoLYQSUvLvxLVC2WCA</td> </tr> </tbody> </table> <p>按照如上的参数ASCII正序排列,进行key和value拼接后得到的字符串如下</p> <p>add_time=1655360148&amp;chat_wxid=7881302848173300&amp;corp_name=逐光网络&amp;corp_user_avatar=//wework.qpic.cn/wwpic/212456_0Kveg3kXQry1pTI_1662386683/0&amp;corp_user_mobile=15000000000&amp;corp_user_name=范测试&amp;external_contact_avatar=//wx.qlogo.cn/mmhead/PiajxSqBRaEKbf7Pc7v5ia5pfic7DFibo3CBfFAia6VD3Qib9hpiaNYgEd2cw/0&amp;external_contact_name=Jenny&amp;sub_userid=0&amp;sub_username=&amp;timestamp=1656059696&amp;wx_corp_id=ww82d8c231564bb98b&amp;wx_external_userid=wm-btLCAAAGfMKkHO0jpuf5BdB-wJv3g&amp;wx_unionid=ol9KOuHRRTuRfR20-hDV0oN6o9bI&amp;wx_userid=TuiZhuShou&amp;wxid=1688851873049028</p> <p>拼接上secret_key的字符串如下</p> <p>add_time=1655360148&amp;chat_wxid=7881302848173300&amp;corp_name=逐光网络&amp;corp_user_avatar=//wework.qpic.cn/wwpic/212456_0Kveg3kXQry1pTI_1662386683/0&amp;corp_user_mobile=15000000000&amp;corp_user_name=范测试&amp;external_contact_avatar=//wx.qlogo.cn/mmhead/PiajxSqBRaEKbf7Pc7v5ia5pfic7DFibo3CBfFAia6VD3Qib9hpiaNYgEd2cw/0&amp;external_contact_name=Jenny&amp;sub_userid=0&amp;sub_username=&amp;timestamp=1656059696&amp;wx_corp_id=ww82d8c231564bb98b&amp;wx_external_userid=wm-btLCAAAGfMKkHO0jpuf5BdB-wJv3g&amp;wx_unionid=ol9KOuHRRTuRfR20-hDV0oN6o9bI&amp;wx_userid=TuiZhuShou&amp;wxid=1688851873049028&amp;secret_key=4b7ee5e6210e056fb00ff518d1653878</p> <p>最后对上面得到的字符串做MD5加密处理得到签名</p> <pre><code>2a47d1f67ef15589fb0e9d43e13b336c</code></pre> <p>最终系统跳转地址为:</p> <p><a href="https://www.test.com?wxid=1688851873049028&amp;chat_wxid=7881302848173300&amp;timestamp=1656059696&amp;sub_userid=0&amp;sub_username=&amp;corp_name=%E9%80%90%E5%85%89%E7%BD%91%E7%BB%9C&amp;corp_user_name=%E8%8C%83%E6%B5%8B%E8%AF%95&amp;corp_user_mobile=15000000000&amp;corp_user_avatar=%2F%2Fwework.qpic.cn%2Fwwpic%2F212456_0Kveg3kXQry1pTI_1662386683%2F0&amp;external_contact_name=Jenny&amp;external_contact_avatar=%2F%2Fwx.qlogo.cn%2Fmmhead%2FPiajxSqBRaEKbf7Pc7v5ia5pfic7DFibo3CBfFAia6VD3Qib9hpiaNYgEd2cw%2F0&amp;add_time=1655360148&amp;wx_corp_id=wwa64d29ed4d57273e&amp;wx_userid=33&amp;wx_unionid=oCQfpjp0sL7OIFAbZe3rJMHj6kU0&amp;wx_corp_id=ww82d8c231564bb98b&amp;wx_userid=TuiZhuShou&amp;wx_unionid=ol9KOuHRRTuRfR20-hDV0oN6o9bI&amp;wx_external_userid=wm-btLCAAAGfMKkHO0jpuf5BdB-wJv3g&amp;sign=2a47d1f67ef15589fb0e9d43e13b336c">https://www.test.com?wxid=1688851873049028&amp;chat_wxid=7881302848173300&amp;timestamp=1656059696&amp;sub_userid=0&amp;sub_username=&amp;corp_name=%E9%80%90%E5%85%89%E7%BD%91%E7%BB%9C&amp;corp_user_name=%E8%8C%83%E6%B5%8B%E8%AF%95&amp;corp_user_mobile=15000000000&amp;corp_user_avatar=%2F%2Fwework.qpic.cn%2Fwwpic%2F212456_0Kveg3kXQry1pTI_1662386683%2F0&amp;external_contact_name=Jenny&amp;external_contact_avatar=%2F%2Fwx.qlogo.cn%2Fmmhead%2FPiajxSqBRaEKbf7Pc7v5ia5pfic7DFibo3CBfFAia6VD3Qib9hpiaNYgEd2cw%2F0&amp;add_time=1655360148&amp;wx_corp_id=wwa64d29ed4d57273e&amp;wx_userid=33&amp;wx_unionid=oCQfpjp0sL7OIFAbZe3rJMHj6kU0&amp;wx_corp_id=ww82d8c231564bb98b&amp;wx_userid=TuiZhuShou&amp;wx_unionid=ol9KOuHRRTuRfR20-hDV0oN6o9bI&amp;wx_external_userid=wm-btLCAAAGfMKkHO0jpuf5BdB-wJv3g&amp;sign=2a47d1f67ef15589fb0e9d43e13b336c</a></p> <h2>群聊:</h2> <p>基于前文配置,如果是群聊,点击右侧侧边栏的自定义页面时,会跳转到地址验签方式同上: <a href="https://www.test.com/?wxid=1688851873049028&amp;chat_wxid=7881302848173300&amp;timestamp=1656059696&amp;sub_userid=0&amp;sub_username=&amp;corp_name=%E9%80%90%E5%85%89%E7%BD%91%E7%BB%9C&amp;corp_user_name=%E8%8C%83%E6%B5%8B%E8%AF%95&amp;corp_user_mobile=15000000000&amp;corp_user_avatar=%2F%2Fwework.qpic.cn%2Fwwpic%2F212456_0Kveg3kXQry1pTI_1662386683%2F0&amp;room_nickname=%E7%BE%A4%E5%90%8D%E7%A7%B0&amp;room_create_time=1661484192&amp;sign=47e34fbff601c8f78196f05d0d4e9ccd">https://www.test.com/?wxid=1688851873049028&amp;chat_wxid=7881302848173300&amp;timestamp=1656059696&amp;sub_userid=0&amp;sub_username=&amp;corp_name=%E9%80%90%E5%85%89%E7%BD%91%E7%BB%9C&amp;corp_user_name=%E8%8C%83%E6%B5%8B%E8%AF%95&amp;corp_user_mobile=15000000000&amp;corp_user_avatar=%2F%2Fwework.qpic.cn%2Fwwpic%2F212456_0Kveg3kXQry1pTI_1662386683%2F0&amp;room_nickname=%E7%BE%A4%E5%90%8D%E7%A7%B0&amp;room_create_time=1661484192&amp;sign=47e34fbff601c8f78196f05d0d4e9ccd</a></p> <table> <thead> <tr> <th style="text-align: left;">业务参数</th> <th style="text-align: left;">备注</th> <th style="text-align: left;">示例值</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">wxid</td> <td style="text-align: left;">企微号wxid(系统中获取)</td> <td style="text-align: left;">1xxx</td> </tr> <tr> <td style="text-align: left;">chat_wxid</td> <td style="text-align: left;">聊天对象wxid(系统中获取)</td> <td style="text-align: left;">7xxx</td> </tr> <tr> <td style="text-align: left;">timestamp</td> <td style="text-align: left;">秒级时间戳</td> <td style="text-align: left;">1636905600</td> </tr> <tr> <td style="text-align: left;">sub_userid</td> <td style="text-align: left;">当前登录的子账号ID,主账号登录该字段为0</td> <td style="text-align: left;">0</td> </tr> <tr> <td style="text-align: left;">sub_username</td> <td style="text-align: left;">当前登录的子账号昵称</td> </tr> <tr> <td style="text-align: left;">corp_name</td> <td style="text-align: left;">企业名称</td> <td style="text-align: left;">逐光网络</td> </tr> <tr> <td style="text-align: left;">corp_user_name</td> <td style="text-align: left;">企微号(员工)名称</td> <td style="text-align: left;">范测试</td> </tr> <tr> <td style="text-align: left;">corp_user_avatar</td> <td style="text-align: left;">企微号(员工)头像</td> <td style="text-align: left;">//wework.qpic.cn/wwpic/212456_0Kveg3kXQry1pTI_1662386683/0 未带协议头</td> </tr> <tr> <td style="text-align: left;">corp_user_mobile</td> <td style="text-align: left;">企微号(员工)手机号</td> <td style="text-align: left;">150xxx</td> </tr> <tr> <td style="text-align: left;">room_nickname</td> <td style="text-align: left;">群名称</td> <td style="text-align: left;"></td> </tr> <tr> <td style="text-align: left;">room_create_time</td> <td style="text-align: left;">群创建时间,秒级时间戳</td> <td style="text-align: left;"></td> </tr> </tbody> </table>

页面列表

ITEM_HTML