FastComments JavaScript/TypeScript SDK

这是 FastComments 的官方 JavaScript/TypeScript SDK。

FastComments API 的官方 JavaScript/TypeScript SDK

仓库

安装

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 与受保护 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	否

响应

返回：AggregationResponse

获取审计日志

参数

名称	类型	必需
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

响应

返回：GetAuditLogs200Response

示例

getAuditLogs 示例

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_9b8f6c';
  const limit: number = 50;
  const skip: number = 0;
  const order: SORTDIR = 'desc';
  const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000;
  const response: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after);
  console.log(response);
}
main();

从公开评论屏蔽

参数

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

响应

返回: BlockFromCommentPublic200Response

示例

blockFromCommentPublic 示例

Copy

const tenantId: string = "site_7f9b2e";
const commentId: string = "comment_2026-03-25_001";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "Repeated harassment and targeted abuse",
  blockDurationDays: 90,
  includeHistory: true,
  notifyModeratorTeam: true
};
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature";
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

取消公开评论屏蔽

参数

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

响应

返回: UnBlockCommentPublic200Response

示例

unBlockCommentPublic 示例

Copy

const tenantId: string = 'tenant_42e8a1';
const commentId: string = 'cmt_9b3f2d';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'abusive_language',
  blockedByModeratorId: 'mod_17',
  note: 'Targeted harassment; review complete',
  unblockRequestedAt: new Date().toISOString()
};
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

检查被屏蔽的评论

参数

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

响应

返回: CheckedCommentsForBlocked200Response

示例

checkedCommentsForBlocked 示例

Copy

const tenantId: string = 'tenant_4f3b2a1e';
const commentIds: string = 'c_1001,c_1002,c_1003';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.Sf4ke7nQP3mZx9v2';
const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

从评论屏蔽用户

参数

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

响应

返回: BlockFromCommentPublic200Response

示例

blockUserFromComment 示例

Copy

const tenantId: string = "tenant_12345";
const id: string = "comment_67890";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated abusive language",
  blockDurationHours: 168,
  blockReplies: true,
  notifyAuthor: true
};
const userId: string = "user_abc123";
const anonUserId: string = "anon_xyz789";
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_prod_42';
const urlId: string = 'article-2026-03-25-tech-deep-dive';
const broadcastId: string = 'live-broadcast-001';
const sessionId: string = 'sess_9f8e7d6a3b';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const commentData: CommentData = {
  content: 'Great reporting — appreciated the depth on performance tradeoffs.',
  authorName: 'Jordan M.',
  language: 'en-US',
  metadata: { client: 'web' }
};
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_7b3f2a';
const commentId: string = 'cmt_8a1f4d2b';
const contextUserId: string = 'user_102';
const isLive: boolean = true;
const result: DeleteComment200Response = await deleteComment(tenantId, commentId, contextUserId, isLive);

删除公开评论

参数

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

响应

返回: DeleteCommentPublic200Response

示例

deleteCommentPublic 示例

Copy

const tenantId: string = 'tenant_4f2c9b';
const commentId: string = 'comment-7c3a9f2d';
const broadcastId: string = 'article-2026-03-20';
const editKey: string | undefined = 'ek_pub_abc12345';
const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';
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 = 'acme-tenant-87e4fd';
const commentId: string = 'cmt-9a12b3f4';
const voteId: string = 'vote-4f6d21b9';
const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';
const broadcastId: string = 'broadcast-20260325-01';
const editKey: string = 'editkey-6b7c8d9e';
const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: 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_acme_001';
const id: string = 'comment_7f3a2b9e';
const userId: string = 'user_jdoe_1001';
const anonUserId: string = 'anon_3f2b_visitor';
const result: FlagComment200Response = await flagComment(tenantId, id, userId, anonUserId);

获取评论

参数

Name	Type	Required	Description
tenantId	string	是
id	string	是

响应

返回： GetComment200Response

示例

getComment 示例

Copy

const tenantId: string = "acme-publishing-001";
const commentId: string = "f3b2c1d0-9a8e-4b7c-8123-6d5f0a1e2b3c";
const result: GetComment200Response = await getComment(tenantId, commentId);
const wrapper: GetComment200Response & { comment?: APIComment } = result;
const comment: APIComment | undefined = wrapper.comment;
const authorBadge: CommentUserBadgeInfo | undefined = comment?.user?.badge;
const userHashTags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashTags

获取评论列表

参数

Name	Type	Required
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	否

响应

返回: GetComments200Response

示例

getComments 示例

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // 页码
  20, // 每页数量
  0, // 跳过
  true, // 是否以树形
  1, // 跳过子评论
  3, // 子评论限制
  4, // 最大树深度
  'articles/2026/new-product-launch', // URL 标识
  'user_7890', // 用户 ID
  'anon_4f3b2', // 匿名用户 ID
  undefined, // 上下文用户 ID
  '#launch', // 话题标签
  undefined // 父评论 ID
);

获取公开评论

req tenantId urlId

参数

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

响应

返回：GetCommentsPublic200Response

示例

getCommentsPublic 示例

Copy

const tenantId: string = 'tenant_eu-west_01';
const urlId: string = 'https://www.financialtimes.com/articles/2026/market-update-q1';
const response: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  2,
  undefined,
  'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.tokenPayload.signature',
  undefined,
  0,
  50,
  5,
  true,
  undefined,
  true,
  false,
  true,
  'en-US',
  'reactions,moderation',
  false,
  true,
  true,
  3,
  false,
  undefined,
  'performance',
  ['feature','fastcomments'],
  'user_9876',
  undefined,
  undefined,
  undefined
);

获取评论文本

参数

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

响应

返回：GetCommentText200Response

示例

getCommentText 示例

Copy

const tenantId: string = 'tenant_acme_001';
const commentId: string = 'cmt_7890b';
const editKey: string = 'edit_4f2d9b7c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

获取评论投票用户名

参数

名称	类型	必需
tenantId	string	Yes
commentId	string	Yes
dir	number	Yes
sso	string	No

响应

返回: GetCommentVoteUserNames200Response

示例

getCommentVoteUserNames 示例

Copy

(async () => {
  const tenantId: string = 'tenant_4f2c1e';
  const commentId: string = 'cmt_9a7b3d';
  const dir: number = 1;
  const resultUpvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature';
  const dirDown: number = -1;
  const resultDownvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dirDown, sso);
  console.log(resultUpvotes, resultDownvotes);
})();

锁定评论

参数

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

响应

返回: LockComment200Response

示例

lockComment 示例

Copy

const tenantId: string = "tenant_prod_8f3a2b";
const commentId: string = "cmt_5d7e9a92";
const broadcastId: string = "broadcast_2026_03_25_1400";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const resultWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const resultWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

