
言語 🇯🇵 日本語
ドキュメント
はじめに
集計
監査ログ
認証
コメントからブロック
ブロックされたコメントの確認
コメント
ドメイン設定
メールテンプレート
イベントログ
フィード投稿
コメントのフラグ
GIF
ハッシュタグ
モデレーション
モデレーター
通知数
通知
ページリアクション
ページ
保留中のWebhookイベント
質問設定
質問結果
質問結果集計
SSOユーザー
サブスクリプション
テナントの日次使用量
テナントパッケージ
テナントユーザー
テナント
チケット
翻訳
画像アップロード
ユーザーバッジ進捗
ユーザーバッジ
ユーザー通知
ユーザー在席状態
ユーザー検索
ユーザー
投票
FastComments Java SDK
これは FastComments の公式 Java SDK です。
FastComments API の公式 Java SDK
リポジトリ
AI coding agents 
FastComments のコンテキスト(ウィジェット、設定、Secure SSO、REST API、SDK)をコーディングエージェントに提供します:
npx skills add fastcomments/skills
Claude Code、Codex、Cursor、Copilot、Gemini、そして他のすべてのエージェントで、skills CLI がサポートしています。
Installation 
Maven
Add the Repsy repository to your project's POM:
<repositories>
<repository>
<id>repsy</id>
<name>FastComments Maven Repository on Repsy</name>
<url>https://repo.repsy.io/mvn/winrid/fastcomments</url>
</repository>
</repositories>
Then add the dependencies you need:
<dependencies>
<!-- API Client -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>client</artifactId>
<version>3.0.1</version>
</dependency>
<!-- Core Library (includes SSO) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>core</artifactId>
<version>3.0.1</version>
</dependency>
<!-- PubSub Library (for live events) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>pubsub</artifactId>
<version>3.0.1</version>
</dependency>
</dependencies>
Gradle
Add the Repsy repository to your build.gradle file:
repositories {
mavenCentral()
maven {
url "https://repo.repsy.io/mvn/winrid/fastcomments"
}
}
dependencies {
// API Client
implementation "com.fastcomments:client:3.0.1"
// Core Library (includes SSO)
implementation "com.fastcomments:core:3.0.1"
// PubSub Library (for live events)
implementation "com.fastcomments:pubsub:3.0.1"
}
Library Contents
このライブラリは 3 つのモジュールで構成されています。生成された API クライアント、API の利用を容易にする手書きユーティリティを含むコア Java ライブラリ、そして変更フィードの購読用ライブラリである pubsub モジュールです。
Public vs Secured APIs
API クライアントには DefaultApi、PublicApi、ModerationApi の 3 つのクラスがあります。DefaultApi には API キーが必要なメソッドが含まれ、PublicApi には認証なしでブラウザやモバイルデバイスなどから直接呼び出せるメソッドが含まれます。
ModerationApi はライブかつ高速なモデレーション API の豊富なスイートを提供します。すべての ModerationApi メソッドは sso パラメータを受け取り、SSO または FastComments.com のセッションクッキーを使用して認証できます。
Quick Start 
認証されたAPIの使用 (DefaultApi)
重要: You must set your API key on the ApiClient before making authenticated requests. If you don't, requests will fail with a 401 error.
import com.fastcomments.invoker.ApiClient;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.api.DefaultApi;
import com.fastcomments.model.*;
public class Example {
public static void main(String[] args) {
// API クライアントを作成して設定します
ApiClient apiClient = new ApiClient();
// REQUIRED: Set your API key (get this from your FastComments dashboard)
apiClient.setApiKey("YOUR_API_KEY_HERE");
// 設定したクライアントで API インスタンスを作成します
DefaultApi api = new DefaultApi(apiClient);
// これで認証された API 呼び出しができます
try {
// 例: SSO ユーザーを追加
CreateAPISSOUserData userData = new CreateAPISSOUserData();
userData.setId("user-123");
userData.setEmail("user@example.com");
userData.setDisplayName("John Doe");
AddSSOUserAPIResponse response = api.addSSOUser("YOUR_TENANT_ID", userData)
.execute();
System.out.println("User created: " + response);
} catch (ApiException e) {
System.err.println("Error: " + e.getResponseBody());
// よくあるエラー:
// - 401: API キーが欠落しているか無効です
// - 400: リクエストの検証に失敗しました
}
}
}
パブリック API の使用 (PublicApi)
パブリックエンドポイントは認証を必要としません:
import com.fastcomments.api.PublicApi;
import com.fastcomments.invoker.ApiException;
PublicApi publicApi = new PublicApi();
try {
var response = publicApi.getCommentsPublic("YOUR_TENANT_ID", "page-url-id")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
モデレーション API の使用 (ModerationApi)
The ModerationApi drives the moderator dashboard. Each method accepts an sso parameter identifying the SSO-authenticated moderator on whose behalf the request is made:
import com.fastcomments.api.ModerationApi;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.model.*;
ModerationApi moderationApi = new ModerationApi();
try {
// 承認待ちのコメントを一覧表示
ModerationAPIGetCommentsResponse response = moderationApi.getApiComments()
.sso("YOUR_SSO_TOKEN")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
よくある問題
- 401 "missing-api-key" error: DefaultApi インスタンスを作成する前に
apiClient.setApiKey("YOUR_KEY")を呼び出していることを確認してください。 - Wrong API class: サーバー側の認証済みリクエストには
DefaultApiを、クライアント側/パブリックなリクエストにはPublicApiを使用してください。 - Null API key: SDK は API キーが null の場合に認証を静かにスキップするため、401 エラーが発生します。
Notes 
ブロードキャスト ID
一部の API 呼び出しでは broadcastId を渡す必要があるのが分かります。イベントを受け取ると、この ID が返されるので、クライアントに楽観的に変更を適用するつもりであれば、そのイベントを無視することができます
(ユーザー体験が最も良くなるため、おそらくそうするでしょう)。ここには UUID を渡してください。ID はブラウザセッション内で二度発生しない程度に十分ユニークである必要があります。
aggregate 
ドキュメントをグループ化して(groupBy が指定されている場合)複数の操作を適用して集計します。 異なる操作(例: sum、countDistinct、avg など)がサポートされています。
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| parentTenantId | string | query | いいえ | |
| includeStats | boolean | query | いいえ |
レスポンス
例

getAuditLogs 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
レスポンス
戻り値: GetAuditLogsResponse
例

logoutPublic 
レスポンス
戻り値: APIEmptyResponse
例

blockFromCommentPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
返却値: BlockSuccess
例

unBlockCommentPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| commentId | string | パス | はい | |
| sso | string | クエリ | いいえ |
レスポンス
戻り値: 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 |
レスポンス
返却: BlockSuccess
例

createCommentPublic 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: SaveCommentsResponseWithPresence
例

deleteComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
レスポンス
戻り値: DeleteCommentResult
例

deleteCommentPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返り値: PublicAPIDeleteCommentResponse
例

deleteCommentVote 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| voteId | string | path | はい | |
| urlId | string | query | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: VoteDeleteResponse
例

flagComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
戻り値: FlagCommentResponse
例

getComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

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 | いいえ |
レスポンス
例

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 | はい | |
| commentId | string | path | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: PublicAPIGetCommentTextResponse
例

getCommentVoteUserNames 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| dir | integer | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: GetCommentVoteUserNamesSuccessResponse
例

lockComment 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
レスポンス
戻り値: APIEmptyResponse
例

pinComment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
レスポンス
戻り値: ChangeCommentPinStatusResponse
例

saveComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| sendEmails | boolean | query | いいえ | |
| populateNotifications | boolean | query | いいえ |
レスポンス
例

saveCommentsBulk 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| sendEmails | boolean | query | いいえ | |
| populateNotifications | boolean | query | いいえ |
レスポンス
例

setCommentText 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: PublicAPISetCommentTextResponse
例

unBlockUserFromComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
戻り値: UnblockSuccess
例

unFlagComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
戻り値: FlagCommentResponse
例

unLockComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

unPinComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: ChangeCommentPinStatusResponse
例

updateComment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| contextUserId | string | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| isLive | boolean | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

voteComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| urlId | string | query | はい | |
| broadcastId | string | query | はい | |
| sessionId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: 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 | いいえ |
レスポンス
戻り値: GetCommentsForUserResponse
例

addDomainConfig 
パラメータ
| Name | Type | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
例

deleteDomainConfig 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domain | string | path | はい |
レスポンス
返却値: DeleteDomainConfigResponse
例

getDomainConfig 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domain | string | path | はい |
レスポンス
例

getDomainConfigs 
パラメータ
| 名前 | Type | Location | Required | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

patchDomainConfig 
パラメーター
| 名称 | Type | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domainToUpdate | string | path | はい |
レスポンス
戻り値: PatchDomainConfigResponse
例

putDomainConfig 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

deleteEmailTemplateRenderError 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| errorId | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

getEmailTemplate 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getEmailTemplateDefinitions 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: GetEmailTemplateDefinitionsResponse
例

getEmailTemplateRenderErrors 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
レスポンス
戻り値: GetEmailTemplateRenderErrorsResponse
例

getEmailTemplates 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetEmailTemplatesResponse
例

renderEmailTemplate 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| locale | string | query | いいえ |
レスポンス
戻り値: RenderEmailTemplateResponse
例

updateEmailTemplate 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

getEventLog 
req tenantId urlId userIdWS
パラメータ
| Name | Type | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| userIdWS | string | query | はい | |
| startTime | integer | query | はい | |
| endTime | integer | query | いいえ |
レスポンス
戻り値: GetEventLogResponse
例

getGlobalEventLog 
req tenantId urlId userIdWS
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| userIdWS | string | query | はい | |
| startTime | integer | query | はい | |
| endTime | integer | query | いいえ |
レスポンス
戻り値: GetEventLogResponse
例

createFeedPost 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| broadcastId | string | query | いいえ | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| skipDupCheck | boolean | query | いいえ |
レスポンス
例

createFeedPostPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

deleteFeedPostPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: DeleteFeedPostPublicResponse
例

getFeedPosts 
req tenantId afterId
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| afterId | string | query | いいえ | |
| limit | integer | query | いいえ | |
| tags | array | query | いいえ |
レスポンス
戻り値: GetFeedPostsResponse
例

getFeedPostsPublic 
req tenantId afterId
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postIds | array | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: UserReactsResponse
例

reactFeedPostPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | |
| postId | string | パス | はい | |
| isUndo | boolean | クエリ | いいえ | |
| broadcastId | string | クエリ | いいえ | |
| sso | string | クエリ | いいえ |
レスポンス
例

updateFeedPost 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

updateFeedPostPublic 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

flagCommentPublic 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| isFlagged | boolean | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

getGifLarge 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| largeInternalURLSanitized | string | query | はい |
レスポンス
戻り値: GifGetLargeResponse
例

getGifsSearch 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| search | string | query | はい | |
| locale | string | query | いいえ | |
| rating | string | query | いいえ | |
| page | number | query | いいえ |
レスポンス
例

getGifsTrending 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| locale | string | query | いいえ | |
| rating | string | query | いいえ | |
| page | number | query | いいえ |
レスポンス
例

addHashTag 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
応答
例

addHashTagsBulk 
Parameters
| 名前 | タイプ | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
戻り値: BulkCreateHashTagsResponse
Example

deleteHashTag 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
応答
返却: APIEmptyResponse
例

getHashTags 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No |
レスポンス
戻り値: GetHashTagsResponse
例

patchHashTag 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| tag | string | path | はい |
応答
例

deleteModerationVote 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
例

getApiComments 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
返り値: ModerationAPIGetCommentsResponse
Example

getApiExportStatus 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| batchJobId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
返却: ModerationExportStatusResponse
例

getApiIds 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| text-search | string | query | いいえ | |
| byIPFromComment | string | query | いいえ | |
| filters | string | query | いいえ | |
| searchFilters | string | query | いいえ | |
| afterId | string | query | いいえ | |
| demo | boolean | query | いいえ | |
| sso | string | query | いいえ |
応答
返却: ModerationAPIGetCommentIdsResponse
例

getBanUsersFromComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
レスポンス
返り値: GetBannedUsersFromCommentResponse
例

getCommentBanStatus 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
レスポンス
戻り値: GetCommentBanStatusResponse
例

getCommentChildren 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
レスポンス
戻り値: ModerationAPIChildCommentsResponse
例

getCount 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| text-search | string | query | いいえ | |
| byIPFromComment | string | query | いいえ | |
| filter | string | query | いいえ | |
| searchFilters | string | query | いいえ | |
| demo | boolean | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: ModerationAPICountCommentsResponse
例

getCounts 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却: GetBannedUsersCountResponse
例

getLogs 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
レスポンス
戻り値: ModerationAPIGetLogsResponse
例

getManualBadges 
Parameters
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
返却: GetTenantManualBadgesResponse
Example

getManualBadgesForUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| badgesUserId | string | query | いいえ | |
| commentId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
戻り値: 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 |
レスポンス
例

getPreBanSummary 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | いいえ |
レスポンス
Returns: ModerationCommentSearchResponse
例

getSearchPages 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| value | string | query | いいえ | |
| sso | string | query | いいえ |
Response
戻り値: ModerationPageSearchResponse
Example

getSearchSites 
パラメータ
| 名前 | 種類 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
レスポンス
返却: ModerationSiteSearchResponse
例

getSearchSuggest 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Response
Example

getSearchUsers 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
レスポンス
返り値: ModerationUserSearchResponse
例

getTrustFactor 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
Returns: GetUserTrustFactorResponse
例

getUserBanPreference 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
Returns: APIModerateGetUserBanPreferencesResponse
例

getUserInternalProfile 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: GetUserInternalProfileResponse
例

postAdjustCommentVotes 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: AdjustVotesResponse
例

postApiExport 
パラメータ
| 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 | |
| sorts | string | query | No | |
| sso | string | query | No |
レスポンス
例

postBanUserFromComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| banEmail | boolean | query | いいえ | |
| banEmailDomain | boolean | query | いいえ | |
| banIP | boolean | query | いいえ | |
| deleteAllUsersComments | boolean | query | いいえ | |
| bannedUntil | string | query | いいえ | |
| isShadowBan | boolean | query | いいえ | |
| updateId | string | query | いいえ | |
| banReason | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

postBanUserUndo 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
レスポンス
返却: APIEmptyResponse
例

postBulkPreBanSummary 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例

postRemoveComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
戻り値: PostRemoveCommentApiResponse
例

postRestoreDeletedComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
Returns: APIEmptyResponse
例

postSetCommentApprovalStatus 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
返却: SetCommentApprovedResponse
例

postSetCommentReviewStatus 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| reviewed | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

postSetCommentSpamStatus 
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| 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 | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
返却: APIEmptyResponse
例

postVote 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| direction | string | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: VoteResponse
例

putAwardBadge 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| badgeId | string | query | はい | |
| userId | string | query | いいえ | |
| commentId | string | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

putCloseThread 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

putRemoveBadge 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| badgeId | string | query | はい | |
| userId | string | query | いいえ | |
| commentId | string | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

putReopenThread 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
応答
戻り値: APIEmptyResponse
例

setTrustFactor 
パラメータ
| 名前 | タイプ | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: SetUserTrustFactorResponse
例

createModerator 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
使用例

deleteModerator 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| sendEmail | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

getModerator 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetModeratorResponse
例

getModerators 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
例

sendInvite 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| fromName | string | query | Yes |
レスポンス
返却値: APIEmptyResponse
例

updateModerator 
パラメータ
| 名前 | 型 | ロケーション | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

deleteNotificationCount 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

getCachedNotificationCount 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: GetCachedNotificationCountResponse
例

getNotificationCount 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| urlId | string | query | いいえ | |
| fromCommentId | string | query | いいえ | |
| viewed | boolean | query | いいえ | |
| type | string | query | いいえ |
レスポンス
戻り値: GetNotificationCountResponse
例

getNotifications 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| urlId | string | query | いいえ | |
| fromCommentId | string | query | いいえ | |
| viewed | boolean | query | いいえ | |
| type | string | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
例

updateNotification 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

createV1PageReact 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| title | string | query | いいえ |
レスポンス
戻り値: CreateV1PageReact
例

createV2PageReact 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| id | string | query | はい | |
| title | string | query | いいえ |
レスポンス
戻り値: CreateV1PageReact
例

deleteV1PageReact 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: CreateV1PageReact
例

deleteV2PageReact 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
レスポンス
返却値: CreateV1PageReact
例

getV1PageLikes 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
レスポンス
戻り値: GetV1PageLikes
例

getV2PageReacts 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: GetV2PageReacts
例

getV2PageReactUsers 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| id | string | query | はい |
レスポンス
戻り値: GetV2PageReactUsersResponse
例

addPage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: AddPageAPIResponse
例

deletePage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getOfflineUsers 
そのページの過去のコメント投稿者(現在オンラインではないユーザー)。displayName でソートされます。 /users/online を使い果たした後に "Members" セクションを表示するためにこれを使用してください。 Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | ページのURL識別子(サーバー側でクリーンされます)。 |
| afterName | string | query | いいえ | カーソル: 前のレスポンスの nextAfterName を渡してください。 |
| afterUserId | string | query | いいえ | カーソルのタイブレーカー: 前のレスポンスの nextAfterUserId を渡してください。afterName が設定されている場合、名前が同じエントリが落ちないように必須です。 |
レスポンス
例

getOnlineUsers 
現在オンラインのページ閲覧者: 現在 websocket セッションがそのページを購読している人々。 anonCount + totalCount を返します(部屋全体の購読者数、列挙しない匿名閲覧者を含む)。
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | ページのURL識別子(サーバー側でクリーンされます)。 |
| afterName | string | query | No | カーソル: 前回のレスポンスの nextAfterName を渡します。 |
| afterUserId | string | query | No | カーソルのタイブレーカー: 前回のレスポンスの nextAfterUserId を渡します。afterName が設定されている場合、名前の同値によってエントリが欠落しないように必要です。 |
レスポンス
例

getPageByURLId 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: GetPageByURLIdAPIResponse
例

getPages 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: GetPagesAPIResponse
例

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 の場合、少なくとも1件のコメントがあるページのみを返します。 |
レスポンス
例

getUsersInfo 
テナントのユーザー情報を一括取得します。userIds を指定すると、User / SSOUser から表示用の情報を返します。 コメントウィジェットが presence event で新たに出現したユーザーを補完するために使用されます。 ページコンテキストがないため、プライバシーは一律に適用されます(非公開プロフィールはマスクされます)。
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| ids | string | query | はい | コンマ区切りの userIds. |
レスポンス
例

patchPage 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: PatchPageAPIResponse
例

deletePendingWebhookEvent 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: APIEmptyResponse
例

getPendingWebhookEventCount 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
レスポンス
戻り値: 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
例

createQuestionConfig 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateQuestionConfigResponse
例

deleteQuestionConfig 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

getQuestionConfig 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getQuestionConfigs 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetQuestionConfigsResponse
例

updateQuestionConfig 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: APIEmptyResponse
例

createQuestionResult 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
戻り値
Returns: CreateQuestionResultResponse
例

deleteQuestionResult 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

getQuestionResult 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: GetQuestionResultResponse
例

getQuestionResults 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | はい | |
| questionId | string | query | いいえ | |
| questionIds | array | query | いいえ | |
| urlId | string | query | いいえ | |
| timeBucket | string | query | いいえ | |
| startDate | string | query | いいえ | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: AggregateQuestionResultsResponse
例

bulkAggregateQuestionResults 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: BulkAggregateQuestionResultsResponse
例

combineCommentsWithQuestionResults 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| questionId | string | query | いいえ | |
| questionIds | array | query | いいえ | |
| urlId | string | query | いいえ | |
| startDate | string | query | いいえ | |
| forceRecalculate | boolean | query | いいえ | |
| minValue | number | query | いいえ | |
| maxValue | number | query | いいえ | |
| limit | number | query | いいえ |
レスポンス
戻り値: CombineQuestionResultsWithCommentsResponse
例

addSSOUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
例

deleteSSOUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| deleteComments | boolean | query | いいえ | |
| commentDeleteMode | string | query | いいえ |
レスポンス
例

getSSOUserByEmail 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| string | path | はい |
レスポンス
戻り値: GetSSOUserByEmailAPIResponse
例

getSSOUserById 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetSSOUserByIdAPIResponse
例

getSSOUsers 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | integer | query | いいえ |
レスポンス
戻り値: GetSSOUsersResponse
例

patchSSOUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | boolean | query | いいえ |
レスポンス
例

putSSOUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | boolean | query | いいえ |
レスポンス
例

createSubscription 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateSubscriptionAPIResponse
例

deleteSubscription 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
レスポンス
戻り値: DeleteSubscriptionAPIResponse
例

getSubscriptions 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ |
Response
戻り値: GetSubscriptionsAPIResponse
Example

updateSubscription 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: UpdateSubscriptionAPIResponse
例

getTenantDailyUsages 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
レスポンス
戻り値: GetTenantDailyUsagesResponse
例

createTenantPackage 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateTenantPackageResponse
例

deleteTenantPackage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: APIEmptyResponse
例

getTenantPackage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getTenantPackages 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetTenantPackagesResponse
例

replaceTenantPackage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

updateTenantPackage 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

createTenantUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
例

deleteUser 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| deleteComments | string | query | いいえ | |
| commentDeleteMode | string | query | いいえ |
レスポンス
返却値: APIEmptyResponse
例

getUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

getUsers 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
例

replaceUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

sendLoginLink 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| redirectURL | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

updateUser 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

createTenant 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateTenantResponse
例

deleteTenant 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| sure | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

getTenant 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい |
レスポンス
戻り値: GetTenantResponse
例

getTenants 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| meta | string | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetTenantsResponse
例

updateTenant 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

changeTicketState 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: ChangeTicketStateResponse
例

createTicket 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | はい |
Response
戻り値: CreateTicketResponse
例

getTicket 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: GetTicketResponse
例

getTickets 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| state | number | query | いいえ | |
| skip | number | query | いいえ | |
| limit | number | query | いいえ |
レスポンス
戻り値: GetTicketsResponse
例

getTranslations 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| namespace | string | パス | はい | |
| component | string | パス | はい | |
| locale | string | クエリ | いいえ | |
| useFullTranslationIds | boolean | クエリ | いいえ |
レスポンス
例

uploadImage 
画像のアップロードとリサイズ
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| sizePreset | string | query | いいえ | サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス向けのサイズを作成します) |
| urlId | string | query | いいえ | アップロードが行われるページのID(設定用) |
レスポンス
戻り値: UploadImageResponse
例

getUserBadgeProgressById 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIGetUserBadgeProgressResponse
例

getUserBadgeProgressByUserId 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | path | はい |
レスポンス
戻り値: APIGetUserBadgeProgressResponse
例

getUserBadgeProgressList 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| 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 | はい |
レスポンス
例

getUserBadge 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
例

getUserBadges 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| userId | string | クエリ | いいえ | |
| badgeId | string | クエリ | いいえ | |
| type | number | クエリ | いいえ | |
| displayedOnComments | boolean | クエリ | いいえ | |
| limit | number | クエリ | いいえ | |
| skip | number | クエリ | いいえ |
レスポンス
例

updateUserBadge 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
例

getUserNotificationCount 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: GetUserNotificationCountResponse
例

getUserNotifications 
パラメーター
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | いいえ | 使用して現在のページが購読されているかどうかを判定します。 |
| pageSize | integer | query | いいえ | |
| afterId | string | query | いいえ | |
| includeContext | boolean | query | いいえ | |
| afterCreatedAt | integer | query | いいえ | |
| unreadOnly | boolean | query | いいえ | |
| dmOnly | boolean | query | いいえ | |
| noDm | boolean | query | いいえ | |
| includeTranslations | boolean | query | いいえ | |
| includeTenantNotifications | boolean | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却値: 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 | はい | |
| notificationId | string | path | はい | |
| optedInOrOut | string | path | はい | |
| commentId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: UpdateUserNotificationCommentSubscriptionStatusResponse
例

updateUserNotificationPageSubscriptionStatus 
ページの通知を有効または無効にします。ユーザーがページを購読している場合、新しいルートコメントに対して通知が作成され、また
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| urlId | string | クエリ | はい | |
| url | string | クエリ | はい | |
| pageTitle | string | クエリ | はい | |
| subscribedOrUnsubscribed | string | パス | はい | |
| sso | string | クエリ | いいえ |
レスポンス
戻り値: UpdateUserNotificationPageSubscriptionStatusResponse
例

updateUserNotificationStatus 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| notificationId | string | path | はい | |
| newStatus | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: UpdateUserNotificationStatusResponse
例

getUserPresenceStatuses 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | いいえ |
レスポンス
戻り値: SearchUsersResult
例

getUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却: GetUserResponse
例

createVote 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | はい | |
| direction | string | query | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
戻り値: VoteResponse
例

deleteVote 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| editKey | string | query | いいえ |
レスポンス
戻り値: VoteDeleteResponse
例

getVotes 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: GetVotesResponse
例

getVotesForUser 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
例

ヘルプが必要ですか?
Java SDKに関して問題が発生した場合や質問がある場合は、次の方法でご連絡ください:
貢献
貢献は歓迎します!貢献ガイドラインについてはGitHubリポジトリを参照してください。