FastComments JavaScript/TypeScript 软件开发工具包

这是 FastComments 的官方 JavaScript/TypeScript SDK。

从 Node.js 或浏览器管理评论、用户、单点登录 (SSO) 和审核。

仓库

安装

npm install fastcomments-sdk

API 文档

完整的 API 参考： docs/api/README.md

浏览器与服务器兼容性

此 SDK 使用 双入口点 以确保最佳兼容性并防止运行时错误：

fastcomments-sdk/browser - 浏览器安全版本，使用原生 fetch
fastcomments-sdk/server - 完整的 Node.js 版本，支持 SSO
fastcomments-sdk (默认) - 仅类型，可在任何地方安全导入

使用

该 SDK 为浏览器和服务器环境提供了不同的入口点，以确保最佳的兼容性和安全性：

浏览器使用（客户端）

对于浏览器/前端应用，请使用不包含 Node.js 依赖项的浏览器安全导出：

// 浏览器安全导入（不包含 Node.js 依赖）
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// 创建浏览器 SDK 实例
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // 可选，默认为 https://fastcomments.com
});

// 使用公共 API（无需 API 密钥 — 对浏览器安全）
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

服务器使用（Node.js）

对于服务器/后端应用，请使用包含 SSO 和身份验证功能的完整 SDK：

// 服务器端导入（包含 SSO，设计为与 NodeJS 一起使用）
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// 创建服务器 SDK 实例
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // 在服务器上保密！
  basePath: 'https://fastcomments.com' // 可选，默认为 https://fastcomments.com
});

// 使用带 API 密钥的安全 API
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

仅类型导入

如果您只需要 TypeScript 类型（无运行时代码），请使用默认导入：

// 仅类型（无运行时依赖 —— 在任何环境均安全）
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

使用单个 API 类

浏览器环境

import { PublicApi, Configuration } from 'fastcomments-sdk/browser';

const config = new Configuration({
  basePath: 'https://fastcomments.com'
});

const publicApi = new PublicApi(config);

服务器环境

import { DefaultApi, PublicApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key',
  basePath: 'https://fastcomments.com'
});

const defaultApi = new DefaultApi(config);
const publicApi = new PublicApi(config);

公共与受保护的 API

The SDK provides three main API classes:

DefaultApi - 受保护的端点，要求使用 API 密钥进行身份验证。用于服务器端操作。
PublicApi - 公共端点，可在无需 API 密钥的情况下访问。可以直接从浏览器/移动设备等调用。
HiddenApi - 用于高级用例的内部/管理端点。

Example: Using Public API (browser-safe)

import { PublicApi } from 'fastcomments-sdk/browser';

const publicApi = new PublicApi();

// 获取页面的评论（不需要 API 密钥）
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Example: Using Default API (server-side only)

import { DefaultApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key' // 请保密！
});
const defaultApi = new DefaultApi(config);

// 使用完整的管理员访问权限获取评论
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO（单点登录）集成

FastComments 支持 SSO，以与您现有的用户认证系统集成。 SSO 功能仅在服务器导出中可用，因为它需要 Node.js crypto 功能。

简单 SSO（仅服务器端）

简单 SSO 应在服务器端生成并发送到客户端：

// 服务器端代码（Node.js/后端）
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// 使用内置辅助创建简单 SSO  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

// 将 ssoToken 发送到您的客户端代码
// 客户端代码然后可以使用该令牌与浏览器 SDK 一起使用

安全 SSO（服务器端，推荐）

安全 SSO 应在服务器端实现，并提供更好的安全性：

// 服务器端代码（Node.js/后端）
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// 使用内置辅助创建安全 SSO
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

// 在服务器上与 API 调用一起使用
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// 或将 ssoConfig 发送到客户端以供浏览器使用

在浏览器中使用 SSO（使用服务器生成的令牌）

// 客户端代码（浏览器）
import { PublicApi } from 'fastcomments-sdk/browser';

// 从您的服务器端点获取 SSO 令牌
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Use the server-generated SSO token
});

带评论创建的 SSO

// 服务器端：创建 SSO 和评论
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();

const response = await publicApi.createCommentPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  broadcastId: 'unique-broadcast-id',
  commentData: {
    comment: 'This is my comment',
    date: Date.now(),
    commenterName: 'John Doe',
    url: 'https://example.com/page',
    urlId: 'page-url-id'
  },
  sso: JSON.stringify(ssoConfig)
});

常见用例

获取页面的评论

const comments = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'article-123'
});

创建评论

const newComment = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'article-123',
    comment: 'Great article!',
    commenterName: 'John Doe',
    commenterEmail: 'john@example.com'
  }
});

对评论投票

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 表示赞成，-1 表示反对
  }
});

用户管理（需要 API 密钥）

// 搜索用户（需要 DefaultApi）
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

实时事件（实时更新）

订阅实时事件以获取有关评论、投票和其他活动的实时更新。

页面级事件

监听特定页面的实时事件（评论、投票等）：

import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const config = {
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
};

// Subscribe to live events for a page
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (get this from getComments response)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Update your UI with the new comment
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Update vote counts in your UI
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Return true if event was handled
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close the subscription when done
subscription.close();

订阅用户事件

监听特定于用户的事件（通知、提及等）：

import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const userConfig = {
  userIdWS: 'user-session-id', // Get this from getComments response
};

// Subscribe to user's personal feed
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Show notification in your UI
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }
    
    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Close when done
userSubscription.close();

获取 userIdWS

The userIdWS parameter is required for live events and can be obtained from API responses:

const response = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-id'
});

// Extract userIdWS from the response
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Now you can subscribe to live events
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

广播 ID

您会看到在某些 API 调用中需要传递 broadcastId。当您接收事件时，会拿回这个 ID，这样如果您计划在客户端乐观地应用更改（您可能会想这样做，因为它提供了最佳体验），就可以知道是否忽略该事件。在这里传入一个 UUID。该 ID 应足够唯一，以避免在同一浏览器会话中出现两次。

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // 此操作的唯一 ID
  }
});

错误处理

try {
  const comments = await sdk.publicApi.getCommentsPublic({
    tenantId: 'your-tenant-id',
    urlId: 'page-id'
  });
} catch (error) {
  if (error.response?.status === 404) {
    console.log('Page not found');
  } else {
    console.error('API Error:', error.message);
  }
}

聚合

通过对文档进行分组（如果提供了 groupBy）并应用多个操作来聚合文档。支持不同的操作（例如 sum、countDistinct、avg 等）。

参数

名称	类型	必需
tenantId	string	是
aggregationRequest	AggregationRequest	是
parentTenantId	string	否
includeStats	boolean	否

响应

返回: Aggregate200Response

示例

aggregate 示例

Copy

const tenantId: string = 'tenant_78a9';
const parentTenantId: string = 'parent_tenant_01';
const includeStats: boolean = true;
const aggregationRequest: AggregationRequest = {
  operation: { type: 'COUNT' },
  groupBy: ['pageUrl'],
  predicate: { field: 'status', operator: 'EQUALS', value: 'approved' },
  sort: [{ field: 'count', direction: 'DESC' }],
  limit: 25
};
const result: Aggregate200Response = await aggregate(tenantId, aggregationRequest, parentTenantId, includeStats);

获取审计日志

参数

Name	Type	Required
tenantId	string	是
limit	number	否
skip	number	否
order	SORTDIR	否
after	number	否
before	number	否

响应

返回: GetAuditLogs200Response

示例

getAuditLogs 示例

Copy

const tenantId: string = 'tenant_5f8d7c3a';
const limit: number = 100;
const skip: number = 0;
const order: SORTDIR = 'DESC' as SORTDIR;
const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 一周前
const before: number = Date.now();
const result: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after, before);

从评论中封锁（公共）

参数

Name	Type	Required
tenantId	string	是
commentId	string	是
publicBlockFromCommentParams	PublicBlockFromCommentParams	是
sso	string	否

响应

返回：BlockFromCommentPublic200Response

示例

blockFromCommentPublic 示例

Copy

const tenantId: string = 'tenant_6b3f9a2d';
const commentId: string = 'cmt_8f4b12a9';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'Repeated promotional links',
  durationMinutes: 60 * 24 * 30, // 30 天
  escalateToModeration: true
};
const sso: string = 'sso_token_3fH7kLw';
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

解除对评论的封禁（公共）

参数

名称	类型	是否必需
tenantId	string	是
commentId	string	是
publicBlockFromCommentParams	PublicBlockFromCommentParams	是
sso	string	否

响应

返回: UnBlockCommentPublic200Response

示例

unBlockCommentPublic 示例

Copy

const tenantId: string = "tenant-42-production";
const commentId: string = "comment_7f3b2a9d";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "flag reviewed and determined not to violate policy",
  restoredBy: "moderator_jane",
  restoredAt: new Date().toISOString()
};
const sso: string = "sso_token_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

检查被封禁的评论

参数

名称	类型	必需
tenantId	string	是
commentIds	string	是
sso	string	否

响应

返回：CheckedCommentsForBlocked200Response

示例

checkedCommentsForBlocked 示例

Copy

(async () => {
  const tenantId: string = 'tenant_fa3b2c9e';
  const commentIds: string = 'cmt_112233,cmt_445566';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0Njc4IiwidGVuYW50IjoidGVuYW50X2ZhM2IifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, sso);
  const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
  console.log(resultWithSSO, resultWithoutSSO);
})();

从评论封禁用户

参数

名称	类型	必填
tenantId	string	Yes
id	string	Yes
blockFromCommentParams	BlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

响应

返回： BlockFromCommentPublic200Response

示例

blockUserFromComment 示例

Copy

const tenantId: string = "tenant_7f3b4c";
const id: string = "comment_9a8b7c6d";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated spam links",
  durationHours: 168,
  notifyModerators: true
};
const userId: string | undefined = "user_42";
const anonUserId: string | undefined = undefined;
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

创建评论（公共）

参数

Name	Type	Required
tenantId	string	是
urlId	string	是
broadcastId	string	是
commentData	CommentData	是
sessionId	string	否
sso	string	否

响应

返回: CreateCommentPublic200Response

示例

createCommentPublic 示例

Copy

const tenantId: string = 'tenant_9a1b2c';
const urlId: string = 'https://www.news-site.com/article/67890';
const broadcastId: string = 'broadcast_2026-06-15-01';
const sessionId: string | undefined = 'sess_abc123xyz';
const sso: string | undefined = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiam9yZGFuIiwiaWF0IjoxNjI0MDAwMDB9.signature';
const commentData: CommentData = {
  content: 'Insightful piece — I appreciated the data-backed points and sources cited.',
  authorDisplayName: 'Jordan Miles'
} as CommentData;
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

删除评论

参数

Name	Type	Required
tenantId	string	是
id	string	是
contextUserId	string	否
isLive	boolean	否

响应

返回: DeleteComment200Response

示例

deleteComment 示例

Copy

const tenantId: string = 'tenant_84a9f2';
const id: string = 'comment_5f3b21';
const contextUserId: string | undefined = 'user_1122';
const isLive: boolean | undefined = true;
async function run(): Promise<void> {
  const result: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);
  console.log(result);
}
run();

删除评论（公共）

参数

Name	类型	必需
tenantId	string	是
commentId	string	是
broadcastId	string	是
editKey	string	否
sso	string	否

响应

返回: DeleteCommentPublic200Response

示例

deleteCommentPublic 示例

Copy

