
Sprache 🇩🇪 Deutsch
Dokumentation
Erste Schritte
API-Referenz
Agent-Mandanten
Aggregieren
Audit-Protokolle
Authentifizierung
Batch-Jobs
Blockieren vom Kommentar
Blockierte Kommentare prüfen
Kommentare
Kommentare für Benutzer
Domain-Konfigurationen
E-Mail-Vorlagen
Ereignisprotokoll
Feed-Beiträge
Kommentar melden
GIFs
Hashtags
Ich
Moderation
Moderatoren
Benachrichtigungszähler
Benachrichtigungen
Seitenreaktionen
Seiten
Ausstehende Webhook-Ereignisse
Umfrage-Stimmen
Umfragen
Fragenkonfigurationen
Frageresultate
Aggregation von Frageresultaten
SSO-Benutzer
Abonnements
Tägliche Nutzung des Mandanten
Mandantenpakete
Mandantenbenutzer
Mandanten
Tickets
Übersetzungen
Bild hochladen
Fortschritt der Benutzerabzeichen
Benutzerabzeichen
Benutzerbenachrichtigungen
Benutzerpräsenzstatus
Benutzersuche
Benutzer
Stimmen
Webhooks
FastComments Swift SDK
Dies ist das offizielle Swift SDK für FastComments.
Offizielles Swift SDK für die FastComments API
Repository
KI-Coding-Agenten 
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 
Swift Package Manager
Fügen Sie Folgendes zu Ihrer Package.swift-Datei hinzu:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Oder in Xcode:
- File > Add Packages...
- Geben Sie die Repository-URL ein:
https://github.com/fastcomments/fastcomments-swift.git - Wählen Sie die gewünschte Version aus
Voraussetzungen
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Bibliotheksinhalt 
Das FastComments Swift SDK besteht aus mehreren Modulen:
-
Client Module - API-Client für FastComments REST APIs
- Vollständige Typdefinitionen für alle API-Modelle
- Authentifizierte (
DefaultAPI), öffentliche (PublicAPI) und Moderations- (ModerationAPI) Methoden - Vollständige Unterstützung für async/await
- Siehe client/README.md für detaillierte API-Dokumentation
-
SSO Module - Serverseitige Single Sign-On-Dienstprogramme
- Sichere Token-Generierung für die Benutzerauthentifizierung
- Unterstützung für sowohl einfache als auch sichere SSO-Modi
- Token-Signatur auf HMAC-SHA256-Basis unter Verwendung von CryptoKit
Schnellstart 
Verwendung der öffentlichen API
import FastCommentsSwift
// Kommentare für eine Seite abrufen
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Verwendung der authentifizierten API
import FastCommentsSwift
// Konfigurieren Sie Ihren API-Schlüssel in der gemeinsam genutzten Konfiguration (gesendet als x-api-key Header)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Kommentare mit der authentifizierten API abrufen
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Verwendung der Moderations-API
import FastCommentsSwift
// Moderationsmethoden werden mit einem `sso`-Token für den handelnden Moderator autorisiert
// (generieren Sie ihn mit FastCommentsSSO, siehe den SSO-Abschnitt oben).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Verwendung von SSO zur Authentifizierung
Sicheres SSO (Empfohlen für die Produktion)
import FastCommentsSwift
let apiKey = "your-api-key"
// Erstelle sichere SSO-Benutzerdaten (nur serverseitig!)
let userData = SecureSSOUserData(
id: "user-123", // Benutzer-ID
email: "user@example.com", // E-Mail
username: "johndoe", // Benutzername
avatar: "https://example.com/avatar.jpg" // Avatar-URL
)
// Generate SSO token
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Übergib dieses Token an dein Frontend zur Authentifizierung
} catch {
print("Error creating SSO token: \(error)")
}
Einfaches SSO (Für Entwicklung/Tests)
import FastCommentsSwift
// Erstelle einfache SSO-Benutzerdaten (kein API-Schlüssel erforderlich)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Generate simple SSO token
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API-Clients 
Das FastComments SDK stellt drei API-Clients bereit:
PublicAPI – Client-sichere Methoden
Die PublicAPI enthält Methoden, die sicher vom clientseitigen Code (iOS/macOS‑Apps) aufgerufen werden können. Diese Methoden:
- Erfordern keinen API‑Schlüssel
- Können SSO‑Token zur Authentifizierung verwenden
- Sind pro Benutzer/Gerät rate‑limitiert
- Sind für End‑User‑Anwendungen geeignet
Beispielanwendung: Abrufen und Erstellen von Kommentaren in Ihrer iOS‑App
DefaultAPI – Serverseitige Methoden
Die DefaultAPI enthält authentifizierte Methoden, die einen API‑Schlüssel benötigen. Diese Methoden:
- Benötigen Ihren FastComments‑API‑Schlüssel
- Sollten NUR aus serverseitigem Code aufgerufen werden
- Bieten vollen Zugriff auf Ihre FastComments‑Daten
- Sind pro Mandant rate‑limitiert
Beispielanwendung: Administrative Vorgänge, Massendatenexport, Benutzermanagement
ModerationAPI – Methoden für das Moderator‑Dashboard
Die ModerationAPI bietet eine umfangreiche Sammlung von Live‑ und schnellen Moderations‑APIs. Jede ModerationAPI‑Methode akzeptiert einen sso‑Parameter und kann sich über SSO oder ein FastComments.com‑Session‑Cookie authentifizieren.
Beispielanwendung: Erstellung einer Moderations‑Erfahrung für Moderatoren Ihrer Community
WICHTIG: Setzen Sie Ihren API‑Schlüssel niemals im clientseitigen Code ein. API‑Schlüssel sollten nur serverseitig verwendet werden.
API-Aufrufe tätigen 
Das Swift SDK verwendet moderne async/await‑Syntax für alle API‑Aufrufe:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Häufige Probleme 
401 Unauthorized-Fehler
Wenn Sie 401-Fehler bei der Verwendung der authentifizierten API erhalten:
- Überprüfen Sie Ihren API-Schlüssel: Stellen Sie sicher, dass Sie den korrekten API-Schlüssel aus Ihrem FastComments-Dashboard verwenden
- Überprüfen Sie die Tenant-ID: Stellen Sie sicher, dass die Tenant-ID mit Ihrem Konto übereinstimmt
- Format des API-Schlüssels: Der API-Schlüssel sollte als
x-api-key-Header in der gemeinsamen Konfiguration gesetzt sein:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Verwendung der falschen API: Stellen Sie sicher, dass Sie
DefaultAPI(nichtPublicAPI) für authentifizierte Aufrufe verwenden
Probleme mit SSO-Tokens
Wenn SSO-Tokens nicht funktionieren:
- Verwenden Sie den sicheren Modus für die Produktion: Verwenden Sie für die Produktion immer
FastCommentsSSO.createSecure()mit Ihrem API-Schlüssel - Nur serverseitig: Generieren Sie sichere SSO-Tokens auf Ihrem Server und geben Sie Ihren API-Schlüssel niemals an Clients weiter
- Benutzerdaten prüfen: Stellen Sie sicher, dass alle erforderlichen Felder (id, email, username) angegeben sind
- Token-Ablauf: Sichere SSO-Tokens enthalten einen Zeitstempel und können ablaufen. Generieren Sie bei Bedarf neue Tokens.
SSL/TLS-Fehler
Wenn Sie auf SSL/TLS-Fehler stoßen:
- Stellen Sie sicher, dass die Info.plist Ihrer App HTTPS-Verbindungen zu fastcomments.com erlaubt
- Prüfen Sie, ob Sie keine App Transport Security-Ausnahmen verwenden, die die Verbindung blockieren könnten
Hinweise 
Broadcast-IDs
Sie werden sehen, dass Sie in einigen API-Aufrufen ein broadcastId übergeben sollen. Wenn Sie Ereignisse erhalten, bekommen Sie diese ID zurück, sodass Sie das Ereignis ignorieren können, falls Sie Änderungen auf dem Client optimistisch anwenden möchten (was Sie vermutlich tun sollten, da es die beste Nutzererfahrung bietet). Übergeben Sie hier eine UUID. Die ID sollte so eindeutig sein, dass sie innerhalb einer Sitzung nicht zweimal vorkommt.
let broadcastId = UUID().uuidString
createAgentTenant 
Erstellt ein neues Testkonto für einen KI‑Agenten ohne menschliche Anmeldung. Es wird kein API‑Schlüssel benötigt, um dies aufzurufen.
Die Antwort enthält die Mandanten‑ID, einen API‑Schlüssel, der sofort gegen die REST‑API und den MCP‑Server funktioniert, sowie eine Claim‑URL. Geben Sie die Claim‑URL an die Person weiter, für die Sie arbeiten: Das Öffnen der URL, während Sie bei FastComments angemeldet sind, verknüpft das Konto mit ihr. Nicht beanspruchte Konten und deren Schlüssel werden 72 Stunden nach Erstellung gelöscht. Bis zur Beanspruchung hat das Konto die üblichen Testlimits.
Response
Rückgabe: CreateAgentTenantResponse
Example

