Skip to content

Block Words

  • Endpoint Path: /api/v2/global/block-words
  • Method: GET
  • Request: Query

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Query Params

Parameter NameTypeRequiredDescription
typeStringoptionalChoose one from content,user,conversation
leave empty to output all
pageSizeNumberoptionalNumber of items per page (default 50 items)
pageNumberoptionalPage number (default 1)

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / How much data in total",
            "pageSize": "Number / How much data on each page",
            "currentPage": "Number / Current page number",
            "lastPage": "Number / Last page number"
        },
        "list": [
            {
                "word": "String / Processed Word",
                "contentMode": "Number / Content Processing Mode (posts and comments)",
                "userMode": "Number / User Processing Mode (nickname and bio)",
                "conversationMode": "Number / Message Processing Mode (conversation messages)",
                "replaceWord": "String / Replacement Word"
            }
        ]
    }
}

Released under the Apache-2.0 License