置顶评论

参数

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

响应

返回: PinComment200Response

示例

pinComment 示例

Copy

const tenantId: string = "tenant_4f2b9a";
const commentId: string = "cmt_9f8e7d6c";
const broadcastId: string = "brd_live_concert_2026-03-25";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload_signature";
const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

保存评论

参数

名称	类型	必填
tenantId	string	是
createCommentParams	CreateCommentParams	是
isLive	boolean	否
doSpamCheck	boolean	否
sendEmails	boolean	否
populateNotifications	boolean	否

响应

返回: SaveComment200Response

示例

saveComment 示例

Copy

const tenantId: string = 'tenant_acme_001';
const createCommentParams: CreateCommentParams = {
  content: 'Great article — helped me fix a production issue in minutes.',
  url: 'https://app.acme.com/blog/performance-tips',
  author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },
  metadata: { locale: 'en-US', appVersion: '4.2.1' }
} as CreateCommentParams;
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 = 'acme-corp-01';
const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];
const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: 'Great insights on async/await patterns.',
    authorName: 'John Smith',
    authorEmail: 'john.smith@acme.com',
    externalId: 'comment-001',
    createdAt: '2026-03-25T10:15:00Z',
    userMentions: mentions1,
    userHashTags: hashtags1
  },
  {
    content: 'I prefer using Promise.all for bulk ops.',
    authorName: 'Emily Turner',
    authorEmail: 'emily.turner@acme.com',
    externalId: 'comment-002',
    createdAt: '2026-03-25T10:20:00Z'
  }
];
const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

设置评论文本

参数

Name	Type	Required
tenantId	string	是
commentId	string	是
broadcastId	string	是
commentTextUpdateRequest	CommentTextUpdateRequest	是
editKey	string	否
sso	string	否

响应

返回：SetCommentText200Response

示例

setCommentText 示例

Copy

const tenantId: string = 'tenant_6721f4';
const commentId: string = 'cmt_9a3b2d';
const broadcastId: string = 'live_2026_03_25';
const editKey: string = 'edit_k_4f7b9';
const sso: string = 'sso_tok_eyJhbGciOiJIUzI1';
const commentTextUpdateRequest: CommentTextUpdateRequest = {
  text: 'Updated to clarify the timeline and link the relevant docs.',
  mentions: [{ userId: 'user_102', displayName: 'Alex Rivera' }],
  hashtags: [{ tag: 'product-update' }]
};
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_87f3e1';
const id: string = 'comment_9b2a4f';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'Reviewed by moderation team — reinstated',
  moderatorId: 'mod_21',
  unblockedAt: new Date().toISOString()
};
const userId: string = 'user_42';
const anonUserId: string = 'anon_e7f9';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

取消标记评论

参数

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

响应

返回：FlagComment200Response

示例

unFlagComment 示例

Copy

const tenantId: string = 'acme-tenant-001';
const commentId: string = 'cmt_9f8e7d6c';
const userId: string = 'user_72b4a1c9';
const anonUserId: string = 'anon_3d2c1b0a';
const response: FlagComment200Response = await unFlagComment(tenantId, commentId, userId, anonUserId);

解锁评论

参数

Name	Type	Required
tenantId	string	是
commentId	string	是
broadcastId	string	是
sso	string	否

响应

返回：LockComment200Response

示例

unLockComment 示例

Copy

const tenantId: string = 'tenant_9d4f2b';
const commentId: string = 'cmt_8a3e1f';
const broadcastId: string = 'broadcast_2026_03_25';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

取消置顶评论

参数

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

响应

返回：PinComment200Response

示例

unPinComment 示例

Copy

const tenantId: string = 'tenant_7f9d2a3b';
const commentId: string = 'comment_842b9c1f';
const broadcastId: string = 'bcast_frontpage_202603';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

更新评论

参数

Name	Type	必需
tenantId	string	是
id	string	是
updatableCommentParams	UpdatableCommentParams	是
contextUserId	string	否
doSpamCheck	boolean	否
isLive	boolean	否

响应

返回: FlagCommentPublic200Response

示例

updateComment 示例

Copy

const tenantId: string = "tenant_acme_corp_01";
const id: string = "comment_20260325_4592";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Updated the response to include a link to the RFC and fixed a typo in the second paragraph.",
  editedByUserId: "user_8721",
  isVisible: true
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

对评论投票

参数

Name	Type	Required
tenantId	string	是
commentId	string	是
urlId	string	是
broadcastId	string	是
voteBodyParams	VoteBodyParams	是
sessionId	string	否
sso	string	否

响应

返回: VoteComment200Response

示例

voteComment 示例

Copy

const tenantId: string = 'tenant_9f8b7c';
const commentId: string = 'cmt_42f3a1';
const urlId: string = 'articles/ai-trends-2026';
const broadcastId: string = 'web';
const voteBodyParams: VoteBodyParams = { vote: 1, reason: 'Insightful and on-topic' };
const sessionId: string = 'sess_6d2b4c9e';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

添加域配置

参数

名称	类型	必需	说明
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

创建邮件模板

参数

Name	Type	Required	Description
tenantId	string	是
createEmailTemplateBody	CreateEmailTemplateBody	是

响应

返回: CreateEmailTemplate200Response

示例

createEmailTemplate 示例

Copy

const tenantId: string = "tenant_7a9f3c2b";
const customConfig: CustomConfigParameters = { smtpHost: "smtp.fastmail.com", smtpPort: 587, useTLS: true };
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "Account Notification",
  subject: "Your ACME account was updated",
  fromEmail: "no-reply@acme-corp.com",
  replyTo: "support@acme-corp.com",
  html: "<p>Hi {{user.firstName}}, your account settings were changed.</p>",
  text: "Hi {{user.firstName}}, your account settings were changed.",
  isActive: true,
  description: "Used for transactional account update emails",
  customConfig
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

删除邮件模板

参数

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

响应

返回: FlagCommentPublic200Response

示例

deleteEmailTemplate 示例

Copy

const tenantId: string = 'tenant_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // 可选参数示例
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

删除邮件模板渲染错误

参数

Name	Type	Required
tenantId	string	是
id	string	是
errorId	string	是

响应

返回: FlagCommentPublic200Response

示例

deleteEmailTemplateRenderError 示例

Copy

const tenantId: string = 'tenant_7f3b4c2a';
const templateEnvironment: string | undefined = 'production'; // 可选的环境选择器
const id: string = `emailTemplates/${templateEnvironment ?? 'staging'}/welcome_v2`;
const errorId: string = 'err_5a9d2f1c';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
console.log(result);

获取邮件模板

参数

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

响应

返回：GetEmailTemplate200Response

示例

getEmailTemplate 示例

Copy

