
언어 🇰🇷 한국어
문서
시작하기
API 레퍼런스
에이전트 테넌트
집계
감사 로그
인증
배치 작업
댓글 차단
차단된 댓글 확인
댓글
사용자 댓글
도메인 설정
이메일 템플릿
이벤트 로그
피드 게시물
댓글 신고
GIF
해시태그
내 정보
모더레이션
모더레이터
알림 수
알림
페이지 반응
페이지
보류 중인 웹훅 이벤트
투표
질문 설정
질문 결과
질문 결과 집계
SSO 사용자
구독
테넌트 일일 사용량
테넌트 패키지
테넌트 사용자
테넌트
티켓
번역
이미지 업로드
사용자 배지 진행
사용자 배지
사용자 알림
사용자 상태
사용자 검색
사용자
웹훅
FastComments Swift SDK
이것은 FastComments용 공식 Swift SDK입니다.
FastComments API용 공식 Swift SDK
저장소
AI 코딩 에이전트 
코딩 에이전트에게 FastComments 컨텍스트를 제공하세요 - 위젯, 구성, Secure SSO, REST API 및 SDK:
npx skills add fastcomments/skills
Claude Code, Codex, Cursor, Copilot, Gemini 및 모든 다른 에이전트와 skills CLI에서 지원됩니다.
설치 
Swift Package Manager
Package.swift 파일에 다음을 추가하세요:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
또는 Xcode에서:
- File > Add Packages... 선택
- 저장소 URL 입력:
https://github.com/fastcomments/fastcomments-swift.git - 사용하려는 버전 선택
요구 사항
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
라이브러리 내용 
The FastComments Swift SDK는 여러 모듈로 구성되어 있습니다:
-
Client Module - FastComments REST API용 API 클라이언트
- 모든 API 모델에 대한 완전한 타입 정의
- 인증된 (
DefaultAPI), 공개 (PublicAPI), 및 모더레이션 (ModerationAPI) 메서드 - 완전한 async/await 지원
- 자세한 API 문서는 client/README.md를 참조하세요
-
SSO Module - 서버 측 Single Sign-On 유틸리티
- 사용자 인증을 위한 보안 토큰 생성
- 단순 SSO 모드와 보안 SSO 모드 모두 지원
- CryptoKit을 사용한 HMAC-SHA256 기반 토큰 서명
빠른 시작 
공용 API 사용
import FastCommentsSwift
// 페이지에 대한 댓글 가져오기
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
인증된 API 사용
import FastCommentsSwift
// 공유 구성에 API 키를 설정합니다 (x-api-key 헤더로 전송)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// 인증된 API를 사용하여 댓글 가져오기
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
모더레이션 API 사용
import FastCommentsSwift
// 모더레이션 메서드는 행동 중인 모더레이터를 위한 `sso` 토큰으로 인증됩니다
// (FastCommentsSSO로 생성, 위의 SSO 섹션을 참조하세요).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
인증을 위한 SSO 사용
보안 SSO (프로덕션 권장)
import FastCommentsSwift
let apiKey = "your-api-key"
// 보안 SSO 사용자 데이터 생성 (서버 측 전용!)
let userData = SecureSSOUserData(
id: "user-123", // 사용자 ID
email: "user@example.com", // 이메일
username: "johndoe", // 사용자명
avatar: "https://example.com/avatar.jpg" // 아바타 URL
)
// SSO 토큰 생성
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// 이 토큰을 프론트엔드에 전달하여 인증합니다
} catch {
print("Error creating SSO token: \(error)")
}
간단한 SSO (개발/테스트용)
import FastCommentsSwift
// 간단한 SSO 사용자 데이터 생성 (API 키 불필요)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// 간단한 SSO 토큰 생성
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API 클라이언트 
The FastComments SDK는 세 개의 API 클라이언트를 제공합니다:
PublicAPI - 클라이언트 안전 메서드
PublicAPI는 클라이언트 측 코드(iOS/macOS 앱)에서 호출해도 안전한 메서드를 포함합니다. 이러한 메서드:
- API 키가 필요하지 않습니다
- 인증을 위해 SSO 토큰을 사용할 수 있습니다
- 사용자/디바이스당 속도 제한이 적용됩니다
- 최종 사용자용 애플리케이션에 적합합니다
Example use case: iOS 앱에서 댓글을 가져오고 생성하기
DefaultAPI - 서버 측 메서드
DefaultAPI는 인증된 메서드를 포함하며 API 키가 필요합니다. 이러한 메서드:
- FastComments API 키가 필요합니다
- 서버 측 코드에서만 호출되어야 합니다
- FastComments 데이터에 대한 전체 접근 권한을 제공합니다
- 테넌트당 속도 제한이 적용됩니다
Example use case: 관리 작업, 대량 데이터 내보내기, 사용자 관리
ModerationAPI - 중재자 대시보드 메서드
ModerationAPI는 실시간 및 빠른 중재 API의 광범위한 스위트를 제공합니다. 모든 ModerationAPI 메서드는 sso 매개변수를 받아들이며 SSO 또는 FastComments.com 세션 쿠키를 통해 인증할 수 있습니다.
Example use case: 커뮤니티 중재자를 위한 중재 경험 구축
IMPORTANT: 절대 클라이언트 측 코드에 API 키를 노출하지 마세요. API 키는 서버 측에서만 사용해야 합니다.
API 호출 만들기 
Swift SDK는 모든 API 호출에 대해 최신 async/await 구문을 사용합니다:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
일반적인 문제 
401 인증되지 않음 오류
인증된 API를 사용할 때 401 오류가 발생하는 경우:
- API 키 확인: FastComments 대시보드에서 올바른 API 키를 사용하고 있는지 확인하세요
- 테넌트 ID 확인: 테넌트 ID가 귀하의 계정과 일치하는지 확인하세요
- API 키 형식: API 키는 공유 설정의
x-api-key헤더로 설정해야 합니다:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- 잘못된 API 사용: 인증이 필요한 호출에는
PublicAPI가 아닌DefaultAPI를 사용하고 있는지 확인하세요
SSO 토큰 문제
SSO 토큰이 작동하지 않는 경우:
- 프로덕션에서는 보안 모드 사용: 프로덕션 환경에서는 항상 API 키와 함께
FastCommentsSSO.createSecure()를 사용하세요 - 서버 사이드에서만 생성: 보안 SSO 토큰은 서버에서 생성하고, API 키를 클라이언트에 노출하지 마세요
- 사용자 데이터 확인: 필수 필드(id, email, username)가 모두 제공되었는지 확인하세요
- 토큰 만료: 보안 SSO 토큰에는 타임스탬프가 포함되어 있으며 만료될 수 있습니다. 필요할 때마다 새 토큰을 생성하세요.
SSL/TLS 오류
SSL/TLS 오류가 발생하는 경우:
- 앱의 Info.plist에서 fastcomments.com으로의 HTTPS 연결이 허용되어 있는지 확인하세요
- 연결을 차단할 수 있는 App Transport Security 예외를 사용하고 있지 않은지 확인하세요
노트 
브로드캐스트 ID
일부 API 호출에서 broadcastId를 전달해야 한다는 것을 보게 됩니다. 이벤트를 수신하면 이 ID가 다시 반환되므로, 클라이언트에서 낙관적으로 변경을 적용하려는 경우(가장 좋은 사용자 경험을 제공하므로 아마 그렇게 하게 될 것입니다) 해당 이벤트를 무시할 수 있습니다. 여기에는 UUID를 전달하세요. 이 ID는 세션 내에서 두 번 발생하지 않을 만큼 충분히 고유해야 합니다.
let broadcastId = UUID().uuidString
createAgentTenant 
사람의 가입 절차 없이 AI 에이전트를 위한 새 체험 계정을 생성합니다. 이 호출에는 API 키가 필요하지 않습니다.
응답에는 테넌트 ID, REST API 및 MCP 서버에 즉시 사용할 수 있는 API 키, 그리고 클레임 URL이 포함됩니다. 클레임 URL은 작업 대상인 사람에게 전달하세요: FastComments에 로그인한 상태에서 해당 URL을 열면 계정이 그 사람에게 연결됩니다. 클레임되지 않은 계정과 해당 키는 생성 후 72시간 후에 삭제됩니다. 클레임되기 전까지 계정에는 표준 체험 제한이 적용됩니다.
응답
반환값: CreateAgentTenantResponse
예제

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 | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
응답
Returns: AggregateResponse
예제