const tenantId: string = 'tenant_acme_42';
const commentId: string = 'c0mment-9f8b7a6';
const broadcastId: string = 'site_homepage_2026-06-15';
const editKey: string = 'ek_3b7a1f59-4d2c-11eb-8dcd-0242ac130003';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);

删除评论投票

参数

名称	类型	必需
tenantId	string	是
commentId	string	是
voteId	string	是
urlId	string	是
broadcastId	string	是
editKey	string	否
sso	string	否

响应

返回: DeleteCommentVote200Response

示例

deleteCommentVote 示例

Copy

const tenantId: string = 'tenant_8f3a2b7c';
const commentId: string = 'cmt-5a1f3d92';
const voteId: string = 'vote-3b9c7e1a';
const urlId: string = 'articles/2026/06/typescript-best-practices';
const broadcastId: string = 'broadcast-77f4d2';
const editKey: string = 'edk-9b2f4c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const result: DeleteCommentVote200Response = await deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, editKey, sso);

举报评论

参数

名称	类型	必填
tenantId	string	是
id	string	是
userId	string	否
anonUserId	string	否

响应

返回：FlagComment200Response

示例

flagComment 示例

Copy

const tenantId: string = "tenant_4f21c9a";
const commentId: string = "cmt_7a12b3e9";
const userId: string = "user_82bd123";
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

获取评论

参数

名称	类型	必需	描述
tenantId	string	是
id	string	是

响应

返回: GetComment200Response

示例

getComment 示例

Copy

const tenantId: string = 'tenant_6f1a2b';
const commentId: string = 'cmt_4d9e8f';
const includeReplies: boolean | undefined = true; // 可选参数示例（未传递给 getComment）
const result: GetComment200Response = await getComment(tenantId, commentId);
console.log('Fetched comment for tenant:', tenantId, 'comment id:', commentId);
console.log('API response received:', result);

获取评论列表

参数

Name	Type	必需
tenantId	string	是
page	number	否
limit	number	否
skip	number	否
asTree	boolean	否
skipChildren	number	否
limitChildren	number	否
maxTreeDepth	number	否
urlId	string	否
userId	string	否
anonUserId	string	否
contextUserId	string	否
hashTag	string	否
parentId	string	否
direction	SortDirections	否
fromDate	number	否
toDate	number	否

响应

返回: GetComments200Response

示例

getComments 示例

Copy

const tenantId: string = "tenant_9a12b3";
const response: GetComments200Response = await getComments(tenantId, 1, 20, 0, true, 0, 3, 2, "https://mysite.com/posts/678", undefined, undefined, undefined, undefined, "parent_987", undefined, 1716873600000, 1719552000000);

获取评论（公共）

req tenantId urlId

参数

名称	类型	必需
tenantId	string	Yes
urlId	string	Yes
page	number	No
direction	SortDirections	No
sso	string	No
skip	number	No
skipChildren	number	No
limit	number	No
limitChildren	number	No
countChildren	boolean	No
fetchPageForCommentId	string	No
includeConfig	boolean	No
countAll	boolean	No
includei10n	boolean	No
locale	string	No
modules	string	No
isCrawler	boolean	No
includeNotificationCount	boolean	No
asTree	boolean	No
maxTreeDepth	number	No
useFullTranslationIds	boolean	No
parentId	string	No
searchText	string	No
hashTags	Array	No
userId	string	No
customConfigStr	string	No
afterCommentId	string	No
beforeCommentId	string	No

响应

返回: GetCommentsPublic200Response

示例

getCommentsPublic 示例

Copy

const tenantId: string = 'acme-news';
const urlId: string = '/articles/2026/fastcomments-update';
const page: number = 1;
const skip: number = 0;
const limit: number = 25;
const countChildren: boolean = true;
const includeConfig: boolean = true;
const result: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  page,
  undefined,
  undefined,
  skip,
  undefined,
  limit,
  undefined,
  countChildren,
  undefined,
  includeConfig
);

获取评论文本

参数

名称	类型	必需
tenantId	string	是
commentId	string	是
editKey	string	否
sso	string	否

响应

返回：GetCommentText200Response

示例

getCommentText 示例

Copy

const tenantId: string = 'tenant_42b7e9';
const commentId: string = 'cmt_9f3a2b';
const editKey: string = 'edk_3f1b7c9d';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

获取评论投票用户名

参数

名称	类型	必需
tenantId	string	是
commentId	string	是
dir	number	是
sso	string	否

响应

返回: GetCommentVoteUserNames200Response

示例

getCommentVoteUserNames 示例

Copy

const tenantId: string = "tenant_67890";
const commentId: string = "comment_abc123";
const dir: number = 1;
const ssoToken: string = "sso-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const responseWithoutSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
const responseWithSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);

锁定评论

参数

名称	类型	必需
tenantId	string	是
commentId	string	是
broadcastId	string	是
sso	string	否

响应

返回：LockComment200Response

示例

lockComment 示例

Copy

const tenantId: string = 'tenant_42f6c1';
const commentId: string = 'cmt-9a8b7c';
const broadcastId: string = 'brd_2026_06_15';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTY1MDAwMDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const lockedWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const lockedWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

置顶评论

参数

名称	类型	必需
tenantId	string	是
commentId	string	是
broadcastId	string	是
sso	string	否

响应

返回: PinComment200Response

示例

pinComment 示例

Copy

const tenantId: string = "acme-corp-tenant-72";
const commentId: string = "cmt_8f3a2b4c9d";
const broadcastId: string = "live_2026-06-15_21z";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload.signature";
const responseNoSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId);
const responseWithSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, ssoToken);

保存评论

Parameters

Name	Type	Required
tenantId	string	是
createCommentParams	CreateCommentParams	是
isLive	boolean	否
doSpamCheck	boolean	否
sendEmails	boolean	否
populateNotifications	boolean	否

响应

返回: SaveComment200Response

示例

saveComment 示例

Copy

const tenantId: string = "fastcomments-tenant-42";
const createCommentParams: CreateCommentParams = {
  threadId: "article-2026-06-0142",
  content: "Great write-up — I followed the migration steps and everything worked as described.",
  userId: "u_9c72b",
  userName: "Ava R.",
  userAvatarUrl: "https://cdn.example.com/avatars/u_9c72b.png",
  metadata: { platform: "web", locale: "en-US" }
};
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const sendEmails: boolean = false;
const populateNotifications: boolean = true;
const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

批量保存评论

参数

名称	类型	必需
tenantId	string	是
createCommentParams	Array	是
isLive	boolean	否
doSpamCheck	boolean	否
sendEmails	boolean	否
populateNotifications	boolean	否

响应

返回: Array<SaveComment200Response

示例

saveCommentsBulk 示例

Copy

const tenantId: string = "tenant_42a1b7";
const mentions: CommentUserMentionInfo[] = [{ userId: "user_2b9", displayName: "Alex Chen" }];
const hashtags: CommentUserHashTagInfo[] = [{ tag: "performance" }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: "Thanks for the detailed article — the alternative approach worked for me.",
    authorId: "user_8f3c2",
    authorName: "Maya Patel",
    authorEmail: "maya.patel@example.com",
    url: "/articles/optimizing-ts-performance",
    createdAt: new Date().toISOString(),
    mentions,
    hashtags
  }
];
const isLive: boolean = true;
const doSpamCheck: boolean = false;
const sendEmails: boolean = true;
const populateNotifications: boolean = true;
const result: Array<SaveComment200Response> = await saveCommentsBulk(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

设置评论文本

参数

名称	类型	必填
tenantId	string	是
commentId	string	是
broadcastId	string	是
commentTextUpdateRequest	CommentTextUpdateRequest	是
editKey	string	否
sso	string	否

响应

返回: SetCommentText200Response

示例

setCommentText 示例

Copy

const tenantId: string = 'tenant_4f9a2b'
const commentId: string = 'cmt-8421'
const broadcastId: string = 'brd-2026-06-15'
const commentTextUpdateRequest: CommentTextUpdateRequest = { text: 'Updated comment text to clarify the schedule.', mentions: [], hashtags: [] }
const editKey: string = 'editkey_9b12'
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso.signature'
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso)

解除对用户的评论封禁

参数

名称	类型	必需
tenantId	string	是
id	string	是
unBlockFromCommentParams	UnBlockFromCommentParams	是
userId	string	否
anonUserId	string	否

响应

返回： UnBlockCommentPublic200Response

示例

unBlockUserFromComment 示例

Copy

const tenantId: string = 'tenant_7b9c2a';
const id: string = 'comment_4f8e1d';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'User submitted appeal and provided additional context',
  effectiveAt: new Date().toISOString()
};
const userId: string = 'user_92a3f6';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId);

取消举报评论

参数

Name	Type	Required
tenantId	string	是
id	string	是
userId	string	否
anonUserId	string	否

响应

返回: FlagComment200Response

示例

unFlagComment 示例

Copy

const tenantId: string = 'tenant_8f3b2a1f';
const commentId: string = 'cmt_20250614_01';
const userId: string = 'user_47d2b9';
const result: FlagComment200Response = await unFlagComment(tenantId, commentId, userId);

解锁评论

参数

名称	Type	必需
tenantId	string	是
commentId	string	是
broadcastId	string	是
sso	string	否

响应

返回: LockComment200Response

示例

unLockComment 示例

Copy

const tenantId: string = "tenant-8f3b2c4a";
const commentId: string = "cmt_92a7f3e6";
const broadcastId: string = "brd_1b4c9d20";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

取消置顶评论

参数

名称	类型	必填
tenantId	string	是
commentId	string	是
broadcastId	string	是
sso	string	否

响应

返回: PinComment200Response

示例

unPinComment 示例

Copy

const tenantId: string = "tenant_9f3b2c1a";
const commentId: string = "comment_4d2e8a7f";
const broadcastId: string = "broadcast_live_2026_06_15_18";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.invalid-signature";
const response: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);
console.log(response);

更新评论

参数

名称	类型	必需
tenantId	string	是
id	string	是
updatableCommentParams	UpdatableCommentParams	是
contextUserId	string	否
doSpamCheck	boolean	否
isLive	boolean	否

响应

返回：FlagCommentPublic200Response

示例

updateComment 示例

Copy

const tenantId: string = 'tenant_7f3c1b2a';
const commentId: string = 'cmt_8d9f2a4b';
const updatableCommentParams: UpdatableCommentParams = {
  body: 'Updating this comment to clarify the feature behavior and include a timestamp.',
  metadata: { category: 'support', editedReason: 'clarify instructions' },
  visible: true
};
const contextUserId: string = 'user_42';
const doSpamCheck: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, commentId, updatableCommentParams, contextUserId, doSpamCheck);

对评论投票

参数

名称	类型	必填
tenantId	string	是
commentId	string	是
urlId	string	是
broadcastId	string	是
voteBodyParams	VoteBodyParams	是
sessionId	string	否
sso	string	否

响应

返回: VoteComment200Response

示例

voteComment 示例

Copy

const tenantId: string = 'tenant_7f9d2e';
const commentId: string = '5a1d3f9b-2c4e-4a2b-bf7b-1234567890ab';
const urlId: string = 'articles/2026/06/15/typescript-api-patterns';
const broadcastId: string = 'broadcast-20260615-01';
const voteBodyParams: VoteBodyParams = { vote: 'up' };
const sessionId: string = 'sess_9d2f3b45';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY5NzE2MDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const response: VoteComment200Response = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

