云真机

API接口文档


查询指令执行结果

<h2>查询任务</h2> <ul> <li>根据下发任务获取到的task_id可查询已下发任务的详细情况,包含执行状态、请求参数和执行结果等。</li> </ul> <h2>请求URL</h2> <ul> <li><code>https://oapi-yzj.miaokol.com/wechat/queryTask</code></li> </ul> <h2>请求方式</h2> <ul> <li>GET </li> </ul> <h2>请求参数</h2> <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;">task_id</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>任务ID,由下发任务接口获得,该字段不传或传空将返回最后一次下发的任务数据</td> </tr> </tbody> </table> <h2>返回数据</h2> <p>数据结构:</p> <pre><code>{&amp;quot;errcode&amp;quot;:0,&amp;quot;data&amp;quot;:{&amp;quot;task&amp;quot;:{&amp;quot;id&amp;quot;:1,&amp;quot;task_type&amp;quot;:&amp;quot;xxxx&amp;quot;,&amp;quot;result&amp;quot;:&amp;quot;xxxx&amp;quot;,&amp;quot;status&amp;quot;:&amp;quot;&amp;quot;,&amp;quot;ctime&amp;quot;:&amp;quot;xxxx&amp;quot;}}}</code></pre> <ul> <li>data.task为对象,对象中字段说明:</li> </ul> <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;">id</td> <td style="text-align: left;">int</td> <td style="text-align: left;">任务ID</td> </tr> <tr> <td style="text-align: left;">task_type</td> <td style="text-align: left;">string</td> <td style="text-align: left;">任务类型</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td style="text-align: left;">任务状态(1执行中;2已完成;3失败)&lt;font color=&quot;red&quot; &gt;注意:已完成仅代表指令已下发,受企微机制影响,并不能代表指令最终一定能执行成功。&lt;/font&gt;</td> </tr> <tr> <td style="text-align: left;">result</td> <td style="text-align: left;">object</td> <td style="text-align: left;">任务执行结果</td> </tr> <tr> <td style="text-align: left;">ctime</td> <td style="text-align: left;">int</td> <td style="text-align: left;">任务创建时间戳</td> </tr> </tbody> </table> <p>不同任务类型返回数据中执行结果result的字段说明:</p> <ul> <li>获取群二维码 数据结构: <pre><code>{ &amp;quot;avatar&amp;quot;:&amp;quot;https:\/\/wework.qpic.cn\/wwpic\/711610_bE3Gry8mRZqg6E1_1637920374\/0&amp;quot;, &amp;quot;chatroom_wxid&amp;quot;:&amp;quot;R:10696050850033049&amp;quot;, &amp;quot;qrcode_url&amp;quot;:&amp;quot;\/\/qiyunbao.oss-cn-hangzhou.aliyuncs.com\/media\/public\/wechatdata\/1688851873049028\/r6fbb13502f1a507a05bbae7ca9396829.png&amp;quot; }</code></pre> <p>数据字段说明:</p></li> </ul> <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;">avatar</td> <td style="text-align: left;">string</td> <td style="text-align: left;">群头像url</td> </tr> <tr> <td style="text-align: left;">qrcode_url</td> <td style="text-align: left;">string</td> <td style="text-align: left;">群二维码url</td> </tr> <tr> <td style="text-align: left;">chatroom_wxid</td> <td style="text-align: left;">string</td> <td style="text-align: left;">群wxid</td> </tr> </tbody> </table> <ul> <li>添加联系人 数据结构: <pre><code>{ &amp;quot;mobile&amp;quot;:&amp;quot;1533392xxxx&amp;quot;, &amp;quot;wechat_user&amp;quot;:{ &amp;quot;avatar&amp;quot;:&amp;quot;http:\/\/wx.qlogo.cn\/mmhead\/PiajxSqBRaEJxzYgQ2kIuGjibkYst5liclwgGrq138yo5Ga44jR4J3sag\/0&amp;quot;, &amp;quot;is_friend&amp;quot;:false, &amp;quot;nickname&amp;quot;:&amp;quot;地球上的星星6868&amp;quot;, &amp;quot;wxid&amp;quot;:&amp;quot;7881302795046315&amp;quot; }, &amp;quot;wxwork_user&amp;quot;:{ &amp;quot;avatar&amp;quot;:&amp;quot;http:\/\/wework.qpic.cn\/bizmail\/biavsjc7CcfpRseZeE9IsmvlmvU2jRRI6ufoMiaDMh3f90LjniaDHe9EA\/0&amp;quot;, &amp;quot;corp_wxid&amp;quot;:&amp;quot;1970325042198880&amp;quot;, &amp;quot;is_friend&amp;quot;:false, &amp;quot;nickname&amp;quot;:&amp;quot;***********8&amp;quot;, &amp;quot;wxid&amp;quot;:&amp;quot;1688851161823068&amp;quot; } }</code></pre> <p>数据字段说明:</p></li> </ul> <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;">mobile</td> <td style="text-align: left;">string</td> <td style="text-align: left;">手机号</td> </tr> <tr> <td style="text-align: left;">wechat_user</td> <td style="text-align: left;">object</td> <td style="text-align: left;">好友个微信息</td> </tr> <tr> <td style="text-align: left;">wechat_user.wxid</td> <td style="text-align: left;">string</td> <td style="text-align: left;">好友wxid</td> </tr> <tr> <td style="text-align: left;">wechat_user.avatar</td> <td style="text-align: left;">string</td> <td style="text-align: left;">头像url</td> </tr> <tr> <td style="text-align: left;">wechat_user.nickname</td> <td style="text-align: left;">string</td> <td style="text-align: left;">昵称</td> </tr> <tr> <td style="text-align: left;">wxwork_user</td> <td style="text-align: left;">object</td> <td style="text-align: left;">好友企微信息</td> </tr> <tr> <td style="text-align: left;">wxwork_user.wxid</td> <td style="text-align: left;">string</td> <td style="text-align: left;">好友wxid</td> </tr> <tr> <td style="text-align: left;">wxwork_user.avatar</td> <td style="text-align: left;">string</td> <td style="text-align: left;">头像url</td> </tr> <tr> <td style="text-align: left;">wxwork_user.nickname</td> <td style="text-align: left;">string</td> <td style="text-align: left;">昵称</td> </tr> <tr> <td style="text-align: left;">wxwork_user.corp_wxid</td> <td style="text-align: left;">string</td> <td style="text-align: left;">好友企业wxid</td> </tr> <tr> <td style="text-align: left;">wxwork_user.is_friend</td> <td style="text-align: left;">string</td> <td style="text-align: left;">是否好友:是true;否false</td> </tr> </tbody> </table> <ul> <li>建群 数据结构: <pre><code>{ &amp;quot;room_wxid&amp;quot;:&amp;quot;R:10696050850033049&amp;quot; }</code></pre> <p>数据字段说明:</p></li> </ul> <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;">room_wxid</td> <td style="text-align: left;">string</td> <td style="text-align: left;">群wxid</td> </tr> </tbody> </table> <ul> <li>搜索通讯录成员 数据结构: <pre><code>{ &amp;quot;text&amp;quot;:&amp;quot;王&amp;quot;, &amp;quot;user_list&amp;quot;:[ { &amp;quot;avatar&amp;quot;:&amp;quot;http:\/\/wework.qpic.cn\/bizmail\/JrMOB5s0qanoJ73Wss3DnD57DHbPlaUtqlCibE3IjBAT3icr7qjDuZXA\/0&amp;quot;, &amp;quot;corp_wxid&amp;quot;:&amp;quot;1970325057094209&amp;quot;, &amp;quot;dept_wxid&amp;quot;:&amp;quot;2251803308720788&amp;quot;, &amp;quot;desc&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;gender&amp;quot;:2, &amp;quot;nickname&amp;quot;:&amp;quot;王11&amp;quot;, &amp;quot;remark&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;wxid&amp;quot;:&amp;quot;1688853852193386&amp;quot; }, { &amp;quot;avatar&amp;quot;:&amp;quot;http:\/\/wework.qpic.cn\/bizmail\/AdaPibXEefH69sdlsKtWhrYuJ7tNepJA8p6GbkhtFcvzcssRTpghqfg\/0&amp;quot;, &amp;quot;corp_wxid&amp;quot;:&amp;quot;1970325057094209&amp;quot;, &amp;quot;dept_wxid&amp;quot;:&amp;quot;2251801394720435&amp;quot;, &amp;quot;desc&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;gender&amp;quot;:2, &amp;quot;nickname&amp;quot;:&amp;quot;王22&amp;quot;, &amp;quot;remark&amp;quot;:&amp;quot;&amp;quot;, &amp;quot;wxid&amp;quot;:&amp;quot;1688851834084821&amp;quot; } ] }</code></pre> <p>数据字段说明:</p></li> </ul> <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;">corp_wxid</td> <td style="text-align: left;">string</td> <td style="text-align: left;">成员所在企业wxid,可根据该wxid过滤出企微号所在企业内部成员</td> </tr> <tr> <td style="text-align: left;">dept_wxid</td> <td style="text-align: left;">string</td> <td style="text-align: left;">成员所在企业部门wxid</td> </tr> <tr> <td style="text-align: left;">gender</td> <td style="text-align: left;">int</td> <td style="text-align: left;">性别:0未知;1男;2女;</td> </tr> <tr> <td style="text-align: left;">nickname</td> <td style="text-align: left;">string</td> <td style="text-align: left;">昵称</td> </tr> <tr> <td style="text-align: left;">wxid</td> <td style="text-align: left;">string</td> <td style="text-align: left;">成员wxid</td> </tr> </tbody> </table> <h2>请求示例</h2> <pre><code>GET /wechat/queryTask?app_id=xxx&amp;amp;access_token=xxxx&amp;amp;task_id=1 HTTP/1.1 Host:oapi-yzj.miaokol.com Content-Type: application/x-www-form-urlencoded </code></pre> <h2>响应示例</h2> <pre><code>HTTP/1.1 200 OK { &amp;quot;data&amp;quot;:{ &amp;quot;task&amp;quot;:{ &amp;quot;id&amp;quot;:2, &amp;quot;user_id&amp;quot;:&amp;quot;xxx&amp;quot;, &amp;quot;action&amp;quot;:&amp;quot;newGroup&amp;quot;, &amp;quot;params&amp;quot;:&amp;quot;{\&amp;quot;wxid\&amp;quot;:\&amp;quot;xxxx\&amp;quot;,\&amp;quot;room_name\&amp;quot;:\&amp;quot;xxxx\&amp;quot;,\&amp;quot;member_wxids\&amp;quot;:[]}&amp;quot;, &amp;quot;result&amp;quot;:&amp;quot;{\&amp;quot;room_wxid\&amp;quot;:\&amp;quot;R:xxx\&amp;quot;}&amp;quot;, &amp;quot;status&amp;quot;:2, &amp;quot;ctime&amp;quot;:1637919792, &amp;quot;utime&amp;quot;:1637920319, &amp;quot;delayed_time&amp;quot;:0 } }, &amp;quot;errcode&amp;quot;:0 }</code></pre>

页面列表

ITEM_HTML