const tenantId: string = "acme-marketing-042";
const templateId: string = "tpl_welcome_2026";
const result: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);
const template: CustomEmailTemplate | undefined = result.template;
const subject: string | undefined = template?.subject;
const customParams: CustomConfigParameters | undefined = template?.customConfigParameters;

获取邮件模板定义

参数

名称	类型	必填	描述
tenantId	string	是

响应

返回: GetEmailTemplateDefinitions200Response

示例

getEmailTemplateDefinitions 示例

Copy

const tenantId: string = 'tenant_acme_eu_01';
const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);
console.log('Email template definitions loaded for', tenantId, templates);

获取邮件模板渲染错误

参数

Name	Type	Required
tenantId	string	是
id	string	是
skip	number	否

响应

返回：GetEmailTemplateRenderErrors200Response

示例

getEmailTemplateRenderErrors 示例

Copy

(async () => {
  const tenantId: string = 'acme-tenant-42';
  const id: string = 'tmpl_3fa85f64-5717-4562-b3fc-2c963f66afa6';
  const skip: number = 20;
  const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
  console.log(result);
})();

获取邮件模板列表

参数

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

响应

返回： GetEmailTemplates200Response

示例

getEmailTemplates 示例

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_5f3a9c2b';
  const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const skip: number = 20;
  const pagedTemplates: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);
  console.log(templates, pagedTemplates);
}
main();

渲染邮件模板

参数

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

响应

返回：RenderEmailTemplate200Response

示例

renderEmailTemplate 示例

Copy

const tenantId: string = 'tenant_b6f3c2';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'comment-notification',
  recipient: { name: 'Ava Thompson', email: 'ava.thompson@publisher.com' },
  context: {
    siteName: 'City Gazette',
    commentText: 'Thanks for the in-depth coverage — very helpful.',
    articleTitle: 'Downtown Redevelopment Plan Advances',
    threadUrl: 'https://citygazette.example/articles/2026/redevelopment#comments'
  }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

更新邮件模板

参数

名称	类型	必填
tenantId	string	是
id	string	是
updateEmailTemplateBody	UpdateEmailTemplateBody	是

响应

返回: FlagCommentPublic200Response

示例

updateEmailTemplate 示例

Copy

const tenantId: string = "tenant_76a4b2";
const id: string = "template_9f3c1e";
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: "Comment Flag Notification",
  subject: "A comment was flagged on your-site.com",
  bodyHtml: "<p>Admin,</p><p>User {{commenterName}} flagged a comment: “{{commentText}}”</p>",
  isEnabled: true,
  description: "Email sent to moderators when a comment is flagged (optional field included)"
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

获取事件日志

req tenantId urlId userIdWS

参数

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

响应

返回：GetEventLog200Response

示例

getEventLog 示例

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // 可选的上游值
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  startTime,
  endTime
);

获取全局事件日志

req tenantId urlId userIdWS

参数

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

响应

返回: GetEventLog200Response

示例

getGlobalEventLog 示例

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7 天前
const endTimeOptional: number | undefined = undefined; // 可选的时间范围结束
const endTime: number = endTimeOptional ?? 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_7f3b9a";
const createFeedPostParams: CreateFeedPostParams = {
  title: "Weekly Product Update — March 2026",
  body: "We've shipped performance improvements and bug fixes across the web client. See the release notes for details.",
  authorId: "user_86fa2b",
  allowComments: true,
  media: [
    {
      url: "https://cdn.example.com/images/update-march.png",
      mimeType: "image/png",
      caption: "Performance graph",
      assets: [{ url: "https://cdn.example.com/images/update-march@2x.png", width: 1600, height: 900 }]
    }
  ],
  links: [{ url: "https://www.example.com/release-notes/march-2026", title: "Release notes" }]
};
const broadcastId: string = "broadcast_prod_updates_202603";
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

创建公开动态帖子

参数

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

响应

返回: CreateFeedPostPublic200Response

示例

createFeedPostPublic 示例

Copy

const tenantId: string = "tenant_987654321";
const asset: FeedPostMediaItemAsset = { url: "https://cdn.fastcomments.com/uploads/team-photo.jpg", mimeType: "image/jpeg", sizeBytes: 324512 };
const mediaItem: FeedPostMediaItem = { type: "image", assets: [asset], caption: "Team launch day" };
const link: FeedPostLink = { url: "https://www.example.com/blog/product-update-march-2026", title: "Product update — March 2026" };
const createFeedPostParams: CreateFeedPostParams = {
  title: "Product update — March 2026",
  content: "<p>We shipped performance improvements and two new integrations.</p>",
  media: [mediaItem],
  link,
  visibility: "public",
  tags: ["product","release","march-2026"],
  customConfig: { allowComments: true, requireTOS: false }
};
const broadcastId: string = "broadcast_2026_03_25_live";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSIsImlhdCI6MTY5MDI0MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

删除公开动态帖子

参数

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

响应

返回: DeleteFeedPostPublic200Response

示例

deleteFeedPostPublic 示例

Copy

const tenantId: string = "tenant_5f8a9b3c";
const postId: string = "post_a1b2c3d4";
const broadcastId: string = "broadcast_2026-03-25T10:00:00Z";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIiwiaWF0IjoxNjE5MjM5MjAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resultWithOptional: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
const resultRequiredOnly: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId);

获取动态帖子

req tenantId afterId

参数

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

响应

返回: GetFeedPosts200Response

示例

getFeedPosts 示例

Copy

const initialPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', undefined, 20, ['sports', 'local']);
const nextPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', 'post_abc123', 20, ['sports', 'local']);

获取公开动态帖子

请求 tenantId afterId

参数

Name	Type	Required
tenantId	string	是
afterId	string	否
limit	number	否
tags	Array	否
sso	string	否
isCrawler	boolean	否
includeUserInfo	boolean	否

响应

返回: GetFeedPostsPublic200Response

示例

getFeedPostsPublic 示例

Copy

const tenantId: string = 'tenant_acme_01';
const afterId: string = 'fp_20260301_042';
const limit: number = 25;
const tags: Array<string> = ['technology', 'announcement'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

获取动态帖子统计

参数

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

响应

返回：GetFeedPostsStats200Response

示例

getFeedPostsStats 示例

Copy

const tenantId: string = 'tenant_9b2f1c4a';
const postIds: Array<string> = [
  '8f14e45f-ea82-4c7a-b6b2-1a2b3c4d5e6f',
  'd0e1f2a3-b4c5-6d7e-8f90-1234567890ab'
];
const sso: string = 'sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

获取用户公开反应

参数

Name	Type	Required
tenantId	string	是
postIds	Array	否
sso	string	否

响应

返回: GetUserReactsPublic200Response

示例

getUserReactsPublic 示例

Copy

const tenantId: string = "acme-tenant-8a4d2c";
const postIds: string[] = ["post-645a2f", "post-645a30"];
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY2MTYwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

对公开动态帖子做出反应

参数

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

响应

返回: ReactFeedPostPublic200Response

示例

reactFeedPostPublic 示例

Copy

const tenantId: string = 'd290f1ee-6c54-4b01-90e6-d701748f0851';
const postId: string = 'c1a2b3d4-5678-90ab-cdef-1234567890ab';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍', source: 'web' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast-2026-03-25-001';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, sso);

