
Sprache 🇩🇪 Deutsch
Dokumentation
Erste Schritte
Verwendung
Aggregieren
Audit-Protokolle
Authentifizierung
Blockieren aus Kommentar
Blockierte Kommentare prüfen
Kommentare
Kommentare für Benutzer
Domain-Konfigurationen
E-Mail-Vorlagen
Ereignisprotokoll
Feed-Beiträge
Kommentar melden
GIFs
Hashtags
Moderation
Moderatoren
Benachrichtigungszähler
Benachrichtigungen
Seitenreaktionen
Seiten
Ausstehende Webhook-Ereignisse
Fragenkonfigurationen
Frageresultate
Aggregation von Frageresultaten
SSO-Benutzer
Abonnements
Tägliche Nutzung des Mandanten
Mandantenpakete
Mandatenpakete
Mandantenbenutzer
Mandanten
Tickets
Übersetzungen
Bild hochladen
Fortschritt der Benutzerabzeichen
Benutzerabzeichen
Benutzerbenachrichtigungen
Benutzerpräsenzstatus
Benutzersuche
Benutzer
Stimmen
FastComments Go SDK
Dies ist das offizielle Go-SDK für FastComments.
Offizielles Go-SDK für die FastComments-API
Repository
AI coding agents 
Geben Sie Ihrem Coding‑Agent den FastComments‑Kontext, den er benötigt – Widgets, Konfiguration, Secure SSO, die REST‑API und die SDKs:
npx skills add fastcomments/skills
Funktioniert mit Claude Code, Codex, Cursor, Copilot, Gemini und jedem anderen Agenten, den das skills CLI unterstützt.
Installation 
go get github.com/fastcomments/fastcomments-go
Verwendung des API-Clients
Öffentliche API (Keine Authentifizierung)
Die PublicAPI ermöglicht unverifizierten Zugriff auf öffentliche Endpunkte:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Kommentare mit PublicAPI abrufen
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)
}
Standard-API (Erfordert API-Schlüssel)
Die DefaultAPI erfordert Authentifizierung mit Ihrem API-Schlüssel:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Authentifizierten Kontext mit API-Schlüssel erstellen
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// Kommentare mit authentifizierter DefaultAPI abrufen
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)
}
Moderations-API (Moderator-Dashboard)
Die ModerationsAPI bietet eine umfangreiche Sammlung von Live- und schnellen Moderations-APIs. Alle Moderationsmethoden akzeptieren einen sso-Parameter und können über SSO oder ein FastComments.com-Session-Cookie authentifiziert werden:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Kommentare zur Moderation mit ModerationsAPI auflisten
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 
Einfaches SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Erstelle Simple-SSO-Token
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)
// Verwende das SSO-Token, um einen authentifizierten API-Aufruf zu tätigen
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)
}
Sicheres SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Erstelle Secure-SSO-Token
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)
// Verwende das SSO-Token, um einen authentifizierten API-Aufruf zu tätigen
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 
Fasst Dokumente zusammen, indem sie gruppiert werden (falls groupBy angegeben ist) und mehrere Operationen angewendet werden. Verschiedene Operationen (z. B. sum, countDistinct, avg usw.) werden unterstützt.
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nein | |
| includeStats | boolean | query | Nein |
Antwort
Gibt zurück: AggregateResponse
Beispiel

GetAuditLogs 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| limit | number | query | Nein | |
| skip | number | query | Nein | |
| order | string | query | Nein | |
| after | number | query | Nein | |
| before | number | query | Nein |
Antwort
Gibt zurück: GetAuditLogsResponse
Beispiel

LogoutPublic 
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

BlockFromCommentPublic 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | Abfrage | Ja | |
| commentId | string | Pfad | Ja | |
| sso | string | Abfrage | Nein |
Antwort
Gibt zurück: BlockSuccess
Beispiel

UnBlockCommentPublic 
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UnblockSuccess
Beispiel

CheckedCommentsForBlocked 
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | Eine durch Kommas getrennte Liste von Kommentar-IDs. |
| sso | string | query | Nein |
Antwort
Gibt zurück: CheckBlockedCommentsResponse
Beispiel

BlockUserFromComment 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: BlockSuccess
Beispiel

CreateCommentPublic 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: SaveCommentsResponseWithPresence
Beispiel

DeleteComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nein | |
| isLive | boolean | query | Nein |
Antwort
Gibt zurück: DeleteCommentResult
Beispiel

DeleteCommentPublic 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: PublicAPIDeleteCommentResponse
Beispiel

DeleteCommentVote 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: VoteDeleteResponse
Beispiel

FlagComment 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: FlagCommentResponse
Beispiel

GetComment 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIGetCommentResponse
Beispiel

GetComments 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | integer | query | Nein | |
| limit | integer | query | Nein | |
| skip | integer | query | Nein | |
| asTree | boolean | query | Nein | |
| skipChildren | integer | query | Nein | |
| limitChildren | integer | query | Nein | |
| maxTreeDepth | integer | query | Nein | |
| urlId | string | query | Nein | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein | |
| contextUserId | string | query | Nein | |
| hashTag | string | query | Nein | |
| parentId | string | query | Nein | |
| direction | string | query | Nein | |
| fromDate | integer | query | Nein | |
| toDate | integer | query | Nein |
Antwort
Gibt zurück: APIGetCommentsResponse
Beispiel

GetCommentsPublic 
req tenantId urlId
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| page | integer | query | Nein | |
| direction | string | query | Nein | |
| sso | string | query | Nein | |
| skip | integer | query | Nein | |
| skipChildren | integer | query | Nein | |
| limit | integer | query | Nein | |
| limitChildren | integer | query | Nein | |
| countChildren | boolean | query | Nein | |
| fetchPageForCommentId | string | query | Nein | |
| includeConfig | boolean | query | Nein | |
| countAll | boolean | query | Nein | |
| includei10n | boolean | query | Nein | |
| locale | string | query | Nein | |
| modules | string | query | Nein | |
| isCrawler | boolean | query | Nein | |
| includeNotificationCount | boolean | query | Nein | |
| asTree | boolean | query | Nein | |
| maxTreeDepth | integer | query | Nein | |
| useFullTranslationIds | boolean | query | Nein | |
| parentId | string | query | Nein | |
| searchText | string | query | Nein | |
| hashTags | array | query | Nein | |
| userId | string | query | Nein | |
| customConfigStr | string | query | Nein | |
| afterCommentId | string | query | Nein | |
| beforeCommentId | string | query | Nein |
Antwort
Gibt zurück: GetCommentsResponseWithPresencePublicComment
Beispiel

GetCommentText 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: PublicAPIGetCommentTextResponse
Beispiel

GetCommentVoteUserNames 
Parameters
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: GetCommentVoteUserNamesSuccessResponse
Beispiel

LockComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

PinComment 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: ChangeCommentPinStatusResponse
Beispiel

SaveComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| sendEmails | boolean | query | Nein | |
| populateNotifications | boolean | query | Nein |
Antwort
Gibt zurück: APISaveCommentResponse
Beispiel

SaveCommentsBulk 
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| sendEmails | boolean | query | Nein | |
| populateNotifications | boolean | query | Nein |
Antwort
Gibt zurück: []SaveCommentsBulkResponse
Beispiel

SetCommentText 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: PublicAPISetCommentTextResponse
Beispiel

UnBlockUserFromComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: UnblockSuccess
Beispiel

UnFlagComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: FlagCommentResponse
Beispiel

UnLockComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

UnPinComment 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: ChangeCommentPinStatusResponse
Beispiel

UpdateComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| isLive | boolean | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

VoteComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Antwort
Gibt zurück: VoteResponse
Beispiel

GetCommentsForUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| userId | string | query | Nein | |
| direction | string | query | Nein | |
| repliesToUserId | string | query | Nein | |
| page | number | query | Nein | |
| includei10n | boolean | query | Nein | |
| locale | string | query | Nein | |
| isCrawler | boolean | query | Nein |
Antwort
Gibt zurück: GetCommentsForUserResponse
Beispiel

AddDomainConfig 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: AddDomainConfigResponse
Beispiel

DeleteDomainConfig 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Antwort
Gibt zurück: DeleteDomainConfigResponse
Beispiel

GetDomainConfig 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Antwort
Gibt zurück: GetDomainConfigResponse
Beispiel

GetDomainConfigs 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: GetDomainConfigsResponse
Beispiel

PatchDomainConfig 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Antwort
Gibt zurück: PatchDomainConfigResponse
Beispiel

PutDomainConfig 
Parameter
| Name | Typ | Position | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Antwort
Gibt zurück: PutDomainConfigResponse
Beispiel

CreateEmailTemplate 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateEmailTemplateResponse
Beispiel

DeleteEmailTemplate 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

DeleteEmailTemplateRenderError 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetEmailTemplate 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Abfrage | Ja | |
| id | string | Pfad | Ja |
Antwort
Gibt zurück: GetEmailTemplateResponse
Beispiel

GetEmailTemplateDefinitions 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: GetEmailTemplateDefinitionsResponse
Beispiel

GetEmailTemplateRenderErrors 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetEmailTemplateRenderErrorsResponse
Beispiel

GetEmailTemplates 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetEmailTemplatesResponse
Beispiel

RenderEmailTemplate 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nein |
Antwort
Gibt zurück: RenderEmailTemplateResponse
Beispiel

UpdateEmailTemplate 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetEventLog 
req tenantId urlId userIdWS
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nein |
Antwort
Gibt zurück: GetEventLogResponse
Beispiel

GetGlobalEventLog 
req tenantId urlId userIdWS
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nein |
Antwort
Gibt zurück: GetEventLogResponse
Beispiel

CreateFeedPost 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| broadcastId | string | query | Nein | |
| isLive | boolean | query | Nein | |
| doSpamCheck | boolean | query | Nein | |
| skipDupCheck | boolean | query | Nein |
Antwort
Gibt zurück: CreateFeedPostsResponse
Beispiel

CreateFeedPostPublic 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: CreateFeedPostResponse
Beispiel

DeleteFeedPostPublic 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: DeleteFeedPostPublicResponse
Beispiel

GetFeedPosts 
req tenantId afterId
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nein | |
| limit | integer | query | Nein | |
| tags | array | query | Nein |
Antwort
Gibt zurück: GetFeedPostsResponse
Beispiel

GetFeedPostsPublic 
req tenantId afterId
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nein | |
| limit | integer | query | Nein | |
| tags | array | query | Nein | |
| sso | string | query | Nein | |
| isCrawler | boolean | query | Nein | |
| includeUserInfo | boolean | query | Nein |
Antwort
Gibt zurück: PublicFeedPostsResponse
Beispiel

GetFeedPostsStats 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: FeedPostsStatsResponse
Beispiel

GetUserReactsPublic 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UserReactsResponse
Beispiel

ReactFeedPostPublic 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: ReactFeedPostResponse
Beispiel

UpdateFeedPost 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

UpdateFeedPostPublic 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: CreateFeedPostResponse
Beispiel

FlagCommentPublic 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetGifLarge 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| largeInternalURLSanitized | string | query | Ja |
Antwort
Gibt zurück: GifGetLargeResponse
Beispiel

GetGifsSearch 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nein | |
| rating | string | query | Nein | |
| page | number | query | Nein |
Antwort
Gibt zurück: GetGifsSearchResponse
Beispiel

