FastComments JavaScript/TypeScript SDK

這是 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 (default) - 僅型別，能安全在任何地方匯入

使用方式

此 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

此 SDK 提供三個主要的 API 類別：

DefaultApi - 需要您的 API 金鑰進行驗證的受保護端點。用於伺服器端操作。
PublicApi - 可在無需 API 金鑰的情況下存取的公開端點。可直接從瀏覽器/行動裝置等呼叫。
HiddenApi - 供內部/管理用途的端點，適用於進階使用情境。

範例：使用 Public API（瀏覽器安全）

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

const publicApi = new PublicApi();

// 取得頁面評論（不需要 API 金鑰）
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

範例：使用 Default API（僅限伺服器端）

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 功能。

Simple SSO (Server-Side Only)

簡易 SSO 應在伺服器端產生並傳送給客戶端：

// 伺服器端程式碼（Node.js/backend）
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 傳送到你的客戶端程式碼
// 客戶端程式碼之後可以使用此 token 與瀏覽器 SDK

Secure SSO (Server-Side, Recommended)

安全 SSO 應在伺服器端實作，並提供較佳的安全性：

// 伺服器端程式碼（Node.js/backend）
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 傳送給客戶端供瀏覽器使用

Using SSO from Browser (with Server-Generated Token)

// 客戶端程式碼（瀏覽器）
import { PublicApi } from 'fastcomments-sdk/browser';

// 從你的伺服器端點取得 SSO token
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 // 使用伺服器產生的 SSO token
});

SSO with Comment Creation

// 伺服器端：建立 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',
};

// 訂閱該頁面的即時事件
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS（租戶 ID）
  'page-url-id',    // urlIdWS（頁面 URL ID）  
  'user-session-id', // userIdWS（從 getComments 回應取得）
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // 使用新留言更新您的介面
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // 在介面中更新票數
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // 若事件已處理則回傳 true
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// 完成後關閉訂閱
subscription.close();

訂閱使用者事件

監聽與特定使用者相關的事件（通知、提及等）：

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

const userConfig = {
  userIdWS: 'user-session-id', // 從 getComments 回應取得
};

// 訂閱使用者的個人資訊流
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // 在您的介面中顯示通知
        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');
  }
);

// 完成後關閉
userSubscription.close();

取得 userIdWS

參數 userIdWS 為即時事件所需，可從 API 回應中取得：

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

// 從回應中擷取 userIdWS
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // 現在您可以訂閱即時事件
  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() // 此操作的唯一識別碼
  }
});

錯誤處理

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);

取得稽核記錄

參數

名稱	類型	必填
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);

從留言封鎖（公開）

參數

名稱	類型	必填
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	是
id	string	是
blockFromCommentParams	BlockFromCommentParams	是
userId	string	否
anonUserId	string	否

回應

回傳: 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);

建立公開留言

參數

名稱	型別	必填
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);

刪除留言

參數

名稱	類型	必填
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();

刪除公開留言

參數

名稱	類型	必填
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);

取得留言列表

參數

名稱	類型	必填
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	是
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 = '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);

鎖定留言

參數

Name	Type	Required
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);

儲存留言

參數

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	Yes
id	string	Yes
unBlockFromCommentParams	UnBlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

回應

回傳: 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);

解除留言檢舉

參數

名稱	類型	必填
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);

解除鎖定留言

參數

Name	Type	Required
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);

取消置頂留言

參數

Name	Type	Required
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);

對留言投票

參數

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

回應

Returns: 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
  undefined, // 已省略 repliesToUserId
  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	Yes
id	string	Yes
errorId	string	Yes

回應

回傳: 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);
})();

取得電子郵件範本渲染錯誤

參數

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

回應

回傳: 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();

渲染電子郵件範本

參數

Name	Type	Required
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);

更新電子郵件範本

參數

名稱	類型	必填
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);

建立動態貼文

參數

名稱	類型	必填
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	否
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	是
postIds	Array	是
sso	string	否

回應

回傳: 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
);

更新動態貼文

參數

Name	Type	Required
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);

取得大型 GIF

參數

名稱	類型	必填	說明
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);

搜尋 GIF

參數

名稱	類型	必填
tenantId	string	是
search	string	是
locale	string	否
rating	string	否
page	number	否

回應

回傳： 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);

取得熱門 GIF

參數

名稱	類型	必填
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);

取得管理員清單

參數

Name	Type	Required	Description
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);

發送邀請

參數

Name	Type	Required
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);
})();

更新管理員

參數

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateModeratorBody	UpdateModeratorBody	Yes

回應

回傳：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);

取得快取的通知計數

參數

Name	Type	Required	Description
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);
}

取得通知計數

參數

名稱	型別	必填
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);

取得通知

參數

Name	Type	Required
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
);

更新通知

參數

Name	Type	是否必填
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 頁面回應

參數

Name	Type	必填
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 頁面回應

參數

名稱	型別	必填
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 頁面按讚

參數

名稱	類型	必填	說明
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 頁面回應使用者

參數

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

回應

回傳: 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

刪除頁面

參數

Name	Type	Required	Description
tenantId	string	是
id	string	是

Response

回傳: DeletePageAPIResponse

取得離線使用者

在該頁面先前的留言者，但目前不在線上。依 displayName 排序。在用盡 /users/online 後，使用此來呈現一個 "成員" 區段。 Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.

參數

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

回應

回傳: 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);

依 URLId 取得頁面

參數

名稱	類型	必填	描述
tenantId	string	是
urlId	string	是

回應

回傳：GetPageByURLIdAPIResponse

取得頁面清單

參數