更新动态帖子

参数

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

响应

返回：FlagCommentPublic200Response

示例

updateFeedPost 示例

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // 包含可选数组
  links: [link],          // 包含可选链接
  isPublished: true       // 这里使用了可选的发布标志
};
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_9f4b2";
const postId: string = "post_21a8e";
const updateFeedPostParams: UpdateFeedPostParams = {
  title: "Quarterly product update",
  body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",
  links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],
  media: [
    {
      type: "image",
      assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]
    }
  ]
};
const broadcastId: string = "broadcast_live_202603";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
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_9f8b3c";
const commentId: string = "comment_72a1d4";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

添加话题标签

参数

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

响应

返回: AddHashTag200Response

示例

addHashTag 示例

Copy

const tenantId: string = 'tenant_acme_01';
const createHashTagBody: CreateHashTagBody = {
  name: 'feature-request',
  label: 'Feature Request',
  color: '#FF5722',
  enabled: true
};
const response: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);
const responseWithoutTenant: AddHashTag200Response = await addHashTag(undefined, createHashTagBody);

批量添加话题标签

参数

Name	Type	Required	Description
tenantId	string	否
bulkCreateHashTagsBody	BulkCreateHashTagsBody	否

响应

返回：AddHashTagsBulk200Response

示例

addHashTagsBulk 示例

Copy

// 创建租户标识符（可选参数）
const tenantId: string = "tenant_9f8c2b7a";
// 准备单个标签条目
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// 批量创建主体（可选参数）
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// 调用全局异步函数并将结果赋予类型化变量
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

删除话题标签

参数

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

响应

返回: FlagCommentPublic200Response

示例

deleteHashTag 示例

Copy

const tag: string = "breaking-news";
const tenantId: string = "tenant_12345";
const deleteRequest: DeleteHashTagRequest = { initiatedBy: "moderator@newsorg.com", purgeAllOccurrences: true };
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteRequest);

获取话题标签

参数

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

响应

返回: GetHashTags200Response

示例

getHashTags 示例

Copy

const tenantId: string = 'acme-tenant-42';
const pageNumber: number = 2;
const responseWithPage: GetHashTags200Response = await getHashTags(tenantId, pageNumber);
const responseWithoutPage: GetHashTags200Response = await getHashTags(tenantId);

部分更新话题标签

参数

名称	类型	必需
tag	string	是
tenantId	string	否
updateHashTagBody	UpdateHashTagBody	否

响应

返回：PatchHashTag200Response

示例

patchHashTag 示例

Copy

const tag: string = "feature-ux-refresh";
const tenantId: string = "tenant_4f92c1";
const updateHashTagBody: UpdateHashTagBody = {
  label: "UX Refresh",
  description: "Track comments related to the 2026 UX redesign",
  isActive: true,
  metadata: { owner: "product-design", rolloutPhase: "phase-2" }
};
const response: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

创建版主

参数

Name	Type	Required	Description
tenantId	string	是
createModeratorBody	CreateModeratorBody	是

响应

返回: CreateModerator200Response

示例

createModerator 示例

Copy

const tenantId: string = 'tenant_7d9f2b4a';
const customConfig: CustomConfigParameters = { timezone: 'UTC', moderationQueueEnabled: true };
const createModeratorBody: CreateModeratorBody = {
  email: 'jane.martin@publisher.com',
  displayName: 'Jane Martin',
  roles: ['moderator'],
  sendWelcomeEmail: true,
  customConfig
};
const response: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

删除版主

参数

名称	类型	必填
tenantId	string	是
id	string	是
sendEmail	string	否

响应

返回：FlagCommentPublic200Response

示例

deleteModerator 示例

Copy

const tenantId: string = 'tenant_9f3b2d4a6c';
const moderatorId: string = 'moderator_84a1b9c2';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, moderatorId, sendEmail);

获取版主

参数

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

响应

返回：GetModerator200Response

示例

getModerator 示例

Copy

const tenantId: string = 'acme-corp-tenant-123';
const id: string = 'mod-987654321';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

获取版主列表

参数

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

响应

返回: GetModerators200Response

示例

getModerators 示例

Copy

const tenantId: string = 'tenant-12345-prod';
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

发送邀请

参数

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

响应

返回: FlagCommentPublic200Response

示例

sendInvite 示例

Copy

const tenantId: string = 'tenant_acme-42';
const id: string = 'comment_8f3b21a7';
const fromName: string = 'Elena Morales';
const replyToEmail: string | undefined = undefined;
const result: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName, replyToEmail);

更新版主

参数

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

响应

返回: FlagCommentPublic200Response

示例

updateModerator 示例

Copy

const tenantId: string = "acme-enterprises-42";
const id: string = "moderator_517";
const updateModeratorBody: UpdateModeratorBody = {
  displayName: "Sofia Martinez",
  email: "sofia.martinez@acme.com",
  permissions: ["approve_comments", "flag_spam", "suspend_users"],
  active: true,
  avatarUrl: "https://cdn.acme.com/avatars/sofia.jpg" // 可选字段示例
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

删除通知计数

参数

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

响应

返回：FlagCommentPublic200Response

示例

deleteNotificationCount 示例

Copy

const tenantSuffix: string | undefined = undefined;
const tenantId: string = tenantSuffix ? `tenant-${tenantSuffix}` : 'tenant-9142a7';
const id: string = '3f9b2a44-1c2e-4d3b-9f6a-8e7c6d5b2a1f';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
console.log(result);

获取缓存的通知计数

参数

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

响应

返回: GetCachedNotificationCount200Response

示例

getCachedNotificationCount 示例

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // 可选参数标志（示例）
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

获取通知计数

参数

名称	类型	必需
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

响应

返回： GetNotificationCount200Response

示例

getNotificationCount 示例

Copy

const tenantId: string = 'tenant_abc123';
const userId: string = 'user_987654321';
const urlId: string = 'https://example.com/news/2026/new-features';
const viewed: boolean = false;
const type: string = 'reply';
const notificationCountResponse: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, undefined, viewed, type);

获取通知

参数

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

响应

返回: GetNotifications200Response

示例

getNotifications 示例

Copy

