Reddit-APP-API

检查版块是否静音/Check if Subreddit is Muted

Changed on

[中文]

用途:

  • 检查指定Reddit版块是否被当前用户静音

参数:

  • subreddit_id: 版块ID,格式为"t5_"开头,可从fetch_subreddit_info接口获取

返回:

  • 静音状态JSON数据,包含:
    • isMuted: 是否静音的布尔值
    • subredditId: 版块ID

注意:

  • APP接口的ID格式与Web接口不同,需要添加类型前缀
  • 版块ID前缀: t5_ (例如: t5_2qh0u)

[English]

Purpose:

  • Check if a specified Reddit subreddit is muted by the current user

Parameters:

  • subreddit_id: Subreddit ID starting with "t5_", can be obtained from fetch_subreddit_info endpoint

Returns:

  • JSON data of mute status containing:
    • isMuted: Boolean value indicating if muted
    • subredditId: Subreddit ID

Note:

  • APP API ID format differs from Web API, requires type prefix
  • Subreddit ID prefix: t5_ (e.g., t5_2qh0u)

[示例/Example]

subreddit_id="t5_2qh0u" need_format=false

get/api/v1/reddit/app/check_subreddit_muted

Request

  • Base URL
    https://api.tikhub.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

languagestring

返回内容使用的语言,采用 IETF 语言标签;默认 en-US / Preferred response language as an IETF language tag; default: en-US

subreddit_idstring required

版块ID/Subreddit ID

need_formatboolean

是否需要清洗数据/Whether to clean and format the data

Response

Successful Response

codeinteger

HTTP status code | HTTP状态码

request_idstring nullable

Unique request identifier | 唯一请求标识符

messagestring

Response message (EN-US) | 响应消息 (English)

message_zhstring

Response message (ZH-CN) | 响应消息 (中文)

supportstring

Support message | 支持消息

timestring

The time the response was generated | 生成响应的时间

time_stampinteger

The timestamp the response was generated | 生成响应的时间戳

time_zonestring

The timezone of the response time | 响应时间的时区

docsstring nullable

Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接

cache_messagestring nullable

Cache message (EN-US) | 缓存消息 (English)

cache_message_zhstring nullable

Cache message (ZH-CN) | 缓存消息 (中文)

cache_urlstring nullable

The URL to access the cached result | 访问缓存结果的 URL

routerstring

The endpoint that generated this response | 生成此响应的端点

paramsunknown
dataunknown

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • breaking

      for the query request parameter subreddit_id, the minLength was increased from 0 to 4

    • breaking

      added the pattern ^t5_[a-z0-9]{1,17}$ to the query request parameter subreddit_id

    • warning

      for the query request parameter subreddit_id, the maxLength was set to 20

    • info

      added the new optional query request parameter language