FastComments JavaScript/TypeScript 开发工具包 (SDK)

这是 FastComments 的官方 JavaScript/TypeScript SDK。

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

仓库

安装

npm install fastcomments-sdk

API 文档

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

浏览器与服务器兼容性

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

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

使用方法

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

浏览器使用（客户端）

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

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

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

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

服务器使用（Node.js）

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

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

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

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

仅类型导入

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

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

使用单个 API 类

浏览器环境

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

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

const publicApi = new PublicApi(config);

服务器环境

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

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

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

公开 API 与受保护 API

该 SDK 提供以下 API 类：

DefaultApi - 需要使用 API 密钥进行身份验证的受保护端点。用于服务器端操作。
PublicApi - 无需 API 密钥即可访问的公共端点。可直接从浏览器/移动设备等调用。
ModerationApi - 管理员仪表板端点（评论审核、封禁、徽章、信任因子、搜索）。通过管理员的会话进行认证；对于通过 SSO 验证的管理员，可传递 sso 查询参数。
HiddenApi - 用于高级用例的内部/管理员端点。

示例：使用 Public API（浏览器安全）

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

const publicApi = new PublicApi();

// Get comments for a page (no API key required)
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);

// Get comments with full admin access
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 等等 */ });

// Moderator-authenticated calls (session cookie, or pass `sso` for an SSO moderator).
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 功能。

简单 SSO（仅服务器端）

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

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

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

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

const ssoToken = sso.createToken();

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

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

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

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

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

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

const ssoConfig = sso.prepareToSend();

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

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

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

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

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

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

带评论创建的 SSO

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

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

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

常见用例

获取页面的评论

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

创建评论

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

对评论投票

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

用户管理（需要 API 密钥）

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

实时事件（实时更新）

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

页面级事件

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

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

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

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

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

订阅用户事件

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

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

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

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

// Close when done
userSubscription.close();

获取 userIdWS

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

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

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

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

广播 ID

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

import { v4 as uuidv4 } from 'uuid';

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

错误处理

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

聚合

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

参数

名称	类型	必需
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	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

响应

Returns: 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	是
commentIds	string	是
sso	string	否

响应

返回：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);
})();

从评论中屏蔽用户

参数

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

响应

返回：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	Yes
id	string	Yes
contextUserId	string	No
isLive	boolean	No

响应

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

举报评论

参数

名称	类型	必填
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);
})();

获取评论列表

参数

名称	类型	必填
tenantId	string	是
page	number	否
limit	number	否
skip	number	否
asTree	boolean	否
skipChildren	number	否
limitChildren	number	否
maxTreeDepth	number	否
urlId	string	否
userId	string	否
anonUserId	string	否
contextUserId	string	否
hashTag	string	否
parentId	string	否
direction	SortDirections	否
fromDate	number	否
toDate	number	否

响应

返回: 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,
});

获取公开评论

req tenantId urlId

参数

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

响应

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

锁定评论

参数

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

响应

Returns: 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	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

响应

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

保存评论

参数

Name	Type	Required
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	是
createCommentParams	Array	是
isLive	boolean	否
doSpamCheck	boolean	否
sendEmails	boolean	否
populateNotifications	boolean	否

响应

返回: 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  // populateNotifications（使用默认值）
);

设置评论文本

参数

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
commentTextUpdateRequest	CommentTextUpdateRequest	Yes
editKey	string	No
sso	string	No

响应

返回: 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 omitted
  );
  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	是
commentId	string	是
broadcastId	string	是
sso	string	否

响应

返回：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	是
id	string	是
updatableCommentParams	UpdatableCommentParams	是
contextUserId	string	否
doSpamCheck	boolean	否
isLive	boolean	否

响应

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

评论投票

参数

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

响应

返回: 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	否

响应

返回：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	Yes
addDomainConfigParams	AddDomainConfigParams	Yes

响应

返回: AddDomainConfigResponse

示例

addDomainConfig 示例

Copy

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

删除域配置

参数

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

响应

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

获取域配置

参数

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

响应

Returns: 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	是
domainToUpdate	string	是
patchDomainConfigParams	PatchDomainConfigParams	是

响应

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

响应

返回: 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	Yes

响应

返回：GetEmailTemplateDefinitionsResponse1

示例

getEmailTemplateDefinitions 示例

Copy

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

获取邮件模板渲染错误

参数

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

响应

返回：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	是
skip	number	否

响应

返回: 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	Yes
postId	string	Yes
broadcastId	string	No
sso	string	No

响应

返回：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);
})();

获取动态帖子

req 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);
})();

获取公开动态帖子

req tenantId afterId

参数

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

响应

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

获取动态帖子统计

参数

名称	类型	必需
tenantId	string	Yes
postIds	Array	Yes
sso	string	No

响应

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

更新公开动态帖子

参数

Name	Type	Required
tenantId	string	Yes
postId	string	Yes
updateFeedPostParams	UpdateFeedPostParams	Yes
broadcastId	string	No
sso	string	No

响应

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

举报公开评论

参数

名称	类型	必填
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();

获取大尺寸 GIF

参数

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

响应

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

搜索 GIF

参数

名称	类型	必填
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();

获取热门 GIF

参数

名称	类型	必需
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();

添加话题标签

参数

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

响应

返回: 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	No
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

响应

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

删除话题标签

参数

名称	类型	必填
tag	string	是
tenantId	string	否
deleteHashTagRequestBody	DeleteHashTagRequestBody	否

响应

返回: 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	是
page	number	否

响应

返回: 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	是
tenantId	string	否
updateHashTagBody	UpdateHashTagBody	否

响应

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

删除审核投票

参数

名称	类型	必填
commentId	string	Yes
voteId	string	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

响应

返回：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 评论

参数

Name	Type	Required
page	number	否
count	number	否
textSearch	string	否
byIPFromComment	string	否
filters	string	否
searchFilters	string	否
sorts	string	否
demo	boolean	否
tenantId	string	否
sso	string	否

响应

返回: 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 ID

参数

名称	类型	必填
textSearch	string	否
byIPFromComment	string	否
filters	string	否
searchFilters	string	否
afterId	string	否
demo	boolean	否
tenantId	string	否
sso	string	否

响应

返回: 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	Yes
tenantId	string	No
sso	string	No

响应

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

获取评论封禁状态

参数

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

响应

返回：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');
}

获取评论子项

参数

Name	Type	Required
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	No
byIPFromComment	string	No
filter	string	No
searchFilters	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

响应

返回：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	Yes
tenantId	string	No
sso	string	No

响应

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

获取手动徽章

参数

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

响应

返回：GetManualBadgesResponse

示例

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

获取审核评论

参数

Name	Type	Required
commentId	string	Yes
includeEmail	boolean	No
includeIP	boolean	No
tenantId	string	No
sso	string	No

响应

返回: 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");
  // 根据需要使用结果...
}

获取审核评论文本

参数

名称	类型	必填
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

响应

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

获取搜索评论摘要

参数

Name	Type	Required
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	No
tenantId	string	No
sso	string	No

响应

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

获取搜索站点

参数

名称	类型	必需
value	string	否
tenantId	string	否
sso	string	否

响应

返回: 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)
}

获取搜索建议

参数

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

响应

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

获取用户封禁偏好

参数

名称	类型	必需	描述
tenantId	string	No
sso	string	No

响应

返回: 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	否
tenantId	string	否
sso	string	否

响应

返回：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	是
adjustCommentVotesParams	AdjustCommentVotesParams	是
broadcastId	string	否
tenantId	string	否
sso	string	否

响应

返回：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	否
byIPFromComment	string	否
filters	string	否
searchFilters	string	否
sorts	string	否
tenantId	string	否
sso	string	否

响应

返回: 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	Yes
tenantId	string	No
sso	string	No

响应

返回: 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	是
includeByUserIdAndEmail	boolean	否
includeByIP	boolean	否
includeByEmailDomain	boolean	否
tenantId	string	否
sso	string	否

响应

返回: 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 获取评论

参数

名称	类型	必需
commentsByIdsParams	CommentsByIdsParams	Yes
tenantId	string	No
sso	string	No

响应

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

举报评论（审核）

参数

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

响应

返回: 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	Yes
approved	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

响应

返回：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	Yes
reviewed	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

响应

返回：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	是
setCommentTextParams	SetCommentTextParams	是
broadcastId	string	否
tenantId	string	否
sso	string	否

响应

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

关闭讨论串

参数

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

响应

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

设置信任因子

参数

名称	类型	必填
userId	string	否
trustFactor	string	否
tenantId	string	否
sso	string	否

响应

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

创建版主

参数

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

响应

返回: CreateModeratorResponse1

示例

createModerator 示例

Copy

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

删除版主

参数

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

响应

返回: 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	是
id	string	是

响应

返回：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	是
skip	number	否

响应

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

发送邀请

参数

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

响应

返回：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	是
id	string	是
updateModeratorBody	UpdateModeratorBody	是

响应

返回：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	是

响应

返回: 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	是
userId	string	否
urlId	string	否
fromCommentId	string	否
viewed	boolean	否
type	string	否

响应

返回：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	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No
skip	number	No

响应

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

更新通知

参数

Name	Type	Required
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	是
urlId	string	是
id	string	是
title	string	否

响应

返回: 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	Yes
urlId	string	Yes

响应

返回: 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	Yes
urlId	string	Yes
id	string	Yes

响应

返回: 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 页面互动用户

参数

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

响应

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

添加页面

参数

Name	Type	Required	Description
tenantId	string	Yes
createAPIPageData	CreateAPIPageData	Yes

响应

Returns: 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}，从 afterName 开始向前使用 $gt 索引，无需 $skip 开销。

Parameters

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

Response

返回：GetOfflineUsersResponse

Example

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（整个房间的订阅者数量，包括我们未列出的匿名观看者）。

参数

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

响应

返回：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	Yes
urlId	string	Yes

响应

返回: 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	是

响应

返回：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 的页面会根据请求用户的组访问权限进行过滤。

参数

Name	Type	Required
tenantId	string	Yes
cursor	string	No
limit	number	No
q	string	No
sortBy	PagesSortBy	No
hasComments	boolean	No

响应

返回：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 的显示信息。由评论小部件使用，以丰富通过存在事件刚出现的用户。没有页面上下文：隐私被统一强制执行（私有个人资料会被屏蔽）。

参数

名称	类型	必填	描述
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);
// Optional fields in the response may be 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 事件计数

参数

Name	Type	Required
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	是
commentId	string	否
externalId	string	否
eventType	string	否
type	string	否
domain	string	否
attemptCountGT	number	否
skip	number	否

响应

返回: 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	是
id	string	是

响应

返回：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	Yes
id	string	Yes

响应

返回：GetQuestionConfigResponse1

示例

getQuestionConfig 示例

Copy

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

获取问答配置列表

参数

名称	类型	必填	描述
tenantId	string	Yes
skip	number	No

响应

返回: GetQuestionConfigsResponse1

示例

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	是
id	string	是
updateQuestionConfigBody	UpdateQuestionConfigBody	是

响应

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

创建问答结果

参数

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

响应

返回：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]
  // 可选字段如备注已省略
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

删除问答结果

参数

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

响应

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

获取问答结果

参数

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

响应

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

获取问答结果列表

参数

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

响应

返回: 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	是
id	string	是
updateQuestionResultBody	UpdateQuestionResultBody	是

响应

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

将评论与问答结果合并

参数

名称	类型	必需
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	Yes
createAPISSOUserData	CreateAPISSOUserData	Yes

响应

返回：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	是
id	string	是
deleteComments	boolean	否
commentDeleteMode	string	否

响应

返回：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 用户

参数

名称	类型	必填	描述
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	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

响应

返回: 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	是
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	是

响应

返回：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);
})();

删除订阅

参数

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

响应

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

更新订阅

参数

名称	类型	必填
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	是
yearNumber	number	否
monthNumber	number	否
dayNumber	number	否
skip	number	否

响应

返回: GetTenantDailyUsagesResponse1

示例

getTenantDailyUsages 示例

Copy

async function fetchDailyUsage() {
  const tenantId: string = "tenant-9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 5; // 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();

创建租户套餐

参数

名称	类型	必填	描述
tenantId	string	是
createTenantPackageBody	CreateTenantPackageBody	是

响应

返回：CreateTenantPackageResponse1

示例

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	是

响应

返回: 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;
}

获取租户套餐列表

参数

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

响应

返回：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	是
id	string	是
replaceTenantPackageBody	ReplaceTenantPackageBody	是

响应

返回：ReplaceTenantPackageResponse

示例

replaceTenantPackage 示例