const tenantId: string = "tenant_84b3f2";
const userId: string = "user_1279";
const urlId: string = "https://www.example.com/articles/2026/03/25/new-feature";
const fromCommentId: string = "cmt_5421";
const viewed: boolean = false;
const type: string = "mention";
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

更新通知

参数

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

响应

返回: FlagCommentPublic200Response

示例

updateNotification 示例

Copy

const tenantId: string = 'tenant_prod_8f4b2c';
const id: string = 'notification_61a2e9';
const userId: string = 'moderator_107';
const updateNotificationBody: UpdateNotificationBody = {
  name: 'Flagged Comment Notification',
  enabled: true,
  channels: ['email', 'inbox'],
  templateId: 'tmpl_mod_alerts_01',
  severity: 'high'
};
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

添加页面

参数

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

响应

返回: AddPageAPIResponse

删除页面

参数

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

响应

返回: DeletePageAPIResponse

通过 URL ID 获取页面

参数

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

响应

返回：GetPageByURLIdAPIResponse

获取页面列表

参数

名称	类型	必填	描述
tenantId	string	是

响应

返回: GetPagesAPIResponse

部分更新页面

参数

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

响应

返回： PatchPageAPIResponse

删除待处理的 Webhook 事件

参数

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

响应

返回: FlagCommentPublic200Response

示例

deletePendingWebhookEvent 示例

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // 可选参数示例（函数不需要）
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

获取待处理 Webhook 事件计数

参数

Name	Type	Required
tenantId	string	是
commentId	string	否
externalId	string	否
eventType	string	否
type	string	否
domain	string	否
attemptCountGT	number	否

响应

返回: GetPendingWebhookEventCount200Response

示例

getPendingWebhookEventCount 示例

Copy

const tenantId: string = "tenant_8d3b7a2f";
const commentId: string | undefined = "comment_79a2b";
const eventType: string | undefined = "comment.created";
const domain: string | undefined = "forum.acme-corp.com";
const attemptCountGT: number | undefined = 1;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  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_9b3f7c';
const commentId: string | undefined = undefined;
const externalId: string | undefined = 'external-572a';
const eventType: string | undefined = 'comment.updated';
const type: string | undefined = 'outbound';
const domain: string | undefined = 'reviews.example.com';
const attemptCountGT: number | undefined = 1;
const skip: number | undefined = 20;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

创建问题配置

参数

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

响应

返回: CreateQuestionConfig200Response

示例

createQuestionConfig 示例

Copy

const tenantId: string = "tenant_9f8b2c";
const option: QuestionConfigCustomOptionsInner = { id: "opt_yes", label: "Yes, helpful", value: "yes" };
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Article usefulness",
  prompt: "Was this article helpful?",
  type: "singleChoice",
  required: false, // 演示可选参数
  options: [option],
  saveBehavior: "immediate"
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

删除问题配置

参数

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

响应

返回: FlagCommentPublic200Response

示例

deleteQuestionConfig 示例

Copy

const tenantId: string = "acme-enterprises-01";
const idOptional: string | undefined = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const id: string = idOptional ?? "11111111-1111-1111-1111-111111111111";
const response: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

获取问题配置

参数

Name	Type	Required	Description
tenantId	string	是
id	string	是

响应

返回: GetQuestionConfig200Response

示例

getQuestionConfig 示例

Copy

const tenantId: string = 'acme-tenant-92';
const id: string = 'question-2026-07-42';
const response: GetQuestionConfig200Response = await getQuestionConfig(tenantId, id);
function summarize(cfg: GetQuestionConfig200Response, includeDetails?: boolean): string {
  return includeDetails ? 'Question config (detailed)' : 'Question config (summary)';
}
const summary: string = summarize(response);

获取问题配置列表

参数

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

响应

返回: GetQuestionConfigs200Response

示例

getQuestionConfigs 示例

Copy

const tenantId: string = "tenant_acme_9876";
const configsWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const configsWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 20);

更新问题配置

参数

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

响应

返回: FlagCommentPublic200Response

示例

updateQuestionConfig 示例

Copy

const tenantId: string = 'tenant_42e8b';
const id: string = 'question_9f4a2';
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  questionText: 'How helpful was this article?',
  description: 'Shown to users below the question (optional)',
  required: true,
  renderingType: 'Likert' as QuestionRenderingType,
  customOptions: [
    { label: 'Very helpful', value: '5' } as QuestionConfigCustomOptionsInner,
    { label: 'Somewhat helpful', value: '3' } as QuestionConfigCustomOptionsInner,
    { label: 'Not helpful', value: '1' } as QuestionConfigCustomOptionsInner
  ],
  whenSave: 'notify' as QuestionWhenSave
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

创建问题结果

参数

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

响应

返回: CreateQuestionResult200Response

示例

createQuestionResult 示例

Copy

const tenantId: string = "tenant-72b1f4";
const meta: MetaItem[] = [{ key: "platform", value: "web" }];
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "question-83472",
  commenterId: "user-5521",
  answers: [{ subQuestionId: "sq-1", value: "Yes" }],
  meta, // 可选的元数据
  note: "Follow-up requested" // 演示可选参数
};
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

删除问题结果

参数

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

响应

返回: FlagCommentPublic200Response

示例

deleteQuestionResult 示例

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // 可选参数，演示备用目标选择
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

获取问题结果

参数

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

响应

返回：GetQuestionResult200Response

示例

getQuestionResult 示例

Copy

const post: { title: string; questionId?: string } = { title: 'Product feedback' };
const tenantId: string = 'acme-corp-tenant-01';
const id: string = post.questionId ?? 'q-8f3a7b2c4d9e';
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);

获取问题结果列表

参数

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

响应

返回：GetQuestionResults200Response

示例

getQuestionResults 示例

Copy

const tenantId: string = "tenant_acme_001";
const urlId: string = "articles/product-launch-2026";
const userId: string = "user_2048";
const startDate: string = "2026-03-01T00:00:00Z";
const questionId: string | undefined = undefined;
const questionIds: string | undefined = "q_101,q_102";
const skip: number | undefined = 0;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

更新问题结果

参数

Name	Type	Required
tenantId	string	是
id	string	是
updateQuestionResultBody	UpdateQuestionResultBody	是

响应

返回: FlagCommentPublic200Response

示例

updateQuestionResult 示例

Copy

const tenantId: string = 'tenant_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // 可选元数据
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
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_acme_98765';
const questionIds: Array<string> = ['q-102', 'q-103'];
const urlId: string = 'url_55b3';
const timeBucket: AggregateTimeBucket = { unit: 'day', size: 7 };
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined, // 省略 questionId，改用 questionIds
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

批量聚合问题结果

参数

名称	类型	必填
tenantId	string	是
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	是
forceRecalculate	boolean	否

响应

返回：BulkAggregateQuestionResults200Response

示例