获取用户的评论

参数

名称	类型	必填
userId	string	否
direction	SortDirections	否
repliesToUserId	string	否
page	number	否
includei10n	boolean	否
locale	string	否
isCrawler	boolean	否

响应

返回：GetCommentsForUser200Response

示例

getCommentsForUser 示例

Copy

const userId: string = "550e8400-e29b-41d4-a716-446655440000";
const page: number = 2;
const includei10n: boolean = true;
const locale: string = "en-US";
const isCrawler: boolean = false;
const comments: GetCommentsForUser200Response = await getCommentsForUser(
  userId,
  undefined, // direction omitted
  undefined, // repliesToUserId omitted
  page,
  includei10n,
  locale,
  isCrawler
);
console.log(comments);

添加域配置

参数

名称	类型	必需	说明
tenantId	string	是
addDomainConfigParams	AddDomainConfigParams	是

响应

返回: AddDomainConfig200Response

删除域配置

参数

名称	类型	必填	描述
tenantId	string	是
domain	string	是

响应

返回: DeleteDomainConfig200Response

获取域配置

参数

名称	类型	必填	描述
tenantId	string	是
domain	string	是

响应

返回: GetDomainConfig200Response

获取域配置列表

参数

名称	类型	必需	描述
tenantId	string	是

响应

返回: GetDomainConfigs200Response

部分更新域配置

参数

名称	类型	必需
tenantId	string	是
domainToUpdate	string	是
patchDomainConfigParams	PatchDomainConfigParams	是

响应

返回: GetDomainConfig200Response

替换域配置

参数

名称	类型	必填
tenantId	string	是
domainToUpdate	string	是
updateDomainConfigParams	UpdateDomainConfigParams	是

响应

返回: GetDomainConfig200Response

创建邮件模板

参数

名称	类型	必需	描述
tenantId	string	是
createEmailTemplateBody	CreateEmailTemplateBody	是

响应

返回: CreateEmailTemplate200Response

示例

createEmailTemplate 示例

Copy

const tenantId: string = "tenant_4f2b1c9e";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "New Comment Notification",
  subject: "Someone replied to your discussion",
  fromName: "Community Team",
  fromAddress: "no-reply@community.example.com",
  htmlBody: "<p>\{{comment.author}} replied: \{{comment.text}}</p>",
  plaintextBody: "\{{comment.author}} replied: \{{comment.text}}",
  previewText: "A new reply on a discussion you follow",
  isDefault: false // 可选标志，演示可选参数的用法
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

删除邮件模板

参数

名称	类型	必填	描述
tenantId	string	是
id	string	是

响应

返回: FlagCommentPublic200Response

示例

deleteEmailTemplate 示例

Copy

const tenantId: string = "tenant_9c4f1b2a";
const id: string = "emailtmpl_4d2b9a5e";
const requestorNote: string | undefined = undefined; // 可选元数据（函数不需要）
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, id);

删除邮件模板渲染错误

参数

名称	类型	必需
tenantId	string	是
id	string	是
errorId	string	是

响应

返回: FlagCommentPublic200Response

示例

deleteEmailTemplateRenderError 示例

Copy

const tenantId: string = 'tenant-72f3b4';
const templateId: string = 'email_template-9c3a1';
let providedErrorId: string | undefined = undefined; // 可选值，可能在其他地方设置
const errorId: string = providedErrorId ?? 'render_err-5d2f7';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, templateId, errorId);

获取邮件模板

参数

名称	类型	必需	描述
tenantId	string	是
id	string	是

响应

返回：GetEmailTemplate200Response

示例

getEmailTemplate 示例

Copy

const tenantId: string = 'tenant_7f3b2c';
const templateId: string = 'welcome-email-2024';
const includeDrafts: boolean | undefined = undefined;
const emailTemplate: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);

获取邮件模板定义

参数

名称	类型	必需	描述
tenantId	string	是

响应

返回: GetEmailTemplateDefinitions200Response

示例

getEmailTemplateDefinitions 示例

Copy

(async () => {
  const tenantId: string = 'tenant_acme_001';
  const options: { includeDrafts?: boolean } = { includeDrafts: true }; // 演示可选参数
  const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId, options);
  console.log(templates);
})();

获取邮件模板渲染错误

参数

名称	类型	必需
tenantId	string	Yes
id	string	Yes
skip	number	No

响应

返回: GetEmailTemplateRenderErrors200Response

示例

getEmailTemplateRenderErrors 示例

Copy

const tenantId: string = 'acme-tenant-01';
const id: string = 'tmpl_7f9a2b4c';
const skip: number = 20;
const errorsWithSkip: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
const errorsFirstPage: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id);

获取邮件模板列表

参数

名称	类型	必填	描述
tenantId	string	是
skip	number	否

响应

返回：GetEmailTemplates200Response

示例

getEmailTemplates 示例

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme-marketing-tenant-001";
  const templatesDefault: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const templatesPaged: GetEmailTemplates200Response = await getEmailTemplates(tenantId, 25);
  console.log(templatesDefault, templatesPaged);
}
run();

渲染邮件模板

参数

名称	类型	必填
tenantId	string	是
renderEmailTemplateBody	RenderEmailTemplateBody	是
locale	string	否

响应

返回: RenderEmailTemplate200Response

示例

renderEmailTemplate 示例

Copy

const tenantId: string = '7f7e2b90-3a2b-4d9b-9df1-5f0b6b2e8a1c';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'welcome_email',
  recipient: { email: 'jordan.smith@acme.co', name: 'Jordan Smith' },
  variables: { siteName: 'Acme Forum', verificationUrl: 'https://acme.forum/verify?code=abc123' }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

更新邮件模板

参数

Name	Type	Required
tenantId	string	是
id	string	是
updateEmailTemplateBody	UpdateEmailTemplateBody	是

响应

返回: FlagCommentPublic200Response

示例

updateEmailTemplate 示例

Copy

const tenantId: string = 'acme-corp-123';
const id: string = 'template-789';
const locale: string | undefined = 'en-US';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  subject: 'Welcome to Acme — Get started',
  bodyHtml: '<p>Hi \{{firstName}}, welcome to Acme. Start by visiting your dashboard.</p>',
  fromName: 'Acme Support',
  fromEmail: 'support@acme.com',
  enabled: true,
  ...(locale ? { locale } : {})
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

获取事件日志

req tenantId urlId userIdWS

参数

Name	Type	Required
tenantId	string	是
urlId	string	是
userIdWS	string	是
startTime	number	是
endTime	number	否

响应

返回: GetEventLog200Response

示例

getEventLog 示例

Copy

const tenantId: string = 'tenant_9f3a2b';
const urlId: string = 'news/2026/06/fastcomments-release';
const userIdWS: string = 'ws_user_48291';
const startTime: number = Date.now() - 86_400_000;
const endTime: number = Date.now();
const result: GetEventLog200Response = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);

获取全局事件日志

req tenantId urlId userIdWS

参数

名称	类型	必需
tenantId	string	是
urlId	string	是
userIdWS	string	是
startTime	number	是
endTime	number	否

响应

返回: GetEventLog200Response

示例

getGlobalEventLog 示例

Copy

const tenantId: string = "tenant_639b7f12";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/important-update-987";
const userIdWS: string = "user_ws_42b7";
const startTime: number = new Date("2026-06-14T00:00:00Z").getTime();
const endTime: number = Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

创建动态帖子

参数

Name	Type	Required
tenantId	string	是
createFeedPostParams	CreateFeedPostParams	是
broadcastId	string	否
isLive	boolean	否
doSpamCheck	boolean	否
skipDupCheck	boolean	否

响应

返回：CreateFeedPost200Response

示例

createFeedPost 示例

Copy

const tenantId: string = 'tenant_4f2b1c';
const createFeedPostParams: CreateFeedPostParams = {
  content: 'Launching our summer collection today — check it out!',
  authorId: 'user_879',
  media: [
    {
      type: 'image',
      assets: [
        { url: 'https://cdn.myshop.com/uploads/summer-look.jpg', width: 1200, height: 800 } as FeedPostMediaItemAsset
      ]
    } as FeedPostMediaItem
  ],
  links: [
    { url: 'https://myshop.com/new-arrival', title: 'Summer Collection' } as FeedPostLink
  ],
  allowComments: true
};
const broadcastId: string = 'broadcast-2026-06-15-001';
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const response: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

创建动态帖子（公共）

参数

名称	类型	必需
tenantId	string	是
createFeedPostParams	CreateFeedPostParams	是
broadcastId	string	No
sso	string	否

响应

返回: CreateFeedPostPublic200Response

示例

createFeedPostPublic 示例

Copy

(async () => {
  const tenantId: string = "tenant_9f8b7c";
  const media: FeedPostMediaItem[] = [{ type: "image", assets: [{ url: "https://cdn.example.com/roadmap.jpg", mimeType: "image/jpeg" }] }];
  const links: FeedPostLink[] = [{ url: "https://company.example.com/roadmap", title: "Full roadmap" }];
  const createFeedPostParams: CreateFeedPostParams = {
    title: "Weekly Product Roadmap Update",
    body: "This week we shipped enhancements to search relevance and fixed top customer bugs.",
    authorId: "user_8321",
    media,
    links,
    visibility: "public"
  };
  const broadcastId: string = "broadcast_2026_06_15";
  const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload";
  const response: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);
  console.log(response);
})();

删除动态帖子（公共）

参数

名称	类型	必需
tenantId	string	是
postId	string	是
broadcastId	string	否
sso	string	否

响应

返回：DeleteFeedPostPublic200Response

示例

deleteFeedPostPublic 示例

Copy

const tenantId: string = 'acme-tenant-42';
const postId: string = 'post_8f3d2a7c';
const broadcastId: string = 'broadcast_2026-06-15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

获取动态帖子

req tenantId afterId

参数

名称	类型	必需
tenantId	string	是
afterId	string	否
limit	number	否
tags	Array	否

响应

返回： GetFeedPosts200Response

示例

getFeedPosts 示例

Copy

const tenantId: string = "tenant_74321";
const afterId: string = "post_20250610_9b2f3";
const limit: number = 25;
const tags: Array<string> = ["product-updates", "announcements"];
const response: GetFeedPosts200Response = await getFeedPosts(tenantId, afterId, limit, tags);

获取动态帖子（公共）

req tenantId afterId

参数

名称	类型	必填
tenantId	string	是
afterId	string	否
limit	number	否
tags	Array	否
sso	string	否
isCrawler	boolean	否
includeUserInfo	boolean	否

响应

返回：GetFeedPostsPublic200Response

示例

getFeedPostsPublic 示例

Copy

(async () => {
  const tenantId: string = 'tenant_acme_01';
  const afterId: string = 'post_20250610_842';
  const limit: number = 25;
  const tags: string[] = ['news', 'technology'];
  const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1Ni';
  const isCrawler: boolean = false;
  const includeUserInfo: boolean = true;
  const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(
    tenantId,
    afterId,
    limit,
    tags,
    sso,
    isCrawler,
    includeUserInfo
  );
  console.log(response);
})();

获取动态帖子统计

参数

Name	Type	Required
tenantId	string	Yes
postIds	Array	Yes
sso	string	No

响应

返回: GetFeedPostsStats200Response

示例

getFeedPostsStats 示例

Copy

const tenantId: string = "tenant_98765";
const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];
const ssoToken: string = "sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, ssoToken);

获取用户反应（公共）

参数

