查看“BBS数据接口”的源代码

== 登录 ==
[[BBS OAuth]]

== 版面 ==

=== 列出版面 ===
: '''GET''' /board/list
{| class="wikitable"
|-
! Parameter !! Type !! Description !! Optional
|-
| session || string || Session Token || No
|-
| start || int || ID of the first post to list || Yes 
|-
| end || int || ID of the last post to list || Yes 
|-
| count || int || Number of posts to list || Yes 
|}
* Return value
** Success: [{"name": <string: Board name>, "read": <Boolean: Board read?>, "BM": <string: BMs>, "id": <int: Board id>, "total": <int: Total post count>, "currentusers": <int: Current users count>},{...}...]

=== 获取帖子列表 ===
: '''GET''' /board/post_list
{| class="wikitable"
|-
! Parameter !! Type !! Description !! Optional !! Choices
|-
| session || string || Session Token || No
|- 
| name || string || Name of the board to list || No
|-
| mode || string || Mode of this board to list || Yes || '''normal'''/digest/mark/deleted/junk
|-
| start || int || ID of the first post to list || Yes 
|-
| end || int || ID of the last post to list || Yes 
|-
| count || int || Number of posts to list || Yes 
|}
* Return value
** Success: [{"posttime": <time: post time>, "attachflag": <int: unknown>, "read": <Boolean: Post read>, "title": <string: Post title>, "attachment": <int: Attachment count>, "owner": <string: Poster userid>, "id": <int: Post id>},
{...}...]

== 帖子 ==

=== 获取帖子 ===
: '''GET''' /post/view
{| class="wikitable"
|-
! Parameter !! Type !! Description !! Optional
|-
| session || string || Session Token || No
|-
| id || int || ID of the post in this board || No
|- 
| board || string || Name of the board this post belongs to || No
|}
* Return value
** Success: {"picattach": [{"name": <string: Attachment filename>, "offset:": <int: Attachment offset in post>}, {...}...], "title": <string: Post title>, "content": <string: Post content>, "otherattach": [{...}...], "owner": <string: Poster>, "id": <int: Post ID>, "xid": <int: unique post ID>}

=== 获取附件 ===
: '''GET''' /post/get_attach
{| class="wikitable"
|-
! Parameter !! Type !! Description !! Optional !! Choices
|-
| session || string || Session Token || No
|-
| id || int || ID of the post in this board || No
|- 
| board || string || Name of the board this post belongs to || No
|-
| mode || string || Mode of the board this ID corresponds to || Yes || '''normal'''/digest/mark/deleted/junk
|-
| offset || int || Offset of the attachment in the post, returned in "view" || No
|}
* Result value
** {"content": <string: Post content encoded in Base64>, "name": <string: Attachment name>}

=== 引用帖子 ===
: '''GET''' /post/quote
{| class="wikitable"
|-
! Parameter !! Type !! Description !! Optional !! Choices
|-
| session || string || Session Token || No
|-
| board || string || Name of the board this post belongs to || No
|-
| id || int || ID of the post to quote || No
|- 
| xid || int || unique ID of the post to quote || No
|-
| mode || string || quote mode || Yes || '''S'''/R/N/A
|-
| index_mode || string || mode of the post list where ID belongs to || Yes || '''normal'''/digest/mark/deleted/junk
|}
* Result
** {"title": <string: Quoted title>, "content": <string: Quoted content>}

=== 发帖/回帖 ===
: '''POST''' /post/new
{| class="wikitable"
|-
! Parameter !! Type !! Description !! Optional !! Choices
|-
| session || string || Session Token || No ||
|-
| board || string || Name of the board this post belongs to || No ||
|-
| re_id || int || ID of the post to reply || Yes ||
|- 
| re_xid || int || unique ID of the post to reply || Yes ||
|-
| re_mode || string || mode of the post list where re_id belongs to || Yes || '''normal'''/digest/mark/deleted/junk
|-
| title || string || title of the post || No ||
|-
| content || string || content of the post || No ||
|-
| signature_id || int || No. of qmd to use || Yes || <0(random)/'''0'''(none)/>0(qmd #)
|-
| anonymous || boolean || create anonymous post || Yes || '''0'''(no)/1(yes)
|-
| mailback || boolean || require replies to be mailed back || Yes || '''0'''(no)/1(yes)
|}

发帖的话，id和xid可以忽略。回帖的话，需要提供id和xid。

== 收藏夹 ==

=== 列出收藏夹 ===

: '''GET''' /favboard/list
{| class="wikitable"
|-
! Parameter !! Type !! Description !! Optional 
|-
| session || string || Session Token || No
|- 
| father || int || Parent directory of boards to list || Yes
|-
| start || int || ID of the first post to list || Yes 
|-
| end || int || ID of the last post to list || Yes 
|-
| count || int || Number of posts to list || Yes 
|}
* Return value
** Success: [{"index": <int: Index in favboard>, "binfo": <BoardInfo: board info>, "father": <int: Parent index in favboard>, "type": <string: Type of this entry>}, {...}...]

== 会话 ==

=== 验证会话 ===
: '''GET''' /session/verify

{| class="wikitable"
|-
! Parameter !! Type !! Description !! Optional 
|-
| session || string || Session Token || No
|}