
Sprache 🇩🇪 Deutsch
Erste Schritte
API-Referenz
Dokumentation
Verwendung
Aggregation
Audit-Protokolle
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
Moderatoren
Benachrichtigungsanzahl
Benachrichtigungen
Seitenreaktionen
Seiten
Ausstehende Webhook-Ereignisse
Fragekonfigurationen
Frageergebnisse
Aggregation von Frageergebnissen
SSO-Benutzer
Abonnements
Tägliche Mandantennutzung
Mandantenpakete
Mandantenbenutzer
Mandanten
Tickets
Übersetzungen
Bild hochladen
Fortschritt der Benutzerabzeichen
Benutzerabzeichen
Benutzerbenachrichtigungen
Anwesenheitsstatus der Benutzer
Benutzersuche
Benutzer
Abstimmungen
FastComments JavaScript/TypeScript SDK
Dies ist das offizielle JavaScript/TypeScript-SDK für FastComments.
Verwalten Sie Kommentare, Benutzer, SSO und Moderation von Node.js oder dem Browser aus.
Repository
API-Dokumentation 
Vollständige API-Referenz: docs/api/README.md
Browser- vs. Server-Kompatibilität 
Dieses SDK verwendet zwei Einstiegspunkte, um optimale Kompatibilität sicherzustellen und Laufzeitfehler zu vermeiden:
fastcomments-sdk/browser- Browser-sichere Version mit nativerfetch-Unterstützungfastcomments-sdk/server- Vollständige Node.js-Version mit SSO-Unterstützungfastcomments-sdk(Standard) - Nur Typen, sicher überall zu importieren
Verwendung 
Dieses SDK bietet getrennte Einstiegspunkte für Browser- und Server-Umgebungen, um optimale Kompatibilität und Sicherheit zu gewährleisten:
Browser-Nutzung (Clientseitig)
Für Browser-/Frontend-Anwendungen verwenden Sie den browser-sicheren Export, der Node.js-Abhängigkeiten ausschließt:
// Browser-sicherer Import (keine Node.js-Abhängigkeiten)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';
// Create browser SDK instance
const sdk = createFastCommentsBrowserSDK({
basePath: 'https://fastcomments.com' // optional, Standardwert ist https://fastcomments.com
});
// Verwende öffentliche APIs (kein API-Schlüssel erforderlich - sicher für Browser)
const comments = await sdk.publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-url-id'
});
Server-Nutzung (Node.js)
Für Server-/Backend-Anwendungen verwenden Sie das vollständige SDK mit SSO- und Authentifizierungsfunktionen:
// Serverseitiger Import (inkl. SSO und für NodeJS ausgelegt)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';
// Create server SDK instance
const sdk = createFastCommentsSDK({
apiKey: 'your-api-key', // Halten Sie diesen geheim auf dem Server!
basePath: 'https://fastcomments.com' // optional, Standardwert ist https://fastcomments.com
});
// Verwenden Sie geschützte APIs mit Ihrem API-Schlüssel
const comments = await sdk.defaultApi.getComments({
tenantId: 'your-tenant-id',
urlId: 'page-url-id'
});
Nur Typen-Import
Wenn Sie nur TypeScript-Typen benötigen (kein Laufzeitcode), verwenden Sie den Standardimport:
// Nur Typen (keine Laufzeitabhängigkeiten - überall sicher)
import type {
PublicComment,
CreateCommentParams,
GetCommentsPublic200Response
} from 'fastcomments-sdk';
Verwendung einzelner API-Klassen
Browser-Umgebung
import { PublicApi, Configuration } from 'fastcomments-sdk/browser';
const config = new Configuration({
basePath: 'https://fastcomments.com'
});
const publicApi = new PublicApi(config);
Server-Umgebung
import { DefaultApi, PublicApi, Configuration } from 'fastcomments-sdk/server';
const config = new Configuration({
apiKey: 'your-api-key',
basePath: 'https://fastcomments.com'
});
const defaultApi = new DefaultApi(config);
const publicApi = new PublicApi(config);
Öffentliche vs. gesicherte APIs 
Das SDK stellt drei Haupt-API-Klassen bereit:
DefaultApi- Gesicherte Endpunkte, die deinen API-Schlüssel zur Authentifizierung erfordern. Verwende diese für serverseitige Operationen.PublicApi- Öffentliche Endpunkte, die ohne API-Schlüssel zugänglich sind. Diese können direkt aus Browsern/Mobilgeräten/etc. aufgerufen werden.HiddenApi- Interne/Admin-Endpunkte für fortgeschrittene Anwendungsfälle.
Beispiel: Verwendung der Public API (browser-sicher)
import { PublicApi } from 'fastcomments-sdk/browser';
const publicApi = new PublicApi();
// Kommentare für eine Seite abrufen (kein API-Schlüssel erforderlich)
const response = await publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-url-id'
});
Beispiel: Verwendung der Default API (nur serverseitig)
import { DefaultApi, Configuration } from 'fastcomments-sdk/server';
const config = new Configuration({
apiKey: 'your-api-key' // Dies geheim halten!
});
const defaultApi = new DefaultApi(config);
// Kommentare mit vollem Admin-Zugriff abrufen
const response = await defaultApi.getComments({
tenantId: 'your-tenant-id',
urlId: 'page-url-id'
});
SSO (Single Sign-On)-Integration 
FastComments unterstützt SSO, um sich in Ihr bestehendes Benutzerauthentifizierungssystem zu integrieren. Die SSO-Funktionalität ist nur im Server-Export verfügbar, da sie Node.js-Crypto-Funktionen benötigt.
Einfache SSO (nur serverseitig)
Einfache SSO sollte serverseitig erzeugt und an den Client gesendet werden:
// Server-seitiger Code (Node.js/Backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';
// Erstelle einfache SSO mit dem eingebauten Helfer
const userData = {
username: 'john_doe',
email: 'john@example.com',
displayName: 'John Doe',
avatar: 'https://example.com/avatar.jpg'
};
const sso = FastCommentsSSO.createSimple(userData, {
loginURL: '/login',
logoutURL: '/logout'
});
const ssoToken = sso.createToken();
// Sende ssoToken an Ihren Client-Code
// Der Client-Code kann dieses Token dann mit dem Browser-SDK verwenden
Sichere SSO (serverseitig, empfohlen)
Sichere SSO sollte serverseitig implementiert werden und bietet bessere Sicherheit:
// Server-seitiger Code (Node.js/Backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';
// Erstelle sichere SSO mit dem eingebauten Helfer
const userData = {
id: 'user-123',
email: 'john@example.com',
username: 'john_doe',
displayName: 'John Doe',
avatar: 'https://example.com/avatar.jpg',
isAdmin: false,
isModerator: false
};
const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
loginURL: '/login',
logoutURL: '/logout'
});
const ssoConfig = sso.prepareToSend();
// Mit API-Aufrufen auf dem Server verwenden
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-url-id',
sso: JSON.stringify(ssoConfig)
});
// Oder sende ssoConfig an den Client zur Browser-Verwendung
Verwendung von SSO im Browser (mit servergeneriertem Token)
// Client-seitiger Code (Browser)
import { PublicApi } from 'fastcomments-sdk/browser';
// Hole SSO-Token von Ihrem Server-Endpunkt
const ssoToken = await fetch('/api/sso-token').then(r => r.json());
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-url-id',
sso: ssoToken // Use the server-generated SSO token
});
SSO mit Kommentar-Erstellung
// Server-seitig: SSO und Kommentar erstellen
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';
const sso = FastCommentsSSO.createSecure('your-api-key', userData);
const ssoConfig = sso.prepareToSend();
const response = await publicApi.createCommentPublic({
tenantId: 'your-tenant-id',
urlId: 'page-url-id',
broadcastId: 'unique-broadcast-id',
commentData: {
comment: 'This is my comment',
date: Date.now(),
commenterName: 'John Doe',
url: 'https://example.com/page',
urlId: 'page-url-id'
},
sso: JSON.stringify(ssoConfig)
});
Häufige Anwendungsfälle 
Kommentare für eine Seite abrufen
const comments = await sdk.publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'article-123'
});
Einen Kommentar erstellen
const newComment = await sdk.publicApi.createCommentPublic({
createCommentParams: {
tenantId: 'your-tenant-id',
urlId: 'article-123',
comment: 'Great article!',
commenterName: 'John Doe',
commenterEmail: 'john@example.com'
}
});
Für einen Kommentar abstimmen
const voteResponse = await sdk.publicApi.voteComment({
voteBodyParams: {
commentId: 'comment-id',
direction: 1 // 1 für Upvote, -1 für Downvote
}
});
Benutzerverwaltung (erfordert API-Schlüssel)
// Benutzer suchen (erfordert DefaultApi)
const users = await sdk.defaultApi.searchUsers({
tenantId: 'your-tenant-id',
urlId: 'page-id',
usernameStartsWith: 'john'
});
Live-Ereignisse (Echtzeit-Aktualisierungen) 
Abonnieren Sie Live-Ereignisse, um Echtzeit-Updates für Kommentare, Abstimmungen und andere Aktivitäten zu erhalten.
Ereignisse auf Seitenebene
Abonnieren Sie Live-Ereignisse für eine bestimmte Seite (Kommentare, Abstimmungen usw.):
import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';
const config = {
tenantId: 'your-tenant-id',
urlId: 'page-url-id',
};
// Subscribe to live events for a page
const subscription = subscribeToChanges(
config,
'your-tenant-id', // tenantIdWS
'page-url-id', // urlIdWS
'user-session-id', // userIdWS (get this from getComments response)
(event: LiveEvent) => {
console.log('Live event received:', event);
switch (event.type) {
case LiveEventType.new_comment:
console.log('New comment:', event.comment);
// Aktualisieren Sie Ihre UI mit dem neuen Kommentar
break;
case LiveEventType.new_vote:
console.log('New vote:', event.vote);
// Aktualisieren Sie die Abstimmungszahlen in Ihrer UI
break;
case LiveEventType.updated_comment:
console.log('Comment updated:', event.comment);
break;
default:
console.log('Other event type:', event.type);
}
return true; // Geben Sie true zurück, wenn das Ereignis verarbeitet wurde
},
(isConnected: boolean) => {
console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
}
);
// Close the subscription when done
subscription.close();
Benutzerbezogene Ereignisse abonnieren
Abonnieren Sie benutzerspezifische Ereignisse (Benachrichtigungen, Erwähnungen usw.):
import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';
const userConfig = {
userIdWS: 'user-session-id', // Get this from getComments response
};
// Subscribe to user's personal feed
const userSubscription = subscribeToUserFeed(
userConfig,
(event: LiveEvent) => {
console.log('User event received:', event);
switch (event.type) {
case LiveEventType.notification:
console.log('New notification:', event.notification);
// Benachrichtigung in Ihrer UI anzeigen
break;
case LiveEventType.notification_update:
console.log('Notification updated:', event.notification);
break;
default:
console.log('Other user event:', event.type);
}
return true;
},
(isConnected: boolean) => {
console.log('User feed connection:', isConnected ? 'Connected' : 'Disconnected');
}
);
// Close when done
userSubscription.close();
Abrufen von userIdWS
Der userIdWS Parameter wird für Live-Ereignisse benötigt und kann aus API-Antworten abgerufen werden:
const response = await sdk.publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-id'
});
// Extract userIdWS from the response
const userIdWS = response.data?.userSessionInfo?.userIdWS;
if (userIdWS) {
// Now you can subscribe to live events
const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}
Broadcast-IDs 
Sie werden sehen, dass Sie in einigen API-Aufrufen eine 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 wahrscheinlich tun sollten, da es die beste Erfahrung bietet). Geben Sie hier eine UUID an. Die ID sollte so eindeutig sein, dass sie in einer Browsersitzung nicht zweimal vorkommt.
import { v4 as uuidv4 } from 'uuid';
const response = await sdk.publicApi.createCommentPublic({
createCommentParams: {
tenantId: 'your-tenant-id',
urlId: 'page-id',
comment: 'My comment',
broadcastId: uuidv4() // Eindeutige ID für diese Operation
}
});
Fehlerbehandlung 
try {
const comments = await sdk.publicApi.getCommentsPublic({
tenantId: 'your-tenant-id',
urlId: 'page-id'
});
} catch (error) {
if (error.response?.status === 404) {
console.log('Page not found');
} else {
console.error('API Error:', error.message);
}
}
aggregate 
Aggregiert Dokumente durch Gruppierung (wenn groupBy angegeben ist) und Anwendung mehrerer Operationen. Verschiedene Operationen (z. B. sum, countDistinct, avg usw.) werden unterstützt.
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| aggregationRequest | AggregationRequest | Ja | |
| parentTenantId | string | Nein | |
| includeStats | boolean | Nein |
Antwort
Gibt zurück: Aggregate200Response
Beispiel

getAuditLogs 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| limit | number | Nein | |
| skip | number | Nein | |
| order | SORTDIR | Nein | |
| after | number | Nein | |
| before | number | Nein |
Antwort
Gibt zurück: GetAuditLogs200Response
Beispiel

blockFromCommentPublic 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: BlockFromCommentPublic200Response
Beispiel

unBlockCommentPublic 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: UnBlockCommentPublic200Response
Beispiel

checkedCommentsForBlocked 
Parameters
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentIds | string | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: CheckedCommentsForBlocked200Response
Beispiel

blockUserFromComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| blockFromCommentParams | BlockFromCommentParams | Ja | |
| userId | string | Nein | |
| anonUserId | string | Nein |
Antwort
Gibt zurück: BlockFromCommentPublic200Response
Beispiel

createCommentPublic 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| broadcastId | string | Ja | |
| commentData | CommentData | Ja | |
| sessionId | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: CreateCommentPublic200Response
Beispiel

deleteComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| contextUserId | string | Nein | |
| isLive | boolean | Nein |
Antwort
Gibt zurück: DeleteComment200Response
Beispiel

deleteCommentPublic 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| editKey | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: DeleteCommentPublic200Response
Beispiel

deleteCommentVote 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| voteId | string | Ja | |
| urlId | string | Ja | |
| broadcastId | string | Ja | |
| editKey | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: DeleteCommentVote200Response
Beispiel

flagComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| userId | string | Nein | |
| anonUserId | string | Nein |
Antwort
Gibt zurück: FlagComment200Response
Beispiel

getComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetComment200Response
Beispiel

getComments 
Parameter
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| page | number | Nein | |
| limit | number | Nein | |
| skip | number | Nein | |
| asTree | boolean | Nein | |
| skipChildren | number | Nein | |
| limitChildren | number | Nein | |
| maxTreeDepth | number | Nein | |
| urlId | string | Nein | |
| userId | string | Nein | |
| anonUserId | string | Nein | |
| contextUserId | string | Nein | |
| hashTag | string | Nein | |
| parentId | string | Nein | |
| direction | SortDirections | Nein | |
| fromDate | number | Nein | |
| toDate | number | Nein |
Antwort
Gibt zurück: GetComments200Response
Beispiel

getCommentsPublic 
req tenantId urlId
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| page | number | Nein | |
| direction | SortDirections | Nein | |
| sso | string | Nein | |
| skip | number | Nein | |
| skipChildren | number | Nein | |
| limit | number | Nein | |
| limitChildren | number | Nein | |
| countChildren | boolean | Nein | |
| fetchPageForCommentId | string | Nein | |
| includeConfig | boolean | Nein | |
| countAll | boolean | Nein | |
| includei10n | boolean | Nein | |
| locale | string | Nein | |
| modules | string | Nein | |
| isCrawler | boolean | Nein | |
| includeNotificationCount | boolean | Nein | |
| asTree | boolean | Nein | |
| maxTreeDepth | number | Nein | |
| useFullTranslationIds | boolean | Nein | |
| parentId | string | Nein | |
| searchText | string | Nein | |
| hashTags | Array | Nein | |
| userId | string | Nein | |
| customConfigStr | string | Nein | |
| afterCommentId | string | Nein | |
| beforeCommentId | string | Nein |
Antwort
Gibt zurück: GetCommentsPublic200Response
Beispiel

getCommentText 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| editKey | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: GetCommentText200Response
Beispiel

getCommentVoteUserNames 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| dir | number | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: GetCommentVoteUserNames200Response
Beispiel

lockComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: LockComment200Response
Beispiel

pinComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: PinComment200Response
Beispiel

saveComment 
Parameter
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| createCommentParams | CreateCommentParams | Ja | |
| isLive | boolean | Nein | |
| doSpamCheck | boolean | Nein | |
| sendEmails | boolean | Nein | |
| populateNotifications | boolean | Nein |
Antwort
Gibt zurück: SaveComment200Response
Beispiel

saveCommentsBulk 
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createCommentParams | Array | Ja | |
| isLive | boolean | Nein | |
| doSpamCheck | boolean | Nein | |
| sendEmails | boolean | Nein | |
| populateNotifications | boolean | Nein |
Antwort
Gibt zurück: Array<SaveComment200Response
Beispiel

setCommentText 
Parameters
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Ja | |
| editKey | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: SetCommentText200Response
Beispiel

unBlockUserFromComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Ja | |
| userId | string | Nein | |
| anonUserId | string | Nein |
Antwort
Gibt zurück: UnBlockCommentPublic200Response
Beispiel

unFlagComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| userId | string | Nein | |
| anonUserId | string | Nein |
Antwort
Gibt zurück: FlagComment200Response
Beispiel

unLockComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: LockComment200Response
Beispiel

unPinComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| broadcastId | string | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: PinComment200Response
Beispiel

updateComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updatableCommentParams | UpdatableCommentParams | Ja | |
| contextUserId | string | Nein | |
| doSpamCheck | boolean | Nein | |
| isLive | boolean | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

voteComment 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| urlId | string | Ja | |
| broadcastId | string | Ja | |
| voteBodyParams | VoteBodyParams | Ja | |
| sessionId | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: VoteComment200Response
Beispiel

getCommentsForUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| userId | string | Nein | |
| direction | SortDirections | Nein | |
| repliesToUserId | string | Nein | |
| page | number | Nein | |
| includei10n | boolean | Nein | |
| locale | string | Nein | |
| isCrawler | boolean | Nein |
Antwort
Gibt zurück: GetCommentsForUser200Response
Beispiel

addDomainConfig 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| addDomainConfigParams | AddDomainConfigParams | Ja |
Antwort
Gibt zurück: AddDomainConfig200Response
deleteDomainConfig 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| domain | string | Ja |
Antwort
Gibt zurück: DeleteDomainConfig200Response
getDomainConfig 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| domain | string | Ja |
Antwort
Gibt zurück: GetDomainConfig200Response
getDomainConfigs 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja |
Antwort
Gibt zurück: GetDomainConfigs200Response
patchDomainConfig 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| domainToUpdate | string | Ja | |
| patchDomainConfigParams | PatchDomainConfigParams | Ja |
Antwort
Gibt zurück: GetDomainConfig200Response
putDomainConfig 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| domainToUpdate | string | Ja | |
| updateDomainConfigParams | UpdateDomainConfigParams | Ja |
Antwort
Gibt zurück: GetDomainConfig200Response
createEmailTemplate 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createEmailTemplateBody | CreateEmailTemplateBody | Ja |
Antwort
Gibt zurück: CreateEmailTemplate200Response
Beispiel

deleteEmailTemplate 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

deleteEmailTemplateRenderError 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| errorId | string | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getEmailTemplate 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetEmailTemplate200Response
Beispiel

getEmailTemplateDefinitions 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja |
Antwort
Gibt zurück: GetEmailTemplateDefinitions200Response
Beispiel

getEmailTemplateRenderErrors 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| skip | number | Nein |
Antwort
Gibt zurück: GetEmailTemplateRenderErrors200Response
Beispiel

getEmailTemplates 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nein |
Antwort
Gibt zurück: GetEmailTemplates200Response
Beispiel

renderEmailTemplate 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Ja | |
| locale | string | Nein |
Antwort
Gibt zurück: RenderEmailTemplate200Response
Beispiel

updateEmailTemplate 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getEventLog 
req tenantId urlId userIdWS
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userIdWS | string | Ja | |
| startTime | number | Ja | |
| endTime | number | Nein |
Antwort
Gibt zurück: GetEventLog200Response
Beispiel

getGlobalEventLog 
req tenantId urlId userIdWS
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userIdWS | string | Ja | |
| startTime | number | Ja | |
| endTime | number | Nein |
Antwort
Gibt zurück: GetEventLog200Response
Beispiel

createFeedPost 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createFeedPostParams | CreateFeedPostParams | Ja | |
| broadcastId | string | Nein | |
| isLive | boolean | Nein | |
| doSpamCheck | boolean | Nein | |
| skipDupCheck | boolean | Nein |
Antwort
Gibt zurück: CreateFeedPost200Response
Beispiel

createFeedPostPublic 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createFeedPostParams | CreateFeedPostParams | Ja | |
| broadcastId | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: CreateFeedPostPublic200Response
Beispiel

deleteFeedPostPublic 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| postId | string | Ja | |
| broadcastId | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: DeleteFeedPostPublic200Response
Beispiel

getFeedPosts 
req tenantId afterId
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| afterId | string | Nein | |
| limit | number | Nein | |
| tags | Array | Nein |
Antwort
Gibt zurück: GetFeedPosts200Response
Beispiel

getFeedPostsPublic 
req tenantId afterId
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| afterId | string | Nein | |
| limit | number | Nein | |
| tags | Array | Nein | |
| sso | string | Nein | |
| isCrawler | boolean | Nein | |
| includeUserInfo | boolean | Nein |
Antwort
Gibt zurück: GetFeedPostsPublic200Response
Beispiel

getFeedPostsStats 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| postIds | Array | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: GetFeedPostsStats200Response
Beispiel

getUserReactsPublic 
Parameter
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| postIds | Array | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: GetUserReactsPublic200Response
Beispiel

reactFeedPostPublic 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| postId | string | Ja | |
| reactBodyParams | ReactBodyParams | Ja | |
| isUndo | boolean | Nein | |
| broadcastId | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: ReactFeedPostPublic200Response
Beispiel

updateFeedPost 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| feedPost | FeedPost | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

updateFeedPostPublic 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| postId | string | Ja | |
| updateFeedPostParams | UpdateFeedPostParams | Ja | |
| broadcastId | string | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: CreateFeedPostPublic200Response
Beispiel

flagCommentPublic 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| isFlagged | boolean | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getGifLarge 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| largeInternalURLSanitized | string | Ja |
Antwort
Gibt zurück: GetGifLarge200Response
Beispiel

getGifsSearch 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| search | string | Ja | |
| locale | string | Nein | |
| rating | string | Nein | |
| page | number | Nein |
Antwort
Gibt zurück: GetGifsSearch200Response
Beispiel

getGifsTrending 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| locale | string | Nein | |
| rating | string | Nein | |
| page | number | Nein |
Antwort
Gibt zurück: GetGifsTrending200Response
Beispiel

addHashTag 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Nein | |
| createHashTagBody | CreateHashTagBody | Nein |
Antwort
Gibt zurück: AddHashTag200Response
Beispiel

addHashTagsBulk 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Nein | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | Nein |
Antwort
Gibt zurück: AddHashTagsBulk200Response
Beispiel

deleteHashTag 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tag | string | Ja | |
| tenantId | string | Nein | |
| deleteHashTagRequest | DeleteHashTagRequest | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getHashTags 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| page | number | Nein |
Antwort
Gibt zurück: GetHashTags200Response
Beispiel

patchHashTag 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tag | string | Ja | |
| tenantId | string | Nein | |
| updateHashTagBody | UpdateHashTagBody | Nein |
Antwort
Gibt zurück: PatchHashTag200Response
Beispiel

createModerator 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createModeratorBody | CreateModeratorBody | Ja |
Antwort
Gibt zurück: CreateModerator200Response
Beispiel

deleteModerator 
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| sendEmail | string | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getModerator 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetModerator200Response
Beispiel

getModerators 
Parameter
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nein |
Response
Gibt zurück: GetModerators200Response
Beispiel

sendInvite 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| fromName | string | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

updateModerator 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateModeratorBody | UpdateModeratorBody | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

deleteNotificationCount 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getCachedNotificationCount 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetCachedNotificationCount200Response
Beispiel

getNotificationCount 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nein | |
| urlId | string | Nein | |
| fromCommentId | string | Nein | |
| viewed | boolean | Nein | |
| type | string | Nein |
Antwort
Gibt zurück: GetNotificationCount200Response
Beispiel

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

updateNotification 
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateNotificationBody | UpdateNotificationBody | Ja | |
| userId | string | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

createV1PageReact 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| title | string | Nein |
Antwort
Gibt zurück: CreateV1PageReact200Response
Beispiel

createV2PageReact 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| id | string | Ja | |
| title | string | Nein |
Antwort
Gibt zurück: CreateV2PageReact200Response
Beispiel

deleteV1PageReact 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja |
Antwort
Gibt zurück: DeleteV1PageReact200Response
Beispiel

deleteV2PageReact 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: DeleteV2PageReact200Response
Beispiel

getV1PageLikes 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja |
Antwort
Gibt zurück: GetV1PageLikes200Response
Beispiel

getV2PageReacts 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja |
Antwort
Gibt zurück: GetV2PageReacts200Response
Beispiel

getV2PageReactUsers 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetV2PageReactUsers200Response
Beispiel

addPage 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createAPIPageData | CreateAPIPageData | Ja |
Antwort
Gibt zurück: AddPageAPIResponse
deletePage 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: DeletePageAPIResponse
getOfflineUsers 
Frühere Kommentatoren auf der Seite, die DERZEIT NICHT online sind. Nach displayName sortiert. Verwenden Sie dies nachdem Sie /users/online ausgeschöpft haben, um einen "Members"-Abschnitt darzustellen. Cursor-Pagination auf commenterName: der Server durchläuft den partiellen {tenantId, urlId, commenterName} Index ab afterName vorwärts mittels $gt, keine $skip-Kosten.
Parameter
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| afterName | string | Nein | |
| afterUserId | string | Nein |
Antwort
Gibt zurück: GetOfflineUsers200Response
Beispiel

getOnlineUsers 
Zurzeit online befindliche Zuschauer einer Seite: Personen, deren websocket session gerade auf die Seite abonniert ist. Gibt anonCount + totalCount zurück (raumweite Abonnenten, einschließlich anonymer Zuschauer, die wir nicht aufzählen).
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| afterName | string | Nein | |
| afterUserId | string | Nein |
Antwort
Gibt zurück: GetOnlineUsers200Response
Beispiel

getPageByURLId 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja |
Antwort
Gibt zurück: GetPageByURLIdAPIResponse
getPagesPublic 
Listet Seiten für einen Mandanten. Wird vom FChat-Desktop-Client verwendet, um dessen Raumliste zu füllen.
enableFChat muss in der aufgelösten benutzerdefinierten Konfiguration für jede Seite auf true gesetzt sein.
Seiten, die SSO erfordern, werden anhand der Gruppenberechtigungen des anfragenden Benutzers gefiltert.
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| cursor | string | Nein | |
| limit | number | Nein | |
| q | string | Nein | |
| sortBy | PagesSortBy | Nein | |
| hasComments | boolean | Nein |
Antwort
Gibt zurück: GetPagesPublic200Response
Beispiel

getUsersInfo 
Massen-Benutzerinformationen für einen tenant. Gibt für die angegebenen userIds Anzeigeinformationen aus User / SSOUser zurück. Wird vom Kommentar-Widget verwendet, um Benutzer zu ergänzen, die gerade via a presence event erschienen sind. Kein Seitenkontext: Die Privatsphäre wird einheitlich durchgesetzt (private Profile werden maskiert).
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Yes | |
| ids | string | Yes |
Antwort
Gibt zurück: GetUsersInfo200Response
Beispiel

patchPage 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateAPIPageData | UpdateAPIPageData | Ja |
Antwort
Gibt zurück: PatchPageAPIResponse
deletePendingWebhookEvent 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getPendingWebhookEventCount 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Nein | |
| externalId | string | Nein | |
| eventType | string | Nein | |
| type | string | Nein | |
| domain | string | Nein | |
| attemptCountGT | number | Nein |
Antwort
Gibt zurück: GetPendingWebhookEventCount200Response
Beispiel

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

createQuestionConfig 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createQuestionConfigBody | CreateQuestionConfigBody | Ja |
Antwort
Gibt zurück: CreateQuestionConfig200Response
Beispiel

deleteQuestionConfig 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getQuestionConfig 
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetQuestionConfig200Response
Beispiel

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

updateQuestionConfig 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

createQuestionResult 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createQuestionResultBody | CreateQuestionResultBody | Ja |
Response
Gibt zurück: CreateQuestionResult200Response
Beispiel

deleteQuestionResult 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Rückgabe: FlagCommentPublic200Response
Beispiel

getQuestionResult 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetQuestionResult200Response
Beispiel