bulkAggregateQuestionResults 示例

Copy

const tenantId: string = "tenant_live_7c9d";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    { questionId: "q_feedback_rating", includeSubQuestions: false, filters: { locale: "en-US" } }
  ],
  timeBuckets: [
    { granularity: "day", startUtc: "2026-03-01T00:00:00Z", endUtc: "2026-03-15T00:00:00Z" }
  ]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

将评论与问题结果合并

参数

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

响应

返回: CombineCommentsWithQuestionResults200Response

示例

combineCommentsWithQuestionResults 示例

Copy

const tenantId: string = 'tenant_9f3a2';
const questionIds: string[] = ['question-42', 'question-43'];
const urlId: string = 'url_5d7b';
const startDate: Date = new Date('2026-02-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  undefined,
  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

创建订阅

参数

Name	Type	Required	Description
tenantId	string	是
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	是

响应

返回：CreateSubscriptionAPIResponse

示例

createSubscription 示例

Copy

const tenantId: string = "acme-corp-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "u_987654",
  planId: "pro_monthly",
  startDate: new Date().toISOString(),
  trialDays: 14, // 可选参数示例
  metadata: { source: "marketing-email" } // 可选参数示例
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);
const subscription: APIUserSubscription = result.subscription;

删除订阅

参数

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

响应

返回: DeleteSubscriptionAPIResponse

获取订阅

参数

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

响应

返回: GetSubscriptionsAPIResponse

示例

getSubscriptions 示例

Copy

const tenantId: string = 'tenant_acme_corp_01';
const userId: string = 'user_76a3b9f2';
const subscriptionsForUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
const subscriptionsForTenant: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);

更新订阅

参数

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_5f4a3b2c-1d6e-4f9a-b9d8-123456789abc';
const yearNumber: number = 2026;
const monthNumber: number = 3;
const dayNumber: number = 24;
const skip: number = 0;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, dayNumber, skip);

创建租户套餐

参数

Name	Type	Required	Description
tenantId	string	是
createTenantPackageBody	CreateTenantPackageBody	是

响应

返回: CreateTenantPackage200Response

示例

createTenantPackage 示例

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // 提供的可选参数
  // optional fields omitted: e.g., advanced moderation rules, custom CSS
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // 示例值；使用 CustomConfigParameters 结构
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

删除租户套餐

参数

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

响应

返回：FlagCommentPublic200Response

示例

deleteTenantPackage 示例

Copy

const tenantId: string = 'tenant_acme_corp_987';
const packageId: string = 'pkg_pro_2026_01';
type DeleteOptions = { force?: boolean; notify?: boolean };
const options: DeleteOptions = { force: true }; // 可选参数示例
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

获取租户套餐

参数

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

响应

返回：GetTenantPackage200Response

示例

getTenantPackage 示例

Copy

const tenantId: string = 'tenant_7f3b2c8';
const packageId: string = 'pkg_standard_2026';
const requestOptions: { includeConfig?: boolean } = { includeConfig: true };
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

获取租户套餐列表

参数

Name	Type	Required	Description
tenantId	string	是
skip	number	否

响应

返回: GetTenantPackages200Response

示例

getTenantPackages 示例

Copy

const tenantId: string = "tenant_7f8e3b4c";
const skip: number = 20;
const packagesDefault: GetTenantPackages200Response = await getTenantPackages(tenantId);
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

替换租户套餐

参数

名称	类型	必需
tenantId	string	是
id	string	是
replaceTenantPackageBody	ReplaceTenantPackageBody	是

响应

返回: FlagCommentPublic200Response

示例

replaceTenantPackage 示例

Copy

const tenantId: string = "tenant-9f3c2a";
const id: string = "pkg_4f8b21";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  packageName: "Premium Moderation Pack",
  enabled: true,
  apiStatus: { mode: "active" } as APIStatus,
  customConfigParameters: { maxFlagsBeforeReview: 5 } as CustomConfigParameters,
  voteStyle: "thumbs" as VoteStyle,
  tosConfig: { requireAcceptance: true } as TOSConfig
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

更新租户套餐

参数

Name	Type	Required
tenantId	string	是
id	string	是
updateTenantPackageBody	UpdateTenantPackageBody	是

响应

返回：FlagCommentPublic200Response

示例

updateTenantPackage 示例

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // 有意省略可选字段 (例如, description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

创建租户用户

参数

名称	类型	必填	描述
tenantId	string	是
createTenantUserBody	CreateTenantUserBody	是

响应

返回: CreateTenantUser200Response

示例

createTenantUser 示例

Copy

const tenantId: string = 'tenant_6f4b2c';
const createTenantUserBody: CreateTenantUserBody = {
  email: 'sara.kim@example.com',
  displayName: 'Sara Kim',
  role: 'moderator',
  notifyOnMentions: true
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

删除租户用户

参数

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

响应

返回: FlagCommentPublic200Response

示例

deleteTenantUser 示例

Copy

const tenantId: string = '4f3a9b2e-1c6a-4f7b-9e2a-0b8d6f1c2a3e';
const userId: string = '9d2f7b3a-5c4e-48a2-b1f0-6c7d8e9f0a12';
const deleteComments: string = 'true';
const commentDeleteMode: string = 'permanent';
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, userId, deleteComments, commentDeleteMode);

获取租户用户

参数

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

响应

返回： GetTenantUser200Response

示例

getTenantUser 示例

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // 访问有效负载
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

获取租户用户列表

参数

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

响应

返回: GetTenantUsers200Response

示例

getTenantUsers 示例

Copy

const tenantId: string = 'tenant_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

替换租户用户

参数

名称	类型	必需
tenantId	string	是
id	string	是
replaceTenantUserBody	ReplaceTenantUserBody	是
updateComments	string	否

响应

返回: FlagCommentPublic200Response

示例

replaceTenantUser 示例

Copy

const tenantId: string = 'tenant_9d8f4b2c';
const id: string = 'user_f47ac10b';
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: 'ext-5234',
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  metadata: { department: 'product', region: 'us-east-1' }
};
const updateComments: string = 'propagate-display-name-to-comments';
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

发送登录链接

参数

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

响应

返回: FlagCommentPublic200Response

示例

sendLoginLink 示例

Copy

const tenantId: string = "tenant_12a9f3b7";
const id: string = "user_84b2c7d1";
const redirectURL: string = "https://app.mycompany.com/welcome?ref=login_email";
const resultWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);
const resultWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

更新租户用户

参数

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

响应

返回：FlagCommentPublic200Response

示例

updateTenantUser 示例

Copy

const tenantId: string = "tenant_8f3b2a9d";
const id: string = "user_52c9f1ab";
const updateTenantUserBody: UpdateTenantUserBody = {
  email: "jane.doe@example.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  isActive: true,
  metadata: { signupSource: "sso", locale: "en-US" }
};
const updateComments: string = "Promoted to moderator and updated display name";
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