名称	类型	必需
tenantId	string	是
postIds	Array	否
sso	string	否

响应

返回：GetUserReactsPublic200Response

示例

getUserReactsPublic 示例

Copy

const tenantId: string = 'fastcomments-tenant-4f2b9c';
const postIds: Array<string> = ['post_7a1f9e', 'post_2b3c88'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTYwOTQ0MDAwMH0.signature';
const response: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

对动态帖子做出反应（公共）

参数

名称	类型	必填
tenantId	string	是
postId	string	是
reactBodyParams	ReactBodyParams	是
isUndo	boolean	否
broadcastId	string	否
sso	string	否

响应

返回: ReactFeedPostPublic200Response

示例

reactFeedPostPublic 示例

Copy

const tenantId: string = 'acme-tenant-001';
const postId: string = 'feedpost_78901';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast_2026_06_15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const response: ReactFeedPostPublic200Response = await reactFeedPostPublic(
  tenantId,
  postId,
  reactBodyParams,
  isUndo,
  broadcastId,
  sso
);

更新动态帖子

参数

名称	类型	必填
tenantId	string	是
id	string	是
feedPost	FeedPost	是

响应

返回：FlagCommentPublic200Response

示例

updateFeedPost 示例

Copy

const tenantId: string = "tenant_72f3b4c9";
const id: string = "post_ba4f6e18-2d3c-4b7a-91f2-8c0e3a6b5d4f";
const feedPost: FeedPost = {
  title: "June feature rollout",
  body: "Announcing performance improvements and moderation updates available to all sites.",
  authorName: "Platform Team",
  mediaItems: [
    {
      type: "image",
      caption: "Release banner",
      asset: { url: "https://cdn.fastcomments.com/assets/june-banner.jpg", mimeType: "image/jpeg", width: 1200, height: 600 }
    }
  ],
  links: [{ title: "Release notes", url: "https://docs.fastcomments.com/releases/june-2026" }]
} as FeedPost;
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

更新动态帖子（公共）

参数

名称	类型	必需
tenantId	string	是
postId	string	是
updateFeedPostParams	UpdateFeedPostParams	是
broadcastId	string	否
sso	string	否

响应

返回: CreateFeedPostPublic200Response

示例

updateFeedPostPublic 示例

Copy

const tenantId: string = 'tenant_acme_01';
const postId: string = 'post_20260615_001';
const updateFeedPostParams: UpdateFeedPostParams = {
  title: 'Weekly Update: Product Launch',
  content: 'We shipped the 2.0 release today — highlights and links below.',
  media: [{ url: 'https://cdn.acme.com/releases/launch.jpg', type: 'image' }],
  tags: ['release', 'product'],
  isPublic: true
};
const broadcastId: string = 'broadcast_live_42';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

举报评论（公共）

参数

名称	类型	必填
tenantId	string	是
commentId	string	是
isFlagged	boolean	是
sso	string	否

响应

返回: FlagCommentPublic200Response

示例

flagCommentPublic 示例

Copy

const tenantId: string = "tenant_4f1b2a9c";
const commentId: string = "comment_8d3e6f12";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

获取大动图

参数

名称	类型	必填	描述
tenantId	string	是
largeInternalURLSanitized	string	是

响应

返回: GetGifLarge200Response

示例

getGifLarge 示例

Copy

const tenantId: string = "tenant_9f8b7c";
const largeInternalURLSanitized: string = "https://cdn.fastcomments.com/gifs/07d3f6_large.gif";
const preferWebP: boolean | undefined = true; // 可选偏好
const urlToUse: string = preferWebP ? largeInternalURLSanitized.replace(".gif", ".webp") : largeInternalURLSanitized;
const response: GetGifLarge200Response = await getGifLarge(tenantId, urlToUse);

搜索动图

参数

名称	类型	必填
tenantId	string	是
search	string	是
locale	string	否
rating	string	否
page	number	否

Response

返回: GetGifsSearch200Response

示例

getGifsSearch 示例

Copy

const tenantId: string = "tenant_acme_9876";
const search: string = "cat playing piano";
const locale: string = "en-US";
const rating: string = "pg";
const page: number = 1;
const result: GetGifsSearch200Response = await getGifsSearch(tenantId, search, locale, rating, page);

获取流行动图

参数

名称	类型	必填
tenantId	string	是
locale	string	否
rating	string	否
page	number	否

响应

返回: GetGifsTrending200Response

示例

getGifsTrending 示例

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_8b3f2c';
  const locale: string = 'en-US';
  const rating: string = 'pg';
  const page: number = 1;
  const result: GetGifsTrending200Response = await getGifsTrending(tenantId, locale, rating, page);
  console.log(result);
}
main();

添加标签

参数

名称	类型	必填	描述
tenantId	string	否
createHashTagBody	CreateHashTagBody	否

响应

返回： AddHashTag200Response

示例

addHashTag 示例

Copy

const tenantId: string | undefined = "tenant_3c9f7b";
const createHashTagBody: CreateHashTagBody = {
  name: "support",
  title: "Support",
  description: "Questions about product usage, bugs, and account issues",
  color: "#0066CC",
  isActive: true,
  aliases: ["help", "customer-service"]
};
const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

批量添加标签

参数

Name	Type	Required	Description
tenantId	string	否
bulkCreateHashTagsBody	BulkCreateHashTagsBody	否

响应

返回：AddHashTagsBulk200Response

示例

addHashTagsBulk 示例

Copy

const tenantId: string = "tenant_acme_corp_987";
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [
    { name: "product-update", description: "Announcements about new product releases", visible: true },
    { name: "customer-support", description: "Customer support related discussions", visible: false }
  ],
  createdBy: "moderator_jane"
};
const resultWithTenant: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const resultWithoutTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);

删除标签

参数

名称	类型	必需
tag	string	是
tenantId	string	否
deleteHashTagRequest	DeleteHashTagRequest	否

响应

返回: FlagCommentPublic200Response

示例

deleteHashTag 示例

Copy

const tag: string = "breaking-news";
const tenantId: string = "tenant_72a1";
const deleteHashTagRequest: DeleteHashTagRequest = {
  reason: "consolidate-duplicates",
  requestedBy: "moderator@dailypress.com",
  forceDelete: true
};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

获取标签

参数

名称	类型	必需	描述
tenantId	string	是
page	number	否

响应

返回：GetHashTags200Response

示例

getHashTags 示例

Copy

const tenantId: string = 'tenant_7f4b2c3a';
const tagsFirstPage: GetHashTags200Response = await getHashTags(tenantId);
const tagsSecondPage: GetHashTags200Response = await getHashTags(tenantId, 2);
console.log(tagsFirstPage, tagsSecondPage);

部分更新标签

参数

Name	Type	Required
tag	string	是
tenantId	string	否
updateHashTagBody	UpdateHashTagBody	否

响应

返回：PatchHashTag200Response

示例

patchHashTag 示例

Copy

const tag: string = "feature-request";
const tenantId: string = "tenant_8f7a3b2c";
const updateHashTagBody: UpdateHashTagBody = {
  displayName: "Feature Request",
  description: "Use this tag for requests to add new features to the product",
  enabled: true
};
const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

创建版主

参数

名称	类型	必填	描述
tenantId	string	是
createModeratorBody	CreateModeratorBody	是

响应

返回: CreateModerator200Response

示例

createModerator 示例

Copy

const tenantId: string = 'tenant_9f3b21';
const createModeratorBody: CreateModeratorBody = {
  moderator: {
    name: 'Alex Rivera',
    email: 'alex.rivera@fastcomments.io',
    role: 'global_moderator',
    enabled: true,
  },
  // 演示可选参数：
  notifyUser: true,
  permissions: ['delete_comment', 'edit_comment', 'ban_user'],
  customConfig: { dashboardTheme: 'dark' } as unknown as CustomConfigParameters
};
const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

删除版主

参数

Name	Type	Required
tenantId	string	是
id	string	是
sendEmail	string	否

响应

返回: FlagCommentPublic200Response

示例

deleteModerator 示例

Copy

const tenantId: string = 'tenant_4f3b2c9a';
const id: string = 'mod_9c2d1f7b';
const sendEmail: string = 'true';
const response: FlagCommentPublic200Response = await deleteModerator(tenantId, id, sendEmail);
console.log(response);

获取版主

参数

名称	类型	必填	描述
tenantId	string	是
id	string	是

响应

返回: GetModerator200Response

示例

getModerator 示例

Copy

const tenantId: string = 'acme-media-58';
const id: string = 'mod-82f3b9c1';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

获取版主列表

参数

名称	类型	必需	描述
tenantId	string	是
skip	number	否

响应

返回: GetModerators200Response

示例

getModerators 示例

Copy

const tenantId: string = 'tenant_0a1b2c3d';
const moderators: GetModerators200Response = await getModerators(tenantId);
const skip: number = 20;
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

发送邀请

参数

名称	类型	必需
tenantId	string	是
id	string	是
fromName	string	是

返回：FlagCommentPublic200Response

示例

sendInvite 示例

Copy

(async () => {
  const tenantId: string = "tenant_acme_42";
  const id: string = "cmt_8f3b21";
  const fromName: string = "Ava Thompson";
  const inviteResult: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);
  console.log(inviteResult);
})();

更新版主

参数

名称	类型	必需
tenantId	string	是
id	string	是
updateModeratorBody	UpdateModeratorBody	是

响应

返回: FlagCommentPublic200Response

示例

updateModerator 示例

Copy

const tenantId: string = 'acme-tenant-81';
const id: string = 'mod_7f3a2b';
const updateModeratorBody: UpdateModeratorBody = {
  email: 'j.reyes@acme-corp.com',
  displayName: 'Jordan Reyes',
  roles: ['moderator', 'content_reviewer'],
  active: true,
  notes: 'Promoted to senior moderator; monitor flagged content weekly'
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

删除通知计数

参数

名称	类型	必填	描述
tenantId	string	是
id	string	是

响应

返回: FlagCommentPublic200Response

示例

deleteNotificationCount 示例

Copy

const tenantId: string = 'tenant_5f3d2e1b';
const id: string = 'notification_9a4b1c2';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);

获取缓存的通知计数

参数

名称	类型	必需	描述
tenantId	string	是
id	string	是

响应

返回：GetCachedNotificationCount200Response

示例

getCachedNotificationCount 示例

Copy

const tenantId: string = 'fastcomments-tenant-23';
const id: string = 'user_987654';
const cachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);
const maybeId: string | undefined = Math.random() > 0.5 ? 'user_123456' : undefined;
if (maybeId) {
  const optionalCachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, maybeId);
}

获取通知计数

参数

Name	Type	Required
tenantId	string	是
userId	string	否
urlId	string	否
fromCommentId	string	否
viewed	boolean	否
type	string	否

响应

返回：GetNotificationCount200Response

示例

getNotificationCount 示例

Copy

const tenantId: string = 'tenant_82a3b9f';
const userId: string = 'user_43721';
const urlId: string = 'https://news.example.com/articles/2026/06/15/coverage-123';
const fromCommentId: string = 'comment_98765';
const viewed: boolean = false;
const notificationType: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, notificationType);

获取通知

参数

名称	类型	必需
tenantId	string	是
userId	string	否
urlId	string	否
fromCommentId	string	否
viewed	boolean	否
type	string	否
skip	number	否

响应

返回: GetNotifications200Response

示例

getNotifications 示例

Copy

const tenantId: string = 'tenant_9f8b7c6a';
const userId: string = 'user_5a4b3c2d';
const urlId: string = 'post_84f2a1b9';
const fromCommentId: string = 'cmt_0a1b2c3d';
const viewed: boolean = false;
const type: string = 'reply';
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(
  tenantId,
  userId,
  urlId,
  fromCommentId,
  viewed,
  type,
  skip
);

更新通知

参数

名称	类型	必填
tenantId	string	是
id	string	是
updateNotificationBody	UpdateNotificationBody	是
userId	string	否

响应

返回：FlagCommentPublic200Response

示例

updateNotification 示例

Copy

const tenantId: string = 'tenant_9f3b2c';
const id: string = 'notification_4a1d2e';
const updateNotificationBody: UpdateNotificationBody = {
  enabled: true,
  channels: ['email', 'push'],
  frequency: 'immediate',
  templateId: 'tmpl_77aa'
} as UpdateNotificationBody;
const userId: string = 'user_2468';
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

创建 V1 页面反应

参数

名称	类型	必填
tenantId	string	是
urlId	string	是
title	string	否

响应

返回: CreateV1PageReact200Response

示例

createV1PageReact 示例

Copy

(async () => {
  const tenantId: string = 'b12f3c4d-5678-90ab-cdef-1234567890ab';
  const urlId: string = 'https://www.news-site.com/world/2026/election-results';
  const title: string = 'Election results: key takeaways and analysis';
  const responseWithTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId, title);
  const responseWithoutTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId);
  console.log(responseWithTitle, responseWithoutTitle);
})();

创建 V2 页面反应

参数

名称	类型	必需
tenantId	string	是
urlId	string	是
id	string	是
title	string	否

响应

返回： CreateV2PageReact200Response

示例

createV2PageReact 示例

Copy

const tenantId: string = "fastcomments-tenant-72";
const urlId: string = "articles/2026/06/15/product-update";
const id: string = "page-8f3b2a";
const title: string = "Product Update: June 15, 2026";
(async function run(): Promise<void> {
  const response: CreateV2PageReact200Response = await createV2PageReact(tenantId, urlId, id, title);
  console.log(response);
})();

删除 V1 页面反应

参数

名称	类型	必需	描述
tenantId	string	是
urlId	string	是

返回: DeleteV1PageReact200Response

示例

deleteV1PageReact 示例

Copy

const tenantId: string = process.env.TENANT_ID ?? 'd3b07384-9f6a-4c2b-8c3e-0a1b2c3d4e5f';
const urlId: string = 'https://acme.com/articles/2026/06/fastcomments-integration';
const result: DeleteV1PageReact200Response = await deleteV1PageReact(tenantId, urlId);

删除 V2 页面反应

参数

Name	Type	Required
tenantId	string	是
urlId	string	是
id	string	是

响应

返回: DeleteV2PageReact200Response

示例

deleteV2PageReact 示例

Copy

const tenantId: string = "tenant_79021";
const urlId: string = "blog/my-first-post";
const id: string = "reaction_9f8b7c";
let includeHistory: boolean | undefined = undefined; // 可选标志，在某些调用中使用
const result: DeleteV2PageReact200Response = await deleteV2PageReact(tenantId, urlId, id);
console.log(result);

获取 V1 页面点赞

参数

Name	Type	Required	Description
tenantId	string	是
urlId	string	是

响应

返回: GetV1PageLikes200Response

示例

getV1PageLikes 示例

Copy

const tenantId: string = 'fastcomments-742';
const urlId: string = 'sports/2026/06/15/world-cup-preview';
const pageLikes: GetV1PageLikes200Response = await getV1PageLikes(tenantId, urlId);

获取 V2 页面反应

参数

名称	类型	必需	描述
tenantId	string	是
urlId	string	是

响应

返回: GetV2PageReacts200Response

示例

getV2PageReacts 示例

Copy

const tenantId: string = "tenant_82f4b3a9";
const urlId: string = "https://news.site.com/articles/2026/06/15/product-launch";
const response: GetV2PageReacts200Response = await getV2PageReacts(tenantId, urlId);
console.log(response);

获取 V2 页面反应用户

参数

名称	类型	必需
tenantId	string	是
urlId	string	是
id	string	是

Response

返回: GetV2PageReactUsers200Response

示例

getV2PageReactUsers 示例

Copy

const tenantId: string = "7421";
const urlId: string = "sports/london-marathon";
const id: string = "reactUser-3fa85f64-5717-4562-b3fc-2c963f66afa6";
const includeDeleted: boolean | undefined = undefined; // 可选标志（示例）
const result: GetV2PageReactUsers200Response = await getV2PageReactUsers(tenantId, urlId, id);

添加页面

参数

名称	类型	必填	描述
tenantId	string	是
createAPIPageData	CreateAPIPageData	是

响应

返回: AddPageAPIResponse

删除页面

参数

名称	类型	必需	描述
tenantId	string	是
id	string	是

响应

返回: DeletePageAPIResponse

获取离线用户

页面上之前评论但当前不在线的用户。按 displayName 排序。在耗尽 /users/online 后使用此方法以渲染“成员”部分。对 commenterName 进行游标分页：服务器沿部分 {tenantId, urlId, commenterName} 索引，从 afterName 向前通过 $gt 遍历，无需 $skip 成本。

参数

名称	类型	必需
tenantId	string	是
urlId	string	是
afterName	string	否
afterUserId	string	否

响应

返回: GetOfflineUsers200Response

示例

getOfflineUsers 示例

Copy

const tenantId: string = 'tenant_prod_001';
const urlId: string = 'article-2026-06-15-how-ai-impacts';
const afterName: string = 'michael.smith';
const afterUserId: string = 'user_72b9';
const response: GetOfflineUsers200Response = await getOfflineUsers(tenantId, urlId, afterName, afterUserId);

获取在线用户

当前页面的在线查看者：当前其 websocket 会话已订阅该页面的人。返回 anonCount + totalCount（房间范围的订阅者，包括我们不列举的匿名查看者）。

参数

名称	类型	必需
tenantId	string	是
urlId	string	是
afterName	string	否
afterUserId	string	否

响应

返回：GetOnlineUsers200Response

示例

getOnlineUsers 示例

Copy

const tenantId: string = 'tenant_14f9c3';
const urlId: string = 'article_20250615';
const afterName: string = 'marie.curie';
const afterUserId: string = 'u_92b7';
const result: GetOnlineUsers200Response = await getOnlineUsers(tenantId, urlId, afterName, afterUserId);

通过 URL ID 获取页面

参数

名称	类型	必需	描述
tenantId	string	是
urlId	string	是

响应

返回：GetPageByURLIdAPIResponse

获取页面列表

参数

名称	类型	必填	描述
tenantId	string	是

响应

返回: GetPagesAPIResponse

获取页面（公共）

列出租户的页面。由 FChat 桌面客户端用于填充其房间列表。要求在每个页面的解析后的自定义配置中 enableFChat 为 true。需要 SSO 的页面会根据请求用户的组访问权限进行过滤。

Parameters

名称	类型	必需
tenantId	string	Yes
cursor	string	No
limit	number	No
q	string	No
sortBy	PagesSortBy	No
hasComments	boolean	No

Response

返回: GetPagesPublic200Response

Example

getPagesPublic 示例

Copy

const tenantId: string = 'tenant_8f3b2c';
const cursor: string = 'eyJwYWdlIjoiMTIwIn0';
const limit: number = 25;
const q: string = 'homepage hero';
const hasComments: boolean = true;
const response: GetPagesPublic200Response = await getPagesPublic(
  tenantId,
  cursor,
  limit,
  q,
  undefined,
  hasComments
);

获取用户信息

为租户批量获取用户信息。给定 userIds，返回 User / SSOUser 的展示信息。由评论小部件使用，用于丰富那些通过在线状态事件刚刚出现的用户信息。无页面上下文：隐私统一强制执行（私人档案将被屏蔽）。

参数

Name	Type	Required	Description
tenantId	string	是
ids	string	是

响应

返回：GetUsersInfo200Response

示例

getUsersInfo 示例

Copy

const tenantId: string = 'acme-tenant-007';
const userIdsList: string[] = ['user_12a', 'user_34b', 'user_56c'];
const separator: string | undefined = undefined; // 可选；如果为 undefined 则默认使用逗号
const ids: string = userIdsList.join(separator ?? ',');
const usersInfo: GetUsersInfo200Response = await getUsersInfo(tenantId, ids);

部分更新页面

参数

名称	类型	必需
tenantId	string	是
id	string	是
updateAPIPageData	UpdateAPIPageData	是

响应

返回： PatchPageAPIResponse

删除待处理的 Webhook 事件

参数

Name	Type	Required	Description
tenantId	string	是
id	string	是

响应

返回: FlagCommentPublic200Response

示例

deletePendingWebhookEvent 示例

Copy

const tenantId: string = "tenant_5f8d7a34";
const id: string = "webhook_evt_987654321";
const requestNote: string | undefined = undefined;
const response: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);

获取待处理 Webhook 事件计数

参数

名称	类型	必填
tenantId	string	是
commentId	string	否
externalId	string	否
eventType	string	否
type	string	否
domain	string	否
attemptCountGT	number	否

响应

返回: GetPendingWebhookEventCount200Response

示例

getPendingWebhookEventCount 示例

Copy

const tenantId: string = 'tenant_9f8b3b';
const commentId: string = 'cmt_1a2b3c';
const eventType: string = 'comment.created';
const domain: string = 'news-site.com';
const attemptCountGT: number = 2;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined, // externalId omitted
  eventType,
  undefined, // type omitted
  domain,
  attemptCountGT
);

获取待处理的 Webhook 事件

参数

名称	类型	必填
tenantId	string	是
commentId	string	否
externalId	string	否
eventType	string	否
type	string	否
domain	string	否
attemptCountGT	number	否
skip	number	否

响应

返回：GetPendingWebhookEvents200Response

示例

getPendingWebhookEvents 示例

Copy

const tenantId: string = 'tenant_9f3b2a';
const commentId: string = 'cmt_8a7d1';
const eventType: string = 'comment.created';
const domain: string = 'reviews.myshop.com';
const attemptCountGT: number = 1;
const skip: number = 0;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT,
  skip
);

创建问题配置

参数

名称	类型	必需	描述
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	Yes

响应

返回: CreateQuestionConfig200Response

示例

createQuestionConfig 示例

Copy

const tenantId: string = "tenant_9f3b1c2a";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  name: "Product feedback",
  key: "product_quality",
  description: "Short survey question shown after posting a comment",
  required: true,
  renderingType: "singleChoice",
  customOptions: [
    { label: "Excellent", value: "5" },
    { label: "Good", value: "4" },
    { label: "Fair", value: "3" }
  ] as QuestionConfigCustomOptionsInner[],
  notifyModerators: false // 演示可选参数
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

删除问题配置

参数

名称	类型	必填	描述
tenantId	string	是
id	string	是

响应

返回: FlagCommentPublic200Response

示例

deleteQuestionConfig 示例

Copy

const tenantId: string = 'acme-corp-47a9';
const id: string = 'qcfg_20260615_001';
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

获取问题配置

参数

名称	类型	必需	描述
tenantId	string	是
id	string	是

响应

返回: GetQuestionConfig200Response

示例

getQuestionConfig 示例

Copy

