
Sprache 🇩🇪 Deutsch
Erste Schritte
Verwendung
Aggregation
Audit-Protokolle
Authentifizierung
Vom Kommentar sperren
Gesperrte Kommentare prüfen
Kommentare
Kommentare für Benutzer
Domain-Konfigurationen
E-Mail-Vorlagen
Ereignisprotokoll
Feed-Beiträge
Kommentar melden
Gifs
Hashtags
Moderation
Moderatoren
Benachrichtigungsanzahl
Benachrichtigungen
Seitenreaktionen
Seiten
Ausstehende Webhook-Ereignisse
Fragekonfigurationen
Frageergebnisse
Aggregation der Frageergebnisse
SSO-Benutzer
Abonnements
Tägliche Nutzung des Tenants
Mandantenpakete
Mandantenbenutzer
Mandanten
Tickets
Übersetzungen
Bild hochladen
Fortschritt Benutzerabzeichen
Benutzerabzeichen
Benutzerbenachrichtigungen
Anwesenheitsstatus des Benutzers
Benutzersuche
Benutzer
Stimmen
FastComments Go SDK
Dies ist das offizielle Go-SDK für FastComments.
Offizielles Go-SDK für die FastComments-API
Repository
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)
}
Verwendung 
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)
}
Aggregation 
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

Audit-Protokolle abrufen 
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

Öffentliche Abmeldung 
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

Vom Kommentar sperren (öffentlich) 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | Abfrage | Ja | |
| commentId | string | Pfad | Ja | |
| sso | string | Abfrage | Nein |
Antwort
Gibt zurück: BlockSuccess
Beispiel

Kommentar entsperren (öffentlich) 
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UnblockSuccess
Beispiel

Auf gesperrte Kommentare prüfen 
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

Benutzer vom Kommentar sperren 
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

Kommentar erstellen (öffentlich) 
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

Kommentar löschen 
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

Kommentar löschen (öffentlich) 
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

Kommentarstimme löschen 
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

Kommentar melden 
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

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

Kommentare abrufen 
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

Kommentare abrufen (öffentlich) 
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

Kommentartext abrufen 
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

Benutzernamen der Kommentarstimmen abrufen 
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

Kommentar sperren 
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

Kommentar anpinnen 
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

Kommentar speichern 
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

Kommentare massenhaft speichern 
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

Kommentartext setzen 
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

Benutzer vom Kommentar entsperren 
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

Meldung aufheben 
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

Kommentar entsperren 
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

Kommentar entpinnen 
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

Kommentar aktualisieren 
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

Kommentar bewerten 
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

Kommentare für Benutzer abrufen 
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

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

Domain-Konfiguration löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Antwort
Gibt zurück: DeleteDomainConfigResponse
Beispiel

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

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

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

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

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

E-Mail-Vorlage löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

Renderfehler der E-Mail-Vorlage löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

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

Definitionen der E-Mail-Vorlagen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: GetEmailTemplateDefinitionsResponse
Beispiel

Renderfehler der E-Mail-Vorlagen abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetEmailTemplateRenderErrorsResponse
Beispiel

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

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

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

Ereignisprotokoll abrufen 
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

Globales Ereignisprotokoll abrufen 
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

Feed-Beitrag erstellen 
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

Feed-Beitrag erstellen (öffentlich) 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: CreateFeedPostResponse
Beispiel

Feed-Beitrag löschen (öffentlich) 
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

Feed-Beiträge abrufen 
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

Feed-Beiträge abrufen (öffentlich) 
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

Statistiken der Feed-Beiträge abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: FeedPostsStatsResponse
Beispiel

Benutzerreaktionen abrufen (öffentlich) 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nein | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UserReactsResponse
Beispiel

Auf Feed-Beitrag reagieren (öffentlich) 
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

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

Feed-Beitrag aktualisieren (öffentlich) 
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

Kommentar melden (öffentlich) 
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

Großes Gif abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| largeInternalURLSanitized | string | query | Ja |
Antwort
Gibt zurück: GifGetLargeResponse
Beispiel

Gifs suchen 
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

Trendende Gifs abrufen 
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

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

Hashtags massenhaft hinzufügen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Antwort
Rückgabe: BulkCreateHashTagsResponse
Beispiel

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

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

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

Moderationsstimme löschen 
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

API-Kommentare abrufen 
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

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

API-IDs abrufen 
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

Vom Kommentar gesperrte Benutzer abrufen 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: GetBannedUsersFromCommentResponse
Beispiel

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

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

Anzahl abrufen 
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

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

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

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

Manuelle Abzeichen für Benutzer abrufen 
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

Moderationskommentar abrufen 
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

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

Vor-Bann-Zusammenfassung abrufen 
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

Suchkommentare-Zusammenfassung abrufen 
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

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

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

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

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

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

Benutzer-Bann-Präferenz abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIModerateGetUserBanPreferencesResponse
Beispiel

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

Kommentarbewertungen anpassen 
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

API-Export starten 
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

Benutzer wegen Kommentar bannen 
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

Benutzerban rückgängig machen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

Vor-Bann-Zusammenfassung (Bulk) erstellen 
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

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

Kommentar melden 
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

Kommentar entfernen 
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

Gelöschten Kommentar wiederherstellen 
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

Kommentargenehmigungsstatus setzen 
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

Kommentarprüfstatus setzen 
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

Kommentar-Spamstatus setzen 
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

Kommentartext setzen 
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

Meldung eines Kommentars aufheben 
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

Abstimmen 
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

Abzeichen verleihen 
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

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

Abzeichen entfernen 
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

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

Vertrauensfaktor setzen 
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

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

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

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

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

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

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

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

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

Benachrichtigungsanzahl abrufen 
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

Benachrichtigungen abrufen 
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

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

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

V2 Seitenreaktion erstellen 
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

V1 Seitenreaktion löschen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Antwort
Gibt zurück: CreateV1PageReact
Beispiel

V2 Seitenreaktion löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Antwort
Gibt zurück: CreateV1PageReact
Beispiel

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

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

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

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

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

Offline-Benutzer abrufen 
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

Online-Benutzer abrufen 
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

Seite nach URL-ID abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Antwort
Gibt zurück: GetPageByURLIdAPIResponse
Beispiel

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

Seiten abrufen (öffentlich) 
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

Benutzerinformationen abrufen 
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

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

Ausstehendes Webhook-Ereignis löschen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

Anzahl ausstehender Webhook-Ereignisse abrufen 
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

Ausstehende Webhook-Ereignisse abrufen 
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

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

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

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

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

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

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

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

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

Frageergebnisse abrufen 
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

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

Frageergebnisse aggregieren 
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

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

Kommentare mit Frageergebnissen kombinieren 
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

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

SSO-Benutzer löschen 
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

SSO-Benutzer per E-Mail abrufen 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Antwort
Gibt zurück: GetSSOUserByEmailAPIResponse
Beispiel

SSO-Benutzer per ID abrufen 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetSSOUserByIdAPIResponse
Beispiel

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

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

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

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

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

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

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

Tägliche Nutzung des Tenants abrufen 
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

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

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

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

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

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

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

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

Mandantenbenutzer löschen 
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

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

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

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

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

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

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

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

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

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

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

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

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

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

Tickets abrufen 
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

Übersetzungen abrufen 
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

Bild hochladen 
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

Benutzerabzeichen-Fortschritt nach ID abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: APIGetUserBadgeProgressResponse
Beispiel

Benutzerabzeichen-Fortschritt nach Benutzer-ID abrufen 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Antwort
Gibt zurück: APIGetUserBadgeProgressResponse
Beispiel

Liste des Benutzerabzeichen-Fortschritts abrufen 
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

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

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

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

Benutzerabzeichen abrufen 
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

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

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

Benutzerbenachrichtigungen abrufen 
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

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

Benutzerbenachrichtigungen zurücksetzen 
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

Kommentar-Abonnementstatus der Benutzerbenachrichtigung aktualisieren 
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

Seiten-Abonnementstatus der Benutzerbenachrichtigung aktualisieren 
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

Status der Benutzerbenachrichtigung aktualisieren 
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

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

Benutzer suchen 
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

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

Stimme erstellen 
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

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

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

Stimmen für Benutzer abrufen 
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.