GetGifsTrending 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| locale | string | query | Nein | |
| rating | string | query | Nein | |
| page | number | query | Nein |
Antwort
Gibt zurück: GetGifsTrendingResponse
Beispiel

AddHashTag 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Rückgabe: CreateHashTagResponse
Beispiel

AddHashTagsBulk 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Antwort
Rückgabe: BulkCreateHashTagsResponse
Beispiel

DeleteHashTag 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

GetHashTags 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nein |
Antwort
Gibt zurück: GetHashTagsResponse
Beispiel

PatchHashTag 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Response
Rückgabe: UpdateHashTagResponse
Example

DeleteModerationVote 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: VoteDeleteResponse
Beispiel

GetApiComments 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nein | |
| count | number | query | Nein | |
| text-search | string | query | Nein | |
| byIPFromComment | string | query | Nein | |
| filters | string | query | Nein | |
| searchFilters | string | query | Nein | |
| sorts | string | query | Nein | |
| demo | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPIGetCommentsResponse
Beispiel

GetApiExportStatus 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationExportStatusResponse
Beispiel

GetApiIds 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nein | |
| byIPFromComment | string | query | Nein | |
| filters | string | query | Nein | |
| searchFilters | string | query | Nein | |
| afterId | string | query | Nein | |
| demo | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPIGetCommentIdsResponse
Beispiel

GetBanUsersFromComment 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetBannedUsersFromCommentResponse
Beispiel

GetCommentBanStatus 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetCommentBanStatusResponse
Beispiel

GetCommentChildren 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPIChildCommentsResponse
Beispiel

GetCount 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nein | |
| byIPFromComment | string | query | Nein | |
| filter | string | query | Nein | |
| searchFilters | string | query | Nein | |
| demo | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPICountCommentsResponse
Beispiel

GetCounts 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Rückgabe: GetBannedUsersCountResponse
Example

GetLogs 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Returns: ModerationAPIGetLogsResponse
Beispiel

GetManualBadges 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetTenantManualBadgesResponse
Beispiel

GetManualBadgesForUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgesUserId | string | query | Nein | |
| commentId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetUserManualBadgesResponse
Beispiel

GetModerationComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeEmail | boolean | query | Nein | |
| includeIP | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPICommentResponse
Beispiel

GetModerationCommentText 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetCommentTextResponse
Beispiel

GetPreBanSummary 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeByUserIdAndEmail | boolean | query | Nein | |
| includeByIP | boolean | query | Nein | |
| includeByEmailDomain | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: PreBanSummary
Beispiel

GetSearchCommentsSummary 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nein | |
| filters | string | query | Nein | |
| searchFilters | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationCommentSearchResponse
Beispiel

GetSearchPages 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nein | |
| sso | string | query | Nein |
Response
Rückgabe: ModerationPageSearchResponse
Beispiel

GetSearchSites 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationSiteSearchResponse
Beispiel

GetSearchSuggest 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Antwort
Returns: ModerationSuggestResponse
Beispiel

GetSearchUsers 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationUserSearchResponse
Beispiel

GetTrustFactor 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Returns: GetUserTrustFactorResponse
Beispiel

GetUserBanPreference 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIModerateGetUserBanPreferencesResponse
Beispiel

GetUserInternalProfile 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nein | |
| sso | string | query | Nein |
Response
Rückgabe: GetUserInternalProfileResponse
Example

PostAdjustCommentVotes 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: AdjustVotesResponse
Beispiel

PostApiExport 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nein | |
| byIPFromComment | string | query | Nein | |
| filters | string | query | Nein | |
| searchFilters | string | query | Nein | |
| sorts | string | query | Nein | |
| sso | string | query | Nein |
Response
Rückgabe: ModerationExportResponse
Beispiel

PostBanUserFromComment 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| banEmail | boolean | query | Nein | |
| banEmailDomain | boolean | query | Nein | |
| banIP | boolean | query | Nein | |
| deleteAllUsersComments | boolean | query | Nein | |
| bannedUntil | string | query | Nein | |
| isShadowBan | boolean | query | Nein | |
| updateId | string | query | Nein | |
| banReason | string | query | Nein | |
| sso | string | query | Nein |
Response
Rückgabe: BanUserFromCommentResult
Beispiel

PostBanUserUndo 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

PostBulkPreBanSummary 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| includeByUserIdAndEmail | boolean | query | Nein | |
| includeByIP | boolean | query | Nein | |
| includeByEmailDomain | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: BulkPreBanSummary
Beispiel

PostCommentsByIds 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationAPIChildCommentsResponse
Beispiel

PostFlagComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

PostRemoveComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: PostRemoveCommentApiResponse
Beispiel

PostRestoreDeletedComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

PostSetCommentApprovalStatus 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| approved | boolean | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Returns: SetCommentApprovedResponse
Beispiel

PostSetCommentReviewStatus 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

PostSetCommentSpamStatus 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| spam | boolean | query | Nein | |
| permNotSpam | boolean | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

PostSetCommentText 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: SetCommentTextResponse
Beispiel

PostUnFlagComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

PostVote 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| direction | string | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: VoteResponse
Beispiel

PutAwardBadge 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: AwardUserBadgeResponse
Beispiel

PutCloseThread 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

PutRemoveBadge 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgeId | string | query | Ja | |
| userId | string | query | Nein | |
| commentId | string | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: RemoveUserBadgeResponse
Beispiel

PutReopenThread 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

SetTrustFactor 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Response
Returns: SetUserTrustFactorResponse
Example

CreateModerator 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateModeratorResponse
Beispiel

DeleteModerator 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetModerator 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetModeratorResponse
Beispiel

GetModerators 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetModeratorsResponse
Beispiel

SendInvite 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

UpdateModerator 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

DeleteNotificationCount 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetCachedNotificationCount 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetCachedNotificationCountResponse
Beispiel

GetNotificationCount 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| urlId | string | query | Nein | |
| fromCommentId | string | query | Nein | |
| viewed | boolean | query | Nein | |
| type | string | query | Nein |
Response
Gibt zurück: GetNotificationCountResponse
Beispiel

GetNotifications 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| urlId | string | query | Nein | |
| fromCommentId | string | query | Nein | |
| viewed | boolean | query | Nein | |
| type | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetNotificationsResponse
Beispiel

UpdateNotification 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

CreateV1PageReact 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| title | string | query | Nein |
Antwort
Gibt zurück: CreateV1PageReact
Beispiel

CreateV2PageReact 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nein |
Antwort
Gibt zurück: CreateV1PageReact
Beispiel

DeleteV1PageReact 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Antwort
Gibt zurück: CreateV1PageReact
Beispiel

DeleteV2PageReact 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Antwort
Gibt zurück: CreateV1PageReact
Beispiel

GetV1PageLikes 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Antwort
Gibt zurück: GetV1PageLikes
Beispiel

GetV2PageReacts 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Antwort
Gibt zurück: GetV2PageReacts
Beispiel

GetV2PageReactUsers 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | |
| urlId | string | Abfrage | Ja | |
| id | string | Abfrage | Ja |
Antwort
Gibt zurück: GetV2PageReactUsersResponse
Beispiel

AddPage 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: AddPageAPIResponse
Beispiel

DeletePage 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: DeletePageAPIResponse
Beispiel

GetOfflineUsers 
Frühere Kommentatoren auf der Seite, die derzeit NICHT online sind. Nach displayName sortiert. Verwenden Sie dies, nachdem Sie /users/online erschöpft haben, um einen "Mitglieder"-Abschnitt anzuzeigen. Cursor-Paginierung auf commenterName: Der Server durchläuft den partiellen {tenantId, urlId, commenterName}-Index von afterName nach vorne mittels $gt, ohne $skip-Kosten.
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
Gibt zurück: PageUsersOfflineResponse
Example

GetOnlineUsers 
Aktuell online befindliche Betrachter einer Seite: Personen, deren WebSocket-Sitzung momentan auf die Seite abonniert ist. Gibt anonCount + totalCount zurück (raumweite Abonnenten, einschließlich anonymer Betrachter, die wir nicht einzeln auflisten).
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Seiten-URL-Bezeichner (serverseitig bereinigt). |
| afterName | string | query | No | Cursor: übergeben Sie nextAfterName aus der vorherigen Antwort. |
| afterUserId | string | query | No | Cursor-Tiebreaker: übergeben Sie nextAfterUserId aus der vorherigen Antwort. Erforderlich, wenn afterName gesetzt ist, damit bei gleichen Namen keine Einträge verloren gehen. |
Response
Gibt zurück: PageUsersOnlineResponse
Example

GetPageByURLId 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Antwort
Gibt zurück: GetPageByURLIdAPIResponse
Beispiel

GetPages 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: GetPagesAPIResponse
Beispiel

GetPagesPublic 
Listet Seiten für einen Mandanten. Wird vom FChat-Desktop-Client verwendet, um seine Raumliste zu füllen. Erfordert, dass enableFChat in der aufgelösten benutzerdefinierten Konfiguration für jede Seite auf true gesetzt ist. Seiten, die SSO erfordern, werden anhand des Gruppenzugriffs des anfragenden Benutzers gefiltert.
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Undurchsichtiger Paginierungs-Cursor, zurückgegeben als nextCursor aus einer vorherigen Anfrage. An denselben sortBy gebunden. |
| limit | integer | query | No | 1..200, Standard 50 |
| q | string | query | No | Optionaler, case-insensitiver Filter für Titelpräfix. |
| sortBy | string | query | No | Sortierreihenfolge. updatedAt (Standard, neueste zuerst), commentCount (meiste Kommentare zuerst), oder title (alphabetisch). |
| hasComments | boolean | query | No | Wenn true, nur Seiten mit mindestens einem Kommentar zurückgeben. |
Antwort
Gibt zurück: GetPublicPagesResponse
Beispiel

GetUsersInfo 
Massenhafte Benutzerinformationen für einen Mandanten. Bei gegebenen userIds werden Anzeigeinformationen aus User / SSOUser zurückgegeben. Wird vom Kommentar-Widget verwendet, um Benutzer anzureichern, die gerade durch ein Presence-Ereignis aufgetaucht sind. Kein Seitenkontext: Datenschutz wird einheitlich durchgesetzt (private Profile werden maskiert).
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | Pfad | Ja | |
| ids | string | Abfrage | Ja | Kommagetrennte userIds. |
Antwort
Gibt zurück: PageUsersInfoResponse
Beispiel

PatchPage 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: PatchPageAPIResponse
Beispiel

DeletePendingWebhookEvent 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetPendingWebhookEventCount 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Antwort
Gibt zurück: GetPendingWebhookEventCountResponse
Beispiel

GetPendingWebhookEvents 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nein | |
| externalId | string | query | Nein | |
| eventType | string | query | Nein | |
| type | string | query | Nein | |
| domain | string | query | Nein | |
| attemptCountGT | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetPendingWebhookEventsResponse
Beispiel

CreateQuestionConfig 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateQuestionConfigResponse
Beispiel

DeleteQuestionConfig 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetQuestionConfig 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetQuestionConfigResponse
Beispiel

GetQuestionConfigs 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetQuestionConfigsResponse
Beispiel

UpdateQuestionConfig 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

CreateQuestionResult 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Antwort
Gibt zurück: CreateQuestionResultResponse
Beispiel

DeleteQuestionResult 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetQuestionResult 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Gibt zurück: GetQuestionResultResponse
Beispiel

GetQuestionResults 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nein | |
| userId | string | query | Nein | |
| startDate | string | query | Nein | |
| questionId | string | query | Nein | |
| questionIds | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetQuestionResultsResponse
Beispiel

UpdateQuestionResult 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

AggregateQuestionResults 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nein | |
| questionIds | array | query | Nein | |
| urlId | string | query | Nein | |
| timeBucket | string | query | Nein | |
| startDate | string | query | Nein | |
| forceRecalculate | boolean | query | Nein |
Antwort
Gibt zurück: AggregateQuestionResultsResponse
Beispiel

BulkAggregateQuestionResults 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nein |
Antwort
Gibt zurück: BulkAggregateQuestionResultsResponse
Beispiel

CombineCommentsWithQuestionResults 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nein | |
| questionIds | array | query | Nein | |
| urlId | string | query | Nein | |
| startDate | string | query | Nein | |
| forceRecalculate | boolean | query | Nein | |
| minValue | number | query | Nein | |
| maxValue | number | query | Nein | |
| limit | number | query | Nein |
Antwort
Gibt zurück: CombineQuestionResultsWithCommentsResponse
Beispiel

AddSSOUser 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: AddSSOUserAPIResponse
Beispiel

DeleteSSOUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nein | |
| commentDeleteMode | string | query | Nein |
Antwort
Gibt zurück: DeleteSSOUserAPIResponse
Beispiel

GetSSOUserByEmail 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Antwort
Gibt zurück: GetSSOUserByEmailAPIResponse
Beispiel

GetSSOUserById 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetSSOUserByIdAPIResponse
Beispiel

GetSSOUsers 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nein |
Antwort
Rückgabe: GetSSOUsersResponse
Beispiel

PatchSSOUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nein |
Antwort
Gibt zurück: PatchSSOUserAPIResponse
Beispiel

PutSSOUser 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nein |
Antwort
Gibt zurück: PutSSOUserAPIResponse
Beispiel

CreateSubscription 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateSubscriptionAPIResponse
Beispiel

DeleteSubscription 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Antwort
Gibt zurück: DeleteSubscriptionAPIResponse
Beispiel

GetSubscriptions 
Parameter
| Name | Type | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: GetSubscriptionsAPIResponse
Beispiel

UpdateSubscription 
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: UpdateSubscriptionAPIResponse
Beispiel

GetTenantDailyUsages 
Parameters
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nein | |
| monthNumber | number | query | Nein | |
| dayNumber | number | query | Nein | |
| skip | number | query | Nein |
Response
Gibt zurück: GetTenantDailyUsagesResponse
Beispiel

CreateTenantPackage 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateTenantPackageResponse
Beispiel

DeleteTenantPackage 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetTenantPackage 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetTenantPackageResponse
Beispiel

GetTenantPackages 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetTenantPackagesResponse
Beispiel

ReplaceTenantPackage 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

UpdateTenantPackage 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

CreateTenantUser 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateTenantUserResponse
Beispiel

DeleteTenantUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nein | |
| commentDeleteMode | string | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetTenantUser 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetTenantUserResponse
Beispiel

GetTenantUsers 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetTenantUsersResponse
Beispiel

ReplaceTenantUser 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

SendLoginLink 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

UpdateTenantUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

CreateTenant 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateTenantResponse
Beispiel

DeleteTenant 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

GetTenant 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Gibt zurück: GetTenantResponse
Beispiel

GetTenants 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetTenantsResponse
Beispiel

UpdateTenant 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

ChangeTicketState 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: ChangeTicketStateResponse
Beispiel

CreateTicket 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Antwort
Gibt zurück: CreateTicketResponse
Beispiel

GetTicket 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: GetTicketResponse
Beispiel

GetTickets 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Antwort
Gibt zurück: GetTicketsResponse
Beispiel

GetTranslations 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Antwort
Gibt zurück: GetTranslationsResponse
Beispiel

UploadImage 
Bild hochladen und skalieren
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| sizePreset | string | query | Nein | Größenvoreinstellung: "Default" (1000x1000px) oder "CrossPlatform" (erstellt Größen für gängige Geräte) |
| urlId | string | query | Nein | Seiten-ID, von der der Upload erfolgt, zur Konfiguration |
Antwort
Gibt zurück: UploadImageResponse
Beispiel

GetUserBadgeProgressById 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIGetUserBadgeProgressResponse
Beispiel

GetUserBadgeProgressByUserId 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Antwort
Gibt zurück: APIGetUserBadgeProgressResponse
Beispiel

GetUserBadgeProgressList 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| limit | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: APIGetUserBadgeProgressListResponse
Beispiel

CreateUserBadge 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: APICreateUserBadgeResponse
Beispiel

DeleteUserBadge 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptySuccessResponse
Beispiel

GetUserBadge 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIGetUserBadgeResponse
Beispiel

GetUserBadges 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| badgeId | string | query | Nein | |
| type | number | query | Nein | |
| displayedOnComments | boolean | query | Nein | |
| limit | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: APIGetUserBadgesResponse
Beispiel

UpdateUserBadge 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptySuccessResponse
Beispiel

GetUserNotificationCount 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: GetUserNotificationCountResponse
Beispiel

GetUserNotifications 
Parameter
| Name | Typ | Speicherort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nein | Wird verwendet, um zu bestimmen, ob die aktuelle Seite abonniert ist. |
| pageSize | integer | query | Nein | |
| afterId | string | query | Nein | |
| includeContext | boolean | query | Nein | |
| afterCreatedAt | integer | query | Nein | |
| unreadOnly | boolean | query | Nein | |
| dmOnly | boolean | query | Nein | |
| noDm | boolean | query | Nein | |
| includeTranslations | boolean | query | Nein | |
| includeTenantNotifications | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: GetMyNotificationsResponse
Beispiel

ResetUserNotificationCount 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: ResetUserNotificationsResponse
Beispiel

ResetUserNotifications 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nein | |
| afterCreatedAt | integer | query | Nein | |
| unreadOnly | boolean | query | Nein | |
| dmOnly | boolean | query | Nein | |
| noDm | boolean | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: ResetUserNotificationsResponse
Beispiel

UpdateUserNotificationCommentSubscriptionStatus 
Aktivieren oder deaktivieren Sie Benachrichtigungen für einen bestimmten Kommentar.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Antwort
Gibt zurück: UpdateUserNotificationCommentSubscriptionStatusResponse
Beispiel

UpdateUserNotificationPageSubscriptionStatus 
Aktivieren oder deaktivieren Sie Benachrichtigungen für eine Seite. Wenn Benutzer für eine Seite abonniert sind, werden Benachrichtigungen für neue Root-Kommentare erstellt, und außerdem
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UpdateUserNotificationPageSubscriptionStatusResponse
Beispiel

UpdateUserNotificationStatus 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UpdateUserNotificationStatusResponse
Beispiel

GetUserPresenceStatuses 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Antwort
Gibt zurück: GetUserPresenceStatusesResponse
Beispiel

SearchUsers 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Antwort
Gibt zurück: SearchUsersResult
Beispiel

GetUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetUserResponse
Beispiel

CreateVote 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: VoteResponse
Beispiel

DeleteVote 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nein |
Antwort
Gibt zurück: VoteDeleteResponse
Beispiel

GetVotes 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Antwort
Gibt zurück: GetVotesResponse
Beispiel

GetVotesForUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Gibt zurück: GetVotesForUserResponse
Beispiel

Benötigen Sie Hilfe?
Wenn Sie auf Probleme stoßen oder Fragen zum Go SDK haben, dann:
Contributing
Beiträge sind willkommen! Bitte besuchen Sie das GitHub-Repository für Richtlinien zur Mitwirkung.