const tenantId: string = "acme-corp-47";
const questionId: string = "q-4f2b9a";
const includeDrafts: boolean | undefined = undefined; // 可选参数占位符
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
console.log(result);

获取问题配置列表

参数

Name	Type	Required	Description
tenantId	string	是
skip	number	否

响应

返回: GetQuestionConfigs200Response

示例

getQuestionConfigs 示例

Copy

const tenantId: string = "tenant_4c9f2b";
const responseWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const skip: number = 50;
const responseWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, skip);

更新问题配置

参数

名称	类型	必需
tenantId	string	是
id	string	是
updateQuestionConfigBody	UpdateQuestionConfigBody	是

响应

返回： FlagCommentPublic200Response

示例

updateQuestionConfig 示例

Copy

const tenantId: string = "tenant_9f3b8a2e-4c6d-4b4f-a1b2-9e8f7d6c5b3a";
const id: string = "q_7c2e1b4a-5d6f-4a8b-9c3d-2e1f0b9a4c5d";
const options: QuestionConfigCustomOptionsInner[] = [
  { value: "1", label: "Very dissatisfied" },
  { value: "2", label: "Dissatisfied" },
  { value: "3", label: "Neutral" },
  { value: "4", label: "Satisfied" },
  { value: "5", label: "Very satisfied" }
];
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  label: "How satisfied are you with the article?",
  enabled: true,
  required: false, // 演示可选参数
  options
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

创建问题结果

参数

名称	类型	必填	描述
tenantId	string	是
createQuestionResultBody	CreateQuestionResultBody	是

响应

返回: CreateQuestionResult200Response

示例

createQuestionResult 示例

Copy

const tenantId: string = 'fc-tenant-512';
const meta: MetaItem[] = [{ key: 'source', value: 'article' }];
const body: CreateQuestionResultBody = {
  questionId: 'q-94',
  userId: 'user_332',
  answers: [{ optionId: 'opt_a', score: 1 }],
  meta, // 提供的可选元数据
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, body);

删除问题结果

参数

名称	类型	必填	描述
tenantId	string	是
id	string	是

响应

返回：FlagCommentPublic200Response

示例

deleteQuestionResult 示例

Copy

const tenantId: string = "acme-corp-tenant-01";
const id: string = "qres_9f8b7c3a";
const response: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);
const optionalResponse: FlagCommentPublic200Response | undefined = response;

获取问题结果

参数

Name	Type	Required	Description
tenantId	string	是
id	string	是

响应

返回: GetQuestionResult200Response

示例

getQuestionResult 示例

Copy

const tenantId: string = 'tenant_9f3b2a7c9';
const questionId: string = 'q_8d4f1b2c3a';
const options: { includeMeta?: boolean } = { includeMeta: true }; // 可选参数示例
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);
const apiStatus: APIStatus | undefined = (result as unknown as { apiStatus?: APIStatus }).apiStatus;
const question: QuestionResult | undefined = (result as unknown as { question?: QuestionResult }).question;

获取问题结果列表

参数

名称	类型	必填
tenantId	string	是
urlId	string	否
userId	string	否
startDate	string	否
questionId	string	否
questionIds	string	否
skip	number	否

响应

返回: GetQuestionResults200Response

示例

getQuestionResults 示例

Copy

const tenantId: string = 'fc-tenant-7a9c';
const urlId: string = 'news/article-2026-06-15';
const userId: string = 'user-8421';
const startDate: string = '2026-05-01T00:00:00Z';
const questionId: string = 'q-13';
const questionIds: string = 'q-13,q-14';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

更新问题结果

参数

名称	类型	必填
tenantId	string	是
id	string	是
updateQuestionResultBody	UpdateQuestionResultBody	是

响应

返回: FlagCommentPublic200Response

示例

updateQuestionResult 示例

Copy

const tenantId: string = "tenant_prod_84b2";
const id: string = "question_9f3a";
const updateQuestionResultBody: UpdateQuestionResultBody = {
  outcome: "accepted",
  confidence: 0.88,
  moderatorId: "moderator_17",
  notes: "Validated by automated review" // 包含可选字段
};
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

聚合问题结果

参数

名称	类型	必需
tenantId	string	是
questionId	string	否
questionIds	Array	否
urlId	string	否
timeBucket	AggregateTimeBucket	否
startDate	Date	否
forceRecalculate	boolean	否

响应

返回: AggregateQuestionResults200Response

示例

aggregateQuestionResults 示例

Copy

const tenantId: string = 'tenant_6f2b3c';
const questionIds: Array<string> = ['q-7a1b2c', 'q-8d3e4f'];
const urlId: string = 'url_9f8e7d';
const startDate: Date = new Date('2025-01-01T00:00:00Z');
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(tenantId, undefined, questionIds, urlId, undefined, startDate, true);

批量聚合问题结果

参数

Name	Type	Required
tenantId	string	是
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	是
forceRecalculate	boolean	否

响应

返回: BulkAggregateQuestionResults200Response

示例

bulkAggregateQuestionResults 示例

Copy

const tenantId: string = "tenant_0012";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    {
      questionId: "quality_score",
      startTime: "2026-06-01T00:00:00Z",
      endTime: "2026-06-14T00:00:00Z",
      timeBucket: "day",
      dimensions: ["threadId"]
    }
  ],
  includeTotals: true
};
const forceRecalculate: boolean = false;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

将评论与问题结果合并

参数

名称	类型	必需
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
startDate	Date	No
forceRecalculate	boolean	No
minValue	number	No
maxValue	number	No
limit	number	No

响应

返回: CombineCommentsWithQuestionResults200Response

示例

combineCommentsWithQuestionResults 示例

Copy

const tenantId: string = 'tenant_12345';
const questionId: string = 'q_98765';
const questionIds: string[] = ['q_98765', 'q_12345'];
const urlId: string = 'url_abc123';
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 0;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  questionId,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

添加 SSO 用户

参数

名称	类型	必需	描述
tenantId	string	是
createAPISSOUserData	CreateAPISSOUserData	是

响应

返回: AddSSOUserAPIResponse

删除 SSO 用户

参数

Name	Type	Required
tenantId	string	是
id	string	是
deleteComments	boolean	否
commentDeleteMode	string	否

响应

返回: DeleteSSOUserAPIResponse

通过邮箱获取 SSO 用户

参数

名称	类型	必需	描述
tenantId	string	是
email	string	是

响应

返回: GetSSOUserByEmailAPIResponse

通过 ID 获取 SSO 用户

参数

名称	类型	必填	描述
tenantId	string	是
id	string	是

响应

返回: GetSSOUserByIdAPIResponse

获取 SSO 用户列表

参数

名称	类型	必填	描述
tenantId	string	是
skip	number	否

响应

返回: GetSSOUsers200Response

部分更新 SSO 用户

参数

名称	类型	必填
tenantId	string	是
id	string	是
updateAPISSOUserData	UpdateAPISSOUserData	是
updateComments	boolean	否

响应

返回：PatchSSOUserAPIResponse

替换 SSO 用户

参数

名称	类型	必需
tenantId	string	是
id	string	是
updateAPISSOUserData	UpdateAPISSOUserData	是
updateComments	boolean	否

响应

返回: PutSSOUserAPIResponse

示例

putSSOUser 示例

Copy

const tenantId: string = 'acme-enterprises-42';
const id: string = 'usr-73a1b2';
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: 'marcus.ingram@acme.com',
  givenName: 'Marcus',
  familyName: 'Ingram',
  roles: ['editor', 'project_owner'],
  enabled: true
};
const result: PutSSOUserAPIResponse = await putSSOUser(tenantId, id, updateAPISSOUserData, true);

创建订阅

参数

Name	Type	Required	Description
tenantId	string	是
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	是

响应

返回：CreateSubscriptionAPIResponse

示例

createSubscription 示例

Copy

const tenantId: string = "acme-corp-tenant-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "user_98765",
  planId: "pro_monthly",
  paymentMethod: { type: "card", cardId: "card_abc123" },
  autoRenew: true,
  trialDays: 14, // 演示可选参数
  metadata: { campaign: "spring_launch" } // 演示可选参数
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);

删除订阅

参数

Name	Type	Required
tenantId	string	是
id	string	是
userId	string	否

响应

返回: DeleteSubscriptionAPIResponse

获取订阅

参数

Name	Type	Required	Description
tenantId	string	是
userId	string	否

响应

返回: GetSubscriptionsAPIResponse

示例

getSubscriptions 示例

Copy

const tenantId: string = "contoso-9a1b2c";
const userId: string = "u-482f6";
const subscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
const userSubscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);

更新订阅

参数

Name	Type	Required
tenantId	string	是
id	string	是
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	是
userId	string	否

响应

返回： UpdateSubscriptionAPIResponse

示例

updateSubscription 示例

Copy

const tenantId: string = 'tenant_9f3b2c';
const subscriptionId: string = 'sub_7641a2b3';
const updateData: UpdateAPIUserSubscriptionData = {
  status: 'active',
  planId: 'pro_annual',
  autoRenew: true,
  renewalDate: '2026-04-15T00:00:00Z',
  metadata: { upgradedBy: 'billing-team' }
};
const userId: string = 'user_215';
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, subscriptionId, updateData, userId);

获取租户每日使用情况

参数

名称	类型	必需
tenantId	string	是
yearNumber	number	否
monthNumber	number	否
dayNumber	number	否
skip	number	否

响应

返回: GetTenantDailyUsages200Response

示例

getTenantDailyUsages 示例

Copy

const tenantId: string = 'tenant_7a3c2e';
const dailyUsages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, 2026, 6, undefined, 0);

创建租户套餐

参数

Name	Type	Required	Description
tenantId	string	是
createTenantPackageBody	CreateTenantPackageBody	是

响应

返回: CreateTenantPackage200Response

示例

createTenantPackage 示例

Copy

const tenantId: string = "tenant_7890";
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Growth Plan",
  maxSeats: 2500,
  features: {
    moderation: true,
    analytics: true,
    sso: { enabled: true, provider: "saml" }
  },
  billing: { interval: "monthly", priceCents: 19900 },
  // 示例可选参数：notes 非必填，但已提供
  notes: "Onboarding bundle with priority support"
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

删除租户套餐

参数

名称	类型	必需	描述
tenantId	string	是
id	string	是

响应

返回: FlagCommentPublic200Response

示例

deleteTenantPackage 示例

Copy

const tenantId: string = 'acme-corp-tenant-01';
const packageId: string = 'pkg-2026-06-15-001';
const dryRun: boolean | undefined = undefined; // 可选标志示例（函数不要求）
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

获取租户套餐

参数

Name	Type	Required	Description
tenantId	string	是
id	string	是

响应

返回: GetTenantPackage200Response

示例

getTenantPackage 示例

Copy

const tenantId: string = 'tenant_4b8c2a9f';
const packageId: string = 'pkg_7d3e1b5c';
const includeMetadata: boolean | undefined = true;
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

获取租户套餐列表

参数

Name	Type	Required	Description
tenantId	string	是
skip	number	否

响应

返回: GetTenantPackages200Response

示例

getTenantPackages 示例

Copy

const tenantId: string = 'tenant_8421';
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, 25);
const packagesWithoutSkip: GetTenantPackages200Response = await getTenantPackages(tenantId);

替换租户套餐

参数

Name	Type	Required
tenantId	string	是
id	string	是
replaceTenantPackageBody	ReplaceTenantPackageBody	是

响应

返回： FlagCommentPublic200Response

示例

replaceTenantPackage 示例

Copy

const tenantId: string = "fastcomments-tenant-114";
const id: string = "pkg-enterprise-2026-06";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: "EnterpriseModeration",
  version: "2.4.7",
  enabled: true,
  apiStatus: { state: "active", lastUpdated: "2026-06-10T12:00:00Z" },
  customConfigParameters: { maxCommentLength: 1200, allowImages: true }, // 包含可选设置
  voteStyle: { style: "updown" }
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

更新租户套餐

参数

名称	类型	必需
tenantId	string	是
id	string	是
updateTenantPackageBody	UpdateTenantPackageBody	是

响应

返回: FlagCommentPublic200Response

示例

updateTenantPackage 示例

Copy

const tenantId: string = 'tenant_9f3b2a';
const id: string = 'pkg_pro_2026';
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: 'Pro Plan',
  monthlyPriceUsd: 49,
  isActive: true,
  features: ['moderation', 'analytics', 'sso'],
  trialDays: 14 // 可选参数示例
};
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

创建租户用户

参数

Name	Type	Required	Description
tenantId	string	是
createTenantUserBody	CreateTenantUserBody	是

响应

返回: CreateTenantUser200Response

示例

createTenantUser 示例

Copy

const tenantId: string = "tenant_7f4a2b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "commenter",
  approved: true,
  displayName: "Jane D." // 可选：提供一个友好的显示名称
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);
console.log(result);

删除租户用户

参数

名称	类型	必需
tenantId	string	是
id	string	是
deleteComments	string	否
commentDeleteMode	string	否

响应

返回: FlagCommentPublic200Response

示例

deleteTenantUser 示例

Copy

const tenantId: string = "tenant_8f3a2b1c4d";
const id: string = "user_62a4f9e0b7";
const deleteComments: string = "true";
const commentDeleteMode: string = "permanent";
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

获取租户用户

参数

名称	类型	必需	描述
tenantId	string	是
id	string	是

响应

返回: GetTenantUser200Response

示例

getTenantUser 示例

Copy

const tenantId: string = 'tenant_ab12c3';
const id: string = 'user_9f8e7d';
const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
console.log(response);

获取租户用户列表

参数

名称	类型	必需	描述
tenantId	string	是
skip	number	否

响应

返回：GetTenantUsers200Response

示例

getTenantUsers 示例

Copy

const tenantId: string = 'tenant_7b8f3a2c-9e4d-4f1a';
const skip: number = 50;
const usersResponseDefault: GetTenantUsers200Response = await getTenantUsers(tenantId);
const usersResponsePaged: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

替换租户用户

参数

Name	Type	Required
tenantId	string	是
id	string	是
replaceTenantUserBody	ReplaceTenantUserBody	是
updateComments	string	否

响应

返回：FlagCommentPublic200Response

示例

replaceTenantUser 示例

Copy

const tenantId: string = "f3b9a2d1-8b4e-4c6a-9f2b-1d5c4e6a7b8c";
const id: string = "user_92f7c3b1";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: "auth0|1234567890",
  email: "jane.doe@company.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  metadata: { department: "support" }
};
const updateComments: string = "reassign-comments-to-new-user";
const response: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

发送登录链接

参数

Name	Type	Required
tenantId	string	是
id	string	是
redirectURL	string	否

响应

返回: FlagCommentPublic200Response

示例

sendLoginLink 示例

Copy

const tenantId: string = "tenant_0a1b2c3d";
const id: string = "user_984321";
const redirectURL: string = "https://app.acme-corp.com/welcome";
const responseWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);
const responseWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);

更新租户用户

参数

名称	类型	必需
tenantId	string	是
id	string	是
updateTenantUserBody	UpdateTenantUserBody	是
updateComments	string	否

响应

返回： FlagCommentPublic200Response

示例

updateTenantUser 示例

Copy

const tenantId: string = 'acme-corp';
const userId: string = 'u_72b9f4';
const updateTenantUserBody: UpdateTenantUserBody = {
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  suspended: false
};
const updateComments: string = 'Promoted to moderator after review of activity and community feedback';
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, userId, updateTenantUserBody, updateComments);

创建租户

参数

名称	类型	必填	描述
tenantId	string	是
createTenantBody	CreateTenantBody	是

响应

返回: CreateTenant200Response

示例

createTenant 示例

Copy

const tenantId: string = 'acme-news-01';
const createTenantBody: CreateTenantBody = {
  name: 'Acme News',
  domainConfiguration: { primaryDomain: 'news.acme.com', redirectHttps: true } as APIDomainConfiguration,
  importedSites: [{ siteId: 'site-92', url: 'https://news.acme.com' }] as ImportedSiteType[],
  billingInfo: { planId: 'business_monthly', contactEmail: 'billing@acme.com' } as BillingInfo
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

删除租户

参数

Name	Type	Required
tenantId	string	是
id	string	是
sure	string	否

响应

返回: FlagCommentPublic200Response

示例

deleteTenant 示例

Copy

const tenantId: string = 'tenant_742b9c';
const flagId: string = 'flag_1a2b3c';
const resultWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId);
const sureConfirmation: string = 'confirmed';
const resultWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId, sureConfirmation);

获取租户

参数

名称	类型	必需	描述
tenantId	string	是
id	string	是

响应

返回：GetTenant200Response

示例

getTenant 示例

Copy

const tenantId: string = 'fc_tenant_6b3e2a';
const id: string = 'site_42f1';
const tenantResponse: GetTenant200Response = await getTenant(tenantId, id);
const tenant: APITenant | undefined = tenantResponse.tenant;
const primaryDomain: APIDomainConfiguration | undefined = tenant?.domainConfiguration?.[0];

获取租户列表

参数

Name	Type	Required
tenantId	string	Yes
meta	string	No
skip	number	No

响应

返回: GetTenants200Response

示例

getTenants 示例

Copy

const tenantId: string = "fcom-tenant-8b4f2a1c";
const meta: string = "include=domains,billing&status=active";
const skip: number = 20;
const response: GetTenants200Response = await getTenants(tenantId, meta, skip);
console.log(response);

更新租户

参数

名称	类型	必需
tenantId	string	是
id	string	是
updateTenantBody	UpdateTenantBody	是

响应

返回: FlagCommentPublic200Response

示例

updateTenant 示例

Copy

const tenantId: string = 'tenant_84f12';
const id: string = 'flag_192b';
const updateTenantBody: UpdateTenantBody = {
  name: 'Acme Media',
  billingInfo: { plan: 'enterprise', seats: 25, nextBillingDate: '2026-07-01' },
  apiDomainConfiguration: { primaryDomain: 'comments.acme.com', additionalDomains: ['acme.com'] },
  importedSites: [{ siteUrl: 'https://blog.acme.com', archived: false }], // 可选
  commentSettings: { htmlRenderingMode: 'sanitized', deletionMode: 'soft' } // 可选
} as UpdateTenantBody;
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

更改工单状态

参数

名称	类型	必需
tenantId	string	是
userId	string	是
id	string	是
changeTicketStateBody	ChangeTicketStateBody	是

响应

返回: ChangeTicketState200Response

示例

changeTicketState 示例

Copy

const tenantId: string = 'tenant_8a7d3f4b';
const userId: string = 'user_5d1a9b2c';
const id: string = 'ticket_1024';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'closed',
  notifyParticipants: true, // 演示可选参数
  comment: 'Resolved by support — follow-up not required.'
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

创建工单

参数

名称	类型	必填
tenantId	string	是
userId	string	是
createTicketBody	CreateTicketBody	是

响应

返回: CreateTicket200Response

示例

createTicket 示例

Copy

const tenantId: string = 'tenant_acme_corp';
const userId: string = 'moderator_jane';
const createTicketBody: CreateTicketBody = {
  subject: 'Mass spam reports on article 789',
  description: 'Multiple identical spam comments posted under article 789. Needs moderation and bulk removal.',
  priority: 'high',
  contactEmail: 'jane@acme-corp.com',
  metadata: { articleId: '789', reportedCount: 12 } // 可选元数据示例
};
const ticket: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

获取工单

参数

名称	类型	必需
tenantId	string	是
id	string	是
userId	string	否

响应

返回：GetTicket200Response

示例

getTicket 示例

Copy

const tenantId: string = 'acme-corp';
const ticketId: string = 'TCKT-20250615-42';
const userId: string = 'user_84b2';
const ticketWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);
console.log(ticketWithUser.id, ticketWithoutUser.id);

获取工单列表

参数

Name	Type	Required
tenantId	string	是
userId	string	否
state	number	否
skip	number	否
limit	number	否

响应

返回: GetTickets200Response

示例

getTickets 示例

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_87b3';
const state: number = 2;
const skip: number = 0;
const limit: number = 50;
const tickets: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);

获取翻译

参数

名称	类型	必填
namespace	string	是
component	string	是
locale	string	否
useFullTranslationIds	boolean	否

响应

返回: GetTranslations200Response

示例

getTranslations 示例

Copy

const namespaceName: string = 'site-ui';
const componentName: string = 'comment-widget';
const locale: string = 'fr-FR';
const useFullTranslationIds: boolean = true;
const translationsWithLocale: GetTranslations200Response = await getTranslations(namespaceName, componentName, locale, useFullTranslationIds);
const translationsDefault: GetTranslations200Response = await getTranslations(namespaceName, componentName);

上传图片

上传并调整图像大小

参数

名称	类型	必需
tenantId	string	是
file	Blob	是
sizePreset	SizePreset	否
urlId	string	否

响应

返回: UploadImageResponse

通过 ID 获取用户徽章进度

参数

名称	类型	必填	描述
tenantId	string	是
id	string	是

响应

返回: GetUserBadgeProgressById200Response

示例

getUserBadgeProgressById 示例

Copy

const tenantId: string = 'fastcomments-tenant-241';
const badgeId: string = 'user-78b3d-badge-3';
const response: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, badgeId);
const progress: UserBadgeProgress | undefined = (response as unknown as { progress?: UserBadgeProgress }).progress;
const percentComplete: number | undefined = progress?.percentage;
console.log('Badge progress percent complete:', percentComplete);

通过用户 ID 获取用户徽章进度

参数

名称	类型	必填	描述
tenantId	string	是
userId	string	是

响应

返回：GetUserBadgeProgressById200Response

示例

getUserBadgeProgressByUserId 示例

Copy

const tenantId: string = 'acme-inc-tenant-01';
const userId: string = 'user_73c9b2';
const progress: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
async function maybeFetchProgress(tenant: string, user?: string): Promise<GetUserBadgeProgressById200Response | null> {
  if (!user) return null;
  return await getUserBadgeProgressByUserId(tenant, user);
}
const optionalResult: GetUserBadgeProgressById200Response | null = await maybeFetchProgress(tenantId, userId);

获取用户徽章进度列表

参数

名称	类型	必需
tenantId	string	是
userId	string	否
limit	number	否
skip	number	否

响应

返回: GetUserBadgeProgressList200Response

示例

getUserBadgeProgressList 示例

Copy

const tenantId: string = 'tenant_4f3a2b9c';
const userId: string = 'user_7721d';
const limit: number = 20;
const skip: number = 0;
const result: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);

创建用户徽章

参数

名称	类型	必填	描述
tenantId	string	是
createUserBadgeParams	CreateUserBadgeParams	是

响应

返回：CreateUserBadge200Response

示例

createUserBadge 示例

Copy

