FastComments JavaScript/TypeScript SDK

이것은 FastComments용 공식 JavaScript/TypeScript SDK입니다.

FastComments API용 공식 JavaScript/TypeScript SDK

저장소

설치

npm install fastcomments-sdk

API 문서

전체 API 참조: docs/api/README.md

브라우저와 서버 호환성

이 SDK는 최적의 호환성을 보장하고 런타임 오류를 방지하기 위해 이중 진입점을 사용합니다:

fastcomments-sdk/browser - 네이티브 fetch를 사용하는 브라우저 안전 버전
fastcomments-sdk/server - SSO를 지원하는 전체 Node.js 버전
fastcomments-sdk (기본) - 타입 전용, 어디서나 안전하게 임포트 가능

사용법

이 SDK는 브라우저 및 서버 환경에 대해 최적의 호환성과 보안을 보장하기 위해 별도의 진입점을 제공합니다:

Browser Usage (Client-Side)

브라우저/프런트엔드 애플리케이션의 경우 Node.js 종속성을 제외한 브라우저 안전 익스포트를 사용하세요:

// Browser-safe import (no Node.js dependencies)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Create browser SDK instance
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use public APIs (no API key needed - safe for browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Server Usage (Node.js)

서버/백엔드 애플리케이션의 경우 SSO 및 인증 기능을 포함한 전체 SDK를 사용하세요:

// Server-side import (includes SSO and designed to work with NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Create server SDK instance
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Keep this secret on the server!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Use secured APIs with your API key
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Types Only Import

TypeScript 타입만 필요하고 런타임 코드는 필요하지 않다면(default import)을 사용하세요:

// Types only (no runtime dependencies - safe everywhere)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Using Individual API Classes

Browser Environment

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

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

const publicApi = new PublicApi(config);

Server Environment

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

The SDK는 세 가지 주요 API 클래스를 제공합니다:

DefaultApi - 인증을 위해 API 키가 필요한 보안 엔드포인트입니다. 서버 측 작업에 사용하세요.
PublicApi - API 키 없이 접근 가능한 공개 엔드포인트입니다. 브라우저/모바일 기기 등에서 직접 호출할 수 있습니다.
HiddenApi - 고급 사용 사례를 위한 내부/관리자용 엔드포인트입니다.

예시: Public API 사용 (브라우저에서 안전하게 사용)

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

const publicApi = new PublicApi();

// 페이지의 댓글을 가져옵니다 (API 키 필요 없음)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

예시: Default API 사용 (서버 측 전용)

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

const config = new Configuration({
  apiKey: 'your-api-key' // 비밀로 유지하세요!
});
const defaultApi = new DefaultApi(config);

// 전체 관리자 권한으로 댓글을 가져옵니다
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO(싱글 사인온) 통합

FastComments는 기존 사용자 인증 시스템과 통합하기 위해 SSO를 지원합니다. SSO 기능은 Node.js의 crypto 기능을 필요로 하기 때문에 서버 내보내기에서만 사용할 수 있습니다.

간단한 SSO (서버 전용)

간단한 SSO는 서버 측에서 생성되어 클라이언트로 전송되어야 합니다:

// 서버 측 코드 (Node.js/백엔드)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Create simple SSO using the built-in helper  
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';

// Create secure SSO using the built-in helper
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 // 서버에서 생성된 SSO 토큰 사용
});

댓글 생성과 함께하는 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',
};

// 특정 페이지의 라이브 이벤트를 구독합니다
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (getComments 응답에서 가져옵니다)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // 새 댓글로 UI를 업데이트합니다
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // UI의 투표 수를 업데이트합니다
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // 이벤트가 처리되었으면 true를 반환합니다
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// 완료되면 구독을 닫습니다
subscription.close();

사용자 이벤트 구독

사용자별 이벤트(알림, 멘션 등)를 수신합니다:

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

const userConfig = {
  userIdWS: 'user-session-id', // getComments 응답에서 가져옵니다
};

// 사용자의 개인 피드를 구독합니다
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // 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');
  }
);

// 완료되면 닫습니다
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'
});

// 응답에서 userIdWS를 추출합니다
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // 이제 라이브 이벤트를 구독할 수 있습니다
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

브로드캐스트 ID

일부 API 호출에서는 broadcastId를 전달해야 한다는 것을 보게 될 것입니다. 이벤트를 수신하면 이 ID가 반환되므로, 클라이언트에서 낙관적으로 변경을 적용하려는 경우(가장 좋은 경험을 제공하므로 아마도 그렇게 하게 될 것입니다) 해당 이벤트를 무시해야 할지 알 수 있습니다. 여기에는 UUID를 전달하세요. 이 ID는 브라우저 세션에서 두 번 발생하지 않을 정도로 충분히 고유해야 합니다.

import { v4 as uuidv4 } from 'uuid';

const response = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'page-id',
    comment: 'My comment',
    broadcastId: uuidv4() // 이 작업을 위한 고유 ID
  }
});

오류 처리

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

집계

문서를 그룹화하여 (groupBy가 제공된 경우) 여러 연산을 적용해 집계합니다. 다양한 연산(예: sum, countDistinct, avg 등)이 지원됩니다.

매개변수

이름	형식	필수
tenantId	string	예
aggregationRequest	AggregationRequest	예
parentTenantId	string	아니요
includeStats	boolean	아니요

응답

반환: AggregationResponse

감사 로그 조회

매개변수

이름	유형	필수
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

응답

반환: GetAuditLogs200Response

예제

getAuditLogs 예제

Copy

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

공개 댓글에서 차단

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
publicBlockFromCommentParams	PublicBlockFromCommentParams	예
sso	string	아니오

응답

반환: BlockFromCommentPublic200Response

예제

blockFromCommentPublic 예제

Copy

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

공개 댓글 차단 해제

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
publicBlockFromCommentParams	PublicBlockFromCommentParams	예
sso	string	아니요

응답

반환: UnBlockCommentPublic200Response

예제

unBlockCommentPublic 예제

Copy

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

차단된 댓글 확인

매개변수

Name	Type	Required
tenantId	string	예
commentIds	string	예
sso	string	아니오

응답

반환: CheckedCommentsForBlocked200Response

예제

checkedCommentsForBlocked 예제

Copy

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

댓글에서 사용자 차단

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
blockFromCommentParams	BlockFromCommentParams	예
userId	string	아니요
anonUserId	string	아니요

응답

반환: BlockFromCommentPublic200Response

예제

blockUserFromComment 예제

Copy

const tenantId: string = "tenant_12345";
const id: string = "comment_67890";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated abusive language",
  blockDurationHours: 168,
  blockReplies: true,
  notifyAuthor: true
};
const userId: string = "user_abc123";
const anonUserId: string = "anon_xyz789";
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

공개 댓글 생성

매개변수

이름	타입	필수
tenantId	string	예
urlId	string	예
broadcastId	string	예
commentData	CommentData	예
sessionId	string	아니오
sso	string	아니오

응답

반환: CreateCommentPublic200Response

예제

createCommentPublic 예제

Copy

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

댓글 삭제

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
contextUserId	string	아니오
isLive	boolean	아니오

응답

반환값: DeleteComment200Response

예제

deleteComment 예제

Copy

const tenantId: string = 'tenant_7b3f2a';
const commentId: string = 'cmt_8a1f4d2b';
const contextUserId: string = 'user_102';
const isLive: boolean = true;
const result: DeleteComment200Response = await deleteComment(tenantId, commentId, contextUserId, isLive);

공개 댓글 삭제

매개변수

이름	타입	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
editKey	string	아니오
sso	string	아니오

응답

반환: DeleteCommentPublic200Response

예제

deleteCommentPublic 예제

Copy

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

댓글 투표 삭제

매개변수

Name	Type	Required
tenantId	string	예
commentId	string	예
voteId	string	예
urlId	string	예
broadcastId	string	예
editKey	string	아니요
sso	string	아니요

응답

반환: DeleteCommentVote200Response

예제

deleteCommentVote 예제

Copy

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

댓글 신고

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
userId	string	아니요
anonUserId	string	아니요

응답

반환: FlagComment200Response

예제

flagComment 예제

Copy

const tenantId: string = 'tenant_acme_001';
const id: string = 'comment_7f3a2b9e';
const userId: string = 'user_jdoe_1001';
const anonUserId: string = 'anon_3f2b_visitor';
const result: FlagComment200Response = await flagComment(tenantId, id, userId, anonUserId);

댓글 조회

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetComment200Response

예제

getComment 예제

Copy

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

댓글 목록 조회

매개변수

Name	Type	Required
tenantId	string	예
page	number	아니요
limit	number	아니요
skip	number	아니요
asTree	boolean	아니요
skipChildren	number	아니요
limitChildren	number	아니요
maxTreeDepth	number	아니요
urlId	string	아니요
userId	string	아니요
anonUserId	string	아니요
contextUserId	string	아니요
hashTag	string	아니요
parentId	string	아니요
direction	SortDirections	아니요

응답

반환: GetComments200Response

예제

getComments 예제

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // 페이지
  20, // 페이지당 항목 수
  0, // 건너뛸 항목 수
  true, // 트리 구조로 반환
  1, // 건너뛸 자식 개수
  3, // 자식 제한
  4, // 트리의 최대 깊이
  'articles/2026/new-product-launch', // urlId
  'user_7890', // 사용자 ID
  'anon_4f3b2', // 익명 사용자 ID
  undefined, // contextUserId
  '#launch', // 해시태그
  undefined // 부모 ID
);

공개 댓글 조회

req tenantId urlId

매개변수

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

응답

반환: GetCommentsPublic200Response

예제

getCommentsPublic 예제

Copy

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

댓글 내용 조회

매개변수

Name	Type	필수
tenantId	string	예
commentId	string	예
editKey	string	아니오
sso	string	아니오

응답

반환: GetCommentText200Response

예제

getCommentText 예제

Copy

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

댓글 투표 사용자명 조회

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
dir	number	예
sso	string	아니오

응답

반환: GetCommentVoteUserNames200Response

예제

getCommentVoteUserNames 예제

Copy

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

댓글 잠금

매개변수

Name	Type	Required
tenantId	string	예
commentId	string	예
broadcastId	string	예
sso	string	아니요

응답

반환: LockComment200Response

예제

lockComment 예제

Copy

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

댓글 고정

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
sso	string	아니요

응답

반환: PinComment200Response

예제

pinComment 예제

Copy

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

댓글 저장

매개변수

이름	형식	필수
tenantId	string	예
createCommentParams	CreateCommentParams	예
isLive	boolean	아니요
doSpamCheck	boolean	아니요
sendEmails	boolean	아니요
populateNotifications	boolean	아니요

응답

반환값: SaveComment200Response

예제

saveComment 예제

Copy

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

댓글 일괄 저장

매개변수

이름	형식	필수
tenantId	string	예
createCommentParams	Array	예
isLive	boolean	아니요
doSpamCheck	boolean	아니요
sendEmails	boolean	아니요
populateNotifications	boolean	아니요

응답

반환: Array<SaveComment200Response

예제

saveCommentsBulk 예제

Copy

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

댓글 내용 설정

매개변수

이름	유형	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
commentTextUpdateRequest	CommentTextUpdateRequest	예
editKey	string	아니오
sso	string	아니오

응답

반환: SetCommentText200Response

예제

setCommentText 예제

Copy

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

댓글에서 사용자 차단 해제

Parameters

이름	유형	필수
tenantId	string	예
id	string	예
unBlockFromCommentParams	UnBlockFromCommentParams	예
userId	string	아니오
anonUserId	string	아니오

응답

반환: UnBlockCommentPublic200Response

예제

unBlockUserFromComment 예제

Copy

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

댓글 신고 취소

매개변수

이름	타입	필수
tenantId	string	예
id	string	예
userId	string	아니요
anonUserId	string	아니요

응답

반환: FlagComment200Response

예제

unFlagComment 예제

Copy

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

댓글 잠금 해제

매개변수

이름	타입	필수
tenantId	string	예
commentId	string	예
broadcastId	string	예
sso	string	아니요

응답

반환: LockComment200Response

예제

unLockComment 예제

Copy

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

댓글 고정 해제

매개변수

Name	Type	Required
tenantId	string	예
commentId	string	예
broadcastId	string	예
sso	string	아니오

응답

반환: PinComment200Response

예제

unPinComment 예제

Copy

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

댓글 업데이트

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
updatableCommentParams	UpdatableCommentParams	예
contextUserId	string	아니요
doSpamCheck	boolean	아니요
isLive	boolean	아니요

응답

반환: FlagCommentPublic200Response

예제

updateComment 예제

Copy

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

댓글 투표

매개변수

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

응답

반환: VoteComment200Response

예제

voteComment 예제

Copy

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

도메인 구성 추가

매개변수

이름	유형	필수	설명
tenantId	string	예
addDomainConfigParams	AddDomainConfigParams	예

응답

반환: AddDomainConfig200Response

도메인 구성 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
domain	string	예

응답

반환: DeleteDomainConfig200Response

도메인 구성 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
domain	string	예

응답

반환: GetDomainConfig200Response

도메인 구성 목록 조회

매개변수

이름	형식	필수	설명
tenantId	string	예

응답

반환: GetDomainConfigs200Response

도메인 구성 부분 수정

매개변수

이름	형식	필수
tenantId	string	예
domainToUpdate	string	예
patchDomainConfigParams	PatchDomainConfigParams	예

응답

반환: GetDomainConfig200Response

도메인 구성 교체

매개변수

이름	유형	필수
tenantId	string	예
domainToUpdate	string	예
updateDomainConfigParams	UpdateDomainConfigParams	예

응답

반환: GetDomainConfig200Response

이메일 템플릿 생성

매개변수

이름	형식	필수	설명
tenantId	string	예
createEmailTemplateBody	CreateEmailTemplateBody	예

응답

반환: CreateEmailTemplate200Response

예제

createEmailTemplate 예제

Copy

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

이메일 템플릿 삭제

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteEmailTemplate 예제

Copy

const tenantId: string = 'tenant_7f4c9d1e';
const templateId: string = 'tmpl_welcome_2024-03';
const notifyAdmin: boolean | undefined = true; // 선택적 매개변수 예시
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

이메일 템플릿 렌더링 오류 삭제

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
errorId	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteEmailTemplateRenderError 예제

Copy

const tenantId: string = 'tenant_7f3b4c2a';
const templateEnvironment: string | undefined = 'production'; // 선택적 환경 선택기
const id: string = `emailTemplates/${templateEnvironment ?? 'staging'}/welcome_v2`;
const errorId: string = 'err_5a9d2f1c';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
console.log(result);

이메일 템플릿 조회

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetEmailTemplate200Response

예제

getEmailTemplate 예제

Copy

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

이메일 템플릿 정의 조회

매개변수

이름	유형	필수	설명
tenantId	string	예

응답

반환: GetEmailTemplateDefinitions200Response

예제

getEmailTemplateDefinitions 예제

Copy

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

이메일 템플릿 렌더링 오류 조회

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
skip	number	아니오

응답

반환: GetEmailTemplateRenderErrors200Response

예제

getEmailTemplateRenderErrors 예제

Copy

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

이메일 템플릿 목록 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
skip	number	아니요

응답

반환: GetEmailTemplates200Response

예제

getEmailTemplates 예제

Copy

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

이메일 템플릿 렌더링

매개변수

이름	형식	필수
tenantId	string	예
renderEmailTemplateBody	RenderEmailTemplateBody	예
locale	string	아니요

응답

반환: RenderEmailTemplate200Response

예제

renderEmailTemplate 예제

Copy

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

이메일 템플릿 업데이트

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
updateEmailTemplateBody	UpdateEmailTemplateBody	예

응답

반환: FlagCommentPublic200Response

예제

updateEmailTemplate 예제

Copy

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

이벤트 로그 조회

req tenantId urlId userIdWS

매개변수

이름	형식	필수
tenantId	string	예
urlId	string	예
userIdWS	string	예
startTime	number	예
endTime	number	예

응답

반환: GetEventLog200Response

예제

getEventLog 예제

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // 선택적 업스트림 값
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  startTime,
  endTime
);

글로벌 이벤트 로그 조회

요청 tenantId urlId userIdWS

매개변수

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

응답

반환: GetEventLog200Response

예제

getGlobalEventLog 예제

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // 7일 전
const endTimeOptional: number | undefined = undefined; // 선택적 기간 종료
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

피드 게시물 생성

매개변수

Name	Type	Required
tenantId	string	예
createFeedPostParams	CreateFeedPostParams	예
broadcastId	string	아니요
isLive	boolean	아니요
doSpamCheck	boolean	아니요
skipDupCheck	boolean	아니요

응답

반환: CreateFeedPost200Response

예제

createFeedPost 예제

Copy

const tenantId: string = "tenant_7f3b9a";
const createFeedPostParams: CreateFeedPostParams = {
  title: "Weekly Product Update — March 2026",
  body: "We've shipped performance improvements and bug fixes across the web client. See the release notes for details.",
  authorId: "user_86fa2b",
  allowComments: true,
  media: [
    {
      url: "https://cdn.example.com/images/update-march.png",
      mimeType: "image/png",
      caption: "Performance graph",
      assets: [{ url: "https://cdn.example.com/images/update-march@2x.png", width: 1600, height: 900 }]
    }
  ],
  links: [{ url: "https://www.example.com/release-notes/march-2026", title: "Release notes" }]
};
const broadcastId: string = "broadcast_prod_updates_202603";
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

공개 피드 게시물 생성

매개변수

이름	타입	필수
tenantId	string	예
createFeedPostParams	CreateFeedPostParams	예
broadcastId	string	아니요
sso	string	아니요

응답

반환: CreateFeedPostPublic200Response

예제

createFeedPostPublic 예제

Copy

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

공개 피드 게시물 삭제

매개변수

이름	타입	필수
tenantId	string	예
postId	string	예
broadcastId	string	아니요
sso	string	아니요

응답

반환: DeleteFeedPostPublic200Response

예제

deleteFeedPostPublic 예제

Copy

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

피드 게시물 조회

req tenantId afterId

매개변수

이름	타입	필수
tenantId	string	예
afterId	string	아니요
limit	number	아니요
tags	Array	아니요

응답

반환: GetFeedPosts200Response

예제

getFeedPosts 예제

Copy

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

공개 피드 게시물 조회

req tenantId afterId

매개변수

이름	유형	필수
tenantId	string	예
afterId	string	아니오
limit	number	아니오
tags	Array	아니오
sso	string	아니오
isCrawler	boolean	아니오
includeUserInfo	boolean	아니오

응답

반환: GetFeedPostsPublic200Response

예제

getFeedPostsPublic 예제

Copy

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

피드 게시물 통계 조회

매개변수

이름	타입	필수
tenantId	string	예
postIds	Array	예
sso	string	아니요

응답

반환: GetFeedPostsStats200Response

예제

getFeedPostsStats 예제

Copy

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

공개 사용자 반응 조회

매개변수

이름	타입	필수
tenantId	string	예
postIds	Array	아니요
sso	string	아니요

응답

반환: GetUserReactsPublic200Response

예제

getUserReactsPublic 예제

Copy

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

공개 피드 게시물에 반응

매개변수

이름	유형	필수
tenantId	string	예
postId	string	예
reactBodyParams	ReactBodyParams	예
isUndo	boolean	아니요
broadcastId	string	아니요
sso	string	아니요

응답

반환: ReactFeedPostPublic200Response

예제

reactFeedPostPublic 예제

Copy

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

피드 게시물 업데이트

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
feedPost	FeedPost	예

응답

반환: FlagCommentPublic200Response

예제

updateFeedPost 예제

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // 선택적 배열 포함
  links: [link],          // 선택적 링크 포함
  isPublished: true       // 여기서는 선택적 게시 플래그 사용됨
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

공개 피드 게시물 업데이트

매개변수

Name	Type	Required
tenantId	string	예
postId	string	예
updateFeedPostParams	UpdateFeedPostParams	예
broadcastId	string	아니요
sso	string	아니요

응답

반환: CreateFeedPostPublic200Response

예제

updateFeedPostPublic 예제

Copy

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

공개 댓글 신고

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
isFlagged	boolean	Yes
sso	string	No

응답

반환: FlagCommentPublic200Response

예제

flagCommentPublic 예제

Copy

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

해시태그 추가

매개변수

이름	유형	필수	설명
tenantId	string	아니요
createHashTagBody	CreateHashTagBody	아니요

응답

반환: AddHashTag200Response

예제

addHashTag 예제

Copy

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

해시태그 일괄 추가

매개변수

이름	유형	필수	설명
tenantId	string	아니오
bulkCreateHashTagsBody	BulkCreateHashTagsBody	아니오

응답

반환: AddHashTagsBulk200Response

예시

addHashTagsBulk 예시

Copy

// 테넌트 식별자 생성 (선택 매개변수)
const tenantId: string = "tenant_9f8c2b7a";
// 개별 태그 항목 준비
const tag1: BulkCreateHashTagsBodyTagsInner = {
  name: "product-feedback",
  label: "Product Feedback",
  color: "#1f8a70",
  description: "User suggestions and enhancement requests",
  isActive: true
};
const tag2: BulkCreateHashTagsBodyTagsInner = {
  name: "bug-report",
  label: "Bug Report",
  color: "#d64545",
  description: "User-reported defects and issues",
  isActive: true
};
// 일괄 생성 본문 (선택 매개변수)
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [tag1, tag2]
};
// 전역 비동기 함수를 호출하고 타입이 지정된 결과를 할당
const result: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);

해시태그 삭제

매개변수

Name	Type	Required
tag	string	예
tenantId	string	아니오
deleteHashTagRequest	DeleteHashTagRequest	아니오

응답

반환: FlagCommentPublic200Response

예제

deleteHashTag 예제

Copy

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

해시태그 조회

매개변수

이름	형식	필수	설명
tenantId	string	예
page	number	아니요

응답

반환: GetHashTags200Response

예제

getHashTags 예제

Copy

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

해시태그 부분 수정

매개변수

Name	Type	Required
tag	string	예
tenantId	string	아니오
updateHashTagBody	UpdateHashTagBody	아니오

응답

반환: PatchHashTag200Response

예제

patchHashTag 예제

Copy

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

모더레이터 생성

매개변수

이름	형식	필수	설명
tenantId	string	예
createModeratorBody	CreateModeratorBody	예

응답

반환: CreateModerator200Response

예제

createModerator 예제

Copy

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

모더레이터 삭제

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
sendEmail	string	아니오

응답

반환: FlagCommentPublic200Response

예제

deleteModerator 예제

Copy

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

모더레이터 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetModerator200Response

예제

getModerator 예제

Copy

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

모더레이터 목록 조회

매개변수

이름	형식	필수	설명
tenantId	string	예
skip	number	아니오

응답

반환: GetModerators200Response

예제

getModerators 예제

Copy

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

초대 전송

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
fromName	string	예

응답

반환: FlagCommentPublic200Response

예제

sendInvite 예제

Copy

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

모더레이터 업데이트

매개변수

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

응답

반환: FlagCommentPublic200Response

예제

updateModerator 예제

Copy

const tenantId: string = "acme-enterprises-42";
const id: string = "moderator_517";
const updateModeratorBody: UpdateModeratorBody = {
  displayName: "Sofia Martinez",
  email: "sofia.martinez@acme.com",
  permissions: ["approve_comments", "flag_spam", "suspend_users"],
  active: true,
  avatarUrl: "https://cdn.acme.com/avatars/sofia.jpg" // 선택적 필드 예시
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

알림 수 삭제

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteNotificationCount 예제

Copy

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

캐시된 알림 수 조회

매개변수

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

응답

Returns: GetCachedNotificationCount200Response

예제

getCachedNotificationCount 예제

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // 선택적 매개변수 플래그 (예시)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

알림 수 조회

매개변수

Name	유형	필수
tenantId	string	예
userId	string	아니요
urlId	string	아니요
fromCommentId	string	아니요
viewed	boolean	아니요
type	string	아니요

응답

반환: GetNotificationCount200Response

예제

getNotificationCount 예제

Copy

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

알림 조회

매개변수

이름	형식	필수
tenantId	string	예
userId	string	아니오
urlId	string	아니오
fromCommentId	string	아니오
viewed	boolean	아니오
type	string	아니오
skip	number	아니오

응답

반환: GetNotifications200Response

예제

getNotifications 예제

Copy

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

알림 업데이트

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
updateNotificationBody	UpdateNotificationBody	예
userId	string	아니요

응답

반환: FlagCommentPublic200Response

예제

updateNotification 예제

Copy

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

페이지 추가

매개변수

이름	유형	필수	설명
tenantId	string	예
createAPIPageData	CreateAPIPageData	예

응답

반환: AddPageAPIResponse

페이지 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: DeletePageAPIResponse

URL ID로 페이지 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
urlId	string	예

응답

반환: GetPageByURLIdAPIResponse

페이지 목록 조회

매개변수

이름	유형	필수	설명
tenantId	string	예

응답

반환: GetPagesAPIResponse

페이지 부분 수정

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateAPIPageData	UpdateAPIPageData	예

응답

반환: PatchPageAPIResponse

대기 중인 웹훅 이벤트 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deletePendingWebhookEvent 예제

Copy

(async () => {
  const tenantId: string = 'tenant_42f7c9b1';
  const id: string = 'pending_webhook_ev_8f3b9a2d';
  const reason?: string = undefined; // 선택적 매개변수 예시 (함수에서 요구되지 않음)
  const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);
  console.log(result);
})();

대기 중인 웹훅 이벤트 수 조회

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	아니요
externalId	string	아니요
eventType	string	아니요
type	string	아니요
domain	string	아니요
attemptCountGT	number	아니요

응답

반환: GetPendingWebhookEventCount200Response

예제

getPendingWebhookEventCount 예제

Copy

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

대기 중인 웹훅 이벤트 조회

매개변수

이름	형식	필수
tenantId	string	예
commentId	string	아니오
externalId	string	아니오
eventType	string	아니오
type	string	아니오
domain	string	아니오
attemptCountGT	number	아니오
skip	number	아니오

응답

반환: GetPendingWebhookEvents200Response

예제

getPendingWebhookEvents 예제

Copy

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

질문 설정 생성

매개변수

이름	타입	필수	설명
tenantId	string	예
createQuestionConfigBody	CreateQuestionConfigBody	예

응답

반환: CreateQuestionConfig200Response

예제

createQuestionConfig 예제

Copy

const tenantId: string = "tenant_9f8b2c";
const option: QuestionConfigCustomOptionsInner = { id: "opt_yes", label: "Yes, helpful", value: "yes" };
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Article usefulness",
  prompt: "Was this article helpful?",
  type: "singleChoice",
  required: false, // 선택적 매개변수 예시
  options: [option],
  saveBehavior: "immediate"
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

질문 설정 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteQuestionConfig 예제

Copy

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

질문 설정 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetQuestionConfig200Response

예제

getQuestionConfig 예제

Copy

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

질문 설정 목록 조회

매개변수

Name	Type	Required	Description
tenantId	string	예
skip	number	아니요

응답

반환: GetQuestionConfigs200Response

예제

getQuestionConfigs 예제

Copy

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

질문 설정 업데이트

매개변수

이름	타입	필수
tenantId	string	예
id	string	예
updateQuestionConfigBody	UpdateQuestionConfigBody	예

응답

반환: FlagCommentPublic200Response

예제

updateQuestionConfig 예제

Copy

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

질문 결과 생성

매개변수

이름	유형	필수	설명
tenantId	string	예
createQuestionResultBody	CreateQuestionResultBody	예

응답

반환: CreateQuestionResult200Response

예제

createQuestionResult 예제

Copy

const tenantId: string = "tenant-72b1f4";
const meta: MetaItem[] = [{ key: "platform", value: "web" }];
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: "question-83472",
  commenterId: "user-5521",
  answers: [{ subQuestionId: "sq-1", value: "Yes" }],
  meta, // 선택적 메타데이터
  note: "Follow-up requested" // 선택적 매개변수 예시
};
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

질문 결과 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteQuestionResult 예제

Copy

const tenantId: string = "org-82479";
const questionId: string = "q-6a3d2e1f";
const includeArchived?: boolean = false; // 대체 대상 선택을 시연하는 선택적 매개변수
const targetId: string = includeArchived ? "q-archived-112233" : questionId;
const result: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, targetId);

질문 결과 조회

매개변수

이름	타입	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetQuestionResult200Response

예제

getQuestionResult 예제

Copy

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

질문 결과 목록 조회

매개변수

이름	형식	필수
tenantId	string	예
urlId	string	아니요
userId	string	아니요
startDate	string	아니요
questionId	string	아니요
questionIds	string	아니요
skip	number	아니요

응답

반환: GetQuestionResults200Response

예제

getQuestionResults 예제

Copy

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

질문 결과 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateQuestionResultBody	UpdateQuestionResultBody	예

응답

반환: FlagCommentPublic200Response

예제

updateQuestionResult 예제

Copy

const tenantId: string = 'tenant_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // 선택적 메타데이터
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

질문 결과 집계

매개변수

이름	유형	필수
tenantId	string	예
questionId	string	아니오
questionIds	Array	아니오
urlId	string	아니오
timeBucket	AggregateTimeBucket	아니오
startDate	Date	아니오
forceRecalculate	boolean	아니오

응답

반환: AggregateQuestionResults200Response

예제

aggregateQuestionResults 예제

Copy

const tenantId: string = 'tenant_acme_98765';
const questionIds: Array<string> = ['q-102', 'q-103'];
const urlId: string = 'url_55b3';
const timeBucket: AggregateTimeBucket = { unit: 'day', size: 7 };
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined, // questionId는 생략됨, 대신 questionIds 사용
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

질문 결과 일괄 집계

매개변수

이름	유형	필수
tenantId	string	예
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	예
forceRecalculate	boolean	아니요

응답