aggregate 
Aggregiert Dokumente, indem sie (falls groupBy angegeben ist) gruppiert und mehrere Operationen angewendet werden. Verschiedene Operationen (z. B. sum, countDistinct, avg usw.) werden unterstützt.
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nein | |
| includeStats | boolean | query | Nein |
Response
Returns: AggregateResponse
Example

getAuditLogs 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | Der Mandant, für den die Audit-Logs gelesen werden sollen. |
| limit | integer | query | Nein | Wie viele Logs zurückgegeben werden sollen. Maximal 10000, Standardwert 1000. |
| skip | integer | query | Nein | Wie viele Logs übersprungen werden sollen, für die Seitennavigation. |
| order | string | query | Nein | Sortierrichtung nach der Ereigniszeit. Standard ist DESC (neueste zuerst). |
| after | integer | query | Nein | |
| before | integer | query | Nein | |
| username | string | query | Nein | Nur Ereignisse zurückgeben, die von diesem Benutzernamen durchgeführt wurden. |
| ip | string | query | Nein | Nur Ereignisse von dieser IP-Adresse zurückgeben. |
| crudType | string | query | Nein | Nur Ereignisse dieses Typs zurückgeben: c, r, u, d oder login. |
| resourceName | string | query | Nein | Nur Ereignisse für diese Ressource zurückgeben, z. B. User oder Moderator. |
| targetId | string | query | Nein | Nur Ereignisse zurückgeben, deren betroffener Gegenstand diese ID hat. |
| target | string | query | Nein | Fallunabhängige Teilstring‑Übereinstimmung im Label des betroffenen Objekts, z. B. ein Benutzername oder eine E‑Mail. |
| includeManagedTenants | boolean | query | Nein | Auch Ereignisse von Mandanten zurückgeben, die dieser Mandant verwaltet. |
Antwort
Rückgabe: GetAuditLogsResponse
Beispiel

logoutPublic 
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

getBatchJob 
Status, Fortschritt und, nach Abschluss, das Ergebnis eines Batch-Jobs.
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Rückgabe: GetBatchJobAPIResponse
Beispiel

getBatchJobs 
Die Batch-Jobs des Mandanten (Importe, Exporte, Seitenmigrationen...), neueste zuerst.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| type | string | query | No | Nur Jobs dieses Typs, zum Beispiel migrate-pages. |
| status | string | query | No | Nur Jobs mit diesem Status: requested, running, success oder failed. |
| skip | integer | query | No | Wie viele Jobs übersprungen werden sollen, für die Seitennavigation. |
Response
Returns: GetBatchJobsAPIResponse
Example

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

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

checkedCommentsForBlocked 
Parameter
| Name | Typ | Ort | 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 | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Rückgabe: BlockSuccess
Beispiel

createCommentPublic 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No | |
| locale | string | query | No |
Antwort
Rückgabe: 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
Rückgabe: DeleteCommentResult
Beispiel

deleteCommentPublic 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: PublicAPIDeleteCommentResponse
Beispiel

deleteCommentVote 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: VoteDeleteResponse
Beispiel

flagComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein | |
| anonUserId | string | query | Nein |
Antwort
Rückgabe: FlagCommentResponse
Beispiel

getComment 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: 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
Rückgabe: APIGetCommentsResponse
Beispiel

getCommentsPublic 
Anfrage
tenantId
urlId
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No | |
| questionId | string | query | No | |
| questionValue | integer | query | No |
Antwort
Returns: GetCommentsResponseWithPresencePublicComment
Beispiel

getCommentText 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Rückgabe: PublicAPIGetCommentTextResponse
Example

getCommentVoteUserNames 
Parameter
| Name | Typ | Ort | 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 | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nein |
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
Rückgabe: APISaveCommentResponse
Beispiel

saveCommentsBulk 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Antwort
Rückgabe: [SaveCommentsBulkResponse]
Beispiel

setCommentText 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Antwort
Returns: PublicAPISetCommentTextResponse
Beispiel

translateComments 
Übersetzt die gegebenen Kommentare in die Widget-Locale. Nur verfügbar, wenn die entsprechende Widget-Anpassungsregel für Comment Translation auf Automatic oder Manual eingestellt ist.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nein | |
| locale | string | query | Nein |
Antwort
Gibt zurück: CommentTranslationsResponse
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
Rückgabe: 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
Rückgabe: 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 | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Antwort
Returns: APIEmptyResponse
Beispiel

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

getCommentsForUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
Antwort
Rückgabe: GetCommentsForUserResponse
Beispiel

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

deleteDomainConfig 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Antwort
Rückgabe: DeleteDomainConfigResponse
Beispiel

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

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

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

putDomainConfig 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

getEmailTemplate 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | 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 | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Antwort
Gibt zurück: GetEmailTemplateRenderErrorsResponse
Beispiel

getEmailTemplates 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Antwort
Rückgabe: CreateFeedPostsResponse
Beispiel

createFeedPostPublic 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: CreateFeedPostResponse
Beispiel

deleteFeedPostPublic 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: DeleteFeedPostPublicResponse
Beispiel

getFeedPosts 
req tenantId afterId
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nein | |
| limit | integer | query | Nein | |
| tags | array | query | Nein |
Antwort
Gibt zurück: GetFeedPostsResponse
Beispiel

getFeedPostsPublic 
Anforderung
tenantId
afterId
Parameter
| Name | Typ | Ort | 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
Rückgabe: PublicFeedPostsResponse
Beispiel

getFeedPostsStats 
Parameter
| Name | Typ | Location | 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
Rückgabe: UserReactsResponse
Beispiel

reactFeedPostPublic 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: ReactFeedPostResponse
Beispiel

updateFeedPost 
Parameters
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Gibt zurück: APIEmptyResponse
Example

updateFeedPostPublic 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Rückgabe: 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 | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nein | |
| rating | string | query | Nein | |
| page | number | query | Nein |
Antwort
Rückgabe: 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
Rückgabe: 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 | Ja |
Antwort
Rückgabe: BulkCreateHashTagsResponse
Beispiel

deleteHashTag 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

getHashTags 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No |
Antwort
Gibt zurück: GetHashTagsResponse
Beispiel

patchHashTag 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Antwort
Rückgabe: UpdateHashTagResponse
Beispiel

getMe 
Identifiziert das verwendete Anmeldecredential: den Mandanten, zu dem es gehört, und bei OAuth-Token den Benutzer, der es autorisiert hat.
Integrationen verwenden dies, um eine Verbindung zu testen und zu kennzeichnen.
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Rückgabe: GetMeResponse
Example

deleteModerationVote 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: VoteDeleteResponse
Beispiel

getApiComments 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nein | |
| sso | string | query | Nein |
Response
Rückgabe: ModerationExportStatusResponse
Example

getApiIds 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: ModerationAPIGetCommentIdsResponse
Beispiel

getBanUsersFromComment 
Parameter
| 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 | Location | 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 | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
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 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: GetBannedUsersCountResponse
Beispiel

getLogs 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: 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 | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
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 | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Response
Rückgabe: 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
Rückgabe: GetUserTrustFactorResponse
Beispiel

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

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

postAdjustCommentVotes 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: AdjustVotesResponse
Beispiel

postApiExport 
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 | |
| sorts | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: ModerationExportResponse
Beispiel

postBanUserFromComment 
Parameter
| 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 |
Antwort
Rückgabe: BanUserFromCommentResult
Beispiel

postBanUserUndo 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
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
Returns: ModerationAPIChildCommentsResponse
Beispiel

postFlagComment 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
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
Returns: 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 | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: SetCommentApprovedResponse
Beispiel

postSetCommentReviewStatus 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| reviewed | boolean | query | Nein | |
| broadcastId | string | query | Nein | |
| sso | string | query | Nein |
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 | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
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 | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Rückgabe: VoteResponse
Beispiel

putAwardBadge 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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: 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 | 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: RemoveUserBadgeResponse
Beispiel

putReopenThread 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

setTrustFactor 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| trustFactor | string | query | Nein | |
| sso | string | query | Nein |
Antwort
Rückgabe: SetUserTrustFactorResponse
Beispiel

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

deleteModerator 
Parameter
| Name | Typ | Location | 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 | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

updateModerator 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: 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 | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Gibt zurück: GetCachedNotificationCountResponse
Beispiel

getNotificationCount 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Antwort
Rückgabe: GetNotificationCountResponse
Beispiel

getNotifications 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Antwort
Returns: GetNotificationsResponse
Beispiel

updateNotification 
Parameter
| Name | Typ | Ort | 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 | |
| sso | string | query | Nein |
Antwort
Rückgabe: 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 | |
| sso | string | query | Nein |
Antwort
Rückgabe: CreateV1PageReact
Beispiel

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

deleteV2PageReact 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Rückgabe: CreateV1PageReact
Beispiel

getV1PageLikes 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Wenn gesetzt, werden die Benutzer zurückgegeben, die die Seite geliked haben (Avatare und Benutzernamen). Nur "public" wird akzeptiert, wodurch private Profile weggelassen werden. |
Antwort
Rückgabe: GetV1PageLikes
Beispiel

getV2PageReacts 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nein | |
| includeUserInfo | string | query | Nein | Wenn gesetzt, werden die Benutzer für jede Reaktions‑ID zurückgegeben (Avatare und Benutzernamen). Nur "public" wird akzeptiert, wodurch private Profile weggelassen werden. |
Rückgabe
Rückgabe: GetV2PageReacts
Beispiel

getV2PageReactUsers 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| sso | string | query | No |
Antwort
Rückgabe: GetV2PageReactUsersResponse
Beispiel

addPage 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Gibt zurück: AddPageAPIResponse
Beispiel

deletePage 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: DeletePageAPIResponse
Beispiel

getOfflineUsers 
Frühere Kommentatoren auf der Seite, die NICHT aktuell online sind. Sortiert nach displayName. Verwenden Sie dies, nachdem /users/online ausgeschöpft wurde, um einen „Members“-Abschnitt darzustellen. Cursor-Paginierung über commenterName: Der Server durchläuft den partiellen {tenantId, urlId, commenterName} Index ab afterName vorwärts mittels $gt, ohne $skip-Kosten.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | Seiten-URL-Identifikator (serverseitig bereinigt). |
| afterName | string | query | Nein | Cursor: nextAfterName aus der vorherigen Antwort übergeben. |
| afterUserId | string | query | Nein | Cursor-Tiebreaker: nextAfterUserId aus der vorherigen Antwort übergeben. Erforderlich, wenn afterName gesetzt ist, damit Namensgleiche keine Einträge verlieren. |
Antwort
Gibt zurück: PageUsersOfflineResponse
Beispiel

getOnlineUsers 
Aktuell online betrachter einer Seite: Personen, deren Websocket‑Sitzung gerade die Seite abonniert hat.
Gibt anonCount + totalCount zurück (räumweite Abonnenten, einschließlich anonymer Betrachter, die wir nicht aufzählen).
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Seiten-URL-Bezeichner (serverseitig bereinigt). |
| afterName | string | query | No | Cursor: nextAfterName aus der vorherigen Antwort übergeben. |
| afterUserId | string | query | No | Cursor‑Tiebreaker: nextAfterUserId aus der vorherigen Antwort übergeben. Erforderlich, wenn afterName gesetzt ist, damit Namensgleichheiten keine Einträge entfernen. |
Response
Rückgabe: PageUsersOnlineResponse
Example

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

getPageLikes 
Like‑Zähler für eine Seite, optional mit den Benutzern, die sie geliked haben.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| includeUserInfo | string | query | No | "public" lässt Benutzer mit privaten Profilen weg, "include-private" schließt sie ein. |
Antwort
Rückgabe: GetPageLikesAPIResponse
Beispiel

getPageReacts 
Benutzerdefinierte Reaktionszähler für eine Seite, optional mit den Benutzern, die reagiert haben.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| includeUserInfo | string | query | Nein | "public" lässt Benutzer mit privaten Profilen aus, "include-private" schließt sie ein. |
Antwort
Rückgabe: GetPageReactsAPIResponse
Beispiel

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

getPagesPublic 
Listet Seiten für einen Tenant auf. 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 gegen den Gruppenzugriff des anfragenden Benutzers gefiltert.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| cursor | string | query | Nein | Opaker Paginierungs-Cursor, der als nextCursor von einer vorherigen Anfrage zurückgegeben wurde. An denselben sortBy gebunden. |
| limit | integer | query | Nein | 1..200, Standard 50 |
| q | string | query | Nein | Optionaler Filter für Titel-Präfix, Groß-/Kleinschreibung wird nicht beachtet. |
| sortBy | string | query | Nein | Sortierreihenfolge. updatedAt (Standard, neueste zuerst), commentCount (meiste Kommentare zuerst) oder title (alphabetisch). |
| hasComments | boolean | query | Nein | Wenn true, werden nur Seiten mit mindestens einem Kommentar zurückgegeben. |
Antwort
Gibt zurück: GetPublicPagesResponse
Beispiel

getUsersInfo 
Massenbenutzerinformationen für einen Mandanten. Anhand von userIds werden Anzeigeinformationen aus User / SSOUser zurückgegeben. Wird vom Kommentar-Widget verwendet, um Benutzer anzureichern, die gerade über ein Präsenzereignis erschienen sind. Kein Seitenkontext: Der Datenschutz wird einheitlich durchgesetzt (private Profile werden maskiert).
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| ids | string | query | Ja | Kommagetrennte userIds. |
Antwort
Gibt zurück: PageUsersInfoResponse
Beispiel

migratePages 
Stellt einen Batch-Job in die Warteschlange, der Kommentare, Seiten und zugehörige Datensätze von einer urlId oder Domain auf eine andere verschiebt. "urlId"-Migrationen treffen nur die exakte urlId. "domain"-Migrationen suchen/ersetzen den Wert in jeder urlId und url. Rufen Sie GET /api/v1/batch-jobs/{batchJobId} ab: Sobald der Vorgang abgeschlossen ist, enthält er die Ergebnisse pro Migration und eine undoId.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: QueuePageMigrationJobAPIResponse
Beispiel

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

undoPageMigrations 
Stellt einen Batch‑Job in die Warteschlange, der jede Migration von einem migrate‑pages‑Job umkehrt, beginnend mit dem neuesten. Verfügbar für 90 Tage. Änderungen, die seit der Migration vorgenommen wurden, bleiben unverändert, sodass eine spätere Bearbeitung niemals überschrieben wird. Abfragen Sie GET /api/v1/batch-jobs/{batchJobId} für die wiederhergestellten/übersprungenen Zähler.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| undoId | string | path | Ja |
Antwort
Rückgabe: QueuePageMigrationJobAPIResponse
Beispiel

deletePendingWebhookEvent 
Parameter
| Name | Typ | Location | 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
Rückgabe: GetPendingWebhookEventCountResponse
Beispiel

getPendingWebhookEvents 
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 | |
| skip | number | query | No |
Antwort
Rückgabe: GetPendingWebhookEventsResponse
Beispiel

createPollVote 
Stimme zu einer Umfrage ab oder verschiebe eine bestehende Stimme zu einer anderen Option. Ein Wähler hat maximal eine Stimme pro Umfrage, daher verschiebt ein erneuter Aufruf für denselben Wähler seine Stimme, anstatt eine weitere hinzuzufügen.
Dies folgt den Umfrageeinstellungen der Website: Wenn die Abstimmung nur für angemeldete Benutzer erlaubt ist, wird eine Stimme nur mit anonUserId abgelehnt, und anonyme Stimmen werden pro IP pro Umfrage ratenbegrenzt.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreatePollVoteResponse
Beispiel

deletePollVote 
Retract a vote. The option it was cast on gives its tally back.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Rückgabe: DeletePollVoteResponse
Beispiel

getPollVote 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Returns: GetPollVoteResponse
Beispiel

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
Eine Umfrage gehört zu einem Kommentar, daher werden Stimmen immer eine Umfrage nach der anderen gelesen – commentId ist erforderlich. Das hält jede Abfrage auf den bereits vorhandenen Indexen der Sammlung.
Beachtet die Privatsphäre der Umfrage: Stimmen einer anonymen Umfrage können nicht gelesen werden (poll-anonymous), weder hier noch per ID.
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| voterId | string | query | No | |
| optionId | string | query | No | |
| skip | integer | query | No |
Response
Returns: GetPollVotesResponse
Example

deletePoll 
Entfernt eine Umfrage aus ihrem Kommentar, zusammen mit allen abgegebenen Stimmen. Der Kommentar selbst bleibt unverändert.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

getPoll 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja |
Antwort
Rückgabe: GetPollResponse
Beispiel

getPollVoters 
Who voted for which option. Anonymous polls never answer, admins-only polls answer only for an admin or moderator.
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
Response
Rückgabe: GetPollVoterNamesSuccessResponse
Beispiel

patchPoll 
Bearbeiten Sie eine Umfrage direkt, ohne die Stimmen zu verlieren: Ändern Sie die Frage, benennen Sie eine Option um, schließen oder öffnen Sie sie erneut, oder ändern Sie, wer die Wähler sehen darf. Optionen werden über die id adressiert – um sie hinzuzufügen, zu entfernen oder neu zu ordnen, senden Sie die vollständige Liste per PUT.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja |
Antwort
Gibt zurück: SavePollResponse
Beispiel

putPoll 
Hängt eine Umfrage an einen Kommentar an oder setzt den vollständigen Zustand der Umfrage, die er bereits hat.
Optionen werden anhand der id abgeglichen: Eine Option, die mit der id einer bestehenden Option gesendet wird, behält ihre Stimmen (und übernimmt das neue Label und die neue Position), eine Option ohne id wird hinzugefügt, und bestehende Optionen, die in der Liste fehlen, werden zusammen mit den auf sie abgegebenen Stimmen entfernt.
Wenn keine bestehenden Options-IDs auf einer Umfrage mit Stimmen beibehalten werden, werden alle gelöscht, daher ist dafür replaceVotes=true erforderlich.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| replaceVotes | boolean | query | Nein |
Antwort
Gibt zurück: SavePollResponse
Beispiel

votePoll 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Antwort
Returns: VotePollResponse
Beispiel

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

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

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

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

updateQuestionConfig 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

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

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

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

getQuestionResults 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Antwort
Returns: GetQuestionResultsResponse
Beispiel

updateQuestionResult 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

aggregateQuestionResults 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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
Rückgabe: 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 | Ort | 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
Rückgabe: CombineQuestionResultsWithCommentsResponse
Beispiel

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

deleteSSOUser 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Antwort
Rückgabe: DeleteSSOUserAPIResponse
Beispiel

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

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

getSSOUsers 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nein |
Antwort
Gibt zurück: 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 | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nein |
Antwort
Gibt zurück: PutSSOUserAPIResponse
Beispiel

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

deleteSubscription 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Antwort
Rückgabe: DeleteSubscriptionAPIResponse
Beispiel

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

updateSubscription 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nein |
Antwort
Gibt zurück: UpdateSubscriptionAPIResponse
Beispiel

getTenantDailyUsages 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Antwort
Rückgabe: GetTenantDailyUsagesResponse
Beispiel

createTenantPackage 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes |
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 | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Gibt zurück: GetTenantPackageResponse
Beispiel

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

replaceTenantPackage 
Parameter
| Name | Typ | Ort | 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 | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwort
Gibt zurück: CreateTenantUserResponse
Beispiel

deleteTenantUser 
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nein | |
| commentDeleteMode | string | query | Nein |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

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

getTenantUsers 
Parameter
| Name | Type | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nein |
Antwort
Rückgabe: GetTenantUsersResponse
Beispiel

replaceTenantUser 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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 | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nein |
Antwort
Gibt zurück: APIEmptyResponse
Beispiel

updateTenantUser 
Parameter
| Name | Typ | Location | 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
Rückgabe: CreateTenantResponse
Beispiel

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

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

getTenants 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Antwort
Rückgabe: GetTenantsResponse
Beispiel

updateTenant 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwort
Rückgabe: 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 | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Ja | |
| userId | string | query | Nein | |
| state | number | query | Nein | |
| skip | number | query | Nein | |
| limit | number | query | Nein |
Antwort
Rückgabe: GetTicketsResponse
Beispiel

getTranslations 
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| namespace | string | path | Ja | |
| component | string | path | Ja | |
| locale | string | query | Nein | |
| useFullTranslationIds | boolean | query | Nein |
Antwort
Rückgabe: GetTranslationsResponse
Beispiel

uploadImage 
Upload and resize an image
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Größenpreset: "Default" (1000x1000px) oder "CrossPlatform" (erstellt Größen für gängige Geräte) |
| urlId | string | query | No | Seiten-ID, von der der Upload ausgeführt wird, zur Konfiguration |
Response
Rückgabe: UploadImageResponse
Example

getUserBadgeProgressById 
Parameter
| Name | Typ | Location | 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 | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nein | |
| limit | number | query | Nein | |
| skip | number | query | Nein |
Antwort
Rückgabe: APIGetUserBadgeProgressListResponse
Beispiel

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

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

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

getUserBadges 
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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
Rückgabe: 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 | Ort | 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
Rückgabe: GetMyNotificationsResponse
Beispiel

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

resetUserNotifications 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Returns: ResetUserNotificationsResponse
Beispiel

updateUserNotificationCommentSubscriptionStatus 
Benachrichtigungen für einen bestimmten Kommentar aktivieren oder deaktivieren.
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| optedInOrOut | string | path | Ja | |
| commentId | string | query | Ja | |
| sso | string | query | Nein |
Antwort
Gibt zurück: UpdateUserNotificationCommentSubscriptionStatusResponse
Beispiel

updateUserNotificationPageSubscriptionStatus 
Aktivieren oder Deaktivieren von Benachrichtigungen für eine Seite. Wenn Benutzer zu einer Seite abonniert sind, werden Benachrichtigungen für neue Root-Kommentare erstellt, und auch
Parameter
| Name | Typ | Location | Erforderlich | Beschreibung |
|---|---|---|---|---|
| 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 | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nein |
Response
Gibt zurück: UpdateUserNotificationStatusResponse
Beispiel

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

searchUsers 
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Antwort
Rückgabe: 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
Returns: 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 | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | Abfrage | Ja | |
| urlId | string | Abfrage | 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
Rückgabe: GetVotesForUserResponse
Beispiel

createWebhook 
Abonniert eine URL für ein Kommentarereignis (REST‑Hook‑Abonnement). Das erneute Abonnieren derselben URL für dasselbe Ereignis und dieselbe Domain gibt das bestehende Abonnement zurück. Lieferungen sind HMAC‑signiert, siehe den Webhooks‑Leitfaden; der veraltete token‑Header wird bei API‑Abonnements niemals gesendet.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreateWebhookResponse
Example

deleteWebhook 
Unsubscribes (REST hook unsubscribe). Nur über diese API erstellte Abonnements können hier gelöscht werden; dashboard‑verwaltete Webhooks werden im Dashboard bearbeitet.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwort
Rückgabe: APIEmptyResponse
Beispiel

getWebhooks 
Listet die für den Tenant konfigurierten Webhooks auf, sowohl dashboard-verwaltete Einträge als auch API-Abonnements.
Parameter
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| event | string | query | Nein | |
| domain | string | query | Nein | |
| source | string | query | Nein | |
| skip | number | query | Nein |
Antwort
Gibt zurück: GetWebhooksResponse
Beispiel

getWebhookSamplePayloads 
Recent comments in exactly the shape webhook deliveries use, for building integrations (for example Zapier sample data). Every event delivers the same comment object, so event only has to be valid.
Parameters
| Name | Typ | Ort | Erforderlich | Beschreibung |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| event | string | query | Nein | |
| limit | number | query | Nein |
Response
Returns: GetWebhookSamplePayloadsResponse
Example

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