接口文档

接口文档


加入房间

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>加入房间</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://xx.com/author/api/joinRoom</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST </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;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>房间标号</td> </tr> <tr> <td style="text-align: left;">password</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>密码</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{ &amp;quot;code&amp;quot;: 200, &amp;quot;message&amp;quot;: &amp;quot;ok&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;room_id&amp;quot;: 2, &amp;quot;author_id&amp;quot;: 2816, &amp;quot;user_id&amp;quot;: 48724, &amp;quot;title&amp;quot;: &amp;quot;我的拼字房&amp;quot;, &amp;quot;code&amp;quot;: &amp;quot;28161711683334&amp;quot;, &amp;quot;type&amp;quot;: &amp;quot;duration&amp;quot;, &amp;quot;duration&amp;quot;: 3600, &amp;quot;word_number&amp;quot;: 0, &amp;quot;member_number&amp;quot;: 1, &amp;quot;is_end&amp;quot;: false, &amp;quot;start_time&amp;quot;: 1711684234, &amp;quot;end_time&amp;quot;: 1711686934, &amp;quot;is_ready&amp;quot;: false, &amp;quot;is_start&amp;quot;: false } }</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;">room_id</td> <td style="text-align: left;">int</td> <td>房间id</td> </tr> <tr> <td style="text-align: left;">author_id</td> <td style="text-align: left;">int</td> <td>作家id</td> </tr> <tr> <td style="text-align: left;">user_id</td> <td style="text-align: left;">int</td> <td>用户id</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">int</td> <td>房间名称</td> </tr> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">int</td> <td>房间编号</td> </tr> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">int</td> <td>类型</td> </tr> <tr> <td style="text-align: left;">duration</td> <td style="text-align: left;">int</td> <td>时长</td> </tr> <tr> <td style="text-align: left;">word_number</td> <td style="text-align: left;">int</td> <td>字数</td> </tr> <tr> <td style="text-align: left;">member_number</td> <td style="text-align: left;">int</td> <td>房间会员数</td> </tr> <tr> <td style="text-align: left;">is_end</td> <td style="text-align: left;">int</td> <td>是否结束</td> </tr> <tr> <td style="text-align: left;">start_time</td> <td style="text-align: left;">int</td> <td>开始时间</td> </tr> <tr> <td style="text-align: left;">end_time</td> <td style="text-align: left;">int</td> <td>结束时间</td> </tr> <tr> <td style="text-align: left;">is_ready</td> <td style="text-align: left;">int</td> <td>我在该房间的是否准备</td> </tr> <tr> <td style="text-align: left;">is_start</td> <td style="text-align: left;">int</td> <td>是否开始比赛了</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML