FastComments 자바스크립트/타입스크립트 SDK

FastComments의 공식 JavaScript/TypeScript SDK입니다.

Node.js 또는 브라우저에서 댓글, 사용자, SSO 및 중재를 관리합니다.

저장소

설치

npm install fastcomments-sdk

API 문서

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

브라우저 및 서버 호환성

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

fastcomments-sdk/browser - 네이티브 fetch를 사용하는 브라우저 안전 버전
fastcomments-sdk/server - 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와 보안 API

The SDK provides these API classes:

DefaultApi - 인증을 위해 API 키가 필요한 보안 엔드포인트입니다. 서버 측 작업에 사용하세요.
PublicApi - API 키 없이 접근할 수 있는 공개 엔드포인트입니다. 브라우저/모바일 디바이스 등에서 직접 호출할 수 있습니다.
ModerationApi - 모더레이터 대시보드 엔드포인트(댓글 관리, 차단, 배지, 신뢰도, 검색). 모더레이터의 세션으로 인증됩니다; SSO로 인증된 모더레이터의 경우 sso 쿼리 파라미터를 전달하세요.
HiddenApi - 고급 사용 사례를 위한 내부/관리자용 엔드포인트입니다.

예제: Using 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'
});

예제: Using 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'
});

예제: Using Moderation API

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

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

// 모더레이터 인증 호출(세션 쿠키 또는 SSO 모더레이터의 경우 `sso` 전달).
const comments = await sdk.moderationApi.getApiComments({
  tenantId: 'your-tenant-id'
});

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

SSO(싱글 사인온) 통합

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

간단한 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);
  }
}

집계

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

Parameters

이름	유형	필수
tenantId	string	예
aggregationRequest	AggregationRequest	예
parentTenantId	string	아니오
includeStats	boolean	아니오

응답

반환: AggregateResponse

예시

집계 예시

Copy

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

감사 로그 조회

매개변수

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

응답

반환: GetAuditLogsResponse1

예제

getAuditLogs 예제

Copy

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

댓글 공개 차단

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

응답

반환: BlockFromCommentPublicResponse

예시

blockFromCommentPublic 예시

Copy

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

공개 댓글 차단 해제

매개변수

이름	형식	필수
tenantId	string	Yes
commentId	string	Yes
publicBlockFromCommentParams	PublicBlockFromCommentParams	Yes
sso	string	No

응답

반환: UnBlockCommentPublicResponse

예제

unBlockCommentPublic 예제

Copy

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

차단된 댓글 확인

매개변수

이름	형식	필수
tenantId	string	Yes
commentIds	string	Yes
sso	string	No

응답

반환: CheckedCommentsForBlockedResponse

예시

checkedCommentsForBlocked 예시

Copy

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

댓글에서 사용자 차단

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
blockFromCommentParams	BlockFromCommentParams	예
userId	string	아니오
anonUserId	string	아니오

응답

반환: BlockUserFromCommentResponse

예시

blockUserFromComment 예시

Copy

const tenantId: string = 'tenant_42';
const commentId: string = 'cmt_20231101';
const blockParams: BlockFromCommentParams = {
  reason: 'spam',
  blockDurationHours: 24,
};
const userId: string = 'user_123'; // 선택적 매개변수
const response: BlockUserFromCommentResponse = await blockUserFromComment(
  tenantId,
  commentId,
  blockParams,
  userId
);

공개 댓글 생성

매개변수

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

응답

반환: CreateCommentPublicResponse

예시

createCommentPublic 예시

Copy

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

댓글 삭제

매개변수

이름	타입	필수
tenantId	string	예
id	string	예
contextUserId	string	아니오
isLive	boolean	아니오

응답

반환: DeleteCommentResponse

예시

deleteComment 예시

Copy

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

공개 댓글 삭제

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

응답

반환: DeleteCommentPublicResponse

예시

deleteCommentPublic 예시

Copy

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

댓글 투표 삭제

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
voteId	string	Yes
urlId	string	Yes
broadcastId	string	Yes
editKey	string	No
sso	string	No

응답

반환: DeleteCommentVoteResponse

예시

deleteCommentVote 예시

Copy

async function removeVote() {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const voteId: string = "vote_abcde";
  const urlId: string = "url_56789";
  const broadcastId: string = "brd_001";
  const editKey: string = "edit_456";
  // sso는 선택 사항이며 생략되었습니다
  const response: DeleteCommentVoteResponse = await deleteCommentVote(
    tenantId,
    commentId,
    voteId,
    urlId,
    broadcastId,
    editKey
  );
  console.log(response);
}
removeVote();

댓글 신고

Parameters

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

Response

반환: FlagCommentResponse1

Example

flagComment 예시

Copy

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

댓글 조회

매개변수

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

응답

반환: GetCommentResponse

예시

getComment 예시

Copy

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

댓글 목록 조회

매개변수

이름	유형	필수
tenantId	string	예
page	number	아니오
limit	number	아니오
skip	number	아니오
asTree	boolean	아니오
skipChildren	number	아니오
limitChildren	number	아니오
maxTreeDepth	number	아니오
urlId	string	아니오
userId	string	아니오
anonUserId	string	아니오
contextUserId	string	아니오
hashTag	string	아니오
parentId	string	아니오
direction	SortDirections	아니오
fromDate	number	아니오
toDate	number	아니오

응답

반환: GetCommentsResponse

예시

getComments 예시

Copy

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

공개 댓글 조회

요청
tenantId
urlId

매개변수

이름	유형	필수
tenantId	string	Yes
urlId	string	Yes
page	number	No
direction	SortDirections	No
sso	string	No
skip	number	No
skipChildren	number	No
limit	number	No
limitChildren	number	No
countChildren	boolean	No
fetchPageForCommentId	string	No
includeConfig	boolean	No
countAll	boolean	No
includei10n	boolean	No
locale	string	No
modules	string	No
isCrawler	boolean	No
includeNotificationCount	boolean	No
asTree	boolean	No
maxTreeDepth	number	No
useFullTranslationIds	boolean	No
parentId	string	No
searchText	string	No
hashTags	Array	No
userId	string	No
customConfigStr	string	No
afterCommentId	string	No
beforeCommentId	string	No

응답

반환: GetCommentsPublicResponse

예시

getCommentsPublic 예시

Copy

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

댓글 텍스트 조회

매개변수

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

응답

반환: GetCommentTextResponse1

예시

getCommentText 예시

Copy

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

댓글 투표 사용자명 조회

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
dir	number	Yes
sso	string	No

응답

반환: GetCommentVoteUserNamesResponse

예시

getCommentVoteUserNames 예시

Copy

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

댓글 잠금

매개변수

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

응답

반환: LockCommentResponse

예제

lockComment 예제

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const commentId: string = "cmt_98765";
  const broadcastId: string = "brd_54321";
  // 옵션 SSO 토큰 포함
  const ssoToken: string = "user-abc123";
  const lockedWithSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId, ssoToken);
  // 옵션 SSO 토큰 없이
  const lockedWithoutSso: LockCommentResponse = await lockComment(tenantId, commentId, broadcastId);
})();

댓글 고정

매개변수

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

응답

반환: PinCommentResponse

예시

pinComment 예시

Copy

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

댓글 저장

매개변수

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

응답

반환: SaveCommentResponse

예시

saveComment 예제

Copy

async function submitComment() {
  const tenantId: string = "tenant_9f8e7d6c";
  const commentParams: CreateCommentParams = {
    text: "Great post, thanks for sharing!",
    authorId: "user_123abc",
    mentions: [] as CommentUserMentionInfo[],
    hashtags: [] as CommentUserHashTagInfo[]
  };
  const response: SaveCommentResponse = await saveComment(
    tenantId,
    commentParams,
    true,   // 실시간 여부
    false   // 스팸 검사 수행
  );
  console.log(response);
}
submitComment();

댓글 일괄 저장

매개변수

이름	유형	필수
tenantId	string	Yes
createCommentParams	Array	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

응답

반환: Array<SaveCommentsBulkResponse

예제

saveCommentsBulk 예제

Copy

const tenantId: string = "tenant_9f8b7c6d";
const bulkComments: CreateCommentParams[] = [
  {
    content: "Welcome to the new forum thread!",
    authorId: "user_42",
    mentions: [{ userId: "user_84", username: "alice" }],
    hashtags: [{ tag: "intro" }]
  },
  {
    content: "Please review the updated guidelines.",
    authorId: "moderator_1",
    mentions: [],
    hashtags: [{ tag: "guidelines" }, { tag: "update" }]
  }
];
const results: SaveCommentsBulkResponse[] = await saveCommentsBulk(
  tenantId,
  bulkComments,
  true,      // 실시간 여부
  false,     // 스팸 검사
  true,      // 이메일 전송
  undefined  // populateNotifications (기본값 사용)
);

댓글 텍스트 설정

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
commentTextUpdateRequest	CommentTextUpdateRequest	Yes
editKey	string	No
sso	string	No

응답

반환: SetCommentTextResponse1

예시

setCommentText 예제

Copy

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