Copy

(async () => {
    const tenantId: string = "acme-corp-tenant-01";
    const packageId: string = "pkg-2024-annual";
    const config: CustomConfigParameters = {
        // 在此处添加自定义配置字段
    };
    const body: ReplaceTenantPackageBody = {
        name: "Enterprise Package",
        // 可选的自定义配置
        customConfig: config,
    };
    const response: ReplaceTenantPackageResponse = await replaceTenantPackage(tenantId, packageId, body);
    console.log(response);
})();

更新租户套餐

参数

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

响应

返回: 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	Yes
createTenantUserBody	CreateTenantUserBody	Yes

响应

返回：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	是
id	string	是
deleteComments	string	否
commentDeleteMode	string	否

响应

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

获取租户用户

参数

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

响应

返回：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	Yes
id	string	Yes
redirectURL	string	No

响应

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

更新租户用户

参数

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateTenantUserBody	UpdateTenantUserBody	Yes
updateComments	string	No

响应

返回: 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	Yes
createTenantBody	CreateTenantBody	Yes

响应

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

删除租户

参数

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

响应

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

获取租户

参数

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

响应

返回: 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	Yes
meta	string	No
skip	number	No

响应

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

更改工单状态

参数

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

响应

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

创建工单

参数

Name	Type	Required
tenantId	string	是
userId	string	是
createTicketBody	CreateTicketBody	是

响应

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

获取工单列表

参数

Name	Type	Required
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	Yes
component	string	Yes
locale	string	No
useFullTranslationIds	boolean	No

响应

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	是
userId	string	是

响应

返回：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	是
userId	string	否
limit	number	否
skip	number	否

响应

返回：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",
  // 描述是可选的，此处省略
};
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();

获取用户徽章

参数

名称	类型	必填	描述
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();

获取用户徽章列表

参数

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

响应

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

更新用户徽章

参数

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

响应

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

获取用户通知计数

参数

Name	Type	Required	Description
tenantId	string	Yes
sso	string	No

响应

Returns: GetUserNotificationCountResponse1

示例

getUserNotificationCount 示例

Copy

async function demoGetUserNotificationCount() {
    const tenantId: string = "acme-corp-01";
    // 使用可选的 SSO 令牌调用
    const countWithSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId,
        "sso-token-abc123"
    );
    // 调用时不使用 SSO 令牌
    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	否

响应

返回: 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; // 示例 UNIX 时间戳
  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.

Parameters

Name	Type	Required
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

Response

返回：UpdateUserNotificationCommentSubscriptionStatusResponse

Example

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

响应

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

更新用户通知状态

参数

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

响应

Returns: 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);
}

搜索用户

参数

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

创建投票

参数

Name	Type	Required
tenantId	string	Yes
commentId	string	Yes
direction	CreateVoteDirectionEnum	Yes
userId	string	No
anonUserId	string	No

响应

返回: 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 参考

文档

使用

聚合

审计日志

从评论屏蔽

检查被屏蔽的评论

评论

用户的评论

域配置

邮件模板

事件日志

动态帖子

举报评论

GIFs

话题标签

审核

版主

通知计数

通知

页面互动

页面

待处理的 Webhook 事件

问答配置

问答结果

问答结果汇总

SSO 用户

订阅

租户每日使用情况

租户套餐

租户用户

租户

工单

翻译

上传图片

用户徽章进度

用户徽章

用户通知

用户在线状态

用户搜索

用户

投票

FastComments JavaScript/TypeScript 开发工具包 (SDK)

仓库

安装

API 文档

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

浏览器与服务器兼容性

使用方法

浏览器 使用（客户端）

服务器 使用（Node.js）

仅类型导入

使用单个 API 类

浏览器环境

服务器环境

公开 API 与受保护 API

示例：使用 Public API（浏览器安全）

示例：使用 Default API（仅限服务器端）

示例：使用 Moderation API

SSO（单点登录）集成

简单 SSO（仅服务器端）

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

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

带评论创建的 SSO

常见用例

获取页面的评论

创建评论

对评论投票

用户管理（需要 API 密钥）

实时事件（实时更新）

页面级事件

订阅用户事件

获取 userIdWS

广播 ID

错误处理

聚合

参数

响应

浏览器使用（客户端）

服务器使用（Node.js）