반환: BulkAggregateQuestionResults200Response

예제

bulkAggregateQuestionResults 예제

Copy

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

댓글과 질문 결과 결합

매개변수

이름	형식	필수
tenantId	string	예
questionId	string	아니요
questionIds	Array	아니요
urlId	string	아니요
startDate	Date	아니요
forceRecalculate	boolean	아니요
minValue	number	아니요
maxValue	number	아니요
limit	number	아니요

응답

반환: CombineCommentsWithQuestionResults200Response

예제

combineCommentsWithQuestionResults 예제

Copy

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

SSO 사용자 추가

매개변수

이름	형식	필수	설명
tenantId	string	예
createAPISSOUserData	CreateAPISSOUserData	예

응답

반환: AddSSOUserAPIResponse

SSO 사용자 삭제

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
deleteComments	boolean	아니오
commentDeleteMode	string	아니오

응답

반환: DeleteSSOUserAPIResponse

이메일로 SSO 사용자 조회

매개변수

이름	형식	필수	설명
tenantId	string	예
email	string	예

응답

반환: GetSSOUserByEmailAPIResponse

ID로 SSO 사용자 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetSSOUserByIdAPIResponse

SSO 사용자 목록 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
skip	number	아니오

응답

반환: GetSSOUsers200Response

SSO 사용자 부분 수정

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateAPISSOUserData	UpdateAPISSOUserData	예
updateComments	boolean	아니요

응답

반환: PatchSSOUserAPIResponse

SSO 사용자 교체

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
updateAPISSOUserData	UpdateAPISSOUserData	예
updateComments	boolean	아니오

응답

반환: PutSSOUserAPIResponse

구독 생성

매개변수

이름	형식	필수	설명
tenantId	string	예
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	예

응답

반환: CreateSubscriptionAPIResponse

예제

createSubscription 예제

Copy

const tenantId: string = "acme-corp-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "u_987654",
  planId: "pro_monthly",
  startDate: new Date().toISOString(),
  trialDays: 14, // 선택적 매개변수 예시
  metadata: { source: "marketing-email" } // 선택적 매개변수 예시
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);
const subscription: APIUserSubscription = result.subscription;

구독 삭제

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
userId	string	아니요

응답

반환: DeleteSubscriptionAPIResponse

구독 목록 조회

매개변수

이름	형식	필수	설명
tenantId	string	예
userId	string	아니오

응답

반환: GetSubscriptionsAPIResponse

예제

getSubscriptions 예제

Copy

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

구독 업데이트

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	예
userId	string	아니요

응답

반환: UpdateSubscriptionAPIResponse

예제

updateSubscription 예제

Copy

const tenantId: string = 'tenant_9f3b2c';
const subscriptionId: string = 'sub_7641a2b3';
const updateData: UpdateAPIUserSubscriptionData = {
  status: 'active',
  planId: 'pro_annual',
  autoRenew: true,
  renewalDate: '2026-04-15T00:00:00Z',
  metadata: { upgradedBy: 'billing-team' }
};
const userId: string = 'user_215';
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, subscriptionId, updateData, userId);

테넌트 일일 사용량 조회

매개변수

이름	유형	필수
tenantId	string	예
yearNumber	number	아니오
monthNumber	number	아니오
dayNumber	number	아니오
skip	number	아니오

응답

반환: GetTenantDailyUsages200Response

예제

getTenantDailyUsages 예제

Copy

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

테넌트 패키지 생성

매개변수

Name	Type	Required	Description
tenantId	string	예
createTenantPackageBody	CreateTenantPackageBody	예

응답

반환: CreateTenantPackage200Response

예제

createTenantPackage 예제

Copy

const tenantId: string = 'tenant_acme_001';
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: 'Standard Moderation',
  description: 'Suitable for small-to-medium sites: basic moderation, spam rules, and analytics',
  maxCommentsPerMinute: 50,
  allowAnonymousComments: false, // 제공된 선택적 매개변수
  // 선택적 필드 생략: 예: 고급 중재 규칙, custom CSS
  customConfigParameters: {
    enableProfanityFilter: true,
    imageContentProfanityLevel: 'medium' // 예시 값; CustomConfigParameters 형태 사용
  }
};
const response: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);
console.log(response);

테넌트 패키지 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: FlagCommentPublic200Response

예제

deleteTenantPackage 예제

Copy

const tenantId: string = 'tenant_acme_corp_987';
const packageId: string = 'pkg_pro_2026_01';
type DeleteOptions = { force?: boolean; notify?: boolean };
const options: DeleteOptions = { force: true }; // 선택적 매개변수 예시
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

테넌트 패키지 조회

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetTenantPackage200Response

예제

getTenantPackage 예제

Copy

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

테넌트 패키지 목록 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
skip	number	아니오

응답

반환: GetTenantPackages200Response

예제

getTenantPackages 예제

Copy

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

테넌트 패키지 교체

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
replaceTenantPackageBody	ReplaceTenantPackageBody	예

응답

반환: FlagCommentPublic200Response

예제

replaceTenantPackage 예제

Copy

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

테넌트 패키지 업데이트

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
updateTenantPackageBody	UpdateTenantPackageBody	예

응답

반환: FlagCommentPublic200Response

예제

updateTenantPackage 예제

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // 선택적 필드는 의도적으로 생략됨(예: description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

테넌트 사용자 생성

매개변수

이름	유형	필수	설명
tenantId	string	예
createTenantUserBody	CreateTenantUserBody	예

응답

반환: CreateTenantUser200Response

예제

createTenantUser 예제

Copy

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

테넌트 사용자 삭제

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
deleteComments	string	아니오
commentDeleteMode	string	아니오

응답

반환: FlagCommentPublic200Response

예제

deleteTenantUser 예제

Copy

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

테넌트 사용자 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetTenantUser200Response

예제

getTenantUser 예제

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // 페이로드에 접근
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

테넌트 사용자 목록 조회

Parameters

Name	Type	Required	Description
tenantId	string	예
skip	number	아니요

Response

반환: GetTenantUsers200Response

예제

getTenantUsers 예제

Copy

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

