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

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

彙總 (aggregate)

透過分組（如果提供了 groupBy）並套用多個運算，來彙總文件。支援不同的運算（例如 sum、countDistinct、avg 等）。

參數

Name	Type	Required
tenantId	string	是
aggregationRequest	AggregationRequest	是
parentTenantId	string	否
includeStats	boolean	否

回應

回傳：AggregationResponse

取得稽核日誌 (getAuditLogs)

參數

名稱	類型	必填
tenantId	string	是
limit	number	否
skip	number	否
order	SORTDIR	否
after	number	否
before	number	否

回應

回傳: GetAuditLogs200Response

範例

getAuditLogs 範例

Copy

const tenantId: string = 'tenant_9a8b7c';
const limit: number = 100;
const skip: number = 0;
const after: number = Date.now() - 30 * 24 * 60 * 60 * 1000; // 30 天前
const before: number = Date.now();
const auditLogs: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, undefined, after, before);

從評論封鎖 (blockFromCommentPublic)

參數

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

回應

回傳: BlockFromCommentPublic200Response

範例

blockFromCommentPublic 範例

Copy

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

解除公開評論封鎖 (unBlockCommentPublic)

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
publicBlockFromCommentParams	PublicBlockFromCommentParams	是
sso	string	否

回應

回傳: UnBlockCommentPublic200Response

範例

unBlockCommentPublic 範例

Copy

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

檢查被封鎖的評論 (checkedCommentsForBlocked)

參數

Name	Type	Required
tenantId	string	是
commentIds	string	是
sso	string	否

回應

回傳: CheckedCommentsForBlocked200Response

範例

checkedCommentsForBlocked 範例

Copy

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

封鎖使用者於評論 (blockUserFromComment)

參數

名稱	型別	必填
tenantId	string	是
id	string	是
blockFromCommentParams	BlockFromCommentParams	是
userId	string	否
anonUserId	string	否

回應

回傳：BlockFromCommentPublic200Response

範例

blockUserFromComment 範例

Copy

const tenantId: string = 'acme-corp';
const id: string = 'comment_7f3b2a9c';
const blockFromCommentParams: BlockFromCommentParams = {
  reason: 'Repeated abusive language and targeted harassment',
  durationDays: 90,
  preventReposting: true
};
const userId: string = 'user_12345';
const anonUserId: string = 'anon_98765';
const result: BlockFromCommentPublic200Response = await blockUserFromComment(
  tenantId,
  id,
  blockFromCommentParams,
  userId,
  anonUserId
);

建立公開評論 (createCommentPublic)

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
broadcastId	string	是
commentData	CommentData	是
sessionId	string	否
sso	string	否

回應

回傳: CreateCommentPublic200Response

範例

createCommentPublic 範例

Copy

const tenantId: string = 'tenant_prod_42';
const urlId: string = 'article-2026-03-25-tech-deep-dive';
const broadcastId: string = 'live-broadcast-001';
const sessionId: string = 'sess_9f8e7d6a3b';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const commentData: CommentData = {
  content: 'Great reporting — appreciated the depth on performance tradeoffs.',
  authorName: 'Jordan M.',
  language: 'en-US',
  metadata: { client: 'web' }
};
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

刪除評論 (deleteComment)

參數

名稱	類型	必填
tenantId	string	是
id	string	是
contextUserId	string	否
isLive	boolean	否

回應

回傳: DeleteComment200Response

範例

deleteComment 範例

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "comment_5f3a2b7c";
const contextUserId: string = "user_1229";
const isLive: boolean = true;
const response: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);

刪除公開評論 (deleteCommentPublic)

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

回應

回傳: DeleteCommentPublic200Response

範例

deleteCommentPublic 範例

Copy

const tenantId: string = 'tenant_4f2c9b';
const commentId: string = 'comment-7c3a9f2d';
const broadcastId: string = 'article-2026-03-20';
const editKey: string | undefined = 'ek_pub_abc12345';
const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(
  tenantId,
  commentId,
  broadcastId,
  editKey,
  sso
);

刪除評論投票 (deleteCommentVote)

參數

Name	類型	必填
tenantId	string	是
commentId	string	是
voteId	string	是
urlId	string	是
broadcastId	string	是
editKey	string	否
sso	string	否

回應

回傳: DeleteCommentVote200Response

範例

deleteCommentVote 範例

Copy

const tenantId: string = 'acme-tenant-87e4fd';
const commentId: string = 'cmt-9a12b3f4';
const voteId: string = 'vote-4f6d21b9';
const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';
const broadcastId: string = 'broadcast-20260325-01';
const editKey: string = 'editkey-6b7c8d9e';
const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: DeleteCommentVote200Response = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey,
  sso
);

檢舉評論 (flagComment)

參數

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

回應

回傳: FlagComment200Response

範例

flagComment 範例

Copy

const tenantId: string = 'tenant_7f3b21';
const commentId: string = 'cmt_9a2b4';
const userId: string = 'user_1024';
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

取得評論 (getComment)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回應

回傳：GetComment200Response

範例

getComment 範例

Copy

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

取得多則評論 (getComments)

參數

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

回應

回傳: GetComments200Response

範例

getComments 範例

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // 頁碼
  20, // 每頁數量
  0, // 跳過
  true, // 以樹狀回傳
  1, // 跳過子項
  3, // 子項限制
  4, // 最大樹層級
  'articles/2026/new-product-launch', // 網址識別碼
  'user_7890', // 使用者 ID
  'anon_4f3b2', // 匿名使用者 ID
  undefined, // 上下文使用者 ID
  '#launch', // 標籤
  undefined // 父項 ID
);

取得公開評論 (getCommentsPublic)

req tenantId urlId

參數

Name	Type	Required
tenantId	string	是
urlId	string	是
page	number	否
direction	SortDirections	否
sso	string	否
skip	number	否
skipChildren	number	否
limit	number	否
limitChildren	number	否
countChildren	boolean	否
fetchPageForCommentId	string	否
includeConfig	boolean	否
countAll	boolean	否
includei10n	boolean	否
locale	string	否
modules	string	否
isCrawler	boolean	否
includeNotificationCount	boolean	否
asTree	boolean	否
maxTreeDepth	number	否
useFullTranslationIds	boolean	否
parentId	string	否
searchText	string	否
hashTags	Array	否
userId	string	否
customConfigStr	string	否
afterCommentId	string	否
beforeCommentId	string	否

回應

回傳: GetCommentsPublic200Response

範例

getCommentsPublic 範例

Copy

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

取得評論文字 (getCommentText)

參數

名稱	型別	必填
tenantId	string	是
commentId	string	是
editKey	string	否
sso	string	否

回應

回傳: GetCommentText200Response

範例

getCommentText 範例

Copy

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

取得評論投票使用者名稱 (getCommentVoteUserNames)

參數

名稱	類型	必填
tenantId	string	Yes
commentId	string	Yes
dir	number	Yes
sso	string	No

回應

回傳：GetCommentVoteUserNames200Response