getQuestionResults 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Nein | |
| userId | string | Nein | |
| startDate | string | Nein | |
| questionId | string | Nein | |
| questionIds | string | Nein | |
| skip | number | Nein |
Antwort
Gibt zurück: GetQuestionResults200Response
Beispiel

updateQuestionResult 
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateQuestionResultBody | UpdateQuestionResultBody | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

aggregateQuestionResults 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| questionId | string | Nein | |
| questionIds | Array | Nein | |
| urlId | string | Nein | |
| timeBucket | AggregateTimeBucket | Nein | |
| startDate | Date | Nein | |
| forceRecalculate | boolean | Nein |
Antwort
Gibt zurück: AggregateQuestionResults200Response
Beispiel

bulkAggregateQuestionResults 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Ja | |
| forceRecalculate | boolean | Nein |
Antwort
Gibt zurück: BulkAggregateQuestionResults200Response
Beispiel

combineCommentsWithQuestionResults 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| questionId | string | Nein | |
| questionIds | Array | Nein | |
| urlId | string | Nein | |
| startDate | Date | Nein | |
| forceRecalculate | boolean | Nein | |
| minValue | number | Nein | |
| maxValue | number | Nein | |
| limit | number | Nein |
Antwort
Gibt zurück: CombineCommentsWithQuestionResults200Response
Beispiel

addSSOUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createAPISSOUserData | CreateAPISSOUserData | Ja |
Antwort
Gibt zurück: AddSSOUserAPIResponse
deleteSSOUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| deleteComments | boolean | Nein | |
| commentDeleteMode | string | Nein |
Antwort
Gibt zurück: DeleteSSOUserAPIResponse
getSSOUserByEmail 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| string | Ja |
Antwort
Gibt zurück: GetSSOUserByEmailAPIResponse
getSSOUserById 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetSSOUserByIdAPIResponse
getSSOUsers 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nein |
Antwort
Gibt zurück: GetSSOUsers200Response
patchSSOUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateAPISSOUserData | UpdateAPISSOUserData | Ja | |
| updateComments | boolean | Nein |
Antwort
Gibt zurück: PatchSSOUserAPIResponse
putSSOUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateAPISSOUserData | UpdateAPISSOUserData | Ja | |
| updateComments | boolean | Nein |
Antwort
Gibt zurück: PutSSOUserAPIResponse
Beispiel

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

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

updateSubscription 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateAPIUserSubscriptionData | UpdateAPIUserSubscriptionData | Ja | |
| userId | string | Nein |
Antwort
Gibt zurück: UpdateSubscriptionAPIResponse
Beispiel

getTenantDailyUsages 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| yearNumber | number | Nein | |
| monthNumber | number | Nein | |
| dayNumber | number | Nein | |
| skip | number | Nein |
Antwort
Gibt zurück: GetTenantDailyUsages200Response
Beispiel

createTenantPackage 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createTenantPackageBody | CreateTenantPackageBody | Ja |
Antwort
Gibt zurück: CreateTenantPackage200Response
Beispiel

deleteTenantPackage 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getTenantPackage 
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetTenantPackage200Response
Beispiel

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

replaceTenantPackage 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

updateTenantPackage 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateTenantPackageBody | UpdateTenantPackageBody | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

createTenantUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createTenantUserBody | CreateTenantUserBody | Ja |
Antwort
Gibt zurück: CreateTenantUser200Response
Beispiel

deleteTenantUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| deleteComments | string | Nein | |
| commentDeleteMode | string | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getTenantUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Antwort
Gibt zurück: GetTenantUser200Response
Beispiel

getTenantUsers 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| skip | number | Nein |
Antwort
Gibt zurück: GetTenantUsers200Response
Beispiel

replaceTenantUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| replaceTenantUserBody | ReplaceTenantUserBody | Ja | |
| updateComments | string | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

sendLoginLink 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| redirectURL | string | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

updateTenantUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateTenantUserBody | UpdateTenantUserBody | Ja | |
| updateComments | string | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

createTenant 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createTenantBody | CreateTenantBody | Ja |
Antwort
Gibt zurück: CreateTenant200Response
Beispiel

deleteTenant 
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| sure | string | Nein |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

getTenant 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Rückgabe: GetTenant200Response
Beispiel

getTenants 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| meta | string | Nein | |
| skip | number | Nein |
Antwort
Gibt zurück: GetTenants200Response
Beispiel

updateTenant 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateTenantBody | UpdateTenantBody | Ja |
Antwort
Gibt zurück: FlagCommentPublic200Response
Beispiel

changeTicketState 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Ja | |
| id | string | Ja | |
| changeTicketStateBody | ChangeTicketStateBody | Ja |
Antwort
Gibt zurück: ChangeTicketState200Response
Beispiel

createTicket 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Ja | |
| createTicketBody | CreateTicketBody | Ja |
Antwort
Gibt zurück: CreateTicket200Response
Beispiel

getTicket 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| userId | string | Nein |
Antwort
Gibt zurück: GetTicket200Response
Beispiel

getTickets 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nein | |
| state | number | Nein | |
| skip | number | Nein | |
| limit | number | Nein |
Antwort
Gibt zurück: GetTickets200Response
Beispiel

getTranslations 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| namespace | string | Ja | |
| component | string | Ja | |
| locale | string | Nein | |
| useFullTranslationIds | boolean | Nein |
Antwort
Gibt zurück: GetTranslations200Response
Beispiel

uploadImage 
Bild hochladen und skalieren
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| file | Blob | Ja | |
| sizePreset | SizePreset | Nein | |
| urlId | string | Nein |
Antwort
Gibt zurück: UploadImageResponse
getUserBadgeProgressById 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetUserBadgeProgressById200Response
Beispiel

getUserBadgeProgressByUserId 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Ja |
Antwort
Gibt zurück: GetUserBadgeProgressById200Response
Beispiel

getUserBadgeProgressList 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nein | |
| limit | number | Nein | |
| skip | number | Nein |
Antwort
Gibt zurück: GetUserBadgeProgressList200Response
Beispiel

createUserBadge 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| createUserBadgeParams | CreateUserBadgeParams | Ja |
Antwort
Gibt zurück: CreateUserBadge200Response
Beispiel

deleteUserBadge 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: UpdateUserBadge200Response
Beispiel

getUserBadge 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetUserBadge200Response
Beispiel

getUserBadges 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| userId | string | Nein | |
| badgeId | string | Nein | |
| type | number | Nein | |
| displayedOnComments | boolean | Nein | |
| limit | number | Nein | |
| skip | number | Nein |
Antwort
Gibt zurück: GetUserBadges200Response
Beispiel

updateUserBadge 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| updateUserBadgeParams | UpdateUserBadgeParams | Ja |
Antwort
Gibt zurück: UpdateUserBadge200Response
Beispiel

getUserNotificationCount 
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: GetUserNotificationCount200Response
Beispiel

getUserNotifications 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Nein | |
| pageSize | number | Nein | |
| afterId | string | Nein | |
| includeContext | boolean | Nein | |
| afterCreatedAt | number | Nein | |
| unreadOnly | boolean | Nein | |
| dmOnly | boolean | Nein | |
| noDm | boolean | Nein | |
| includeTranslations | boolean | Nein | |
| includeTenantNotifications | boolean | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: GetUserNotifications200Response
Beispiel

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

resetUserNotifications 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| afterId | string | Nein | |
| afterCreatedAt | number | Nein | |
| unreadOnly | boolean | Nein | |
| dmOnly | boolean | Nein | |
| noDm | boolean | Nein | |
| sso | string | Nein |
Antwort
Gibt zurück: ResetUserNotifications200Response
Beispiel

updateUserNotificationCommentSubscriptionStatus 
Benachrichtigungen für einen bestimmten Kommentar aktivieren oder deaktivieren.
Parameters
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Yes | |
| notificationId | string | Yes | |
| optedInOrOut | UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum | Yes | |
| commentId | string | Yes | |
| sso | string | No |
Response
Gibt zurück: UpdateUserNotificationStatus200Response
Example

updateUserNotificationPageSubscriptionStatus 
Benachrichtigungen für eine Seite aktivieren oder deaktivieren. Wenn Benutzer für eine Seite abonniert sind, werden Benachrichtigungen für neue Root-Kommentare erstellt, und auch
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| url | string | Ja | |
| pageTitle | string | Ja | |
| subscribedOrUnsubscribed | UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: UpdateUserNotificationStatus200Response
Beispiel

updateUserNotificationStatus 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| notificationId | string | Ja | |
| newStatus | UpdateUserNotificationStatusNewStatusEnum | Ja | |
| sso | string | Nein |
Antwort
Gibt zurück: UpdateUserNotificationStatus200Response
Beispiel

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

searchUsers 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| usernameStartsWith | string | Nein | |
| mentionGroupIds | Array | Nein | |
| sso | string | Nein | |
| searchSection | SearchUsersSearchSectionEnum | Nein |
Antwort
Gibt zurück: SearchUsers200Response
Beispiel

getUser 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja |
Antwort
Gibt zurück: GetUser200Response
Beispiel

createVote 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| commentId | string | Ja | |
| direction | CreateVoteDirectionEnum | Ja | |
| userId | string | Nein | |
| anonUserId | string | Nein |
Antwort
Rückgabe: VoteComment200Response
Beispiel

deleteVote 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| id | string | Ja | |
| editKey | string | Nein |
Antwort
Gibt zurück: DeleteCommentVote200Response
Beispiel

getVotes 
Parameter
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja |
Antwort
Gibt zurück: GetVotes200Response
Beispiel

getVotesForUser 
Parameter
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| tenantId | string | Ja | |
| urlId | string | Ja | |
| userId | string | Nein | |
| anonUserId | string | Nein |
Antwort
Gibt zurück: GetVotesForUser200Response
Beispiel

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