테넌트 사용자 교체

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
replaceTenantUserBody	ReplaceTenantUserBody	예
updateComments	string	아니요

응답

반환: FlagCommentPublic200Response

예제

replaceTenantUser 예제

Copy

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

로그인 링크 전송

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
redirectURL	string	아니오

응답

반환: FlagCommentPublic200Response

예제

sendLoginLink 예제

Copy

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

테넌트 사용자 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateTenantUserBody	UpdateTenantUserBody	예
updateComments	string	아니요

응답

반환: FlagCommentPublic200Response

예제

updateTenantUser 예제

Copy

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

테넌트 생성

매개변수

이름	형식	필수	설명
tenantId	string	예
createTenantBody	CreateTenantBody	예

응답

반환: CreateTenant200Response

예제

createTenant 예제

Copy

const tenantId: string = "acme-corp-001";
const createTenantBody: CreateTenantBody = {
  name: "Acme Corporation",
  domain: "comments.acme.com",
  adminContact: { name: "Jane Doe", email: "jane.doe@acme.com" },
  billingInfo: { planId: "pro-monthly", billingContactEmail: "billing@acme.com" },
  importedSite: { siteId: "site-123", siteName: "Acme Blog" } // 선택적으로 가져온 사이트
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

테넌트 삭제

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
sure	string	아니오

응답

반환: FlagCommentPublic200Response

예제

deleteTenant 예제

Copy

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

테넌트 조회

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetTenant200Response

예제

getTenant 예제

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // 선택적 재정의(가능한 경우)
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

테넌트 목록 조회

매개변수

이름	형식	필수
tenantId	string	예
meta	string	아니요
skip	number	아니요

응답

반환: GetTenants200Response

예제

getTenants 예제

Copy

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

테넌트 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateTenantBody	UpdateTenantBody	예

응답

반환: FlagCommentPublic200Response

예제

updateTenant 예제

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // 선택 사항, 현재 청구 정보를 유지하려면 생략
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

티켓 상태 변경

매개변수

이름	유형	필수
tenantId	string	예
userId	string	예
id	string	예
changeTicketStateBody	ChangeTicketStateBody	예

응답

반환: ChangeTicketState200Response

예제

changeTicketState 예제

Copy

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

티켓 생성

매개변수

이름	타입	필수
tenantId	string	예
userId	string	예
createTicketBody	CreateTicketBody	예

응답

반환: CreateTicket200Response

예제

createTicket 예제

Copy

const tenantId: string = "acme-corp-001";
const userId: string = "user_72b9f4";
const createTicketBody: CreateTicketBody = {
  subject: "Subscription renewal failed for card on file",
  description: "Customer's card was declined by the payment processor during automatic renewal. Transaction ID: txn_9a8b7c. Please review gateway logs and retry.",
  priority: "high", // 선택적 필드 예시
  contactEmail: "billing@acme-corp.com", // 선택적 연락처 정보
  relatedUrl: "https://acme-corp.com/account/billing"
};
const ticketResponse: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

티켓 조회

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
userId	string	아니요

응답

반환: GetTicket200Response

예제

getTicket 예제

Copy

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

티켓 목록 조회

매개변수

이름	타입	필수
tenantId	string	Yes
userId	string	No
state	number	No
skip	number	No
limit	number	No

응답

반환: GetTickets200Response

예제

getTickets 예제

Copy

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

이미지 업로드

이미지 업로드 및 크기 조정

매개변수

이름	유형	필수
tenantId	string	예
file	Blob	예
sizePreset	SizePreset	아니요
urlId	string	아니요

응답

반환: UploadImageResponse

ID로 사용자 배지 진행률 조회

매개변수

이름	Type	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetUserBadgeProgressById200Response

예제

getUserBadgeProgressById 예제

Copy

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

사용자 ID로 배지 진행률 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
userId	string	예

응답

반환: GetUserBadgeProgressById200Response

예제

getUserBadgeProgressByUserId 예제

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // 선택적 소스(없을 수 있음)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

사용자 배지 진행률 목록 조회

매개변수

이름	형식	필수
tenantId	string	예
userId	string	아니오
limit	number	아니오
skip	number	아니오

응답

반환: GetUserBadgeProgressList200Response

예제

getUserBadgeProgressList 예제

Copy

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

사용자 배지 생성

Parameters

Name	Type	Required	Description
tenantId	string	예
createUserBadgeParams	CreateUserBadgeParams	예

Response

반환: CreateUserBadge200Response

Example

createUserBadge 예제

Copy

const tenantId: string = 'tenant_84f3b2';
const createUserBadgeParams: CreateUserBadgeParams = {
  name: 'Top Contributor',
  slug: 'top-contributor',
  imageUrl: 'https://assets.fastcomments.com/badges/top-contributor.png',
  description: 'Awarded for 100 helpful comments',
  active: true,
  criteria: { commentsCount: 100 }, // 선택적 기준
  displayOrder: 10,
  metadata: { featured: true } // 선택적 메타데이터
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);
console.log(result);

사용자 배지 삭제

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: UpdateUserBadge200Response

예제

deleteUserBadge 예제

Copy

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

사용자 배지 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetUserBadge200Response

예제

getUserBadge 예제

Copy

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

사용자 배지 목록 조회

매개변수

이름	유형	필수
tenantId	string	예
userId	string	아니오
badgeId	string	아니오
type	number	아니오
displayedOnComments	boolean	아니오
limit	number	아니오
skip	number	아니오

응답

반환: GetUserBadges200Response

예제

getUserBadges 예제

Copy

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

사용자 배지 업데이트

매개변수

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

응답

반환: UpdateUserBadge200Response

예제

updateUserBadge 예제

Copy

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

사용자 알림 수 조회

매개변수

이름	유형	필수	설명
tenantId	string	예
sso	string	아니요

응답

반환: GetUserNotificationCount200Response

예제

getUserNotificationCount 예제

Copy

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

사용자 알림 조회

매개변수

이름	타입	필수
tenantId	string	예
pageSize	number	아니요
afterId	string	아니요
includeContext	boolean	아니요
afterCreatedAt	number	아니요
unreadOnly	boolean	아니요
dmOnly	boolean	아니요
noDm	boolean	아니요
includeTranslations	boolean	아니요
sso	string	아니요

응답

반환: GetUserNotifications200Response

예제

getUserNotifications 예제

Copy

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

사용자 알림 수 초기화

매개변수

Name	Type	Required	Description
tenantId	string	예
sso	string	아니요

응답

반환: ResetUserNotifications200Response

예제

resetUserNotificationCount 예제

Copy

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

사용자 알림 초기화

매개변수

이름	타입	필수
tenantId	string	예
afterId	string	아니오
afterCreatedAt	number	아니오
unreadOnly	boolean	아니오
dmOnly	boolean	아니오
noDm	boolean	아니오
sso	string	아니오

응답

반환: ResetUserNotifications200Response

예제

resetUserNotifications 예제

Copy

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

사용자 댓글 구독 상태 업데이트

특정 댓글에 대한 알림을 활성화하거나 비활성화합니다.

매개변수

이름	유형	필수
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

응답

반환: UpdateUserNotificationStatus200Response

예제

updateUserNotificationCommentSubscriptionStatus 예제

Copy

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

사용자 페이지 구독 상태 업데이트

페이지에 대한 알림을 활성화하거나 비활성화합니다. 사용자가 페이지를 구독하면 새 루트 댓글에 대한 알림이 생성되며, 또한

매개변수

이름	유형	필수
tenantId	string	예
urlId	string	예
url	string	예
pageTitle	string	예
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	예
sso	string	아니요

응답

반환: UpdateUserNotificationStatus200Response

예제

updateUserNotificationPageSubscriptionStatus 예제

Copy

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

사용자 알림 상태 업데이트

매개변수

Name	Type	Required
tenantId	string	예
notificationId	string	예
newStatus	UpdateUserNotificationStatusNewStatusEnum	예
sso	string	아니요

응답

반환: UpdateUserNotificationStatus200Response

예제

updateUserNotificationStatus 예제

Copy

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

사용자 접속 상태 조회

매개변수

이름	유형	필수
tenantId	string	예
urlIdWS	string	예
userIds	string	예

응답

반환: GetUserPresenceStatuses200Response

예제

getUserPresenceStatuses 예제

Copy

const tenantId: string = 'tenant_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // 선택적 소스
const userIds: string = maybeUserIds ?? 'user_123';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

사용자 검색

매개변수

이름	유형	필수
tenantId	string	예
urlId	string	예
usernameStartsWith	string	아니오
mentionGroupIds	Array	아니오
sso	string	아니오
searchSection	SearchUsersSearchSectionEnum	아니오

응답

반환: SearchUsers200Response

예제

searchUsers 예제

Copy

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

사용자 조회

매개변수

이름	형식	필수	설명
tenantId	string	예
id	string	예

응답

반환: GetUser200Response

예제

getUser 예제

Copy

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

투표 생성

매개변수

이름	타입	필수
tenantId	string	예
commentId	string	예
direction	CreateVoteDirectionEnum	예
userId	string	아니요
anonUserId	string	아니요

응답

반환: VoteComment200Response

예제

createVote 예제

Copy

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

투표 삭제

매개변수

Name	Type	Required
tenantId	string	예
id	string	예
editKey	string	아니오

응답

반환: DeleteCommentVote200Response

예제

deleteVote 예제

Copy

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

투표 조회

매개변수

이름	타입	필수	설명
tenantId	string	예
urlId	string	예

응답

반환: GetVotes200Response

예제

getVotes 예제

Copy

const tenantId: string = 'acme-corp-8f3b';
const refCampaign: string | undefined = 'newsletter-march2026'; // 선택적 쿼리 매개변수
const urlId: string = `https://www.example.com/articles/2026/03/25/fastcomments-integration${refCampaign ? `?ref=${refCampaign}` : ''}`;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

사용자 투표 조회

매개변수

Name	Type	Required
tenantId	string	예
urlId	string	예
userId	string	아니요
anonUserId	string	아니요

응답

반환: GetVotesForUser200Response

예제

getVotesForUser 예제

Copy

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

도움을 원하십니까?

JavaScript/TypeScript SDK에 문제가 있거나 질문이 있는 경우, 다음을 이용해 주세요:

기여

기여는 언제나 환영합니다! 기여 지침은 GitHub 저장소를 방문하세요.

언어 🇰🇷 한국어

시작하기

API 참조

문서

사용법

집계

감사 로그

댓글에서 차단

차단된 댓글 확인

댓글

도메인 구성

이메일 템플릿

이벤트 로그

피드 게시물

댓글 신고

해시태그

모더레이터

알림 수

알림

페이지

대기 중인 웹훅 이벤트

질문 설정

질문 결과

질문 결과 집계

SSO 사용자

구독

테넌트 일일 사용량

테넌트 패키지

테넌트 사용자

테넌트

티켓

이미지 업로드

사용자 배지 진행률

사용자 배지

사용자 알림

사용자 접속 상태

사용자 검색

사용자

투표

FastComments JavaScript/TypeScript SDK

저장소

설치

API 문서

전체 API 참조: docs/api/README.md

브라우저와 서버 호환성

사용법

Browser Usage (Client-Side)

Server Usage (Node.js)

Types Only Import

Using Individual API Classes

Browser Environment

Server Environment

공개와 보안 API

예시: Public API 사용 (브라우저에서 안전하게 사용)

예시: Default API 사용 (서버 측 전용)

SSO(싱글 사인온) 통합

간단한 SSO (서버 전용)

보안 SSO (서버 측, 권장)

브라우저에서 SSO 사용 (서버 생성 토큰 포함)

댓글 생성과 함께하는 SSO

일반적인 사용 사례

페이지의 댓글 가져오기

댓글 생성

댓글에 투표하기

사용자 관리 (API 키 필요)

라이브 이벤트(실시간 업데이트)

페이지 수준 이벤트

사용자 이벤트 구독

userIdWS 가져오기

브로드캐스트 ID

오류 처리

집계

매개변수

응답

감사 로그 조회

매개변수

응답

예제

공개 댓글에서 차단

매개변수