API Overview
Global
Method | Endpoint Path | Description |
---|---|---|
GET | /status.json /api/fresns/v1/global/status | Client Status |
GET | /api/fresns/v1/global/configs | Configs |
GET | /api/fresns/v1/global/language-pack | Language Pack |
GET | /api/fresns/v1/global/channels | Extend Channels |
GET | /api/fresns/v1/global/{type} /archives | Extend Archives |
GET | /api/fresns/v1/global/{type} /content-types | Content Types |
GET | /api/fresns/v1/global/roles | User Roles |
GET | /api/fresns/v1/global/stickers | Stickers |
Common
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/common/ip-info | IP Information |
GET | /api/fresns/v1/common/input-tips | Input Tips |
POST | /api/fresns/v1/common/cmd-word | Command Word Request |
POST | /api/fresns/v1/common/file/upload-token | File: Make S3 Upload Token |
POST | /api/fresns/v1/common/file/upload | File: Upload |
PATCH | /api/fresns/v1/common/file/{fid} /info | File: Update Info |
GET | /api/fresns/v1/common/file/{fid} /link | File: Download Link |
GET | /api/fresns/v1/common/file/{fid} /users | File: Download Users |
Account
Method | Endpoint Path | Description |
---|---|---|
POST | /api/fresns/v1/account/auth-token | Create Account Token (Login) |
DELETE | /api/fresns/v1/account/auth-token | Delete Account Token (Logout) |
GET | /api/fresns/v1/account/detail | Account Detail |
GET | /api/fresns/v1/account/wallet-records | Wallet Records |
User
Function
Method | Endpoint Path | Description |
---|---|---|
POST | /api/fresns/v1/user/auth-token | Create User Token (Login) |
GET | /api/fresns/v1/user/overview | Overview |
GET | /api/fresns/v1/user/extcredits-records | Extcredits Records |
PATCH | /api/fresns/v1/user/profile | Update Profile |
PATCH | /api/fresns/v1/user/setting | Update Setting |
POST | /api/fresns/v1/user/mark | Mark |
PATCH | /api/fresns/v1/user/mark-note | Mark Note |
POST | /api/fresns/v1/user/extend-action | Extend Action |
Interactive
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/user/list | User List |
GET | /api/fresns/v1/user/{uidOrUsername} /detail | User Detail |
GET | /api/fresns/v1/user/{uidOrUsername} /followers-you-follow | Followers You Know |
GET | /api/fresns/v1/user/{uidOrUsername} /interaction/{type} | User Interaction Users |
GET | /api/fresns/v1/user/{uidOrUsername} /mark/{markType} /{listType} | User Mark List |
Message
Notification
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/notification/list | List |
PATCH | /api/fresns/v1/notification/read-status | Mark As Read |
DELETE | /api/fresns/v1/notification/messages | Delete Messages |
Conversation
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/conversation/list | List |
GET | /api/fresns/v1/conversation/{uidOrUsername} /detail | Detail |
GET | /api/fresns/v1/conversation/{uidOrUsername} /messages | Messages |
PATCH | /api/fresns/v1/conversation/{uidOrUsername} /pin | Pin Conversation |
PATCH | /api/fresns/v1/conversation/{uidOrUsername} /read-status | Mark As Read |
DELETE | /api/fresns/v1/conversation/{uidOrUsername} | Delete Conversation or Messages |
POST | /api/fresns/v1/conversation/message | Send Message |
Group
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/group/tree | Group Tree List |
GET | /api/fresns/v1/group/list | Group List |
GET | /api/fresns/v1/group/{gid} /detail | Group Detail |
GET | /api/fresns/v1/group/{gid} /creator | Group Creator |
GET | /api/fresns/v1/group/{gid} /admins | Group Admins |
GET | /api/fresns/v1/group/{gid} /interaction/{type} | Group Interaction Users |
Hashtag
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/hashtag/list | Hashtag List |
GET | /api/fresns/v1/hashtag/{htid} /detail | Hashtag Detail |
GET | /api/fresns/v1/hashtag/{htid} /interaction/{type} | Hashtag Interaction Users |
Geotag
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/geotag/list | Geotag List |
GET | /api/fresns/v1/geotag/{gtid} /detail | Geotag Detail |
GET | /api/fresns/v1/geotag/{gtid} /interaction/{type} | Geotag Interaction Users |
Post
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/post/list | Post List |
GET | /api/fresns/v1/post/timelines | Post List by Timelines |
GET | /api/fresns/v1/post/nearby | Post List by Nearby |
GET | /api/fresns/v1/post/{pid} /detail | Post Detail |
GET | /api/fresns/v1/post/{pid} /interaction/{type} | Post Interaction Users |
GET | /api/fresns/v1/post/{pid} /users | Post Associated Users |
GET | /api/fresns/v1/post/{pid} /quotes | Post Quote It List |
GET | /api/fresns/v1/post/{pid} /histories | Post Histories |
GET | /api/fresns/v1/post/history/{hpid} /detail | Post History Detail |
DELETE | /api/fresns/v1/post/{pid} | Delete |
Comment
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/comment/list | Comment List |
GET | /api/fresns/v1/comment/timelines | Comment List by Timelines |
GET | /api/fresns/v1/comment/nearby | Comment List by Nearby |
GET | /api/fresns/v1/comment/{cid} /detail | Comment Detail |
GET | /api/fresns/v1/comment/{cid} /interaction/{type} | Comment Interaction Users |
GET | /api/fresns/v1/comment/{cid} /histories | Comment Histories |
GET | /api/fresns/v1/comment/history/{hcid} /detail | Comment History Detail |
DELETE | /api/fresns/v1/comment/{cid} | Delete |
Editor
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/editor/{type} /configs | Editor Configs |
POST | /api/fresns/v1/editor/{type} /publish | Quick Publish |
POST | /api/fresns/v1/editor/{type} /edit/{fsid} | Edit Post or Comment |
POST | /api/fresns/v1/editor/{type} /draft | Draft: Create |
GET | /api/fresns/v1/editor/{type} /drafts | Draft: List |
GET | /api/fresns/v1/editor/{type} /draft/{did} | Draft: Detail |
PATCH | /api/fresns/v1/editor/{type} /draft/{did} | Draft: Update |
POST | /api/fresns/v1/editor/{type} /draft/{did} | Draft: Publish |
PUT | /api/fresns/v1/editor/{type} /draft/{did} | Draft: Recall (Draft under review) |
DELETE | /api/fresns/v1/editor/{type} /draft/{did} | Draft: Delete |
Search
Method | Endpoint Path | Description |
---|---|---|
GET | /api/fresns/v1/search/users | Search Users |
GET | /api/fresns/v1/search/groups | Search Groups |
GET | /api/fresns/v1/search/hashtags | Search Hashtags |
GET | /api/fresns/v1/search/geotags | Search Geotags |
GET | /api/fresns/v1/search/posts | Search Posts |
GET | /api/fresns/v1/search/comments | Search Comments |