範例

getCommentVoteUserNames 範例

Copy

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

鎖定評論 (lockComment)

參數

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

回應

回傳: LockComment200Response

範例

lockComment 範例

Copy

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

置頂評論 (pinComment)

參數

名稱	型別	必填
tenantId	string	是
commentId	string	是
broadcastId	string	是
sso	string	否

回應

回傳: PinComment200Response

範例

pinComment 範例

Copy

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

儲存評論 (saveComment)

參數

名稱	類型	必填
tenantId	string	是
createCommentParams	CreateCommentParams	是
isLive	boolean	否
doSpamCheck	boolean	否
sendEmails	boolean	否
populateNotifications	boolean	否

回應

回傳: SaveComment200Response

範例

saveComment 範例

Copy

const tenantId: string = 'tenant_acme_001';
const createCommentParams: CreateCommentParams = {
  content: 'Great article — helped me fix a production issue in minutes.',
  url: 'https://app.acme.com/blog/performance-tips',
  author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },
  metadata: { locale: 'en-US', appVersion: '4.2.1' }
} as CreateCommentParams;
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const sendEmails: boolean = false;
const populateNotifications: boolean = true;
const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

批次儲存評論 (saveCommentsBulk)

參數

名稱	類型	必填
tenantId	string	是
createCommentParams	Array	是
isLive	boolean	否
doSpamCheck	boolean	否
sendEmails	boolean	否
populateNotifications	boolean	否

回應

回傳： Array<SaveComment200Response

範例

saveCommentsBulk 範例

Copy

const tenantId: string = 'acme-corp-01';
const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];
const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: 'Great insights on async/await patterns.',
    authorName: 'John Smith',
    authorEmail: 'john.smith@acme.com',
    externalId: 'comment-001',
    createdAt: '2026-03-25T10:15:00Z',
    userMentions: mentions1,
    userHashTags: hashtags1
  },
  {
    content: 'I prefer using Promise.all for bulk ops.',
    authorName: 'Emily Turner',
    authorEmail: 'emily.turner@acme.com',
    externalId: 'comment-002',
    createdAt: '2026-03-25T10:20:00Z'
  }
];
const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

設定評論文字 (setCommentText)

參數

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

回傳

回傳: SetCommentText200Response

範例

setCommentText 範例

Copy

const tenantId: string = 'tenant_6721f4';
const commentId: string = 'cmt_9a3b2d';
const broadcastId: string = 'live_2026_03_25';
const editKey: string = 'edit_k_4f7b9';
const sso: string = 'sso_tok_eyJhbGciOiJIUzI1';
const commentTextUpdateRequest: CommentTextUpdateRequest = {
  text: 'Updated to clarify the timeline and link the relevant docs.',
  mentions: [{ userId: 'user_102', displayName: 'Alex Rivera' }],
  hashtags: [{ tag: 'product-update' }]
};
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso);

解除使用者評論封鎖 (unBlockUserFromComment)

參數

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

回應

回傳: UnBlockCommentPublic200Response

範例

unBlockUserFromComment 範例

Copy

const tenantId: string = 'tenant_87f3e1';
const id: string = 'comment_9b2a4f';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'Reviewed by moderation team — reinstated',
  moderatorId: 'mod_21',
  unblockedAt: new Date().toISOString()
};
const userId: string = 'user_42';
const anonUserId: string = 'anon_e7f9';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

解除檢舉評論 (unFlagComment)

參數

名稱	型別	必填
tenantId	string	是
id	string	是
userId	string	否
anonUserId	string	否

回應

回傳： FlagComment200Response

範例

unFlagComment 範例

Copy

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

解除鎖定評論 (unLockComment)

參數

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

回應

回傳: LockComment200Response

範例

unLockComment 範例

Copy

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

取消置頂評論 (unPinComment)

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
broadcastId	string	是
sso	string	否

回應

回傳: PinComment200Response

範例

unPinComment 範例

Copy

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

更新評論 (updateComment)

參數

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

回應

回傳: FlagCommentPublic200Response

範例

updateComment 範例

Copy

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

對評論投票 (voteComment)

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
urlId	string	是
broadcastId	string	是
voteBodyParams	VoteBodyParams	是
sessionId	string	否
sso	string	否

回應

回傳：VoteComment200Response

範例

voteComment 範例

Copy

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

取得使用者的評論 (getCommentsForUser)

參數

名稱	類型	必填
userId	string	否
tenantId	string	否
urlId	string	否
page	number	否
direction	SortDirections	否
lastGenDate	number	否
repliesToUserId	string	否
fetchPageForCommentId	string	否
includei10n	boolean	否
useFullTranslationIds	boolean	否
locale	string	否
includeConfig	boolean	否
includeNotificationCount	boolean	否
countAll	boolean	否
sso	string	否

回應

回傳: GetCommentsForUserResponse

範例

getCommentsForUser 範例

Copy

const userId: string = "user_92b7f4";
const tenantId: string = "news-tenant-uk";
const urlId: string = "https://news.example.co.uk/articles/2026/05/01/local-election";
const page: number = 1;
const lastGenDate: number = Date.now() - 24 * 60 * 60 * 1000;
const fetchPageForCommentId: string = "c_987654321";
const includei10n: boolean = true;
const locale: string = "en-GB";
const includeConfig: boolean = true;
const includeNotificationCount: boolean = false;
const result: GetCommentsForUserResponse = await getCommentsForUser(
  userId,
  tenantId,
  urlId,
  page,
  undefined,
  lastGenDate,
  undefined,
  fetchPageForCommentId,
  includei10n,
  false,
  locale,
  includeConfig,
  includeNotificationCount,
  false,
  undefined
);

新增網域設定 (addDomainConfig)

參數

名稱	類型	必填	說明
tenantId	string	是
addDomainConfigParams	AddDomainConfigParams	是

回應

回傳：AddDomainConfig200Response

刪除網域設定 (deleteDomainConfig)

參數

名稱	類型	必填	說明
tenantId	string	是
domain	string	是

回應

回傳: DeleteDomainConfig200Response

取得網域設定 (getDomainConfig)

參數

名稱	類型	必填	說明
tenantId	string	是
domain	string	是

回應

回傳: GetDomainConfig200Response

取得多個網域設定 (getDomainConfigs)

參數

名稱	類型	必填	說明
tenantId	string	是

回應

回傳: GetDomainConfigs200Response

部分更新網域設定 (patchDomainConfig)

參數

名稱	類型	必填
tenantId	string	是
domainToUpdate	string	是
patchDomainConfigParams	PatchDomainConfigParams	是

回應

回傳: GetDomainConfig200Response

取代網域設定 (putDomainConfig)

參數

名稱	類型	是否必填
tenantId	string	是
domainToUpdate	string	是
updateDomainConfigParams	UpdateDomainConfigParams	是

回應

回傳: GetDomainConfig200Response

建立電子郵件範本 (createEmailTemplate)

參數

名稱	類型	必填	說明
tenantId	string	Yes
createEmailTemplateBody	CreateEmailTemplateBody	Yes

回應

回傳: CreateEmailTemplate200Response

範例

createEmailTemplate 範例

Copy

(async () => {
  const tenantId: string = 'tenant_9f4a2b';
  const createEmailTemplateBody: CreateEmailTemplateBody = {
    name: 'Weekly Digest',
    subject: 'Your weekly discussion highlights',
    html: '<!doctype html><body><h1>Hello {{user.name}}</h1><p>Top comments this week...</p></body>',
    fromAddress: 'no-reply@fastcomments-example.com',
    replyTo: 'moderation@fastcomments-example.com',
    isDefault: false
  };
  const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);
  console.log(result);
})();

刪除電子郵件範本 (deleteEmailTemplate)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回應

回傳：FlagCommentPublic200Response

範例

deleteEmailTemplate 範例

Copy

const tenantId: string = "acme-corp-42";
const idSuffix: string | undefined = "-archived";
const templateId: string = "email_tmpl_6a1b2c" + (idSuffix ?? "");
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

刪除電子郵件範本渲染錯誤 (deleteEmailTemplateRenderError)

參數

Name	Type	Required
tenantId	string	Yes
id	string	Yes
errorId	string	Yes

回應

回傳: FlagCommentPublic200Response

範例

deleteEmailTemplateRenderError 範例

Copy

const tenantId: string = "tenant_7a1d2f9b";
const id: string = "email_template_42b1";
const errorId: string = "render_err_2026-04-24_7f3c";
const includeStackTrace: boolean | undefined = undefined; // 可選旗標範例
const response: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
// 若支援可選的 options 物件，它可能看起來像：
 // await deleteEmailTemplateRenderError(tenantId, id, errorId /*, { includeStackTrace } */);

取得電子郵件範本 (getEmailTemplate)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回應

回傳: GetEmailTemplate200Response

範例

getEmailTemplate 範例

Copy

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

取得電子郵件範本定義 (getEmailTemplateDefinitions)

參數

Name	Type	Required	Description
tenantId	string	是

回應

回傳: GetEmailTemplateDefinitions200Response

範例

getEmailTemplateDefinitions 範例

Copy

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

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

參數

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

回應

回傳: GetEmailTemplateRenderErrors200Response

範例

getEmailTemplateRenderErrors 範例

Copy

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

取得電子郵件範本清單 (getEmailTemplates)

參數

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

回應

回傳: GetEmailTemplates200Response

範例

getEmailTemplates 範例

Copy

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

渲染電子郵件範本 (renderEmailTemplate)

參數

名稱	類型	是否必填
tenantId	string	是
renderEmailTemplateBody	RenderEmailTemplateBody	是
locale	string	否

回應

回傳：RenderEmailTemplate200Response

範例

renderEmailTemplate 範例

Copy

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

更新電子郵件範本 (updateEmailTemplate)

參數

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

回應

回傳: FlagCommentPublic200Response

範例

updateEmailTemplate 範例

Copy

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

取得事件記錄 (getEventLog)

req tenantId urlId userIdWS

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
userIdWS	string	是
startTime	number	是
endTime	number	是

回應

回傳: GetEventLog200Response

範例

getEventLog 範例

Copy

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

取得全域事件記錄 (getGlobalEventLog)

req tenantId urlId userIdWS

參數

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

回應

回傳: GetEventLog200Response

範例

getGlobalEventLog 範例

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7 天前
const endTimeOptional: number | undefined = undefined; // 可選的時間範圍結束
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

建立動態貼文 (createFeedPost)

參數

名稱	類型	必要
tenantId	string	是
createFeedPostParams	CreateFeedPostParams	是
broadcastId	string	否
isLive	boolean	否
doSpamCheck	boolean	否
skipDupCheck	boolean	否

回應

回傳: CreateFeedPost200Response

範例

createFeedPost 範例

Copy

const tenantId: string = 'tenant_87f3b2';
const mediaAsset: FeedPostMediaItemAsset = { url: 'https://cdn.example.com/images/post-123.jpg', mimeType: 'image/jpeg', width: 1200, height: 800, size: 245000 };
const mediaItem: FeedPostMediaItem = { id: 'media_1', type: 'image', assets: [mediaAsset], altText: 'Conference keynote stage' };
const link: FeedPostLink = { url: 'https://news.example.com/keynote-recap', title: 'Keynote recap' };
const createFeedPostParams: CreateFeedPostParams = {
  title: 'Product Launch Highlights',
  content: 'Highlights from today’s product launch and roadmap updates.',
  authorId: 'user_42',
  mediaItems: [mediaItem],
  links: [link],
  tags: ['product', 'launch', 'announcement']
};
const broadcastId: string = 'broadcast_20260424';
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

建立公開動態貼文 (createFeedPostPublic)

參數

名稱	類型	必要
tenantId	string	是
createFeedPostParams	CreateFeedPostParams	是
broadcastId	string	否
sso	string	否

回應

回傳: CreateFeedPostPublic200Response

範例

createFeedPostPublic 範例

Copy

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

刪除公開動態貼文 (deleteFeedPostPublic)

參數

名稱	型別	必填
tenantId	string	是
postId	string	是
broadcastId	string	否
sso	string	否

回應

回傳：DeleteFeedPostPublic200Response

範例

deleteFeedPostPublic 範例

Copy

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

取得動態貼文 (getFeedPosts)

req tenantId afterId

參數

Name	Type	Required
tenantId	string	是
afterId	string	否
limit	number	否
tags	Array	否

回應

回傳: GetFeedPosts200Response

範例

getFeedPosts 範例

Copy

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

取得公開動態貼文 (getFeedPostsPublic)

req tenantId afterId

參數

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

回應

回傳: GetFeedPostsPublic200Response

範例

getFeedPostsPublic 範例

Copy

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

取得動態貼文統計 (getFeedPostsStats)

參數

名稱	型別	必填
tenantId	string	是
postIds	Array	是
sso	string	否

回應

回傳: GetFeedPostsStats200Response

範例

getFeedPostsStats 範例

Copy

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

取得使用者公開反應 (getUserReactsPublic)

參數

名稱	類型	必填
tenantId	string	Yes
postIds	Array	No
sso	string	No

回應

回傳： GetUserReactsPublic200Response

範例

getUserReactsPublic 範例

Copy

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

對公開動態貼文反應 (reactFeedPostPublic)

參數

名稱	類型	必填
tenantId	string	Yes
postId	string	Yes
reactBodyParams	ReactBodyParams	Yes
isUndo	boolean	No
broadcastId	string	No
urlId	string	No
sso	string	No

回應

回傳: ReactFeedPostPublic200Response

範例

reactFeedPostPublic 範例

Copy

const tenantId: string = 'tenant_84f2b1';
const postId: string = 'post_12ac9e';
const reactBodyParams: ReactBodyParams = { emoji: 'thumbs_up', intensity: 1 };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast_20260503_01';
const urlId: string = 'article-4527';
const sso: string = 'sso_token_7f3b2c';
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, urlId, sso);

更新動態貼文 (updateFeedPost)

參數

名稱	類型	必填
tenantId	string	是
id	string	是
feedPost	FeedPost	是

回應

回傳: FlagCommentPublic200Response

範例

updateFeedPost 範例

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // 選填的陣列
  links: [link],          // 選填的連結
  isPublished: true       // 在此使用選填的發佈旗標
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

更新公開動態貼文 (updateFeedPostPublic)

參數

名稱	類型	必填
tenantId	string	是
postId	string	是
updateFeedPostParams	UpdateFeedPostParams	是
broadcastId	string	否
sso	string	否

回傳

回傳：CreateFeedPostPublic200Response

範例

updateFeedPostPublic 範例

Copy

const tenantId: string = "tenant_9f4b2";
const postId: string = "post_21a8e";
const updateFeedPostParams: UpdateFeedPostParams = {
  title: "Quarterly product update",
  body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",
  links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],
  media: [
    {
      type: "image",
      assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]
    }
  ]
};
const broadcastId: string = "broadcast_live_202603";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

檢舉公開評論 (flagCommentPublic)

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
isFlagged	boolean	是
sso	string	否

回應

回傳: FlagCommentPublic200Response

範例

flagCommentPublic 範例

Copy

const tenantId: string = "tenant_9f8b3c";
const commentId: string = "comment_72a1d4";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

取得大型 GIF (getGifLarge)

參數

Name	Type	Required	Description
tenantId	string	是
largeInternalURLSanitized	string	是

回應

回傳: GifGetLargeResponse

範例

getGifLarge 範例

Copy

const tenantId: string = 'acme_marketing_tenant_7';
const largeInternalURLSanitized: string = 'https://cdn.acmeinc.com/gifs/promo-spring-2026_large_sanitized.gif';
const includePreview: boolean | undefined = undefined; // 呼叫者可能會使用的可選旗標
const result: GifGetLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);
console.log(result, includePreview);

搜尋 GIF (getGifsSearch)

參數

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

回應

回傳: GifSearchResponse

範例

getGifsSearch 範例

Copy

const tenantId: string = "tenant_fcm_42";
const search: string = "funny golden retriever";
const locale: string = "en-US";
const rating: string = "pg";
const page: number = 2;
const result: GifSearchResponse = await getGifsSearch(tenantId, search, locale, rating, page);

取得熱門 GIF (getGifsTrending)

參數

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

回應

回傳: GifSearchResponse

範例

getGifsTrending 範例

Copy

const tenantId: string = "acme-tenant-01";
const trendingBasic: GifSearchResponse = await getGifsTrending(tenantId);
const locale: string = "en-GB";
const rating: string = "pg";
const page: number = 1;
const trendingWithOptions: GifSearchResponse = await getGifsTrending(tenantId, locale, rating, page);

新增標籤 (addHashTag)

參數

名稱	型別	必填	說明
tenantId	string	否
createHashTagBody	CreateHashTagBody	否

回應

回傳: AddHashTag200Response

範例

addHashTag 範例

Copy

const tenantId: string | undefined = undefined;
const createHashTagBody: CreateHashTagBody = {
  name: 'release-2026',
  description: 'Feedback and bug reports for the April 2026 product release',
  synonyms: ['v2-release', 'launch-2026'],
  color: '#1d72b8',
  isActive: true,
  createdBy: 'product.manager@acme-corp.com'
};
const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

批次新增標籤 (addHashTagsBulk)

參數

名稱	類型	必填	說明
tenantId	string	否
bulkCreateHashTagsBody	BulkCreateHashTagsBody	否

回應

回傳：AddHashTagsBulk200Response

範例

addHashTagsBulk 範例

Copy

const tenantId: string = 'tenant_acme_corp_01';
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [
    { name: 'feature-request', slug: 'feature-request', description: 'Requests for new capabilities', isActive: true, customConfig: { visibility: 'public' } as unknown as CustomConfigParameters }
  ]
};
const addHashTagsResponse: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const bulkCreateHashTagsBodyNoTenant: BulkCreateHashTagsBody = {
  tags: [
    { name: 'ux-feedback', slug: 'ux-feedback', description: 'User experience suggestions', isActive: true }
  ]
};
const addHashTagsResponseNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBodyNoTenant);

刪除標籤 (deleteHashTag)

參數

名稱	類型	必填
tag	string	是
tenantId	string	否
deleteHashTagRequest	DeleteHashTagRequest	否

回應

回傳: FlagCommentPublic200Response

範例

deleteHashTag 範例

Copy

const tag: string = "spring-sale-2026";
const tenantId: string = "tenant-9876";
const deleteHashTagRequest: DeleteHashTagRequest = {
  requestedBy: "admin@retailco.com",
  reason: "Campaign ended; remove associated auto-tags",
  cascadeDelete: true
};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

取得標籤 (getHashTags)

參數

名稱	類型	必填	說明
tenantId	string	是
page	number	否

回應

回傳: GetHashTags200Response

範例

getHashTags 範例

Copy

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

部分更新標籤 (patchHashTag)

參數

名稱	類型	必填
tag	string	是
tenantId	string	否
updateHashTagBody	UpdateHashTagBody	否

回應

回傳：PatchHashTag200Response

範例

patchHashTag 範例

Copy

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

建立管理員 (createModerator)

參數

名稱	型別	必填	描述
tenantId	string	是
createModeratorBody	CreateModeratorBody	是

回應

回傳：CreateModerator200Response

範例

createModerator 範例

Copy

const tenantId: string = "tenant_8f3b6c";
const optionalConfig: CustomConfigParameters = { moderationThreshold: 5, escalateOnRepeatedOffenses: true };
const newModerator: CreateModeratorBody = {
  email: "lina.gomez@dailynews.com",
  fullName: "Lina Gomez",
  role: "senior_moderator",
  enabled: true,
  notifyByEmail: true,
  customConfig: optionalConfig
};
const response: CreateModerator200Response = await createModerator(tenantId, newModerator);

刪除管理員 (deleteModerator)

參數

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

回應

回傳: FlagCommentPublic200Response

範例

deleteModerator 範例

Copy

const tenantId: string = 'tenant_9f8b7c6d';
const id: string = 'mod_4a3e11ec9d1f0242ac120003';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, id, sendEmail);

取得管理員 (getModerator)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回傳

回傳: GetModerator200Response

範例

getModerator 範例

Copy

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

取得管理員清單 (getModerators)

參數

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

回應

回傳: GetModerators200Response

範例

getModerators 範例

Copy

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

發送邀請 (sendInvite)

參數

名稱	類型	必填
tenantId	string	是
id	string	是
fromName	string	是

回應

回傳: FlagCommentPublic200Response

範例

sendInvite 範例

Copy

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

更新管理員 (updateModerator)

參數

名稱	類型	必填
tenantId	string	是
id	string	是
updateModeratorBody	UpdateModeratorBody	是

回應

回傳：FlagCommentPublic200Response

範例

updateModerator 範例

Copy

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

刪除通知計數 (deleteNotificationCount)

參數

名稱	Type	必填	說明
tenantId	string	是
id	string	是

回應

回傳: FlagCommentPublic200Response

範例

deleteNotificationCount 範例

Copy

const tenantId: string = "org-72a8f1b9";
const id: string = "notif-8f9c2e4a";
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
console.log(result);

取得快取的通知計數 (getCachedNotificationCount)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回應

回傳： GetCachedNotificationCount200Response

範例

getCachedNotificationCount 範例

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // 可選參數旗標（示範）
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

取得通知計數 (getNotificationCount)

參數

名稱	類型	必填
tenantId	string	是
userId	string	否
urlId	string	否
fromCommentId	string	否
viewed	boolean	否
type	string	否

回應

回傳：GetNotificationCount200Response

範例

getNotificationCount 範例

Copy

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

取得通知 (getNotifications)

參數

名稱	類型	必填
tenantId	string	是
userId	string	否
urlId	string	否
fromCommentId	string	否
viewed	boolean	否
type	string	否
skip	number	否

回應

回傳: GetNotifications200Response

範例

getNotifications 範例

Copy

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

更新通知 (updateNotification)

參數

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

回應

回傳: FlagCommentPublic200Response

範例

updateNotification 範例

Copy

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

新增頁面 (addPage)

參數

名稱	類型	必填	說明
tenantId	string	是
createAPIPageData	CreateAPIPageData	是

回應

回傳: AddPageAPIResponse

刪除頁面 (deletePage)

參數

Name	Type	Required	Description
tenantId	string	是
id	string	是

Response

回傳: DeletePageAPIResponse

以 URL ID 取得頁面 (getPageByURLId)

參數

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

回應

回傳：GetPageByURLIdAPIResponse

取得頁面清單 (getPages)

參數

名稱	類型	必填	描述
tenantId	string	是

回應

回傳: GetPagesAPIResponse

部分更新頁面 (patchPage)

參數

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

回應

回傳: PatchPageAPIResponse

刪除待處理的 Webhook 事件 (deletePendingWebhookEvent)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回應

回傳: FlagCommentPublic200Response

範例

deletePendingWebhookEvent 範例

Copy

const tenantId: string = "tenant_7f3b2a";
const webhookEventId: string = "wh_evt_9a8c7d1234";
const dryRun: boolean | undefined = undefined; // 選用旗標範例（此呼叫不需要）
const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, webhookEventId);

取得待處理 Webhook 事件計數 (getPendingWebhookEventCount)

參數

名稱	類型	是否必填
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

回應

回傳: GetPendingWebhookEventCount200Response

範例

getPendingWebhookEventCount 範例

Copy

const tenantId: string = "tenant_8d3b7a2f";
const commentId: string | undefined = "comment_79a2b";
const eventType: string | undefined = "comment.created";
const domain: string | undefined = "forum.acme-corp.com";
const attemptCountGT: number | undefined = 1;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT
);

取得待處理的 Webhook 事件 (getPendingWebhookEvents)

參數

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

回應

回傳： GetPendingWebhookEvents200Response

範例

getPendingWebhookEvents 範例

Copy

const tenantId: string = 'tenant_9b3f7c';
const commentId: string | undefined = undefined;
const externalId: string | undefined = 'external-572a';
const eventType: string | undefined = 'comment.updated';
const type: string | undefined = 'outbound';
const domain: string | undefined = 'reviews.example.com';
const attemptCountGT: number | undefined = 1;
const skip: number | undefined = 20;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

建立問卷設定 (createQuestionConfig)

參數

名稱	類型	必填	描述
tenantId	string	是
createQuestionConfigBody	CreateQuestionConfigBody	是

回應

回傳：CreateQuestionConfig200Response

範例

createQuestionConfig 範例

Copy

const tenantId: string = "tenant_acme_01";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Post-purchase feedback",
  description: "Quick survey about your recent order",
  required: true,
  renderingType: "single_choice",
  options: [
    { label: "Very dissatisfied", value: "1" },
    { label: "Dissatisfied", value: "2" },
    { label: "Neutral", value: "3" },
    { label: "Satisfied", value: "4" },
    { label: "Very satisfied", value: "5" }
  ] as QuestionConfigCustomOptionsInner[]
} as CreateQuestionConfigBody;
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

刪除問卷設定 (deleteQuestionConfig)

參數

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

回應

回傳：FlagCommentPublic200Response

範例

deleteQuestionConfig 範例

Copy

const tenantId: string = "tenant_42fa9b7c";
const id: string = "qcfg-0f8fad5b-d9cb-469f-a165-70867728950e";
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

取得問卷設定 (getQuestionConfig)

參數

名稱	類型	必填	描述
tenantId	string	Yes
id	string	Yes

回應

回傳: GetQuestionConfig200Response

範例

getQuestionConfig 範例

Copy

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

取得問卷設定清單 (getQuestionConfigs)

參數

名稱	型別	必填	描述
tenantId	string	是
skip	number	否

回應

回傳: GetQuestionConfigs200Response

範例

getQuestionConfigs 範例

Copy

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

更新問卷設定 (updateQuestionConfig)

參數

Name	Type	Required
tenantId	string	是
id	string	是
updateQuestionConfigBody	UpdateQuestionConfigBody	是

回應

回傳: FlagCommentPublic200Response

範例

updateQuestionConfig 範例

Copy

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

建立問卷結果 (createQuestionResult)

參數

名稱	類型	必要	描述
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	Yes

回應

回傳: CreateQuestionResult200Response

範例

createQuestionResult 範例

Copy

const tenantId: string = 'fastcomments-tenant-01';
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: 'q-34567',
  respondentId: 'user-8923',
  answers: [{ optionId: 'opt_A', text: 'Agree', count: 1 }],
  score: 5,
  meta: [{ key: 'platform', value: 'web' }],
  notifyModerators: false // 可選參數
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

刪除問卷結果 (deleteQuestionResult)

參數

Name	Type	Required	Description
tenantId	string	是
id	string	是

回應

回傳: FlagCommentPublic200Response

範例

deleteQuestionResult 範例

Copy

const tenantIdEnv: string | undefined = process.env.FASTCOMMENTS_TENANT_ID;
const tenantId: string = tenantIdEnv ?? 'tenant_78b3f2';
const id: string = 'qres-9f2a3b1c';
const response: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);

取得問卷結果 (getQuestionResult)

參數

名稱	類型	是否必填	描述
tenantId	string	是
id	string	是

回應

回傳: GetQuestionResult200Response

範例

getQuestionResult 範例

Copy

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

取得問卷結果清單 (getQuestionResults)

參數

Name	Type	Required
tenantId	string	是
urlId	string	否
userId	string	否
startDate	string	否
questionId	string	否
questionIds	string	否
skip	number	否

回應

回傳: GetQuestionResults200Response

範例

getQuestionResults 範例

Copy

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

更新問卷結果 (updateQuestionResult)

參數

名稱	類型	必填
tenantId	string	是
id	string	是
updateQuestionResultBody	UpdateQuestionResultBody	是

回應

回傳: FlagCommentPublic200Response

範例

updateQuestionResult 範例

Copy

const tenantId: string = 'tenant_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // 可選的元資料
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

彙總問卷結果 (aggregateQuestionResults)

參數

名稱	類型	必填
tenantId	string	是
questionId	string	否
questionIds	Array	否
urlId	string	否
timeBucket	AggregateTimeBucket	否
startDate	Date	否
forceRecalculate	boolean	否

回應

回傳: AggregateQuestionResults200Response

範例

aggregateQuestionResults 範例

Copy

const tenantId: string = "tenant_acme_001";
const questionIds: string[] = ["q-2026-sales", "q-2026-support"];
const urlId: string = "url_7f2c";
const timeBucket: AggregateTimeBucket = { unit: "week", size: 1 };
const startDate: Date = new Date("2026-01-01T00:00:00Z");
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

批次彙總問卷結果 (bulkAggregateQuestionResults)

參數

名稱	類型	必填
tenantId	string	是
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	是
forceRecalculate	boolean	否

回應

回傳：BulkAggregateQuestionResults200Response

範例

bulkAggregateQuestionResults 範例

Copy

const tenantId: string = "tenant_acme_42";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  questions: [
    { questionId: "q-001", threadId: "thread-1001", questionType: "rating" },
    { questionId: "q-002", threadId: "thread-1002", questionType: "yes_no" }
  ],
  timeRange: { from: "2026-03-01T00:00:00Z", to: "2026-04-01T00:00:00Z" },
  groupBy: ["questionId", "threadId"]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

將評論與問卷結果合併 (combineCommentsWithQuestionResults)

參數

名稱	型別	必填
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-acme-001';
const questionId: string | undefined = 'q-analytics-42';
const questionIds: string[] | undefined = ['q-analytics-42', 'q-feedback-17'];
const urlId: string | undefined = 'url-987654';
const startDate: Date | undefined = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean | undefined = true;
const minValue: number | undefined = 1;
const maxValue: number | undefined = 5;
const limit: number | undefined = 250;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  questionId,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

新增 SSO 使用者 (addSSOUser)

參數

名稱	類型	必填	描述
tenantId	string	是
createAPISSOUserData	CreateAPISSOUserData	是

回應

回傳：AddSSOUserAPIResponse

刪除 SSO 使用者 (deleteSSOUser)

參數

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

回應

回傳: DeleteSSOUserAPIResponse

以電子郵件取得 SSO 使用者 (getSSOUserByEmail)

參數

名稱	類型	必填	說明
tenantId	string	是
email	string	是

回應

回傳: GetSSOUserByEmailAPIResponse

以 ID 取得 SSO 使用者 (getSSOUserById)

參數

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

回應

回傳: GetSSOUserByIdAPIResponse

取得 SSO 使用者清單 (getSSOUsers)

參數

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

回應

回傳: GetSSOUsers200Response

部分更新 SSO 使用者 (patchSSOUser)

參數

Name	Type	Required
tenantId	string	是
id	string	是
updateAPISSOUserData	UpdateAPISSOUserData	是
updateComments	boolean	否

回應

回傳: PatchSSOUserAPIResponse

取代或建立 SSO 使用者 (putSSOUser)

參數

名稱	類型	必填
tenantId	string	是
id	string	是
updateAPISSOUserData	UpdateAPISSOUserData	是
updateComments	boolean	否

回傳

回傳: PutSSOUserAPIResponse

建立訂閱 (createSubscription)

參數

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

刪除訂閱 (deleteSubscription)

參數

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

回應

回傳: DeleteSubscriptionAPIResponse

取得訂閱 (getSubscriptions)

參數

Name	Type	Required	Description
tenantId	string	是
userId	string	否

回應

回傳: GetSubscriptionsAPIResponse

範例

getSubscriptions 範例

Copy

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

更新訂閱 (updateSubscription)

參數

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

取得租戶每日使用量 (getTenantDailyUsages)

參數

名稱	類型	必填
tenantId	string	Yes
yearNumber	number	No
monthNumber	number	No
dayNumber	number	No
skip	number	No

回應

回傳：GetTenantDailyUsages200Response

範例

getTenantDailyUsages 範例

Copy

const tenantId: string = 'tenant_5f4a3b2c-1d6e-4f9a-b9d8-123456789abc';
const yearNumber: number = 2026;
const monthNumber: number = 3;
const dayNumber: number = 24;
const skip: number = 0;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, dayNumber, skip);

建立租戶方案 (createTenantPackage)

Parameters

Name	Type	Required	Description
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	Yes

Response

Returns: CreateTenantPackage200Response

Example

createTenantPackage 範例

Copy

const tenantId: string = "tenant_acme-corp_001";
const createTenantPackageBody: CreateTenantPackageBody = {
  name: "Acme Standard Package",
  description: "Default package for Acme Corp comments with moderation and SSO enabled",
  enabled: true,
  maxCommentsPerThread: 500,
  voteStyle: "thumbs",
  gifRating: "PG-13",
  tosConfig: { enabled: true, url: "https://acme.example.com/terms" } // 示範可選參數
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

刪除租戶方案 (deleteTenantPackage)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回應

回傳: FlagCommentPublic200Response

範例

deleteTenantPackage 範例

Copy

(async () => {
  const tenantId: string = "tenant_8f3a2b4c9d01";
  const packageId: string = "pkg_2026-04-security-patch";
  const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);
  console.log(result);
})();

取得租戶方案 (getTenantPackage)

參數

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

回應

回傳: GetTenantPackage200Response

範例

getTenantPackage 範例

Copy

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

取得租戶方案清單 (getTenantPackages)

參數

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

回應

回傳: GetTenantPackages200Response

範例

getTenantPackages 範例

Copy

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

取代租戶方案 (replaceTenantPackage)

參數

Name	Type	必填
tenantId	string	是
id	string	是
replaceTenantPackageBody	ReplaceTenantPackageBody	是

回應

回傳：FlagCommentPublic200Response

範例

replaceTenantPackage 範例

Copy

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

更新租戶方案 (updateTenantPackage)

參數

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

回傳

回傳：FlagCommentPublic200Response

範例

updateTenantPackage 範例

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // 已故意省略可選欄位（例如：description、limits）
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

建立租戶使用者 (createTenantUser)

參數

名稱	型別	必填	說明
tenantId	string	是
createTenantUserBody	CreateTenantUserBody	是

回應

傳回: CreateTenantUser200Response

範例

createTenantUser 範例

Copy

const tenantId: string = "tenant_74b3a9f4b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "jane.doe@acmecorp.com",
  displayName: "Jane Doe",
  role: "moderator",
  sendWelcomeEmail: true, // 示範可選參數
  metadata: { department: "Customer Support" }
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

刪除租戶使用者 (deleteTenantUser)

參數

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

回應

回傳: FlagCommentPublic200Response

範例

deleteTenantUser 範例

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme_corp_tenant_9f1a2b";
  const id: string = "user_4d2a1b6c";
  const deleteComments: string = "true"; // 同時刪除使用者的評論
  const commentDeleteMode: string = "permanent"; // "permanent" 或 "soft"
  const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);
  console.log(result);
}
run();

取得租戶使用者 (getTenantUser)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回應

回傳: GetTenantUser200Response

範例

getTenantUser 範例

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // 取得回傳內容
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

取得租戶使用者清單 (getTenantUsers)

參數

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

回應

Returns: GetTenantUsers200Response

範例

getTenantUsers 範例

Copy

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

取代租戶使用者 (replaceTenantUser)

參數

Name	Type	必填
tenantId	string	是
id	string	是
replaceTenantUserBody	ReplaceTenantUserBody	是
updateComments	string	否

回傳

回傳: FlagCommentPublic200Response

範例

replaceTenantUser 範例

Copy

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

發送登入連結 (sendLoginLink)

參數

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

回應

回傳： FlagCommentPublic200Response

範例

sendLoginLink 範例

Copy

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

更新租戶使用者 (updateTenantUser)

參數

名稱	類型	必填
tenantId	string	是
id	string	是
updateTenantUserBody	UpdateTenantUserBody	是
updateComments	string	否

回應

回傳: FlagCommentPublic200Response

範例

updateTenantUser 範例

Copy

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

建立租戶 (createTenant)

參數

名稱	Type	必填	描述
tenantId	string	是
createTenantBody	CreateTenantBody	是

回應

回傳：CreateTenant200Response

範例

createTenant 範例

Copy

const tenantId: string = 'acme-corp-001';
const createTenantBody: CreateTenantBody = {
  name: 'Acme Corporation',
  domainConfiguration: { primaryDomain: 'comments.acme.com', enforceHttps: true } as APIDomainConfiguration,
  billingInfo: { planId: 'enterprise', contactEmail: 'billing@acme.com' } as BillingInfo
  // 可選欄位（例如 ssoConfig 或 customConfig）故意省略
} as CreateTenantBody;
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

刪除租戶 (deleteTenant)

參數

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

回應

回傳：FlagCommentPublic200Response

範例

deleteTenant 範例

Copy

const tenantId: string = 'tenant_42c9f1';
const id: string = 'flag_9a7b3c';
const sure: string = 'confirm-delete';
const result: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

取得租戶 (getTenant)

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

回應

Returns: GetTenant200Response

範例

getTenant 範例

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // 可選的覆寫（若可用）
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

取得租戶清單 (getTenants)

參數

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

回應

回傳: GetTenants200Response

範例

getTenants 範例

Copy

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

更新租戶 (updateTenant)

參數

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

回應

回傳: FlagCommentPublic200Response

範例

updateTenant 範例

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // 選填，省略以保留目前的帳單資訊
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

變更工單狀態 (changeTicketState)

參數

名稱	類型	必填
tenantId	string	是
userId	string	是
id	string	是
changeTicketStateBody	ChangeTicketStateBody	是

回應

回傳: ChangeTicketState200Response

範例

changeTicketState 範例

Copy

const tenantId: string = "tenant_7f3b2c9a";
const userId: string = "user_5a1d9fb2";
const id: string = "ticket_3e8a1b6f";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  reason: "Fixed in backend release 2.4.1",
  notifyUsers: true,
  metadata: { resolutionOwner: "agent_12", priority: "high" } // 示範可選欄位
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

建立工單 (createTicket)

參數

名稱	類型	必要
tenantId	string	是
userId	string	是
createTicketBody	CreateTicketBody	是

回應

回傳: CreateTicket200Response

範例

createTicket 範例

Copy

const tenantId: string = '7f3e9b1a-1c2d-4a5b-b6c7-d8e9f0123456';
const userId: string = 'd290f1ee-6c54-4b01-90e6-d701748f0851';
const createTicketBody: CreateTicketBody = {
  subject: 'Unable to post comments on product update',
  message: 'Submitting a comment returns a 504 timeout after ~10s. Reproducible in Chrome and Firefox.',
  priority: 'high', // 可選欄位（已包含）
  contactEmail: 'jane.doe@acme-corp.com',
  ccEmails: ['eng-oncall@acme-corp.com'], // 可選欄位（已包含）
  metadata: { page: '/blog/product-update', browser: 'Chrome 112' } // 可選
};
const response: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

取得工單 (getTicket)

參數

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

回應

回傳: GetTicket200Response

範例

getTicket 範例

Copy

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

取得工單清單 (getTickets)

參數

名稱	類型	必填
tenantId	string	是
userId	string	否
state	number	否
skip	number	否
limit	number	否

回應

回傳: GetTickets200Response

範例

getTickets 範例

Copy

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

取得翻譯 (getTranslations)

參數

名稱	類型	必填
namespace	string	是
component	string	是
locale	string	否
useFullTranslationIds	boolean	否

回應

回傳：GetTranslationsResponse

範例

getTranslations 範例

Copy

const translationsBase: GetTranslationsResponse = await getTranslations("acme-site-482", "commentThread");
const translationsSpanishFullIds: GetTranslationsResponse = await getTranslations("acme-site-482", "commentThread", "es-ES", true);

上傳圖片 (uploadImage)

上傳並調整圖片大小

參數

名稱	類型	必填
tenantId	string	是
file	Blob	是
sizePreset	SizePreset	否
urlId	string	否

回應

回傳: UploadImageResponse

以 ID 取得使用者徽章進度 (getUserBadgeProgressById)

參數

名稱	類型	是否必填	描述
tenantId	string	是
id	string	是

回應

回傳: GetUserBadgeProgressById200Response

範例

getUserBadgeProgressById 範例

Copy

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

以使用者 ID 取得徽章進度 (getUserBadgeProgressByUserId)

參數

名稱	類型	必填	說明
tenantId	string	是
userId	string	是

回應

回傳: GetUserBadgeProgressById200Response

範例

getUserBadgeProgressByUserId 範例

Copy

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

取得使用者徽章進度清單 (getUserBadgeProgressList)

參數

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

回應

回傳: GetUserBadgeProgressList200Response

範例

getUserBadgeProgressList 範例

Copy

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

建立使用者徽章 (createUserBadge)

參數

名稱	類型	必填	說明
tenantId	string	是
createUserBadgeParams	CreateUserBadgeParams	是

回應

回傳: CreateUserBadge200Response

範例

createUserBadge 範例

Copy

const tenantId: string = "tenant_9a8b7c";
const params: CreateUserBadgeParams = {
  name: "Top Contributor",
  slug: "top-contributor",
  description: "Awarded for 100 approved comments",
  iconUrl: "https://cdn.fastcomments.com/badges/top-contributor.png",
  active: true,
  criteria: { approvedComments: 100 },
  customConfig: { showOnProfile: true } // 可選參數
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, params);