getAuditLogs 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | 감사 로그를 읽을 테넌트. |
| limit | integer | query | No | 반환할 로그 수. 최대 10000, 기본값은 1000. |
| skip | integer | query | No | 페이지 매김을 위해 건너뛸 로그 수. |
| order | string | query | No | 이벤트 시간에 대한 정렬 방향. 기본값은 DESC (최신 순). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | 이 사용자 이름으로 수행된 이벤트만 반환. |
| ip | string | query | No | 이 IP 주소에서 발생한 이벤트만 반환. |
| crudType | string | query | No | 이 유형(c, r, u, d, login)의 이벤트만 반환. |
| resourceName | string | query | No | 이 리소스(예: User 또는 Moderator)의 이벤트만 반환. |
| targetId | string | query | No | 영향을 받은 객체가 이 ID를 가진 이벤트만 반환. |
| target | string | query | No | 영향을 받은 객체의 라벨(예: 사용자 이름 또는 이메일)에 대한 대소문자 구분 없는 부분 문자열 매치. |
| includeManagedTenants | boolean | query | No | 이 테넌트가 관리하는 테넌트의 이벤트도 반환. |
응답
예시

logoutPublic 
응답
반환: APIEmptyResponse
예제

getBatchJob 
배치 작업의 상태, 진행 상황 및 완료 시 결과.
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
예시