댓글에서 사용자 차단 해제

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	Yes
unBlockFromCommentParams	UnBlockFromCommentParams	Yes
userId	string	No
anonUserId	string	No

응답

반환: UnBlockUserFromCommentResponse

예시

unBlockUserFromComment 예시

Copy

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

댓글 신고 취소

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	Yes
userId	string	No
anonUserId	string	No

응답

반환: UnFlagCommentResponse

예제

unFlagComment 예제

Copy

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

댓글 잠금 해제

매개변수

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

응답

반환: UnLockCommentResponse

예제

unLockComment 예제

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_9876";
const broadcastId: string = "brd_001";
const ssoToken: string | undefined = "sso_token_abc";
async function run() {
  const unlocked: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId, ssoToken);
  console.log(unlocked);
  // 선택적 sso 매개변수 없이 호출
  const unlockedWithoutSso: UnLockCommentResponse = await unLockComment(tenantId, commentId, broadcastId);
  console.log(unlockedWithoutSso);
}
run();

댓글 고정 해제

매개변수

이름	형식	필수
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

응답

반환: UnPinCommentResponse

예시

unPinComment 예시

Copy

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

댓글 업데이트

Parameters

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updatableCommentParams	UpdatableCommentParams	Yes
contextUserId	string	No
doSpamCheck	boolean	No
isLive	boolean	No

Response

반환: UpdateCommentResponse

Example

updateComment 예시

Copy

const tenantId: string = "tenant_12345";
const commentId: string = "cmt_98765";
const updatableCommentParams: UpdatableCommentParams = {
  // 예시 필드; 실제 형태는 API 정의에 따라 다릅니다
  // 예: body: "Edited comment content",
};
const contextUserId: string = "user_abcde";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
const result: UpdateCommentResponse = await updateComment(
  tenantId,
  commentId,
  updatableCommentParams,
  contextUserId,
  doSpamCheck,
  isLive
);

댓글 투표

Parameters

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

Response

Returns: VoteCommentResponse

Example

voteComment 예시

Copy

const tenantId: string = "acme-corp";
const commentId: string = "cmt_9f8e7d6c";
const urlId: string = "url_123456";
const broadcastId: string = "bcast_2024_01";
const voteBodyParams: VoteBodyParams = {
  vote: "up",               // 예: "up" | "down"
  weight: 1,                // 투표의 가중치 (옵션)
};
const sessionId: string = "sess_abc123def";
const sso: string = "sso_token_xyz";
const result: VoteCommentResponse = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

사용자별 댓글 조회

매개변수

이름	유형	필수
userId	string	No
direction	SortDirections	No
repliesToUserId	string	No
page	number	No
includei10n	boolean	No
locale	string	No
isCrawler	boolean	No

응답

반환: GetCommentsForUserResponse1

예시

getCommentsForUser 예시

Copy

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

도메인 설정 추가

매개변수

이름	타입	필수	설명
tenantId	string	Yes
addDomainConfigParams	AddDomainConfigParams	Yes

응답

Returns: AddDomainConfigResponse

예시

addDomainConfig 예시

Copy

(async () => {
  const tenantId: string = 'tenant_12345';
  const config: AddDomainConfigParams = {
    domain: 'myblog.example.com',
    enabled: true,
    // 설명은 선택 사항이며 여기서는 생략되었습니다
  };
  const response: AddDomainConfigResponse = await addDomainConfig(tenantId, config);
  console.log(response);
})();

도메인 설정 삭제

매개변수

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

응답

반환: DeleteDomainConfigResponse

예제

deleteDomainConfig 예제

Copy

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

도메인 설정 조회

매개변수

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

응답

반환: GetDomainConfigResponse

예시

getDomainConfig 예시

Copy

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

도메인 설정들 조회

매개변수

이름	타입	필수	설명
tenantId	string	Yes

응답

반환값: GetDomainConfigsResponse

예시

getDomainConfigs 예시

Copy

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

도메인 설정 부분 수정

매개변수

이름	유형	필수
tenantId	string	Yes
domainToUpdate	string	Yes
patchDomainConfigParams	PatchDomainConfigParams	Yes

응답

Returns: PatchDomainConfigResponse

예제

patchDomainConfig 예제

Copy

async function updateDomainConfig() {
  const tenantId: string = "tenant_98765";
  const domainToUpdate: string = "forum.mycompany.com";
  const patchParams: PatchDomainConfigParams = {
    enableComments: true,
    moderationLevel: "strict",
    allowAnonymous: false, // 선택적 매개변수 시연
  };
  const response: PatchDomainConfigResponse = await patchDomainConfig(tenantId, domainToUpdate, patchParams);
  console.log(response);
}
updateDomainConfig();

도메인 설정 전체 대체

매개변수

Name	Type	Required
tenantId	string	Yes
domainToUpdate	string	Yes
updateDomainConfigParams	UpdateDomainConfigParams	Yes

응답

반환: PutDomainConfigResponse

예시

putDomainConfig 예시

Copy

async function runExample() {
  const tenantId: string = 'tenant-9f8c7b1a';
  const domainToUpdate: string = 'comments.mywebsite.org';
  const updateDomainConfigParams: UpdateDomainConfigParams = {
    enableModeration: true,
    // 선택적 필드가 생략됨, 예: maxCommentLength?: number
  };
  const result: PutDomainConfigResponse = await putDomainConfig(
    tenantId,
    domainToUpdate,
    updateDomainConfigParams,
  );
  console.log(result);
}
runExample();

이메일 템플릿 생성

매개변수

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

응답

반환: CreateEmailTemplateResponse1

예시

createEmailTemplate 예제

Copy

const tenantId: string = "tenant_9f8e7d6c";
const emailTemplate: CreateEmailTemplateBody = {
  name: "Account Activation",
  subject: "Activate Your New Account",
  htmlContent: "<p>Welcome! Please click <a href=\"\{{activationLink}}\">here</a> to activate.</p>",
  // textContent, isActive와 같은 선택적 필드는 선택적 매개변수를 보여주기 위해 생략되었습니다
};
const result: CreateEmailTemplateResponse1 = await createEmailTemplate(
  tenantId,
  emailTemplate
);
console.log(result);

이메일 템플릿 삭제

매개변수

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

응답

반환: DeleteEmailTemplateResponse

예시

deleteEmailTemplate 예시

Copy

async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "template_abcde";
  const response: DeleteEmailTemplateResponse = await deleteEmailTemplate(tenantId, templateId);
  // 응답에서 선택적 속성에 접근하는 예시
  const statusCode: number | undefined = response.status?.code;
}();

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

매개변수

이름	형식	필수
tenantId	string	Yes
id	string	Yes
errorId	string	Yes

응답

반환: DeleteEmailTemplateRenderErrorResponse

예시

deleteEmailTemplateRenderError 예시

Copy

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

이메일 템플릿 조회

매개변수

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

응답

반환: GetEmailTemplateResponse1

예시

getEmailTemplate 예시

Copy

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

이메일 템플릿 정의 조회

매개변수

이름	유형	필수	설명
tenantId	string	Yes

응답

반환: GetEmailTemplateDefinitionsResponse1

예시

getEmailTemplateDefinitions 예시

Copy

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

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

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	Yes
skip	number	No

응답

반환: GetEmailTemplateRenderErrorsResponse1

예시

getEmailTemplateRenderErrors 예시

Copy

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

이메일 템플릿들 조회

매개변수

이름	타입	필수	설명
tenantId	string	예
skip	number	아니오

응답

반환: GetEmailTemplatesResponse1

예시

getEmailTemplates 예시

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  // 선택적 'skip' 없이 호출
  const templates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId);
  // 선택적 'skip' 매개변수와 함께 호출
  const pagedTemplates: GetEmailTemplatesResponse1 = await getEmailTemplates(tenantId, 20);
})();

이메일 템플릿 렌더링

매개변수

이름	유형	필수
tenantId	string	예
renderEmailTemplateBody	RenderEmailTemplateBody	예
locale	string	아니오

응답

반환: RenderEmailTemplateResponse1

예시

renderEmailTemplate 예제

Copy

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

이메일 템플릿 업데이트

Parameters

이름	타입	필수
tenantId	string	예
id	string	예
updateEmailTemplateBody	UpdateEmailTemplateBody	예

Response

반환: UpdateEmailTemplateResponse

예제

updateEmailTemplate 예제

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const templateId: string = "email_tpl_67890";
  const updateBody: UpdateEmailTemplateBody = {
    subject: "Comment reply notification",
    htmlContent: "<p>Someone replied to your comment.</p>",
    plainTextContent: "Someone replied to your comment.",
    // 선택적 필드 예시
    isActive: true,
  };
  const result: UpdateEmailTemplateResponse = await updateEmailTemplate(
    tenantId,
    templateId,
    updateBody
  );
  console.log(result);
})();

이벤트 로그 조회

req tenantId urlId userIdWS

매개변수

이름	유형	필수
tenantId	string	예
urlId	string	예
userIdWS	string	예
startTime	number	예
endTime	number	아니오

응답

반환: GetEventLogResponse1

예시

getEventLog 예시

Copy

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

글로벌 이벤트 로그 조회

req tenantId urlId userIdWS

매개변수

이름	유형	필수
tenantId	string	Yes
urlId	string	Yes
userIdWS	string	Yes
startTime	number	Yes
endTime	number	No

응답

반환: GetGlobalEventLogResponse

예시

getGlobalEventLog 예시

Copy

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

피드 게시물 생성

매개변수

이름	유형	필수
tenantId	string	Yes
createFeedPostParams	CreateFeedPostParams	Yes
broadcastId	string	No
isLive	boolean	No
doSpamCheck	boolean	No
skipDupCheck	boolean	No

응답

반환: CreateFeedPostResponse1

예제

createFeedPost 예제

Copy

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

공개 피드 게시물 생성

매개변수

이름	형식	필수
tenantId	string	예
createFeedPostParams	CreateFeedPostParams	예
broadcastId	string	아니오
sso	string	아니오

응답

반환: CreateFeedPostPublicResponse

예시

createFeedPostPublic 예제

Copy

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

공개 피드 게시물 삭제

매개변수

이름	형식	필수
tenantId	string	Yes
postId	string	Yes
broadcastId	string	No
sso	string	No

응답

반환: DeleteFeedPostPublicResponse

예시

deleteFeedPostPublic 예시

Copy

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

피드 게시물 조회

req tenantId afterId

매개변수

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

응답

반환: GetFeedPostsResponse1

예제

getFeedPosts 예제

Copy

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

공개 피드 게시물 조회

req tenantId afterId

매개변수

이름	형식	필수
tenantId	string	Yes
afterId	string	No
limit	number	No
tags	Array	No
sso	string	No
isCrawler	boolean	No
includeUserInfo	boolean	No

응답

반환: GetFeedPostsPublicResponse

예시

getFeedPostsPublic 예시

Copy

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

피드 게시물 통계 조회

매개변수

이름	유형	필수
tenantId	string	예
postIds	Array	예
sso	string	아니오

응답

반환: GetFeedPostsStatsResponse

예제

getFeedPostsStats 예제

Copy

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

사용자 반응(공개) 조회

Parameters

이름	유형	필수
tenantId	string	Yes
postIds	Array	No
sso	string	No

Response

반환: GetUserReactsPublicResponse

Example

getUserReactsPublic 예제

Copy

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

공개 피드 게시물에 반응

매개변수

이름	유형	필수
tenantId	string	Yes
postId	string	Yes
reactBodyParams	ReactBodyParams	Yes
isUndo	boolean	No
broadcastId	string	No
sso	string	No

응답

반환: ReactFeedPostPublicResponse

예시

reactFeedPostPublic 예제

Copy

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

피드 게시물 업데이트

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	Yes
feedPost	FeedPost	Yes

응답

반환: UpdateFeedPostResponse

예시

updateFeedPost 예시

Copy

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

공개 피드 게시물 업데이트

매개변수

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

응답

반환: UpdateFeedPostPublicResponse

예시

updateFeedPostPublic 예시

Copy

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

공개 댓글 신고

매개변수

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

응답

반환: FlagCommentPublicResponse

예제

flagCommentPublic 예제

Copy

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

큰 GIF 조회

Parameters

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

Response

반환: GetGifLargeResponse

예시

getGifLarge 예시

Copy

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

GIF 검색

매개변수

이름	유형	필수
tenantId	string	예
search	string	예
locale	string	아니오
rating	string	아니오
page	number	아니오

응답

반환: GetGifsSearchResponse

예시

getGifsSearch 예제

Copy

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

Parameters

이름	유형	필수
tenantId	string	Yes
locale	string	No
rating	string	No
page	number	No

Response

반환: GetGifsTrendingResponse

Example

getGifsTrending 예시

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "tenant_9f8b7c6d";
  const locale: string = "en-US";
  const rating: string = "PG-13";
  const page: number = 1;
  const trendingAll: GetGifsTrendingResponse = await getGifsTrending(tenantId, locale, rating, page);
  console.log(trendingAll);
  // 필수 파라미터만 사용
  const trendingMinimal: GetGifsTrendingResponse = await getGifsTrending(tenantId);
  console.log(trendingMinimal);
}
runExample();

해시태그 추가

매개변수

이름	유형	필수	설명
tenantId	string	No
createHashTagBody	CreateHashTagBody	No

응답

반환: AddHashTagResponse

예시

addHashTag 예시

Copy

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

해시태그 일괄 추가

매개변수

이름	형식	필수	설명
tenantId	string	No
bulkCreateHashTagsBody	BulkCreateHashTagsBody	No

응답

반환: AddHashTagsBulkResponse

예시

addHashTagsBulk 예시

Copy

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

해시태그 삭제

매개변수

이름	형식	필수
tag	string	Yes
tenantId	string	No
deleteHashTagRequestBody	DeleteHashTagRequestBody	No

응답

반환: DeleteHashTagResponse

예시

deleteHashTag 예시

Copy

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

해시태그 조회

매개변수

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

응답

반환: GetHashTagsResponse1

예제

getHashTags 예제

Copy

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

해시태그 부분 수정

매개변수

이름	형식	필수
tag	string	Yes
tenantId	string	No
updateHashTagBody	UpdateHashTagBody	No

응답

반환: PatchHashTagResponse

예시

patchHashTag 예시

Copy

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

중재 투표 삭제

Parameters

이름	유형	필수
commentId	string	예
voteId	string	예
broadcastId	string	아니오
tenantId	string	아니오
sso	string	아니오

Response

반환: DeleteModerationVoteResponse

예시

deleteModerationVote 예시

Copy

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

API 댓글 조회

매개변수

이름	유형	필수
page	number	No
count	number	No
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

응답

Returns: GetApiCommentsResponse

예시

getApiComments 예시

Copy

async function loadComments() {
  const fullResult: GetApiCommentsResponse = await getApiComments(
    2,                     // 페이지
    25,                    // 카운트
    "feedback",           // 텍스트 검색
    "192.168.1.100",      // 댓글 IP
    "approved",           // 필터
    "hasReplies",         // 검색 필터
    "dateDesc",           // 정렬
    false,                // 데모
    "tenant-abc123",      // 테넌트 ID
    "sso-token-xyz"       // SSO
  );
  const minimalResult: GetApiCommentsResponse = await getApiComments(undefined, 5);
}

API 내보내기 상태 조회

매개변수

이름	형식	필수
batchJobId	string	No
tenantId	string	No
sso	string	No

응답

반환: GetApiExportStatusResponse

예제

getApiExportStatus 예제

Copy

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

API ID 조회

Parameters

Name	Type	Required
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
afterId	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

Response

반환: GetApiIdsResponse

Example

getApiIds 예제

Copy

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

댓글로부터 차단된 사용자 조회

매개변수

이름	타입	필수
commentId	string	Yes
tenantId	string	No
sso	string	No

응답

반환값: GetBanUsersFromCommentResponse

예시

getBanUsersFromComment 예시

Copy

async function demoGetBanUsers() {
  const commentId: string = "cmt_5f8e3a9b2d";
  const tenantId: string = "tenant_42";
  const sso: string = "sso_token_abc123";
  // 모든 매개변수로 호출
  const fullResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId, tenantId, sso);
  console.log(fullResult);
  // 필수 매개변수만 사용하여 호출
  const minimalResult: GetBanUsersFromCommentResponse = await getBanUsersFromComment(commentId);
  console.log(minimalResult);
}
demoGetBanUsers();

댓글 차단 상태 조회

매개변수

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

응답

반환: GetCommentBanStatusResponse1

예시

getCommentBanStatus 예제

Copy

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

댓글 자식(답글) 조회

매개변수

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

응답

반환: GetCommentChildrenResponse

예시

getCommentChildren 예시

Copy

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

카운트 조회

매개변수

Name	Type	Required
textSearch	string	No
byIPFromComment	string	No
filter	string	No
searchFilters	string	No
demo	boolean	No
tenantId	string	No
sso	string	No

응답

Returns: GetCountResponse

예시

getCount 예제

Copy

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

여러 카운트 조회

매개변수

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

응답

반환: GetCountsResponse

예시

getCounts 예시

Copy

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

로그 조회

매개변수

이름	타입	필수
commentId	string	Yes
tenantId	string	No
sso	string	No

응답

반환: GetLogsResponse

예제

getLogs 예제

Copy

async function fetchLogs() {
    const commentId: string = "cmt_9a8b7c6d5e4f3a2b";
    const tenantId: string = "tenant_9876";
    const sso: string = "sso_abcdef123456";
    const fullResponse: GetLogsResponse = await getLogs(commentId, tenantId, sso);
    const minimalResponse: GetLogsResponse = await getLogs(commentId);
}

수동 배지 조회

매개변수

Name	Type	Required	Description
tenantId	string	No
sso	string	No

응답

반환: GetManualBadgesResponse

예제

getManualBadges 예제

Copy

async function fetchBadges() {
  const tenantId: string = "tenant_987654321";
  const ssoToken: string = "sso_ABCdef123456";
  // 선택적 매개변수를 모두 사용하여 호출
  const responseFull: GetManualBadgesResponse = await getManualBadges(tenantId, ssoToken);
  console.log(responseFull);
  // tenantId만 사용하여 호출
  const responseTenantOnly: GetManualBadgesResponse = await getManualBadges(tenantId);
  console.log(responseTenantOnly);
}
fetchBadges();

사용자용 수동 배지 조회

매개변수

이름	유형	필수
badgesUserId	string	No
commentId	string	No
tenantId	string	No
sso	string	No

응답

반환: GetManualBadgesForUserResponse

예시

getManualBadgesForUser 예시

Copy

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

중재용 댓글 조회

매개변수

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

응답

반환: GetModerationCommentResponse

예시

getModerationComment 예제

Copy

async function fetchCommentDetails() {
  // 전체 매개변수 집합
  const commentId: string = "cmt_12345abc";
  const includeEmail: boolean = true;
  const includeIP: boolean = false;
  const tenantId: string = "tenant_9876";
  const sso: string = "sso_token_xyz";
  const fullResult: GetModerationCommentResponse = await getModerationComment(
    commentId,
    includeEmail,
    includeIP,
    tenantId,
    sso
  );
  // 필수 인수만 사용한 최소 호출
  const minimalResult: GetModerationCommentResponse = await getModerationComment("cmt_67890def");
  // 결과를 필요에 따라 사용...
}

중재용 댓글 텍스트 조회

Parameters

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

Response

반환: GetModerationCommentTextResponse

Example

getModerationCommentText 예시

Copy

async function exampleUsage(): Promise<void> {
  const commentId: string = "cmt_9f8e7d6c5b4a3b2c1d0e";
  const tenantId: string = "tenant_67890";
  const sso: string = "sso_token_abc123";
  // 필수 매개변수만 사용하여 호출
  const result1: GetModerationCommentTextResponse = await getModerationCommentText(commentId);
  // 선택적 매개변수와 함께 호출
  const result2: GetModerationCommentTextResponse = await getModerationCommentText(commentId, tenantId, sso);
}

사전 차단 요약 조회

매개변수

이름	유형	필수
commentId	string	Yes
includeByUserIdAndEmail	boolean	No
includeByIP	boolean	No
includeByEmailDomain	boolean	No
tenantId	string	No
sso	string	No

응답

Returns: GetPreBanSummaryResponse

예시

getPreBanSummary 예시

Copy

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

검색 댓글 요약 조회

매개변수

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

응답

반환: GetSearchCommentsSummaryResponse

예시

getSearchCommentsSummary 예시

Copy

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

검색 페이지 조회

매개변수

이름	형식	필수
value	string	아니오
tenantId	string	아니오
sso	string	아니오

응답

반환: GetSearchPagesResponse

예시

getSearchPages 예시

Copy

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

검색 사이트 조회

매개변수

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

응답

반환: GetSearchSitesResponse

예시

getSearchSites 예시

Copy

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

검색 추천 조회

매개변수

Name	Type	Required
textSearch	string	No
tenantId	string	No
sso	string	No

응답

반환: GetSearchSuggestResponse

예시

getSearchSuggest 예시

Copy

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

검색 사용자 조회

매개변수

이름	형식	필수
value	string	아니오
tenantId	string	아니오
sso	string	아니오

응답

반환: GetSearchUsersResponse

예시

getSearchUsers 예제

Copy

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

신뢰 지수 조회

매개변수

이름	유형	필수
userId	string	No
tenantId	string	No
sso	string	No

응답

반환: GetTrustFactorResponse

예제

getTrustFactor 예제

Copy

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

사용자 차단 설정 조회

매개변수

이름	타입	필수	설명
tenantId	string	No
sso	string	No

응답

반환: GetUserBanPreferenceResponse

예시

getUserBanPreference 예제

Copy

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

사용자 내부 프로필 조회

Parameters

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

Response

반환: GetUserInternalProfileResponse1

Example

getUserInternalProfile 예시

Copy

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

댓글 투표 조정

매개변수

이름	유형	필수
commentId	string	Yes
adjustCommentVotesParams	AdjustCommentVotesParams	Yes
broadcastId	string	No
tenantId	string	No
sso	string	No

응답

반환: PostAdjustCommentVotesResponse

예제

postAdjustCommentVotes 예제

Copy

const commentId: string = "cmt_9f8b7a6d";
const adjustParams: AdjustCommentVotesParams = {
  voteDelta: 1,
  // AdjustCommentVotesParams에 필요한 추가 필드
};
const broadcastId: string = "brd_20230915";
const tenantId: string = "tenant_42";
const sso: string = "sso-token-abc123";
const result: PostAdjustCommentVotesResponse = await postAdjustCommentVotes(
  commentId,
  adjustParams,
  broadcastId,
  tenantId,
  sso
);

API 내보내기 요청

매개변수

이름	타입	필수
textSearch	string	No
byIPFromComment	string	No
filters	string	No
searchFilters	string	No
sorts	string	No
tenantId	string	No
sso	string	No

응답

Returns: PostApiExportResponse

예시

postApiExport 예시

Copy

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

댓글에서 사용자 차단

매개변수

이름	유형	필수
commentId	string	예
banEmail	boolean	아니오
banEmailDomain	boolean	아니오
banIP	boolean	아니오
deleteAllUsersComments	boolean	아니오
bannedUntil	string	아니오
isShadowBan	boolean	아니오
updateId	string	아니오
banReason	string	아니오
tenantId	string	아니오
sso	string	아니오

응답

반환: PostBanUserFromCommentResponse

예시

postBanUserFromComment 예시

Copy

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

사용자 차단 취소

매개변수

이름	유형	필수
banUserUndoParams	BanUserUndoParams	예
tenantId	string	아니오
sso	string	아니오

응답

반환: PostBanUserUndoResponse

예시

postBanUserUndo 예시

Copy

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

일괄 사전 차단 요약 요청

매개변수

이름	유형	필수
bulkPreBanParams	BulkPreBanParams	예
includeByUserIdAndEmail	boolean	아니오
includeByIP	boolean	아니오
includeByEmailDomain	boolean	아니오
tenantId	string	아니오
sso	string	아니오

응답

반환: PostBulkPreBanSummaryResponse

예제

postBulkPreBanSummary 예제

Copy

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

ID로 댓글 조회

매개변수

이름	타입	필수
commentsByIdsParams	CommentsByIdsParams	Yes
tenantId	string	No
sso	string	No

응답

반환: PostCommentsByIdsResponse

예시

postCommentsByIds 예시

Copy

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

댓글 신고

매개변수

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

응답

반환: PostFlagCommentResponse

예시

postFlagComment 예시

Copy

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

댓글 제거

매개변수

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

응답

반환: PostRemoveCommentResponse

예제

postRemoveComment 예제

Copy

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

삭제된 댓글 복원

매개변수

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

응답

반환: PostRestoreDeletedCommentResponse

예시

postRestoreDeletedComment 예시

Copy

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

댓글 승인 상태 설정

매개변수

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

응답

Returns: PostSetCommentApprovalStatusResponse

예제

postSetCommentApprovalStatus 예제

Copy

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

댓글 검토 상태 설정

매개변수

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

응답

반환: PostSetCommentReviewStatusResponse

예시

postSetCommentReviewStatus 예시

Copy

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

댓글 스팸 상태 설정

매개변수

Name	Type	Required
commentId	string	Yes
spam	boolean	No
permNotSpam	boolean	No
broadcastId	string	No
tenantId	string	No
sso	string	No

응답

Returns: PostSetCommentSpamStatusResponse

예제

postSetCommentSpamStatus 예제

Copy

async function demoSpamStatus(): Promise<void> {
  const commentId: string = "cmt_5f2a1b3c4d6e7f8g9h0i";
  // 필수 매개변수만
  const resultSimple: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(commentId, true);
  // 모든 선택적 매개변수가 제공됨
  const resultFull: PostSetCommentSpamStatusResponse = await postSetCommentSpamStatus(
    commentId,
    false,
    true,
    "brd_1234abcd",
    "tenant_42",
    "sso_9876xyz"
  );
  console.log(resultSimple, resultFull);
}

댓글 텍스트 설정

매개변수

이름	유형	필수
commentId	string	예
setCommentTextParams	SetCommentTextParams	예
broadcastId	string	아니오
tenantId	string	아니오
sso	string	아니오

응답

반환: PostSetCommentTextResponse

예시

postSetCommentText 예시

Copy

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

댓글 신고 취소

매개변수

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

응답

반환: PostUnFlagCommentResponse

예시

postUnFlagComment 예시

Copy

async () => {
  const response: PostUnFlagCommentResponse = await postUnFlagComment(
    "cmt_12345",          // 댓글 ID
    "brd_67890",          // broadcastId (선택사항)
    "tenant_abc",         // tenantId (선택사항)
    "sso_user_token_789"  // sso (선택사항)
  );
};

투표

매개변수

이름	타입	필수
commentId	string	Yes
direction	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

응답

반환: PostVoteResponse

예시

postVote 예시

Copy

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

배지 수여

매개변수

이름	유형	필수
badgeId	string	Yes
userId	string	No
commentId	string	No
broadcastId	string	No
tenantId	string	No
sso	string	No

응답

반환: PutAwardBadgeResponse

예시

putAwardBadge 예시

Copy

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

스레드 닫기

Parameters

이름	유형	필수
urlId	string	예
tenantId	string	아니오
sso	string	아니오

Response

반환: PutCloseThreadResponse

Example

putCloseThread 예시

Copy

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

배지 제거

Parameters

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

Response

Returns: PutRemoveBadgeResponse

Example

putRemoveBadge 예제

Copy

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

스레드 재개

매개변수

이름	유형	필수
urlId	string	Yes
tenantId	string	No
sso	string	No

응답

반환: PutReopenThreadResponse

예제

putReopenThread 예제

Copy

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

신뢰 지수 설정

매개변수

이름	유형	필수
userId	string	아니오
trustFactor	string	아니오
tenantId	string	아니오
sso	string	아니오

응답

반환값: SetTrustFactorResponse

예제

setTrustFactor 예제

Copy

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

중재자 생성

매개변수

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

응답

반환: CreateModeratorResponse1

예시

createModerator 예제

Copy

async function runExample() {
  const tenantId: string = "tenant_9876";
  const moderatorPayload: CreateModeratorBody = {
    name: "Alice Johnson",
    email: "alice.johnson@example.com"
    // optional fields like description are omitted
  };
  const result: CreateModeratorResponse1 = await createModerator(tenantId, moderatorPayload);
  console.log(result);
}
runExample();

중재자 삭제

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	Yes
sendEmail	string	No

응답

반환: DeleteModeratorResponse

예제

deleteModerator 예제

Copy

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

중재자 조회

매개변수

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

응답

반환: GetModeratorResponse1

예시

getModerator 예시

Copy

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

중재자들 조회

매개변수

이름	유형	필수	설명
tenantId	string	Yes
skip	number	No

응답

반환: GetModeratorsResponse1

예시

getModerators 예시

Copy

async function fetchModerators(): Promise<void> {
  const tenantId: string = "tenant-9876";
  const skip: number = 30; // 선택적 페이지네이션 오프셋
  const moderators: GetModeratorsResponse1 = await getModerators(tenantId, skip);
  // 페이지네이션 없이 예시:
  // const allModerators: GetModeratorsResponse1 = await getModerators(tenantId);
}

초대 전송

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	Yes
fromName	string	Yes

응답

반환: SendInviteResponse

예시

sendInvite 예시

Copy

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

중재자 업데이트

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
updateModeratorBody	UpdateModeratorBody	예

응답

반환: UpdateModeratorResponse

예시

updateModerator 예시

Copy

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

알림 수 삭제

매개변수

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

응답

반환: DeleteNotificationCountResponse

예제

deleteNotificationCount 예제

Copy

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

캐시된 알림 수 조회

매개변수

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

응답

반환: GetCachedNotificationCountResponse1

예시

getCachedNotificationCount 예제

Copy

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

알림 수 조회

매개변수

이름	타입	필수
tenantId	string	Yes
userId	string	No
urlId	string	No
fromCommentId	string	No
viewed	boolean	No
type	string	No

응답

반환: GetNotificationCountResponse1

예시

getNotificationCount 예시

Copy

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

알림 조회

매개변수

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

응답

반환: GetNotificationsResponse1

예시

getNotifications 예시

Copy

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

알림 업데이트

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	Yes
updateNotificationBody	UpdateNotificationBody	Yes
userId	string	No

응답

반환: UpdateNotificationResponse

예제

updateNotification 예제

Copy

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

V1 페이지 반응 생성

매개변수

이름	유형	필수
tenantId	string	예
urlId	string	예
title	string	아니오

응답

반환: CreateV1PageReactResponse

예시

createV1PageReact 예시

Copy

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

V2 페이지 반응 생성

매개변수

이름	형식	필수
tenantId	string	Yes
urlId	string	Yes
id	string	Yes
title	string	No

응답

반환: CreateV2PageReactResponse

예제

createV2PageReact 예제

Copy

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

V1 페이지 반응 삭제

매개변수

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

응답

반환: DeleteV1PageReactResponse

예시

deleteV1PageReact 예시

Copy

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

V2 페이지 반응 삭제

매개변수

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

응답

반환: DeleteV2PageReactResponse

예제

deleteV2PageReact 예제

Copy

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

V1 페이지 좋아요 조회

매개변수

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

응답

반환: GetV1PageLikesResponse

예시

getV1PageLikes 예시

Copy

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

V2 페이지 반응 조회

매개변수

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

응답

반환: GetV2PageReactsResponse

예시

getV2PageReacts 예시

Copy

async function demoGetPageReacts(): Promise<void> {
    const tenantId: string = "acme-corp-tenant";
    const urlId: string = "article-2024-06-01";
    const reacts: GetV2PageReactsResponse = await getV2PageReacts(tenantId, urlId);
    // 선택적 속성 접근 예시
    const customConfig: CustomConfigParameters | undefined = reacts.customConfig;
    console.log(reacts);
}
demoGetPageReacts();

V2 페이지 반응 사용자 조회

매개변수

이름	유형	필수
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

응답

Returns: GetV2PageReactUsersResponse1

예시

getV2PageReactUsers 예시

Copy

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

페이지 추가

매개변수

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

응답

반환: AddPageAPIResponse

예시

addPage 예시

Copy

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

페이지 삭제

매개변수

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

응답

반환: DeletePageAPIResponse

예시

deletePage 예시

Copy

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

오프라인 사용자 조회

Past commenters on the page who are NOT currently online. Sorted by displayName.
페이지에 과거에 댓글을 남겼지만 현재 온라인이 아닌 댓글 작성자들. displayName 순으로 정렬됩니다.

Use this after exhausting /users/online to render a "Members" section.
/users/online을 모두 사용한 후에 "Members" 섹션을 렌더링하기 위해 사용합니다.

Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
commenterName에 대한 커서 페이지네이션: 서버가 부분 {tenantId, urlId, commenterName} 인덱스를 afterName 이후로 $gt를 사용해 이동하며, $skip 비용이 없습니다.

Parameters

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

Response

Returns: GetOfflineUsersResponse

Example

getOfflineUsers 예시

Copy

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

온라인 사용자 조회

현재 페이지에 실시간으로 접속 중인 사용자: 현재 웹소켓 세션이 페이지에 구독돼 있는 사람들입니다.
익명 사용자 수(anonCount)와 총 사용자 수(totalCount)를 반환합니다(방 전체 구독자 수, 열거되지 않은 익명 뷰어 포함).

매개변수

이름	타입	필수
tenantId	string	예
urlId	string	예
afterName	string	아니오
afterUserId	string	아니오

응답

반환: GetOnlineUsersResponse

예시

getOnlineUsers 예시

Copy

async function demoOnlineUsers() {
  const tenantId: string = "tenant_12345";
  const urlId: string = "url_98765";
  // 선택적 페이지 매김 매개변수가 있는 경우
  const pagedResult: GetOnlineUsersResponse = await getOnlineUsers(
    tenantId,
    urlId,
    "alice_smith",
    "user_9"
  );
  // 선택적 페이지 매김 매개변수가 없는 경우
  const fullResult: GetOnlineUsersResponse = await getOnlineUsers(tenantId, urlId);
}

URL ID로 페이지 조회

매개변수

Name	Type	Required	Description
tenantId	string	예
urlId	string	예

응답

반환: GetPageByURLIdAPIResponse

예제

getPageByURLId 예제

Copy

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

페이지들 조회

매개변수

이름	유형	필수	설명
tenantId	string	Yes

응답

반환: GetPagesAPIResponse

예제

getPages 예제

Copy

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

공개 페이지 조회

테넌트의 페이지를 나열합니다. FChat 데스크톱 클라이언트가 방 목록을 채우는 데 사용됩니다.
각 페이지에 대해 해결된 커스텀 구성에서 enableFChat이 true이어야 합니다.
SSO가 필요한 페이지는 요청한 사용자의 그룹 액세스를 기준으로 필터링됩니다.

매개변수

이름	형식	필수
tenantId	string	예
cursor	string	아니오
limit	number	아니오
q	string	아니오
sortBy	PagesSortBy	아니오
hasComments	boolean	아니오

응답

반환: GetPagesPublicResponse

예시

getPagesPublic 예시

Copy

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

사용자 정보 조회

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).

Parameters

Name	Type	Required	Description
tenantId	string	예
ids	string	예

Response

Returns: GetUsersInfoResponse

Example

getUsersInfo 예시

Copy

const tenantId: string = "acme-corp-tenant";
const ids: string = "user-1001,user-1002";
const usersInfo: GetUsersInfoResponse = await getUsersInfo(tenantId, ids);
// Optional fields in the response may be undefined
const firstUser: PageUserEntry | undefined = usersInfo?.users?.[0];

