消息列表API
<h1>开发者</h1>
<ul>
<li>罗恒山</li>
</ul>
<h1>说明</h1>
<ul>
<li>书目列表</li>
</ul>
<h1>请求</h1>
<ul>
<li>Endpoint： <code>/api/message</code></li>
<li>Method：GET</li>
</ul>
<h1>查询条件（filter）</h1>
<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;">filter[subject]</td>
<td style="text-align: left;">string</td>
<td>消息主题，模糊查询</td>
</tr>
<tr>
<td style="text-align: left;">filter[sender_id]</td>
<td style="text-align: left;">int</td>
<td>发件人ID，全等</td>
</tr>
</tbody>
</table>
<p>示例 <code>/api/message?filter[subject]=aaa&filter[sender_id]=69</code></p>
<h1>关联对象（include）</h1>
<ul>
<li>sender：发件人</li>
<li>recipient：收件人</li>
</ul>
<p>示例 <code>/api/message?include=sender,recipient</code></p>
<h1>返回示例</h1>
<p>分页的相关参数，请查看"接口说明文档-常例：分页返回结果"</p>
<pre><code>{
"status_code": 200,
"message": "",
"data": {
"current_page": 1,
"data": [
{
"id": 1,
"sender_id": 0,
"recipient_id": 69,
"subject": "心愿单已采购",
"content": "您的心愿单书籍《老人与海》、《水浒寻宋》已下单采购",
"view_at": "",
"created_at": "2022-02-24 15:14:03",
"updated_at": "2022-02-24 15:14:03",
"deleted_at": "",
"sender": null,
"recipient": {
"id": 69,
"name": "肖小洁",
"avatar": "https://tgcadmin.hxeduonline.com/images/user_avatar.jpg",
"mobile": "18670784551",
"mobile_verified_at": "",
"email": "1644560647@mail.com",
"email_verified_at": "",
"status": 1,
"library_id": 32,
"library_user_level": 2,
"openid": 0,
"login_at": "2022-02-17 15:17:10",
"is_mobile_verified": 0,
"created_at": "2022-02-10 13:38:50",
"updated_at": "2022-02-17 15:17:10",
"deleted_at": ""
}
}
],
"first_page_url": "http://yuedaguancang.my/api/message?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://yuedaguancang.my/api/message?page=1",
"links": [
{
"url": null,
"label": "&laquo; 上一页",
"active": false
},
{
"url": "http://yuedaguancang.my/api/message?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "下一页 &raquo;",
"active": false
}
],
"next_page_url": null,
"path": "http://yuedaguancang.my/api/message",
"per_page": 15,
"prev_page_url": null,
"to": 1,
"total": 1
}
}</code></pre>
<h2>数据列表 data 中参数说明</h2>
<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;">data.id</td>
<td style="text-align: left;">int</td>
<td>ID</td>
</tr>
<tr>
<td style="text-align: left;">data.sender_id</td>
<td style="text-align: left;">int</td>
<td>发件人ID：0 为系统发送</td>
</tr>
<tr>
<td style="text-align: left;">data.recipient_id</td>
<td style="text-align: left;">int</td>
<td>收件人ID</td>
</tr>
<tr>
<td style="text-align: left;">data.subject</td>
<td style="text-align: left;">string</td>
<td>主题</td>
</tr>
<tr>
<td style="text-align: left;">data.content</td>
<td style="text-align: left;">string</td>
<td>内容</td>
</tr>
<tr>
<td style="text-align: left;">data.view_at</td>
<td style="text-align: left;">datetime</td>
<td>查看时间；时间为空则表示未查看</td>
</tr>
<tr>
<td style="text-align: left;">data.sender</td>
<td style="text-align: left;">object</td>
<td>发件人</td>
</tr>
<tr>
<td style="text-align: left;">data.recipient</td>
<td style="text-align: left;">object</td>
<td>收件人</td>
</tr>
</tbody>
</table>
<h1>备注</h1>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>