getBatchJobs 
The tenant's batch jobs (imports, exports, page migrations...), newest first.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| type | string | query | No | 예를 들어 migrate-pages와 같은 해당 유형의 작업만. |
| status | string | query | No | 요청됨, 실행 중, 성공 또는 실패 상태인 작업만. |
| skip | integer | query | No | 페이지 매김을 위해 건너뛸 작업 수. |
Response
Returns: GetBatchJobsAPIResponse
예시

blockFromCommentPublic 
매개변수
| 이름 | Type | Location | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| sso | string | query | 아니요 |
응답
반환: BlockSuccess
예제

unBlockCommentPublic 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| sso | string | query | 아니오 |
응답
반환: UnblockSuccess
예제

checkedCommentsForBlocked 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentIds | string | query | 예 | 쉼표로 구분된 댓글 ID 목록입니다. |
| sso | string | query | 아니오 |
응답
반환: CheckBlockedCommentsResponse
예제

blockUserFromComment 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
응답
Returns: BlockSuccess
예제

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

deleteComment 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
응답
예시

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

deleteCommentVote 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| 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 |
응답
예시

flagComment 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
응답
예시

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

getComments 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | 아니오 |
Response
Example

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

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

getCommentVoteUserNames 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| dir | integer | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: GetCommentVoteUserNamesSuccessResponse
예제

lockComment 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| broadcastId | string | query | 예 | |
| sso | string | query | 아니요 |
응답
반환: APIEmptyResponse
예제

pinComment 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| broadcastId | string | query | 예 | |
| sso | string | query | 아니오 |
응답
반환: ChangeCommentPinStatusResponse
예제

saveComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| isLive | boolean | query | 아니오 | |
| doSpamCheck | boolean | query | 아니오 | |
| sendEmails | boolean | query | 아니오 | |
| populateNotifications | boolean | query | 아니오 |
응답
예제

saveCommentsBulk 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
응답
반환: [SaveCommentsBulkResponse]
예시

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

translateComments 
주어진 댓글을 위젯 로케일로 번역합니다. 일치하는 위젯 사용자 정의 규칙에서 댓글 번역이 자동 또는 수동으로 설정된 경우에만 사용할 수 있습니다.
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | |
| sso | string | query | 아니오 | |
| locale | string | query | 아니오 |
응답
반환: CommentTranslationsResponse
예시

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

unFlagComment 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
응답
예제

unLockComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | 경로 | 예 | |
| commentId | string | 경로 | 예 | |
| broadcastId | string | 쿼리 | 예 | |
| sso | string | 쿼리 | 아니요 |
응답
반환: APIEmptyResponse
예제

unPinComment 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| broadcastId | string | query | 예 | |
| sso | string | query | 아니요 |
응답
반환: ChangeCommentPinStatusResponse
예제

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

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

getCommentsForUser 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| userId | string | query | 아니오 | |
| direction | string | query | 아니오 | |
| repliesToUserId | string | query | 아니오 | |
| page | number | query | 아니오 | |
| includei10n | boolean | query | 아니오 | |
| locale | string | query | 아니오 | |
| isCrawler | boolean | query | 아니오 |
응답
Returns: GetCommentsForUserResponse
예시

addDomainConfig 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
예제

deleteDomainConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| domain | string | path | 예 |
Response
반환: DeleteDomainConfigResponse
Example

getDomainConfig 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| domain | string | path | 예 |
응답
예제

getDomainConfigs 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
예제

patchDomainConfig 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
응답
예제

putDomainConfig 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| domainToUpdate | string | path | 예 |
응답
예제

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

deleteEmailTemplate 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
응답
반환: APIEmptyResponse
예제

deleteEmailTemplateRenderError 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | 쿼리 | 예 | |
| id | string | 경로 | 예 | |
| errorId | string | 경로 | 예 |
응답
반환: APIEmptyResponse
예제

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

getEmailTemplateDefinitions 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 |
Response
반환: GetEmailTemplateDefinitionsResponse
Example

getEmailTemplateRenderErrors 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| skip | number | query | 아니오 |
응답
반환: GetEmailTemplateRenderErrorsResponse
예제

getEmailTemplates 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| skip | number | query | 아니오 |
응답
예제

renderEmailTemplate 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| locale | string | query | 아니요 |
응답
반환: 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 |
응답
예제

getGlobalEventLog 
req tenantId urlId userIdWS
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | No |
응답
예제

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

createFeedPostPublic 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
예시

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

getFeedPosts 
req tenantId afterId
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
응답
예시

getFeedPostsPublic 
req tenantId afterId
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| afterId | string | query | 아니오 | |
| limit | integer | query | 아니오 | |
| tags | array | query | 아니오 | |
| sso | string | query | 아니오 | |
| isCrawler | boolean | query | 아니오 | |
| includeUserInfo | boolean | query | 아니오 |
응답
예제

getFeedPostsStats 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| postIds | array | query | 예 | |
| sso | string | query | 아니요 |
응답
예제

getUserReactsPublic 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
응답
예시

reactFeedPostPublic 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
응답
예시

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

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

flagCommentPublic 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| isFlagged | boolean | query | 예 | |
| sso | string | query | 아니요 |
응답
반환: APIEmptyResponse
예제

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

getGifsSearch 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
응답
예시

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

addHashTag 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
Response
예시

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

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

getHashTags 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| page | number | query | 아니요 |
응답
예제

patchHashTag 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Response
Example

getMe 
사용 중인 자격 증명을 식별합니다: 해당 자격 증명이 속한 테넌트와, OAuth 토큰의 경우 이를 승인한 사용자를 나타냅니다. 통합 기능은 이를 사용하여 연결을 테스트하고 레이블을 지정합니다.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
반환 값: GetMeResponse
Example

deleteModerationVote 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| voteId | string | path | 예 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
예제

getApiComments 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| page | number | query | 아니요 | |
| count | number | query | 아니요 | |
| text-search | string | query | 아니요 | |
| byIPFromComment | string | query | 아니요 | |
| filters | string | query | 아니요 | |
| searchFilters | string | query | 아니요 | |
| sorts | string | query | 아니요 | |
| demo | boolean | query | 아니요 | |
| sso | string | query | 아니요 |
Response
Returns: ModerationAPIGetCommentsResponse
Example

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

getApiIds 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Response
반환: ModerationAPIGetCommentIdsResponse
Example

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

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

getCommentChildren 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | 예 | |
| sso | string | query | 아니오 |
응답
반환: GetBannedUsersCountResponse
예제

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

getManualBadges 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| sso | string | query | 아니오 |
응답
Returns: GetTenantManualBadgesResponse
예제

getManualBadgesForUser 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| badgesUserId | string | query | 아니오 | |
| commentId | string | query | 아니오 | |
| sso | string | query | 아니오 |
Response
반환: GetUserManualBadgesResponse
Example

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

getModerationCommentText 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| sso | string | query | 아니오 |
응답
예시

getPreBanSummary 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| 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 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| value | string | query | 아니오 | |
| filters | string | query | 아니오 | |
| searchFilters | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: ModerationCommentSearchResponse
예시

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

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

getSearchSuggest 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
응답
예시

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

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

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

getUserInternalProfile 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: GetUserInternalProfileResponse
예시

postAdjustCommentVotes 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
예시

postApiExport 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
응답
예시

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 |
응답
예시

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

postBulkPreBanSummary 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| includeByUserIdAndEmail | boolean | query | 아니오 | |
| includeByIP | boolean | query | 아니오 | |
| includeByEmailDomain | boolean | query | 아니오 | |
| sso | string | query | 아니오 |
응답
예시

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

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

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

postRestoreDeletedComment 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
Response
Returns: APIEmptyResponse
Example

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

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

postSetCommentSpamStatus 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 | |
| spam | boolean | query | 아니오 | |
| permNotSpam | boolean | query | 아니오 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: APIEmptyResponse
예시

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

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

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

putAwardBadge 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| badgeId | string | query | 예 | |
| userId | string | query | 아니오 | |
| commentId | string | query | 아니오 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
예제

putCloseThread 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
응답
Returns: 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 |
응답
예시

putReopenThread 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| urlId | string | query | 예 | |
| sso | string | query | 아니오 |
Response
반환: APIEmptyResponse
Example

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

createModerator 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
예제

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

getModerator 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
예제

getModerators 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| skip | number | query | 아니오 |
응답
예제

sendInvite 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| fromName | string | query | 예 |
응답
반환: APIEmptyResponse
예제

updateModerator 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: APIEmptyResponse
예제

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

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

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

getNotifications 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 아니오 | |
| urlId | string | query | 아니오 | |
| fromCommentId | string | query | 아니오 | |
| viewed | boolean | query | 아니오 | |
| type | string | query | 아니오 | |
| skip | number | query | 아니오 |
응답
예시

updateNotification 
매개변수
| 이름 | Type | Location | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| userId | string | query | 아니요 |
응답
반환: APIEmptyResponse
예제

createV1PageReact 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | |
| title | string | query | 아니오 | |
| sso | string | query | 아니오 |
Response
예시

createV2PageReact 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No | |
| sso | string | query | No |
응답
예시

deleteV1PageReact 
Parameters
| 이름 | 유형 | Location | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | |
| sso | string | query | 아니오 |
Response
Example

deleteV2PageReact 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | |
| id | string | query | 예 | |
| sso | string | query | 아니오 |
응답
예시

getV1PageLikes 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | 설정하면 페이지에 좋아요를 누른 사용자를 반환합니다 (아바타와 사용자 이름). Only "public"만 허용되며, 이는 비공개 프로필을 제외합니다. |
응답
반환: GetV1PageLikes
예시

getV2PageReacts 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | 설정하면 각 react id에 대한 사용자(아바타와 사용자 이름)를 반환합니다. "public"만 허용되며, 이는 비공개 프로필을 제외합니다. |
Response
반환: GetV2PageReacts
Example

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

addPage 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
예제

deletePage 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
예제

getOfflineUsers 
현재 온라인 상태가 아닌, 해당 페이지의 과거 댓글 작성자입니다. displayName 기준으로 정렬됩니다. "멤버" 섹션을 렌더링할 때 /users/online을 모두 조회한 후 이 엔드포인트를 사용하세요. commenterName 기준 커서 페이지네이션: 서버는 부분 인덱스 {tenantId, urlId, commenterName}을 afterName부터 $gt로 순회하며, $skip 비용이 없습니다.
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | 페이지 URL 식별자(서버에서 정리됨). |
| afterName | string | query | 아니요 | 커서: 이전 응답의 nextAfterName을 전달하세요. |
| afterUserId | string | query | 아니요 | 커서 동점 결정자: 이전 응답의 nextAfterUserId를 전달하세요. afterName이 설정된 경우 이름이 같은 항목이 누락되지 않도록 필수입니다. |
응답
예제

getOnlineUsers 
현재 페이지에 온라인으로 있는 시청자: 현재 웹소켓 세션이 해당 페이지에 구독된 사람들.
익명 카운트와 총 카운트(방 전체 구독자, 우리가 열거하지 않는 익명 시청자 포함)를 반환합니다.
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| urlId | string | query | 예 | 페이지 URL 식별자 (서버 측에서 정리됨). |
| afterName | string | query | 아니오 | 커서: 이전 응답에서 nextAfterName을 전달합니다. |
| afterUserId | string | query | 아니오 | 커서 동점 해소: 이전 응답에서 nextAfterUserId를 전달합니다. afterName이 설정된 경우 이름 동점으로 인한 항목 손실을 방지하기 위해 필요합니다. |
Response
예시

getPageByURLId 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
응답
예제

getPageLikes 
페이지의 좋아요 수, 선택적으로 좋아요를 누른 사용자를 포함합니다.
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| urlId | string | query | 예 | |
| includeUserInfo | string | query | 아니요 | "public"은 비공개 프로필 사용자를 제외하고, "include-private"은 포함합니다. |
응답
예제

getPageReacts 
페이지에 대한 사용자 지정 리액트 카운트, 선택적으로 리액트한 사용자 포함.
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| urlId | string | query | 예 | |
| includeUserInfo | string | query | 아니요 | "public"은 비공개 프로필 사용자를 생략하고, "include-private"은 포함합니다. |
응답
예제

getPages 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
예제

getPagesPublic 
테넌트의 페이지 목록을 조회합니다. FChat 데스크톱 클라이언트에서 방 목록을 채우는 데 사용됩니다.
각 페이지의 확인된 커스텀 설정에서 enableFChat이 true여야 합니다.
SSO가 필요한 페이지는 요청 사용자의 그룹 접근 권한을 기준으로 필터링됩니다.
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| cursor | string | query | 아니요 | 이전 요청에서 nextCursor로 반환된 불투명한 페이지네이션 커서입니다. 동일한 sortBy에 연결됩니다. |
| limit | integer | query | 아니요 | 1..200, 기본값 50 |
| q | string | query | 아니요 | 선택 사항인 대소문자를 구분하지 않는 제목 접두사 필터입니다. |
| sortBy | string | query | 아니요 | 정렬 순서. updatedAt (기본값, 최신순), commentCount (댓글 많은순), 또는 title (알파벳순). |
| hasComments | boolean | query | 아니요 | true인 경우, 댓글이 하나 이상 있는 페이지만 반환합니다. |
응답
예제

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

migratePages 
하나의 urlId 또는 도메인에서 다른 urlId 또는 도메인으로 댓글, 페이지 및 관련 레코드를 이동하는 배치 작업을 큐에 추가합니다. "urlId" 마이그레이션은 정확히 일치하는 urlId만 대상으로 합니다. "domain" 마이그레이션은 모든 urlId와 url 내에서 값을 찾아 교체합니다. GET /api/v1/batch-jobs/{batchJobId}를 폴링하세요: 완료되면 마이그레이션별 결과와 undoId를 포함합니다.
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
반환값: QueuePageMigrationJobAPIResponse
예제

patchPage 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
예제

undoPageMigrations 
배치 작업을 큐에 넣어 하나의 migrate-pages 작업에서 발생한 모든 마이그레이션을 최신 순으로 역전시킵니다. 작업은 90일 동안 사용할 수 있습니다.
마이그레이션 이후 변경된 레코드는 그대로 유지되므로, 이후 편집이 덮어쓰여지지 않습니다.
복원/건너뛴 수를 확인하려면 GET /api/v1/batch-jobs/{batchJobId}를 폴링하세요.
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| undoId | string | path | Yes |
응답
반환: QueuePageMigrationJobAPIResponse
예시

deletePendingWebhookEvent 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
예시

getPendingWebhookEvents 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
응답
반환: GetPendingWebhookEventsResponse
예제

createPollVote 
투표(poll)에 새 투표를 기록하거나, 기존 투표를 다른 옵션으로 이동합니다. 투표자는 투표당 최대 하나의 표만 가질 수 있으므로, 동일한 투표자에 대해 이 API를 다시 호출하면 표가 추가되는 것이 아니라 기존 표가 이동됩니다.
이 API는 사이트의 투표 설정을 따릅니다. 로그인한 사용자만 투표할 수 있도록 설정된 경우 anonUserId만 포함한 투표는 거부되며, 익명 투표는 투표별로 IP당 속도 제한이 적용됩니다.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Example

deletePollVote 
투표를 취소합니다. 투표가 이루어진 옵션이 그 집계 수를 되돌려줍니다.
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | 문자열 | 쿼리 | 예 | |
| id | 문자열 | 경로 | 예 |
응답
예시

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

getPollVotes 
하나의 투표 집계 뒤에 있는 개별 투표 기록으로, 오래된 순서부터 정렬됩니다.
투표는 댓글에 속하므로, 투표 기록은 항상 한 번에 하나의 투표만 조회합니다 - commentId가 필수입니다. 이를 통해 모든 쿼리가 컬렉션이 이미 보유한 인덱스를 사용하게 됩니다.
투표의 프라이버시 설정을 따릅니다: 익명 투표의 기록은 여기서나 id로 조회할 수 없습니다 (poll-anonymous).
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | query | 예 | |
| voterId | string | query | 아니요 | |
| optionId | string | query | 아니요 | |
| skip | integer | query | 아니요 |
응답
반환값: GetPollVotesResponse
예제

