FastComments JavaScript/TypeScript SDK

這是 FastComments 的官方 JavaScript/TypeScript SDK。

可從 Node.js 或瀏覽器管理評論、使用者、SSO（單一登入）和審核。

儲存庫

安裝

npm install fastcomments-sdk

API 文件

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

瀏覽器 vs 伺服器相容性

此 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 vs 受保護 API

該 SDK 提供以下 API 類別：

DefaultApi - 需要您的 API 金鑰用於驗證的受保護端點。用於伺服器端作業。
PublicApi - 可在未提供 API 金鑰下存取的公開端點。可直接從瀏覽器/行動裝置/等呼叫。
ModerationApi - 管理員儀表板端點（留言審核、封鎖、徽章、信任指數、搜尋）。透過管理員的會話進行驗證；對於以 SSO 驗證的管理員，傳入 sso 查詢參數。
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'
});

範例：使用 Moderation API

import { createFastCommentsSDK } from 'fastcomments-sdk/server';

const sdk = createFastCommentsSDK({ /* basePath 等 */ });

// 管理員已驗證的呼叫（使用 session cookie，或為 SSO 管理員傳入 `sso`）。
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

await sdk.moderationApi.postSetCommentSpamStatus({
  commentId: 'comment-id',
  spam: true
});

單一登入 (SSO) 整合

FastComments 支援 SSO 以整合您現有的使用者認證系統。 SSO 功能僅在伺服器端匯出時可用，因為它需要 Node.js 的 crypto 功能。

Simple SSO (Server-Side Only)

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

// 伺服器端程式碼（Node.js/backend）
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// 使用內建輔助函式建立簡易 SSO  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

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

const ssoToken = sso.createToken();

// 將 ssoToken 傳送到你的客戶端程式碼
// 客戶端程式碼之後可以使用此 token 與瀏覽器 SDK

Secure SSO (Server-Side, Recommended)

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

// 伺服器端程式碼（Node.js/backend）
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

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

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

const ssoConfig = sso.prepareToSend();

// 用於伺服器上的 API 呼叫
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// 或將 ssoConfig 傳送給客戶端供瀏覽器使用

Using SSO from Browser (with Server-Generated Token)

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

// 從你的伺服器端點取得 SSO token
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // 使用伺服器產生的 SSO token
});

SSO with Comment Creation

// 伺服器端：建立 SSO 與留言
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

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

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

常見使用情境

取得頁面留言

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

建立留言

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

對留言投票

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

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

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

即時事件 (即時更新)

訂閱即時事件以獲取有關留言、點讚和其他活動的即時更新。

頁面層級事件

監聽特定頁面的即時事件（留言、點讚等）：

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

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

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

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

訂閱使用者事件

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

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

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

// 訂閱使用者的個人資訊流
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // 在您的介面中顯示通知
        break;
      case LiveEventType.notification_update:
        console.log('Notification updated:', event.notification);
        break;
      default:
        console.log('Other user event:', event.type);
    }
    
    return true;
  },
  (isConnected: boolean) => {
    console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
  }
);

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

取得 userIdWS

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

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

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

if (userIdWS) {
  // 現在您可以訂閱即時事件
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

廣播 ID

你會看到在某些 API 呼叫中應該傳入 broadcastId。當你接收事件時，你會得到這個 ID 回傳，因此如果你打算在客戶端採取樂觀更新（你很可能會想這麼做，因為它提供最佳體驗），你就會知道要忽略該事件。請在此傳入 UUID。該 ID 應該足夠唯一，以免在瀏覽器會話中出現兩次。

import { v4 as uuidv4 } from 'uuid';

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

錯誤處理

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

彙總

聚合文件，透過分組（如果提供 groupBy）並套用多項操作。支援不同的操作（例如 sum、countDistinct、avg 等）。

參數

名稱	類型	必填
tenantId	string	Yes
aggregationRequest	AggregationRequest	Yes
parentTenantId	string	No
includeStats	boolean	No

回應

返回：AggregateResponse

範例

聚合示例

Copy

const tenantId: string = "tenant-12345";
const aggregationRequest: AggregationRequest = {
  predicates: [
    {
      field: "status",
      operator: "eq",
      value: { type: "string", value: "approved" }
    }
  ],
  operations: [
    { type: "count", field: "commentId" }
  ],
  sort: { field: "createdAt", direction: "desc" }
};
const parentTenantId: string = "parent-001";
const includeStats: boolean = true;
const result: AggregateResponse = await aggregate(
  tenantId,
  aggregationRequest,
  parentTenantId,
  includeStats
);

取得稽核日誌

參數

名稱	類型	必填
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

回應

返回：GetAuditLogsResponse1

範例

getAuditLogs 範例

Copy

(async () => {
  const tenantId: string = "tenant_42";
  const limit: number = 100;
  const skip: number = 10;
  const order: SORTDIR = "desc";
  const after: number = Date.now() - 3 * 24 * 60 * 60 * 1000; // 3 天前
  const auditResponse: GetAuditLogsResponse1 = await getAuditLogs(
    tenantId,
    limit,
    skip,
    order,
    after
  );
  console.log(auditResponse);
})();

從留言封鎖（公開）

參數

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

回應

返回: BlockFromCommentPublicResponse

範例

blockFromCommentPublic 範例

Copy

async function demo() {
  const tenantId: string = "tenant_9f8b7c";
  const commentId: string = "cmt_1234567890";
  const blockParams: PublicBlockFromCommentParams = {
    reason: "spam",
    durationHours: 24,
  };
  const ssoToken: string = "sso_ABCDEF123456";
  const responseWithSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(
    tenantId,
    commentId,
    blockParams,
    ssoToken
  );
  const responseWithoutSso: BlockFromCommentPublicResponse = await blockFromCommentPublic(
    tenantId,
    commentId,
    blockParams
  );
  console.log(responseWithSso, responseWithoutSso);
}
demo();

解除封鎖留言（公開）

參數

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

回應

回傳: UnBlockCommentPublicResponse

範例

unBlockCommentPublic 範例

Copy

const tenantId: string = "acme-corp-tenant";
const commentId: string = "cmt-20230915-001";
const unblockParams: PublicBlockFromCommentParams = {
  reason: "User appealed and was cleared",
  unblockExpiresAt: new Date(Date.now() + 24 * 60 * 60 * 1000).toISOString()
};
const ssoToken: string = "sso-3d9f8a7b";
const result: UnBlockCommentPublicResponse = await unBlockCommentPublic(
  tenantId,
  commentId,
  unblockParams,
  ssoToken
);

檢查被封鎖的留言

參數

名稱	類型	必填
tenantId	string	Yes
commentIds	string	Yes
sso	string	No

回應

返回：CheckedCommentsForBlockedResponse

範例

checkedCommentsForBlocked 範例

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const commentIds: string = "cmt_001,cmt_002";
  const ssoToken: string = "ssoTokenXYZ";
  const blockedCheck: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds);
  const blockedCheckWithSso: CheckedCommentsForBlockedResponse = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);
})();

封鎖使用者（留言）

參數

名稱	類型	必要
tenantId	string	是
id	string	是
blockFromCommentParams	BlockFromCommentParams	是
userId	string	否
anonUserId	string	否

回應

返回: BlockUserFromCommentResponse

範例

blockUserFromComment 範例

Copy

const tenantId: string = 'tenant_42';
const commentId: string = 'cmt_20231101';
const blockParams: BlockFromCommentParams = {
  reason: 'spam',
  blockDurationHours: 24,
};
const userId: string = 'user_123'; // 可選參數
const response: BlockUserFromCommentResponse = await blockUserFromComment(
  tenantId,
  commentId,
  blockParams,
  userId
);

建立公開留言

參數

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
commentData	CommentData	Yes
sessionId	string	No
sso	string	No

回應

返回: CreateCommentPublicResponse

示例

createCommentPublic 示例

Copy

(async () => {
  const tenantId: string = "tenant-abc123";
  const urlId: string = "post-987654";
  const broadcastId: string = "bcast-001";
  const commentData: CommentData = {
    content: "I really enjoyed this article!"
  };
  const sessionId: string = "session-xyz789";
  const sso: string = "sso-token-456def";
  const response: CreateCommentPublicResponse = await createCommentPublic(
    tenantId,
    urlId,
    broadcastId,
    commentData,
    sessionId,
    sso
  );
  console.log(response);
})();

刪除留言

參數

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

回應

Returns: DeleteCommentResponse

範例

deleteComment 範例

Copy

(async () => {
  const tenantId: string = 'tenant_01';
  const commentId: string = 'comment_abc123';
  const contextUserId: string = 'user_42';
  const isLive: boolean = false;
  const deleteResult: DeleteCommentResponse = await deleteComment(tenantId, commentId, contextUserId, isLive);
  const simpleResult: DeleteCommentResponse = await deleteComment(tenantId, commentId);
})();

刪除公開留言

參數

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

回應

返回: DeleteCommentPublicResponse

範例

deleteCommentPublic 範例

Copy

(async () => {
  const tenantId: string = 'c6f9a2e3-9b1d-4f8a-b2d2-1a2b3c4d5e6f';
  const commentId: string = '7d9f0b1c-2e3f-4a5b-6c7d-8e9f0a1b2c3d';
  const broadcastId: string = 'live-2023-09-15';
  const editKey: string = 'ed1tK3y1234567890';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.abc123';
  const result: DeleteCommentPublicResponse = await deleteCommentPublic(
    tenantId,
    commentId,
    broadcastId,
    editKey,
    sso
  );
})();

刪除留言投票

參數

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

回應

返回：DeleteCommentVoteResponse

範例

deleteCommentVote 範例

Copy

async function removeVote() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const voteId: string = "vote_abcde";
  const urlId: string = "url_56789";
  const broadcastId: string = "brd_001";
  const editKey: string = "edit_456";
  // sso 為可選項，已省略
  const response: DeleteCommentVoteResponse = await deleteCommentVote(
    tenantId,
    commentId,
    voteId,
    urlId,
    broadcastId,
    editKey
  );
  console.log(response);
}
removeVote();

檢舉留言

參數

Name	Type	Required
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

回應

返回：FlagCommentResponse1

範例

flagComment 範例

Copy

(async () => {
  const tenantId: string = "tenant_2023";
  const commentId: string = "comment_5678";
  const userId: string = "user_1234";
  const anonUserId: string = "anon_4321";
  const result: FlagCommentResponse1 = await flagComment(tenantId, commentId, userId);
  const anonResult: FlagCommentResponse1 = await flagComment(tenantId, commentId, undefined, anonUserId);
})();

取得留言

參數

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

回應

返回: GetCommentResponse

範例

getComment 範例

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-987654";
  const result: GetCommentResponse = await getComment(tenantId, commentId);
  const badgeInfo: CommentUserBadgeInfo | undefined = result.comment?.user?.badgeInfo;
  console.log(badgeInfo?.label);
})();

取得多則留言

參數

Name	Type	Required
tenantId	string	Yes
page	number	No
limit	number	No
skip	number	No
asTree	boolean	No
skipChildren	number	No
limitChildren	number	No
maxTreeDepth	number	No
urlId	string	No
userId	string	No
anonUserId	string	No
contextUserId	string	No
hashTag	string	No
parentId	string	No
direction	SortDirections	No
fromDate	number	No
toDate	number	No

回應

Returns: GetCommentsResponse

範例

getComments 範例

Copy

const tenantId: string = "tenant_12345";
const page: number = 2;
const limit: number = 50;
const asTree: boolean = true;
const urlId: string = "article_5678";
const direction: SortDirections = "desc";
const fromDate: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 一週前
const toDate: number = Date.now();
const commentsResponse: GetCommentsResponse = await getComments({
  tenantId,
  page,
  limit,
  asTree,
  urlId,
  direction,
  fromDate,
  toDate,
});

取得公開留言

請求
tenantId
urlId

參數

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

回應

返回：GetCommentsPublicResponse

範例

getCommentsPublic 範例

Copy

async function fetchComments() {
  const tenantId: string = 'acme-corp';
  const urlId: string = 'blog/post-789';
  const page: number = 1;
  const direction: SortDirections = SortDirections.Desc;
  const limit: number = 25;
  const includeConfig: boolean = true;
  const locale: string = 'en-GB';
  const modules: string = 'reactions,attachments';
  const isCrawler: boolean = false;
  const includeNotificationCount: boolean = true;
  const asTree: boolean = true;
  const maxTreeDepth: number = 4;
  const searchText: string = 'TypeScript';
  const hashTags: string[] = ['typescript', 'api'];
  const response: GetCommentsPublicResponse = await getCommentsPublic(
    tenantId,
    urlId,
    page,
    direction,
    undefined,
    undefined,
    undefined,
    limit,
    undefined,
    undefined,
    undefined,
    includeConfig,
    undefined,
    undefined,
    locale,
    modules,
    isCrawler,
    includeNotificationCount,
    asTree,
    maxTreeDepth,
    undefined,
    undefined,
    searchText,
    hashTags,
    undefined,
    undefined,
    undefined,
    undefined
  );
}

取得留言文字

參數

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

回應

返回：GetCommentTextResponse1

範例

getCommentText 範例

Copy

async function run() {
  const tenantId: string = "acme-corp-tenant";
  const commentId: string = "cmt-5f2e9a1b";
  const editKey: string = "edk-9b7c3";
  const ssoToken: string = "sso-xyz789";
  const commentOnly: GetCommentTextResponse1 = await getCommentText(tenantId, commentId);
  const commentWithEdit: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey);
  const commentFull: GetCommentTextResponse1 = await getCommentText(tenantId, commentId, editKey, ssoToken);
}
run();

取得留言投票者名稱

參數

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

回應

返回：GetCommentVoteUserNamesResponse

範例

getCommentVoteUserNames 範例

Copy

async function demoGetCommentVoteUserNames() {
  const tenantId: string = "acme-corp";
  const commentId: string = "cmt_5f2a1e3b";
  const dir: number = 1; // 升序
  const votesWithoutSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir
  );
  const ssoToken: string = "sso_abcdef123456";
  const votesWithSSO: GetCommentVoteUserNamesResponse = await getCommentVoteUserNames(
    tenantId,
    commentId,
    dir,
    ssoToken
  );
  console.log(votesWithoutSSO, votesWithSSO);
}

鎖定留言

參數

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

回應

返回：LockCommentResponse

範例

lockComment 範例

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_54321";
  // 使用可選的 SSO 令牌
  const ssoToken: string = "user-abc123";
  const lockedWithSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);
  // 未使用 SSO 令牌
  const lockedWithoutSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId);
})();

置頂留言

參數

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

回應

返回: PinCommentResponse

範例

pinComment 範例

Copy

(async () => {
  const tenantId: string = 'tenant-001';
  const commentId: string = 'comment-5678';
  const broadcastId: string = 'broadcast-2023';
  const ssoToken: string = 'sso-xyz-789';
  const pinResult: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId);
  const pinResultWithSso: PinCommentResponse = await pinComment(tenantId, commentId, broadcastId, ssoToken);
})();

儲存留言

參數

名稱	型別	必填
tenantId	string	Yes
createCommentParams	CreateCommentParams	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

回應

回傳: SaveCommentResponse

範例

saveComment 範例

Copy

async function submitComment() {
  const tenantId: string = "tenant_9f8e7d6c";
  const commentParams: CreateCommentParams = {
    text: "Great post, thanks for sharing!",
    authorId: "user_123abc",
    mentions: [] as CommentUserMentionInfo[],
    hashtags: [] as CommentUserHashTagInfo[]
  };
  const response: SaveCommentResponse = await saveComment(
    tenantId,
    commentParams,
    true,   // isLive
    false   // doSpamCheck
  );
  console.log(response);
}
submitComment();

批次儲存留言

參數

名稱	類型	必填
tenantId	string	Yes
createCommentParams	Array	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

回應

返回：Array<SaveCommentsBulkResponse

範例

saveCommentsBulk 範例

Copy

const tenantId: string = "tenant_9f8b7c6d";
const bulkComments: CreateCommentParams[] = [
  {
    content: "Welcome to the new forum thread!",
    authorId: "user_42",
    mentions: [{ userId: "user_84", username: "alice" }],
    hashtags: [{ tag: "intro" }]
  },
  {
    content: "Please review the updated guidelines.",
    authorId: "moderator_1",
    mentions: [],
    hashtags: [{ tag: "guidelines" }, { tag: "update" }]
  }
];
const results: SaveCommentsBulkResponse[] = await saveCommentsBulk(
  tenantId,
  bulkComments,
  true,      // 是否為實時
  false,     // 執行垃圾郵件檢查
  true,      // 發送電子郵件
  undefined  // 填充通知（使用預設）
);

設定留言文字

參數

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

回應

返回：SetCommentTextResponse1

範例

setCommentText 範例

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const commentId: string = 'cmt_98765';
  const broadcastId: string = 'brd_112233';
  const commentTextUpdateRequest: CommentTextUpdateRequest = {
    text: 'Updated comment with @john.doe and #important',
    mentions: [{ userId: 'user_001', username: 'john.doe' }],
    hashtags: [{ tag: 'important' }],
  };
  const editKey: string = 'edit_abc123';
  const result: SetCommentTextResponse1 = await setCommentText(
    tenantId,
    commentId,
    broadcastId,
    commentTextUpdateRequest,
    editKey,
  );
  console.log(result);
})();

解除封鎖使用者（留言）

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
unBlockFromCommentParams	UnBlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

回應

返回：UnBlockUserFromCommentResponse

範例

unBlockUserFromComment 範例

Copy

async function demoUnblock() {
  const tenantId: string = "acme-corp-tenant";
  const commentId: string = "cmt_9f8b7a6d";
  const params: UnBlockFromCommentParams = {
    reason: "User resolved the issue",
    notifyUser: true
  };
  const userId: string = "usr_12345";
  const result: UnBlockUserFromCommentResponse = await unBlockUserFromComment(
    tenantId,
    commentId,
    params,
    userId
    // anonUserId 已省略
  );
  console.log(result);
}
demoUnblock();

取消檢舉留言

參數

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

回應

返回：UnFlagCommentResponse

範例

unFlagComment 範例

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_123456";
const userId: string = "usr_98765";
const result: UnFlagCommentResponse = await unFlagComment(tenantId, commentId, userId);
const anonCommentId: string = "cmt_123457";
const anonUserId: string = "anon_abc123";
const anonResult: UnFlagCommentResponse = await unFlagComment(tenantId, anonCommentId, undefined, anonUserId);

解鎖留言

參數

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

回應

返回：UnLockCommentResponse

範例

unLockComment 範例

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_9876";
const broadcastId: string = "brd_001";
const ssoToken: string | undefined = "sso_token_abc";
async function run() {
  const unlocked: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId, ssoToken);
  console.log(unlocked);
  // 呼叫時省略可選的 sso 參數
  const unlockedWithoutSso: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId);
  console.log(unlockedWithoutSso);
}
run();

取消置頂留言

參數

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

回應

返回: UnPinCommentResponse

範例

unPinComment 範例

Copy

(async () => {
  const tenantId: string = "tenant-001"
  const commentId: string = "comment-123"
  const broadcastId: string = "broadcast-456"
  const sso: string = "sso-token-xyz"
  const resultWithSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId, sso)
  const resultWithoutSso: UnPinCommentResponse = await unPinComment(tenantId, commentId, broadcastId)
  console.log(resultWithSso, resultWithoutSso)
})()

更新留言

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
updatableCommentParams	UpdatableCommentParams	Yes
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

回應

返回: UpdateCommentResponse

範例

updateComment 範例

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const updatableCommentParams: UpdatableCommentParams = {
  // 範例欄位；實際結構取決於 API 定義
  // 例如，body: "Edited comment content",
};
const contextUserId: string = "user_abcde";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: UpdateCommentResponse = await updateComment(
  tenantId,
  commentId,
  updatableCommentParams,
  contextUserId,
  doSpamCheck,
  isLive
);

留言投票

參數

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
voteBodyParams	VoteBodyParams	Yes
sessionId	string	No
sso	string	No

回應

Returns: VoteCommentResponse

範例

voteComment 範例

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_9f8e7d6c";
const urlId: string = "url_123456";
const broadcastId: string = "bcast_2024_01";
const voteBodyParams: VoteBodyParams = {
  vote: "up",               // 例如 "up" | "down"
  weight: 1,                // 投票的可選加權
};
const sessionId: string = "sess_abc123def";
const sso: string = "sso_token_xyz";
const result: VoteCommentResponse = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

取得使用者的留言

參數

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

回應

Returns: GetCommentsForUserResponse1

範例

getCommentsForUser 範例

Copy

async function demo() {
    const userId: string = "user-12345";
    const direction: SortDirections = "desc";
    const page: number = 1;
    const includei10n: boolean = true;
    const locale: string = "en-US";
    const isCrawler: boolean = false;
    const response: GetCommentsForUserResponse1 = await getCommentsForUser(
        userId,
        direction,
        undefined,
        page,
        includei10n,
        locale,
        isCrawler
    );
    console.log(response);
}

新增網域設定

參數

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

回應

返回：AddDomainConfigResponse

範例

addDomainConfig 範例

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const config: AddDomainConfigParams = {
    domain: 'myblog.example.com',
    enabled: true,
    // description 是可選的，此處省略
  };
  const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);
  console.log(response);
})();

刪除網域設定

參數

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

回應

返回：DeleteDomainConfigResponse

範例

deleteDomainConfig 範例

Copy

async function runExample() {
  const tenantId: string = 'acme-corp';
  const domain: string = 'blog.acme.com';
  const response: DeleteDomainConfigResponse = await deleteDomainConfig(tenantId, domain);
  console.log(response);
}
runExample();

取得網域設定

參數

Name	Type	Required	Description
tenantId	string	Yes
domain	string	Yes

回應

返回：GetDomainConfigResponse

範例

getDomainConfig 範例

Copy

async function main() {
  const tenantId: string = "acme-corp-123";
  const domain: string = "blog.acme.com";
  const config: GetDomainConfigResponse = await getDomainConfig(tenantId, domain);
  console.log(config);
}
main();

取得多個網域設定

參數

名稱	類型	必要	描述
tenantId	string	是

回應

返回: GetDomainConfigsResponse

範例

getDomainConfigs 範例

Copy

async function fetchDomainConfigs(): Promise<void> {
  const tenantId: string = "acme-corp-567";
  const configs: GetDomainConfigsResponse = await getDomainConfigs(tenantId);
  console.log(configs);
}

部分更新網域設定

參數

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

回應

Returns: PatchDomainConfigResponse

範例

patchDomainConfig 範例

Copy

async function updateDomainConfig() {
  const tenantId: string = "tenant_98765";
  const domainToUpdate: string = "forum.mycompany.com";
  const patchParams: PatchDomainConfigParams = {
    enableComments: true,
    moderationLevel: "strict",
    allowAnonymous: false, // 示範可選參數
  };
  const response: PatchDomainConfigResponse = await patchDomainConfig(tenantId, domainToUpdate, patchParams);
  console.log(response);
}
updateDomainConfig();

覆蓋更新網域設定

參數

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

回應

返回: PutDomainConfigResponse

範例

putDomainConfig 範例

Copy

async function runExample() {
  const tenantId: string = 'tenant-9f8c7b1a';
  const domainToUpdate: string = 'comments.mywebsite.org';
  const updateDomainConfigParams: UpdateDomainConfigParams = {
    enableModeration: true,
    // 可選欄位已省略，例如 maxCommentLength?: number
  };
  const result: PutDomainConfigResponse = await putDomainConfig(
    tenantId,
    domainToUpdate,
    updateDomainConfigParams,
  );
  console.log(result);
}
runExample();

建立電子郵件範本

參數

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

回應

返回：CreateEmailTemplateResponse1

範例

createEmailTemplate 範例

Copy

const tenantId: string = "tenant_9f8e7d6c";
const emailTemplate: CreateEmailTemplateBody = {
  name: "Account Activation",
  subject: "Activate Your New Account",
  htmlContent: "<p>Welcome! Please click <a href=\"\{{activationLink}}\">here</a> to activate.</p>",
  // 可選欄位如 textContent、isActive 已省略，以示範可選參數
};
const result: CreateEmailTemplateResponse1 = await createEmailTemplate(
  tenantId,
  emailTemplate
);
console.log(result);

刪除電子郵件範本

參數

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

回應

返回: DeleteEmailTemplateResponse

範例

deleteEmailTemplate 範例

Copy

async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_abcde";
  const response: DeleteEmailTemplateResponse = await deleteEmailTemplate(tenantId, templateId);
  // 範例：從回應中存取可選屬性
  const statusCode: number | undefined = response.status?.code;
}();

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

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
errorId	string	Yes

回應

Returns: DeleteEmailTemplateRenderErrorResponse

範例

deleteEmailTemplateRenderError 範例

Copy

async function executeDelete() {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_001";
  const errorId: string = "render_err_2023";
  const result: DeleteEmailTemplateRenderErrorResponse = await deleteEmailTemplateRenderError(
    tenantId,
    templateId,
    errorId
  );
  console.log(result);
}
executeDelete();

取得電子郵件範本

參數

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

回應

返回：GetEmailTemplateResponse1

範例

getEmailTemplate 範例

Copy

async function fetchTemplate(): Promise<void> {
    const tenantId: string = "tenant-12345";
    const templateId: string = "order-confirmation";
    const response: GetEmailTemplateResponse1 = await getEmailTemplate(tenantId, templateId);
    const emailTemplate: CustomEmailTemplate | undefined = response.customEmailTemplate;
    const configParams: CustomConfigParameters | undefined = response.customConfigParameters;
}

取得電子郵件範本定義

參數

名稱	類型	必填	說明
tenantId	string	是

回應

返回: GetEmailTemplateDefinitionsResponse1

範例

getEmailTemplateDefinitions 範例

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const emailTemplateDefs: GetEmailTemplateDefinitionsResponse1 = await getEmailTemplateDefinitions(tenantId);
  console.log(emailTemplateDefs);
})();

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

參數

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

回應

返回：GetEmailTemplateRenderErrorsResponse1

範例

getEmailTemplateRenderErrors 範例

Copy

const tenantId: string = "c2f5a8d9-4b3e-4f6a-9e1b-2d5c6f7a8b9c";
const templateId: string = "welcome-email-template";
const skip: number = 20;
const result: GetEmailTemplateRenderErrorsResponse1 = await getEmailTemplateRenderErrors(
  tenantId,
  templateId,
  skip
);

取得電子郵件範本清單

參數

名稱	類型	必填	說明
tenantId	string	Yes
skip	number	No

回應

返回：GetEmailTemplatesResponse1

範例

getEmailTemplates 範例

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // 呼叫時不含可選的 'skip'
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // 呼叫時包含可選的 'skip' 參數
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

渲染電子郵件範本

參數

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

回應

返回：RenderEmailTemplateResponse1

範例

renderEmailTemplate 範例

Copy

(async () => {
  const tenantId: string = "acme-corp-01";
  const templateBody: RenderEmailTemplateBody = {
    templateId: "welcome-email",
    placeholders: {
      userName: "John Doe",
      signupDate: "2024-04-01"
    }
  };
  const locale: string = "en-US";
  const result: RenderEmailTemplateResponse1 = await renderEmailTemplate(tenantId, templateBody, locale);
  console.log(result);
})();

更新電子郵件範本

參數

名稱	類型	必填
tenantId	string	是
id	string	是
updateEmailTemplateBody	UpdateEmailTemplateBody	是

回應

返回：UpdateEmailTemplateResponse

範例

updateEmailTemplate 範例

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_67890";
  const updateBody: UpdateEmailTemplateBody = {
    subject: "Comment reply notification",
    htmlContent: "<p>Someone replied to your comment.</p>",
    plainTextContent: "Someone replied to your comment.",
    // 可選欄位範例
    isActive: true,
  };
  const result: UpdateEmailTemplateResponse = await updateEmailTemplate(
    tenantId,
    templateId,
    updateBody
  );
  console.log(result);
})();

取得事件日誌

req tenantId urlId userIdWS

參數

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

回應

回傳: GetEventLogResponse1

範例

getEventLog 範例

Copy

(async () => {
    const tenantId: string = "tenant_9876";
    const urlId: string = "page_54321";
    const userIdWS: string = "ws_user_1122";
    const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 一週前
    const endTime: number = Date.now();
    const log: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
    const recentLog: GetEventLogResponse1 = await getEventLog(tenantId, urlId, userIdWS, startTime);
})();

取得全域事件日誌

請求 tenantId urlId userIdWS

參數

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

回應

返回：GetGlobalEventLogResponse

範例

getGlobalEventLog 範例

Copy

(async () => {
  const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
  const urlId: string = 'article-2023-09-15';
  const userIdWS: string = 'ws_987654321';
  const startTime: number = Date.now() - 86400000;
  const endTime: number = Date.now();
  const fullLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
  const recentLog: GetGlobalEventLogResponse = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime);
  console.log(fullLog, recentLog);
})();

建立動態貼文

參數

名稱	類型	必填
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

回應

返回：CreateFeedPostResponse1

範例

createFeedPost 範例

Copy

async function run() {
  const tenantId = "tenant-12345";
  const feedParams: CreateFeedPostParams = {
    text: "New product launch!",
    mediaItems: [{ type: "image", asset: { url: "https://cdn.example.com/img.jpg", width: 800, height: 600 } as FeedPostMediaItemAsset } as FeedPostMediaItem],
    link: { url: "https://example.com/product", title: "Product" } as FeedPostLink
  };
  const result: CreateFeedPostResponse1 = await createFeedPost(tenantId, feedParams, "broadcast-987", true, false, true);
  console.log(result);
}
run();

建立公開動態貼文

參數

名稱	類型	必填
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

回應

回傳: CreateFeedPostPublicResponse

範例

createFeedPostPublic 範例

Copy

async function submitPost() {
  const tenantId: string = "tenant_12345";
  const mediaItem: FeedPostMediaItem = {
    asset: {
      url: "https://cdn.example.com/image.jpg",
      mimeType: "image/jpeg",
      size: 104857,
    },
    type: "image",
  };
  const link: FeedPostLink = {
    url: "https://example.com/blog/new-feature",
    title: "New Feature Release",
    description: "Details about our latest product update.",
  };
  const createFeedPostParams: CreateFeedPostParams = {
    content: "Check out our new feature!",
    media: [mediaItem],
    link: link,
  };
  const broadcastId: string = "broadcast_9876";
  const sso: string = "sso_token_abc123";
  const response: CreateFeedPostPublicResponse = await createFeedPostPublic(
    tenantId,
    createFeedPostParams,
    broadcastId,
    sso
  );
}

刪除公開動態貼文

參數

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

回應

返回: DeleteFeedPostPublicResponse

範例

deleteFeedPostPublic 範例

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const postId: string = "post_987654321";
  const broadcastId: string = "broadcast_2024Q1";
  const sso: string = "sso_4fa3b9c2";
  const response1: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId);
  const response2: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId);
  const response3: DeleteFeedPostPublicResponse = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
})();

取得動態貼文

請求
tenantId
afterId

參數

名稱	類型	必填
tenantId	string	是
afterId	string	否
limit	number	否
tags	Array	否

回應

回傳：GetFeedPostsResponse1

範例

getFeedPosts 範例

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const afterId: string = 'post_9876';
  const limit: number = 20;
  const tags: string[] = ['news', 'sports'];
  const feedResult: GetFeedPostsResponse1 = await getFeedPosts(tenantId, afterId, limit, tags);
})();

取得公開動態貼文

請求 tenantId afterId

參數

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

回應

Returns: GetFeedPostsPublicResponse

範例

getFeedPostsPublic 範例

Copy

async function example() {
  const tenantId: string = "tenant_12345";
  const afterId: string = "post_9876";
  const limit: number = 20;
  const tags: string[] = ["news", "tech"];
  const sso: string = "userToken123";
  const isCrawler: boolean = false;
  const includeUserInfo: boolean = true;
  const response: GetFeedPostsPublicResponse = await getFeedPostsPublic(
    tenantId,
    afterId,
    limit,
    tags,
    sso,
    isCrawler,
    includeUserInfo
  );
}
example();

取得動態貼文統計

參數

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

回應

返回：GetFeedPostsStatsResponse

範例

getFeedPostsStats 範例

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];
    const ssoToken: string = "sso_abcdef123456";
    const statsWithoutSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds);
    const statsWithSso: GetFeedPostsStatsResponse = await getFeedPostsStats(tenantId, postIds, ssoToken);
}
runExample();

取得公開使用者反應

參數

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

回應

返回：GetUserReactsPublicResponse

範例

getUserReactsPublic 範例

Copy

async function demo() {
  const tenantId: string = "tenant_12345";
  const postIds: string[] = ["post_1a2b3c", "post_4d5e6f"];
  const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
  const fullResponse: GetUserReactsPublicResponse = await getUserReactsPublic(tenantId, postIds, ssoToken);
  const minimalResponse: GetUserReactsPublicResponse = await getUserReactsPublic(tenantId);
}
demo();

對動態貼文做公開反應

參數

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

回應

回傳: ReactFeedPostPublicResponse

範例

reactFeedPostPublic 範例

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const postId: string = 'post_98765';
  const reactBodyParams: ReactBodyParams = { reaction: 'thumbs_up' };
  const isUndo: boolean = false;
  const broadcastId: string = 'broadcast_abcde';
  const sso: string = 'sso_token_xyz';
  const response: ReactFeedPostPublicResponse = await reactFeedPostPublic(
    tenantId,
    postId,
    reactBodyParams,
    isUndo,
    broadcastId,
    sso
  );
  console.log(response);
})();

更新動態貼文

參數

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

回應

回傳：UpdateFeedPostResponse

範例

updateFeedPost 範例

Copy

const tenantId: string = "tenant_3421";
const postId: string = "feedpost_a9b8c7";
const feedPost: FeedPost = {
  content: "We've refreshed the announcement with the latest project milestones.",
  media: [
    {
      type: "image",
      url: "https://assets.example.com/images/milestone.png",
      caption: "Project Milestones"
    } as FeedPostMediaItem
  ],
  link: {
    url: "https://example.com/project-updates",
    title: "Project Updates",
    description: "Read about the recent progress and upcoming goals."
  } as FeedPostLink
};
const result: UpdateFeedPostResponse = await updateFeedPost(tenantId, postId, feedPost);

更新公開動態貼文

參數

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

回應

返回：UpdateFeedPostPublicResponse

範例

updateFeedPostPublic 範例

Copy

async function updatePostExample() {
  const tenantId: string = 'tenant-9f8b7c';
  const postId: string = 'post-3a4d5e';
  const updateParams: UpdateFeedPostParams = {
    title: 'New Announcement',
    content: 'We have updated our terms of service.',
    media: [
      {
        url: 'https://cdn.example.com/assets/image.png',
        type: 'image',
        asset: {
          width: 800,
          height: 600,
          size: 124000
        } as FeedPostMediaItemAsset
      } as FeedPostMediaItem
    ],
    link: {
      url: 'https://example.com/terms',
      title: 'Read the new TOS'
    } as FeedPostLink
  };
  const broadcastId: string = 'broadcast-2023-09';
  const sso: string = 'sso-abc123xyz';
  const result: UpdateFeedPostPublicResponse = await updateFeedPostPublic(
    tenantId,
    postId,
    updateParams,
    broadcastId,
    sso
  );
}

公開檢舉留言

參數

Name	Type	Required
tenantId	string	是
commentId	string	是
isFlagged	boolean	是
sso	string	否

回應

返回：FlagCommentPublicResponse

範例

flagCommentPublic 範例

Copy

async function demoFlagComment() {
    const tenantId: string = "acme-tenant-123";
    const commentId: string = "comment-987654";
    const isFlagged: boolean = true;
    const sso: string = "sso-token-abc123";
    const result: FlagCommentPublicResponse = await flagCommentPublic(
        tenantId,
        commentId,
        isFlagged,
        sso
    );
    console.log(result);
}
demoFlagComment();

取得大型動圖

參數

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

回應

返回：GetGifLargeResponse

範例

getGifLarge 範例

Copy

(async () => {
  const tenantId: string = 'c9f4a1b2-3d5e-4f6a-8b9c-0d1e2f3a4b5c';
  const largeInternalURLSanitized: string = 'https://cdn.fastcomments.com/gifs/awesome-cat-large.gif';
  const result: GetGifLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);
  console.log(result);
})();

搜尋動圖

參數

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

回應

返回：GetGifsSearchResponse

範例

getGifsSearch 範例

Copy

async function demo() {
  const tenantId: string = "tenant_9f8b7c";
  const search: string = "funny cats";
  const locale: string = "en-US";
  const rating: string = "pg";
  const page: number = 1;
  const result: GetGifsSearchResponse = await getGifsSearch(
    tenantId,
    search,
    locale,
    rating,
    page
  );
  console.log(result);
}
demo();

取得熱門動圖

參數

名稱	類型	必要
tenantId	string	Yes
locale	string	No
rating	string	No
page	number	No

回應

返回：GetGifsTrendingResponse

範例

getGifsTrending 範例

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6d";
  const locale: string = "en-US";
  const rating: string = "PG-13";
  const page: number = 1;
  const trendingAll: GetGifsTrendingResponse = await getGifsTrending(tenantId, locale, rating, page);
  console.log(trendingAll);
  // 僅使用必要參數
  const trendingMinimal: GetGifsTrendingResponse = await getGifsTrending(tenantId);
  console.log(trendingMinimal);
}
runExample();

新增標籤

參數

Name	Type	Required	Description
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

回應

Returns: AddHashTagResponse

範例

addHashTag 範例

Copy

const tenantId: string = "tenant_9876";
const newHashTag: CreateHashTagBody = {
  tag: "typescript",
  description: "Discussions about TypeScript"
};
const responseWithTenant: AddHashTagResponse = await addHashTag(tenantId, newHashTag);
const responseWithoutTenant: AddHashTagResponse = await addHashTag(undefined, newHashTag);

批次新增標籤

參數

名稱	類型	必填	描述
tenantId	string	否
bulkCreateHashTagsBody	BulkCreateHashTagsBody	否

回應

返回：AddHashTagsBulkResponse

範例

addHashTagsBulk 範例

Copy

async () => {
    const tenantId: string | undefined = "tenant_9f8b7c6d";
    const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
        tags: [
            {
                name: "typescript",
                description: "Discussions about TypeScript",
                color: "#3178c6"
            },
            {
                name: "fastcomments",
                description: "Tags for FastComments integration",
                color: "#00aaff"
            }
        ]
    };
    const result: AddHashTagsBulkResponse = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
    console.log(result);
}();

刪除標籤

參數

Name	Type	Required
tag	string	Yes
tenantId	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

回應

Returns: DeleteHashTagResponse

範例

deleteHashTag 範例

Copy

(async () => {
  const tag: string = "announcement";
  const tenantId: string = "tenant_9876";
  const requestBody: DeleteHashTagRequestBody = {
    confirmDeletion: true
  };
  const response: DeleteHashTagResponse = await deleteHashTag(tag, tenantId, requestBody);
  console.log(response);
})();

取得標籤

參數

名稱	類型	必填	說明
tenantId	string	Yes
page	number	No

回應

返回：GetHashTagsResponse1

範例

getHashTags 範例

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const responseWithPage: GetHashTagsResponse1 = await getHashTags(tenantId, 1);
  const responseDefault: GetHashTagsResponse1 = await getHashTags(tenantId);
  console.log(responseWithPage, responseDefault);
})();

部分更新標籤

參數

名稱	類型	必填
tag	string	Yes
tenantId	string	No
updateHashTagBody	UpdateHashTagBody	No

回應

返回：PatchHashTagResponse

範例

patchHashTag 範例

Copy

const response1: PatchHashTagResponse = await patchHashTag("new-feature");
const response2: PatchHashTagResponse = await patchHashTag(
  "beta-release",
  "tenant-9f8b7c"
);
const updateBody: UpdateHashTagBody = {
  description: "Mark comments related to the upcoming beta release",
  color: "#1e90ff"
};
const response3: PatchHashTagResponse = await patchHashTag(
  "beta-release",
  "tenant-9f8b7c",
  updateBody
);

刪除審核投票

參數

Name	Type	Required
commentId	string	Yes
voteId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

回應

Returns: DeleteModerationVoteResponse

範例

deleteModerationVote 範例

Copy

const commentId: string = "cmt_12345";
const voteId: string = "vote_9876";
const broadcastId: string = "brd_001";
const tenantId: string = "tenant_42";
const sso: string = "sso_token_abc";
const result: DeleteModerationVoteResponse = await deleteModerationVote(
  commentId,
  voteId,
  broadcastId,
  tenantId,
  sso
);

取得 API 留言

參數

名稱	類型	必要
page	number	No
count	number	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

回應

回傳：GetApiCommentsResponse

範例

getApiComments 範例

Copy

async function loadComments() {
  const fullResult: GetApiCommentsResponse = await getApiComments(
    2,                     // 頁面
    25,                    // 數量
    "feedback",           // 文字搜尋
    "192.168.1.100",      // 依IP取得評論
    "approved",           // 篩選條件
    "hasReplies",         // 搜尋篩選條件
    "dateDesc",           // 排序
    false,                // 示範
    "tenant-abc123",      // 租戶ID
    "sso-token-xyz"       // 單點登入
  );
  const minimalResult: GetApiCommentsResponse = await getApiComments(undefined, 5);
}

取得 API 匯出狀態

參數

名稱	類型	必填
batchJobId	string	No
tenantId	string	No
sso	string	No

回應

回傳：GetApiExportStatusResponse

範例

getApiExportStatus 範例

Copy

async function demoExportStatus() {
    const batchJobId: string = "exportBatch-20231101-001";
    const tenantId: string = "tenant-abc123";
    const ssoToken: string = "sso-xyz789";
    const fullStatus: GetApiExportStatusResponse = await getApiExportStatus(batchJobId, tenantId, ssoToken);
    const simpleStatus: GetApiExportStatusResponse = await getApiExportStatus(batchJobId);
    console.log(fullStatus, simpleStatus);
}

取得 API IDs

參數

名稱	類型	必要
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

回應

返回：GetApiIdsResponse

範例

getApiIds 範例

Copy

const textSearch: string = "urgent feedback";
const byIPFromComment: string = "203.0.113.42";
const filters: string = "status:approved";
const afterId: string = "comment-789";
const demo: boolean = true;
const tenantId: string = "tenant-001";
const apiIds: GetApiIdsResponse = await getApiIds({
  textSearch,
  byIPFromComment,
  filters,
  afterId,
  demo,
  tenantId,
});

取得從留言封鎖的使用者

參數

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

回應

返回：GetBanUsersFromCommentResponse

範例

getBanUsersFromComment 範例

Copy

async function demoGetBanUsers() {
  const commentId: string = "cmt_5f8e3a9b2d";
  const tenantId: string = "tenant_42";
  const sso: string = "sso_token_abc123";
  // 呼叫所有參數
  const fullResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId, tenantId, sso);
  console.log(fullResult);
  // 只使用必要參數呼叫
  const minimalResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId);
  console.log(minimalResult);
}
demoGetBanUsers();

取得留言封鎖狀態

參數

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

回應

Returns: GetCommentBanStatusResponse1

範例

getCommentBanStatus 範例

Copy

async function checkCommentBanStatus() {
  const banStatus: GetCommentBanStatusResponse1 = await getCommentBanStatus('cmt_987654321', 'tenant_42', 'sso_token_abc123');
  const banStatusNoTenant: GetCommentBanStatusResponse1 = await getCommentBanStatus('cmt_987654322', undefined, 'sso_token_def456');
}

取得留言子項

參數

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

回應

回傳: GetCommentChildrenResponse

範例

getCommentChildren 範例

Copy

const commentId: string = "cmt_12345";
const tenantId: string = "tenant_xyz";
const sso: string = "sso_987654";
const fullResponse: GetCommentChildrenResponse = await getCommentChildren(commentId, tenantId, sso);
const minimalResponse: GetCommentChildrenResponse = await getCommentChildren(commentId);

取得計數

參數

名稱	類型	必填
textSearch	string	否
byIPFromComment	string	否
filter	string	否
searchFilters	string	否
demo	boolean	否
tenantId	string	否
sso	string	否

回應

返回: GetCountResponse

範例

getCount 範例

Copy

async function main(): Promise<void> {
  const count: GetCountResponse = await getCount({
    textSearch: "order issue",
    byIPFromComment: "198.51.100.23",
    filter: "pending",
    demo: true,
    tenantId: "acme_corp",
    sso: "sso_abcdef123456"
  });
  console.log(count);
}
main();

取得多個計數

參數

名稱	類型	必要	描述
tenantId	string	否
sso	string	否

回應

返回：GetCountsResponse

範例

getCounts 範例

Copy

async function runExample() {
    const tenantId: string = "acme-corp";
    const ssoToken: string = "sso-token-2024";
    const withBoth: GetCountsResponse = await getCounts(tenantId, ssoToken);
    const withTenantOnly: GetCountsResponse = await getCounts(tenantId);
    const withoutParams: GetCountsResponse = await getCounts();
    console.log(withBoth, withTenantOnly, withoutParams);
}
runExample();

取得日誌

參數

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

回應

返回: GetLogsResponse

範例

getLogs 範例

Copy

async function fetchLogs() {
    const commentId: string = "cmt_9a8b7c6d5e4f3a2b";
    const tenantId: string = "tenant_9876";
    const sso: string = "sso_abcdef123456";

    const fullResponse: GetLogsResponse = await getLogs(commentId, tenantId, sso);
    const minimalResponse: GetLogsResponse = await getLogs(commentId);
}

取得手動徽章

Parameters

Name	Type	Required	Description
tenantId	string	否
sso	string	否

Response

返回：GetManualBadgesResponse

Example

getManualBadges 範例

Copy

async function fetchBadges() {
  const tenantId: string = "tenant_987654321";
  const ssoToken: string = "sso_ABCdef123456";
  // 同時呼叫兩個可選參數
  const responseFull: GetManualBadgesResponse = await getManualBadges(tenantId, ssoToken);
  console.log(responseFull);
  // 僅以 tenantId 呼叫
  const responseTenantOnly: GetManualBadgesResponse = await getManualBadges(tenantId);
  console.log(responseTenantOnly);
}
fetchBadges();

取得使用者的手動徽章

參數

名稱	類型	必填
badgesUserId	string	No
commentId	string	No
tenantId	string	No
sso	string	No

回應

返回: GetManualBadgesForUserResponse

範例

getManualBadgesForUser 範例

Copy

(async () => {
  const userId: string = "user_42";
  const commentId: string = "comment_1001";
  const tenantId: string = "tenant_acme";
  const ssoToken: string = "sso_5f6g7h8i9j";
  const badges: GetManualBadgesForUserResponse = await getManualBadgesForUser(userId, commentId, tenantId, ssoToken);
  const limitedBadges: GetManualBadgesForUserResponse = await getManualBadgesForUser(userId);
})();

取得審核留言

參數

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

回應

返回：GetModerationCommentResponse

範例

getModerationComment 範例

Copy

async function fetchCommentDetails() {
  // 完整參數集合
  const commentId: string = "cmt_12345abc";
  const includeEmail: boolean = true;
  const includeIP: boolean = false;
  const tenantId: string = "tenant_9876";
  const sso: string = "sso_token_xyz";
  const fullResult: GetModerationCommentResponse = await getModerationComment(
    commentId,
    includeEmail,
    includeIP,
    tenantId,
    sso
  );
  // 只使用必要參數的最小呼叫
  const minimalResult: GetModerationCommentResponse = await getModerationComment("cmt_67890def");
  // 根據需要使用結果...
}

取得審核留言文字

Parameters

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

回應

返回：GetModerationCommentTextResponse

範例

getModerationCommentText 範例

Copy

async function exampleUsage(): Promise<void> {
  const commentId: string = "cmt_9f8e7d6c5b4a3b2c1d0e";
  const tenantId: string = "tenant_67890";
  const sso: string = "sso_token_abc123";
  // 只使用必填參數呼叫
  const result1: GetModerationCommentTextResponse = await getModerationCommentText(commentId);
  // 呼叫時使用可選參數
  const result2: GetModerationCommentTextResponse = await getModerationCommentText(commentId, tenantId, sso);
}

取得預封鎖摘要

參數

名稱	類型	必要
commentId	string	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

回應

Returns: GetPreBanSummaryResponse

範例

getPreBanSummary 範例

Copy

const commentId: string = "5f8d0c2e4b1a2c3d4e5f6a7b";
const includeByUserIdAndEmail: boolean = true;
const includeByIP: boolean = true;
const includeByEmailDomain: boolean = false;
const tenantId: string = "tenant-001";
const sso: string = "sso-xyz-123";
const preBanSummary: GetPreBanSummaryResponse = await getPreBanSummary(
  commentId,
  includeByUserIdAndEmail,
  includeByIP,
  includeByEmailDomain,
  tenantId,
  sso
);

取得搜尋留言摘要

參數

名稱	類型	必填
value	string	No
filters	string	No
searchFilters	string	No
tenantId	string	No
sso	string	No

回應

回傳: GetSearchCommentsSummaryResponse

範例

getSearchCommentsSummary 範例

Copy

async function runExample(): Promise<void> {
    const searchTerm: string = "fastcomments integration";
    const filterString: string = "status:approved";
    const searchFilterString: string = "author:jane";
    const tenantId: string = "123e4567-e89b-12d3-a456-426614174000";
    const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
    const summary: GetSearchCommentsSummaryResponse = await getSearchCommentsSummary(
        searchTerm,
        filterString,
        searchFilterString,
        tenantId,
        ssoToken
    );
    console.log(summary);
}
runExample();

取得搜尋頁面

參數

名稱	類型	必填
value	string	否
tenantId	string	否
sso	string	否

回應

回傳: GetSearchPagesResponse

範例

getSearchPages 範例

Copy

(async () => {
  const query: string = "network outage";
  const tenantId: string = "tenant-9876";
  const ssoToken: string = "sso-abc123def456";
  const searchResult: GetSearchPagesResponse = await getSearchPages(query, tenantId, ssoToken);
  const searchResultNoSso: GetSearchPagesResponse = await getSearchPages(query, tenantId);
})();

取得搜尋網站

參數

Name	Type	Required
value	string	No
tenantId	string	No
sso	string	No

回應

回傳：GetSearchSitesResponse

範例

getSearchSites 範例

Copy

async function fetchSites() {
  const value: string = "customer support"
  const tenantId: string = "tenant-9876"
  const sso: string = "sso-abc123"
  const sites: GetSearchSitesResponse = await getSearchSites(value, tenantId, sso)
  const sitesOnlyTenant: GetSearchSitesResponse = await getSearchSites(undefined, tenantId)
}

取得搜尋建議

參數

名稱	類型	必填
textSearch	string	否
tenantId	string	否
sso	string	否

回應

返回：GetSearchSuggestResponse

範例

getSearchSuggest 範例

Copy

async function example(): Promise<void> {
    const term: string = "fastcomments api";
    const tenant: string = "tenant_001";
    const sso: string = "sso_9a8b7c";
    const fullResult: GetSearchSuggestResponse = await getSearchSuggest(term, tenant, sso);
    const partialResult: GetSearchSuggestResponse = await getSearchSuggest(term);
}
example();

取得搜尋使用者

參數

名稱	類型	必要
value	string	No
tenantId	string	No
sso	string	No

回應

返回：GetSearchUsersResponse

範例

getSearchUsers 範例

Copy

async function demoSearch() {
    const query: string = "john.doe@example.com";
    const tenantId: string = "tenant_12345";
    const ssoToken: string = "sso_token_abc";
    const resultWithSso: GetSearchUsersResponse = await getSearchUsers(query, tenantId, ssoToken);
    const resultWithoutSso: GetSearchUsersResponse = await getSearchUsers(query, tenantId);
}

取得信任係數

參數

名稱	類型	必填
userId	string	No
tenantId	string	No
sso	string	No

回應

返回: GetTrustFactorResponse

範例

getTrustFactor 範例

Copy

async function runDemo(): Promise<void> {
    const trustFull: GetTrustFactorResponse = await getTrustFactor("user_12345", "tenant_abc", "sso_token_987");
    const trustUserOnly: GetTrustFactorResponse = await getTrustFactor("user_12345");
    console.log(trustFull, trustUserOnly);
}
runDemo();

取得使用者封鎖偏好

參數

Name	Type	Required	Description
tenantId	string	No
sso	string	No

回應

Returns: GetUserBanPreferenceResponse

範例

getUserBanPreference 範例

Copy

async function demoGetUserBanPreference(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-2024";
  const sso: string = "sso-token-9f8b7a6c";
  const result: GetUserBanPreferenceResponse = await getUserBanPreference(tenantId, sso);
  console.log(result);
}
demoGetUserBanPreference();

取得使用者內部檔案

參數

名稱	類型	必填
commentId	string	No
tenantId	string	No
sso	string	No

回應

回傳：GetUserInternalProfileResponse1

範例

getUserInternalProfile 範例

Copy

(async () => {
  const fullProfile: GetUserInternalProfileResponse1 = await getUserInternalProfile({
    commentId: "cmt_12345",
    tenantId: "tenant_67890",
    sso: "sso_token_abcdef"
  });
  const partialProfile: GetUserInternalProfileResponse1 = await getUserInternalProfile({
    commentId: "cmt_98765"
  });
})();

調整留言投票

參數

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

回應

返回: PostAdjustCommentVotesResponse

範例

postAdjustCommentVotes 範例

Copy

const commentId: string = "cmt_9f8b7a6d";
const adjustParams: AdjustCommentVotesParams = {
  voteDelta: 1,
  // 需要 AdjustCommentVotesParams 的其他欄位
};
const broadcastId: string = "brd_20230915";
const tenantId: string = "tenant_42";
const sso: string = "sso-token-abc123";
const result: PostAdjustCommentVotesResponse = await postAdjustCommentVotes(
  commentId,
  adjustParams,
  broadcastId,
  tenantId,
  sso
);

提交 API 匯出

參數

名稱	類型	必填
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
tenantId	string	No
sso	string	No

回應

回傳: PostApiExportResponse

範例

postApiExport 範例

Copy

(async () => {
  const textSearch: string = "keyword:feedback"
  const byIPFromComment: string = "203.0.113.45"
  const filters: string = "status:pending,category:support"
  const searchFilters: string = "createdAt>2023-01-01"
  const sorts: string = "createdAt:desc"
  const tenantId: string = "tenant_9876"
  const sso: string = "sso_7e2a9b"
  const exportResult: PostApiExportResponse = await postApiExport(
    textSearch,
    byIPFromComment,
    filters,
    searchFilters,
    sorts,
    tenantId,
    sso
  )
  console.log(exportResult)
})()

封鎖使用者（留言）

參數

名稱	類型	必填
commentId	string	是
banEmail	boolean	否
banEmailDomain	boolean	否
banIP	boolean	否
deleteAllUsersComments	boolean	否
bannedUntil	string	否
isShadowBan	boolean	否
updateId	string	否
banReason	string	否
tenantId	string	否
sso	string	否

回應

返回：PostBanUserFromCommentResponse

範例

postBanUserFromComment 範例

Copy

async function runBan() {
  const commentId: string = "cmt_5f8a2b3c";
  const banEmail: boolean = true;
  const banIP: boolean = false;
  const deleteAllUsersComments: boolean = true;
  const bannedUntil: string = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000).toISOString();
  const isShadowBan: boolean = false;
  const banReason: string = "Repeated spam posting";
  const tenantId: string = "tenant_12345";
  const response: PostBanUserFromCommentResponse = await postBanUserFromComment(
    commentId,
    banEmail,
    undefined,
    banIP,
    deleteAllUsersComments,
    bannedUntil,
    isShadowBan,
    undefined,
    banReason,
    tenantId
  );
  console.log(response);
}
runBan();

取消封鎖使用者

參數

名稱	類型	必填
banUserUndoParams	BanUserUndoParams	是
tenantId	string	否
sso	string	否

回應

返回: PostBanUserUndoResponse

範例

postBanUserUndo 範例

Copy

const undoParams: BanUserUndoParams = {
  userId: "user-8421",
  commentId: "comment-6702",
  reason: "Accidental ban"
};
const tenantId: string = "tenant-7f9e";
const ssoToken: string = "sso-4b2c1d";
async function runUndo() {
  const resultAll: PostBanUserUndoResponse = await postBanUserUndo(undoParams, tenantId, ssoToken);
  console.log(resultAll);
  const resultMinimal: PostBanUserUndoResponse = await postBanUserUndo(undoParams);
  console.log(resultMinimal);
}
runUndo();

批次提交預封鎖摘要

參數

名稱	類型	必填
bulkPreBanParams	BulkPreBanParams	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

回應

回傳: PostBulkPreBanSummaryResponse

範例

postBulkPreBanSummary 範例

Copy

async function runExample() {
  const bulkPreBanParams: BulkPreBanParams = {
    userIds: [10234, 56789],
    emails: ["spam_user@example.com", "abuse@badsite.org"],
    ips: ["203.0.113.45", "198.51.100.22"],
    emailDomains: ["maliciousdomain.com"]
  };
  const includeByUserIdAndEmail: boolean = true;
  const includeByIP: boolean = false;
  const includeByEmailDomain: boolean = true;
  const tenantId: string = "tenant_8f4b2c1a";
  const sso: string = "sso-3948abf0";
  const summary: PostBulkPreBanSummaryResponse = await postBulkPreBanSummary(
    bulkPreBanParams,
    includeByUserIdAndEmail,
    includeByIP,
    includeByEmailDomain,
    tenantId,
    sso
  );
  console.log(summary);
}
runExample();

以 ID 取得留言（POST）

參數

名稱	類型	必填
commentsByIdsParams	CommentsByIdsParams	是
tenantId	string	否
sso	string	否

回應

返回: PostCommentsByIdsResponse

範例

postCommentsByIds 範例

Copy

const commentsByIdsParams: CommentsByIdsParams = {
  commentIds: ['cmt001', 'cmt002'],
  includeUserInfo: true,
  includeThreadInfo: false,
} as CommentsByIdsParams;
const fullResponse: PostCommentsByIdsResponse = await postCommentsByIds(
  commentsByIdsParams,
  'tenant-12345',
  'sso-token-xyz'
);
const minimalResponse: PostCommentsByIdsResponse = await postCommentsByIds(
  commentsByIdsParams
);

提交檢舉留言

參數

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

回應

返回：PostFlagCommentResponse

範例

postFlagComment 範例

Copy

const commentId: string = "cmt_20230915_001";
const broadcastId: string = "brd_20230915_live";
const tenantId: string = "tenant_42";
const sso: string = "sso_token_abc123";
const flaggedResponse: PostFlagCommentResponse = await postFlagComment(
  commentId,
  broadcastId,
  tenantId,
  sso
);

提交移除留言

參數

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

回應

返回：PostRemoveCommentResponse

範例

postRemoveComment 範例

Copy

async function removeCommentExample(): Promise<void> {
  const commentId: string = "cmt_7f9a3e2b";
  const result1: PostRemoveCommentResponse = await postRemoveComment(commentId);
  const broadcastId: string = "brd_12ab34cd";
  const tenantId: string = "tenant_5678efgh";
  const sso: string = "sso_XYZ12345";
  const result2: PostRemoveCommentResponse = await postRemoveComment(commentId, broadcastId, tenantId, sso);
  console.log(result1, result2);
}

提交還原已刪除留言

參數

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

回應

返回: PostRestoreDeletedCommentResponse

範例

postRestoreDeletedComment 範例

Copy

async function restoreCommentDemo(): Promise<void> {
    const commentId: string = "cmt_5f2a9b7e1234567890abcd";
    const broadcastId: string | undefined = "brd_2023_09";
    const tenantId: string | undefined = "tenant_42";
    const sso: string | undefined = "sso_token_abcdef123456";
    const response: PostRestoreDeletedCommentResponse = await postRestoreDeletedComment(
        commentId,
        broadcastId,
        tenantId,
        sso
    );
    console.log(response);
}
restoreCommentDemo();

設定留言核准狀態

參數

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

回應

回傳: PostSetCommentApprovalStatusResponse

範例

postSetCommentApprovalStatus 範例

Copy

async function main() {
  const commentIdOnly: string = "cmt_1001";
  const resultOnly: PostSetCommentApprovalStatusResponse = await postSetCommentApprovalStatus(commentIdOnly);
  const commentIdFull: string = "cmt_2002";
  const approvedFull: boolean = true;
  const broadcastIdFull: string = "brd_3003";
  const tenantIdFull: string = "tenant_abc";
  const ssoFull: string = "sso_token_xyz";
  const resultFull: PostSetCommentApprovalStatusResponse = await postSetCommentApprovalStatus(
    commentIdFull,
    approvedFull,
    broadcastIdFull,
    tenantIdFull,
    ssoFull
  );
  console.log(resultOnly, resultFull);
}
main();

設定留言審查狀態

參數

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

回應

返回: PostSetCommentReviewStatusResponse

範例

postSetCommentReviewStatus 範例

Copy

async function updateCommentReviewStatus(): Promise<void> {
  const commentId: string = "cmt_9f8a7b6c5d4e3f2a1b0c";
  const reviewed: boolean = true;
  const broadcastId: string = "broadcast_2024Q1";
  const tenantId: string = "tenant_1001";
  const sso: string = "alice@example.com";
  const response: PostSetCommentReviewStatusResponse = await postSetCommentReviewStatus(
    commentId,
    reviewed,
    broadcastId,
    tenantId,
    sso
  );
  console.log(response);
}

設定留言垃圾郵件狀態

參數

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

回應

返回：PostSetCommentSpamStatusResponse

範例

postSetCommentSpamStatus 範例

Copy

async function demoSpamStatus(): Promise<void> {
  const commentId: string = "cmt_5f2a1b3c4d6e7f8g9h0i";
  // 只需要的參數
  const resultSimple: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(commentId, true);
  // 提供了所有可選參數
  const resultFull: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(
    commentId,
    false,
    true,
    "brd_1234abcd",
    "tenant_42",
    "sso_9876xyz"
  );
  console.log(resultSimple, resultFull);
}

設定留言文字（審核）

參數

名稱	類型	必要
commentId	string	Yes
setCommentTextParams	SetCommentTextParams	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

回應

返回：PostSetCommentTextResponse

範例

postSetCommentText 範例

Copy

(async () => {
  const commentId: string = "cmt_9f8b7a6d5e4c3b2a1";
  const setParams: SetCommentTextParams = {
    text: "Edited comment to correct a typo and add clarification."
  };
  const broadcastId: string = "brd_1a2b3c4d5e6f7g8h9";
  const tenantId: string = "tenant_xyz123";
  const sso: string = "sso_user_456def";
  const fullResult: PostSetCommentTextResponse = await postSetCommentText(
    commentId,
    setParams,
    broadcastId,
    tenantId,
    sso
  );
  const minimalResult: PostSetCommentTextResponse = await postSetCommentText(
    commentId,
    setParams
  );
  console.log(fullResult, minimalResult);
})();

提交取消檢舉留言

參數

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

回應

返回：PostUnFlagCommentResponse

範例

postUnFlagComment 範例

Copy

async () => {
  const response: PostUnFlagCommentResponse = await postUnFlagComment(
    "cmt_12345",          // commentId
    "brd_67890",          // broadcastId (可選)
    "tenant_abc",         // tenantId (可選)
    "sso_user_token_789"  // sso (可選)
  );
};

提交投票

參數

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

回應

返回: PostVoteResponse

範例

postVote 範例

Copy

let commentId: string = 'cmt_12345';
let direction: string = 'up';
let broadcastId: string = 'brd_67890';
let tenantId: string = 'tenant_abc';
let sso: string = 'sso_token_xyz';
const fullVote: PostVoteResponse = await postVote(
  commentId,
  direction,
  broadcastId,
  tenantId,
  sso
);
const simpleVote: PostVoteResponse = await postVote('cmt_67890');

授予徽章

參數

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

回應

返回值: PutAwardBadgeResponse

範例

putAwardBadge 範例

Copy

(async () => {
    const badgeId: string = "badge-superstar"
    const userId: string = "user-42"
    const commentId: string = "comment-7f9c3"
    const broadcastId: string = "broadcast-2023-09"
    const result: PutAwardBadgeResponse = await putAwardBadge(badgeId, userId, commentId, broadcastId)
    console.log(result)
})()

關閉討論串

參數

Name	Type	Required
urlId	string	Yes
tenantId	string	No
sso	string	No

回應

返回：PutCloseThreadResponse

範例

putCloseThread 範例

Copy

async function closeThreadDemo(): Promise<void> {
  const urlId: string = "article-2023-09-15";
  const tenantId: string = "tenant-42";
  const sso: string = "sso-token-xyz";
  const response: PutCloseThreadResponse = await putCloseThread(urlId, tenantId, sso);
  console.log(response);
}
closeThreadDemo();

移除徽章

參數

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

回應

返回：PutRemoveBadgeResponse

範例

putRemoveBadge 範例

Copy

const badgeId: string = "badge-12345";
const userId: string = "user-9876";
const commentId: string = "comment-5555";
const broadcastId: string = "broadcast-001";
const result: PutRemoveBadgeResponse = await putRemoveBadge(
  badgeId,
  userId,
  commentId,
  broadcastId
);

重新開啟討論串

參數

名稱	類型	必填
urlId	string	Yes
tenantId	string	No
sso	string	No

回應

返回：PutReopenThreadResponse

範例

putReopenThread 範例

Copy

async function exampleUsage() {
  const urlId: string = "thread-9f8b7c6a";
  const tenantId: string = "tenant-001";
  const sso: string = "sso-3f9d2e1a";
  const resultAll: PutReopenThreadResponse = await putReopenThread(urlId, tenantId, sso);
  console.log(resultAll);
  const resultMinimal: PutReopenThreadResponse = await putReopenThread(urlId);
  console.log(resultMinimal);
}

設定信任係數

參數

Name	Type	Required
userId	string	No
trustFactor	string	No
tenantId	string	No
sso	string	No

回應

返回：SetTrustFactorResponse

範例

setTrustFactor 範例

Copy

(async () => {
  const userId: string = "user_8421";
  const trustFactor: string = "high";
  const tenantId: string = "tenant_33";
  const ssoToken: string = "sso_7d9f";
  const fullResult: SetTrustFactorResponse = await setTrustFactor(userId, trustFactor, tenantId, ssoToken);
  const minimalResult: SetTrustFactorResponse = await setTrustFactor(userId, trustFactor);
})();

建立管理員

參數

Name	Type	Required	Description
tenantId	string	Yes
createModeratorBody	CreateModeratorBody	Yes

回應

返回: CreateModeratorResponse1

範例

createModerator 範例

Copy

async function runExample() {
  const tenantId: string = "tenant_9876";
  const moderatorPayload: CreateModeratorBody = {
    name: "Alice Johnson",
    email: "alice.johnson@example.com"
    // 可選欄位如說明已省略
  };
  const result: CreateModeratorResponse1 = await createModerator(tenantId, moderatorPayload);
  console.log(result);
}
runExample();

刪除管理員

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
sendEmail	string	No

回應

返回: DeleteModeratorResponse

範例

deleteModerator 範例

Copy

async function runDeleteModeratorExample() {
  const tenantId: string = "tenant_2023";
  const moderatorId: string = "mod_001";
  const notificationEmail: string = "admin@mycompany.com";
  const resultWithEmail: DeleteModeratorResponse = await deleteModerator(tenantId, moderatorId, notificationEmail);
  const resultWithoutEmail: DeleteModeratorResponse = await deleteModerator(tenantId, moderatorId);
}

取得管理員

參數

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

回應

返回：GetModeratorResponse1

範例

getModerator 範例

Copy

(async () => {
  const tenantId: string = "acme-corp-001";
  const id: string = "mod-12345";
  const result: GetModeratorResponse1 = await getModerator(tenantId, id);
  const moderatorName: string | undefined = result.moderator?.name;
  console.log(moderatorName);
})();

取得管理員清單

參數

名稱	類型	必填	描述
tenantId	string	Yes
skip	number	No

回應

返回：GetModeratorsResponse1

範例

getModerators 範例

Copy

async function fetchModerators(): Promise<void> {
  const tenantId: string = "tenant-9876";
  const skip: number = 30; // 可選的分頁偏移
  const moderators: GetModeratorsResponse1 = await getModerators(tenantId, skip);
  // 沒有分頁的範例：
  // const allModerators: GetModeratorsResponse1 = await getModerators(tenantId);
}

發送邀請

參數

Name	Type	Required
tenantId	string	是
id	string	是
fromName	string	是

回應

返回：SendInviteResponse

範例

sendInvite 範例

Copy

const tenantId: string = "acme-corp-tenant";
const inviteId: string = "invite-12345";
const fromName: string = "John Doe";
const inviteResult: SendInviteResponse = await sendInvite(tenantId, inviteId, fromName);

更新管理員

參數

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

回應

返回: UpdateModeratorResponse

範例

updateModerator 範例

Copy

async function demoUpdateModerator(): Promise<void> {
    const tenantId: string = "tenant_42abc";
    const moderatorId: string = "moderator_8f9e";
    const updateBody: UpdateModeratorBody = {
        isActive: true,
        role: "admin",
        // 可選欄位
        notes: "Promoted to senior moderator"
    };
    const result: UpdateModeratorResponse = await updateModerator(tenantId, moderatorId, updateBody);
    console.log(result);
}
demoUpdateModerator();

刪除通知計數

參數

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

回應

Returns: DeleteNotificationCountResponse

範例

deleteNotificationCount 範例

Copy

async function run() {
  const tenantId: string = "tenant_12345";
  const notificationId: string = "notif_98765";
  const result: DeleteNotificationCountResponse = await deleteNotificationCount(tenantId, notificationId);
  console.log(result);
}
run();

取得快取的通知計數

參數

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

回應

返回: GetCachedNotificationCountResponse1

範例

getCachedNotificationCount 範例

Copy

const tenantId: string = "e3f1a9b2-4c5d-6e7f-8a9b-0c1d2e3f4a5b";
const userId: string = "u-20231101-001";
const notificationResult: GetCachedNotificationCountResponse1 = await getCachedNotificationCount(tenantId, userId);
console.log(notificationResult);

取得通知計數

參數

名稱	類型	必填
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

回應

返回：GetNotificationCountResponse1

範例

getNotificationCount 範例

Copy

async function demoNotificationCount() {
    const tenantId: string = "tenant_001";
    const userId: string = "user_42";
    const urlId: string = "url_9f8e7d";
    const fromCommentId: string = "comment_12345";
    const viewed: boolean = false;
    const type: string = "mention";
    const result: GetNotificationCountResponse1 = await getNotificationCount(
        tenantId,
        userId,
        urlId,
        fromCommentId,
        viewed,
        type
    );
    console.log(result);
}
demoNotificationCount();

取得通知

參數

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

回應

返回: GetNotificationsResponse1

範例

getNotifications 範例

Copy

async function demo() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const notifications: GetNotificationsResponse1 = await getNotifications(tenantId, userId);
  console.log(notifications);
  const more: GetNotificationsResponse1 = await getNotifications(
    tenantId,
    undefined,
    "article-5678",
    undefined,
    true,
    "reply",
    10
  );
  console.log(more);
}
demo();

更新通知

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
updateNotificationBody	UpdateNotificationBody	Yes
userId	string	No

回應

返回：UpdateNotificationResponse

範例

updateNotification 範例

Copy

const tenantId: string = "tenant_5f4d2c";
const notificationId: string = "notif_9b8a7c";
const updateBody: UpdateNotificationBody = {
  enabled: false,
  sendEmail: true,
  schedule: "2023-12-01T08:00:00Z"
};
const userId: string = "user_123e4567";
const responseWithUser: UpdateNotificationResponse = await updateNotification(
  tenantId,
  notificationId,
  updateBody,
  userId
);
const responseWithoutUser: UpdateNotificationResponse = await updateNotification(
  tenantId,
  notificationId,
  updateBody
);

建立 V1 頁面互動

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
title	string	否

回應

返回: CreateV1PageReactResponse

範例

createV1PageReact 範例

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "article-2024-06-improvements";
const title: string = "FastComments API Integration Guide";
const responseWithTitle: CreateV1PageReactResponse = await createV1PageReact(tenantId, urlId, title);
const responseWithoutTitle: CreateV1PageReactResponse = await createV1PageReact(tenantId, urlId);

建立 V2 頁面互動

參數

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
id	string	Yes
title	string	No

回應

返回：CreateV2PageReactResponse

範例

createV2PageReact 範例

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const urlId: string = "blog/posts/fastcomments-integration";
  const pageId: string = "page-12345";
  const title: string = "FastComments API Integration Guide";
  const responseWithoutTitle: CreateV2PageReactResponse = await createV2PageReact(tenantId, urlId, pageId);
  const responseWithTitle: CreateV2PageReactResponse = await createV2PageReact(tenantId, urlId, pageId, title);
  console.log(responseWithoutTitle, responseWithTitle);
})();

刪除 V1 頁面互動

參數

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

回應

返回: DeleteV1PageReactResponse

範例

deleteV1PageReact 範例

Copy

const tenantId: string = "acme-corp";
const urlId: string = "article-2024-06-01";
const response: DeleteV1PageReactResponse = await deleteV1PageReact(tenantId, urlId);
console.log(response);

刪除 V2 頁面互動

參數

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

回應

返回：DeleteV2PageReactResponse

範例

deleteV2PageReact 範例

Copy

const tenantId: string = "tenant_12345";
const urlId: string = "page_98765";
const reactionId: string = "react_abcde";
const deleteResult: DeleteV2PageReactResponse = await deleteV2PageReact(tenantId, urlId, reactionId);

取得 V1 頁面按讚

參數

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

回應

回傳: GetV1PageLikesResponse

範例

getV1PageLikes 範例

Copy

async function fetchPageLikes() {
  const tenantId: string = "acme-corp-tenant-42";
  const urlId: string = "blog-post-2024-06-typescript-best-practices";
  const likes: GetV1PageLikesResponse = await getV1PageLikes(tenantId, urlId);
  console.log(likes);
}

取得 V2 頁面互動

參數

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

回應

返回：GetV2PageReactsResponse

範例

getV2PageReacts 範例

Copy

async function demoGetPageReacts(): Promise<void> {
    const tenantId: string = "acme-corp-tenant";
    const urlId: string = "article-2024-06-01";
    const reacts: GetV2PageReactsResponse = await getV2PageReacts(tenantId, urlId);
    // 可選屬性存取範例
    const customConfig: CustomConfigParameters | undefined = reacts.customConfig;
    console.log(reacts);
}
demoGetPageReacts();

取得 V2 頁面互動使用者

參數

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

回應

返回: GetV2PageReactUsersResponse1

範例

getV2PageReactUsers 範例

Copy

async function fetchReactUsers() {
  const tenantId: string = 'tenant_12345';
  const urlId: string = 'article-9876';
  const id: string = 'user_abcde';
  const response: GetV2PageReactUsersResponse1 = await getV2PageReactUsers(tenantId, urlId, id);
  console.log(response);
}
fetchReactUsers();

新增頁面

參數

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

回應

返回: AddPageAPIResponse

範例

addPage 範例

Copy

const tenantId: string = "tenant_9f8432b1-4c2e-4f9d-8a5d-7bc9e2f6d9a0";
const pageData: CreateAPIPageData = {
    url: "https://example.com/articles/fastcomments-intro",
    title: "FastComments Introduction",
    description: "An introductory guide to FastComments API usage.",
    tags: ["fastcomments", "api", "tutorial"],
    metadata: {
        author: "Jane Doe",
        publishedAt: "2024-03-15T08:00:00Z"
    }
};
const response: AddPageAPIResponse = await addPage(tenantId, pageData);

刪除頁面

參數

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

回應

返回: DeletePageAPIResponse

範例

deletePage 範例

Copy

async function example() {
    const tenantId: string = "acme-corp-001";
    const pageId: string = "page-987654321";
    const result: DeletePageAPIResponse = await deletePage(tenantId, pageId);
    console.log(result);
}
example();

取得離線使用者

過去在頁面上的評論者目前未上線。依 displayName 排序。
在耗盡 /users/online 後使用此功能以呈現「成員」區段。
在 commenterName 上使用游標分頁：伺服器從部分 {tenantId, urlId, commenterName} 索引，透過 $gt 從 afterName 向前走，無 $skip 成本。

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
afterName	string	否
afterUserId	string	否

回應

返回：GetOfflineUsersResponse

範例

getOfflineUsers 範例

Copy

async function fetchOfflineUsers(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const urlId: string = "thread_9876";
    const afterName: string = "Jane Smith";
    const afterUserId: string = "user_7f9b3c";
    const offlineUsers: GetOfflineUsersResponse = await getOfflineUsers(
        tenantId,
        urlId,
        afterName,
        afterUserId
    );
    console.log(offlineUsers);
}

取得在線使用者

目前線上觀看頁面的使用者：指其 websocket 會話目前已訂閱此頁面的使用者。
返回 anonCount + totalCount（全房間訂閱者，包括我們未列舉的匿名觀看者）。

參數

名稱	類型	必填
tenantId	string	是
urlId	string	是
afterName	string	否
afterUserId	string	否

回應

返回：GetOnlineUsersResponse

範例

getOnlineUsers 範例

Copy

async function demoOnlineUsers() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_98765";
  // 使用可選的分頁參數
  const pagedResult: GetOnlineUsersResponse = await getOnlineUsers(
    tenantId,
    urlId,
    "alice_smith",
    "user_9"
  );
  // 不使用可選的分頁參數
  const fullResult: GetOnlineUsersResponse = await getOnlineUsers(tenantId, urlId);
}

以 URL ID 取得頁面

參數

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

回應

返回：GetPageByURLIdAPIResponse

範例

getPageByURLId 範例

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_9876";
  const response: GetPageByURLIdAPIResponse = await getPageByURLId(tenantId, urlId);
  const page: APIPage | undefined = response.page;
})();

取得頁面

參數

名稱	類型	必填	說明
tenantId	string	Yes

回應

返回：GetPagesAPIResponse

範例

getPages 範例

Copy

const tenantId: string = "tenant_12345";
(async () => {
  const response: GetPagesAPIResponse = await getPages(tenantId);
  const firstPage: APIPage | undefined = response.pages?.[0];
  console.log(firstPage?.title);
})();

取得公開頁面

列出租戶的頁面。由 FChat 桌面客戶端使用，以填充其房間列表。
需要在每個頁面的已解析自訂設定中將 enableFChat 設為 true。
需要 SSO 的頁面會根據請求使用者的群組存取權限進行過濾。

Parameters

名稱	類型	必填
tenantId	string	是
cursor	string	否
limit	number	否
q	string	否
sortBy	PagesSortBy	否
hasComments	boolean	否

Response

返回: GetPagesPublicResponse

範例

getPagesPublic 示例

Copy

async function fetchPages() {
  const tenantId: string = "tenant_12345";
  const cursor: string = "nextPageToken";
  const limit: number = 20;
  const q: string = "blog";
  const sortBy: PagesSortBy = "createdAt";
  const hasComments: boolean = true;
  const response: GetPagesPublicResponse = await getPagesPublic(
    tenantId,
    cursor,
    limit,
    q,
    sortBy,
    hasComments
  );
  console.log(response);
}

取得使用者資訊

取得租戶的批次使用者資訊。根據 userIds，回傳 User / SSOUser 的顯示資訊。此功能由評論小工具使用，以在使用者透過 presence 事件剛出現時豐富其資訊。無頁面上下文：隱私權一致執行（私密個人檔案會被遮蔽）。

參數

名稱	類型	必填	說明
tenantId	string	Yes
ids	string	Yes

回應

返回: GetUsersInfoResponse

範例

getUsersInfo 範例

Copy

const tenantId: string = "acme-corp-tenant";
const ids: string = "user-1001,user-1002";
const usersInfo: GetUsersInfoResponse = await getUsersInfo(tenantId, ids);
// 回應中的可選欄位可能為 undefined
const firstUser: PageUserEntry | undefined = usersInfo?.users?.[0];

部分更新頁面

參數

名稱	類型	必填
tenantId	string	是
id	string	是
updateAPIPageData	UpdateAPIPageData	是

回應

返回：PatchPageAPIResponse

範例

patchPage 範例

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const pageId: string = "page_98765";
  const updateData: UpdateAPIPageData = {
    title: "Updated FAQ Page"
    // description?: string 可以省略
  };
  const response: PatchPageAPIResponse = await patchPage(tenantId, pageId, updateData);
})();

刪除待處理的 Webhook 事件

參數

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

回應

回傳: DeletePendingWebhookEventResponse

範例

deletePendingWebhookEvent 範例

Copy

async function runDemo() {
  const tenantId: string = 'c3f5e9d2-1a2b-4c3d-9e7f-1234567890ab';
  const eventId: string = 'event_987654321';
  const response: DeletePendingWebhookEventResponse = await deletePendingWebhookEvent(tenantId, eventId);
  console.log(response);
}
runDemo();

取得待處理 Webhook 事件計數

參數

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

回應

返回：GetPendingWebhookEventCountResponse1

範例

getPendingWebhookEventCount 範例

Copy

(async () => {
  const tenantId: string = "tenant_001";
  const responseAll: GetPendingWebhookEventCountResponse1 = await getPendingWebhookEventCount(
    tenantId,
    "comment_456",
    "ext_789",
    "comment.updated",
    "webhook",
    "mydomain.com",
    3
  );
  const responseMinimal: GetPendingWebhookEventCountResponse1 = await getPendingWebhookEventCount(tenantId);
  console.log(responseAll, responseMinimal);
})();

取得待處理的 Webhook 事件

參數

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

回應

返回: GetPendingWebhookEventsResponse1

範例

getPendingWebhookEvents 範例

Copy

async function fetchPendingEvents(): Promise<void> {
    const tenantId: string = "123e4567-e89b-12d3-a456-426614174000";
    const commentId: string = "cmt-987654321";
    const externalId: string = "ext-abc-123";
    const eventType: string = "comment_created";
    const type: string = "outbound";
    const domain: string = "myblog.com";
    const attemptCountGT: number = 3;
    const skip: number = 0;
    const pending: GetPendingWebhookEventsResponse1 = await getPendingWebhookEvents(
        tenantId,
        commentId,
        externalId,
        eventType,
        type,
        domain,
        attemptCountGT,
        skip
    );
    console.log(pending);
}
fetchPendingEvents();

建立問卷設定

參數

名稱	類型	必填	說明
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	Yes

回應

回傳: CreateQuestionConfigResponse1

範例

createQuestionConfig 範例

Copy

const tenantId: string = "tenant_12345";
const customOption: QuestionConfigCustomOptionsInner = {
  label: "Option A",
  value: "a",
};
const createQuestionConfigBody: CreateQuestionConfigBody = {
  questionText: "What is your favorite color?",
  isActive: true,
  // 可選欄位可省略
  customOptions: [customOption],
};
const response: CreateQuestionConfigResponse1 = await createQuestionConfig(
  tenantId,
  createQuestionConfigBody
);

刪除問卷設定

參數

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

回應

返回：DeleteQuestionConfigResponse

範例

deleteQuestionConfig 範例

Copy

async function runDeletion(): Promise<void> {
  const tenantId: string = "tenant_8f5a2c9d";
  const configId: string = "questionConfig_4b7e1f";
  const deleteResult: DeleteQuestionConfigResponse = await deleteQuestionConfig(tenantId, configId);
  console.log(deleteResult);
}
void runDeletion();

取得問卷設定

參數

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

回應

返回: GetQuestionConfigResponse1

範例

getQuestionConfig 範例

Copy

const tenantId: string = "acme-corp-tenant-42";
const questionId: string = "question-7f9b3e";
const response: GetQuestionConfigResponse1 = await getQuestionConfig(tenantId, questionId);

取得多個問卷設定

Parameters

Name	Type	Required	Description
tenantId	string	是
skip	number	否

Response

Returns: GetQuestionConfigsResponse1

Example

getQuestionConfigs 示例

Copy

async function fetchQuestionConfigs() {
    const tenantId: string = "tenant-9876";
    // 呼叫（不含可選的 'skip' 參數）
    const configsWithoutSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId);
    // 呼叫（含可選的 'skip' 參數）
    const skip: number = 10;
    const configsWithSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId, skip);
    console.log(configsWithoutSkip, configsWithSkip);
}

更新問卷設定

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

回應

返回：UpdateQuestionConfigResponse

範例

updateQuestionConfig 範例

Copy

const tenantId: string = "acme-corp-tenant";
const questionId: string = "qstn-2023-04";
const updateBody: UpdateQuestionConfigBody = {
  // 示範可選欄位
  customOptions: [
    {
      id: "opt-001",
      label: "Extra Details",
      required: true,
    },
  ],
  renderingType: "markdown",
};
const response: UpdateQuestionConfigResponse = await updateQuestionConfig(
  tenantId,
  questionId,
  updateBody
);

建立問卷結果

參數

Name	Type	Required	Description
tenantId	string	Yes
createQuestionResultBody	CreateQuestionResultBody	Yes

回應

Returns: CreateQuestionResultResponse1

範例

createQuestionResult 範例

Copy

const tenantId: string = "acme-corp-tenant";
const metaItem: MetaItem = {
  key: "campaign",
  value: "spring-launch"
};
const questionResultBody: CreateQuestionResultBody = {
  questionId: "question-42",
  answer: "Positive",
  metadata: [metaItem]
  // optional fields such as notes are omitted
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

刪除問卷結果

參數

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

回應

Returns: DeleteQuestionResultResponse

範例

deleteQuestionResult 範例

Copy

async function runDeletion(): Promise<void> {
    const tenantId: string = "tenant-001";
    const resultId: string = "c9f2a5b3-7e6d-4c9a-8b1f-2d3e4f5a6b7c";
    const result: DeleteQuestionResultResponse = await deleteQuestionResult(tenantId, resultId);
    console.log(result);
}
runDeletion();

取得問卷結果

參數

Name	Type	Required	說明
tenantId	string	Yes
id	string	Yes

回應

返回：GetQuestionResultResponse1

範例

getQuestionResult 範例

Copy

async function fetchQuestionResult(): Promise<void> {
    const tenantId: string = "acme-corp-001";
    const questionId: string = "question-7a9b8c";
    const result: GetQuestionResultResponse1 = await getQuestionResult(tenantId, questionId);
    const question: QuestionResult | undefined = result.questionResult;
    const firstMeta: MetaItem | undefined = result.meta?.[0];
    console.log(question?.id, firstMeta?.key);
}

取得多筆問卷結果

參數

Name	Type	Required
tenantId	string	Yes
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

回應

Returns: GetQuestionResultsResponse1

範例

getQuestionResults 範例

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const urlId: string = "post-456";
  const userId: string = "user-789";
  const startDate: string = "2023-09-01T00:00:00Z";
  const questionId: string = "q-101";
  const questionIds: string = "q-102,q-103";
  const skip: number = 20;
  const results: GetQuestionResultsResponse1 = await getQuestionResults(
    tenantId,
    urlId,
    userId,
    startDate,
    questionId,
    questionIds,
    skip
  );
  console.log(results);
})();

更新問卷結果

參數

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

回應

返回：UpdateQuestionResultResponse

範例

updateQuestionResult 範例

Copy

async function runUpdate() {
    const tenantId: string = "acme-corp-01";
    const id: string = "qr-20230915-001";
    const updateQuestionResultBody: UpdateQuestionResultBody = {
        // 必填字段
        answer: "No",
        // 可選字段
        comment: "User clarified their response",
        // anotherOptionalField?: value,
    };
    const result: UpdateQuestionResultResponse = await updateQuestionResult(
        tenantId,
        id,
        updateQuestionResultBody
    );
    console.log(result);
}
runUpdate();

彙總問卷結果

參數

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

回應

回傳: AggregateQuestionResultsResponse1

範例

aggregateQuestionResults 範例

Copy

(async () => {
  const tenantId: string = "acme-corp-123";
  const questionId: string = "feedback-rating";
  const questionIds: string[] = ["feedback-rating", "recommendation"];
  const urlId: string = "https://myblog.com/articles/42";
  const timeBucket: AggregateTimeBucket = "month";
  const startDate: Date = new Date("2023-01-01T00:00:00Z");
  const forceRecalculate: boolean = true;
  const result: AggregateQuestionResultsResponse1 = await aggregateQuestionResults(
    tenantId,
    questionId,
    questionIds,
    urlId,
    timeBucket,
    startDate,
    forceRecalculate
  );
  console.log(result);
})();

批次彙總問卷結果

參數

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

回應

返回：BulkAggregateQuestionResultsResponse1

範例

bulkAggregateQuestionResults 範例

Copy

const tenantId: string = "acme-corp";
const request: BulkAggregateQuestionResultsRequest = {
  questionIds: ["product-satisfaction", "feature-usage"],
  startDate: "2024-01-01T00:00:00Z",
  endDate: "2024-01-31T23:59:59Z",
  timeBucket: "day"
};
const result: BulkAggregateQuestionResultsResponse1 = await bulkAggregateQuestionResults(
  tenantId,
  request,
  true
);

結合留言與問卷結果

參數

Name	Type	Required
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
startDate	Date	No
forceRecalculate	boolean	No
minValue	number	No
maxValue	number	No
limit	number	No

回應

回傳: CombineCommentsWithQuestionResultsResponse

範例

combineCommentsWithQuestionResults 範例

Copy

const tenantId: string = "tenant_12345";
const questionIds: string[] = ["question_1", "question_2"];
const urlId: string = "article-9876";
const startDate: Date = new Date("2023-01-01T00:00:00Z");
const forceRecalculate: boolean = false;
const minValue: number = 1;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResultsResponse = await combineCommentsWithQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

新增 SSO 使用者

參數

名稱	類型	必填	說明
tenantId	string	是
createAPISSOUserData	CreateAPISSOUserData	是

回應

返回：AddSSOUserAPIResponse

範例

addSSOUser 範例

Copy

const tenantId: string = "tenant_12345";
const newUser: CreateAPISSOUserData = {
  userId: "sso_user_987",
  name: "Jane Doe",
  email: "jane.doe@example.com",
  // 可選欄位
  avatarUrl: "https://example.com/avatars/jane.jpg",
};
const result: AddSSOUserAPIResponse = await addSSOUser(tenantId, newUser);

刪除 SSO 使用者

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
deleteComments	boolean	No
commentDeleteMode	string	No

回應

返回：DeleteSSOUserAPIResponse

範例

deleteSSOUser 範例

Copy

const tenantId: string = "acme-corp-tenant";
const userId: string = "sso-user-42";
const deleteComments: boolean = true;
const commentDeleteMode: string = "hard";
const detailedResult: DeleteSSOUserAPIResponse = await deleteSSOUser(
  tenantId,
  userId,
  deleteComments,
  commentDeleteMode
);
const simpleResult: DeleteSSOUserAPIResponse = await deleteSSOUser(
  tenantId,
  userId
);

以電子郵件取得 SSO 使用者

參數

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

回應

返回：GetSSOUserByEmailAPIResponse

範例

getSSOUserByEmail 範例

Copy

async function fetchSSOUser() {
  const tenantId: string = "tenant_12345";
  const email: string = "john.doe@example.com";
  const result: GetSSOUserByEmailAPIResponse = await getSSOUserByEmail(tenantId, email);
  const user: APISSOUser | undefined = result?.user;
}

以 ID 取得 SSO 使用者

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

回應

返回：GetSSOUserByIdAPIResponse

範例

getSSOUserById 範例

Copy

async function fetchUser() {
  const tenantId: string = "tenant-987654321";
  const userId: string = "sso-user-abc123";
  const result: GetSSOUserByIdAPIResponse = await getSSOUserById(tenantId, userId);
  const ssoUser: APISSOUser = result.user;
}

取得 SSO 使用者清單

參數

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

回應

返回：GetSSOUsersResponse

範例

getSSOUsers 範例

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    // 呼叫時未提供可選的 `skip`
    const firstPage: GetSSOUsersResponse = await getSSOUsers(tenantId);
    // 呼叫時使用可選的 `skip`
    const secondPage: GetSSOUsersResponse = await getSSOUsers(tenantId, 100);
    console.log(firstPage, secondPage);
}
runExample();

部分更新 SSO 使用者

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

回應

返回：PatchSSOUserAPIResponse

範例

patchSSOUser 範例

Copy

const tenantId: string = "c1f2a3b4-5678-90ab-cdef-1234567890ab";
const userId: string = "user-987654321";
const updateData: UpdateAPISSOUserData = {
  email: "jane.smith@enterprise.com",
  displayName: "Jane Smith",
  role: "editor"
};
const responseWithComments: PatchSSOUserAPIResponse = await patchSSOUser(
  tenantId,
  userId,
  updateData,
  true
);
const responseWithoutComments: PatchSSOUserAPIResponse = await patchSSOUser(
  tenantId,
  userId,
  updateData
);

覆蓋更新 SSO 使用者

參數

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

回應

返回：PutSSOUserAPIResponse

範例

putSSOUser 範例

Copy

(async () => {
  const tenantId: string = "tenant_abc123";
  const userId: string = "user_456def";
  const updateData: UpdateAPISSOUserData = {
    email: "jane.doe@example.com",
    displayName: "Jane Doe",
    isActive: true,
  };
  const response: PutSSOUserAPIResponse = await putSSOUser(tenantId, userId, updateData, true);
})();

建立訂閱

參數

名稱	類型	必填	說明
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Yes

回應

Returns: CreateSubscriptionAPIResponse

範例

createSubscription 範例

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const subscriptionData: CreateAPIUserSubscriptionData = {
        userId: "user-456",
        planId: "premium-monthly",
        startDate: new Date(),
        trialPeriodDays: 14 // 可選欄位
    };
    const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, subscriptionData);
    console.log(result);
})();

刪除訂閱

Parameters

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

Response

返回：DeleteSubscriptionAPIResponse

範例

deleteSubscription 範例

Copy

(async () => {
  const tenantId: string = "tenant_9876";
  const subscriptionId: string = "sub_54321";
  const userId: string = "user_abc123";
  // 使用可選的 userId
  const responseWithUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId, userId);
  // 不使用可選的 userId
  const responseWithoutUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId);
})();

取得訂閱

參數

名稱	類型	必填	描述
tenantId	string	Yes
userId	string	No

回應

返回：GetSubscriptionsAPIResponse

範例

getSubscriptions 範例

Copy

(async () => {
    const tenantId: string = "acme-corp-123";
    const userId: string = "user-789";
    const responseWithUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
    const responseWithoutUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
})();

更新訂閱

參數

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

回應

返回: UpdateSubscriptionAPIResponse

範例

updateSubscription 範例

Copy

const tenantId: string = "tenant_12345";
const subscriptionId: string = "sub_98765";
const updateData: UpdateAPIUserSubscriptionData = {
  planId: "premium_plan",
  status: "active",
  renewalDate: "2024-12-31",
};
const userId: string = "user_abcde";
const response: UpdateSubscriptionAPIResponse = await updateSubscription(
  tenantId,
  subscriptionId,
  updateData,
  userId
);

取得租戶每日使用量

參數

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

回應

返回：GetTenantDailyUsagesResponse1

範例

getTenantDailyUsages 示例

Copy

async function fetchDailyUsage() {
  const tenantId: string = "tenant-9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 5; // 五月
  const dayNumber: number = 12;
  const skip: number = 0;
  const fullResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  // 只使用必填參數和一個可選參數
  const partialResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
  console.log(fullResult, partialResult);
}
fetchDailyUsage();

建立租戶方案

Parameters

Name	Type	Required	Description
tenantId	string	是
createTenantPackageBody	CreateTenantPackageBody	是

Response

Returns: CreateTenantPackageResponse1

Example

createTenantPackage 範例

Copy

(async () => {
  const tenantId: string = "tenant-9876";
  const body: CreateTenantPackageBody = {
    packageName: "Standard",
    quota: 5000,
    // 可選欄位
    description: "Standard package for medium traffic",
  };
  const result: CreateTenantPackageResponse1 = await createTenantPackage(tenantId, body);
  console.log(result);
})();

刪除租戶方案

參數

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

回應

返回：DeleteTenantPackageResponse

示例

deleteTenantPackage 示例

Copy

async function removeTenantPackage(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const packageId: string = "pkg_67890";
  const result: DeleteTenantPackageResponse = await deleteTenantPackage(tenantId, packageId);
  // 按需使用結果
}
removeTenantPackage();

取得租戶方案

參數

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

回應

Returns: GetTenantPackageResponse1

範例

getTenantPackage 範例

Copy

async function fetchTenantPackage(): Promise<void> {
    const tenantId: string = "acme-tenant-2024";
    const packageId: string = "premium-package-01";
    const response: GetTenantPackageResponse1 = await getTenantPackage(tenantId, packageId);
    // 回應中的可選欄位
    const tenantPackage: TenantPackage | undefined = response.tenantPackage;
    const customConfig: CustomConfigParameters | undefined = response.customConfigParameters;
}

取得租戶方案清單

參數

Name	Type	Required	Description
tenantId	string	Yes
skip	number	No

回應

Returns: GetTenantPackagesResponse1

範例

getTenantPackages 範例

Copy

(async () => {
  const tenantId: string = 'tenant_67890';
  const skip: number = 30;
  const packagesWithSkip: GetTenantPackagesResponse1 = await getTenantPackages(tenantId, skip);
  const packagesWithoutSkip: GetTenantPackagesResponse1 = await getTenantPackages(tenantId);
  console.log(packagesWithSkip, packagesWithoutSkip);
})();

替換租戶方案

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
replaceTenantPackageBody	ReplaceTenantPackageBody	Yes

回應

返回：ReplaceTenantPackageResponse

範例

replaceTenantPackage 範例

Copy

(async () => {
    const tenantId: string = "acme-corp-tenant-01";
    const packageId: string = "pkg-2024-annual";
    const config: CustomConfigParameters = {
        // custom configuration fields here
    };
    const body: ReplaceTenantPackageBody = {
        name: "Enterprise Package",
        // optional custom configuration
        customConfig: config,
    };
    const response: ReplaceTenantPackageResponse = await replaceTenantPackage(tenantId, packageId, body);
    console.log(response);
})();

更新租戶方案

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
updateTenantPackageBody	UpdateTenantPackageBody	Yes

回應

回傳: UpdateTenantPackageResponse

範例

updateTenantPackage 範例

Copy

const tenantId: string = "tenant-9876";
const packageId: string = "pkg-2023";
const customConfig: CustomConfigParameters = {
  enableSpamFilter: true,
  spamRatingThreshold: 4,
};
const updateBody: UpdateTenantPackageBody = {
  displayName: "Enterprise Pro",
  customConfig,
};
const response: UpdateTenantPackageResponse = await updateTenantPackage(
  tenantId,
  packageId,
  updateBody
);

建立租戶使用者

參數

名稱	類型	必填	描述
tenantId	string	是
createTenantUserBody	CreateTenantUserBody	是

回應

返回: CreateTenantUserResponse1

範例

createTenantUser 範例

Copy

const tenantId: string = "a1b2c3d4-5678-90ab-cdef-1234567890ab";
const newUser: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "admin",
  // 可選參數
  phoneNumber: "+15551234567",
  isActive: true,
};
const result: CreateTenantUserResponse1 = await createTenantUser(tenantId, newUser);

刪除租戶使用者

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
deleteComments	string	No
commentDeleteMode	string	No

回應

返回：DeleteTenantUserResponse

範例

deleteTenantUser 範例

Copy

async function demoDeleteTenantUser() {
  const tenantId: string = "acme-corp-tenant";
  const userId: string = "user-9876";
  // 刪除使用者及其所有評論，使用硬刪除模式
  const resultWithOptions: DeleteTenantUserResponse = await deleteTenantUser(
    tenantId,
    userId,
    "true",
    "hard"
  );
  // 刪除使用者但不移除評論（預設行為）
  const resultBasic: DeleteTenantUserResponse = await deleteTenantUser(tenantId, userId);
}

取得租戶使用者

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

回應

返回：GetTenantUserResponse1

範例

getTenantUser 範例

Copy

async function fetchUser(): Promise<void> {
  const tenantId: string = "tenant-01a2b3c";
  const userId: string = "user-7890";
  const result: GetTenantUserResponse1 = await getTenantUser(tenantId, userId);
  console.log(result);
}

取得租戶使用者清單

參數

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

回應

返回：GetTenantUsersResponse1

範例

getTenantUsers 範例

Copy

(async () => {
  const tenantId: string = "tenant_9f7a2c";
  const skip: number = 25;
  const usersPage: GetTenantUsersResponse1 = await getTenantUsers(tenantId, skip);
  const allUsers: GetTenantUsersResponse1 = await getTenantUsers(tenantId);
})();

替換租戶使用者

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
replaceTenantUserBody	ReplaceTenantUserBody	Yes
updateComments	string	No

回應

回傳：ReplaceTenantUserResponse

範例

replaceTenantUser 範例

Copy

async function updateUser() {
  const tenantId: string = "c3d1f2e4-5b6a-4c7d-9f2e-1234567890ab";
  const userId: string = "u-654321";
  const replaceBody: ReplaceTenantUserBody = {
    email: "newuser@example.com",
    username: "newusername"
  };
  const response: ReplaceTenantUserResponse = await replaceTenantUser(
    tenantId,
    userId,
    replaceBody,
    "true"
  );
  console.log(response);
}
updateUser();

發送登入連結

參數

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

回應

回傳：SendLoginLinkResponse

範例

sendLoginLink 範例

Copy

async function demoSendLoginLink() {
  const tenantId: string = "acme-corp";
  const userId: string = "user-9876";
  const redirectURL: string = "https://app.acme-corp.com/auth/callback";
  const resultWithRedirect: SendLoginLinkResponse = await sendLoginLink(tenantId, userId, redirectURL);
  const resultWithoutRedirect: SendLoginLinkResponse = await sendLoginLink(tenantId, userId);
}

更新租戶使用者

參數

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

回應

返回: UpdateTenantUserResponse

範例

updateTenantUser 範例

Copy

let tenantId: string = "5f8f8c1a2e9b3c001c2a9b2d";
let userId: string = "user_98765";
let updateBody: UpdateTenantUserBody = {
  email: "jane.smith@example.com",
  role: "moderator",
  isActive: false,
};
let updateComments: string = "Deactivated user due to policy violation.";
let result: UpdateTenantUserResponse = await updateTenantUser(tenantId, userId, updateBody, updateComments);

建立租戶

參數

名稱	類型	必填	說明
tenantId	string	是
createTenantBody	CreateTenantBody	是

回應

返回: CreateTenantResponse1

範例

createTenant 範例

Copy

async function example() {
  const tenantId: string = 'tenant-2024-01';
  const createTenantBody: CreateTenantBody = {
    // 必填欄位
    name: 'Acme International',
    // 可根據需要新增選用欄位，例如：
    // billingInfo: { address: '123 Main St', city: 'Metropolis' } as BillingInfo,
  };
  const response: CreateTenantResponse1 = await createTenant(tenantId, createTenantBody);
  console.log(response);
}

刪除租戶

參數

Name	Type	Required
tenantId	string	Yes
id	string	Yes
sure	string	No

回應

Returns: DeleteTenantResponse

範例

deleteTenant 範例

Copy

async function runExample() {
    const tenantId: string = "tenant_12345";
    const id: string = "resource_98765";
    const sure: string = "confirm";
    // 呼叫時包含可選的 'sure' 參數
    const responseWithSure: DeleteTenantResponse = await deleteTenant(tenantId, id, sure);
    console.log(responseWithSure);
    // 呼叫時不包含可選的 'sure' 參數
    const responseWithoutSure: DeleteTenantResponse = await deleteTenant(tenantId, id);
    console.log(responseWithoutSure);
}
runExample();

取得租戶

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

回應

回傳: GetTenantResponse1

範例

getTenant 範例

Copy

async function fetchTenant(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const id: string = "user_9876";
  const tenantInfo: GetTenantResponse1 = await getTenant(tenantId, id);
  console.log(tenantInfo);
}
fetchTenant();

取得租戶清單

參數

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

回應

回傳: GetTenantsResponse1

範例

getTenants 示例

Copy

(async () => {
  const tenantId: string = "tenant-9f8e7d6c";
  const resultOnlyId: GetTenantsResponse1 = await getTenants(tenantId);
  const resultWithMeta: GetTenantsResponse1 = await getTenants(tenantId, "full");
  const resultAllParams: GetTenantsResponse1 = await getTenants(tenantId, "full", 15);
  console.log(resultOnlyId, resultWithMeta, resultAllParams);
})();

更新租戶

參數

名稱	類型	必填
tenantId	string	是
id	string	是
updateTenantBody	UpdateTenantBody	是

回應

回傳：UpdateTenantResponse

範例

updateTenant 範例

Copy

const tenantId: string = "c8f9e3d2-4b6a-11ee-8c99-0242ac130003";
const id: string = "tenant-config-01";
const updateBody: UpdateTenantBody = {
  domain: "mytenant.fastcomments.io",
  branding: {
    logoUrl: "https://cdn.mytenant.com/assets/logo.png"
  },
  description: "Branding update for Q3"
};
const response: UpdateTenantResponse = await updateTenant(tenantId, id, updateBody);
console.log(response);

更改工單狀態

參數

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

回應

返回: ChangeTicketStateResponse1

範例

changeTicketState 範例

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-97123";
const ticketId: string = "ticket-45001";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  // 本文的可選欄位
  comment: "Issue resolved after code fix"
};
const response: ChangeTicketStateResponse1 = await changeTicketState(
  tenantId,
  userId,
  ticketId,
  changeTicketStateBody
);

建立工單

參數

名稱	類型	必填
tenantId	string	Yes
userId	string	Yes
createTicketBody	CreateTicketBody	Yes

回應

返回：CreateTicketResponse1

範例

createTicket 範例

Copy

const tenantId: string = "tenant_12345";
const userId: string = "user_98765";
const ticketBody: CreateTicketBody = {
  subject: "Issue with payment processing"
  // description?: string 是可選的，已省略
};
const response: CreateTicketResponse1 = await createTicket(tenantId, userId, ticketBody);
// 範例：使用回應中的可選字段
// console.log(response.ticket?.id);

取得工單

參數

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

回應

返回：GetTicketResponse1

範例

getTicket 範例

Copy

const tenantId: string = "acme-inc";
const ticketId: string = "ticket-3421";
const userId: string = "alice.smith";
const ticketWithUser: GetTicketResponse1 = await getTicket(tenantId, ticketId, userId);
const ticketWithoutUser: GetTicketResponse1 = await getTicket(tenantId, ticketId);

取得多筆工單

參數

名稱	類型	必填
tenantId	string	Yes
userId	string	No
state	number	No
skip	number	No
limit	number	No

回應

返回：GetTicketsResponse1

範例

getTickets 範例

Copy

async function loadTickets() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const state: number = 2; // 例如，已關閉
  const skip: number = 10;
  const limit: number = 5;
  const ticketsFull: GetTicketsResponse1 = await getTickets(tenantId, userId, state, skip, limit);
  const ticketsPartial: GetTicketsResponse1 = await getTickets(tenantId);
}
loadTickets();

取得翻譯

參數

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

回應

Returns: GetTranslationsResponse1

範例

getTranslations 範例

Copy

(async () => {
  const namespace: string = 'blog';
  const component: string = 'comment-editor';
  const locale: string = 'fr-FR';
  const useFullTranslationIds: boolean = true;
  const basicTranslations: GetTranslationsResponse1 = await getTranslations(namespace, component);
  const fullTranslations: GetTranslationsResponse1 = await getTranslations(namespace, component, locale, useFullTranslationIds);
})();

上傳圖片

上傳並調整圖像大小

參數

名稱	類型	必填
tenantId	string	Yes
file	Blob	Yes
sizePreset	SizePreset	No
urlId	string	No

回應

返回：UploadImageResponse

範例

uploadImage 範例

Copy

const tenantId: string = "acme-tenant-01";
const imageBlob: Blob = new Blob([new Uint8Array([137,80,78,71])], { type: "image/png" });
const uploadResult1: UploadImageResponse = await uploadImage(tenantId, imageBlob);
const sizePreset: SizePreset = { presetName: "medium" };
const urlId: string = "article-9876";
const uploadResult2: UploadImageResponse = await uploadImage(tenantId, imageBlob, sizePreset, urlId);

以 ID 取得使用者徽章進度

參數

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

回應

回傳: GetUserBadgeProgressByIdResponse

範例

getUserBadgeProgressById 範例

Copy

async function demo(): Promise<void> {
    const tenantId: string = "acme-corp";
    const userId: string = "user-42";
    const result: GetUserBadgeProgressByIdResponse = await getUserBadgeProgressById(tenantId, userId);
    const progress: UserBadgeProgress | undefined = result.progress;
    const earnedAt: Date | undefined = progress?.earnedAt;
    console.log(`Badge earned at: ${earnedAt?.toISOString() ?? "not earned yet"}`);
}
demo();

以使用者 ID 取得使用者徽章進度

參數

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

回應

返回: GetUserBadgeProgressByUserIdResponse

範例

getUserBadgeProgressByUserId 範例

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const userId: string = "user-12345";
  const badgeProgress: GetUserBadgeProgressByUserIdResponse = await getUserBadgeProgressByUserId(tenantId, userId);
  console.log(badgeProgress);
})();

取得使用者徽章進度清單

參數

名稱	類型	必填
tenantId	string	Yes
userId	string	No
limit	number	No
skip	number	No

回應

回傳：GetUserBadgeProgressListResponse

範例

getUserBadgeProgressList 範例

Copy

async function fetchBadgeProgress() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe@example.com";
  const limit: number = 10;
  const skip: number = 5;
  const fullList: GetUserBadgeProgressListResponse = await getUserBadgeProgressList(
    tenantId,
    userId,
    limit,
    skip
  );
  const simpleList: GetUserBadgeProgressListResponse = await getUserBadgeProgressList(tenantId);
}
fetchBadgeProgress();

建立使用者徽章

參數

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

回應

返回：CreateUserBadgeResponse

範例

createUserBadge 範例

Copy

const tenantId: string = "company-42";
const badgeParams: CreateUserBadgeParams = {
  name: "Community Champion",
  iconUrl: "https://assets.example.com/badges/champion.png",
  // description 是可選的，這裡省略
};
const result: CreateUserBadgeResponse = await createUserBadge(tenantId, badgeParams);

刪除使用者徽章

參數

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

回應

返回：DeleteUserBadgeResponse

範例

deleteUserBadge 範例

Copy

async function exampleDeleteBadge(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6a";
  const badgeId: string = "badge_4e3d2c1b";
  const result: DeleteUserBadgeResponse = await deleteUserBadge(tenantId, badgeId);
  console.log(result);
}
exampleDeleteBadge();

取得使用者徽章

參數

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

回應

返回：GetUserBadgeResponse

範例

getUserBadge 範例

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-001";
  const badgeId: string = "badge-5f9d3a2b";
  const badgeResponse: GetUserBadgeResponse = await getUserBadge(tenantId, badgeId);
  // 安全地存取可選欄位
  const badgeName: string | undefined = badgeResponse.userBadge?.name;
  console.log(`Badge ID: ${badgeId}, Name: ${badgeName ?? "Unnamed"}`);
}
runExample();

取得使用者徽章清單

參數

Name	Type	Required
tenantId	string	Yes
userId	string	No
badgeId	string	No
type	number	No
displayedOnComments	boolean	No
limit	number	No
skip	number	No

回應

回傳: GetUserBadgesResponse

範例

getUserBadges 範例

Copy

async function example() {
  const tenantId: string = "tenant-01";
  const userId: string = "user-42";
  const badgeId: string = "badge-gold";
  const type: number = 1;
  const displayedOnComments: boolean = true;
  const limit: number = 10;
  const skip: number = 5;
  const fullResult: GetUserBadgesResponse = await getUserBadges(
    tenantId,
    userId,
    badgeId,
    type,
    displayedOnComments,
    limit,
    skip
  );
  const minimalResult: GetUserBadgesResponse = await getUserBadges(tenantId);
}
example();

更新使用者徽章

參數

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateUserBadgeParams	UpdateUserBadgeParams	Yes

回應

返回：UpdateUserBadgeResponse

範例

updateUserBadge 範例

Copy

async function applyBadge() {
    const tenantId: string = "acme-corp-tenant";
    const userId: string = "user-98765";
    const params: UpdateUserBadgeParams = {
        badgeId: "gold-contributor",
        // 可選欄位範例
        expiresAt: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000).toISOString(),
    };
    const result: UpdateUserBadgeResponse = await updateUserBadge(tenantId, userId, params);
    console.log(result);
}
applyBadge();

取得使用者通知數量

參數

名稱	類型	必填	描述
tenantId	string	Yes
sso	string	No

回應

返回：GetUserNotificationCountResponse1

範例

getUserNotificationCount 範例

Copy

async function demoGetUserNotificationCount() {
    const tenantId: string = "acme-corp-01";
    // Call with optional SSO token
    const countWithSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId,
        "sso-token-abc123"
    );
    // Call without SSO token
    const countWithoutSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId
    );
    console.log(countWithSSO, countWithoutSSO);
}

取得使用者通知

參數

名稱	類型	必要
tenantId	string	是
urlId	string	否
pageSize	number	否
afterId	string	否
includeContext	boolean	否
afterCreatedAt	number	否
unreadOnly	boolean	否
dmOnly	boolean	否
noDm	boolean	否
includeTranslations	boolean	否
includeTenantNotifications	boolean	否
sso	string	否

回應

返回：GetUserNotificationsResponse

範例

getUserNotifications 範例

Copy

async function fetchUserNotifications() {
    const tenantId: string = "tenant_9f4b2c";
    const urlId: string = "post_1234";
    const pageSize: number = 25;
    const afterId: string = "notif_5678";
    const includeContext: boolean = true;
    const unreadOnly: boolean = false;
    const dmOnly: boolean = false;
    const includeTranslations: boolean = true;
    const notifications: GetUserNotificationsResponse = await getUserNotifications(
        tenantId,
        urlId,
        pageSize,
        afterId,
        includeContext,
        undefined,
        unreadOnly,
        dmOnly,
        undefined,
        includeTranslations,
        undefined,
        undefined
    );
    console.log(notifications);
}

重設使用者通知數量

參數

Name	Type	Required	Description
tenantId	string	是
sso	string	否

回應

Returns: ResetUserNotificationCountResponse

範例

resetUserNotificationCount 範例

Copy

async function demoResetCount() {
  const tenantId: string = "acme-corp-tenant";
  const sso: string = "sso-user-9876";
  // 呼叫並帶有可選的 sso 參數
  const resultWithSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId, sso);
  // 呼叫而不帶可選的 sso 參數
  const resultWithoutSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId);
  console.log(resultWithSso, resultWithoutSso);
}

重設使用者通知

參數

名稱	類型	必填
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

回應

回傳: ResetUserNotificationsResponse1

範例

resetUserNotifications 範例

Copy

(async () => {
  const tenantId: string = "tenant-001";
  const afterId: string = "notif-123";
  const afterCreatedAt: number = 1697049600; // example UNIX timestamp
  const unreadOnly: boolean = true;
  const dmOnly: boolean = false;
  const noDm: boolean = false;
  const sso: string = "sso-token-xyz";
  const result: ResetUserNotificationsResponse1 = await resetUserNotifications(
    tenantId,
    afterId,
    afterCreatedAt,
    unreadOnly,
    dmOnly,
    noDm,
    sso
  );
  console.log(result);
})();

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

Enable or disable notifications for a specific comment.

參數

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

回應

返回：UpdateUserNotificationCommentSubscriptionStatusResponse

範例

updateUserNotificationCommentSubscriptionStatus 範例

Copy

const tenantId: string = "tenant_12345";
const notificationId: string = "notif_9876";
const commentId: string = "comment_abc123";
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum =
  UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = "ssoTokenXYZ";
const responseWithSso: UpdateUserNotificationCommentSubscriptionStatusResponse =
  await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId,
    sso
  );
const responseWithoutSso: UpdateUserNotificationCommentSubscriptionStatusResponse =
  await updateUserNotificationCommentSubscriptionStatus(
    tenantId,
    notificationId,
    optedInOrOut,
    commentId
  );

更新使用者頁面通知訂閱狀態

Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also

參數

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
url	string	Yes
pageTitle	string	Yes
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Yes
sso	string	No

回應

Returns: UpdateUserNotificationPageSubscriptionStatusResponse

範例

updateUserNotificationPageSubscriptionStatus 範例

Copy

(async () => {
  const tenantId: string = "tenant-2024";
  const urlId: string = "page-5678";
  const url: string = "https://example.com/articles/typescript-tips";
  const pageTitle: string = "Top TypeScript Tips";
  const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum =
    UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
  const sso: string = "sso-token-xyz";
  const resultWithSso: UpdateUserNotificationPageSubscriptionStatusResponse = await updateUserNotificationPageSubscriptionStatus(
    tenantId,
    urlId,
    url,
    pageTitle,
    subscribedOrUnsubscribed,
    sso
  );
  const resultWithoutSso: UpdateUserNotificationPageSubscriptionStatusResponse = await updateUserNotificationPageSubscriptionStatus(
    tenantId,
    urlId,
    url,
    pageTitle,
    subscribedOrUnsubscribed
  );
})();

更新使用者通知狀態

參數

Name	Type	Required
tenantId	string	Yes
notificationId	string	Yes
newStatus	UpdateUserNotificationStatusNewStatusEnum	Yes
sso	string	No

回應

回傳：UpdateUserNotificationStatusResponse

範例

updateUserNotificationStatus 範例

Copy

const tenantId: string = "acme-corp";
const notificationId: string = "notif-20231101-001";
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Dismissed;
const ssoToken: string = "sso-9f8e7d6c5b4a";
const result: UpdateUserNotificationStatusResponse = await updateUserNotificationStatus(
  tenantId,
  notificationId,
  newStatus,
  ssoToken
);

取得使用者在線狀態

參數

名稱	類型	必填
tenantId	string	Yes
urlIdWS	string	Yes
userIds	string	Yes

回應

返回：GetUserPresenceStatusesResponse1

範例

getUserPresenceStatuses 範例

Copy

async function fetchUserPresences() {
  const tenantId: string = "tenant_9f8e2d";
  const urlIdWS: string = "blog.mycompany.com/thread/12345";
  const userIds: string = "alice,bob,carol";
  const result: GetUserPresenceStatusesResponse1 = await getUserPresenceStatuses(
    tenantId,
    urlIdWS,
    userIds
  );
  console.log(result);
}

搜尋使用者

參數

名稱	類型	必填
tenantId	string	Yes
urlId	string	Yes
usernameStartsWith	string	No
mentionGroupIds	Array	No
sso	string	No
searchSection	SearchUsersSearchSectionEnum	No

回應

返回：SearchUsersResponse1

範例

searchUsers 示例

Copy

async function demoSearch(): Promise<void> {
    const tenantId: string = "tenant_12345";
    const urlId: string = "article-9876";
    const usernameStartsWith: string = "john";
    const mentionGroupIds: string[] = ["groupA", "groupB"];
    const sso: string = "sso_abc123";
    const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.Users;
    const response: SearchUsersResponse1 = await searchUsers(
        tenantId,
        urlId,
        usernameStartsWith,
        mentionGroupIds,
        sso,
        searchSection
    );
    console.log(response);
}
demoSearch();

取得使用者

參數

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

回應

返回：GetUserResponse1

範例

getUser 範例

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const userId: string = "user_98765";
  const result: GetUserResponse1 = await getUser(tenantId, userId);
})();

建立投票

參數

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

回應

返回：CreateVoteResponse

範例

createVote 範例

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "comment_987654";
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Upvote;
const userId: string = "user_7f9a2b";
const voteResult: CreateVoteResponse = await createVote(
  tenantId,
  commentId,
  direction,
  userId
);

刪除投票

參數

名稱	類型	必填
tenantId	string	Yes
id	string	Yes
editKey	string	No

回應

返回：DeleteVoteResponse

範例

deleteVote 範例

Copy

(async () => {
  const tenantId: string = "acme-corp";
  const commentId: string = "comment-9876";
  const editKey: string = "edit-key-123";
  const resultWithEdit: DeleteVoteResponse = await deleteVote(tenantId, commentId, editKey);
  const resultWithoutEdit: DeleteVoteResponse = await deleteVote(tenantId, commentId);
})();

取得投票

參數

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

回應

返回: GetVotesResponse1

範例

getVotes 範例

Copy

async function fetchVotes(): Promise<void> {
  const tenantId: string = "acme-corp-01";
  const urlId: string = "article-2024-05-15";
  const response: GetVotesResponse1 = await getVotes(tenantId, urlId);
  // 範例說明如何存取回應中的可選欄位
  const firstVoteId: string | undefined = response?.votes?.[0]?.id;
}

取得使用者的投票

參數

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

回應

返回：GetVotesForUserResponse1

範例

getVotesForUser 範例

Copy

async function demo() {
  const tenantId: string = "acme-corp";
  const urlId: string = "post-9f8b7c";
  const userId: string = "user-42";
  const anonUserId: string = "anon-123";
  const votesRequiredOnly: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId);
  const votesWithUserId: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId, userId);
  const votesWithAnonId: GetVotesForUserResponse1 = await getVotesForUser(tenantId, urlId, undefined, anonUserId);
}
demo();

需要幫助嗎？

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

貢獻

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

語言 🇹🇼 繁體中文

快速開始

API 參考

文件

使用說明

彙總

稽核日誌

封鎖（留言）

檢查被封鎖的留言

留言

使用者留言

網域設定

電子郵件範本

事件日誌

動態貼文

檢舉留言

動圖

標籤

審核

管理員

通知數量

通知

頁面互動

頁面

待處理 Webhook 事件

問卷設定

問卷結果

問卷結果彙總

SSO 使用者

訂閱

租戶每日用量

租戶方案

租戶使用者

租戶

工單

翻譯

上傳圖片

使用者徽章進度

使用者徽章

使用者通知

使用者在線狀態

使用者搜尋

使用者

投票

FastComments JavaScript/TypeScript SDK

儲存庫

安裝

API 文件

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

瀏覽器 vs 伺服器 相容性

使用方式

瀏覽器 用法（客戶端）

伺服器 用法（Node.js）

僅匯入類型

使用個別 API 類別

瀏覽器 環境

伺服器 環境

公開 API vs 受保護 API

範例：使用 Public API（適用於瀏覽器）

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

範例：使用 Moderation 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

錯誤處理

彙總

參數

回應

瀏覽器 vs 伺服器相容性

瀏覽器用法（客戶端）

伺服器用法（Node.js）

瀏覽器環境

伺服器環境