FastComments JavaScript/TypeScript SDK

Dit is de officiële JavaScript/TypeScript SDK voor FastComments.

Beheer reacties, gebruikers, SSO en moderatie vanuit Node.js of de browser.

Repository

Installatie

npm install fastcomments-sdk

API-documentatie

Volledige API-referentie: docs/api/README.md

Browser- versus servercompatibiliteit

Deze SDK gebruikt dubbele toegangspunten om optimale compatibiliteit te waarborgen en runtime-fouten te voorkomen:

fastcomments-sdk/browser - Browserveilige versie met native fetch
fastcomments-sdk/server - Volledige Node.js-versie met SSO-ondersteuning
fastcomments-sdk (standaard) - Alleen types, veilig om overal te importeren

Gebruik

Deze SDK biedt afzonderlijke toegangspunten voor browser- en serveromgevingen om optimale compatibiliteit en beveiliging te garanderen:

Browsergebruik (Client-Side)

Voor browser/frontend-applicaties, gebruik de browserveilige export die Node.js-afhankelijkheden uitsluit:

// Browser-veilige import (geen Node.js-afhankelijkheden)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Maak een browser SDK-instantie
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Gebruik openbare API's (geen API-sleutel nodig - veilig voor browsers)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Servergebruik (Node.js)

Voor server/backend-applicaties, gebruik de volledige SDK met SSO- en authenticatiefuncties:

// Server-side import (inclusief SSO en ontworpen om te werken met NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Maak een server SDK-instantie
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Houd dit geheim op de server!
  basePath: 'https://fastcomments.com' // optional, defaults to https://fastcomments.com
});

// Gebruik beveiligde API's met uw API-sleutel
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Alleen types importeren

Als u alleen TypeScript-typen nodig heeft (geen runtime-code), gebruik dan de standaardimport:

// Alleen types (geen runtime-afhankelijkheden - overal veilig)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Gebruik van individuele API-klassen

Browseromgeving

import { PublicApi, Configuration } from 'fastcomments-sdk/browser';

const config = new Configuration({
  basePath: 'https://fastcomments.com'
});

const publicApi = new PublicApi(config);

Serveromgeving

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);

Openbare versus beveiligde API's

De SDK biedt drie hoofd-API-klassen:

DefaultApi - Beveiligde endpoints die uw API-sleutel vereisen voor authenticatie. Gebruik deze voor serverzijde-bewerkingen.
PublicApi - Publieke endpoints die kunnen worden benaderd zonder API-sleutel. Deze kunnen rechtstreeks vanuit browsers/mobiele apparaten/etc. worden aangeroepen.
HiddenApi - Interne/admin endpoints voor geavanceerde gebruikssituaties.

Voorbeeld: Public API gebruiken (browser-veilig)

import { PublicApi } from 'fastcomments-sdk/browser';

const publicApi = new PublicApi();

// Haal reacties op voor een pagina (geen API-sleutel vereist)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Voorbeeld: Default API gebruiken (alleen serverzijde)

import { DefaultApi, Configuration } from 'fastcomments-sdk/server';

const config = new Configuration({
  apiKey: 'your-api-key' // Houd dit geheim!
});
const defaultApi = new DefaultApi(config);

// Haal reacties op met volledige beheerdersrechten
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO (Single Sign-On)-integratie

FastComments ondersteunt SSO om te integreren met uw bestaande gebruikersauthenticatiesysteem. SSO-functionaliteit is alleen beschikbaar in de server-export omdat het Node.js crypto-functies vereist.

Eenvoudige SSO (Alleen serverzijde)

Eenvoudige SSO moet aan de serverzijde worden gegenereerd en naar de client worden gestuurd:

// Code aan de serverzijde (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Maak eenvoudige SSO met de ingebouwde helper  
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();

// Stuur ssoToken naar uw client-side code
// Client-side code kan dit token vervolgens gebruiken met de browser SDK

Beveiligde SSO (Server-side, aanbevolen)

Beveiligde SSO moet aan de serverzijde worden geïmplementeerd en biedt betere beveiliging:

// Code aan de serverzijde (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Maak beveiligde SSO met de ingebouwde helper
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();

// Gebruik met API-aanroepen op de server
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Of stuur ssoConfig naar de client voor gebruik in de browser

SSO gebruiken vanuit de browser (met door de server gegenereerd token)

// Code aan de clientzijde (browser)
import { PublicApi } from 'fastcomments-sdk/browser';

// Haal SSO-token op van uw server-endpoint
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 // Gebruik het door de server gegenereerde SSO-token
});

SSO met het aanmaken van een reactie

// Server-side: Maak SSO en reactie
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)
});

Veelvoorkomende gebruiksscenario's

Reacties ophalen voor een pagina

const comments = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'article-123'
});

Een reactie aanmaken

const newComment = await sdk.publicApi.createCommentPublic({
  createCommentParams: {
    tenantId: 'your-tenant-id',
    urlId: 'article-123',
    comment: 'Great article!',
    commenterName: 'John Doe',
    commenterEmail: 'john@example.com'
  }
});

Stemmen op een reactie

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 voor omhoog stemmen, -1 voor omlaag stemmen
  }
});

Gebruikersbeheer (vereist API-sleutel)

// Zoeken naar gebruikers (vereist DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Live-evenementen (Realtime-updates)

Abonneer op live-evenementen om realtime updates te ontvangen voor reacties, stemmen en andere activiteiten.

Paginaniveau-evenementen

Luister naar live-evenementen op een specifieke pagina (reacties, stemmen, enz.):

import { subscribeToChanges, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const config = {
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
};

// Abonneer op live-evenementen voor een pagina
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (haal dit uit het antwoord van getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);
    
    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Werk je UI bij met de nieuwe reactie
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Werk de stemaantallen in je UI bij
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }
    
    return true; // Geef true terug als het event is verwerkt
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Sluit de subscription wanneer klaar
subscription.close();

Abonneer op gebruikersgebeurtenissen

Luister naar gebruiker-specifieke gebeurtenissen (meldingen, vermeldingen, enz.):

import { subscribeToUserFeed, LiveEvent, LiveEventType } from 'fastcomments-sdk/browser';

const userConfig = {
  userIdWS: 'user-session-id', // Verkrijg dit uit het antwoord van getComments
};

// Abonneer op de persoonlijke feed van de gebruiker
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);
    
    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Toon melding in je UI
        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');
  }
);

// Sluit wanneer klaar
userSubscription.close();

Het verkrijgen van userIdWS

De userIdWS-parameter is vereist voor live-evenementen en kan worden verkregen uit API-responses:

const response = await sdk.publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-id'
});

// Extraheer userIdWS uit het antwoord
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Nu kun je je abonneren op live-evenementen
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Broadcast-ID's

Je ziet dat je in sommige API-aanroepen een broadcastId moet doorgeven. Wanneer je events ontvangt, krijg je deze ID terug, zodat je het event kunt negeren als je van plan bent om wijzigingen optimistisch op de client toe te passen (wat je waarschijnlijk wilt doen omdat het de beste ervaring biedt). Geef hier een UUID door. De ID moet uniek genoeg zijn om niet twee keer in een browsersessie voor te komen.

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() // Unieke ID voor deze bewerking
  }
});

Foutafhandeling

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);
  }
}

Aggregeren

Aggregeert documenten door ze te groeperen (als groupBy is opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, enz.) worden ondersteund.

Parameters

Naam	Type	Vereist
tenantId	string	Yes
aggregationRequest	AggregationRequest	Yes
parentTenantId	string	No
includeStats	boolean	No

Antwoord

Retourneert: Aggregate200Response

Voorbeeld

aggregate Voorbeeld

Copy

const tenantId: string = 'tenant_78a9';
const parentTenantId: string = 'parent_tenant_01';
const includeStats: boolean = true;
const aggregationRequest: AggregationRequest = {
  operation: { type: 'COUNT' },
  groupBy: ['pageUrl'],
  predicate: { field: 'status', operator: 'EQUALS', value: 'approved' },
  sort: [{ field: 'count', direction: 'DESC' }],
  limit: 25
};
const result: Aggregate200Response = await aggregate(tenantId, aggregationRequest, parentTenantId, includeStats);

Auditlogs ophalen

Parameters

Name	Type	Required
tenantId	string	Yes
limit	number	No
skip	number	No
order	SORTDIR	No
after	number	No
before	number	No

Response

Retourneert: GetAuditLogs200Response

Voorbeeld

getAuditLogs Voorbeeld

Copy

const tenantId: string = 'tenant_5f8d7c3a';
const limit: number = 100;
const skip: number = 0;
const order: SORTDIR = 'DESC' as SORTDIR;
const after: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // een week geleden
const before: number = Date.now();
const result: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, order, after, before);

Blokkeren van openbare reactie

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nee

Respons

Retourneert: BlockFromCommentPublic200Response

Voorbeeld

blockFromCommentPublic Voorbeeld

Copy

const tenantId: string = 'tenant_6b3f9a2d';
const commentId: string = 'cmt_8f4b12a9';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'Repeated promotional links',
  durationMinutes: 60 * 24 * 30, // 30 dagen
  escalateToModeration: true
};
const sso: string = 'sso_token_3fH7kLw';
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

Deblokkeren van openbare reactie

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
publicBlockFromCommentParams	PublicBlockFromCommentParams	Ja
sso	string	Nee

Response

Geeft terug: UnBlockCommentPublic200Response

Voorbeeld

unBlockCommentPublic Voorbeeld

Copy

const tenantId: string = "tenant-42-production";
const commentId: string = "comment_7f3b2a9d";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "flag reviewed and determined not to violate policy",
  restoredBy: "moderator_jane",
  restoredAt: new Date().toISOString()
};
const sso: string = "sso_token_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

Controleren op geblokkeerde reacties

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentIds	string	Ja
sso	string	Nee

Antwoord

Retourneert: CheckedCommentsForBlocked200Response

Voorbeeld

checkedCommentsForBlocked Voorbeeld

Copy

(async () => {
  const tenantId: string = 'tenant_fa3b2c9e';
  const commentIds: string = 'cmt_112233,cmt_445566';
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0Njc4IiwidGVuYW50IjoidGVuYW50X2ZhM2IifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, sso);
  const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
  console.log(resultWithSSO, resultWithoutSSO);
})();

Gebruiker blokkeren voor reactie

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
blockFromCommentParams	BlockFromCommentParams	Ja
userId	string	Nee
anonUserId	string	Nee

Respons

Geeft terug: BlockFromCommentPublic200Response

Voorbeeld

blockUserFromComment Voorbeeld

Copy

const tenantId: string = "tenant_7f3b4c";
const id: string = "comment_9a8b7c6d";
const blockFromCommentParams: BlockFromCommentParams = {
  reason: "Repeated spam links",
  durationHours: 168,
  notifyModerators: true
};
const userId: string | undefined = "user_42";
const anonUserId: string | undefined = undefined;
const result: BlockFromCommentPublic200Response = await blockUserFromComment(tenantId, id, blockFromCommentParams, userId, anonUserId);

Openbare reactie aanmaken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
commentData	CommentData	Ja
sessionId	string	Nee
sso	string	Nee

Respons

Retourneert: CreateCommentPublic200Response

Voorbeeld

createCommentPublic Voorbeeld

Copy

const tenantId: string = 'tenant_9a1b2c';
const urlId: string = 'https://www.news-site.com/article/67890';
const broadcastId: string = 'broadcast_2026-06-15-01';
const sessionId: string | undefined = 'sess_abc123xyz';
const sso: string | undefined = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiam9yZGFuIiwiaWF0IjoxNjI0MDAwMDB9.signature';
const commentData: CommentData = {
  content: 'Insightful piece — I appreciated the data-backed points and sources cited.',
  authorDisplayName: 'Jordan Miles'
} as CommentData;
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

Reactie verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
contextUserId	string	Nee
isLive	boolean	Nee

Respons

Retourneert: DeleteComment200Response

Voorbeeld

deleteComment Voorbeeld

Copy

const tenantId: string = 'tenant_84a9f2';
const id: string = 'comment_5f3b21';
const contextUserId: string | undefined = 'user_1122';
const isLive: boolean | undefined = true;
async function run(): Promise<void> {
  const result: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);
  console.log(result);
}
run();

Openbare reactie verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
editKey	string	Nee
sso	string	Nee

Antwoord

Retourneert: DeleteCommentPublic200Response

Voorbeeld

deleteCommentPublic Voorbeeld

Copy

const tenantId: string = 'tenant_acme_42';
const commentId: string = 'c0mment-9f8b7a6';
const broadcastId: string = 'site_homepage_2026-06-15';
const editKey: string = 'ek_3b7a1f59-4d2c-11eb-8dcd-0242ac130003';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(tenantId, commentId, broadcastId, editKey, sso);

Stem op reactie verwijderen

Parameters

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
voteId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
editKey	string	Nee
sso	string	Nee

Respons

Geeft terug: DeleteCommentVote200Response

Voorbeeld

deleteCommentVote Voorbeeld

Copy

const tenantId: string = 'tenant_8f3a2b7c';
const commentId: string = 'cmt-5a1f3d92';
const voteId: string = 'vote-3b9c7e1a';
const urlId: string = 'articles/2026/06/typescript-best-practices';
const broadcastId: string = 'broadcast-77f4d2';
const editKey: string = 'edk-9b2f4c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const result: DeleteCommentVote200Response = await deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, editKey, sso);

Reactie rapporteren

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
userId	string	Nee
anonUserId	string	Nee

Antwoord

Retourneert: FlagComment200Response

Voorbeeld

flagComment Voorbeeld

Copy

const tenantId: string = "tenant_4f21c9a";
const commentId: string = "cmt_7a12b3e9";
const userId: string = "user_82bd123";
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

Reactie ophalen

Parameters

Name	Type	Required	Description
tenantId	string	Yes
id	string	Yes

Respons

Retourneert: GetComment200Response

Voorbeeld

getComment Voorbeeld

Copy

const tenantId: string = 'tenant_6f1a2b';
const commentId: string = 'cmt_4d9e8f';
const includeReplies: boolean | undefined = true; // voorbeeld van optionele parameter (niet doorgegeven aan getComment)
const result: GetComment200Response = await getComment(tenantId, commentId);
console.log('Fetched comment for tenant:', tenantId, 'comment id:', commentId);
console.log('API response received:', result);

Reacties ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
page	number	Nee
limit	number	Nee
skip	number	Nee
asTree	boolean	Nee
skipChildren	number	Nee
limitChildren	number	Nee
maxTreeDepth	number	Nee
urlId	string	Nee
userId	string	Nee
anonUserId	string	Nee
contextUserId	string	Nee
hashTag	string	Nee
parentId	string	Nee
direction	SortDirections	Nee
fromDate	number	Nee
toDate	number	Nee

Respons

Geeft terug: GetComments200Response

Voorbeeld

getComments Voorbeeld

Copy

const tenantId: string = "tenant_9a12b3";
const response: GetComments200Response = await getComments(tenantId, 1, 20, 0, true, 0, 3, 2, "https://mysite.com/posts/678", undefined, undefined, undefined, undefined, "parent_987", undefined, 1716873600000, 1719552000000);

Openbare reacties ophalen

req tenantId urlId

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
page	number	Nee
direction	SortDirections	Nee
sso	string	Nee
skip	number	Nee
skipChildren	number	Nee
limit	number	Nee
limitChildren	number	Nee
countChildren	boolean	Nee
fetchPageForCommentId	string	Nee
includeConfig	boolean	Nee
countAll	boolean	Nee
includei10n	boolean	Nee
locale	string	Nee
modules	string	Nee
isCrawler	boolean	Nee
includeNotificationCount	boolean	Nee
asTree	boolean	Nee
maxTreeDepth	number	Nee
useFullTranslationIds	boolean	Nee
parentId	string	Nee
searchText	string	Nee
hashTags	Array	Nee
userId	string	Nee
customConfigStr	string	Nee
afterCommentId	string	Nee
beforeCommentId	string	Nee

Response

Retourneert: GetCommentsPublic200Response

Voorbeeld

getCommentsPublic Voorbeeld

Copy

const tenantId: string = 'acme-news';
const urlId: string = '/articles/2026/fastcomments-update';
const page: number = 1;
const skip: number = 0;
const limit: number = 25;
const countChildren: boolean = true;
const includeConfig: boolean = true;
const result: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  page,
  undefined,
  undefined,
  skip,
  undefined,
  limit,
  undefined,
  countChildren,
  undefined,
  includeConfig
);

Reactietekst ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
editKey	string	Nee
sso	string	Nee

Antwoord

Retourneert: GetCommentText200Response

Voorbeeld

getCommentText Voorbeeld

Copy

const tenantId: string = 'tenant_42b7e9';
const commentId: string = 'cmt_9f3a2b';
const editKey: string = 'edk_3f1b7c9d';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

Gebruikersnamen van stemmers ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
dir	number	Ja
sso	string	Nee

Respons

Retourneert: GetCommentVoteUserNames200Response

Voorbeeld

getCommentVoteUserNames Voorbeeld

Copy

const tenantId: string = "tenant_67890";
const commentId: string = "comment_abc123";
const dir: number = 1;
const ssoToken: string = "sso-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const responseWithoutSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
const responseWithSSO: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir, ssoToken);

Reactie vergrendelen

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nee

Respons

Retourneert: LockComment200Response

Voorbeeld

lockComment Voorbeeld

Copy

const tenantId: string = 'tenant_42f6c1';
const commentId: string = 'cmt-9a8b7c';
const broadcastId: string = 'brd_2026_06_15';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTY1MDAwMDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const lockedWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const lockedWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

Reactie vastzetten

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nee

Antwoord

Geeft terug: PinComment200Response

Voorbeeld

pinComment Voorbeeld

Copy

const tenantId: string = "acme-corp-tenant-72";
const commentId: string = "cmt_8f3a2b4c9d";
const broadcastId: string = "live_2026-06-15_21z";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload.signature";
const responseNoSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId);
const responseWithSSO: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, ssoToken);

Reactie bewaren

Parameters

Naam	Type	Vereist
tenantId	string	Yes
createCommentParams	CreateCommentParams	Yes
isLive	boolean	No
doSpamCheck	boolean	No
sendEmails	boolean	No
populateNotifications	boolean	No

Response

Retourneert: SaveComment200Response

Example

Voorbeeld van saveComment

Copy

const tenantId: string = "fastcomments-tenant-42";
const createCommentParams: CreateCommentParams = {
  threadId: "article-2026-06-0142",
  content: "Great write-up — I followed the migration steps and everything worked as described.",
  userId: "u_9c72b",
  userName: "Ava R.",
  userAvatarUrl: "https://cdn.example.com/avatars/u_9c72b.png",
  metadata: { platform: "web", locale: "en-US" }
};
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const sendEmails: boolean = false;
const populateNotifications: boolean = true;
const result: SaveComment200Response = await saveComment(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

Reacties in bulk opslaan

Parameters

Naam	Type	Vereist
tenantId	string	Ja
createCommentParams	Array	Ja
isLive	boolean	Nee
doSpamCheck	boolean	Nee
sendEmails	boolean	Nee
populateNotifications	boolean	Nee

Respons

Retourneert: Array<SaveComment200Response

Voorbeeld

saveCommentsBulk Voorbeeld

Copy

const tenantId: string = "tenant_42a1b7";
const mentions: CommentUserMentionInfo[] = [{ userId: "user_2b9", displayName: "Alex Chen" }];
const hashtags: CommentUserHashTagInfo[] = [{ tag: "performance" }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: "Thanks for the detailed article — the alternative approach worked for me.",
    authorId: "user_8f3c2",
    authorName: "Maya Patel",
    authorEmail: "maya.patel@example.com",
    url: "/articles/optimizing-ts-performance",
    createdAt: new Date().toISOString(),
    mentions,
    hashtags
  }
];
const isLive: boolean = true;
const doSpamCheck: boolean = false;
const sendEmails: boolean = true;
const populateNotifications: boolean = true;
const result: Array<SaveComment200Response> = await saveCommentsBulk(tenantId, createCommentParams, isLive, doSpamCheck, sendEmails, populateNotifications);

Reactietekst instellen

Parameters

Name	Type	Required
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
commentTextUpdateRequest	CommentTextUpdateRequest	Ja
editKey	string	Nee
sso	string	Nee

Response

Retourneert: SetCommentText200Response

Voorbeeld

setCommentText Voorbeeld

Copy

const tenantId: string = 'tenant_4f9a2b'
const commentId: string = 'cmt-8421'
const broadcastId: string = 'brd-2026-06-15'
const commentTextUpdateRequest: CommentTextUpdateRequest = { text: 'Updated comment text to clarify the schedule.', mentions: [], hashtags: [] }
const editKey: string = 'editkey_9b12'
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso.signature'
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso)

Deblokkeren gebruiker voor reactie

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
unBlockFromCommentParams	UnBlockFromCommentParams	Ja
userId	string	Nee
anonUserId	string	Nee

Antwoord

Geeft terug: UnBlockCommentPublic200Response

Voorbeeld

Voorbeeld unBlockUserFromComment

Copy

const tenantId: string = 'tenant_7b9c2a';
const id: string = 'comment_4f8e1d';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'User submitted appeal and provided additional context',
  effectiveAt: new Date().toISOString()
};
const userId: string = 'user_92a3f6';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId);

Markering van reactie verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
userId	string	Nee
anonUserId	string	Nee

Respons

Retourneert: FlagComment200Response

Voorbeeld

unFlagComment Voorbeeld

Copy

const tenantId: string = 'tenant_8f3b2a1f';
const commentId: string = 'cmt_20250614_01';
const userId: string = 'user_47d2b9';
const result: FlagComment200Response = await unFlagComment(tenantId, commentId, userId);

Reactie ontgrendelen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nee

Antwoord

Geeft terug: LockComment200Response

Voorbeeld

unLockComment Voorbeeld

Copy

const tenantId: string = "tenant-8f3b2c4a";
const commentId: string = "cmt_92a7f3e6";
const broadcastId: string = "brd_1b4c9d20";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

Reactie loszetten

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
broadcastId	string	Ja
sso	string	Nee

Respons

Geeft terug: PinComment200Response

Voorbeeld

unPinComment Voorbeeld

Copy

const tenantId: string = "tenant_9f3b2c1a";
const commentId: string = "comment_4d2e8a7f";
const broadcastId: string = "broadcast_live_2026_06_15_18";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.invalid-signature";
const response: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);
console.log(response);

Reactie bijwerken

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updatableCommentParams	UpdatableCommentParams	Ja
contextUserId	string	Nee
doSpamCheck	boolean	Nee
isLive	boolean	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateComment Voorbeeld

Copy

const tenantId: string = 'tenant_7f3c1b2a';
const commentId: string = 'cmt_8d9f2a4b';
const updatableCommentParams: UpdatableCommentParams = {
  body: 'Updating this comment to clarify the feature behavior and include a timestamp.',
  metadata: { category: 'support', editedReason: 'clarify instructions' },
  visible: true
};
const contextUserId: string = 'user_42';
const doSpamCheck: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, commentId, updatableCommentParams, contextUserId, doSpamCheck);

Stem op reactie

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
urlId	string	Ja
broadcastId	string	Ja
voteBodyParams	VoteBodyParams	Ja
sessionId	string	Nee
sso	string	Nee

Respons

Retourneert: VoteComment200Response

Voorbeeld

voteComment Voorbeeld

Copy

const tenantId: string = 'tenant_7f9d2e';
const commentId: string = '5a1d3f9b-2c4e-4a2b-bf7b-1234567890ab';
const urlId: string = 'articles/2026/06/15/typescript-api-patterns';
const broadcastId: string = 'broadcast-20260615-01';
const voteBodyParams: VoteBodyParams = { vote: 'up' };
const sessionId: string = 'sess_9d2f3b45';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY5NzE2MDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const response: VoteComment200Response = await voteComment(
  tenantId,
  commentId,
  urlId,
  broadcastId,
  voteBodyParams,
  sessionId,
  sso
);

Reacties voor gebruiker ophalen

Parameters

Naam	Type	Vereist
userId	string	Nee
direction	SortDirections	Nee
repliesToUserId	string	Nee
page	number	Nee
includei10n	boolean	Nee
locale	string	Nee
isCrawler	boolean	Nee

Respons

Retourneert: GetCommentsForUser200Response

Voorbeeld

getCommentsForUser Voorbeeld

Copy

const userId: string = "550e8400-e29b-41d4-a716-446655440000";
const page: number = 2;
const includei10n: boolean = true;
const locale: string = "en-US";
const isCrawler: boolean = false;
const comments: GetCommentsForUser200Response = await getCommentsForUser(
  userId,
  undefined, // direction omitted
  undefined, // repliesToUserId omitted
  page,
  includei10n,
  locale,
  isCrawler
);
console.log(comments);

Domeinconfiguratie toevoegen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
addDomainConfigParams	AddDomainConfigParams	Ja

Respons

Retourneert: AddDomainConfig200Response

Domeinconfiguratie verwijderen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
domain	string	Ja

Respons

Geeft terug: DeleteDomainConfig200Response

Domeinconfiguratie ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
domain	string	Ja

Antwoord

Retourneert: GetDomainConfig200Response

Domeinconfiguraties ophalen

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja

Antwoord

Retourneert: GetDomainConfigs200Response

Domeinconfiguratie bijwerken (PATCH)

Parameters

Naam	Type	Vereist
tenantId	string	Ja
domainToUpdate	string	Ja
patchDomainConfigParams	PatchDomainConfigParams	Ja

Respons

Retourneert: GetDomainConfig200Response

Domeinconfiguratie vervangen (PUT)

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
domainToUpdate	string	Ja
updateDomainConfigParams	UpdateDomainConfigParams	Ja

Respons

Retourneert: GetDomainConfig200Response

E-mailsjabloon maken

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createEmailTemplateBody	CreateEmailTemplateBody	Ja

Antwoord

Geeft terug: CreateEmailTemplate200Response

Voorbeeld

createEmailTemplate Voorbeeld

Copy

const tenantId: string = "tenant_4f2b1c9e";
const createEmailTemplateBody: CreateEmailTemplateBody = {
  name: "New Comment Notification",
  subject: "Someone replied to your discussion",
  fromName: "Community Team",
  fromAddress: "no-reply@community.example.com",
  htmlBody: "<p>\{{comment.author}} replied: \{{comment.text}}</p>",
  plaintextBody: "\{{comment.author}} replied: \{{comment.text}}",
  previewText: "A new reply on a discussion you follow",
  isDefault: false // optionele vlag ter demonstratie van het gebruik van een optionele parameter
};
const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);

E-mailsjabloon verwijderen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteEmailTemplate Voorbeeld

Copy

const tenantId: string = "tenant_9c4f1b2a";
const id: string = "emailtmpl_4d2b9a5e";
const requestorNote: string | undefined = undefined; // optionele metadata (niet vereist door de functie)
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, id);

Renderfout e-mailsjabloon verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
errorId	string	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteEmailTemplateRenderError Voorbeeld

Copy

const tenantId: string = 'tenant-72f3b4';
const templateId: string = 'email_template-9c3a1';
let providedErrorId: string | undefined = undefined; // optionele waarde, kan elders ingesteld worden
const errorId: string = providedErrorId ?? 'render_err-5d2f7';
const result: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, templateId, errorId);

E-mailsjabloon ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: GetEmailTemplate200Response

Voorbeeld

getEmailTemplate Voorbeeld

Copy

const tenantId: string = 'tenant_7f3b2c';
const templateId: string = 'welcome-email-2024';
const includeDrafts: boolean | undefined = undefined;
const emailTemplate: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);

Definities van e-mailsjablonen ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja

Antwoord

Retourneert: GetEmailTemplateDefinitions200Response

Voorbeeld

getEmailTemplateDefinitions Voorbeeld

Copy

(async () => {
  const tenantId: string = 'tenant_acme_001';
  const options: { includeDrafts?: boolean } = { includeDrafts: true }; // optionele parameter ter demonstratie
  const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId, options);
  console.log(templates);
})();

Renderfouten e-mailsjablonen ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	Yes
skip	number	No

Respons

Geeft terug: GetEmailTemplateRenderErrors200Response

Voorbeeld

getEmailTemplateRenderErrors Voorbeeld

Copy

const tenantId: string = 'acme-tenant-01';
const id: string = 'tmpl_7f9a2b4c';
const skip: number = 20;
const errorsWithSkip: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
const errorsFirstPage: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id);

E-mailsjablonen ophalen

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
skip	number	Nee

Respons

Geeft terug: GetEmailTemplates200Response

Voorbeeld

getEmailTemplates Voorbeeld

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme-marketing-tenant-001";
  const templatesDefault: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const templatesPaged: GetEmailTemplates200Response = await getEmailTemplates(tenantId, 25);
  console.log(templatesDefault, templatesPaged);
}
run();

E-mailsjabloon renderen

Parameters

Naam	Type	Vereist
tenantId	string	Yes
renderEmailTemplateBody	RenderEmailTemplateBody	Yes
locale	string	No

Antwoord

Retourneert: RenderEmailTemplate200Response

Voorbeeld

Voorbeeld renderEmailTemplate

Copy

const tenantId: string = '7f7e2b90-3a2b-4d9b-9df1-5f0b6b2e8a1c';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'welcome_email',
  recipient: { email: 'jordan.smith@acme.co', name: 'Jordan Smith' },
  variables: { siteName: 'Acme Forum', verificationUrl: 'https://acme.forum/verify?code=abc123' }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

E-mailsjabloon bijwerken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateEmailTemplateBody	UpdateEmailTemplateBody	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateEmailTemplate Voorbeeld

Copy

const tenantId: string = 'acme-corp-123';
const id: string = 'template-789';
const locale: string | undefined = 'en-US';
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  subject: 'Welcome to Acme — Get started',
  bodyHtml: '<p>Hi \{{firstName}}, welcome to Acme. Start by visiting your dashboard.</p>',
  fromName: 'Acme Support',
  fromEmail: 'support@acme.com',
  enabled: true,
  ...(locale ? { locale } : {})
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

Gebeurtenislog ophalen

req tenantId urlId userIdWS

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Nee

Respons

Retourneert: GetEventLog200Response

Voorbeeld

getEventLog Voorbeeld

Copy

const tenantId: string = 'tenant_9f3a2b';
const urlId: string = 'news/2026/06/fastcomments-release';
const userIdWS: string = 'ws_user_48291';
const startTime: number = Date.now() - 86_400_000;
const endTime: number = Date.now();
const result: GetEventLog200Response = await getEventLog(tenantId, urlId, userIdWS, startTime, endTime);

Globale gebeurtenislog ophalen

req tenantId urlId userIdWS

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
userIdWS	string	Ja
startTime	number	Ja
endTime	number	Nee

Antwoord

Retourneert: GetEventLog200Response

Voorbeeld

getGlobalEventLog Voorbeeld

Copy

const tenantId: string = "tenant_639b7f12";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/important-update-987";
const userIdWS: string = "user_ws_42b7";
const startTime: number = new Date("2026-06-14T00:00:00Z").getTime();
const endTime: number = Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

Feed-bericht aanmaken

Parameters

Name	Type	Vereist
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nee
isLive	boolean	Nee
doSpamCheck	boolean	Nee
skipDupCheck	boolean	Nee

Respons

Retourneert: CreateFeedPost200Response

Voorbeeld

createFeedPost Voorbeeld

Copy

const tenantId: string = 'tenant_4f2b1c';
const createFeedPostParams: CreateFeedPostParams = {
  content: 'Launching our summer collection today — check it out!',
  authorId: 'user_879',
  media: [
    {
      type: 'image',
      assets: [
        { url: 'https://cdn.myshop.com/uploads/summer-look.jpg', width: 1200, height: 800 } as FeedPostMediaItemAsset
      ]
    } as FeedPostMediaItem
  ],
  links: [
    { url: 'https://myshop.com/new-arrival', title: 'Summer Collection' } as FeedPostLink
  ],
  allowComments: true
};
const broadcastId: string = 'broadcast-2026-06-15-001';
const isLive: boolean = false;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const response: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

Openbaar feed-bericht aanmaken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
createFeedPostParams	CreateFeedPostParams	Ja
broadcastId	string	Nee
sso	string	Nee

Antwoord

Retourneert: CreateFeedPostPublic200Response

Voorbeeld

createFeedPostPublic Voorbeeld

Copy

(async () => {
  const tenantId: string = "tenant_9f8b7c";
  const media: FeedPostMediaItem[] = [{ type: "image", assets: [{ url: "https://cdn.example.com/roadmap.jpg", mimeType: "image/jpeg" }] }];
  const links: FeedPostLink[] = [{ url: "https://company.example.com/roadmap", title: "Full roadmap" }];
  const createFeedPostParams: CreateFeedPostParams = {
    title: "Weekly Product Roadmap Update",
    body: "This week we shipped enhancements to search relevance and fixed top customer bugs.",
    authorId: "user_8321",
    media,
    links,
    visibility: "public"
  };
  const broadcastId: string = "broadcast_2026_06_15";
  const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload";
  const response: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);
  console.log(response);
})();

Openbaar feed-bericht verwijderen

Parameters

Name	Type	Required
tenantId	string	Ja
postId	string	Ja
broadcastId	string	Nee
sso	string	Nee

Respons

Geeft terug: DeleteFeedPostPublic200Response

Voorbeeld

deleteFeedPostPublic Voorbeeld

Copy

const tenantId: string = 'acme-tenant-42';
const postId: string = 'post_8f3d2a7c';
const broadcastId: string = 'broadcast_2026-06-15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);

Feed-berichten ophalen

req tenantId afterId

Parameters

Naam	Type	Vereist
tenantId	string	Ja
afterId	string	Nee
limit	number	Nee
tags	Array	Nee

Antwoord

Retourneert: GetFeedPosts200Response

Voorbeeld

getFeedPosts Voorbeeld

Copy

const tenantId: string = "tenant_74321";
const afterId: string = "post_20250610_9b2f3";
const limit: number = 25;
const tags: Array<string> = ["product-updates", "announcements"];
const response: GetFeedPosts200Response = await getFeedPosts(tenantId, afterId, limit, tags);

Openbare feed-berichten ophalen

req tenantId afterId

Parameters

Name	Type	Required
tenantId	string	Ja
afterId	string	Nee
limit	number	Nee
tags	Array	Nee
sso	string	Nee
isCrawler	boolean	Nee
includeUserInfo	boolean	Nee

Response

Retourneert: GetFeedPostsPublic200Response

Voorbeeld

getFeedPostsPublic Voorbeeld

Copy

(async () => {
  const tenantId: string = 'tenant_acme_01';
  const afterId: string = 'post_20250610_842';
  const limit: number = 25;
  const tags: string[] = ['news', 'technology'];
  const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1Ni';
  const isCrawler: boolean = false;
  const includeUserInfo: boolean = true;
  const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(
    tenantId,
    afterId,
    limit,
    tags,
    sso,
    isCrawler,
    includeUserInfo
  );
  console.log(response);
})();

Statistieken feed-berichten ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postIds	Array	Ja
sso	string	Nee

Respons

Retourneert: GetFeedPostsStats200Response

Voorbeeld

getFeedPostsStats Voorbeeld

Copy

const tenantId: string = "tenant_98765";
const postIds: string[] = ["post_a1b2c3", "post_d4e5f6"];
const ssoToken: string = "sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9";
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, ssoToken);

Publieke gebruikersreacties ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postIds	Array	Nee
sso	string	Nee

Respons

Retourneert: GetUserReactsPublic200Response

Voorbeeld

getUserReactsPublic Voorbeeld

Copy

const tenantId: string = 'fastcomments-tenant-4f2b9c';
const postIds: Array<string> = ['post_7a1f9e', 'post_2b3c88'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI1Njc4OSIsImlhdCI6MTYwOTQ0MDAwMH0.signature';
const response: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

Reageren op openbaar feed-bericht

Parameters

Naam	Type	Vereist
tenantId	string	Ja
postId	string	Ja
reactBodyParams	ReactBodyParams	Ja
isUndo	boolean	Nee
broadcastId	string	Nee
sso	string	Nee

Response

Retourneert: ReactFeedPostPublic200Response

Voorbeeld

reactFeedPostPublic Voorbeeld

Copy

const tenantId: string = 'acme-tenant-001';
const postId: string = 'feedpost_78901';
const reactBodyParams: ReactBodyParams = { reaction: 'like', emoji: '👍' };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast_2026_06_15_01';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const response: ReactFeedPostPublic200Response = await reactFeedPostPublic(
  tenantId,
  postId,
  reactBodyParams,
  isUndo,
  broadcastId,
  sso
);

Feed-bericht bijwerken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
feedPost	FeedPost	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateFeedPost Voorbeeld

Copy

const tenantId: string = "tenant_72f3b4c9";
const id: string = "post_ba4f6e18-2d3c-4b7a-91f2-8c0e3a6b5d4f";
const feedPost: FeedPost = {
  title: "June feature rollout",
  body: "Announcing performance improvements and moderation updates available to all sites.",
  authorName: "Platform Team",
  mediaItems: [
    {
      type: "image",
      caption: "Release banner",
      asset: { url: "https://cdn.fastcomments.com/assets/june-banner.jpg", mimeType: "image/jpeg", width: 1200, height: 600 }
    }
  ],
  links: [{ title: "Release notes", url: "https://docs.fastcomments.com/releases/june-2026" }]
} as FeedPost;
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

Openbaar feed-bericht bijwerken

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
postId	string	Ja
updateFeedPostParams	UpdateFeedPostParams	Ja
broadcastId	string	Nee
sso	string	Nee

Response

Retourneert: CreateFeedPostPublic200Response

Voorbeeld

updateFeedPostPublic Voorbeeld

Copy

const tenantId: string = 'tenant_acme_01';
const postId: string = 'post_20260615_001';
const updateFeedPostParams: UpdateFeedPostParams = {
  title: 'Weekly Update: Product Launch',
  content: 'We shipped the 2.0 release today — highlights and links below.',
  media: [{ url: 'https://cdn.acme.com/releases/launch.jpg', type: 'image' }],
  tags: ['release', 'product'],
  isPublic: true
};
const broadcastId: string = 'broadcast_live_42';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

Openbare reactie rapporteren

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
isFlagged	boolean	Ja
sso	string	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

flagCommentPublic Voorbeeld

Copy

const tenantId: string = "tenant_4f1b2a9c";
const commentId: string = "comment_8d3e6f12";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

Grote GIF ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
largeInternalURLSanitized	string	Ja

Respons

Retourneert: GetGifLarge200Response

Voorbeeld

getGifLarge Voorbeeld

Copy

const tenantId: string = "tenant_9f8b7c";
const largeInternalURLSanitized: string = "https://cdn.fastcomments.com/gifs/07d3f6_large.gif";
const preferWebP: boolean | undefined = true; // optionele voorkeur
const urlToUse: string = preferWebP ? largeInternalURLSanitized.replace(".gif", ".webp") : largeInternalURLSanitized;
const response: GetGifLarge200Response = await getGifLarge(tenantId, urlToUse);

GIF's zoeken

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
search	string	Ja
locale	string	Nee
rating	string	Nee
page	number	Nee

Response

Retourneert: GetGifsSearch200Response

Voorbeeld

getGifsSearch Voorbeeld

Copy

const tenantId: string = "tenant_acme_9876";
const search: string = "cat playing piano";
const locale: string = "en-US";
const rating: string = "pg";
const page: number = 1;
const result: GetGifsSearch200Response = await getGifsSearch(tenantId, search, locale, rating, page);

Populaire GIF's ophalen

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
locale	string	Nee
rating	string	Nee
page	number	Nee

Respons

Geeft terug: GetGifsTrending200Response

Voorbeeld

getGifsTrending Voorbeeld

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_8b3f2c';
  const locale: string = 'en-US';
  const rating: string = 'pg';
  const page: number = 1;
  const result: GetGifsTrending200Response = await getGifsTrending(tenantId, locale, rating, page);
  console.log(result);
}
main();

Hashtag toevoegen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Nee
createHashTagBody	CreateHashTagBody	Nee

Response

Retourneert: AddHashTag200Response

Voorbeeld

addHashTag Voorbeeld

Copy

const tenantId: string | undefined = "tenant_3c9f7b";
const createHashTagBody: CreateHashTagBody = {
  name: "support",
  title: "Support",
  description: "Questions about product usage, bugs, and account issues",
  color: "#0066CC",
  isActive: true,
  aliases: ["help", "customer-service"]
};
const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

Hashtags in bulk toevoegen

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Nee
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Nee

Respons

Geeft terug: AddHashTagsBulk200Response

Voorbeeld

addHashTagsBulk Voorbeeld

Copy

const tenantId: string = "tenant_acme_corp_987";
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [
    { name: "product-update", description: "Announcements about new product releases", visible: true },
    { name: "customer-support", description: "Customer support related discussions", visible: false }
  ],
  createdBy: "moderator_jane"
};
const resultWithTenant: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const resultWithoutTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBody);

Hashtag verwijderen

Parameters

Naam	Type	Verplicht
tag	string	Ja
tenantId	string	Nee
deleteHashTagRequest	DeleteHashTagRequest	Nee

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteHashTag Voorbeeld

Copy

const tag: string = "breaking-news";
const tenantId: string = "tenant_72a1";
const deleteHashTagRequest: DeleteHashTagRequest = {
  reason: "consolidate-duplicates",
  requestedBy: "moderator@dailypress.com",
  forceDelete: true
};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

Hashtags ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
page	number	Nee

Antwoord

Retourneert: GetHashTags200Response

Voorbeeld

getHashTags Voorbeeld

Copy

const tenantId: string = 'tenant_7f4b2c3a';
const tagsFirstPage: GetHashTags200Response = await getHashTags(tenantId);
const tagsSecondPage: GetHashTags200Response = await getHashTags(tenantId, 2);
console.log(tagsFirstPage, tagsSecondPage);

Hashtag bijwerken (PATCH)

Parameters

Naam	Type	Vereist
tag	string	Ja
tenantId	string	Nee
updateHashTagBody	UpdateHashTagBody	Nee

Respons

Retourneert: PatchHashTag200Response

Voorbeeld

patchHashTag Voorbeeld

Copy

const tag: string = "feature-request";
const tenantId: string = "tenant_8f7a3b2c";
const updateHashTagBody: UpdateHashTagBody = {
  displayName: "Feature Request",
  description: "Use this tag for requests to add new features to the product",
  enabled: true
};
const result: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

Moderator aanmaken

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createModeratorBody	CreateModeratorBody	Ja

Antwoord

Retourneert: CreateModerator200Response

Voorbeeld

createModerator Voorbeeld

Copy

const tenantId: string = 'tenant_9f3b21';
const createModeratorBody: CreateModeratorBody = {
  moderator: {
    name: 'Alex Rivera',
    email: 'alex.rivera@fastcomments.io',
    role: 'global_moderator',
    enabled: true,
  },
  // optionele parameters ter demonstratie:
  notifyUser: true,
  permissions: ['delete_comment', 'edit_comment', 'ban_user'],
  customConfig: { dashboardTheme: 'dark' } as unknown as CustomConfigParameters
};
const result: CreateModerator200Response = await createModerator(tenantId, createModeratorBody);

Moderator verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
sendEmail	string	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteModerator Voorbeeld

Copy

const tenantId: string = 'tenant_4f3b2c9a';
const id: string = 'mod_9c2d1f7b';
const sendEmail: string = 'true';
const response: FlagCommentPublic200Response = await deleteModerator(tenantId, id, sendEmail);
console.log(response);

Moderator ophalen

Parameters

Name	Type	Required	Description
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetModerator200Response

Voorbeeld

getModerator Voorbeeld

Copy

const tenantId: string = 'acme-media-58';
const id: string = 'mod-82f3b9c1';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

Moderators ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	number	Nee

Response

Geeft terug: GetModerators200Response

Voorbeeld

getModerators Voorbeeld

Copy

const tenantId: string = 'tenant_0a1b2c3d';
const moderators: GetModerators200Response = await getModerators(tenantId);
const skip: number = 20;
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, skip);

Uitnodiging verzenden

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
fromName	string	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

sendInvite Voorbeeld

Copy

(async () => {
  const tenantId: string = "tenant_acme_42";
  const id: string = "cmt_8f3b21";
  const fromName: string = "Ava Thompson";
  const inviteResult: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);
  console.log(inviteResult);
})();

Moderator bijwerken

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateModeratorBody	UpdateModeratorBody	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateModerator Voorbeeld

Copy

const tenantId: string = 'acme-tenant-81';
const id: string = 'mod_7f3a2b';
const updateModeratorBody: UpdateModeratorBody = {
  email: 'j.reyes@acme-corp.com',
  displayName: 'Jordan Reyes',
  roles: ['moderator', 'content_reviewer'],
  active: true,
  notes: 'Promoted to senior moderator; monitor flagged content weekly'
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

Aantal meldingen verwijderen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteNotificationCount Voorbeeld

Copy

const tenantId: string = 'tenant_5f3d2e1b';
const id: string = 'notification_9a4b1c2';
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);

Gecachte meldingen-aantal ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: GetCachedNotificationCount200Response

Voorbeeld

getCachedNotificationCount Voorbeeld

Copy

const tenantId: string = 'fastcomments-tenant-23';
const id: string = 'user_987654';
const cachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);
const maybeId: string | undefined = Math.random() > 0.5 ? 'user_123456' : undefined;
if (maybeId) {
  const optionalCachedCount: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, maybeId);
}

Aantal meldingen ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
urlId	string	Nee
fromCommentId	string	Nee
viewed	boolean	Nee
type	string	Nee

Respons

Geeft terug: GetNotificationCount200Response

Voorbeeld

getNotificationCount Voorbeeld

Copy

const tenantId: string = 'tenant_82a3b9f';
const userId: string = 'user_43721';
const urlId: string = 'https://news.example.com/articles/2026/06/15/coverage-123';
const fromCommentId: string = 'comment_98765';
const viewed: boolean = false;
const notificationType: string = 'mention';
const result: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, fromCommentId, viewed, notificationType);

Meldingen ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
urlId	string	Nee
fromCommentId	string	Nee
viewed	boolean	Nee
type	string	Nee
skip	number	Nee

Response

Retourneert: GetNotifications200Response

Voorbeeld

getNotifications Voorbeeld

Copy

const tenantId: string = 'tenant_9f8b7c6a';
const userId: string = 'user_5a4b3c2d';
const urlId: string = 'post_84f2a1b9';
const fromCommentId: string = 'cmt_0a1b2c3d';
const viewed: boolean = false;
const type: string = 'reply';
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(
  tenantId,
  userId,
  urlId,
  fromCommentId,
  viewed,
  type,
  skip
);

Melding bijwerken

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateNotificationBody	UpdateNotificationBody	Ja
userId	string	Nee

Response

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateNotification Voorbeeld

Copy

const tenantId: string = 'tenant_9f3b2c';
const id: string = 'notification_4a1d2e';
const updateNotificationBody: UpdateNotificationBody = {
  enabled: true,
  channels: ['email', 'push'],
  frequency: 'immediate',
  templateId: 'tmpl_77aa'
} as UpdateNotificationBody;
const userId: string = 'user_2468';
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

Pagina-reactie V1 aanmaken

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
urlId	string	Ja
title	string	Nee

Antwoord

Retourneert: CreateV1PageReact200Response

Voorbeeld

createV1PageReact Voorbeeld

Copy

(async () => {
  const tenantId: string = 'b12f3c4d-5678-90ab-cdef-1234567890ab';
  const urlId: string = 'https://www.news-site.com/world/2026/election-results';
  const title: string = 'Election results: key takeaways and analysis';
  const responseWithTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId, title);
  const responseWithoutTitle: CreateV1PageReact200Response = await createV1PageReact(tenantId, urlId);
  console.log(responseWithTitle, responseWithoutTitle);
})();

Pagina-reactie V2 aanmaken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
id	string	Ja
title	string	Nee

Antwoord

Geeft terug: CreateV2PageReact200Response

Voorbeeld

createV2PageReact Voorbeeld

Copy

const tenantId: string = "fastcomments-tenant-72";
const urlId: string = "articles/2026/06/15/product-update";
const id: string = "page-8f3b2a";
const title: string = "Product Update: June 15, 2026";
(async function run(): Promise<void> {
  const response: CreateV2PageReact200Response = await createV2PageReact(tenantId, urlId, id, title);
  console.log(response);
})();

Pagina-reactie V1 verwijderen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: DeleteV1PageReact200Response

Voorbeeld

deleteV1PageReact Voorbeeld

Copy

const tenantId: string = process.env.TENANT_ID ?? 'd3b07384-9f6a-4c2b-8c3e-0a1b2c3d4e5f';
const urlId: string = 'https://acme.com/articles/2026/06/fastcomments-integration';
const result: DeleteV1PageReact200Response = await deleteV1PageReact(tenantId, urlId);

Pagina-reactie V2 verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Yes
urlId	string	Yes
id	string	Yes

Respons

Geeft terug: DeleteV2PageReact200Response

Voorbeeld

deleteV2PageReact Voorbeeld

Copy

const tenantId: string = "tenant_79021";
const urlId: string = "blog/my-first-post";
const id: string = "reaction_9f8b7c";
let includeHistory: boolean | undefined = undefined; // optionele vlag, wordt bij sommige aanroepen gebruikt
const result: DeleteV2PageReact200Response = await deleteV2PageReact(tenantId, urlId, id);
console.log(result);

Pagina-likes V1 ophalen

Parameters

Name	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Response

Retourneert: GetV1PageLikes200Response

Voorbeeld

getV1PageLikes Voorbeeld

Copy

const tenantId: string = 'fastcomments-742';
const urlId: string = 'sports/2026/06/15/world-cup-preview';
const pageLikes: GetV1PageLikes200Response = await getV1PageLikes(tenantId, urlId);

Pagina-reacties V2 ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: GetV2PageReacts200Response

Voorbeeld

getV2PageReacts Voorbeeld

Copy

const tenantId: string = "tenant_82f4b3a9";
const urlId: string = "https://news.site.com/articles/2026/06/15/product-launch";
const response: GetV2PageReacts200Response = await getV2PageReacts(tenantId, urlId);
console.log(response);

Gebruikers van pagina-reacties V2 ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
id	string	Ja

Respons

Retourneert: GetV2PageReactUsers200Response

Voorbeeld

getV2PageReactUsers Voorbeeld

Copy

const tenantId: string = "7421";
const urlId: string = "sports/london-marathon";
const id: string = "reactUser-3fa85f64-5717-4562-b3fc-2c963f66afa6";
const includeDeleted: boolean | undefined = undefined; // optionele vlag (demonstratie)
const result: GetV2PageReactUsers200Response = await getV2PageReactUsers(tenantId, urlId, id);

Pagina toevoegen

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
createAPIPageData	CreateAPIPageData	Ja

Antwoord

Retourneert: AddPageAPIResponse

Pagina verwijderen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: DeletePageAPIResponse

Offline gebruikers ophalen

Vorige commentatoren op de pagina die OP DIT MOMENT NIET online zijn. Gesorteerd op displayName. Gebruik dit nadat u /users/online hebt uitgeput om een "Leden"-sectie weer te geven. Cursor-paginering op commenterName: de server doorloopt de gedeeltelijke {tenantId, urlId, commenterName} index vanaf afterName vooruit via $gt, geen $skip-kosten.

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
afterName	string	Nee
afterUserId	string	Nee

Response

Retourneert: GetOfflineUsers200Response

Voorbeeld

getOfflineUsers Voorbeeld

Copy

const tenantId: string = 'tenant_prod_001';
const urlId: string = 'article-2026-06-15-how-ai-impacts';
const afterName: string = 'michael.smith';
const afterUserId: string = 'user_72b9';
const response: GetOfflineUsers200Response = await getOfflineUsers(tenantId, urlId, afterName, afterUserId);

Online gebruikers ophalen

Momenteel online kijkers van een pagina: personen waarvan de websocket-sessie op dit moment op de pagina is geabonneerd. Geeft anonCount + totalCount terug (kamerbrede abonnees, inclusief anonieme kijkers die we niet opsommen).

Parameters

Naam	Type	Verplicht
tenantId	string	Yes
urlId	string	Yes
afterName	string	No
afterUserId	string	No

Antwoord

Geeft terug: GetOnlineUsers200Response

Voorbeeld

getOnlineUsers Voorbeeld

Copy

const tenantId: string = 'tenant_14f9c3';
const urlId: string = 'article_20250615';
const afterName: string = 'marie.curie';
const afterUserId: string = 'u_92b7';
const result: GetOnlineUsers200Response = await getOnlineUsers(tenantId, urlId, afterName, afterUserId);

Pagina ophalen via URL-id

Parameters

Name	Type	Required	Description
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: GetPageByURLIdAPIResponse

Pagina's ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja

Response

Retourneert: GetPagesAPIResponse

Openbare pagina's ophalen

Lijst met pagina's voor een tenant. Gebruikt door de FChat-desktopclient om zijn kamerlijst te vullen. Vereist dat enableFChat de waarde true heeft in de opgeloste aangepaste configuratie voor elke pagina. Pagina's die SSO vereisen worden gefilterd op basis van de groepsrechten van de aanvragende gebruiker.

Parameters

Naam	Type	Vereist
tenantId	string	Ja
cursor	string	Nee
limit	number	Nee
q	string	Nee
sortBy	PagesSortBy	Nee
hasComments	boolean	Nee

Antwoord

Retourneert: GetPagesPublic200Response

Voorbeeld

getPagesPublic Voorbeeld

Copy

const tenantId: string = 'tenant_8f3b2c';
const cursor: string = 'eyJwYWdlIjoiMTIwIn0';
const limit: number = 25;
const q: string = 'homepage hero';
const hasComments: boolean = true;
const response: GetPagesPublic200Response = await getPagesPublic(
  tenantId,
  cursor,
  limit,
  q,
  undefined,
  hasComments
);

Gebruikersinformatie ophalen

Bulk gebruikersinformatie voor een tenant. Gegeven userIds, retourneer weergave-informatie van User / SSOUser. Wordt gebruikt door de commentaarwidget om gebruikers te verrijken die zojuist verschenen via een presence-evenement. Geen paginacontext: privacy wordt uniform gehandhaafd (privéprofielen worden gemaskeerd).

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
ids	string	Ja

Respons

Retourneert: GetUsersInfo200Response

Voorbeeld

Voorbeeld getUsersInfo

Copy

const tenantId: string = 'acme-tenant-007';
const userIdsList: string[] = ['user_12a', 'user_34b', 'user_56c'];
const separator: string | undefined = undefined; // optioneel; als undefined standaard komma gebruiken
const ids: string = userIdsList.join(separator ?? ',');
const usersInfo: GetUsersInfo200Response = await getUsersInfo(tenantId, ids);

Pagina bijwerken (PATCH)

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateAPIPageData	UpdateAPIPageData	Ja

Antwoord

Retourneert: PatchPageAPIResponse

In afwachting webhook-event verwijderen

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deletePendingWebhookEvent Voorbeeld

Copy

const tenantId: string = "tenant_5f8d7a34";
const id: string = "webhook_evt_987654321";
const requestNote: string | undefined = undefined;
const response: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, id);

Aantal in afwachting webhook-events ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Nee
externalId	string	Nee
eventType	string	Nee
type	string	Nee
domain	string	Nee
attemptCountGT	number	Nee

Respons

Geeft terug: GetPendingWebhookEventCount200Response

Voorbeeld

getPendingWebhookEventCount Voorbeeld

Copy

const tenantId: string = 'tenant_9f8b3b';
const commentId: string = 'cmt_1a2b3c';
const eventType: string = 'comment.created';
const domain: string = 'news-site.com';
const attemptCountGT: number = 2;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined, // externalId omitted
  eventType,
  undefined, // type omitted
  domain,
  attemptCountGT
);

In afwachting webhook-events ophalen

Parameters

Name	Type	Vereist
tenantId	string	Ja
commentId	string	Nee
externalId	string	Nee
eventType	string	Nee
type	string	Nee
domain	string	Nee
attemptCountGT	number	Nee
skip	number	Nee

Respons

Retourneert: GetPendingWebhookEvents200Response

Voorbeeld

getPendingWebhookEvents Voorbeeld

Copy

const tenantId: string = 'tenant_9f3b2a';
const commentId: string = 'cmt_8a7d1';
const eventType: string = 'comment.created';
const domain: string = 'reviews.myshop.com';
const attemptCountGT: number = 1;
const skip: number = 0;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT,
  skip
);

Vraagconfiguratie aanmaken

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createQuestionConfigBody	CreateQuestionConfigBody	Ja

Respons

Retourneert: CreateQuestionConfig200Response

Voorbeeld

createQuestionConfig Voorbeeld

Copy

const tenantId: string = "tenant_9f3b1c2a";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  name: "Product feedback",
  key: "product_quality",
  description: "Short survey question shown after posting a comment",
  required: true,
  renderingType: "singleChoice",
  customOptions: [
    { label: "Excellent", value: "5" },
    { label: "Good", value: "4" },
    { label: "Fair", value: "3" }
  ] as QuestionConfigCustomOptionsInner[],
  notifyModerators: false // optionele parameter ter demonstratie
};
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

Vraagconfiguratie verwijderen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteQuestionConfig Voorbeeld

Copy

const tenantId: string = 'acme-corp-47a9';
const id: string = 'qcfg_20260615_001';
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

Vraagconfiguratie ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetQuestionConfig200Response

Voorbeeld

getQuestionConfig Voorbeeld

Copy

const tenantId: string = "acme-corp-47";
const questionId: string = "q-4f2b9a";
const includeDrafts: boolean | undefined = undefined; // tijdelijke aanduiding voor optionele parameter
const result: GetQuestionConfig200Response = await getQuestionConfig(tenantId, questionId);
console.log(result);

Vraagconfiguraties ophalen

Parameters

Name	Type	Required	Description
tenantId	string	Ja
skip	number	Nee

Antwoord

Retourneert: GetQuestionConfigs200Response

Voorbeeld

getQuestionConfigs Voorbeeld

Copy

const tenantId: string = "tenant_4c9f2b";
const responseWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const skip: number = 50;
const responseWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, skip);

Vraagconfiguratie bijwerken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateQuestionConfigBody	UpdateQuestionConfigBody	Ja

Response

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateQuestionConfig Voorbeeld

Copy

const tenantId: string = "tenant_9f3b8a2e-4c6d-4b4f-a1b2-9e8f7d6c5b3a";
const id: string = "q_7c2e1b4a-5d6f-4a8b-9c3d-2e1f0b9a4c5d";
const options: QuestionConfigCustomOptionsInner[] = [
  { value: "1", label: "Very dissatisfied" },
  { value: "2", label: "Dissatisfied" },
  { value: "3", label: "Neutral" },
  { value: "4", label: "Satisfied" },
  { value: "5", label: "Very satisfied" }
];
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  label: "How satisfied are you with the article?",
  enabled: true,
  required: false, // optionele parameter ter demonstratie
  options
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

Vraagresultaat aanmaken

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createQuestionResultBody	CreateQuestionResultBody	Ja

Response

Geeft terug: CreateQuestionResult200Response

Voorbeeld

createQuestionResult Voorbeeld

Copy

const tenantId: string = 'fc-tenant-512';
const meta: MetaItem[] = [{ key: 'source', value: 'article' }];
const body: CreateQuestionResultBody = {
  questionId: 'q-94',
  userId: 'user_332',
  answers: [{ optionId: 'opt_a', score: 1 }],
  meta, // optionele metadata meegegeven
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, body);

Vraagresultaat verwijderen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteQuestionResult Voorbeeld

Copy

const tenantId: string = "acme-corp-tenant-01";
const id: string = "qres_9f8b7c3a";
const response: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);
const optionalResponse: FlagCommentPublic200Response | undefined = response;

Vraagresultaat ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Response

Retourneert: GetQuestionResult200Response

Voorbeeld

getQuestionResult Voorbeeld

Copy

const tenantId: string = 'tenant_9f3b2a7c9';
const questionId: string = 'q_8d4f1b2c3a';
const options: { includeMeta?: boolean } = { includeMeta: true }; // demonstratie van optionele parameter
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, questionId);
const apiStatus: APIStatus | undefined = (result as unknown as { apiStatus?: APIStatus }).apiStatus;
const question: QuestionResult | undefined = (result as unknown as { question?: QuestionResult }).question;

Vraagresultaten ophalen

Parameters

Name	Type	Required
tenantId	string	Ja
urlId	string	Nee
userId	string	Nee
startDate	string	Nee
questionId	string	Nee
questionIds	string	Nee
skip	number	Nee

Antwoord

Retourneert: GetQuestionResults200Response

Voorbeeld

getQuestionResults Voorbeeld

Copy

const tenantId: string = 'fc-tenant-7a9c';
const urlId: string = 'news/article-2026-06-15';
const userId: string = 'user-8421';
const startDate: string = '2026-05-01T00:00:00Z';
const questionId: string = 'q-13';
const questionIds: string = 'q-13,q-14';
const skip: number = 20;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

Vraagresultaat bijwerken

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateQuestionResultBody	UpdateQuestionResultBody	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateQuestionResult Voorbeeld

Copy

const tenantId: string = "tenant_prod_84b2";
const id: string = "question_9f3a";
const updateQuestionResultBody: UpdateQuestionResultBody = {
  outcome: "accepted",
  confidence: 0.88,
  moderatorId: "moderator_17",
  notes: "Validated by automated review" // optioneel veld opgenomen
};
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

Vraagresultaten aggregeren

Parameters

Naam	Type	Vereist
tenantId	string	Ja
questionId	string	Nee
questionIds	Array	Nee
urlId	string	Nee
timeBucket	AggregateTimeBucket	Nee
startDate	Date	Nee
forceRecalculate	boolean	Nee

Respons

Retourneert: AggregateQuestionResults200Response

Voorbeeld

aggregateQuestionResults Voorbeeld

Copy

const tenantId: string = 'tenant_6f2b3c';
const questionIds: Array<string> = ['q-7a1b2c', 'q-8d3e4f'];
const urlId: string = 'url_9f8e7d';
const startDate: Date = new Date('2025-01-01T00:00:00Z');
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(tenantId, undefined, questionIds, urlId, undefined, startDate, true);

Vraagresultaten in bulk aggregeren

Parameters

Naam	Type	Vereist
tenantId	string	Ja
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Ja
forceRecalculate	boolean	Nee

Antwoord

Retourneert: BulkAggregateQuestionResults200Response

Voorbeeld

bulkAggregateQuestionResults Voorbeeld

Copy

const tenantId: string = "tenant_0012";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  items: [
    {
      questionId: "quality_score",
      startTime: "2026-06-01T00:00:00Z",
      endTime: "2026-06-14T00:00:00Z",
      timeBucket: "day",
      dimensions: ["threadId"]
    }
  ],
  includeTotals: true
};
const forceRecalculate: boolean = false;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

Reacties combineren met vraagresultaten

Parameters

Naam	Type	Vereist
tenantId	string	Ja
questionId	string	Nee
questionIds	Array	Nee
urlId	string	Nee
startDate	Date	Nee
forceRecalculate	boolean	Nee
minValue	number	Nee
maxValue	number	Nee
limit	number	Nee

Response

Retourneert: CombineCommentsWithQuestionResults200Response

Voorbeeld

Voorbeeld combineCommentsWithQuestionResults

Copy

const tenantId: string = 'tenant_12345';
const questionId: string = 'q_98765';
const questionIds: string[] = ['q_98765', 'q_12345'];
const urlId: string = 'url_abc123';
const startDate: Date = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean = true;
const minValue: number = 0;
const maxValue: number = 5;
const limit: number = 50;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  questionId,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

SSO-gebruiker toevoegen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createAPISSOUserData	CreateAPISSOUserData	Ja

Antwoord

Retourneert: AddSSOUserAPIResponse

SSO-gebruiker verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
deleteComments	boolean	Nee
commentDeleteMode	string	Nee

Respons

Geeft terug: DeleteSSOUserAPIResponse

SSO-gebruiker ophalen op e-mail

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
email	string	Ja

Response

Retourneert: GetSSOUserByEmailAPIResponse

SSO-gebruiker ophalen op id

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetSSOUserByIdAPIResponse

SSO-gebruikers ophalen

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Ja
skip	number	Nee

Respons

Retourneert: GetSSOUsers200Response

SSO-gebruiker bijwerken (PATCH)

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nee

Response

Retourneert: PatchSSOUserAPIResponse

SSO-gebruiker vervangen (PUT)

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateAPISSOUserData	UpdateAPISSOUserData	Ja
updateComments	boolean	Nee

Respons

Retourneert: PutSSOUserAPIResponse

Voorbeeld

putSSOUser Voorbeeld

Copy

const tenantId: string = 'acme-enterprises-42';
const id: string = 'usr-73a1b2';
const updateAPISSOUserData: UpdateAPISSOUserData = {
  email: 'marcus.ingram@acme.com',
  givenName: 'Marcus',
  familyName: 'Ingram',
  roles: ['editor', 'project_owner'],
  enabled: true
};
const result: PutSSOUserAPIResponse = await putSSOUser(tenantId, id, updateAPISSOUserData, true);

Abonnement aanmaken

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Ja

Antwoord

Retourneert: CreateSubscriptionAPIResponse

Voorbeeld

createSubscription Voorbeeld

Copy

const tenantId: string = "acme-corp-tenant-123";
const createAPIUserSubscriptionData: CreateAPIUserSubscriptionData = {
  userId: "user_98765",
  planId: "pro_monthly",
  paymentMethod: { type: "card", cardId: "card_abc123" },
  autoRenew: true,
  trialDays: 14, // optionele parameter gedemonstreerd
  metadata: { campaign: "spring_launch" } // optionele parameter gedemonstreerd
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);

Abonnement verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
userId	string	Nee

Antwoord

Retourneert: DeleteSubscriptionAPIResponse

Abonnementen ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
userId	string	Nee

Response

Retourneert: GetSubscriptionsAPIResponse

Voorbeeld

getSubscriptions Voorbeeld

Copy

const tenantId: string = "contoso-9a1b2c";
const userId: string = "u-482f6";
const subscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);
const userSubscriptions: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);

Abonnement bijwerken

Parameters

Naam	Type	Vereist
tenantId	string	Yes
id	string	Yes
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Yes
userId	string	No

Respons

Retourneert: UpdateSubscriptionAPIResponse

Voorbeeld

updateSubscription Voorbeeld

Copy

const tenantId: string = 'tenant_9f3b2c';
const subscriptionId: string = 'sub_7641a2b3';
const updateData: UpdateAPIUserSubscriptionData = {
  status: 'active',
  planId: 'pro_annual',
  autoRenew: true,
  renewalDate: '2026-04-15T00:00:00Z',
  metadata: { upgradedBy: 'billing-team' }
};
const userId: string = 'user_215';
const result: UpdateSubscriptionAPIResponse = await updateSubscription(tenantId, subscriptionId, updateData, userId);

Dagelijks gebruik per tenant ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
yearNumber	number	Nee
monthNumber	number	Nee
dayNumber	number	Nee
skip	number	Nee

Antwoord

Retourneert: GetTenantDailyUsages200Response

Voorbeeld

getTenantDailyUsages Voorbeeld

Copy

const tenantId: string = 'tenant_7a3c2e';
const dailyUsages: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, 2026, 6, undefined, 0);

Tenantpakket aanmaken

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantPackageBody	CreateTenantPackageBody	Ja

Antwoord

Retourneert: CreateTenantPackage200Response

Voorbeeld

createTenantPackage Voorbeeld

Copy

const tenantId: string = "tenant_7890";
const createTenantPackageBody: CreateTenantPackageBody = {
  packageName: "Growth Plan",
  maxSeats: 2500,
  features: {
    moderation: true,
    analytics: true,
    sso: { enabled: true, provider: "saml" }
  },
  billing: { interval: "monthly", priceCents: 19900 },
  // optionele parameter gedemonstreerd: notes is niet verplicht maar wel opgegeven
  notes: "Onboarding bundle with priority support"
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

Tenantpakket verwijderen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteTenantPackage Voorbeeld

Copy

const tenantId: string = 'acme-corp-tenant-01';
const packageId: string = 'pkg-2026-06-15-001';
const dryRun: boolean | undefined = undefined; // optioneel vlagvoorbeeld (niet vereist door de functie)
const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);

Tenantpakket ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: GetTenantPackage200Response

Voorbeeld

getTenantPackage Voorbeeld

Copy

const tenantId: string = 'tenant_4b8c2a9f';
const packageId: string = 'pkg_7d3e1b5c';
const includeMetadata: boolean | undefined = true;
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

Tenantpakketten ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
skip	number	Nee

Antwoord

Retourneert: GetTenantPackages200Response

Voorbeeld

getTenantPackages Voorbeeld

Copy

const tenantId: string = 'tenant_8421';
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, 25);
const packagesWithoutSkip: GetTenantPackages200Response = await getTenantPackages(tenantId);

Tenantpakket vervangen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
replaceTenantPackageBody	ReplaceTenantPackageBody	Ja

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

replaceTenantPackage Voorbeeld

Copy

const tenantId: string = "fastcomments-tenant-114";
const id: string = "pkg-enterprise-2026-06";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  name: "EnterpriseModeration",
  version: "2.4.7",
  enabled: true,
  apiStatus: { state: "active", lastUpdated: "2026-06-10T12:00:00Z" },
  customConfigParameters: { maxCommentLength: 1200, allowImages: true }, // optionele instellingen inbegrepen
  voteStyle: { style: "updown" }
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

Tenantpakket bijwerken

Parameters

Name	Type	Required
tenantId	string	Ja
id	string	Ja
updateTenantPackageBody	UpdateTenantPackageBody	Ja

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateTenantPackage Voorbeeld

Copy

const tenantId: string = 'tenant_9f3b2a';
const id: string = 'pkg_pro_2026';
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: 'Pro Plan',
  monthlyPriceUsd: 49,
  isActive: true,
  features: ['moderation', 'analytics', 'sso'],
  trialDays: 14 // optionele parameter gedemonstreerd
};
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

Tenantgebruiker aanmaken

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
createTenantUserBody	CreateTenantUserBody	Yes

Respons

Retourneert: CreateTenantUser200Response

Voorbeeld

createTenantUser Voorbeeld

Copy

const tenantId: string = "tenant_7f4a2b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "jane.doe@example.com",
  firstName: "Jane",
  lastName: "Doe",
  role: "commenter",
  approved: true,
  displayName: "Jane D." // optioneel: een vriendelijke naam opgeven
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);
console.log(result);

Tenantgebruiker verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
deleteComments	string	Nee
commentDeleteMode	string	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteTenantUser Voorbeeld

Copy

const tenantId: string = "tenant_8f3a2b1c4d";
const id: string = "user_62a4f9e0b7";
const deleteComments: string = "true";
const commentDeleteMode: string = "permanent";
const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);

Tenantgebruiker ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: GetTenantUser200Response

Voorbeeld

getTenantUser Voorbeeld

Copy

const tenantId: string = 'tenant_ab12c3';
const id: string = 'user_9f8e7d';
const response: GetTenantUser200Response = await getTenantUser(tenantId, id);
console.log(response);

Tenantgebruikers ophalen

Parameters

Name	Type	Required	Description
tenantId	string	Ja
skip	number	Nee

Antwoord

Retourneert: GetTenantUsers200Response

Voorbeeld

getTenantUsers Voorbeeld

Copy

const tenantId: string = 'tenant_7b8f3a2c-9e4d-4f1a';
const skip: number = 50;
const usersResponseDefault: GetTenantUsers200Response = await getTenantUsers(tenantId);
const usersResponsePaged: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);

Tenantgebruiker vervangen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
replaceTenantUserBody	ReplaceTenantUserBody	Ja
updateComments	string	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

replaceTenantUser Voorbeeld

Copy

const tenantId: string = "f3b9a2d1-8b4e-4c6a-9f2b-1d5c4e6a7b8c";
const id: string = "user_92f7c3b1";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: "auth0|1234567890",
  email: "jane.doe@company.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  metadata: { department: "support" }
};
const updateComments: string = "reassign-comments-to-new-user";
const response: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

Loginlink verzenden

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
redirectURL	string	Nee

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

sendLoginLink Voorbeeld

Copy

const tenantId: string = "tenant_0a1b2c3d";
const id: string = "user_984321";
const redirectURL: string = "https://app.acme-corp.com/welcome";
const responseWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);
const responseWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);

Tenantgebruiker bijwerken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateTenantUserBody	UpdateTenantUserBody	Ja
updateComments	string	Nee

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateTenantUser Voorbeeld

Copy

const tenantId: string = 'acme-corp';
const userId: string = 'u_72b9f4';
const updateTenantUserBody: UpdateTenantUserBody = {
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  suspended: false
};
const updateComments: string = 'Promoted to moderator after review of activity and community feedback';
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, userId, updateTenantUserBody, updateComments);

Huurder aanmaken

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createTenantBody	CreateTenantBody	Ja

Antwoord

Retourneert: CreateTenant200Response

Voorbeeld

createTenant Voorbeeld

Copy

const tenantId: string = 'acme-news-01';
const createTenantBody: CreateTenantBody = {
  name: 'Acme News',
  domainConfiguration: { primaryDomain: 'news.acme.com', redirectHttps: true } as APIDomainConfiguration,
  importedSites: [{ siteId: 'site-92', url: 'https://news.acme.com' }] as ImportedSiteType[],
  billingInfo: { planId: 'business_monthly', contactEmail: 'billing@acme.com' } as BillingInfo
};
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

Huurder verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
sure	string	Nee

Antwoord

Retourneert: FlagCommentPublic200Response

Voorbeeld

deleteTenant Voorbeeld

Copy

const tenantId: string = 'tenant_742b9c';
const flagId: string = 'flag_1a2b3c';
const resultWithoutSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId);
const sureConfirmation: string = 'confirmed';
const resultWithSure: FlagCommentPublic200Response = await deleteTenant(tenantId, flagId, sureConfirmation);

Huurder ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: GetTenant200Response

Voorbeeld

getTenant Voorbeeld

Copy

const tenantId: string = 'fc_tenant_6b3e2a';
const id: string = 'site_42f1';
const tenantResponse: GetTenant200Response = await getTenant(tenantId, id);
const tenant: APITenant | undefined = tenantResponse.tenant;
const primaryDomain: APIDomainConfiguration | undefined = tenant?.domainConfiguration?.[0];

Huurders ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
meta	string	Nee
skip	number	Nee

Respons

Retourneert: GetTenants200Response

Voorbeeld

getTenants Voorbeeld

Copy

const tenantId: string = "fcom-tenant-8b4f2a1c";
const meta: string = "include=domains,billing&status=active";
const skip: number = 20;
const response: GetTenants200Response = await getTenants(tenantId, meta, skip);
console.log(response);

Huurder bijwerken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
updateTenantBody	UpdateTenantBody	Ja

Respons

Retourneert: FlagCommentPublic200Response

Voorbeeld

updateTenant Voorbeeld

Copy

const tenantId: string = 'tenant_84f12';
const id: string = 'flag_192b';
const updateTenantBody: UpdateTenantBody = {
  name: 'Acme Media',
  billingInfo: { plan: 'enterprise', seats: 25, nextBillingDate: '2026-07-01' },
  apiDomainConfiguration: { primaryDomain: 'comments.acme.com', additionalDomains: ['acme.com'] },
  importedSites: [{ siteUrl: 'https://blog.acme.com', archived: false }], // optioneel
  commentSettings: { htmlRenderingMode: 'sanitized', deletionMode: 'soft' } // optioneel
} as UpdateTenantBody;
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

Ticketstatus wijzigen

Parameters

Name	Type	Required
tenantId	string	Ja
userId	string	Ja
id	string	Ja
changeTicketStateBody	ChangeTicketStateBody	Ja

Antwoord

Geeft terug: ChangeTicketState200Response

Voorbeeld

changeTicketState Voorbeeld

Copy

const tenantId: string = 'tenant_8a7d3f4b';
const userId: string = 'user_5d1a9b2c';
const id: string = 'ticket_1024';
const changeTicketStateBody: ChangeTicketStateBody = {
  state: 'closed',
  notifyParticipants: true, // optionele parameter ter illustratie
  comment: 'Resolved by support — follow-up not required.'
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

Ticket aanmaken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Ja
createTicketBody	CreateTicketBody	Ja

Antwoord

Retourneert: CreateTicket200Response

Voorbeeld

createTicket Voorbeeld

Copy

const tenantId: string = 'tenant_acme_corp';
const userId: string = 'moderator_jane';
const createTicketBody: CreateTicketBody = {
  subject: 'Mass spam reports on article 789',
  description: 'Multiple identical spam comments posted under article 789. Needs moderation and bulk removal.',
  priority: 'high',
  contactEmail: 'jane@acme-corp.com',
  metadata: { articleId: '789', reportedCount: 12 } // optionele metadata ter demonstratie
};
const ticket: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

Ticket ophalen

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Ja
userId	string	Nee

Antwoord

Retourneert: GetTicket200Response

Voorbeeld

getTicket Voorbeeld

Copy

const tenantId: string = 'acme-corp';
const ticketId: string = 'TCKT-20250615-42';
const userId: string = 'user_84b2';
const ticketWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);
console.log(ticketWithUser.id, ticketWithoutUser.id);

Tickets ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
state	number	Nee
skip	number	Nee
limit	number	Nee

Antwoord

Geeft terug: GetTickets200Response

Voorbeeld

getTickets Voorbeeld

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_87b3';
const state: number = 2;
const skip: number = 0;
const limit: number = 50;
const tickets: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);

Vertalingen ophalen

Parameters

Name	Type	Required
namespace	string	Ja
component	string	Ja
locale	string	Nee
useFullTranslationIds	boolean	Nee

Respons

Retourneert: GetTranslations200Response

Voorbeeld

getTranslations Voorbeeld

Copy

const namespaceName: string = 'site-ui';
const componentName: string = 'comment-widget';
const locale: string = 'fr-FR';
const useFullTranslationIds: boolean = true;
const translationsWithLocale: GetTranslations200Response = await getTranslations(namespaceName, componentName, locale, useFullTranslationIds);
const translationsDefault: GetTranslations200Response = await getTranslations(namespaceName, componentName);

Afbeelding uploaden

Een afbeelding uploaden en formaat wijzigen

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
file	Blob	Ja
sizePreset	SizePreset	Nee
urlId	string	Nee

Respons

Geeft terug: UploadImageResponse

Voortgang gebruikersbadge ophalen op id

Parameters

Naam	Type	Vereist	Omschrijving
tenantId	string	Ja
id	string	Ja

Antwoord

Retourneert: GetUserBadgeProgressById200Response

Voorbeeld

getUserBadgeProgressById Voorbeeld

Copy

const tenantId: string = 'fastcomments-tenant-241';
const badgeId: string = 'user-78b3d-badge-3';
const response: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, badgeId);
const progress: UserBadgeProgress | undefined = (response as unknown as { progress?: UserBadgeProgress }).progress;
const percentComplete: number | undefined = progress?.percentage;
console.log('Badge progress percent complete:', percentComplete);

Voortgang gebruikersbadge ophalen op gebruikers-id

Parameters

Naam	Type	Verplicht	Beschrijving
tenantId	string	Yes
userId	string	Yes

Respons

Retourneert: GetUserBadgeProgressById200Response

Voorbeeld

getUserBadgeProgressByUserId Voorbeeld

Copy

const tenantId: string = 'acme-inc-tenant-01';
const userId: string = 'user_73c9b2';
const progress: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
async function maybeFetchProgress(tenant: string, user?: string): Promise<GetUserBadgeProgressById200Response | null> {
  if (!user) return null;
  return await getUserBadgeProgressByUserId(tenant, user);
}
const optionalResult: GetUserBadgeProgressById200Response | null = await maybeFetchProgress(tenantId, userId);

Lijst voortgang gebruikersbadges ophalen

Parameters

Name	Type	Required
tenantId	string	Ja
userId	string	No
limit	number	No
skip	number	No

Respons

Geeft terug: GetUserBadgeProgressList200Response

Voorbeeld

getUserBadgeProgressList Voorbeeld

Copy

const tenantId: string = 'tenant_4f3a2b9c';
const userId: string = 'user_7721d';
const limit: number = 20;
const skip: number = 0;
const result: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);

Gebruikersbadge aanmaken

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
createUserBadgeParams	CreateUserBadgeParams	Ja

Respons

Retourneert: CreateUserBadge200Response

Voorbeeld

createUserBadge Voorbeeld

Copy

const tenantId: string = "tenant_7f4b2a";
const createUserBadgeParams: CreateUserBadgeParams = {
  code: "top_contributor",
  title: "Top Contributor",
  description: "Awarded for 100 high-quality comments",
  iconUrl: "https://cdn.fastcomments.com/badges/top_contributor.svg",
  isActive: true,
  criteria: { commentsRequired: 100 },
  customConfig: { displayOnProfile: true } // optionele parameter ter demonstratie
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, createUserBadgeParams);

Gebruikersbadge verwijderen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Respons

Retourneert: UpdateUserBadge200Response

Voorbeeld

deleteUserBadge Voorbeeld

Copy

const tenantId: string = "tenant_8b3f2c7a";
const badgeIdOptional: string | undefined = Math.random() > 0.5 ? "badge_4f9a21" : undefined;
const id: string = badgeIdOptional ?? "badge_backup_01";
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

Gebruikersbadge ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
id	string	Ja

Response

Retourneert: GetUserBadge200Response

Voorbeeld

getUserBadge Voorbeeld

Copy

(async () => {
  const tenantId: string = 'tenant_6b8f2a1c';
  const id: string = 'badge_9f3d4b2a';
  const response: GetUserBadge200Response = await getUserBadge(tenantId, id);
  const badge: UserBadge | undefined = response.userBadge;
  const badgeName: string | undefined = badge?.name;
  console.log('Retrieved badge name:', badgeName);
})();

Gebruikersbadges ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
userId	string	Nee
badgeId	string	Nee
type	number	Nee
displayedOnComments	boolean	Nee
limit	number	Nee
skip	number	Nee

Response

Retourneert: GetUserBadges200Response

Voorbeeld

getUserBadges Voorbeeld

Copy

const tenantId: string = 'tenant_7f9a12';
const userId: string = 'user_42b7';
const badgeId: string = 'badge_top_contributor';
const type: number = 2;
const displayedOnComments: boolean = true;
const limit: number = 25;
const skip: number = 0;
const badges: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

Gebruikersbadge bijwerken

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
id	string	Ja
updateUserBadgeParams	UpdateUserBadgeParams	Ja

Respons

Retourneert: UpdateUserBadge200Response

Voorbeeld

updateUserBadge Voorbeeld

Copy

const tenantId: string = "tenant_9a8b7c";
const id: string = "badge_a1b2c3";
const updateUserBadgeParams: UpdateUserBadgeParams = {
  title: "Community Helper",
  description: "Awarded for providing 50 helpful answers",
  iconUrl: "https://cdn.fastcomments.com/badges/community-helper.png",
  isActive: true,
  expiryDate: undefined
};
const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);

Aantal gebruikersmeldingen ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
sso	string	Nee

Response

Retourneert: GetUserNotificationCount200Response

Voorbeeld

getUserNotificationCount Voorbeeld

Copy

const tenantId: string = 'tenant_acme_01';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload.signature';
const notificationCountNoSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
const notificationCountWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);

Gebruikersmeldingen ophalen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Nee
pageSize	number	Nee
afterId	string	Nee
includeContext	boolean	Nee
afterCreatedAt	number	Nee
unreadOnly	boolean	Nee
dmOnly	boolean	Nee
noDm	boolean	Nee
includeTranslations	boolean	Nee
includeTenantNotifications	boolean	Nee
sso	string	Nee

Response

Retourneert: GetUserNotifications200Response

Voorbeeld

getUserNotifications Voorbeeld

Copy

const tenantId: string = "tenant_8271";
const urlId: string = "https://www.news-site.com/articles/2026/06/15/ai-updates";
const pageSize: number = 25;
const afterId: string = "notif_abc123";
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 86_400_000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const includeTenantNotifications: boolean = true;
const sso: string = "sso_token_xyz_987";
const notifications: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  urlId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  includeTenantNotifications,
  sso
);

Aantal gebruikersmeldingen resetten

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
sso	string	Nee

Respons

Retourneert: ResetUserNotifications200Response

Voorbeeld

resetUserNotificationCount Voorbeeld

Copy

const tenantId: string = "tenant_8a3f2b6c";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyX2QxMjM0IiwiaWF0IjoxNjI1MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resetResponseWithSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
const resetResponseWithoutSso: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);

Gebruikersmeldingen resetten

Parameters

Name	Type	Required
tenantId	string	Ja
afterId	string	Nee
afterCreatedAt	number	Nee
unreadOnly	boolean	Nee
dmOnly	boolean	Nee
noDm	boolean	Nee
sso	string	Nee

Respons

Retourneert: ResetUserNotifications200Response

Voorbeeld

resetUserNotifications Voorbeeld

Copy

const tenantId: string = "tenant_9b1f2";
const afterId: string = "notification_0001";
const afterCreatedAt: number = Date.now() - 60 * 60 * 1000; // een uur geleden
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const sso: string = "sso_session_7f2d";
const result: ResetUserNotifications200Response = await resetUserNotifications(
  tenantId,
  afterId,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  sso
);

Abonnementsstatus reacties van gebruiker bijwerken

Schakel meldingen in of uit voor een specifieke reactie.

Parameters

Naam	Type	Vereist
tenantId	string	Ja
notificationId	string	Ja
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Ja
commentId	string	Ja
sso	string	Nee

Antwoord

Geeft terug: UpdateUserNotificationStatus200Response

Voorbeeld

Voorbeeld updateUserNotificationCommentSubscriptionStatus

Copy

const tenantId: string = 'f3a9c8b0-4d2e-4f8a-9c3b-1234567890ab';
const notificationId: string = '62a1f4d2-8c7b-4e1a-aaa1-abcdef123456';
const commentId: string = '7e4a2b1c-1234-5678-90ab-cdef12345678';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptedIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ssoPayload.signature';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

Abonnementsstatus pagina's van gebruiker bijwerken

Schakel meldingen in of uit voor een pagina. Wanneer gebruikers op een pagina geabonneerd zijn, worden er meldingen aangemaakt voor nieuwe root-opmerkingen, en ook

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
url	string	Ja
pageTitle	string	Ja
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Ja
sso	string	Nee

Response

Retourneert: UpdateUserNotificationStatus200Response

Voorbeeld

updateUserNotificationPageSubscriptionStatus Voorbeeld

Copy

const tenantId: string = 'tenant_7f3b2';
const urlId: string = 'article_987';
const url: string = 'https://www.news-site.com/articles/2026/pasta-guide';
const pageTitle: string = 'The Definitive Guide to Cooking Pasta';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso-token-62b9f1';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

Gebruikersmelding status bijwerken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
notificationId	string	Ja
newStatus	UpdateUserNotificationStatusNewStatusEnum	Ja
sso	string	Nee

Response

Retourneert: UpdateUserNotificationStatus200Response

Voorbeeld

updateUserNotificationStatus Voorbeeld

Copy

const tenantId: string = 'tenant_5f2a8b9c';
const notificationId: string = 'notif_987654321';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

Aanwezigheidsstatussen van gebruikers ophalen

Parameters

Naam	Type	Verplicht
tenantId	string	Ja
urlIdWS	string	Ja
userIds	string	Ja

Antwoord

Geeft terug: GetUserPresenceStatuses200Response

Voorbeeld

getUserPresenceStatuses Voorbeeld

Copy

const tenantId: string = 'tenant_42';
const urlIdWS: string = 'wss://comments.fastsite.com/ws/tenant_42';
const userIds: string = 'user_9012,user_3478';
const includePresenceMetadata: boolean | undefined = true; // voorbeeld van optionele parameter
const presenceStatuses: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

Gebruikers zoeken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
urlId	string	Ja
usernameStartsWith	string	Nee
mentionGroupIds	Array	Nee
sso	string	Nee
searchSection	SearchUsersSearchSectionEnum	Nee

Respons

Retourneert: SearchUsers200Response

Voorbeeld

searchUsers Voorbeeld

Copy

const tenantId: string = 'tenant_7890';
const urlId: string = 'news/2026-06-15-world-cup-final';
const usernameStartsWith: string = 'mar';
const mentionGroupIds: string[] = ['staff', 'trusted-commenters'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI0NTY3OCJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.Commenters;
const response: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

Gebruiker ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Yes
id	string	Yes

Antwoord

Retourneert: GetUser200Response

Voorbeeld

getUser Voorbeeld

Copy

const tenantId: string = 'fastcomments_corp';
const id: string = 'user_9f8b7c6d-5e4a-3b2c-1f0e-123456789abc';
const response: GetUser200Response = await getUser(tenantId, id);
const userEmail: string | undefined = response.user?.email;
const displayName: string | undefined = response.user?.displayName

Stem aanmaken

Parameters

Naam	Type	Vereist
tenantId	string	Ja
commentId	string	Ja
direction	CreateVoteDirectionEnum	Ja
userId	string	Nee
anonUserId	string	Nee

Antwoord

Geeft terug: VoteComment200Response

Voorbeeld

createVote Voorbeeld

Copy

const tenantId: string = 'fastcomments-tenant-001';
const commentId: string = 'cmt_8f3b2a9d';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const userId: string = 'user_5021';
const anonUserId: string = 'anon_7a9c';
const voteResponse: VoteComment200Response = await createVote(tenantId, commentId, direction, userId, anonUserId);

Stem verwijderen

Parameters

Naam	Type	Vereist
tenantId	string	Ja
id	string	Ja
editKey	string	Nee

Respons

Retourneert: DeleteCommentVote200Response

Voorbeeld

deleteVote Voorbeeld

Copy

(async () => {
  const tenantId: string = 'tenant_8421';
  const id: string = 'vote_3f9b7c2a';
  const editKey: string = 'edit_7Xk9LpQ';
  const responseWithoutEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id);
  const responseWithEdit: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
  console.log(responseWithoutEdit, responseWithEdit);
})();

Stemmen ophalen

Parameters

Naam	Type	Vereist	Beschrijving
tenantId	string	Ja
urlId	string	Ja

Respons

Retourneert: GetVotes200Response

Voorbeeld

getVotes Voorbeeld

Copy

const tenantId: string = 'tenant_7f8e91c2';
const urlId: string = 'https://www.sportsdaily.com/news/2026/06/15/championship-game-recap';
const votes: GetVotes200Response = await getVotes(tenantId, urlId);
console.log(votes);

Stemmen voor gebruiker ophalen

Parameters

Name	Type	Required
tenantId	string	Ja
urlId	string	Ja
userId	string	Nee
anonUserId	string	Nee

Respons

Retourneert: GetVotesForUser200Response

Voorbeeld

getVotesForUser Voorbeeld

Copy

const tenantId: string = 'tenant_9b8f7c6d';
const urlId: string = 'articles/product-update-2026';
const userId: string = 'user_c12345';
const anonUserId: string = 'anon_7f4e2a';
const votes: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);

Hulp nodig?

Als u problemen ondervindt of vragen heeft over de JavaScript/TypeScript SDK, kunt u:

Bijdragen

Bijdragen zijn welkom! Bezoek de GitHub-repository voor richtlijnen voor bijdragen.

Taal 🇳🇱 Nederlands

Aan de slag

API-referentie

Documentatie

Gebruik

Aggregatie

Auditlogs

Reactie blokkeren

Controleer geblokkeerde reacties

Reacties

Reacties voor gebruiker

Domeinconfiguraties

E-mailsjablonen

Gebeurtenislog

Feed-berichten

Reactie rapporteren

GIFs

Hashtags

Moderators

Aantal meldingen

Meldingen

Pagina-reacties

Pagina's

In afwachting webhook-events

Vraagconfiguraties

Vraagresultaten

Aggregatie vraagresultaten

SSO-gebruikers

Abonnementen

Dagelijks gebruik tenant

Tenantpakketten

Tenantgebruikers

Huurders

Tickets

Vertalingen

Afbeelding uploaden

Voortgang gebruikersbadge

Gebruikersbadges

Gebruikersmeldingen

Aanwezigheidsstatus gebruikers

Gebruikers zoeken

Gebruikers

Stemmen

FastComments JavaScript/TypeScript SDK

Repository

Installatie

API-documentatie

Volledige API-referentie: docs/api/README.md

Browser- versus servercompatibiliteit

Gebruik

Browsergebruik (Client-Side)

Servergebruik (Node.js)

Alleen types importeren

Gebruik van individuele API-klassen

Browseromgeving

Serveromgeving

Openbare versus beveiligde API's

Voorbeeld: Public API gebruiken (browser-veilig)

Voorbeeld: Default API gebruiken (alleen serverzijde)

SSO (Single Sign-On)-integratie

Eenvoudige SSO (Alleen serverzijde)

Beveiligde SSO (Server-side, aanbevolen)

SSO gebruiken vanuit de browser (met door de server gegenereerd token)

SSO met het aanmaken van een reactie

Veelvoorkomende gebruiksscenario's

Reacties ophalen voor een pagina

Een reactie aanmaken

Stemmen op een reactie

Gebruikersbeheer (vereist API-sleutel)

Live-evenementen (Realtime-updates)

Paginaniveau-evenementen

Abonneer op gebruikersgebeurtenissen

Het verkrijgen van userIdWS

Broadcast-ID's

Foutafhandeling

Aggregeren

Parameters

Antwoord

Voorbeeld

Auditlogs ophalen