Skip to content
On this page

API Overview

Global

MethodEndpoint PathDescription
GET/api/v2/global/configsGlobal Configs
GET/api/v2/global/code-messagesCode Messages
GET/api/v2/global/{type}/archivesExtend Archives
GET/api/v2/global/upload-tokenGet Upload Token
GET/api/v2/global/rolesUser Roles
GET/api/v2/global/mapsMap Services
GET/api/v2/global/{type}/content-typesContent Types
GET/api/v2/global/stickersStickers
GET/api/v2/global/block-wordsBlock Words

Common

MethodEndpoint PathDescription
GET/api/v2/common/input-tipsInput Tips
GET/api/v2/common/callbackPlugin Callback
POST/api/v2/common/send-verify-codeSend Verify Code
POST/api/v2/common/upload-logUpload Log
POST/api/v2/common/upload-fileUpload File
GET/api/v2/common/file/{fid}/linkFile Download Link
GET/api/v2/common/file/{fid}/usersFile Download Users

Account

MethodEndpoint PathDescription
POST/api/v2/account/registerRegister
POST/api/v2/account/loginLogin
PUT/api/v2/account/reset-passwordReset Password
GET/api/v2/account/detailAccount Detail
GET/api/v2/account/wallet-logsWallet Logs
POST/api/v2/account/verify-identityVerify Identity
PUT/api/v2/account/editEdit
DELETE/api/v2/account/logoutLogout
POST/api/v2/account/apply-deleteApply Delete
POST/api/v2/account/recall-deleteRecall Delete

User

MethodEndpoint PathDescription
GET/api/v2/user/listUser List
GET/api/v2/user/{uidOrUsername}/detailUser Detail
GET/api/v2/user/{uidOrUsername}/followers-you-followFollowers You Know
GET/api/v2/user/{uidOrUsername}/interaction/{type}User Interaction Users
GET/api/v2/user/{uidOrUsername}/mark/{markType}/{listType}User Mark List
POST/api/v2/user/authAuth
GET/api/v2/user/panelPanel
PUT/api/v2/user/editEdit
POST/api/v2/user/markMark
PUT/api/v2/user/mark-noteMark Note

Message

MethodEndpoint PathDescription
GET/api/v2/notification/list[Notification] List
PUT/api/v2/notification/mark-as-read[Notification] Mark As Read
DELETE/api/v2/notification/delete[Notification] Delete
GET/api/v2/conversation/list[Conversation] List
GET/api/v2/conversation/{conversationId}/detail[Conversation] Detail
GET/api/v2/conversation/{conversationId}/messages[Conversation] Messages
PUT/api/v2/conversation/pin[Conversation] Pin Conversation
PUT/api/v2/conversation/mark-as-read[Conversation] Mark As Read
POST/api/v2/conversation/send-message[Conversation] Send Message
DELETE/api/v2/conversation/delete[Conversation] Delete Conversation or Messages

Group

MethodEndpoint PathDescription
GET/api/v2/group/treeGroup Tree List
GET/api/v2/group/categoriesGroup Categories
GET/api/v2/group/listGroup List
GET/api/v2/group/{gid}/detailGroup Detail
GET/api/v2/group/{gid}/interaction/{type}Group Interaction Users

Hashtag

MethodEndpoint PathDescription
GET/api/v2/hashtag/listHashtag List
GET/api/v2/hashtag/{hid}/detailHashtag Detail
GET/api/v2/hashtag/{hid}/interaction/{type}Hashtag Interaction Users

Post

MethodEndpoint PathDescription
GET/api/v2/post/listPost List
GET/api/v2/post/follow/{type}Post List by Follow
GET/api/v2/post/nearbyPost List by Nearby
GET/api/v2/post/{pid}/detailPost Detail
GET/api/v2/post/{pid}/interaction/{type}Post Interaction Users
GET/api/v2/post/{pid}/user-listPost Affiliate User List
GET/api/v2/post/{pid}/logsPost Logs
GET/api/v2/post/{pid}/log/{logId}Post Log Detail
DELETE/api/v2/post/{pid}Delete

Comment

MethodEndpoint PathDescription
GET/api/v2/comment/listComment List
GET/api/v2/comment/follow/{type}Comment List by Follow
GET/api/v2/comment/nearbyComment List by Nearby
GET/api/v2/comment/{cid}/detailComment Detail
GET/api/v2/comment/{cid}/interaction/{type}Comment Interaction Users
GET/api/v2/comment/{cid}/logsComment Logs
GET/api/v2/comment/{cid}/log/{logId}Comment Log Detail
DELETE/api/v2/comment/{pid}Delete

Editor

MethodEndpoint PathDescription
POST/api/v2/editor/{type}/quick-publishQuick Publish
GET/api/v2/editor/{type}/configEditor Config
GET/api/v2/editor/{type}/draftsDraft List
POST/api/v2/editor/{type}/createCreate Draft
POST/api/v2/editor/{type}/generate/{fsid}Generate Draft
GET/api/v2/editor/{type}/{draftId}Draft Detail
PUT/api/v2/editor/{type}/{draftId}Update Draft
POST/api/v2/editor/{type}/{draftId}Publish
PATCH/api/v2/editor/{type}/{draftId}Recall
DELETE/api/v2/editor/{type}/{draftId}Delete
MethodEndpoint PathDescription
GET/api/v2/search/usersSearch Users
GET/api/v2/search/groupsSearch Groups
GET/api/v2/search/hashtagsSearch Hashtags
GET/api/v2/search/postsSearch Posts
GET/api/v2/search/commentsSearch Comments

Released under the Apache-2.0 License