创建租户

参数

Name	Type	Required	Description
tenantId	string	是
createTenantBody	CreateTenantBody	是

返回: CreateTenant200Response

示例

createTenant 示例

Copy

const tenantId: string = "acme-corp-001";
const createTenantBody: CreateTenantBody = {
  name: "Acme Corporation",
  domain: "comments.acme.com",
  adminContact: { name: "Jane Doe", email: "jane.doe@acme.com" },
  billingInfo: { planId: "pro-monthly", billingContactEmail: "billing@acme.com" },
  importedSite: { siteId: "site-123", siteName: "Acme Blog" } // 可选的已导入站点
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

删除租户

参数

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

响应

返回：FlagCommentPublic200Response

示例

deleteTenant 示例

Copy

const tenantId: string = "tenant_7f3d2c";
const id: string = "flag_8392b1a7";
const sure: string = "confirmed";
const responseWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id);
const responseWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

获取租户

参数

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

响应

返回: GetTenant200Response

示例

getTenant 示例

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // 可选覆盖（如果可用）
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

获取租户列表

参数

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

响应

返回: GetTenants200Response

示例

getTenants 示例

Copy

const tenantId: string = 'tenant_8421e7';
const meta: string = 'include=domains,billing,customConfig';
const skip: number = 20;
const tenantsBasic: GetTenants200Response = await getTenants(tenantId);
const tenantsWithOptions: GetTenants200Response = await getTenants(tenantId, meta, skip);

更新租户

参数

Name	Type	Required
tenantId	string	是
id	string	是
updateTenantBody	UpdateTenantBody	是

响应

返回: FlagCommentPublic200Response

示例

updateTenant 示例

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // 可选，省略以保留当前计费信息
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

更改工单状态

参数

Name	Type	Required
tenantId	string	是
userId	string	是
id	string	是
changeTicketStateBody	ChangeTicketStateBody	是

响应

返回: ChangeTicketState200Response

示例

changeTicketState 示例

Copy

const tenantId: string = 'tenant_82f9b3';
const userId: string = 'user_9472';
const id: string = 'ticket_550e8400-e29b-41d4-a716-446655440000';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'resolved',
  comment: 'Confirmed fix deployed to production; closing ticket.',
  notifySubscribers: true
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

创建工单

参数

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

响应

返回: CreateTicket200Response

示例

createTicket 示例

Copy

const tenantId: string = "acme-corp-001";
const userId: string = "user_72b9f4";
const createTicketBody: CreateTicketBody = {
  subject: "Subscription renewal failed for card on file",
  description: "Customer's card was declined by the payment processor during automatic renewal. Transaction ID: txn_9a8b7c. Please review gateway logs and retry.",
  priority: "high", // 可选字段示例
  contactEmail: "billing@acme-corp.com", // 可选联系信息
  relatedUrl: "https://acme-corp.com/account/billing"
};
const ticketResponse: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

获取工单

参数

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

响应

返回：GetTicket200Response

示例

getTicket 示例

Copy

const tenantId: string = 'acme-corp-tenant-01';
const ticketId: string = 'tkt-20260325-42';
const userId: string = 'user-8452';
const ticketResponseWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketResponseWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);

获取工单列表

参数

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

响应

返回: GetTickets200Response

示例

getTickets 示例

Copy

const tenantId: string = "tenant_92f3b4c1";
const userId: string = "user_742a9f3e";
const state: number = 1;
const skip: number = 0;
const limit: number = 25;
const ticketsFull: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);
const ticketsMinimal: GetTickets200Response = await getTickets("tenant_92f3b4c1");

上传图片

上传并调整图像大小

参数

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

响应

返回: UploadImageResponse

通过 ID 获取用户徽章进度

参数

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

响应

返回：GetUserBadgeProgressById200Response

示例

getUserBadgeProgressById 示例

Copy

const optionalTenantSuffix: string | undefined = undefined;
const tenantId: string = `5f8d0d55-1234-4ab1-9e2a-3f2b5c6d7e8f${optionalTenantSuffix ?? ''}`;
const id: string = '3a2b1c4d-5678-4ef0-9abc-def123456789';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, id);

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

参数

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

响应

返回: GetUserBadgeProgressById200Response

示例

getUserBadgeProgressByUserId 示例

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // 可选来源（可能为 undefined）
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

获取用户徽章进度列表

参数

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

响应

返回: GetUserBadgeProgressList200Response

示例

getUserBadgeProgressList 示例

Copy

(async () => {
  const tenantId: string = 'tenant_4f8c2b9d';
  const userId: string = 'user_9a7e215c';
  const limit: number = 25;
  const skip: number = 0;
  const resultMinimal: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId);
  const resultFull: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);
  console.log(resultMinimal, resultFull);
})();

创建用户徽章

参数

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

响应

返回: CreateUserBadge200Response

示例

createUserBadge 示例

Copy

const tenantId: string = 'tenant_84f3b2';
const createUserBadgeParams: CreateUserBadgeParams = {
  name: 'Top Contributor',
  slug: 'top-contributor',
  imageUrl: 'https://assets.fastcomments.com/badges/top-contributor.png',
  description: 'Awarded for 100 helpful comments',
  active: true,
  criteria: { commentsCount: 100 }, // 可选条件
  displayOrder: 10,
  metadata: { featured: true } // 可选元数据
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);
console.log(result);

删除用户徽章

参数

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

响应

返回: UpdateUserBadge200Response

示例

deleteUserBadge 示例

Copy

type DeleteOptions = { notifyModerators?: boolean };
const tenantId: string = 'tenant_8a3f21';
const id: string = 'badge_71f2b';
const options: DeleteOptions = { notifyModerators: true };
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

获取用户徽章

参数

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

响应

返回: GetUserBadge200Response

示例

getUserBadge 示例

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "badge_8c7d2f";
const response: GetUserBadge200Response = await getUserBadge(tenantId, id);

获取用户徽章列表

参数

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

响应

返回： GetUserBadges200Response

示例

getUserBadges 示例

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_5f4d3c2a';
const badgeId: string = 'badge_top_contributor';
const type: number = 1;
const displayedOnComments: boolean = true;
const limit: number = 50;
const skip: number = 0;
const result: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

更新用户徽章

参数

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

响应

返回: UpdateUserBadge200Response

示例

updateUserBadge 示例

Copy

(async () => {
  const tenantId: string = 'tenant_acme_987';
  const id: string = 'badge_top_contributor_42';
  const updateUserBadgeParams: UpdateUserBadgeParams = {
    title: 'Top Contributor',
    description: 'Awarded for reaching 100 high-quality comments',
    color: '#FFD700',
    iconUrl: 'https://cdn.acme.com/badges/top-contributor.svg',
    active: true,
    notifyUsers: true
  } as UpdateUserBadgeParams;
  const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);
  console.log(result);
})();

获取用户通知计数

参数

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

响应

返回: GetUserNotificationCount200Response

示例

getUserNotificationCount 示例

Copy

(async () => {
  const tenantId: string = '9f1e2d3c-4b5a-6d7e-8f90-123456789abc';
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);
  const resultWithoutSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
  console.log(resultWithSSO, resultWithoutSSO);
})();

获取用户通知

参数

Name	Type	Required
tenantId	string	是
pageSize	number	否
afterId	string	否
includeContext	boolean	否
afterCreatedAt	number	否
unreadOnly	boolean	否
dmOnly	boolean	否
noDm	boolean	否
includeTranslations	boolean	否
sso	string	否

响应

返回：GetUserNotifications200Response

示例

getUserNotifications 示例

Copy

const tenantId: string = 'tenant_7f3b1c';
const pageSize: number = 25;
const afterId: string = 'notif_b2f9e4';
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 24 * 60 * 60 * 1000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const sso: string = 'sso_tok_user_9f8d7c';
const response: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  sso
);

重置用户通知计数

参数

Name	Type	必填	描述
tenantId	string	是
sso	string	否

响应

返回: ResetUserNotifications200Response

示例

resetUserNotificationCount 示例

Copy

(async () => {
  const tenantId: string = "tenant_9f3b2c4a";
  const ssoToken: string | undefined = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9._sample_payload_.signature";
  const responseWithSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
  const responseWithoutSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);
  console.log(responseWithSSO, responseWithoutSSO);
})();

重置用户通知

参数

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

响应

返回：ResetUserNotifications200Response

示例

resetUserNotifications 示例

Copy

const tenantId: string = "tenant_prod_4a9f12";
const afterId: string = "notification_87213";
const afterCreatedAt: number = Math.floor(Date.now() / 1000) - 3600;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.payload";
const result: ResetUserNotifications200Response = await resetUserNotifications(tenantId, afterId, afterCreatedAt, unreadOnly, dmOnly, undefined, sso);

更新用户评论订阅状态

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

参数

名称	类型	必填
tenantId	string	是
notificationId	string	是
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	是
commentId	string	是
sso	string	否

响应

返回: UpdateUserNotificationStatus200Response

示例

updateUserNotificationCommentSubscriptionStatus 示例

Copy

const tenantId: string = 'acme-tenant-001';
const notificationId: string = 'notif-2026-03-25-01';
const commentId: string = 'cmt-8f3a2b';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso-payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

更新用户页面订阅状态

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

参数

名称	类型	必需
tenantId	string	是
urlId	string	是
url	string	是
pageTitle	string	是
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	是
sso	string	否

响应

返回：UpdateUserNotificationStatus200Response

示例

updateUserNotificationPageSubscriptionStatus 示例

Copy

const tenantId: string = 'acme-tenant-42';
const urlId: string = 'blog-launch-2026';
const url: string = 'https://acme.example.com/blog/launch-march-2026';
const pageTitle: string = 'Acme Product Launch — March 2026';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

更新用户通知状态

参数

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

响应

返回: UpdateUserNotificationStatus200Response

示例

updateUserNotificationStatus 示例

Copy

const tenantId: string = 'tenant_84a2c3';
const notificationId: string = 'notif_20260325_01';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_signature_example';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

获取用户在线状态

参数

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

响应

返回：GetUserPresenceStatuses200Response

示例

getUserPresenceStatuses 示例

Copy

const tenantId: string = 'tenant_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // 可选来源
const userIds: string = maybeUserIds ?? 'user_123';
const presence: 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_8392';
const urlId: string = 'articles/2026/03/25/fastcomments-release';
const usernameStartsWith: string = 'jo';
const mentionGroupIds: Array<string> = ['editors', 'senior-writers'];
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.ALL;
const result: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

获取用户

参数

名称	Type	必填	描述
tenantId	string	是
id	string	是

Response

返回: GetUser200Response

示例

getUser 示例

Copy

const tenantId: string = 'tenant_7b3f42';
const id: string = 'user_9c4d2a';
const userResponse: GetUser200Response = await getUser(tenantId, id);
console.log(userResponse);

创建投票

参数

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

响应

返回: VoteComment200Response

示例

createVote 示例

Copy

const tenantId: string = 'tenant_9f8b6a';
const commentId: string = 'comment_3b7d2e';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const anonUserId: string = 'anon_4c2a1f';
const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);

删除投票

参数

名称	类型	必填
tenantId	string	是
id	string	是
editKey	string	否

响应

返回: DeleteCommentVote200Response

示例

deleteVote 示例

Copy

const tenantId: string = "tenant_7c3f2b4a";
const voteId: string = "vote_4f8d9a11";
const editKey: string = "edit_2b9f8c";
const resultWithoutKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId);
const resultWithKey: DeleteCommentVote200Response = await deleteVote(tenantId, voteId, editKey);

获取投票

参数

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

响应

返回: GetVotes200Response

示例

getVotes 示例

Copy

const tenantId: string = 'acme-corp-8f3b';
const refCampaign: string | undefined = 'newsletter-march2026'; // 可选查询参数
const urlId: string = `https://www.example.com/articles/2026/03/25/fastcomments-integration${refCampaign ? `?ref=${refCampaign}` : ''}`;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

获取用户的投票

参数

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

响应

返回: GetVotesForUser200Response

示例

getVotesForUser 示例

Copy

(async (): Promise<void> => {
  const tenantId: string = "local-news-ny";
  const urlId: string = "articles/2026-03-25/ev-infrastructure-update";
  const userId: string = "user_78b6f3d9";
  const anonUserId: string = "anon_9c3f7a1b";
  const result: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);
  console.log(result);
})();

需要帮助？

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

贡献

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

语言 🇨🇳 简体中文

入门

API 参考

文档

使用方法

聚合

审计日志

从评论屏蔽

检查被屏蔽评论

评论

域配置

邮件模板

事件日志

动态帖子

标记评论

话题标签

版主

通知计数

通知

页面

待处理 Webhook 事件

问题配置

问题结果

问题结果聚合

SSO 用户

订阅

租户每日使用量

租户套餐

租户用户

租户

工单

上传图片

用户徽章进度

用户徽章

用户通知

用户在线状态

用户搜索

用户

投票

FastComments JavaScript/TypeScript SDK

仓库

安装

API 文档

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

浏览器与服务器兼容性

使用方法

浏览器 使用（客户端）

服务器 使用（Node.js）

仅类型导入

使用单个 API 类

浏览器环境

服务器环境

公开 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）