const tenantId: string = "tenant_7f4b2a";
const createUserBadgeParams: CreateUserBadgeParams = {
  code: "top_contributor",
  title: "Top Contributor",
  description: "Awarded for 100 high-quality comments",
  iconUrl: "https://cdn.fastcomments.com/badges/top_contributor.svg",
  isActive: true,
  criteria: { commentsRequired: 100 },
  customConfig: { displayOnProfile: true } // 示例：可选参数
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);

删除用户徽章

参数

Name	Type	Required	Description
tenantId	string	是
id	string	是

响应

返回: UpdateUserBadge200Response

示例

deleteUserBadge 示例

Copy

const tenantId: string = "tenant_8b3f2c7a";
const badgeIdOptional: string | undefined = Math.random() > 0.5 ? "badge_4f9a21" : undefined;
const id: string = badgeIdOptional ?? "badge_backup_01";
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

获取用户徽章

参数

名称	类型	必填	描述
tenantId	string	是
id	string	是

响应

返回: GetUserBadge200Response

示例

getUserBadge 示例

Copy

(async () => {
  const tenantId: string = 'tenant_6b8f2a1c';
  const id: string = 'badge_9f3d4b2a';
  const response: GetUserBadge200Response = await getUserBadge(tenantId, id);
  const badge: UserBadge | undefined = response.userBadge;
  const badgeName: string | undefined = badge?.name;
  console.log('Retrieved badge name:', badgeName);
})();

获取用户徽章列表

参数

名称	类型	必需
tenantId	string	是
userId	string	否
badgeId	string	否
type	number	否
displayedOnComments	boolean	否
limit	number	否
skip	number	否

响应

返回: GetUserBadges200Response

示例

getUserBadges 示例

Copy

const tenantId: string = 'tenant_7f9a12';
const userId: string = 'user_42b7';
const badgeId: string = 'badge_top_contributor';
const type: number = 2;
const displayedOnComments: boolean = true;
const limit: number = 25;
const skip: number = 0;
const badges: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

更新用户徽章

参数

名称	类型	必需
tenantId	string	是
id	string	是
updateUserBadgeParams	UpdateUserBadgeParams	是

响应

返回: UpdateUserBadge200Response

示例

updateUserBadge 示例

Copy

const tenantId: string = "tenant_9a8b7c";
const id: string = "badge_a1b2c3";
const updateUserBadgeParams: UpdateUserBadgeParams = {
  title: "Community Helper",
  description: "Awarded for providing 50 helpful answers",
  iconUrl: "https://cdn.fastcomments.com/badges/community-helper.png",
  isActive: true,
  expiryDate: undefined
};
const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);

获取用户通知计数

参数

名称	类型	必需	描述
tenantId	string	是
sso	string	否

响应

返回：GetUserNotificationCount200Response

示例

getUserNotificationCount 示例

Copy

const tenantId: string = 'tenant_acme_01';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const notificationCountNoSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
const notificationCountWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);

获取用户通知

参数

名称	类型	必填
tenantId	string	是
urlId	string	否
pageSize	number	否
afterId	string	否
includeContext	boolean	否
afterCreatedAt	number	否
unreadOnly	boolean	否
dmOnly	boolean	否
noDm	boolean	否
includeTranslations	boolean	否
includeTenantNotifications	boolean	否
sso	string	否

响应

返回: GetUserNotifications200Response

示例

getUserNotifications 示例

Copy

const tenantId: string = "tenant_8271";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/ai-updates";
const pageSize: number = 25;
const afterId: string = "notif_abc123";
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 86_400_000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const includeTenantNotifications: boolean = true;
const sso: string = "sso_token_xyz_987";
const notifications: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  urlId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  includeTenantNotifications,
  sso
);

重置用户通知计数

参数

名称	类型	必填	描述
tenantId	string	是
sso	string	否

响应

返回: ResetUserNotifications200Response

示例

resetUserNotificationCount 示例

Copy

const tenantId: string = "tenant_8a3f2b6c";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyX2QxMjM0IiwiaWF0IjoxNjI1MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resetResponseWithSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
const resetResponseWithoutSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);

重置用户通知

参数

名称	类型	必填
tenantId	string	是
afterId	string	否
afterCreatedAt	number	否
unreadOnly	boolean	否
dmOnly	boolean	否
noDm	boolean	否
sso	string	否

响应

返回: ResetUserNotifications200Response

示例

resetUserNotifications 示例

Copy

const tenantId: string = "tenant_9b1f2";
const afterId: string = "notification_0001";
const afterCreatedAt: number = Date.now() - 60 * 60 * 1000; // 一小时前
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const sso: string = "sso_session_7f2d";
const result: ResetUserNotifications200Response = await resetUserNotifications(
  tenantId,
  afterId,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  sso
);

更新用户评论订阅状态

启用或禁用特定评论的通知。

参数

Name	Type	Required
tenantId	string	是
notificationId	string	是
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	是
commentId	string	是
sso	string	否

响应

返回: UpdateUserNotificationStatus200Response

示例

updateUserNotificationCommentSubscriptionStatus 示例

Copy

const tenantId: string = 'f3a9c8b0-4d2e-4f8a-9c3b-1234567890ab';
const notificationId: string = '62a1f4d2-8c7b-4e1a-aaa1-abcdef123456';
const commentId: string = '7e4a2b1c-1234-5678-90ab-cdef12345678';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptedIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

更新用户页面订阅状态

启用或禁用某个页面的通知。当用户订阅某个页面时，会为新的根评论创建通知，并且也会

参数

名称	类型	必需
tenantId	string	Yes
urlId	string	Yes
url	string	Yes
pageTitle	string	Yes
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Yes
sso	string	No

响应

返回: UpdateUserNotificationStatus200Response

示例

updateUserNotificationPageSubscriptionStatus 示例

Copy

const tenantId: string = 'tenant_7f3b2';
const urlId: string = 'article_987';
const url: string = 'https://www.news-site.com/articles/2026/pasta-guide';
const pageTitle: string = 'The Definitive Guide to Cooking Pasta';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso-token-62b9f1';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

更新用户通知状态

参数

名称	类型	必需
tenantId	string	是
notificationId	string	是
newStatus	UpdateUserNotificationStatusNewStatusEnum	是
sso	string	否

响应

返回: UpdateUserNotificationStatus200Response

示例

updateUserNotificationStatus 示例

Copy

const tenantId: string = 'tenant_5f2a8b9c';
const notificationId: string = 'notif_987654321';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

获取用户在线状态

参数

名称	类型	必填
tenantId	string	是
urlIdWS	string	是
userIds	string	是

响应

返回：GetUserPresenceStatuses200Response

示例

getUserPresenceStatuses 示例

Copy

const tenantId: string = 'tenant_42';
const urlIdWS: string = 'wss://comments.fastsite.com/ws/tenant_42';
const userIds: string = 'user_9012,user_3478';
const includePresenceMetadata: boolean | undefined = true; // 可选参数示例
const presenceStatuses: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

搜索用户

参数

名称	类型	必需
tenantId	string	是
urlId	string	是
usernameStartsWith	string	否
mentionGroupIds	Array	否
sso	string	否
searchSection	SearchUsersSearchSectionEnum	否

响应

返回: SearchUsers200Response

示例

searchUsers 示例

Copy

const tenantId: string = 'tenant_7890';
const urlId: string = 'news/2026-06-15-world-cup-final';
const usernameStartsWith: string = 'mar';
const mentionGroupIds: string[] = ['staff', 'trusted-commenters'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0NTY3OCJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.Commenters;
const response: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

获取用户

参数

名称	类型	必填	描述
tenantId	string	是
id	string	是

响应

返回: GetUser200Response

示例

getUser 示例

Copy

const tenantId: string = 'fastcomments_corp';
const id: string = 'user_9f8b7c6d-5e4a-3b2c-1f0e-123456789abc';
const response: GetUser200Response = await getUser(tenantId, id);
const userEmail: string | undefined = response.user?.email;
const displayName: string | undefined = response.user?.displayName

创建投票

参数

名称	类型	必需
tenantId	string	是
commentId	string	是
direction	CreateVoteDirectionEnum	是
userId	string	否
anonUserId	string	否

响应

返回: VoteComment200Response

示例

createVote 示例

Copy

const tenantId: string = 'fastcomments-tenant-001';
const commentId: string = 'cmt_8f3b2a9d';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const userId: string = 'user_5021';
const anonUserId: string = 'anon_7a9c';
const voteResponse: VoteComment200Response = await createVote(tenantId, commentId, direction, userId, anonUserId);

删除投票

参数

Name	Type	Required
tenantId	string	是
id	string	是
editKey	string	否

响应

返回: DeleteCommentVote200Response

示例

deleteVote 示例

Copy

(async () => {
  const tenantId: string = 'tenant_8421';
  const id: string = 'vote_3f9b7c2a';
  const editKey: string = 'edit_7Xk9LpQ';
  const responseWithoutEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id);
  const responseWithEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
  console.log(responseWithoutEdit, responseWithEdit);
})();

获取投票

参数

名称	类型	必需	描述
tenantId	string	是
urlId	string	是

响应

返回：GetVotes200Response

示例

getVotes 示例

Copy

const tenantId: string = 'tenant_7f8e91c2';
const urlId: string = 'https://www.sportsdaily.com/news/2026/06/15/championship-game-recap';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
console.log(votes);

获取用户的投票

参数

名称	类型	必需
tenantId	string	是
urlId	string	是
userId	string	否
anonUserId	string	否

响应

返回: GetVotesForUser200Response

示例

getVotesForUser 示例

Copy

const tenantId: string = 'tenant_9b8f7c6d';
const urlId: string = 'articles/product-update-2026';
const userId: string = 'user_c12345';
const anonUserId: string = 'anon_7f4e2a';
const votes: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);

需要帮助？

如果您在使用 JavaScript/TypeScript SDK 时遇到任何问题或有疑问，请：

贡献

欢迎贡献！请访问 GitHub 仓库获取贡献指南。

语言 🇨🇳 简体中文

入门

API 参考

文档

使用

聚合

审计日志

从评论中封禁

检查被封禁的评论

评论

用户评论

域配置

邮件模板

事件日志

动态帖子

举报评论

动图

标签

版主

通知计数

通知

页面反应

页面

待处理的 Webhook 事件

问题配置

问题结果

问题结果聚合

SSO 用户

订阅

租户每日使用

租户套餐

租户用户

租户

工单

翻译

上传图片

用户徽章进度

用户徽章

用户通知

用户在线状态

用户搜索

用户

投票

FastComments JavaScript/TypeScript 软件开发工具包

仓库

安装

API 文档

完整的 API 参考： docs/api/README.md

浏览器与服务器兼容性

使用

浏览器 使用（客户端）

服务器 使用（Node.js）

仅类型导入

使用单个 API 类

浏览器环境

服务器环境

公共与受保护的 API

Example: Using Public API (browser-safe)

Example: Using Default API (server-side only)

SSO（单点登录）集成

简单 SSO（仅服务器端）

安全 SSO（服务器端，推荐）

在浏览器中使用 SSO（使用服务器生成的令牌）

带评论创建的 SSO

常见用例

获取页面的评论

创建评论

对评论投票

用户管理（需要 API 密钥）

实时事件（实时更新）

页面级事件

订阅用户事件

获取 userIdWS

广播 ID

错误处理

聚合

参数

响应

示例

获取审计日志

浏览器使用（客户端）

服务器使用（Node.js）