刪除使用者徽章 (deleteUserBadge)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回應

回傳: UpdateUserBadge200Response

範例

deleteUserBadge 範例

Copy

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

取得使用者徽章 (getUserBadge)

參數

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

回應

回傳：GetUserBadge200Response

範例

getUserBadge 範例

Copy

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

取得使用者徽章清單 (getUserBadges)

參數

名稱	Type	必填
tenantId	string	是
userId	string	否
badgeId	string	否
type	number	否
displayedOnComments	boolean	否
limit	number	否
skip	number	否

回傳

回傳: GetUserBadges200Response

範例

getUserBadges 範例

Copy

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

更新使用者徽章 (updateUserBadge)

參數

名稱	類型	必填
tenantId	string	是
id	string	是
updateUserBadgeParams	UpdateUserBadgeParams	是

回應

回傳：UpdateUserBadge200Response

範例

updateUserBadge 範例

Copy

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

取得使用者通知計數 (getUserNotificationCount)

參數

名稱	類型	必填	說明
tenantId	string	是
sso	string	否

回應

回傳： GetUserNotificationCount200Response

範例

getUserNotificationCount 範例

Copy

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

取得使用者通知 (getUserNotifications)

參數

名稱	型別	必填
tenantId	string	是
pageSize	number	否
afterId	string	否
includeContext	boolean	否
afterCreatedAt	number	否
unreadOnly	boolean	否
dmOnly	boolean	否
noDm	boolean	否
includeTranslations	boolean	否
sso	string	否

回應

回傳: GetUserNotifications200Response

範例

getUserNotifications 範例

Copy

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

重設使用者通知計數 (resetUserNotificationCount)

參數

名稱	類型	必填	描述
tenantId	string	是
sso	string	否

回應

回傳: ResetUserNotifications200Response

範例

resetUserNotificationCount 範例

Copy

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

重設使用者通知 (resetUserNotifications)

參數

名稱	Type	必填
tenantId	string	是
afterId	string	否
afterCreatedAt	number	否
unreadOnly	boolean	否
dmOnly	boolean	否
noDm	boolean	否
sso	string	否

回應

回傳: ResetUserNotifications200Response

範例

resetUserNotifications 範例

Copy

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

更新使用者評論訂閱狀態 (updateUserNotificationCommentSubscriptionStatus)

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

參數

名稱	類型	必填
tenantId	string	是
notificationId	string	是
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	是
commentId	string	是
sso	string	否

回應

回傳: UpdateUserNotificationStatus200Response

範例

updateUserNotificationCommentSubscriptionStatus 範例

Copy

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

更新使用者頁面訂閱狀態 (updateUserNotificationPageSubscriptionStatus)

為頁面啟用或停用通知。當使用者訂閱某個頁面時，會建立通知針對新的根留言，並且還

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
url	string	是
pageTitle	string	是
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	是
sso	string	否

回應

回傳: UpdateUserNotificationStatus200Response

範例

updateUserNotificationPageSubscriptionStatus 範例

Copy

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

更新使用者通知狀態 (updateUserNotificationStatus)

參數

名稱	類型	必填
tenantId	string	是
notificationId	string	是
newStatus	UpdateUserNotificationStatusNewStatusEnum	是
sso	string	否

回應

回傳: UpdateUserNotificationStatus200Response

範例

updateUserNotificationStatus 範例

Copy

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

取得使用者在席狀態 (getUserPresenceStatuses)

參數

Name	Type	Required
tenantId	string	是
urlIdWS	string	是
userIds	string	是

回應

回傳: GetUserPresenceStatuses200Response

範例

getUserPresenceStatuses 範例

Copy

const tenantId: string = 'tenant_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // 可選來源
const userIds: string = maybeUserIds ?? 'user_123';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

搜尋使用者 (searchUsers)

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
usernameStartsWith	string	否
mentionGroupIds	Array	否
sso	string	否
searchSection	SearchUsersSearchSectionEnum	否

回應

回傳: SearchUsers200Response

範例

searchUsers 範例

Copy

const tenantId: string = 'tenant_8392';
const urlId: string = 'articles/2026/03/25/fastcomments-release';
const usernameStartsWith: string = 'jo';
const mentionGroupIds: Array<string> = ['editors', 'senior-writers'];
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.ALL;
const result: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

取得使用者 (getUser)

參數

名稱	類型	必填	說明
tenantId	string	是
id	string	是

回應

回傳: GetUser200Response

範例

getUser 範例

Copy

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

建立投票 (createVote)

參數

名稱	類型	必填
tenantId	string	是
commentId	string	是
direction	CreateVoteDirectionEnum	是
userId	string	否
anonUserId	string	否

回應

回傳：VoteComment200Response

範例

createVote 範例

Copy

const tenantId: string = 'tenant_5f2a9b';
const commentId: string = 'cmt_3b7e21';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const anonUserId: string = 'anon_9x7k2p';
const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);

刪除投票 (deleteVote)

參數

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

回應

回傳: DeleteCommentVote200Response

範例

deleteVote 範例

Copy

const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
const id: string = 'vote-7a1b2c3d-9f8e-4b6a-8123-abcdef012345';
const editKey: string = 'editKey_4f3e2d1c';
const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);

取得投票 (getVotes)

參數

名稱	類型	必填	說明
tenantId	string	是
urlId	string	是

回應

回傳: GetVotes200Response

範例

getVotes 範例

Copy

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

取得使用者的投票 (getVotesForUser)

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
userId	string	否
anonUserId	string	否

回應

回傳: GetVotesForUser200Response

範例

getVotesForUser 範例

Copy

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

需要幫助嗎？

如果您在使用 JavaScript/TypeScript SDK 時遇到任何問題或有任何疑問，請：

貢獻

歡迎貢獻！請造訪 GitHub 儲存庫以取得貢獻指南。

語言 🇹🇼 繁體中文

入門指南

API 參考

文件

使用說明

彙總

稽核日誌

從評論封鎖

檢查被封鎖的評論

評論

使用者的評論

網域設定

電子郵件範本

事件記錄

動態貼文

檢舉評論

GIF 動圖

標籤

管理員

通知計數

通知

頁面

待處理的 Webhook 事件

問卷設定

問卷結果

問卷結果彙總

SSO 使用者

訂閱

租戶每日使用量

租戶方案

租戶使用者

租戶

工單

翻譯

上傳圖片

使用者徽章進度

使用者徽章

使用者通知

使用者在線狀態

使用者搜尋

使用者

投票

FastComments JavaScript/TypeScript SDK

儲存庫

安裝

API 文件

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

瀏覽器與伺服器相容性

用法

瀏覽器 用法（客戶端）

伺服器 用法（Node.js）

僅匯入類型

使用個別 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

錯誤處理

彙總 (aggregate)

參數

回應

取得稽核日誌 (getAuditLogs)

參數

回應

瀏覽器用法（客戶端）

伺服器用法（Node.js）

瀏覽器環境

伺服器環境