deletePoll 
댓글에서 투표를 제거하며, 해당 투표에 대한 모든 투표 기록도 함께 삭제합니다. 댓글 자체는 그대로 유지됩니다.
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 |
응답
반환값: APIEmptyResponse
예제

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

getPollVoters 
Who voted for which option. Anonymous polls never answer, admins-only polls answer only for an admin or moderator.
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| urlId | string | query | 아니오 | |
| page | integer | query | 아니오 | |
| search | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: GetPollVoterNamesSuccessResponse
예시

patchPoll 
Edit a poll in place, keeping its tallies: change the question, relabel an option, close or reopen it, or change who may see the voters. Options are addressed by id - to add, remove or reorder them, PUT the full list.
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | path | 예 |
응답
반환: SavePollResponse
예시

putPoll 
Comment에 설문을 첨부하거나 이미 존재하는 설문의 전체 상태를 설정합니다.
옵션은 id로 매칭됩니다: 기존 옵션의 id와 함께 전송된 옵션은 투표 수를 유지하고(새 라벨과 위치를 적용), id 없이 전송된 옵션은 추가되며, 목록에 포함되지 않은 기존 옵션은 해당 옵션에 대한 투표와 함께 삭제됩니다.
투표가 있는 설문에서 기존 옵션 id를 전혀 남기지 않으면 모든 옵션이 삭제되므로, 이 경우 replaceVotes=true가 필요합니다.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| replaceVotes | boolean | query | No |
Response
반환: SavePollResponse
Example

votePoll 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | 예 | |
| commentId | string | path | 예 | |
| urlId | string | query | 아니오 | |
| broadcastId | string | query | 아니오 | |
| sso | string | query | 아니오 |
응답
반환: VotePollResponse
예제

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

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

getQuestionConfig 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
예제

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

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

createQuestionResult 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 |
Response
반환: CreateQuestionResultResponse
Example

deleteQuestionResult 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: APIEmptyResponse
예제

getQuestionResult 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | 쿼리 | 예 | |
| id | string | 경로 | 예 |
응답
예제

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

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

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 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| forceRecalculate | boolean | query | 아니요 |
응답
반환: BulkAggregateQuestionResultsResponse
예제

combineCommentsWithQuestionResults 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| 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 |
응답
예제

deleteSSOUser 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
응답
예시

getSSOUserByEmail 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| string | path | 예 |
응답
반환: GetSSOUserByEmailAPIResponse
예제

getSSOUserById 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
예제

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

patchSSOUser 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| updateComments | boolean | query | 아니요 |
응답
예제

putSSOUser 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| updateComments | boolean | query | 아니오 |
응답
예제

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

deleteSubscription 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| userId | string | query | 아니요 |
응답
반환: DeleteSubscriptionAPIResponse
예제

getSubscriptions 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 아니요 |
응답
반환: 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 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
반환: CreateTenantPackageResponse
예제

deleteTenantPackage 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환: APIEmptyResponse
예제

getTenantPackage 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
예제

getTenantPackages 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| skip | number | query | 아니요 |
응답
예제

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

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

createTenantUser 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
예제

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

getTenantUser 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
예제

getTenantUsers 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| skip | number | query | 아니요 |
응답
예제

replaceTenantUser 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| updateComments | string | query | 아니요 |
응답
반환: APIEmptyResponse
예제

sendLoginLink 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| redirectURL | string | query | 아니요 |
Response
반환: APIEmptyResponse
Example

updateTenantUser 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| updateComments | string | query | 아니오 |
응답
반환: APIEmptyResponse
예제

createTenant 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 |
응답
예시

deleteTenant 
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| sure | string | query | 아니요 |
응답
반환: APIEmptyResponse
예제

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

getTenants 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Response
Example

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

changeTicketState 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 예 | |
| id | string | path | 예 |
응답
반환값: ChangeTicketStateResponse
예제

createTicket 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 예 |
응답
예제

getTicket 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| userId | string | query | 아니요 |
Response
Example

getTickets 
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 아니오 | |
| state | number | query | 아니오 | |
| skip | number | query | 아니오 | |
| limit | number | query | 아니오 |
Response
Returns: GetTicketsResponse
Example

getTranslations 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| namespace | string | path | 예 | |
| component | string | path | 예 | |
| locale | string | query | 아니오 | |
| useFullTranslationIds | boolean | query | 아니오 |
Response
Returns: GetTranslationsResponse
Example

uploadImage 
이미지를 업로드하고 크기를 조정합니다
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | 크기 프리셋: "Default" (1000x1000px) 또는 "CrossPlatform" (인기 기기용 사이즈 생성) |
| urlId | string | query | No | 업로드가 발생하는 페이지 ID, 구성용 |
Response
Returns: UploadImageResponse
Example

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

getUserBadgeProgressByUserId 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | path | 예 |
응답
반환: APIGetUserBadgeProgressResponse
예제

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

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

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

getUserBadge 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
예제

getUserBadges 
Parameters
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| userId | string | query | 아니오 | |
| badgeId | string | query | 아니오 | |
| type | number | query | 아니오 | |
| displayedOnComments | boolean | query | 아니오 | |
| limit | number | query | 아니오 | |
| skip | number | query | 아니오 |
Response
Example

updateUserBadge 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
예제

getUserNotificationCount 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
응답
반환: ResetUserNotificationsResponse
예시

updateUserNotificationCommentSubscriptionStatus 
특정 댓글에 대한 알림을 활성화하거나 비활성화합니다.
매개변수
| 이름 | Type | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | 쿼리 | 예 | |
| notificationId | string | 경로 | 예 | |
| optedInOrOut | string | 경로 | 예 | |
| commentId | string | 쿼리 | 예 | |
| sso | string | 쿼리 | 아니요 |
응답
반환: UpdateUserNotificationCommentSubscriptionStatusResponse
예제

updateUserNotificationPageSubscriptionStatus 
페이지에 대한 알림을 활성화하거나 비활성화합니다. 사용자가 페이지를 구독하면 새 루트 댓글에 대한 알림이 생성되며, 또한
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| urlId | string | query | 예 | |
| url | string | query | 예 | |
| pageTitle | string | query | 예 | |
| subscribedOrUnsubscribed | string | path | 예 | |
| sso | string | query | 아니오 |
응답
반환: UpdateUserNotificationPageSubscriptionStatusResponse
예제

updateUserNotificationStatus 
매개변수
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| notificationId | string | path | 예 | |
| newStatus | string | path | 예 | |
| sso | string | query | 아니요 |
응답
반환: UpdateUserNotificationStatusResponse
예제

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

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

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

createVote 
매개변수
| 이름 | 형식 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| commentId | string | query | 예 | |
| direction | string | query | 예 | |
| userId | string | query | 아니오 | |
| anonUserId | string | query | 아니오 |
응답
반환: VoteResponse
예시

deleteVote 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 | |
| editKey | string | query | 아니요 |
응답
예제

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

getVotesForUser 
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| urlId | string | query | 예 | |
| userId | string | query | 아니오 | |
| anonUserId | string | query | 아니오 |
응답
예시

createWebhook 
URL을 댓글 이벤트에 구독합니다 (REST hook 구독). 동일한 URL을 동일한 이벤트와 도메인에 다시 구독하면 기존 구독이 반환됩니다. 전달은 HMAC 서명되며, 웹훅 가이드를 참조하십시오; 레거시 token 헤더는 API 구독에 절대 전송되지 않습니다.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreateWebhookResponse
Example

deleteWebhook 
구독 취소 (REST hook unsubscribe). 이 API를 통해 생성된 구독만 여기서 삭제할 수 있습니다; 대시보드에서 관리되는 웹훅은 대시보드에서 편집합니다.
매개변수
| 이름 | 타입 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| id | string | path | 예 |
응답
반환값: APIEmptyResponse
예제

getWebhooks 
테넌트에 구성된 웹훅을 나열합니다. 대시보드에서 관리되는 행과 API 구독 모두 포함됩니다.
매개변수
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | 예 | |
| event | string | query | 아니오 | |
| domain | string | query | 아니오 | |
| source | string | query | 아니오 | |
| skip | number | query | 아니오 |
응답
예시

getWebhookSamplePayloads 
Recent comments in exactly the shape webhook deliveries use, for building integrations (for example Zapier sample data). Every event delivers the same comment object, so event only has to be valid.
Parameters
| 이름 | 유형 | 위치 | 필수 | 설명 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| event | string | query | No | |
| limit | number | query | No |
응답
Returns: GetWebhookSamplePayloadsResponse
예시

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