SaiNiuApi

SaiNiuApi - 基于sunnySDK的中间件调试框架,千牛SDK全功能框架


【11】获取操作事件

<p>[TOC]</p> <h5>接口状态</h5> <ul> <li><code>正常</code></li> </ul> <h5>框架版本</h5> <ul> <li><code>≥ 2.0.5.0</code></li> </ul> <h5>更新时间</h5> <ul> <li><code>2024/11/21</code></li> </ul> <h5>调用额度</h5> <ul> <li><code>免额度</code></li> </ul> <h5>简要描述</h5> <ul> <li>HTTP轮询获取操作事件</li> </ul> <h5>易语言模块调用例子</h5> <pre><code>SaiNiuPost.Call.获取操作事件()</code></pre> <h5>POST调用例子</h5> <pre><code>http://127.0.0.1:3030/SaiNiuApi/Call</code></pre> <pre><code>&amp;amp;post=GetEventNews&amp;amp;data={}</code></pre> <h5>参数</h5> <ul> <li>无</li> </ul> <h5>返回成功示例 - 切换对象</h5> <pre><code>{&amp;quot;code&amp;quot;:200,&amp;quot;msg&amp;quot;:&amp;quot;调用成功&amp;quot;,&amp;quot;data&amp;quot;:&amp;quot;{\&amp;quot;type\&amp;quot;:\&amp;quot;CALL_RECEIVE_MSG\&amp;quot;,\&amp;quot;event\&amp;quot;:\&amp;quot;CONVERSATION_CHANGE\&amp;quot;,\&amp;quot;msg\&amp;quot;:\&amp;quot;切换对象\&amp;quot;,\&amp;quot;userNick\&amp;quot;:\&amp;quot;tb9403060_2011\&amp;quot;,\&amp;quot;currentUser\&amp;quot;:\&amp;quot;{\\\&amp;quot;uid\\\&amp;quot;:\\\&amp;quot;cntaobaotb266770389534\\\&amp;quot;,\\\&amp;quot;user_nick\\\&amp;quot;:\\\&amp;quot;cntaobaotb266770389534\\\&amp;quot;,\\\&amp;quot;securityUID\\\&amp;quot;:\\\&amp;quot;2218165087899\\\&amp;quot;,\\\&amp;quot;bizDomain\\\&amp;quot;:\\\&amp;quot;taobao\\\&amp;quot;,\\\&amp;quot;bizType\\\&amp;quot;:\\\&amp;quot;11001\\\&amp;quot;,\\\&amp;quot;dnick\\\&amp;quot;:\\\&amp;quot;tb266770389534\\\&amp;quot;,\\\&amp;quot;cid\\\&amp;quot;:\\\&amp;quot;2218165087899.1-796978238.1#11001@cntaobao\\\&amp;quot;}\&amp;quot;,\&amp;quot;data\&amp;quot;:{\&amp;quot;ctype\&amp;quot;:0,\&amp;quot;targetType\&amp;quot;:\&amp;quot;3\&amp;quot;,\&amp;quot;nick\&amp;quot;:\&amp;quot;tb266770389534\&amp;quot;,\&amp;quot;targetId\&amp;quot;:\&amp;quot;2218165087899\&amp;quot;,\&amp;quot;ccode\&amp;quot;:\&amp;quot;2218165087899.1-796978238.1#11001@cntaobao\&amp;quot;,\&amp;quot;bizeType\&amp;quot;:\&amp;quot;11001\&amp;quot;,\&amp;quot;display\&amp;quot;:\&amp;quot;tb266770389534\&amp;quot;,\&amp;quot;portrait\&amp;quot;:\&amp;quot;\&amp;quot;,\&amp;quot;unreadcount\&amp;quot;:0},\&amp;quot;passkey\&amp;quot;:1732155946559}&amp;quot;,&amp;quot;passkey&amp;quot;:&amp;quot;1732155951350&amp;quot;}</code></pre> <h5>返回成功示例 - 对话关闭</h5> <pre><code>{&amp;quot;code&amp;quot;:200,&amp;quot;msg&amp;quot;:&amp;quot;调用成功&amp;quot;,&amp;quot;data&amp;quot;:&amp;quot;{\&amp;quot;type\&amp;quot;:\&amp;quot;CALL_RECEIVE_MSG\&amp;quot;,\&amp;quot;event\&amp;quot;:\&amp;quot;CONVERSATION_CLOSE\&amp;quot;,\&amp;quot;msg\&amp;quot;:\&amp;quot;对话关闭\&amp;quot;,\&amp;quot;userNick\&amp;quot;:\&amp;quot;tb9403060_2011\&amp;quot;,\&amp;quot;currentUser\&amp;quot;:null,\&amp;quot;data\&amp;quot;:{\&amp;quot;closeall\&amp;quot;:0,\&amp;quot;cid\&amp;quot;:{\&amp;quot;ccode\&amp;quot;:\&amp;quot;2218165087899.1-796978238.1#11001@cntaobao\&amp;quot;}},\&amp;quot;passkey\&amp;quot;:1732155985267}&amp;quot;,&amp;quot;passkey&amp;quot;:&amp;quot;1732155986638&amp;quot;}</code></pre> <h5>返回成功示例 - 发送消息</h5> <pre><code>{&amp;quot;code&amp;quot;:200,&amp;quot;msg&amp;quot;:&amp;quot;调用成功&amp;quot;,&amp;quot;data&amp;quot;:&amp;quot;{\&amp;quot;type\&amp;quot;:\&amp;quot;CALL_RECEIVE_MSG\&amp;quot;,\&amp;quot;event\&amp;quot;:\&amp;quot;CHAT_SEND_MSG\&amp;quot;,\&amp;quot;msg\&amp;quot;:\&amp;quot;发送消息\&amp;quot;,\&amp;quot;userNick\&amp;quot;:\&amp;quot;tb9403060_2011\&amp;quot;,\&amp;quot;currentUser\&amp;quot;:\&amp;quot;{\\\&amp;quot;uid\\\&amp;quot;:\\\&amp;quot;cntaobaotb266770389534\\\&amp;quot;,\\\&amp;quot;user_nick\\\&amp;quot;:\\\&amp;quot;cntaobaotb266770389534\\\&amp;quot;,\\\&amp;quot;securityUID\\\&amp;quot;:\\\&amp;quot;2218165087899\\\&amp;quot;,\\\&amp;quot;bizDomain\\\&amp;quot;:\\\&amp;quot;taobao\\\&amp;quot;,\\\&amp;quot;bizType\\\&amp;quot;:\\\&amp;quot;11001\\\&amp;quot;,\\\&amp;quot;dnick\\\&amp;quot;:\\\&amp;quot;tb266770389534\\\&amp;quot;,\\\&amp;quot;cid\\\&amp;quot;:\\\&amp;quot;2218165087899.1-796978238.1#11001@cntaobao\\\&amp;quot;}\&amp;quot;,\&amp;quot;data\&amp;quot;:{\&amp;quot;cid\&amp;quot;:{\&amp;quot;ccode\&amp;quot;:\&amp;quot;2218165087899.1-796978238.1#11001@cntaobao\&amp;quot;}},\&amp;quot;passkey\&amp;quot;:1732156020874}&amp;quot;,&amp;quot;passkey&amp;quot;:&amp;quot;1732156021902&amp;quot;}</code></pre> <h5>返回成功示例 - 发送消息成功</h5> <pre><code>{&amp;quot;code&amp;quot;:200,&amp;quot;msg&amp;quot;:&amp;quot;调用成功&amp;quot;,&amp;quot;data&amp;quot;:&amp;quot;{\&amp;quot;type\&amp;quot;:\&amp;quot;CALL_RECEIVE_MSG\&amp;quot;,\&amp;quot;event\&amp;quot;:\&amp;quot;CHAT_SEND_MSG_STATUS_CHANGE\&amp;quot;,\&amp;quot;msg\&amp;quot;:\&amp;quot;消息发送成功\&amp;quot;,\&amp;quot;userNick\&amp;quot;:\&amp;quot;tb9403060_2011\&amp;quot;,\&amp;quot;data\&amp;quot;:[{\&amp;quot;cid\&amp;quot;:{\&amp;quot;ccode\&amp;quot;:\&amp;quot;2218165087899.1-796978238.1#11001@cntaobao\&amp;quot;},\&amp;quot;mcode\&amp;quot;:{\&amp;quot;clientId\&amp;quot;:\&amp;quot;7265189011965084411\&amp;quot;,\&amp;quot;messageId\&amp;quot;:\&amp;quot;3227529997716.PNM\&amp;quot;},\&amp;quot;originalData\&amp;quot;:{\&amp;quot;text\&amp;quot;:\&amp;quot;你好\&amp;quot;},\&amp;quot;progress\&amp;quot;:100,\&amp;quot;sendStatus\&amp;quot;:0,\&amp;quot;sendTime\&amp;quot;:1732156041217,\&amp;quot;sortTimeMicrosecond\&amp;quot;:1732156041217000,\&amp;quot;delta\&amp;quot;:{\&amp;quot;receiverState\&amp;quot;:{\&amp;quot;unread\&amp;quot;:{\&amp;quot;count\&amp;quot;:1,\&amp;quot;all\&amp;quot;:false},\&amp;quot;read\&amp;quot;:{\&amp;quot;count\&amp;quot;:1,\&amp;quot;all\&amp;quot;:false}},\&amp;quot;ext\&amp;quot;:{\&amp;quot;pushMsgType\&amp;quot;:\&amp;quot;bc_chat\&amp;quot;,\&amp;quot;sender_nick\&amp;quot;:\&amp;quot;cntaobaotb9403060_2011\&amp;quot;,\&amp;quot;receiverBizDomain\&amp;quot;:\&amp;quot;taobao\&amp;quot;,\&amp;quot;receiver_nick\&amp;quot;:\&amp;quot;cntaobaotb266770389534\&amp;quot;,\&amp;quot;saasNamespace\&amp;quot;:\&amp;quot;taobao\&amp;quot;,\&amp;quot;senderBizDomain\&amp;quot;:\&amp;quot;taobao\&amp;quot;}}}],\&amp;quot;passkey\&amp;quot;:1732156021029}&amp;quot;,&amp;quot;passkey&amp;quot;:&amp;quot;1732156021911&amp;quot;}</code></pre> <h5>返回成功示例 - 用户正在输入</h5> <pre><code>{&amp;quot;code&amp;quot;:200,&amp;quot;msg&amp;quot;:&amp;quot;调用成功&amp;quot;,&amp;quot;data&amp;quot;:&amp;quot;{\&amp;quot;type\&amp;quot;:\&amp;quot;CALL_RECEIVE_MSG\&amp;quot;,\&amp;quot;event\&amp;quot;:\&amp;quot;INPUT_STATUS_CHANGE\&amp;quot;,\&amp;quot;msg\&amp;quot;:\&amp;quot;用户正在输入\&amp;quot;,\&amp;quot;userNick\&amp;quot;:\&amp;quot;tb9403060_2011\&amp;quot;,\&amp;quot;data\&amp;quot;:{\&amp;quot;cid\&amp;quot;:{\&amp;quot;ccode\&amp;quot;:\&amp;quot;2218165087899.1-796978238.1#11001@cntaobao\&amp;quot;},\&amp;quot;value\&amp;quot;:0},\&amp;quot;passkey\&amp;quot;:1732156077980}&amp;quot;,&amp;quot;passkey&amp;quot;:&amp;quot;1732156082291&amp;quot;}</code></pre> <h5>返回成功示例 - 消息被阅读</h5> <pre><code>{&amp;quot;code&amp;quot;:200,&amp;quot;msg&amp;quot;:&amp;quot;调用成功&amp;quot;,&amp;quot;data&amp;quot;:&amp;quot;{\&amp;quot;type\&amp;quot;:\&amp;quot;CALL_RECEIVE_MSG\&amp;quot;,\&amp;quot;event\&amp;quot;:\&amp;quot;CHAT_MSG_READ\&amp;quot;,\&amp;quot;msg\&amp;quot;:\&amp;quot;消息被阅读\&amp;quot;,\&amp;quot;userNick\&amp;quot;:\&amp;quot;tb9403060_2011\&amp;quot;,\&amp;quot;data\&amp;quot;:[{\&amp;quot;cid\&amp;quot;:{\&amp;quot;ccode\&amp;quot;:\&amp;quot;2218165087899.1-796978238.1#11001@cntaobao\&amp;quot;},\&amp;quot;mcode\&amp;quot;:{\&amp;quot;clientId\&amp;quot;:\&amp;quot;\&amp;quot;,\&amp;quot;messageId\&amp;quot;:\&amp;quot;3227529997716.PNM\&amp;quot;},\&amp;quot;state\&amp;quot;:{\&amp;quot;unread\&amp;quot;:{\&amp;quot;count\&amp;quot;:0,\&amp;quot;all\&amp;quot;:false},\&amp;quot;read\&amp;quot;:{\&amp;quot;count\&amp;quot;:2,\&amp;quot;all\&amp;quot;:true}}}],\&amp;quot;passkey\&amp;quot;:1732156078178}&amp;quot;,&amp;quot;passkey&amp;quot;:&amp;quot;1732156082307&amp;quot;}</code></pre> <h5>返回成功示例 - 窗口切换【多账号或企业号生效】</h5> <pre><code>{&amp;quot;code&amp;quot;:200,&amp;quot;msg&amp;quot;:&amp;quot;调用成功&amp;quot;,&amp;quot;data&amp;quot;:&amp;quot;{\&amp;quot;type\&amp;quot;:\&amp;quot;CALL_RECEIVE_MSG\&amp;quot;,\&amp;quot;event\&amp;quot;:\&amp;quot;WINDOW_ACTIVE\&amp;quot;,\&amp;quot;msg\&amp;quot;:\&amp;quot;窗口切换\&amp;quot;,\&amp;quot;userNick\&amp;quot;:\&amp;quot;tb9403060_2011\&amp;quot;,\&amp;quot;currentUser\&amp;quot;:null,\&amp;quot;data\&amp;quot;:{\&amp;quot;cid\&amp;quot;:{\&amp;quot;ccode\&amp;quot;:\&amp;quot;\&amp;quot;}},\&amp;quot;passkey\&amp;quot;:1732156268254}&amp;quot;,&amp;quot;passkey&amp;quot;:&amp;quot;1732156272098&amp;quot;}</code></pre> <h5>返回失败示例</h5> <pre><code>{&amp;quot;code&amp;quot;:501,&amp;quot;msg&amp;quot;:&amp;quot;调用失败 - 当前队列中暂无新消息&amp;quot;,&amp;quot;passkey&amp;quot;:&amp;quot;1732151939223&amp;quot;}</code></pre> <h5>返回参数说明</h5> <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;">code</td> <td style="text-align: left;">整数型</td> <td>返回结果,成功=200,失败≠200</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">文本型</td> <td>结果说明,调用成功或失败原因</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">文本型</td> <td>调用结果</td> </tr> <tr> <td style="text-align: left;">passkey</td> <td style="text-align: left;">文本型</td> <td>请求完成13位时间戳</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML