
언어 🇰🇷 한국어
문서
집계
감사 로그
인증
댓글 차단
차단된 댓글 확인
댓글
사용자 댓글
도메인 설정
이메일 템플릿
이벤트 로그
피드 게시물
댓글 신고
GIF
해시태그
관리
관리자
알림 수
알림
페이지 반응
페이지
보류 중인 웹훅 이벤트
질문 설정
질문 결과
질문 결과 집계
SSO 사용자
구독
테넌트 일일 사용량
테넌트 패키지
테넌트 사용자
테넌트
티켓
번역
이미지 업로드
사용자 배지 진행
사용자 배지
사용자 알림
사용자 온라인 상태
사용자 검색
사용자
투표
FastComments Dart SDK
FastComments용 공식 Dart SDK입니다.
Dart 및 Flutter 애플리케이션에서 댓글, 사용자, SSO 및 중재를 관리합니다.
저장소
레이아웃 
fastcomments-dart/
client/ 생성된 dart 클라이언트 (직접 편집 금지)
sso/ 수동 작성 SSO 토큰 도우미
openapi.json 생성을 위해 사용된 사양의 커밋된 복사본
config.json OpenAPI-Generator 구성
update.py 사양으로부터 클라이언트를 재생성
Use 
dependencies:
fastcomments_dart: ^3.0.0
SSO 헬퍼는 패키지에 포함되어 있습니다 (package:fastcomments_dart/sso/...).
클라이언트는 세 개의 API 클래스를 노출합니다:
DefaultApi- 서버 측 사용을 위한 API 키 인증 메서드.PublicApi- API 키가 필요 없는 공개 메서드이며, 브라우저 및 모바일 클라이언트에 안전합니다.ModerationApi- 실시간 및 빠른 모더레이션 API의 포괄적인 스위트입니다. 모든ModerationApi메서드는sso매개변수를 받아 SSO 또는 FastComments.com 세션 쿠키를 통해 인증할 수 있습니다.
import 'package:fastcomments_dart/api.dart';
final api = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final comments = await api.getCommentsPublic('YOUR_TENANT_ID', 'YOUR_URL_ID');import 'package:fastcomments_dart/api.dart';
final publicApi = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final feedPosts = await publicApi.getFeedPostsPublic('YOUR_TENANT_ID');import 'package:fastcomments_dart/api.dart';
final moderation = ModerationApi(ApiClient(basePath: 'https://fastcomments.com'));
final result = await moderation.getApiComments(
GetApiCommentsOptions(sso: 'SSO_TOKEN'),
);
SSO 
import 'package:fastcomments_dart/sso/fastcomments_sso.dart';
import 'package:fastcomments_dart/sso/secure_sso_user_data.dart';
final sso = FastCommentsSSO.secure(
apiKey: 'YOUR_API_SECRET',
user: SecureSSOUserData(
id: 'user-123',
email: 'jane@example.com',
username: 'jane',
avatar: 'https://example.com/jane.png',
),
);
final token = sso.prepareToSend();
aggregate 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| parentTenantId | string | query | 아니오 | |
| includeStats | boolean | query | 아니오 |
응답
반환: AggregateResponse
예시

getAuditLogs 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| limit | number | query | 아니오 | |
| skip | number | query | 아니오 | |
| order | string | query | 아니오 | |
| after | number | query | 아니오 | |
| before | number | query | 아니오 |
응답
반환: GetAuditLogsResponse
예시

logoutPublic 
응답
반환: APIEmptyResponse
예시

blockFromCommentPublic 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | 쿼리 | 예 | |
| commentId | string | 경로 | 예 | |
| sso | string | 쿼리 | 아니오 |
응답
반환: BlockSuccess
예시

unBlockCommentPublic 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
응답
반환: UnblockSuccess
예제

checkedCommentsForBlocked 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | 쉼표로 구분된 댓글 ID 목록. |
| sso | string | query | No |
응답
반환: CheckBlockedCommentsResponse
예시

blockUserFromComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| userId | string | query | 아니오 | |
| anonUserId | string | query | 아니오 |
응답
반환: BlockSuccess
예시

createCommentPublic 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
응답
반환: SaveCommentsResponseWithPresence
예시

deleteComment 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| contextUserId | string | query | 아니오 | |
| isLive | boolean | query | 아니오 |
응답
반환: DeleteCommentResult
예시

deleteCommentPublic 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| broadcastId | string | query | 예 | |
| editKey | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
Returns: PublicAPIDeleteCommentResponse
예시

deleteCommentVote 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Returns: VoteDeleteResponse
Example

flagComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
응답
반환: FlagCommentResponse
예시

getComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
Returns: APIGetCommentResponse
예제

getComments 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| page | integer | query | 아니오 | |
| limit | integer | query | 아니오 | |
| skip | integer | query | 아니오 | |
| asTree | boolean | query | 아니오 | |
| skipChildren | integer | query | 아니오 | |
| limitChildren | integer | query | 아니오 | |
| maxTreeDepth | integer | query | 아니오 | |
| urlId | string | query | 아니오 | |
| userId | string | query | 아니오 | |
| anonUserId | string | query | 아니오 | |
| contextUserId | string | query | 아니오 | |
| hashTag | string | query | 아니오 | |
| parentId | string | query | 아니오 | |
| direction | string | query | 아니오 | |
| fromDate | integer | query | 아니오 | |
| toDate | integer | query | 아니오 |
응답
반환: APIGetCommentsResponse
예시

getCommentsPublic 
req tenantId urlId
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | |
| page | integer | query | 아니오 | |
| direction | string | query | 아니오 | |
| sso | string | query | 아니오 | |
| skip | integer | query | 아니오 | |
| skipChildren | integer | query | 아니오 | |
| limit | integer | query | 아니오 | |
| limitChildren | integer | query | 아니오 | |
| countChildren | boolean | query | 아니오 | |
| fetchPageForCommentId | string | query | 아니오 | |
| includeConfig | boolean | query | 아니오 | |
| countAll | boolean | query | 아니오 | |
| includei10n | boolean | query | 아니오 | |
| locale | string | query | 아니오 | |
| modules | string | query | 아니오 | |
| isCrawler | boolean | query | 아니오 | |
| includeNotificationCount | boolean | query | 아니오 | |
| asTree | boolean | query | 아니오 | |
| maxTreeDepth | integer | query | 아니오 | |
| useFullTranslationIds | boolean | query | 아니오 | |
| parentId | string | query | 아니오 | |
| searchText | string | query | 아니오 | |
| hashTags | array | query | 아니오 | |
| userId | string | query | 아니오 | |
| customConfigStr | string | query | 아니오 | |
| afterCommentId | string | query | 아니오 | |
| beforeCommentId | string | query | 아니오 |
응답
반환: GetCommentsResponseWithPresencePublicComment
예시

getCommentText 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
응답
반환: PublicAPIGetCommentTextResponse
예시

getCommentVoteUserNames 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| dir | integer | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: GetCommentVoteUserNamesSuccessResponse
예시

lockComment 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
응답
반환: APIEmptyResponse
예시

pinComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
응답
반환값: ChangeCommentPinStatusResponse
예시

saveComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
응답
반환: APISaveCommentResponse
예제

saveCommentsBulk 
Parameters
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Response
반환값: SaveCommentsBulkResponse
Example

setCommentText 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| broadcastId | string | query | 예 | |
| editKey | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: PublicAPISetCommentTextResponse
예시

unBlockUserFromComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| userId | string | query | 아니오 | |
| anonUserId | string | query | 아니오 |
응답
반환: UnblockSuccess
예시

unFlagComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
응답
반환: FlagCommentResponse
예시

unLockComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| broadcastId | string | query | 예 | |
| sso | string | query | 아니오 |
응답
Returns: APIEmptyResponse
예시

unPinComment 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
응답
Returns: ChangeCommentPinStatusResponse
예시

updateComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
응답
반환: APIEmptyResponse
예시

voteComment 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| urlId | string | query | 예 | |
| broadcastId | string | query | 예 | |
| sessionId | string | query | 아니오 | |
| sso | string | query | 아니오 |
Response
반환: VoteResponse
Example

getCommentsForUser 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
Response
반환값: GetCommentsForUserResponse
Example

addDomainConfig 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
Response
반환값: AddDomainConfigResponse
Example

deleteDomainConfig 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
응답
반환: DeleteDomainConfigResponse
예시

getDomainConfig 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
응답
반환: GetDomainConfigResponse
예시

getDomainConfigs 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
응답
반환: GetDomainConfigsResponse
예시

patchDomainConfig 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
응답
반환: PatchDomainConfigResponse
예시

putDomainConfig 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| domainToUpdate | string | path | 예 |
응답
반환: PutDomainConfigResponse
예제

createEmailTemplate 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
응답
반환: CreateEmailTemplateResponse
예시

deleteEmailTemplate 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
Returns: APIEmptyResponse
예시

deleteEmailTemplateRenderError 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| errorId | string | path | 예 |
Response
반환: APIEmptyResponse
Example

getEmailTemplate 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: GetEmailTemplateResponse
예시

getEmailTemplateDefinitions 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
반환: GetEmailTemplateDefinitionsResponse
예제

getEmailTemplateRenderErrors 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| skip | number | query | 아니오 |
Response
반환값: GetEmailTemplateRenderErrorsResponse
Example

getEmailTemplates 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
응답
반환: GetEmailTemplatesResponse
예시

renderEmailTemplate 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| locale | string | query | No |
응답
Returns: RenderEmailTemplateResponse
예제

updateEmailTemplate 
매개변수
| 이 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: APIEmptyResponse
예시

getEventLog 
req tenantId urlId userIdWS
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | No |
응답
반환: GetEventLogResponse
예시

getGlobalEventLog 
req tenantId urlId userIdWS
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | |
| userIdWS | string | query | 예 | |
| startTime | integer | query | 예 | |
| endTime | integer | query | 아니오 |
Response
반환: GetEventLogResponse
Example

createFeedPost 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
응답
반환: CreateFeedPostResponse
예시

createFeedPostPublic 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: CreateFeedPostResponse
예시

deleteFeedPostPublic 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
반환: DeleteFeedPostPublicResponse
예시

getFeedPosts 
요청 tenantId afterId
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
응답
반환: GetFeedPostsResponse
예시

getFeedPostsPublic 
req tenantId afterId
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
응답
반환: PublicFeedPostsResponse
예시

getFeedPostsStats 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| postIds | array | query | 예 | |
| sso | string | query | 아니요 |
응답
반환: FeedPostsStatsResponse
예시

getUserReactsPublic 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| postIds | array | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: UserReactsResponse
예제

reactFeedPostPublic 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| postId | string | path | 예 | |
| isUndo | boolean | query | 아니오 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: ReactFeedPostResponse
예제

updateFeedPost 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
Returns: APIEmptyResponse
예시

updateFeedPostPublic 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | 문자열 | 경로 | 예 | |
| postId | 문자열 | 경로 | 예 | |
| broadcastId | 문자열 | 쿼리 | 아니오 | |
| sso | 문자열 | 쿼리 | 아니오 |
응답
반환: CreateFeedPostResponse
예시

flagCommentPublic 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| isFlagged | boolean | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: APIEmptyResponse
예시

getGifLarge 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| largeInternalURLSanitized | string | query | 예 |
응답
반환: GifGetLargeResponse
예제

getGifsSearch 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
응답
Returns: GetGifsSearchResponse
예시

getGifsTrending 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| locale | string | query | 아니오 | |
| rating | string | query | 아니오 | |
| page | number | query | 아니오 |
응답
Returns: GetGifsTrendingResponse
예시

addHashTag 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
반환: CreateHashTagResponse
예시

addHashTagsBulk 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
응답
Returns: BulkCreateHashTagsResponse
예시

deleteHashTag 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
응답
Returns: APIEmptyResponse
예시

getHashTags 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No |
응답
반환: GetHashTagsResponse
예시

patchHashTag 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
응답
반환: UpdateHashTagResponse
예시

deleteModerationVote 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
반환: VoteDeleteResponse
예시

getApiComments 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
응답
Returns: ModerationAPIGetCommentsResponse
예시

getApiExportStatus 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| batchJobId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: ModerationExportStatusResponse
예시

getApiIds 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
응답
반환: ModerationAPIGetCommentIdsResponse
예시

getBanUsersFromComment 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
응답
반환: GetBannedUsersFromCommentResponse
예시

getCommentBanStatus 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| sso | string | query | 아니오 |
응답
반환: GetCommentBanStatusResponse
예시

getCommentChildren 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
응답
Returns: ModerationAPIChildCommentsResponse
예시

getCount 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
응답
반환: ModerationAPICountCommentsResponse
예시

getCounts 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
응답
Returns: GetBannedUsersCountResponse
예시

getLogs 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| sso | string | query | 아니오 |
응답
반환: ModerationAPIGetLogsResponse
예시

getManualBadges 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
응답
반환: GetTenantManualBadgesResponse
예시

getManualBadgesForUser 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
응답
Returns: GetUserManualBadgesResponse
예시

getModerationComment 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| includeEmail | boolean | query | 아니오 | |
| includeIP | boolean | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: ModerationAPICommentResponse
예시

getModerationCommentText 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
응답
반환: GetCommentTextResponse
예시

getPreBanSummary 
매개변수
| 이름 | 유형 | 위치 | Required | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
응답
반환: PreBanSummary
예시

getSearchCommentsSummary 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
응답
반환: ModerationCommentSearchResponse
예제

getSearchPages 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
응답
반환: ModerationPageSearchResponse
예시

getSearchSites 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| value | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: ModerationSiteSearchResponse
예시

getSearchSuggest 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | 쿼리 | 예 | |
| text-search | string | 쿼리 | 아니오 | |
| sso | string | 쿼리 | 아니오 |
응답
반환: ModerationSuggestResponse
예시

getSearchUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
반환: ModerationUserSearchResponse
Example

getTrustFactor 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: GetUserTrustFactorResponse
예시

getUserBanPreference 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: APIModerateGetUserBanPreferencesResponse
예제

getUserInternalProfile 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
응답
반환: GetUserInternalProfileResponse
예시

postAdjustCommentVotes 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
Returns: AdjustVotesResponse
Example

postApiExport 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| text-search | string | query | 아니오 | |
| byIPFromComment | string | query | 아니오 | |
| filters | string | query | 아니오 | |
| searchFilters | string | query | 아니오 | |
| sorts | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: ModerationExportResponse
예시

postBanUserFromComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
응답
반환: BanUserFromCommentResult
예시

postBanUserUndo 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: APIEmptyResponse
예시

postBulkPreBanSummary 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
응답
반환: BulkPreBanSummary
예시

postCommentsByIds 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
응답
반환: ModerationAPIChildCommentsResponse
예시

postFlagComment 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
Returns: APIEmptyResponse
예시

postRemoveComment 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
반환: PostRemoveCommentApiResponse
Example

postRestoreDeletedComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
Returns: APIEmptyResponse
예시

postSetCommentApprovalStatus 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | 쿼리 | 예 | |
| commentId | string | 경로 | 예 | |
| approved | boolean | 쿼리 | 아니오 | |
| broadcastId | string | 쿼리 | 아니오 | |
| sso | string | 쿼리 | 아니오 |
응답
반환: SetCommentApprovedResponse
예시

postSetCommentReviewStatus 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
반환: APIEmptyResponse
예시

postSetCommentSpamStatus 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
Returns: APIEmptyResponse
예시

postSetCommentText 
Parameters
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
반환: SetCommentTextResponse
예시

postUnFlagComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
Response
Returns: APIEmptyResponse
Example

postVote 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| direction | string | query | 아니오 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: VoteResponse
예시

putAwardBadge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| badgeId | string | query | 예 | |
| userId | string | query | 아니오 | |
| commentId | string | query | 아니오 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
Response
반환: AwardUserBadgeResponse
Example

putCloseThread 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| urlId | string | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: APIEmptyResponse
예시

putRemoveBadge 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
Returns: RemoveUserBadgeResponse
예시

putReopenThread 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| urlId | string | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: APIEmptyResponse
예시

setTrustFactor 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 아니오 | |
| trustFactor | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: SetUserTrustFactorResponse
예시

createModerator 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
Returns: CreateModeratorResponse
예시

deleteModerator 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| sendEmail | string | query | 아니오 |
응답
Returns: APIEmptyResponse
예시

getModerator 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: GetModeratorResponse
예시

getModerators 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| skip | number | query | 아니오 |
응답
반환: GetModeratorsResponse
예시

sendInvite 
Parameters
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| fromName | string | query | Yes |
Response
반환: APIEmptyResponse
Example

updateModerator 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: APIEmptyResponse
예시

deleteNotificationCount 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: APIEmptyResponse
예시

getCachedNotificationCount 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: GetCachedNotificationCountResponse
예시

getNotificationCount 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 아니오 | |
| urlId | string | query | 아니오 | |
| fromCommentId | string | query | 아니오 | |
| viewed | boolean | query | 아니오 | |
| type | string | query | 아니오 |
Response
반환: GetNotificationCountResponse
예시

getNotifications 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
응답
반환: GetNotificationsResponse
예시

updateNotification 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
응답
반환: APIEmptyResponse
예제

createV1PageReact 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No |
응답
Returns: CreateV1PageReact
예시

createV2PageReact 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No |
응답
반환: CreateV1PageReact
예시

deleteV1PageReact 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 |
응답
반환: CreateV1PageReact
예시

deleteV2PageReact 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | |
| id | string | query | 예 |
응답
반환: CreateV1PageReact
예시

getV1PageLikes 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
응답
반환: GetV1PageLikes
예시

getV2PageReacts 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
응답
Returns: GetV2PageReacts
예시

getV2PageReactUsers 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
응답
반환: GetV2PageReactUsersResponse
예시

addPage 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
반환: AddPageAPIResponse
Example

deletePage 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
Response
반환: DeletePageAPIResponse
Example

getOfflineUsers 
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
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | 페이지 URL 식별자 (서버 측에서 정리됨). |
| afterName | string | query | No | 커서: 이전 응답의 nextAfterName을 전달합니다. |
| afterUserId | string | query | No | 커서 동점 해결: 이전 응답의 nextAfterUserId를 전달합니다. afterName이 설정된 경우 이름이 같은 경우 항목이 누락되지 않도록 필수입니다. |
Response
Returns: PageUsersOfflineResponse
반환: PageUsersOfflineResponse
Example

getOnlineUsers 
현재 페이지에 온라인인 뷰어: 현재 웹소켓 세션이 페이지에 구독된 사람들입니다.
anonCount + totalCount(방 전체 구독자, 열거하지 않는 익명 뷰어 포함)를 반환합니다.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | 페이지 URL 식별자 (서버 측에서 정리됨). |
| afterName | string | query | No | 커서: 이전 응답에서 nextAfterName을 전달합니다. |
| afterUserId | string | query | No | 커서 타이브레이커: 이전 응답에서 nextAfterUserId을 전달합니다. afterName이 설정된 경우 이름이 같은 경우 항목이 누락되지 않도록 필요합니다. |
Response
Returns: PageUsersOnlineResponse
Example

getPageByURLId 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| urlId | string | query | 예 |
응답
반환: GetPageByURLIdAPIResponse
예시

getPages 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
응답
반환: GetPagesAPIResponse
예시

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | 이전 요청에서 nextCursor 로 반환된 불투명한 페이지네이션 커서. 동일한 sortBy 와 연결됩니다. |
| limit | integer | query | No | 1..200, default 50 |
| q | string | query | No | 대소문자를 구분하지 않는 선택적 제목 접두어 필터. |
| sortBy | string | query | No | 정렬 순서. updatedAt (기본값, 최신 순), commentCount (댓글 수 많은 순), 또는 title (알파벳 순). |
| hasComments | boolean | query | No | true인 경우, 최소 하나의 댓글이 있는 페이지만 반환합니다. |
Response
Returns: GetPublicPagesResponse
Example

getUsersInfo 
Bulk 사용자 정보는 테넌트 단위로 제공됩니다. userIds가 주어지면 User / SSOUser의 표시 정보를 반환합니다.
댓글 위젯에서 방금 존재 이벤트를 통해 나타난 사용자를 풍부하게 표시하는 데 사용됩니다.
페이지 컨텍스트가 없으며: 프라이버시가 일관되게 적용됩니다(비공개 프로필은 마스킹됩니다).
Parameters
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| ids | string | query | 예 | 쉼표로 구분된 userIds. |
Response
반환: PageUsersInfoResponse
예시

patchPage 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환값: PatchPageAPIResponse
예시

deletePendingWebhookEvent 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: APIEmptyResponse
예시

getPendingWebhookEventCount 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | query | 아니오 | |
| externalId | string | query | 아니오 | |
| eventType | string | query | 아니오 | |
| type | string | query | 아니오 | |
| domain | string | query | 아니오 | |
| attemptCountGT | number | query | 아니오 |
응답
반환: GetPendingWebhookEventCountResponse
Example

getPendingWebhookEvents 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | query | 아니오 | |
| externalId | string | query | 아니오 | |
| eventType | string | query | 아니오 | |
| type | string | query | 아니오 | |
| domain | string | query | 아니오 | |
| attemptCountGT | number | query | 아니오 | |
| skip | number | query | 아니오 |
응답
반환: GetPendingWebhookEventsResponse
예시

createQuestionConfig 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
응답
반환: CreateQuestionConfigResponse
예시

deleteQuestionConfig 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | 쿼리 | 예 | |
| id | string | 경로 | 예 |
Response
반환: APIEmptyResponse
Example

getQuestionConfig 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
반환: GetQuestionConfigResponse
Example

getQuestionConfigs 
매개 변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
응답
반환: GetQuestionConfigsResponse
예제

updateQuestionConfig 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: APIEmptyResponse
예시

createQuestionResult 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
반환: CreateQuestionResultResponse
예시

deleteQuestionResult 
Parameters
| 이름 | 타입 | 위치 | 필요 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
Response
반환: APIEmptyResponse
Example

getQuestionResult 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: GetQuestionResultResponse
예시

getQuestionResults 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| urlId | string | query | 아니오 | |
| userId | string | query | 아니오 | |
| startDate | string | query | 아니오 | |
| questionId | string | query | 아니오 | |
| questionIds | string | query | 아니오 | |
| skip | number | query | 아니오 |
응답
반환: GetQuestionResultsResponse
예시

updateQuestionResult 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
반환: APIEmptyResponse
Example

aggregateQuestionResults 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
응답
반환값: AggregateQuestionResultsResponse
예시

bulkAggregateQuestionResults 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| forceRecalculate | boolean | query | 아니오 |
Response
반환값: BulkAggregateQuestionResultsResponse
예시

combineCommentsWithQuestionResults 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
응답
반환: CombineQuestionResultsWithCommentsResponse
예시

addSSOUser 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
응답
반환: AddSSOUserAPIResponse
예제

deleteSSOUser 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
응답
Returns: DeleteSSOUserAPIResponse
예시

getSSOUserByEmail 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| string | path | 예 |
Response
반환: GetSSOUserByEmailAPIResponse
Example

getSSOUserById 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: GetSSOUserByIdAPIResponse
예시

getSSOUsers 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| skip | integer | query | 아니오 |
응답
반환: GetSSOUsersResponse
예제

patchSSOUser 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| updateComments | boolean | query | 아니오 |
응답
반환: PatchSSOUserAPIResponse
예시

putSSOUser 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
응답
반환: PutSSOUserAPIResponse
예시

createSubscription 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
Returns: CreateSubscriptionAPIResponse
예시

deleteSubscription 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
응답
반환: DeleteSubscriptionAPIResponse
예시

getSubscriptions 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No |
응답
반환: GetSubscriptionsAPIResponse
예시

updateSubscription 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| userId | string | query | 아니오 |
응답
반환: UpdateSubscriptionAPIResponse
예시

getTenantDailyUsages 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Response
반환: GetTenantDailyUsagesResponse
Example

createTenantPackage 
Parameters
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
반환값: CreateTenantPackageResponse
예시

deleteTenantPackage 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: APIEmptyResponse
예시

getTenantPackage 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
Returns: GetTenantPackageResponse
예시

getTenantPackages 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| skip | number | query | 아니오 |
응답
반환: GetTenantPackagesResponse
예시

replaceTenantPackage 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: APIEmptyResponse
예시

updateTenantPackage 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: APIEmptyResponse
예시

createTenantUser 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
반환: CreateTenantUserResponse
예시

deleteTenantUser 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
응답
반환: APIEmptyResponse
예시

getTenantUser 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: GetTenantUserResponse
예제

getTenantUsers 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
응답
반환값: GetTenantUsersResponse
예시

replaceTenantUser 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
응답
반환: APIEmptyResponse
예제

sendLoginLink 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
응답
반환: APIEmptyResponse
예시

updateTenantUser 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| updateComments | string | query | 아니오 |
Response
반환: APIEmptyResponse
Example

createTenant 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
반환: CreateTenantResponse
예시

deleteTenant 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| sure | string | query | 아니오 |
응답
반환: APIEmptyResponse
예시

getTenant 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: GetTenantResponse
예제

getTenants 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
응답
반환: GetTenantsResponse
예시

updateTenant 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
Returns: APIEmptyResponse
예시

changeTicketState 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: ChangeTicketStateResponse
예시

createTicket 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes |
응답
반환: CreateTicketResponse
예시

getTicket 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
응답
반환: GetTicketResponse
예제

getTickets 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
응답
Returns: GetTicketsResponse
예제

getTranslations 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| namespace | string | path | 예 | |
| component | string | path | 예 | |
| locale | string | query | 아니오 | |
| useFullTranslationIds | boolean | query | 아니오 |
Response
반환: GetTranslationsResponse
예시

uploadImage 
이미지 업로드 및 리사이즈
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Size preset: "Default" (1000x1000px) or "CrossPlatform" (creates sizes for popular devices) |
| urlId | string | query | No | Page id that upload is happening from, to configure |
Response
Returns: UploadImageResponse
Example

getUserBadgeProgressById 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: APIGetUserBadgeProgressResponse
예시

getUserBadgeProgressByUserId 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | path | 예 |
응답
반환: APIGetUserBadgeProgressResponse
예시

getUserBadgeProgressList 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 아니오 | |
| limit | number | query | 아니오 | |
| skip | number | query | 아니오 |
응답
반환: APIGetUserBadgeProgressListResponse
예시

createUserBadge 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
응답
반환: APICreateUserBadgeResponse
예제

deleteUserBadge 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: APIEmptySuccessResponse
예시

getUserBadge 
파라미터
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: APIGetUserBadgeResponse
예시

getUserBadges 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 아니오 | |
| badgeId | string | query | 아니오 | |
| type | number | query | 아니오 | |
| displayedOnComments | boolean | query | 아니오 | |
| limit | number | query | 아니오 | |
| skip | number | query | 아니오 |
응답
반환: APIGetUserBadgesResponse
예시

updateUserBadge 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: APIEmptySuccessResponse
예시

getUserNotificationCount 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: GetUserNotificationCountResponse
예시

getUserNotifications 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | 현재 페이지가 구독되는지 여부를 판단하는 데 사용됩니다. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
응답
반환: GetMyNotificationsResponse
예제

resetUserNotificationCount 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: ResetUserNotificationsResponse
예제

resetUserNotifications 
파라미터
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| afterId | string | query | 아니오 | |
| afterCreatedAt | integer | query | 아니오 | |
| unreadOnly | boolean | query | 아니오 | |
| dmOnly | boolean | query | 아니오 | |
| noDm | boolean | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: ResetUserNotificationsResponse
예시

updateUserNotificationCommentSubscriptionStatus 
특정 댓글에 대한 알림을 활성화하거나 비활성화합니다.
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
응답
반환: UpdateUserNotificationCommentSubscriptionStatusResponse
예시

updateUserNotificationPageSubscriptionStatus 
페이지에 대한 알림을 활성화하거나 비활성화합니다. 사용자가 페이지에 구독하면 새로운 루트 댓글에 대해 알림이 생성되고, 또한
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
응답
반환: UpdateUserNotificationPageSubscriptionStatusResponse
예시

updateUserNotificationStatus 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| notificationId | string | path | 예 | |
| newStatus | string | path | 예 | |
| sso | string | query | 아니오 |
응답
반환: UpdateUserNotificationStatusResponse
예시

getUserPresenceStatuses 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
응답
반환: GetUserPresenceStatusesResponse
예시

searchUsers 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | |
| usernameStartsWith | string | query | 아니오 | |
| mentionGroupIds | array | query | 아니오 | |
| sso | string | query | 아니오 | |
| searchSection | string | query | 아니오 |
응답
반환: SearchUsersResult
예시

getUser 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: GetUserResponse
예제

createVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
반환: VoteResponse
Example

deleteVote 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| editKey | string | query | 아니오 |
Response
반환: VoteDeleteResponse
Example

getVotes 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
응답
반환: GetVotesResponse
예시

getVotesForUser 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
응답
반환: GetVotesForUserResponse
예시

도움이 필요하신가요?
Dart SDK와 관련하여 문제가 발생하거나 질문이 있으시면, 다음을 이용해주세요:
기여하기
기여를 환영합니다! 기여 가이드라인은 GitHub 저장소를 방문해 주세요.