名稱	類型	必填	描述
tenantId	string	是

回應

回傳: GetPagesAPIResponse

取得公開頁面

列出租戶的頁面。供 FChat 桌面客戶端用來填充其房間列表。要求每個頁面的解析後自訂設定中 enableFChat 必須為 true。需要 SSO 的頁面會根據請求使用者的群組權限進行篩選。

參數

Name	Type	Required
tenantId	string	是
cursor	string	否
limit	number	否
q	string	否
sortBy	PagesSortBy	否
hasComments	boolean	否

回應

回傳: GetPagesPublic200Response

範例

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 返回顯示資訊。由評論 widget 使用，用於豐富剛透過 presence 事件出現的使用者。無頁面上下文：隱私統一強制執行（私人檔案會被遮蔽）。

參數

名稱	類型	必填	描述
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);

部分更新頁面

參數

Name	Type	Required
tenantId	string	是
id	string	是
updateAPIPageData	UpdateAPIPageData	是

回應

回傳: PatchPageAPIResponse

刪除待處理的 Webhook 事件

參數

名稱	類型	必填	說明
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
  eventType,
  undefined, // 已省略 type
  domain,
  attemptCountGT
);

取得待處理的 Webhook 事件

參數

Name	Type	Required
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	是
createQuestionConfigBody	CreateQuestionConfigBody	是

回應

回傳: 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);

取得問卷設定清單

參數

名稱	類型	必填	描述
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);

建立問卷結果

參數

Name	Type	Required	Description
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;

取得問卷結果

參數

名稱	類型	是否必填	描述
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);

更新問卷結果

參數

Name	Type	Required
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);

批次彙總問卷結果

參數

名稱	類型	必填
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	是
questionId	string	否
questionIds	Array	否
urlId	string	否
startDate	Date	否
forceRecalculate	boolean	否
minValue	number	否
maxValue	number	否
limit	number	否

回應

回傳: 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 使用者

參數

Name	Type	Required
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);

建立訂閱

參數

名稱	類型	必填	說明
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);

刪除訂閱

參數

名稱	類型	必填
tenantId	string	是
id	string	是
userId	string	否

回應

回傳: DeleteSubscriptionAPIResponse

取得訂閱

參數

Name	Type	必填	描述
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);

更新訂閱

參數

名稱	類型	必填
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);

建立租戶方案

參數

名稱	類型	是否必填	說明
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);

刪除租戶方案

參數

Name	Type	Required	Description
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);

取得租戶方案

參數

名稱	類型	必填	描述
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);

取代租戶方案

參數

名稱	類型	是否必填
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);

更新租戶方案

參數

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

回應

回傳: 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);

建立租戶使用者

參數

名稱	類型	是否必填	描述
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);

刪除租戶使用者

參數

Name	Type	Required
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);

取代租戶使用者

參數

名稱	類型	必填
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);

發送登入連結

參數

名稱	類型	必填
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);

刪除租戶

參數

名稱	型別	必填
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];

取得租戶清單

參數

名稱	類型	必填
tenantId	string	是
meta	string	否
skip	number	否

回應

回傳: 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);

更新租戶

參數

Name	Type	Required
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);

建立工單

參數

Name	Type	Required
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 } // 示範可選的 metadata
};
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);

取得工單清單

參數

名稱	類型	必填
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);

刪除使用者徽章

參數

名稱	類型	必填	說明
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);
})();

取得使用者徽章清單

參數

Name	類型	必填
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);

取得使用者通知

參數

Name	Type	Required
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
);

更新使用者留言通知訂閱狀態

啟用或停用針對特定評論的通知。

參數

名稱	類型	必填
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	是
urlId	string	是
url	string	是
pageTitle	string	是
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	是
sso	string	否

回應

回傳: 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);

更新使用者通知狀態

參數

Name	Type	Required
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);

搜尋使用者

參數

Name	Type	Required
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);

取得使用者

參數

Name	Type	Required	Description
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);

刪除投票

參數

名稱	類型	必填
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 參考

文件

使用方式

彙總

稽核記錄

從留言封鎖

檢查被封鎖的留言

留言

使用者留言

網域設定

電子郵件範本

事件記錄

動態貼文

檢舉留言

GIF

標籤

管理員

通知計數

通知

頁面回應

頁面

待處理的 Webhook 事件

問卷設定

問卷結果

問卷結果彙整

SSO 使用者

訂閱

租戶每日使用

租戶方案

租戶使用者

租戶

工單

翻譯

上傳圖片

使用者徽章進度

使用者徽章

使用者通知

使用者在線狀態

使用者搜尋

使用者

投票

FastComments JavaScript/TypeScript SDK

儲存庫

安裝

API 文件

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

瀏覽器與伺服器相容性

使用方式

瀏覽器 用法（客戶端）

伺服器 用法（Node.js）

僅匯入類型

使用個別 API 類別

瀏覽器 環境

伺服器 環境

公開 API 與受保護 API

範例：使用 Public API（瀏覽器安全）

範例：使用 Default API（僅限伺服器端）

SSO（單一登入）整合

Simple SSO (Server-Side Only)

Secure SSO (Server-Side, Recommended)

Using SSO from Browser (with Server-Generated Token)

SSO with Comment Creation

常見使用情境

取得頁面留言

建立留言

對留言投票

使用者管理（需要 API 金鑰）

即時事件（即時更新）

頁面層級事件

訂閱使用者事件

取得 userIdWS

廣播 ID

錯誤處理

彙總

參數

回應

範例

取得稽核記錄

瀏覽器用法（客戶端）

伺服器用法（Node.js）

瀏覽器環境

伺服器環境