페이지 부분 수정

매개변수

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

응답

Returns: PatchPageAPIResponse

예시

patchPage 예시

Copy

(async () => {
  const tenantId: string = "tenant_12345";
  const pageId: string = "page_98765";
  const updateData: UpdateAPIPageData = {
    title: "Updated FAQ Page"
    // description?: string 은 생략할 수 있습니다
  };
  const response: PatchPageAPIResponse = await patchPage(tenantId, pageId, updateData);
})();

대기 중인 웹훅 이벤트 삭제

매개변수

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

응답

반환: DeletePendingWebhookEventResponse

예시

deletePendingWebhookEvent 예시

Copy

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

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

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No

응답

반환: GetPendingWebhookEventCountResponse1

예시

getPendingWebhookEventCount 예제

Copy

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

대기 중인 웹훅 이벤트 조회

매개변수

이름	유형	필수
tenantId	string	Yes
commentId	string	No
externalId	string	No
eventType	string	No
type	string	No
domain	string	No
attemptCountGT	number	No
skip	number	No

응답

반환: GetPendingWebhookEventsResponse1

예시

getPendingWebhookEvents 예시

Copy

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

질문 설정 생성

매개변수

이름	유형	필수	설명
tenantId	string	Yes
createQuestionConfigBody	CreateQuestionConfigBody	Yes

응답

반환: CreateQuestionConfigResponse1

예시

createQuestionConfig 예제

Copy

const tenantId: string = "tenant_12345";
const customOption: QuestionConfigCustomOptionsInner = {
  label: "Option A",
  value: "a",
};
const createQuestionConfigBody: CreateQuestionConfigBody = {
  questionText: "What is your favorite color?",
  isActive: true,
  // 선택적 필드는 생략할 수 있습니다
  customOptions: [customOption],
};
const response: CreateQuestionConfigResponse1 = await createQuestionConfig(
  tenantId,
  createQuestionConfigBody
);

질문 설정 삭제

매개변수

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

응답

반환: DeleteQuestionConfigResponse

예시

deleteQuestionConfig 예시

Copy

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

질문 설정 조회

매개변수

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

응답

반환: GetQuestionConfigResponse1

예시

getQuestionConfig 예시

Copy

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

질문 설정들 조회

매개변수

이름	유형	필수	설명
tenantId	string	Yes
skip	number	No

응답

반환: GetQuestionConfigsResponse1

예시

getQuestionConfigs 예제

Copy

async function fetchQuestionConfigs() {
    const tenantId: string = "tenant-9876";
    // 선택적 'skip' 매개변수 없이 호출
    const configsWithoutSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId);
    // 선택적 'skip' 매개변수와 함께 호출
    const skip: number = 10;
    const configsWithSkip: GetQuestionConfigsResponse1 = await getQuestionConfigs(tenantId, skip);
    console.log(configsWithoutSkip, configsWithSkip);
}

질문 설정 업데이트

매개변수

이름	형식	필수
tenantId	string	Yes
id	string	Yes
updateQuestionConfigBody	UpdateQuestionConfigBody	Yes

응답

반환: UpdateQuestionConfigResponse

예제

updateQuestionConfig 예제

Copy

const tenantId: string = "acme-corp-tenant";
const questionId: string = "qstn-2023-04";
const updateBody: UpdateQuestionConfigBody = {
  // 선택적 필드 예시
  customOptions: [
    {
      id: "opt-001",
      label: "Extra Details",
      required: true,
    },
  ],
  renderingType: "markdown",
};
const response: UpdateQuestionConfigResponse = await updateQuestionConfig(
  tenantId,
  questionId,
  updateBody
);

질문 결과 생성

매개변수

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

응답

Returns: CreateQuestionResultResponse1

예시

createQuestionResult 예제

Copy

const tenantId: string = "acme-corp-tenant";
const metaItem: MetaItem = {
  key: "campaign",
  value: "spring-launch"
};
const questionResultBody: CreateQuestionResultBody = {
  questionId: "question-42",
  answer: "Positive",
  metadata: [metaItem]
  // notes와 같은 선택적 필드는 생략되었습니다
};
const result: CreateQuestionResultResponse1 = await createQuestionResult(tenantId, questionResultBody);

질문 결과 삭제

매개변수

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

응답

반환: DeleteQuestionResultResponse

예시

deleteQuestionResult 예시

Copy

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

질문 결과 조회

매개변수

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

응답

반환: GetQuestionResultResponse1

예시

getQuestionResult 예시

Copy

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

질문 결과들 조회

Parameters

이름	타입	필수
tenantId	string	Yes
urlId	string	No
userId	string	No
startDate	string	No
questionId	string	No
questionIds	string	No
skip	number	No

Response

반환: GetQuestionResultsResponse1

Example

getQuestionResults 예제

Copy

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

질문 결과 업데이트

매개변수

Name	Type	Required
tenantId	string	Yes
id	string	Yes
updateQuestionResultBody	UpdateQuestionResultBody	Yes

응답

Returns: UpdateQuestionResultResponse

예제

updateQuestionResult 예제

Copy

async function runUpdate() {
    const tenantId: string = "acme-corp-01";
    const id: string = "qr-20230915-001";
    const updateQuestionResultBody: UpdateQuestionResultBody = {
        // 필수 필드
        answer: "No",
        // 선택 필드
        comment: "User clarified their response",
        // anotherOptionalField?: value,
    };
    const result: UpdateQuestionResultResponse = await updateQuestionResult(
        tenantId,
        id,
        updateQuestionResultBody
    );
    console.log(result);
}
runUpdate();

질문 결과 집계

매개변수

이름	타입	필수
tenantId	string	Yes
questionId	string	No
questionIds	Array	No
urlId	string	No
timeBucket	AggregateTimeBucket	No
startDate	Date	No
forceRecalculate	boolean	No

응답

반환: AggregateQuestionResultsResponse1

예제

aggregateQuestionResults 예제

Copy

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

질문 결과 일괄 집계

Parameters

Name	Type	Required
tenantId	string	예
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	예
forceRecalculate	boolean	아니오

Response

반환: BulkAggregateQuestionResultsResponse1

Example

bulkAggregateQuestionResults 예시

Copy

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

댓글과 질문 결과 결합

매개변수

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

응답

반환: CombineCommentsWithQuestionResultsResponse

예시

combineCommentsWithQuestionResults 예시

Copy

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

SSO 사용자 추가

매개변수

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

응답

Returns: AddSSOUserAPIResponse

예시

addSSOUser 예시

Copy

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

SSO 사용자 삭제

매개변수

Name	Type	Required
tenantId	string	Yes
id	string	Yes
deleteComments	boolean	No
commentDeleteMode	string	No

응답

Returns: DeleteSSOUserAPIResponse

예시

deleteSSOUser 예시

Copy

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

이메일로 SSO 사용자 조회

매개변수

이름	타입	필수	설명
tenantId	string	Yes
email	string	Yes

응답

반환: GetSSOUserByEmailAPIResponse

예시

getSSOUserByEmail 예시

Copy

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

ID로 SSO 사용자 조회

매개변수

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

응답

Returns: GetSSOUserByIdAPIResponse

예제

getSSOUserById 예제

Copy

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

SSO 사용자들 조회

매개변수

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

응답

Returns: GetSSOUsersResponse

예시

getSSOUsers 예시

Copy

async function runExample(): Promise<void> {
    const tenantId: string = "tenant_12345";
    // 옵션 `skip` 없이 호출
    const firstPage: GetSSOUsersResponse = await getSSOUsers(tenantId);
    // 옵션 `skip`와 함께 호출
    const secondPage: GetSSOUsersResponse = await getSSOUsers(tenantId, 100);
    console.log(firstPage, secondPage);
}
runExample();

SSO 사용자 부분 수정

매개변수

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

응답

반환: PatchSSOUserAPIResponse

예시

patchSSOUser 예제

Copy

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

SSO 사용자 전체 대체

매개변수

이름	형식	필수
tenantId	string	Yes
id	string	Yes
updateAPISSOUserData	UpdateAPISSOUserData	Yes
updateComments	boolean	No

응답

반환: PutSSOUserAPIResponse

예시

putSSOUser 예시

Copy

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

구독 생성

Parameters

이름	유형	필수	설명
tenantId	string	Yes
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Yes

Response

반환: CreateSubscriptionAPIResponse

Example

createSubscription 예시

Copy

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

구독 삭제

Parameters

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

Response

Returns: DeleteSubscriptionAPIResponse

Example

deleteSubscription 예제

Copy

(async () => {
  const tenantId: string = "tenant_9876";
  const subscriptionId: string = "sub_54321";
  const userId: string = "user_abc123";
  // 선택적 userId 포함
  const responseWithUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId, userId);
  // 선택적 userId 없이
  const responseWithoutUser: DeleteSubscriptionAPIResponse = await deleteSubscription(tenantId, subscriptionId);
})();

구독들 조회

매개변수

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

응답

반환: GetSubscriptionsAPIResponse

예시

