
言語 🇯🇵 日本語
はじめに
使用方法
集計
監査ログ
認証
コメントからブロック
ブロックされたコメントを確認
コメント
ユーザーのコメント
ドメイン設定
メールテンプレート
イベントログ
フィード投稿
コメントの通報
GIF
ハッシュタグ
モデレーション
モデレーター
通知数
通知
ページリアクション
ページ
保留中のWebhookイベント
質問設定
質問結果
質問結果の集計
SSOユーザー
サブスクリプション
テナントの日次使用量
テナントパッケージ
テナントユーザー
テナント
チケット
翻訳
画像アップロード
ユーザーバッジの進捗
ユーザーバッジ
ユーザーの通知
ユーザーのプレゼンスステータス
ユーザー検索
ユーザー
投票
FastComments の Go SDK
これはFastCommentsの公式Go SDKです。
FastComments APIの公式Go SDK
リポジトリ
インストール 
go get github.com/fastcomments/fastcomments-go
API クライアントの使用
パブリック API(認証なし)
PublicAPI は認証なしでパブリックエンドポイントにアクセスできます:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// PublicAPI を使用してコメントを取得
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
デフォルト API(API キーが必要)
DefaultAPI は API キーを使用した認証が必要です:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// API キーで認証されたコンテキストを作成
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// 認証された DefaultAPI を使用してコメントを取得
response, httpResp, err := apiClient.DefaultAPI.GetComments(auth).
TenantId("your-tenant-id").
UrlId("your-page-url-id").
Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
モデレーション API(モデレーター ダッシュボード)
ModerationAPI は、リアルタイムかつ高速なモデレーション API の豊富なスイートを提供します。すべてのモデレーションメソッドは sso パラメータを受け付け、SSO または FastComments.com のセッションクッキーで認証できます:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// ModerationAPI を使用してモデレーション用のコメントを一覧取得
response, httpResp, err := apiClient.ModerationAPI.GetApiComments(
context.Background(),
).Sso("your-sso-token").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
使用方法 
シンプルSSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// シンプルSSOトークンを作成
user := &sso.SimpleSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Avatar: "https://example.com/avatar.jpg",
}
ssoInstance := sso.NewSimple(user)
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("SSO Token:", token)
// SSOトークンを使用して認証されたAPI呼び出しを行う
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
セキュアSSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// セキュアSSOトークンを作成
user := &sso.SecureSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Username: "johndoe",
Avatar: "https://example.com/avatar.jpg",
}
apiKey := "your-api-key"
ssoInstance, err := sso.NewSecure(apiKey, user)
if err != nil {
panic(err)
}
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("Secure SSO Token:", token)
// SSOトークンを使用して認証されたAPI呼び出しを行う
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
集計 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| parentTenantId | string | query | いいえ | |
| includeStats | boolean | query | いいえ |
レスポンス
戻り値: AggregateResponse
例

監査ログを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ | |
| order | string | query | いいえ | |
| after | number | query | いいえ | |
| before | number | query | いいえ |
レスポンス
戻り値: GetAuditLogsResponse
例

ログアウト(公開) 
レスポンス
戻り値: APIEmptyResponse
例

コメントからのブロック(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: BlockSuccess
例

コメントのブロック解除(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: UnblockSuccess
例

ブロックされたコメントの確認 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentIds | string | query | はい | カンマ区切りのコメントIDの一覧。 |
| sso | string | query | いいえ |
レスポンス
戻り値: CheckBlockedCommentsResponse
例

コメントからユーザーをブロック 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
戻り値: BlockSuccess
例

コメントを作成(公開) 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| broadcastId | string | query | はい | |
| sessionId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却値: SaveCommentsResponseWithPresence
例

コメントを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| contextUserId | string | query | いいえ | |
| isLive | boolean | query | いいえ |
レスポンス
返却値: DeleteCommentResult
例

コメントを削除(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却値: PublicAPIDeleteCommentResponse
例

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

コメントを通報 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい | |
| userId | string | クエリ | いいえ | |
| anonUserId | string | クエリ | いいえ |
レスポンス
戻り値: FlagCommentResponse
例

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

コメントを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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 | いいえ |
レスポンス
例

コメントを取得(公開) 
req tenantId urlId
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
例

コメントのテキストを取得 
パラメータ
| 名前 | タイプ | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: PublicAPIGetCommentTextResponse
例

コメントに投票したユーザー名を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| dir | integer | query | はい | |
| sso | string | query | いいえ |
戻り値
返却: GetCommentVoteUserNamesSuccessResponse
例

コメントをロック 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却値: APIEmptyResponse
例

コメントを固定 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: ChangeCommentPinStatusResponse
例

コメントを保存 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| sendEmails | boolean | query | いいえ | |
| populateNotifications | boolean | query | いいえ |
レスポンス
例

コメントを一括保存 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| sendEmails | boolean | query | いいえ | |
| populateNotifications | boolean | query | いいえ |
レスポンス
戻り値: []SaveCommentsBulkResponse
例

コメントのテキストを設定 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| editKey | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: PublicAPISetCommentTextResponse
例

コメントからユーザーのブロックを解除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
戻り値: UnblockSuccess
例

コメントの通報を解除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
戻り値: FlagCommentResponse
例

コメントのロックを解除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | |
| commentId | string | パス | はい | |
| broadcastId | string | クエリ | はい | |
| sso | string | クエリ | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

コメントの固定を解除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: ChangeCommentPinStatusResponse
例

コメントを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| contextUserId | string | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| isLive | boolean | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

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

ユーザーのコメントを取得 
パラメータ
| 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
例

ドメイン設定を追加 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい |
レスポンス
例

ドメイン設定を削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
レスポンス
戻り値: DeleteDomainConfigResponse
例

ドメイン設定を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domain | string | path | はい |
レスポンス
例

ドメイン設定を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

ドメイン設定をパッチ更新 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domainToUpdate | string | path | はい |
レスポンス
戻り値: PatchDomainConfigResponse
例

ドメイン設定を置換 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| domainToUpdate | string | path | はい |
レスポンス
例

メールテンプレートを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateEmailTemplateResponse
例

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

メールテンプレートのレンダーエラーを削除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| errorId | string | path | はい |
レスポンス
返却: APIEmptyResponse
例

メールテンプレートを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい |
レスポンス
例

メールテンプレート定義を取得 
パラメーター
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | クエリ | はい |
レスポンス
戻り値: GetEmailTemplateDefinitionsResponse
例

メールテンプレートのレンダーエラーを取得 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetEmailTemplateRenderErrorsResponse
例

メールテンプレートを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetEmailTemplatesResponse
例

メールテンプレートをレンダリング 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| locale | string | query | いいえ |
レスポンス
返却: RenderEmailTemplateResponse
例

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

イベントログを取得 
req tenantId urlId userIdWS
パラメータ
| Name | Type | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| userIdWS | string | query | はい | |
| startTime | integer | query | はい | |
| endTime | integer | query | いいえ |
レスポンス
例

グローバルイベントログを取得 
req tenantId urlId userIdWS
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| userIdWS | string | query | はい | |
| startTime | integer | query | はい | |
| endTime | integer | query | いいえ |
レスポンス
返却値: GetEventLogResponse
例

フィード投稿を作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| broadcastId | string | query | いいえ | |
| isLive | boolean | query | いいえ | |
| doSpamCheck | boolean | query | いいえ | |
| skipDupCheck | boolean | query | いいえ |
レスポンス
例

フィード投稿を作成(公開) 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

フィード投稿を削除(公開) 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: DeleteFeedPostPublicResponse
例

フィード投稿を取得 
req tenantId afterId
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| afterId | string | query | いいえ | |
| limit | integer | query | いいえ | |
| tags | array | query | いいえ |
レスポンス
戻り値: GetFeedPostsResponse
例

フィード投稿を取得(公開) 
req tenantId afterId
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| afterId | string | query | いいえ | |
| limit | integer | query | いいえ | |
| tags | array | query | いいえ | |
| sso | string | query | いいえ | |
| isCrawler | boolean | query | いいえ | |
| includeUserInfo | boolean | query | いいえ |
レスポンス
例

フィード投稿の統計を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postIds | array | query | はい | |
| sso | string | query | いいえ |
レスポンス
例

ユーザーのリアクションを取得(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postIds | array | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: UserReactsResponse
例

フィード投稿にリアクション(公開) 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postId | string | path | はい | |
| isUndo | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

フィード投稿を更新 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

フィード投稿を更新(公開) 
パラメータ
| Name | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

コメントを通報(公開) 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| isFlagged | boolean | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

大きなGIFを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| largeInternalURLSanitized | string | query | はい |
レスポンス
戻り値: GifGetLargeResponse
例

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

トレンドのGIFを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
レスポンス
例

ハッシュタグを追加 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Example

ハッシュタグを一括追加 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
返却: BulkCreateHashTagsResponse
例

ハッシュタグを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| tag | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

ハッシュタグを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| page | number | クエリ | いいえ |
レスポンス
戻り値: GetHashTagsResponse
例

ハッシュタグをパッチ更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
レスポンス
例

モデレーション投票を削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
Returns: VoteDeleteResponse
例

APIコメントを取得 
パラメーター
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
レスポンス
返却: ModerationAPIGetCommentsResponse
例

APIエクスポートのステータスを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
応答
戻り値: ModerationExportStatusResponse
例

API IDを取得 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
例

コメントから禁止されたユーザーを取得 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
応答
返却: GetBannedUsersFromCommentResponse
例

コメントの禁止ステータスを取得 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: GetCommentBanStatusResponse
例

コメントの子コメントを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
応答
返却: ModerationAPIChildCommentsResponse
例

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

カウントを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
レスポンス
返り値: GetBannedUsersCountResponse
例

ログを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
返却: ModerationAPIGetLogsResponse
例

手動バッジを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
応答
返却: GetTenantManualBadgesResponse
例

ユーザーの手動バッジを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| badgesUserId | string | query | いいえ | |
| commentId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: GetUserManualBadgesResponse
例

モデレーション対象のコメントを取得 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| includeEmail | boolean | query | いいえ | |
| includeIP | boolean | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: ModerationAPICommentResponse
例

モデレーション対象のコメントのテキストを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
応答
例

事前禁止サマリーを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
例

コメント検索のサマリーを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: ModerationCommentSearchResponse
例

検索ページを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
レスポンス
Returns: ModerationPageSearchResponse
例

検索サイトを取得 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
戻り値: ModerationSiteSearchResponse
例

検索サジェストを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| text-search | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: ModerationSuggestResponse
例

ユーザー検索を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| value | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: ModerationUserSearchResponse
例

信頼度を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返り値: GetUserTrustFactorResponse
例

ユーザーの禁止設定を取得 
パラメータ
| 名前 | 種類 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
応答
返り値: APIModerateGetUserBanPreferencesResponse
例

ユーザーの内部プロファイルを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: GetUserInternalProfileResponse
例

コメント投票を調整 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
例

APIエクスポートを開始 
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 | |
| sorts | string | query | No | |
| sso | string | query | No |
Response
Returns: ModerationExportResponse
Example

コメントからユーザーを禁止 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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 | いいえ |
応答
例

ユーザーの禁止を元に戻す 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

事前禁止サマリーを一括作成 
パラメータ
| Name | Type | Location | Required | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
レスポンス
戻り値: BulkPreBanSummary
例

IDでコメントを取得(POST) 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却: ModerationAPIChildCommentsResponse
例

コメントを通報(POST) 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
返却: APIEmptyResponse
例

コメントを削除(POST) 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: PostRemoveCommentApiResponse
例

削除されたコメントを復元 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
Returns: APIEmptyResponse
例

コメントの承認ステータスを設定 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| approved | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
戻り値: SetCommentApprovedResponse
例

コメントのレビュー状態を設定 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| reviewed | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

コメントのスパム状態を設定 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
Returns: APIEmptyResponse
例

コメントのテキストを設定 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
応答
Returns: SetCommentTextResponse
例

コメントの通報を解除(POST) 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例

投票を行う 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: VoteResponse
例

バッジを付与 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| badgeId | string | query | はい | |
| userId | string | query | いいえ | |
| commentId | string | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
例

スレッドを閉鎖 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
応答
Returns: APIEmptyResponse
例

バッジを削除 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
例

スレッドを再開 
Parameters
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| sso | string | query | いいえ |
Response
返却: APIEmptyResponse
Example

信頼度を設定 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
レスポンス
返却: SetUserTrustFactorResponse
例

モデレーターを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

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

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

モデレーターを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| skip | number | クエリ | いいえ |
レスポンス
例

招待を送信 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| fromName | string | query | はい |
レスポンス
戻り値: APIEmptyResponse
例

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

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

キャッシュされた通知数を取得 
パラメータ
| Name | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetCachedNotificationCountResponse
例

通知数を取得 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| urlId | string | query | いいえ | |
| fromCommentId | string | query | いいえ | |
| viewed | boolean | query | いいえ | |
| type | string | query | いいえ |
レスポンス
戻り値: GetNotificationCountResponse
例

通知を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| userId | string | クエリ | いいえ | |
| urlId | string | クエリ | いいえ | |
| fromCommentId | string | クエリ | いいえ | |
| viewed | boolean | クエリ | いいえ | |
| type | string | クエリ | いいえ | |
| skip | number | クエリ | いいえ |
レスポンス
例

通知を更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例

V1ページリアクションを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| title | string | query | いいえ |
レスポンス
戻り値: CreateV1PageReact
例

V2ページリアクションを作成 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| id | string | query | はい | |
| title | string | query | いいえ |
レスポンス
戻り値: CreateV1PageReact
例

V1ページリアクションを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: CreateV1PageReact
例

V2ページリアクションを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| id | string | query | はい |
レスポンス
戻り値: CreateV1PageReact
例

V1ページのいいねを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
レスポンス
戻り値: GetV1PageLikes
例

V2ページのリアクションを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | |
| urlId | string | クエリ | はい |
レスポンス
返却値: GetV2PageReacts
例

V2ページのリアクションユーザーを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | 必須 | |
| urlId | string | クエリ | 必須 | |
| id | string | クエリ | 必須 |
レスポンス
戻り値: GetV2PageReactUsersResponse
例

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

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

オフラインユーザーを取得 
現在オンラインではない、そのページの過去のコメント投稿者。displayNameでソート。 /users/online を使い尽くした後に「メンバー」セクションをレンダリングするためにこれを使用してください。 commenterNameに対するカーソルページネーション: サーバーは部分的な {tenantId, urlId, commenterName} インデックスを辿ります。 afterName から先を $gt で前方にインデックス、$skip コストはありません。
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Page URL identifier (cleaned server-side). |
| afterName | string | query | No | Cursor: pass nextAfterName from the previous response. |
| afterUserId | string | query | No | Cursor tiebreaker: pass nextAfterUserId from the previous response. Required when afterName is set so name-ties don't drop entries. |
Response
Example

オンラインユーザーを取得 
現在ページにオンラインの閲覧者: 現在そのページにWebSocketセッションを購読しているユーザー。 anonCount と totalCount を返します(ルーム全体の購読者数、列挙しない匿名閲覧者も含む)。
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | ページのURL識別子(サーバー側でクリーンされます)。 |
| afterName | string | query | いいえ | カーソル: 前のレスポンスの nextAfterName を渡します。 |
| afterUserId | string | query | いいえ | カーソルのタイブレーカー: 前のレスポンスの nextAfterUserId を渡します。afterName が設定されているときに、名前が同一のエントリが除外されないように必須です。 |
レスポンス
例

URL IDでページを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい |
レスポンス
戻り値: GetPageByURLIdAPIResponse
例

ページを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes |
レスポンス
返却値: GetPagesAPIResponse
例

ページを取得(公開) 
テナントのページ一覧を返します。FChat デスクトップクライアントがルーム一覧を生成するために使用します。
各ページについて解決されたカスタム設定で enableFChat が true である必要があります。
SSO を必要とするページは、要求元ユーザーのグループアクセスに基づいてフィルタされます。
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | 以前のリクエストから nextCursor として返された不透明なページネーションカーソル。同じ sortBy に結びついています。 |
| limit | integer | query | No | 1..200、デフォルト 50 |
| q | string | query | No | 省略可の大文字小文字を区別しないタイトル先頭一致フィルタ。 |
| sortBy | string | query | No | 並び順。 updatedAt(デフォルト、最新が先)、commentCount(コメント数が多い順)、または title(アルファベット順)。 |
| hasComments | boolean | query | No | true の場合、少なくとも1件のコメントがあるページのみを返します。 |
Response
Returns: GetPublicPagesResponse
Example

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

ページをパッチ更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: PatchPageAPIResponse
例

保留中のWebhookイベントを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

保留中のWebhookイベント数を取得 
パラメータ
| Name | Type | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | query | いいえ | |
| externalId | string | query | いいえ | |
| eventType | string | query | いいえ | |
| type | string | query | いいえ | |
| domain | string | query | いいえ | |
| attemptCountGT | number | query | いいえ |
レスポンス
戻り値: GetPendingWebhookEventCountResponse
例

保留中のWebhookイベントを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
例

質問設定を作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateQuestionConfigResponse
例

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

質問設定を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetQuestionConfigResponse
例

質問設定を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetQuestionConfigsResponse
例

質問設定を更新 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい |
レスポンス
戻り値: APIEmptyResponse
例

質問結果を作成 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
Response
戻り値: CreateQuestionResultResponse
Example

質問結果を削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却値: APIEmptyResponse
例

質問結果を取得 
パラメータ
| 名称 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: GetQuestionResultResponse
例

質問結果を取得 
パラメータ
| 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
例

質問結果を更新 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: APIEmptyResponse
例

質問結果を集計 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| questionId | string | query | いいえ | |
| questionIds | array | query | いいえ | |
| urlId | string | query | いいえ | |
| timeBucket | string | query | いいえ | |
| startDate | string | query | いいえ | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: AggregateQuestionResultsResponse
例

質問結果を一括集計 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: BulkAggregateQuestionResultsResponse
例

コメントと質問結果を結合 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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
例

SSOユーザーを追加 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

SSOユーザーを削除 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| deleteComments | boolean | query | いいえ | |
| commentDeleteMode | string | query | いいえ |
レスポンス
例

メールでSSOユーザーを取得 
パラメーター
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| string | path | はい |
レスポンス
戻り値: GetSSOUserByEmailAPIResponse
例

IDでSSOユーザーを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetSSOUserByIdAPIResponse
例

SSOユーザーを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | integer | query | いいえ |
レスポンス
戻り値: GetSSOUsersResponse
例

SSOユーザーをパッチ更新 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | boolean | query | いいえ |
レスポンス
例

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

サブスクリプションを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateSubscriptionAPIResponse
例

サブスクリプションを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: DeleteSubscriptionAPIResponse
例

サブスクリプションを取得 
パラメーター
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: GetSubscriptionsAPIResponse
例

サブスクリプションを更新 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
戻り値: UpdateSubscriptionAPIResponse
例

テナントの日次使用量を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| yearNumber | number | query | いいえ | |
| monthNumber | number | query | いいえ | |
| dayNumber | number | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetTenantDailyUsagesResponse
例

テナントパッケージを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: CreateTenantPackageResponse
例

テナントパッケージを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIEmptyResponse
例

テナントパッケージを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

テナントパッケージを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
戻り値: GetTenantPackagesResponse
例

テナントパッケージを置換 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい |
レスポンス
返却: APIEmptyResponse
例

テナントパッケージを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
返却値: APIEmptyResponse
例

テナントユーザーを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
例

テナントユーザーを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| deleteComments | string | query | いいえ | |
| commentDeleteMode | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

テナントユーザーを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

テナントユーザーを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | number | query | いいえ |
レスポンス
例

テナントユーザーを置換 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

ログインリンクを送信 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| redirectURL | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例

テナントユーザーを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| updateComments | string | query | いいえ |
レスポンス
戻り値: APIEmptyResponse
例

テナントを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
返却値: CreateTenantResponse
例

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

テナントを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetTenantResponse
例

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

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

チケットの状態を変更 
パラメータ
| 名前 | 型 | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: ChangeTicketStateResponse
例

チケットを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| userId | string | クエリ | はい |
レスポンス
戻り値: CreateTicketResponse
例

チケットを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| userId | string | query | いいえ |
レスポンス
例

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

翻訳を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
レスポンス
例

画像をアップロード 
画像のアップロードとリサイズ
パラメータ
| 名前 | Type | 位置 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | |
| sizePreset | string | クエリ | いいえ | サイズプリセット: "Default" (1000x1000px) または "CrossPlatform" (一般的なデバイス向けのサイズを作成) |
| urlId | string | クエリ | いいえ | アップロードが行われているページのID、設定用 |
レスポンス
例

IDでユーザーバッジの進捗を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: APIGetUserBadgeProgressResponse
例

ユーザーIDでユーザーバッジの進捗を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | path | はい |
レスポンス
返却: APIGetUserBadgeProgressResponse
例

ユーザーバッジの進捗一覧を取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
戻り値: APIGetUserBadgeProgressListResponse
例

ユーザーバッジを作成 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい |
レスポンス
戻り値: APICreateUserBadgeResponse
例

ユーザーバッジを削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
例

ユーザーバッジを取得 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

ユーザーバッジを取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| userId | string | query | いいえ | |
| badgeId | string | query | いいえ | |
| type | number | query | いいえ | |
| displayedOnComments | boolean | query | いいえ | |
| limit | number | query | いいえ | |
| skip | number | query | いいえ |
レスポンス
例

ユーザーバッジを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
例

ユーザーの通知数を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
レスポンス
戻り値: GetUserNotificationCountResponse
例

ユーザーの通知を取得 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| 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
例

ユーザーの通知数をリセット 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: ResetUserNotificationsResponse
例

ユーザーの通知をリセット 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| afterId | string | query | いいえ | |
| afterCreatedAt | integer | query | いいえ | |
| unreadOnly | boolean | query | いいえ | |
| dmOnly | boolean | query | いいえ | |
| noDm | boolean | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却値: ResetUserNotificationsResponse
例

ユーザーのコメント購読ステータスを更新 
特定のコメントに対する通知を有効化または無効化します。
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| notificationId | string | path | はい | |
| optedInOrOut | string | path | はい | |
| commentId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
戻り値: UpdateUserNotificationCommentSubscriptionStatusResponse
例

ユーザーのページ購読ステータスを更新 
ページの通知を有効または無効にします。ユーザーがページを購読していると、新しいルートコメントがあるたびに通知が作成され、また
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| url | string | query | はい | |
| pageTitle | string | query | はい | |
| subscribedOrUnsubscribed | string | path | はい | |
| sso | string | query | いいえ |
レスポンス
返却: UpdateUserNotificationPageSubscriptionStatusResponse
例

ユーザーの通知ステータスを更新 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| newStatus | string | path | Yes | |
| sso | string | query | No |
レスポンス
戻り値: UpdateUserNotificationStatusResponse
例

ユーザーのプレゼンスステータスを取得 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlIdWS | string | query | はい | |
| userIds | string | query | はい |
レスポンス
戻り値: GetUserPresenceStatusesResponse
例

ユーザーを検索 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| urlId | string | query | はい | |
| usernameStartsWith | string | query | いいえ | |
| mentionGroupIds | array | query | いいえ | |
| sso | string | query | いいえ | |
| searchSection | string | query | いいえ |
レスポンス
戻り値: SearchUsersResult
例

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

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

投票を削除 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| editKey | string | query | いいえ |
レスポンス
戻り値: VoteDeleteResponse
例

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

ユーザーの投票を取得 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
例

ヘルプが必要ですか?
Go SDK に関して問題が発生したり質問がある場合は、次のいずれかを行ってください:
貢献
貢献を歓迎します!貢献ガイドラインについては、GitHub リポジトリ をご覧ください。