
言語 🇯🇵 日本語
ドキュメント
はじめに
使用方法
集計
監査ログ
認証
コメントからブロック
ブロックされたコメントの確認
コメント
コメントのフラグ付け
ユーザーのコメント
ドメイン設定
メールテンプレート
イベントログ
フィード投稿
GIF
ハッシュタグ
モデレーション
モデレーター
通知カウント
通知
ページリアクション
ページ
保留中のWebhookイベント
質問設定
質問結果
質問結果の集計
SSOユーザー
サブスクリプション
テナントの日次使用量
テナントパッケージ
テナントユーザー
テナント
チケット
翻訳
画像アップロード
ユーザーバッジ進捗
ユーザーバッジ
ユーザー通知
ユーザー在席状態
ユーザー検索
ユーザー
投票
FastComments Go SDK
これはFastCommentsの公式Go SDKです。
FastComments APIの公式Go SDK
リポジトリ
AI コーディングエージェント 
コーディングエージェントに必要な FastComments のコンテキストを提供します - ウィジェット、構成、Secure SSO、REST API、そして SDK です:
npx skills add fastcomments/skills
Claude Code、Codex、Cursor、Copilot、Gemini、そして skills CLI がサポートするすべてのエージェントで動作します。
Installation 
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)
}
Usage 
シンプル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)
}
Aggregate 
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
例

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

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

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

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

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

BlockUserFromComment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
戻り値: BlockSuccess
例

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

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

DeleteCommentPublic 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | クエリ | はい | |
| id | string | パス | はい | |
| userId | string | クエリ | いいえ | |
| anonUserId | string | クエリ | いいえ |
レスポンス
戻り値: FlagCommentResponse
例

GetComment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
パラメータ
| 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
例

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

GetCommentVoteUserNames 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| commentId | string | path | はい | |
| dir | integer | query | はい | |
| sso | string | query | いいえ |
戻り値
返却: GetCommentVoteUserNamesSuccessResponse
例

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

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

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

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

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

UnFlagComment 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
レスポンス
戻り値: FlagCommentResponse
例

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

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

UpdateComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい |
レスポンス
例

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

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

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

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

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

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

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

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

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

GetEmailTemplateDefinitions 
パラメーター
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | クエリ | はい |
レスポンス
戻り値: GetEmailTemplateDefinitionsResponse
例

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

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

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

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

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

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

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

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

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

GetUserReactsPublic 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | はい | |
| postIds | array | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
戻り値: UserReactsResponse
例

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

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

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

FlagCommentPublic 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
レスポンス
例

AddHashTag 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Example

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

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

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

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

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

GetApiComments 
パラメーター
| 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
例

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

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

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

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 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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 | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
レスポンス
戻り値: ModerationCommentSearchResponse
例

GetSearchPages 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
レスポンス
Returns: ModerationPageSearchResponse
例

GetSearchSites 
Parameters
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
戻り値: ModerationSiteSearchResponse
例

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

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

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

GetUserBanPreference 
パラメータ
| 名前 | 種類 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
応答
返り値: APIModerateGetUserBanPreferencesResponse
例

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

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

PostApiExport 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| text-search | string | query | いいえ | |
| byIPFromComment | string | query | いいえ | |
| filters | string | query | いいえ | |
| searchFilters | string | query | いいえ | |
| sorts | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
例

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

PostBulkPreBanSummary 
パラメータ
| 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
例

PostCommentsByIds 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| sso | string | query | いいえ |
レスポンス
返却: ModerationAPIChildCommentsResponse
例

PostFlagComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
返却: APIEmptyResponse
例

PostRemoveComment 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | 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 | はい | |
| commentId | string | path | はい | |
| approved | boolean | query | いいえ | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
応答
戻り値: SetCommentApprovedResponse
例

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

PostSetCommentSpamStatus 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
レスポンス
Returns: APIEmptyResponse
例

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

PostUnFlagComment 
パラメータ
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| commentId | string | path | はい | |
| broadcastId | string | query | いいえ | |
| sso | string | query | いいえ |
レスポンス
返却: APIEmptyResponse
例

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

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

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

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

PutReopenThread 
Parameters
| 名前 | タイプ | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| sso | string | query | いいえ |
Response
返却: APIEmptyResponse
Example

SetTrustFactor 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | 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 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい |
レスポンス
戻り値: GetModeratorResponse
例

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

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

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

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

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

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

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

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

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

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

GetV2PageReacts 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | パス | はい | |
| urlId | string | クエリ | はい |
レスポンス
返却値: GetV2PageReacts
例

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

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

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

GetOfflineUsers 
現在オンラインではない、そのページの過去のコメント投稿者。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

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

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

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

GetPagesPublic 
テナントのページ一覧を返します。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

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

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

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

GetPendingWebhookEventCount 
パラメータ
| 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
例

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

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

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

UpdateQuestionConfig 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい |
レスポンス
戻り値: APIEmptyResponse
例

CreateQuestionResult 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい |
Response
戻り値: CreateQuestionResultResponse
Example

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

GetQuestionResult 
パラメータ
| 名称 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
レスポンス
戻り値: APIEmptyResponse
例

AggregateQuestionResults 
パラメータ
| 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
例

BulkAggregateQuestionResults 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| forceRecalculate | boolean | query | いいえ |
レスポンス
戻り値: BulkAggregateQuestionResultsResponse
例

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

DeleteSSOUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| skip | integer | query | いいえ |
レスポンス
戻り値: GetSSOUsersResponse
例

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

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

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

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

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

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

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

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

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

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

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

ReplaceTenantPackage 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | クエリ | はい | |
| id | string | パス | はい |
レスポンス
返却: APIEmptyResponse
例

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GetUserBadges 
パラメータ
| 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 | いいえ |
レスポンス
例

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

GetUserNotificationCount 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
レスポンス
戻り値: GetUserNotificationCountResponse
例

GetUserNotifications 
パラメータ
| 名前 | 型 | 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
例

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

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

GetUserPresenceStatuses 
パラメータ
| 名前 | 型 | Location | 必須 | 説明 |
|---|---|---|---|---|
| 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 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| 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 
パラメータ
| 名前 | 型 | 場所 | 必須 | 説明 |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| id | string | path | はい | |
| editKey | string | query | いいえ |
レスポンス
戻り値: VoteDeleteResponse
例

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

GetVotesForUser 
パラメータ
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | はい | |
| urlId | string | query | はい | |
| userId | string | query | いいえ | |
| anonUserId | string | query | いいえ |
レスポンス
例

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