getSubscriptions 예제

Copy

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

구독 업데이트

매개변수

이름	타입	필수
tenantId	string	Yes
id	string	Yes
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Yes
userId	string	No

응답

반환: UpdateSubscriptionAPIResponse

예시

updateSubscription 예시

Copy

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

테넌트 일일 사용량 조회

매개변수

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

응답

반환: GetTenantDailyUsagesResponse1

예시

getTenantDailyUsages 예시

Copy

async function fetchDailyUsage() {
  const tenantId: string = "tenant-9876";
  const yearNumber: number = 2024;
  const monthNumber: number = 5; // 5월
  const dayNumber: number = 12;
  const skip: number = 0;
  const fullResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber,
    monthNumber,
    dayNumber,
    skip
  );
  // 필수 매개변수와 하나의 선택 매개변수만 사용
  const partialResult: GetTenantDailyUsagesResponse1 = await getTenantDailyUsages(
    tenantId,
    yearNumber
  );
  console.log(fullResult, partialResult);
}
fetchDailyUsage();

테넌트 패키지 생성

매개변수

이름	유형	필수	설명
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	Yes

응답

반환: CreateTenantPackageResponse1

예시

createTenantPackage 예시

Copy

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

테넌트 패키지 삭제

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Response

Returns: DeleteTenantPackageResponse

Example

deleteTenantPackage 예시

Copy

async function removeTenantPackage(): Promise<void> {
  const tenantId: string = "tenant_12345";
  const packageId: string = "pkg_67890";
  const result: DeleteTenantPackageResponse = await deleteTenantPackage(tenantId, packageId);
  // 필요에 따라 결과 사용
}
removeTenantPackage();

테넌트 패키지 조회

매개변수

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

응답

반환: GetTenantPackageResponse1

예시

getTenantPackage 예제

Copy

async function fetchTenantPackage(): Promise<void> {
    const tenantId: string = "acme-tenant-2024";
    const packageId: string = "premium-package-01";
    const response: GetTenantPackageResponse1 = await getTenantPackage(tenantId, packageId);
    // 응답의 선택적 필드
    const tenantPackage: TenantPackage | undefined = response.tenantPackage;
    const customConfig: CustomConfigParameters | undefined = response.customConfigParameters;
}

테넌트 패키지들 조회

Parameters

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

응답

반환: GetTenantPackagesResponse1

예시

getTenantPackages 예시

Copy

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

테넌트 패키지 교체

매개변수

이름	유형	필수
tenantId	string	예
id	string	예
replaceTenantPackageBody	ReplaceTenantPackageBody	예

응답

반환: ReplaceTenantPackageResponse

예제

replaceTenantPackage 예제

Copy

(async () => {
    const tenantId: string = "acme-corp-tenant-01";
    const packageId: string = "pkg-2024-annual";
    const config: CustomConfigParameters = {
        // 여기 사용자 정의 구성 필드
    };
    const body: ReplaceTenantPackageBody = {
        name: "Enterprise Package",
        // 선택적 사용자 정의 구성
        customConfig: config,
    };
    const response: ReplaceTenantPackageResponse = await replaceTenantPackage(tenantId, packageId, body);
    console.log(response);
})();

테넌트 패키지 업데이트

매개변수

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

응답

반환: UpdateTenantPackageResponse

예제

updateTenantPackage 예제

Copy

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

테넌트 사용자 생성

매개변수

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

응답

반환: CreateTenantUserResponse1

예시

createTenantUser 예시

Copy

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

테넌트 사용자 삭제

매개변수

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

응답

반환: DeleteTenantUserResponse

예시

deleteTenantUser 예시

Copy

async function demoDeleteTenantUser() {
  const tenantId: string = "acme-corp-tenant";
  const userId: string = "user-9876";
  // 하드 삭제 모드를 사용하여 사용자를 삭제하고 모든 댓글을 삭제합니다
  const resultWithOptions: DeleteTenantUserResponse = await deleteTenantUser(
    tenantId,
    userId,
    "true",
    "hard"
  );
  // 댓글을 제거하지 않고 사용자를 삭제합니다 (기본 동작)
  const resultBasic: DeleteTenantUserResponse = await deleteTenantUser(tenantId, userId);
}

테넌트 사용자 조회

매개변수

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

응답

반환: GetTenantUserResponse1

예시

getTenantUser 예시

Copy

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

테넌트 사용자들 조회

매개변수

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

응답

반환: GetTenantUsersResponse1

예시

getTenantUsers 예제

Copy

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

테넌트 사용자 교체

매개변수

이름	타입	필수
tenantId	string	예
id	string	예
replaceTenantUserBody	ReplaceTenantUserBody	예
updateComments	string	아니오

응답

반환: ReplaceTenantUserResponse

예시

replaceTenantUser 예시

Copy

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

로그인 링크 전송

매개변수

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

응답

반환: SendLoginLinkResponse

예시

sendLoginLink 예시

Copy

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

테넌트 사용자 업데이트

매개변수

이름	형식	필수
tenantId	string	예
id	string	예
updateTenantUserBody	UpdateTenantUserBody	예
updateComments	string	아니오

응답

반환: UpdateTenantUserResponse

예시

updateTenantUser 예시

Copy

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

테넌트 생성

매개변수

이름	유형	필수	설명
tenantId	string	Yes
createTenantBody	CreateTenantBody	Yes

응답

반환: CreateTenantResponse1

예시

createTenant 예시

Copy

async function example() {
  const tenantId: string = 'tenant-2024-01';
  const createTenantBody: CreateTenantBody = {
    // 필수 필드
    name: 'Acme International',
    // 필요에 따라 선택적 필드를 추가할 수 있습니다, 예:
    // billingInfo: { address: '123 Main St', city: 'Metropolis' } as BillingInfo,
  };
  const response: CreateTenantResponse1 = await createTenant(tenantId, createTenantBody);
  console.log(response);
}

테넌트 삭제

Parameters

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

Response

Returns: DeleteTenantResponse

Example

deleteTenant 예시

Copy

async function runExample() {
    const tenantId: string = "tenant_12345";
    const id: string = "resource_98765";
    const sure: string = "confirm";
    // 선택적인 'sure' 매개변수를 사용하여 호출
    const responseWithSure: DeleteTenantResponse = await deleteTenant(tenantId, id, sure);
    console.log(responseWithSure);
    // 선택적인 'sure' 매개변수 없이 호출
    const responseWithoutSure: DeleteTenantResponse = await deleteTenant(tenantId, id);
    console.log(responseWithoutSure);
}
runExample();

테넌트 조회

매개변수

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

응답

반환: GetTenantResponse1

예시

getTenant 예제

Copy

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

테넌트들 조회

매개변수

이름	형식	필수
tenantId	string	Yes
meta	string	No
skip	number	No

응답

반환: GetTenantsResponse1

예제

getTenants 예제

Copy

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

테넌트 업데이트

매개변수

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

응답

반환: UpdateTenantResponse

예시

updateTenant 예시

Copy

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

티켓 상태 변경

매개변수

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

응답

반환: ChangeTicketStateResponse1

예시

changeTicketState 예제

Copy

const tenantId: string = "acme-corp";
const userId: string = "user-97123";
const ticketId: string = "ticket-45001";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  // 본문에 선택적 필드
  comment: "Issue resolved after code fix"
};
const response: ChangeTicketStateResponse1 = await changeTicketState(
  tenantId,
  userId,
  ticketId,
  changeTicketStateBody
);

티켓 생성

매개변수

이름	유형	필수
tenantId	string	Yes
userId	string	Yes
createTicketBody	CreateTicketBody	Yes

응답

반환: CreateTicketResponse1

예시

createTicket 예시

Copy

const tenantId: string = "tenant_12345";
const userId: string = "user_98765";
const ticketBody: CreateTicketBody = {
  subject: "Issue with payment processing"
  // description?: string은 선택 사항이며 생략되었습니다
};
const response: CreateTicketResponse1 = await createTicket(tenantId, userId, ticketBody);
// 응답의 선택적 필드를 사용하는 예시
// console.log(response.ticket?.id);

티켓 조회

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	Yes
userId	string	No

응답

Returns: GetTicketResponse1

예시

getTicket 예시

Copy

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

티켓들 조회

매개변수

이름	타입	필수
tenantId	string	예
userId	string	아니오
state	number	아니오
skip	number	아니오
limit	number	아니오

응답

반환: GetTicketsResponse1

예시

getTickets 예제

Copy

async function loadTickets() {
  const tenantId: string = "acme-corp";
  const userId: string = "john.doe";
  const state: number = 2; // 예: 닫힌 상태
  const skip: number = 10;
  const limit: number = 5;
  const ticketsFull: GetTicketsResponse1 = await getTickets(tenantId, userId, state, skip, limit);
  const ticketsPartial: GetTicketsResponse1 = await getTickets(tenantId);
}
loadTickets();

번역 조회

매개변수

이름	유형	필수
namespace	string	Yes
component	string	Yes
locale	string	No
useFullTranslationIds	boolean	No

응답

반환: GetTranslationsResponse1

예시

getTranslations 예시

Copy

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

이미지 업로드

이미지를 업로드하고 크기를 조정하기

매개변수

이름	유형	필수
tenantId	string	Yes
file	Blob	Yes
sizePreset	SizePreset	No
urlId	string	No

응답

반환: UploadImageResponse

예시

uploadImage 예제

Copy

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

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

매개변수

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

응답

반환: GetUserBadgeProgressByIdResponse

예제

getUserBadgeProgressById 예제

Copy

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

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

매개변수

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

응답

반환: GetUserBadgeProgressByUserIdResponse

예제

getUserBadgeProgressByUserId 예제

Copy

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

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

매개변수

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

응답

반환: GetUserBadgeProgressListResponse

예시

getUserBadgeProgressList 예시

Copy

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

사용자 배지 생성

매개변수

이름	형식	필수	설명
tenantId	string	Yes
createUserBadgeParams	CreateUserBadgeParams	Yes

응답

반환: CreateUserBadgeResponse

예시

createUserBadge 예제

Copy

const tenantId: string = "company-42";
const badgeParams: CreateUserBadgeParams = {
  name: "Community Champion",
  iconUrl: "https://assets.example.com/badges/champion.png",
  // 설명은 선택 사항이며 여기서는 생략되었습니다
};
const result: CreateUserBadgeResponse = await createUserBadge(tenantId, badgeParams);

사용자 배지 삭제

매개변수

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

응답

반환: DeleteUserBadgeResponse

예시

deleteUserBadge 예제

Copy

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

사용자 배지 조회

매개변수

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

응답

반환: GetUserBadgeResponse

예시

getUserBadge 예시

Copy

async function runExample(): Promise<void> {
  const tenantId: string = "acme-corp-tenant-001";
  const badgeId: string = "badge-5f9d3a2b";
  const badgeResponse: GetUserBadgeResponse = await getUserBadge(tenantId, badgeId);
  // 옵션 필드를 안전하게 접근
  const badgeName: string | undefined = badgeResponse.userBadge?.name;
  console.log(`Badge ID: ${badgeId}, Name: ${badgeName ?? "Unnamed"}`);
}
runExample();

사용자 배지들 조회

매개변수

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

응답

반환: GetUserBadgesResponse

예제

getUserBadges 예제

Copy

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

사용자 배지 업데이트

매개변수

이름	유형	필수
tenantId	string	Yes
id	string	Yes
updateUserBadgeParams	UpdateUserBadgeParams	Yes

응답

반환: UpdateUserBadgeResponse

예시

updateUserBadge 예제

Copy

async function applyBadge() {
    const tenantId: string = "acme-corp-tenant";
    const userId: string = "user-98765";
    const params: UpdateUserBadgeParams = {
        badgeId: "gold-contributor",
        // 옵션 필드 예시
        expiresAt: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000).toISOString(),
    };
    const result: UpdateUserBadgeResponse = await updateUserBadge(tenantId, userId, params);
    console.log(result);
}
applyBadge();

사용자 알림 수 조회

매개변수

이름	유형	필수	설명
tenantId	string	Yes
sso	string	No

응답

반환: GetUserNotificationCountResponse1

예시

getUserNotificationCount 예제

Copy

async function demoGetUserNotificationCount() {
    const tenantId: string = "acme-corp-01";
    // 선택적 SSO 토큰으로 호출
    const countWithSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId,
        "sso-token-abc123"
    );
    // SSO 토큰 없이 호출
    const countWithoutSSO: GetUserNotificationCountResponse1 = await getUserNotificationCount(
        tenantId
    );
    console.log(countWithSSO, countWithoutSSO);
}

사용자 알림 조회

매개변수

이름	유형	필수
tenantId	string	Yes
urlId	string	No
pageSize	number	No
afterId	string	No
includeContext	boolean	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
includeTranslations	boolean	No
includeTenantNotifications	boolean	No
sso	string	No

응답

반환: GetUserNotificationsResponse

예시

getUserNotifications 예시

Copy

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

사용자 알림 수 초기화

매개변수

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

응답

반환: ResetUserNotificationCountResponse

예시

resetUserNotificationCount 예제

Copy

async function demoResetCount() {
  const tenantId: string = "acme-corp-tenant";
  const sso: string = "sso-user-9876";
  // 선택적 sso 매개변수를 사용하여 호출
  const resultWithSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId, sso);
  // 선택적 sso 매개변수 없이 호출
  const resultWithoutSso: ResetUserNotificationCountResponse = await resetUserNotificationCount(tenantId);
  console.log(resultWithSso, resultWithoutSso);
}

사용자 알림 초기화

매개변수

이름	유형	필수
tenantId	string	Yes
afterId	string	No
afterCreatedAt	number	No
unreadOnly	boolean	No
dmOnly	boolean	No
noDm	boolean	No
sso	string	No

응답

반환: ResetUserNotificationsResponse1

예시

resetUserNotifications 예시

Copy

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

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

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

매개변수

이름	타입	필수
tenantId	string	Yes
notificationId	string	Yes
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Yes
commentId	string	Yes
sso	string	No

응답

반환: UpdateUserNotificationCommentSubscriptionStatusResponse

예시

updateUserNotificationCommentSubscriptionStatus 예시

Copy

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

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

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

매개변수

Name	Type	Required
tenantId	string	Yes
urlId	string	Yes
url	string	Yes
pageTitle	string	Yes
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Yes
sso	string	No

응답

반환: UpdateUserNotificationPageSubscriptionStatusResponse

예시

updateUserNotificationPageSubscriptionStatus 예제

Copy

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

사용자 알림 상태 업데이트

매개변수

이름	유형	필수
tenantId	string	Yes
notificationId	string	Yes
newStatus	UpdateUserNotificationStatusNewStatusEnum	Yes
sso	string	No

응답

반환: UpdateUserNotificationStatusResponse

예시

updateUserNotificationStatus 예시

Copy

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

사용자 접속 상태들 조회

Parameters

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

Response

반환: GetUserPresenceStatusesResponse1

Example

getUserPresenceStatuses 예제

Copy

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

사용자 검색

매개변수

이름	유형	필수
tenantId	string	Yes
urlId	string	Yes
usernameStartsWith	string	No
mentionGroupIds	Array	No
sso	string	No
searchSection	SearchUsersSearchSectionEnum	No

응답

반환: SearchUsersResponse1

예제

searchUsers 예제

Copy

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

사용자 조회

매개변수

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

응답

반환: GetUserResponse1

예시

getUser 예시

Copy

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

투표 생성

매개변수

이름	형식	필수
tenantId	string	Yes
commentId	string	Yes
direction	CreateVoteDirectionEnum	Yes
userId	string	No
anonUserId	string	No

응답

반환: CreateVoteResponse

예시

createVote 예시

Copy

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

투표 삭제

Parameters

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

Response

반환: DeleteVoteResponse

Example

deleteVote 예시

Copy

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

투표 조회

매개변수

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

응답

반환: GetVotesResponse1

예시

getVotes 예시

Copy

async function fetchVotes(): Promise<void> {
  const tenantId: string = "acme-corp-01";
  const urlId: string = "article-2024-05-15";
  const response: GetVotesResponse1 = await getVotes(tenantId, urlId);
  // 응답에서 선택적 필드에 접근하는 예시
  const firstVoteId: string | undefined = response?.votes?.[0]?.id;
}

사용자별 투표 조회

매개변수

이름	유형	필수
tenantId	string	Yes
urlId	string	Yes
userId	string	No
anonUserId	string	No

응답

반환값: GetVotesForUserResponse1

예시

getVotesForUser 예시

Copy

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

도움을 원하십니까?

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

기여

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

언어 🇰🇷 한국어

시작하기

API 참조

문서

사용법

집계

감사 로그

댓글 차단

차단된 댓글 확인

댓글

사용자용 댓글

도메인 설정

이메일 템플릿

이벤트 로그

피드 게시물

댓글 신고

GIF

해시태그

중재

중재자

알림 수

알림

페이지 반응

페이지

대기 중인 웹훅 이벤트

질문 설정

질문 결과

질문 결과 집계

SSO 사용자

구독

테넌트 일일 사용량

테넌트 패키지

테넌트 사용자

테넌트

티켓

번역

이미지 업로드

사용자 배지 진행률

사용자 배지

사용자 알림

사용자 접속 상태

사용자 검색

사용자

투표

FastComments 자바스크립트/타입스크립트 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와 보안 API

예제: Using Public API (브라우저 안전)

예제: Using Default API (서버 측 전용)

예제: Using Moderation API

SSO(싱글 사인온) 통합

간단한 SSO (서버 전용)

보안 SSO (서버 측, 권장)

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

댓글 생성과 함께하는 SSO

일반적인 사용 사례

페이지의 댓글 가져오기

댓글 생성

댓글에 투표하기

사용자 관리 (API 키 필요)

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

페이지 수준 이벤트

사용자 이벤트 구독

userIdWS 가져오기

방송 ID

오류 처리

집계

Parameters

응답