FastComments JavaScript/TypeScript SDK

Това е официалното JavaScript/TypeScript SDK за FastComments.

Управлявайте коментари, потребители, SSO и модерация от Node.js или от браузъра.

Хранилище

Инсталация

npm install fastcomments-sdk

Документация на API

Пълна справка за API: docs/api/README.md

Съвместимост между браузър и сървър

Този SDK използва двойни входни точки, за да осигури оптимална съвместимост и да предотврати грешки по време на изпълнение:

fastcomments-sdk/browser - Версия, безопасна за браузъри, с вграден fetch
fastcomments-sdk/server - Пълна версия за Node.js с поддръжка на SSO
fastcomments-sdk (по подразбиране) - Само типове, безопасно за импортиране навсякъде

Използване

Този SDK предоставя отделни входни точки за браузърни и сървърни среди, за да осигури оптимална съвместимост и сигурност:

Използване в браузъра (клиентска страна)

За браузърни/фронтенд приложения използвайте безопасния за браузър износ, който изключва зависимости от Node.js:

// Импорт безопасен за браузър (без зависимости от Node.js)
import { createFastCommentsBrowserSDK } from 'fastcomments-sdk/browser';

// Създаване на екземпляр на SDK за браузър
const sdk = createFastCommentsBrowserSDK({
  basePath: 'https://fastcomments.com' // по избор, по подразбиране https://fastcomments.com
});

// Използване на публични API (не се изисква API ключ - безопасно за браузъра)
const comments = await sdk.publicApi.getCommentsPublic({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Използване на сървъра (Node.js)

За сървърни/бекенд приложения използвайте пълния SDK с SSO и функции за удостоверяване:

// Импорт за сървърната страна (включва SSO и е проектиран да работи с NodeJS)
import { createFastCommentsSDK } from 'fastcomments-sdk/server';

// Създаване на екземпляр на SDK за сървър
const sdk = createFastCommentsSDK({
  apiKey: 'your-api-key', // Дръжте това в тайна на сървъра!
  basePath: 'https://fastcomments.com' // по избор, по подразбиране https://fastcomments.com
});

// Използване на защитени API с вашия API ключ
const comments = await sdk.defaultApi.getComments({ 
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Импорт само на типове

Ако се нуждаете само от TypeScript типове (без код за изпълнение), използвайте стандартния импорт:

// Само типове (без зависимости по време на изпълнение - безопасно навсякъде)
import type { 
  PublicComment, 
  CreateCommentParams, 
  GetCommentsPublic200Response 
} from 'fastcomments-sdk';

Използване на отделни API класове

Браузърна среда

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

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

const publicApi = new PublicApi(config);

Сървърна среда

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

Публични и защитени API

SDK предоставя три основни API класа:

DefaultApi - Защитени крайни точки, които изискват вашия API ключ за удостоверяване. Използвайте тези за операции от страна на сървъра.
PublicApi - Публични крайни точки, които могат да бъдат достъпвани без API ключ. Те могат да се извикват директно от браузъри/мобилни устройства/и т.н.
HiddenApi - Вътрешни/административни крайни точки за напреднали случаи на използване.

Пример: Използване на Public API (безопасно за браузър)

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

const publicApi = new PublicApi();

// Получете коментари за страница (не е необходим API ключ)
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

Пример: Използване на Default API (само от страна на сървъра)

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

const config = new Configuration({
  apiKey: 'your-api-key' // Пазете това в тайна!
});
const defaultApi = new DefaultApi(config);

// Получете коментари с пълен администраторски достъп
const response = await defaultApi.getComments({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id'
});

SSO (Еднократен вход) интеграция

FastComments поддържа SSO за интеграция с вашата съществуваща система за удостоверяване на потребители. Функционалността SSO е достъпна само в сървърния експорт тъй като изисква криптографски възможности на Node.js.

Прост SSO (само от страна на сървъра)

Прост SSO трябва да се генерира от страна на сървъра и да се изпрати на клиента:

// Серверен код (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Създаване на прост SSO с помощта на вградения помощник  
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();

// Изпратете ssoToken към клиентския код
// Клиентският код може да използва този токен с browser SDK

Сигурен SSO (от страна на сървъра, препоръчително)

Сигурният SSO трябва да се имплементира от страна на сървъра и предлага по-добра сигурност:

// Серверен код (Node.js/backend)
import { FastCommentsSSO, PublicApi } from 'fastcomments-sdk/server';

// Създаване на сигурен SSO с помощта на вградения помощник
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();

// Използване с API повиквания на сървъра
const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: JSON.stringify(ssoConfig)
});

// Или изпратете ssoConfig на клиента за използване в браузъра

Използване на SSO от браузъра (с токен, генериран от сървъра)

// Клиентски код (браузър)
import { PublicApi } from 'fastcomments-sdk/browser';

// Вземете SSO токен от вашия сървърен 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 // Използвайте SSO токена, генериран от сървъра
});

SSO с създаване на коментар

// От страна на сървъра: Създайте SSO и коментар
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)
});

Често срещани случаи на употреба

Получаване на коментари за страница

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

Създаване на коментар

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

Гласуване за коментар

const voteResponse = await sdk.publicApi.voteComment({
  voteBodyParams: {
    commentId: 'comment-id',
    direction: 1 // 1 за гласуване нагоре, -1 за гласуване надолу
  }
});

Управление на потребители (изисква API ключ)

// Търсене на потребители (изисква DefaultApi)
const users = await sdk.defaultApi.searchUsers({
  tenantId: 'your-tenant-id',
  urlId: 'page-id',
  usernameStartsWith: 'john'
});

Живи събития (Актуализации в реално време)

Абонирайте се за събития в реално време, за да получавате актуализации за коментари, гласове и други дейности.

Събития на ниво страница

Слушайте за събития в реално време за конкретна страница (коментари, гласове и т.н.):

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

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

// Абонирайте се за събития в реално време за страница
const subscription = subscribeToChanges(
  config,
  'your-tenant-id', // tenantIdWS
  'page-url-id',    // urlIdWS  
  'user-session-id', // userIdWS (получете това от отговора на getComments)
  (event: LiveEvent) => {
    console.log('Live event received:', event);

    switch (event.type) {
      case LiveEventType.new_comment:
        console.log('New comment:', event.comment);
        // Актуализирайте вашия интерфейс с новия коментар
        break;
      case LiveEventType.new_vote:
        console.log('New vote:', event.vote);
        // Актуализирайте броя на гласовете в потребителския интерфейс
        break;
      case LiveEventType.updated_comment:
        console.log('Comment updated:', event.comment);
        break;
      default:
        console.log('Other event type:', event.type);
    }

    return true; // Върнете true, ако събитието е обработено
  },
  (isConnected: boolean) => {
    console.log('Connection status:', isConnected ? 'Connected' : 'Disconnected');
  }
);

// Затворете абонамента, когато приключите
subscription.close();

Абониране за потребителски събития

Слушайте за потребителски събития (известия, споменавания и т.н.):

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

const userConfig = {
  userIdWS: 'user-session-id', // Получете това от отговора на getComments
};

// Абонирайте се за личния канал на потребителя
const userSubscription = subscribeToUserFeed(
  userConfig,
  (event: LiveEvent) => {
    console.log('User event received:', event);

    switch (event.type) {
      case LiveEventType.notification:
        console.log('New notification:', event.notification);
        // Показване на известие в потребителския интерфейс
        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');
  }
);

// Затворете, когато приключите
userSubscription.close();

Получаване на userIdWS

Параметърът userIdWS е задължителен за събития в реално време и може да бъде получен от отговорите на API:

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

// Извлечете userIdWS от отговора
const userIdWS = response.data?.userSessionInfo?.userIdWS;

if (userIdWS) {
  // Сега можете да се абонирате за събития в реално време
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Идентификатори за излъчване

Ще видите, че трябва да подадете broadcastId в някои API извиквания. Когато получавате събития, ще получите този ID обратно, така че да знаете да игнорирате събитието, ако планирате да приложите промените оптимистично на клиента (което вероятно ще искате да направите, тъй като осигурява най-доброто потребителско изживяване). Подайте UUID тук. Идентификаторът трябва да бъде достатъчно уникален, за да не се появи два пъти в рамките на една браузър сесия.

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() // Уникален идентификатор за тази операция
  }
});

Обработка на грешки

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

Агрегиране

Агрегира документи чрез групиране (ако е зададен groupBy) и прилагане на множество операции. Поддържат се различни операции (например sum, countDistinct, avg и др.).

Параметри

Име	Тип	Задължително
tenantId	string	Да
aggregationRequest	AggregationRequest	Да
parentTenantId	string	Не
includeStats	boolean	Не

Отговор

Връща: AggregationResponse

Получаване на логове за одит

Параметри

Име	Тип	Задължително
tenantId	string	Да
limit	number	Не
skip	number	Не
order	SORTDIR	Не
after	number	Не
before	number	Не

Отговор

Връща: GetAuditLogs200Response

Пример

Пример за getAuditLogs

Copy

const tenantId: string = 'tenant_9a8b7c';
const limit: number = 100;
const skip: number = 0;
const after: number = Date.now() - 30 * 24 * 60 * 60 * 1000; // преди 30 дни
const before: number = Date.now();
const auditLogs: GetAuditLogs200Response = await getAuditLogs(tenantId, limit, skip, undefined, after, before);

Блокиране от публичен коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
publicBlockFromCommentParams	PublicBlockFromCommentParams	Да
sso	string	Не

Отговор

Връща: BlockFromCommentPublic200Response

Пример

Пример за blockFromCommentPublic

Copy

const tenantId: string = "site_7f9b2e";
const commentId: string = "comment_2026-03-25_001";
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: "Repeated harassment and targeted abuse",
  blockDurationDays: 90,
  includeHistory: true,
  notifyModeratorTeam: true
};
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakePayload.signature";
const result: BlockFromCommentPublic200Response = await blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

Отблокиране на публичен коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
publicBlockFromCommentParams	PublicBlockFromCommentParams	Да
sso	string	Не

Отговор

Връща: UnBlockCommentPublic200Response

Пример

Пример за unBlockCommentPublic

Copy

const tenantId: string = 'tenant_42e8a1';
const commentId: string = 'cmt_9b3f2d';
const publicBlockFromCommentParams: PublicBlockFromCommentParams = {
  reason: 'abusive_language',
  blockedByModeratorId: 'mod_17',
  note: 'Targeted harassment; review complete',
  unblockRequestedAt: new Date().toISOString()
};
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: UnBlockCommentPublic200Response = await unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);

Проверка за блокирани коментари

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentIds	string	Да
sso	string	Не

Отговор

Връща: CheckedCommentsForBlocked200Response

Пример

checkedCommentsForBlocked Пример

Copy

const tenantId: string = 'tenant_4f3b2a1e';
const commentIds: string = 'c_1001,c_1002,c_1003';
const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIn0.Sf4ke7nQP3mZx9v2';
const resultWithoutSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds);
const resultWithSSO: CheckedCommentsForBlocked200Response = await checkedCommentsForBlocked(tenantId, commentIds, ssoToken);

Блокиране на потребител от коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
blockFromCommentParams	BlockFromCommentParams	Да
userId	string	Не
anonUserId	string	Не

Отговор

Връща: BlockFromCommentPublic200Response

Пример

Пример за blockUserFromComment

Copy

const tenantId: string = 'acme-corp';
const id: string = 'comment_7f3b2a9c';
const blockFromCommentParams: BlockFromCommentParams = {
  reason: 'Repeated abusive language and targeted harassment',
  durationDays: 90,
  preventReposting: true
};
const userId: string = 'user_12345';
const anonUserId: string = 'anon_98765';
const result: BlockFromCommentPublic200Response = await blockUserFromComment(
  tenantId,
  id,
  blockFromCommentParams,
  userId,
  anonUserId
);

Създаване на публичен коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Да
broadcastId	string	Да
commentData	CommentData	Да
sessionId	string	Не
sso	string	Не

Отговор

Връща: CreateCommentPublic200Response

Пример

Пример за createCommentPublic

Copy

const tenantId: string = 'tenant_prod_42';
const urlId: string = 'article-2026-03-25-tech-deep-dive';
const broadcastId: string = 'live-broadcast-001';
const sessionId: string = 'sess_9f8e7d6a3b';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const commentData: CommentData = {
  content: 'Great reporting — appreciated the depth on performance tradeoffs.',
  authorName: 'Jordan M.',
  language: 'en-US',
  metadata: { client: 'web' }
};
const result: CreateCommentPublic200Response = await createCommentPublic(tenantId, urlId, broadcastId, commentData, sessionId, sso);

Изтриване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
contextUserId	string	Не
isLive	boolean	Не

Отговор

Връща: DeleteComment200Response

Пример

Пример за deleteComment

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "comment_5f3a2b7c";
const contextUserId: string = "user_1229";
const isLive: boolean = true;
const response: DeleteComment200Response = await deleteComment(tenantId, id, contextUserId, isLive);

Изтриване на публичен коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
broadcastId	string	Да
editKey	string	Не
sso	string	Не

Отговор

Връща: DeleteCommentPublic200Response

Пример

Пример за deleteCommentPublic

Copy

const tenantId: string = 'tenant_4f2c9b';
const commentId: string = 'comment-7c3a9f2d';
const broadcastId: string = 'article-2026-03-20';
const editKey: string | undefined = 'ek_pub_abc12345';
const sso: string | undefined = 'sso_eyJhbGciOiJIUzI1Ni';
const result: DeleteCommentPublic200Response = await deleteCommentPublic(
  tenantId,
  commentId,
  broadcastId,
  editKey,
  sso
);

Изтриване на глас за коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
voteId	string	Да
urlId	string	Да
broadcastId	string	Да
editKey	string	Не
sso	string	Не

Отговор

Връща: DeleteCommentVote200Response

Пример

Пример за deleteCommentVote

Copy

const tenantId: string = 'acme-tenant-87e4fd';
const commentId: string = 'cmt-9a12b3f4';
const voteId: string = 'vote-4f6d21b9';
const urlId: string = 'https://www.acme.com/articles/2026/03/25/how-to-test';
const broadcastId: string = 'broadcast-20260325-01';
const editKey: string = 'editkey-6b7c8d9e';
const sso: string = 'sso-jwt-eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: DeleteCommentVote200Response = await deleteCommentVote(
  tenantId,
  commentId,
  voteId,
  urlId,
  broadcastId,
  editKey,
  sso
);

Докладване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
userId	string	Не
anonUserId	string	Не

Отговор

Връща: FlagComment200Response

Пример

flagComment Пример

Copy

const tenantId: string = 'tenant_7f3b21';
const commentId: string = 'cmt_9a2b4';
const userId: string = 'user_1024';
const result: FlagComment200Response = await flagComment(tenantId, commentId, userId);

Получаване на коментар

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetComment200Response

Пример

getComment Пример

Copy

const tenantId: string = "acme-publishing-001";
const commentId: string = "f3b2c1d0-9a8e-4b7c-8123-6d5f0a1e2b3c";
const result: GetComment200Response = await getComment(tenantId, commentId);
const wrapper: GetComment200Response & { comment?: APIComment } = result;
const comment: APIComment | undefined = wrapper.comment;
const authorBadge: CommentUserBadgeInfo | undefined = comment?.user?.badge;
const userHashTags: CommentUserHashTagInfo[] | undefined = comment?.user?.hashTags

Получаване на коментари

Параметри

Name	Type	Задължително
tenantId	string	Да
page	number	Не
limit	number	Не
skip	number	Не
asTree	boolean	Не
skipChildren	number	Не
limitChildren	number	Не
maxTreeDepth	number	Не
urlId	string	Не
userId	string	Не
anonUserId	string	Не
contextUserId	string	Не
hashTag	string	Не
parentId	string	Не
direction	SortDirections	Не

Отговор

Връща: GetComments200Response

Пример

getComments Example

Copy

const tenantId: string = 'tenant_acme_42';
const response: GetComments200Response = await getComments(
  tenantId,
  1, // страница
  20, // лимит
  0, // брой за пропускане
  true, // като дърво
  1, // брой деца за пропускане
  3, // лимит за деца
  4, // макс. дълбочина на дървото
  'articles/2026/new-product-launch', // идентификатор на url
  'user_7890', // идентификатор на потребител
  'anon_4f3b2', // идентификатор на анонимен потребител
  undefined, // идентификатор на контекстен потребител
  '#launch', // хаштаг
  undefined // идентификатор на родител
);

Получаване на публични коментари

req tenantId urlId

Параметри

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Да
page	number	Не
direction	SortDirections	Не
sso	string	Не
skip	number	Не
skipChildren	number	Не
limit	number	Не
limitChildren	number	Не
countChildren	boolean	Не
fetchPageForCommentId	string	Не
includeConfig	boolean	Не
countAll	boolean	Не
includei10n	boolean	Не
locale	string	Не
modules	string	Не
isCrawler	boolean	Не
includeNotificationCount	boolean	Не
asTree	boolean	Не
maxTreeDepth	number	Не
useFullTranslationIds	boolean	Не
parentId	string	Не
searchText	string	Не
hashTags	Array	Не
userId	string	Не
customConfigStr	string	Не
afterCommentId	string	Не
beforeCommentId	string	Не

Отговор

Връща: GetCommentsPublic200Response

Пример

Пример за getCommentsPublic

Copy

const tenantId: string = 'tenant_eu-west_01';
const urlId: string = 'https://www.financialtimes.com/articles/2026/market-update-q1';
const response: GetCommentsPublic200Response = await getCommentsPublic(
  tenantId,
  urlId,
  2,
  undefined,
  'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.tokenPayload.signature',
  undefined,
  0,
  50,
  5,
  true,
  undefined,
  true,
  false,
  true,
  'en-US',
  'reactions,moderation',
  false,
  true,
  true,
  3,
  false,
  undefined,
  'performance',
  ['feature','fastcomments'],
  'user_9876',
  undefined,
  undefined,
  undefined
);

Получаване на текст на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
editKey	string	Не
sso	string	Не

Отговор

Връща: GetCommentText200Response

Пример

Пример за getCommentText

Copy

const tenantId: string = 'tenant_acme_001';
const commentId: string = 'cmt_7890b';
const editKey: string = 'edit_4f2d9b7c';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: GetCommentText200Response = await getCommentText(tenantId, commentId, editKey, sso);

Получаване на потребителски имена на гласували за коментара

Параметри

Name	Тип	Задължителен
tenantId	string	Да
commentId	string	Да
dir	number	Да
sso	string	Не

Отговор

Връща: GetCommentVoteUserNames200Response

Пример

Пример за getCommentVoteUserNames

Copy

(async () => {
  const tenantId: string = 'tenant_4f2c1e';
  const commentId: string = 'cmt_9a7b3d';
  const dir: number = 1;
  const resultUpvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dir);
  const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fakepayload.signature';
  const dirDown: number = -1;
  const resultDownvotes: GetCommentVoteUserNames200Response = await getCommentVoteUserNames(tenantId, commentId, dirDown, sso);
  console.log(resultUpvotes, resultDownvotes);
})();

Заключване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
broadcastId	string	Да
sso	string	Не

Отговор

Връща: LockComment200Response

Пример

Пример за lockComment

Copy

const tenantId: string = "tenant_prod_8f3a2b";
const commentId: string = "cmt_5d7e9a92";
const broadcastId: string = "broadcast_2026_03_25_1400";
const ssoToken: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const resultWithSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId, ssoToken);
const resultWithoutSso: LockComment200Response = await lockComment(tenantId, commentId, broadcastId);

Закрепване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
broadcastId	string	Да
sso	string	Не

Отговор

Връща: PinComment200Response

Пример

Пример за pinComment

Copy

const tenantId: string = "tenant_4f2b9a";
const commentId: string = "cmt_9f8e7d6c";
const broadcastId: string = "brd_live_concert_2026-03-25";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_payload_signature";
const result: PinComment200Response = await pinComment(tenantId, commentId, broadcastId, sso);

Запазване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
createCommentParams	CreateCommentParams	Да
isLive	boolean	Не
doSpamCheck	boolean	Не
sendEmails	boolean	Не
populateNotifications	boolean	Не

Отговор

Връща: SaveComment200Response

Пример

Пример за saveComment

Copy

const tenantId: string = 'tenant_acme_001';
const createCommentParams: CreateCommentParams = {
  content: 'Great article — helped me fix a production issue in minutes.',
  url: 'https://app.acme.com/blog/performance-tips',
  author: { name: 'Maya Chen', email: 'maya.chen@acme.com' },
  metadata: { locale: 'en-US', appVersion: '4.2.1' }
} as CreateCommentParams;
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);

Масово запазване на коментари

Параметри

Име	Тип	Задължително
tenantId	string	Да
createCommentParams	Array	Да
isLive	boolean	Не
doSpamCheck	boolean	Не
sendEmails	boolean	Не
populateNotifications	boolean	Не

Отговор

Връща: Array<SaveComment200Response

Пример

Пример за saveCommentsBulk

Copy

const tenantId: string = 'acme-corp-01';
const mentions1: CommentUserMentionInfo[] = [{ userId: 'user-123', displayName: 'Jane Doe' }];
const hashtags1: CommentUserHashTagInfo[] = [{ tag: 'typescript' }];
const createCommentParams: CreateCommentParams[] = [
  {
    content: 'Great insights on async/await patterns.',
    authorName: 'John Smith',
    authorEmail: 'john.smith@acme.com',
    externalId: 'comment-001',
    createdAt: '2026-03-25T10:15:00Z',
    userMentions: mentions1,
    userHashTags: hashtags1
  },
  {
    content: 'I prefer using Promise.all for bulk ops.',
    authorName: 'Emily Turner',
    authorEmail: 'emily.turner@acme.com',
    externalId: 'comment-002',
    createdAt: '2026-03-25T10:20:00Z'
  }
];
const result: SaveComment200Response[] = await saveCommentsBulk(tenantId, createCommentParams, true, true, false, true);

Задаване на текст на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
broadcastId	string	Да
commentTextUpdateRequest	CommentTextUpdateRequest	Да
editKey	string	Не
sso	string	Не

Отговор

Връща: SetCommentText200Response

Пример

Пример за setCommentText

Copy

const tenantId: string = 'tenant_6721f4';
const commentId: string = 'cmt_9a3b2d';
const broadcastId: string = 'live_2026_03_25';
const editKey: string = 'edit_k_4f7b9';
const sso: string = 'sso_tok_eyJhbGciOiJIUzI1';
const commentTextUpdateRequest: CommentTextUpdateRequest = {
  text: 'Updated to clarify the timeline and link the relevant docs.',
  mentions: [{ userId: 'user_102', displayName: 'Alex Rivera' }],
  hashtags: [{ tag: 'product-update' }]
};
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, editKey, sso);

Отблокиране на потребител от коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
unBlockFromCommentParams	UnBlockFromCommentParams	Да
userId	string	Не
anonUserId	string	Не

Отговор

Връща: UnBlockCommentPublic200Response

Пример

Пример за unBlockUserFromComment

Copy

const tenantId: string = 'tenant_87f3e1';
const id: string = 'comment_9b2a4f';
const unBlockFromCommentParams: UnBlockFromCommentParams = {
  reason: 'Reviewed by moderation team — reinstated',
  moderatorId: 'mod_21',
  unblockedAt: new Date().toISOString()
};
const userId: string = 'user_42';
const anonUserId: string = 'anon_e7f9';
const result: UnBlockCommentPublic200Response = await unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, userId, anonUserId);

Премахване на доклад за коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
userId	string	Не
anonUserId	string	Не

Отговор

Връща: FlagComment200Response

Пример

Пример за unFlagComment

Copy

const tenantId: string = 'acme-tenant-001';
const commentId: string = 'cmt_9f8e7d6c';
const userId: string = 'user_72b4a1c9';
const anonUserId: string = 'anon_3d2c1b0a';
const response: FlagComment200Response = await unFlagComment(tenantId, commentId, userId, anonUserId);

Отключване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
broadcastId	string	Да
sso	string	Не

Отговор

Връща: LockComment200Response

Пример

Пример за unLockComment

Copy

const tenantId: string = 'tenant_9d4f2b';
const commentId: string = 'cmt_8a3e1f';
const broadcastId: string = 'broadcast_2026_03_25';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature';
const result: LockComment200Response = await unLockComment(tenantId, commentId, broadcastId, sso);

Премахване на закрепване на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Отговор

Връща: PinComment200Response

Пример

Пример: unPinComment

Copy

const tenantId: string = 'tenant_7f9d2a3b';
const commentId: string = 'comment_842b9c1f';
const broadcastId: string = 'bcast_frontpage_202603';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.exampleSignature';
const result: PinComment200Response = await unPinComment(tenantId, commentId, broadcastId, sso);

Актуализиране на коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
updatableCommentParams	UpdatableCommentParams	Да
contextUserId	string	Не
doSpamCheck	boolean	Не
isLive	boolean	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateComment

Copy

const tenantId: string = "tenant_acme_corp_01";
const id: string = "comment_20260325_4592";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Updated the response to include a link to the RFC and fixed a typo in the second paragraph.",
  editedByUserId: "user_8721",
  isVisible: true
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = true;
const result: FlagCommentPublic200Response = await updateComment(tenantId, id, updatableCommentParams, contextUserId, doSpamCheck, isLive);

Гласуване за коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
urlId	string	Да
broadcastId	string	Да
voteBodyParams	VoteBodyParams	Да
sessionId	string	Не
sso	string	Не

Отговор

Връща: VoteComment200Response

Пример

Пример за voteComment

Copy

const tenantId: string = 'tenant_9f8b7c';
const commentId: string = 'cmt_42f3a1';
const urlId: string = 'articles/ai-trends-2026';
const broadcastId: string = 'web';
const voteBodyParams: VoteBodyParams = { vote: 1, reason: 'Insightful and on-topic' };
const sessionId: string = 'sess_6d2b4c9e';
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const result: VoteComment200Response = await voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, sessionId, sso);

Получаване на коментари за потребител

Параметри

Име	Тип	Задължително
userId	string	Не
tenantId	string	Не
urlId	string	Не
page	number	Не
direction	SortDirections	Не
lastGenDate	number	Не
repliesToUserId	string	Не
fetchPageForCommentId	string	Не
includei10n	boolean	Не
useFullTranslationIds	boolean	Не
locale	string	Не
includeConfig	boolean	Не
includeNotificationCount	boolean	Не
countAll	boolean	Не
sso	string	Не

Отговор

Връща: GetCommentsForUserResponse

Пример

Пример за getCommentsForUser

Copy

const userId: string = "user_92b7f4";
const tenantId: string = "news-tenant-uk";
const urlId: string = "https://news.example.co.uk/articles/2026/05/01/local-election";
const page: number = 1;
const lastGenDate: number = Date.now() - 24 * 60 * 60 * 1000;
const fetchPageForCommentId: string = "c_987654321";
const includei10n: boolean = true;
const locale: string = "en-GB";
const includeConfig: boolean = true;
const includeNotificationCount: boolean = false;
const result: GetCommentsForUserResponse = await getCommentsForUser(
  userId,
  tenantId,
  urlId,
  page,
  undefined,
  lastGenDate,
  undefined,
  fetchPageForCommentId,
  includei10n,
  false,
  locale,
  includeConfig,
  includeNotificationCount,
  false,
  undefined
);

Добавяне на конфигурация на домейн

Parameters

Име	Тип	Задължително	Описание
tenantId	string	Да
addDomainConfigParams	AddDomainConfigParams	Да

Response

Връща: AddDomainConfig200Response

Изтриване на конфигурация на домейн

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
domain	string	Да

Отговор

Връща: DeleteDomainConfig200Response

Получаване на конфигурация на домейн

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
domain	string	Да

Отговор

Връща: GetDomainConfig200Response

Получаване на конфигурации на домейни

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да

Отговор

Връща: GetDomainConfigs200Response

Частична промяна на конфигурация на домейн

Параметри

Име	Тип	Задължително
tenantId	string	Да
domainToUpdate	string	Да
patchDomainConfigParams	PatchDomainConfigParams	Да

Отговор

Връща: GetDomainConfig200Response

Замяна на конфигурация на домейн

Параметри

Име	Тип	Задължително
tenantId	string	Да
domainToUpdate	string	Да
updateDomainConfigParams	UpdateDomainConfigParams	Да

Отговор

Връща: GetDomainConfig200Response

Създаване на имейл шаблон

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createEmailTemplateBody	CreateEmailTemplateBody	Да

Отговор

Връща: CreateEmailTemplate200Response

Пример

Пример за createEmailTemplate

Copy

(async () => {
  const tenantId: string = 'tenant_9f4a2b';
  const createEmailTemplateBody: CreateEmailTemplateBody = {
    name: 'Weekly Digest',
    subject: 'Your weekly discussion highlights',
    html: '<!doctype html><body><h1>Hello {{user.name}}</h1><p>Top comments this week...</p></body>',
    fromAddress: 'no-reply@fastcomments-example.com',
    replyTo: 'moderation@fastcomments-example.com',
    isDefault: false
  };
  const result: CreateEmailTemplate200Response = await createEmailTemplate(tenantId, createEmailTemplateBody);
  console.log(result);
})();

Изтриване на имейл шаблон

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteEmailTemplate

Copy

const tenantId: string = "acme-corp-42";
const idSuffix: string | undefined = "-archived";
const templateId: string = "email_tmpl_6a1b2c" + (idSuffix ?? "");
const result: FlagCommentPublic200Response = await deleteEmailTemplate(tenantId, templateId);

Изтриване на грешка при рендиране на имейл шаблон

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
errorId	string	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteEmailTemplateRenderError

Copy

const tenantId: string = "tenant_7a1d2f9b";
const id: string = "email_template_42b1";
const errorId: string = "render_err_2026-04-24_7f3c";
const includeStackTrace: boolean | undefined = undefined; // пример за опционален флаг
const response: FlagCommentPublic200Response = await deleteEmailTemplateRenderError(tenantId, id, errorId);
// Ако се поддържаше незадължителен обект с опции, той може да изглежда така:
// await deleteEmailTemplateRenderError(tenantId, id, errorId /*, { includeStackTrace } */);

Получаване на имейл шаблон

Параметри

Name	Type	Required	Description
tenantId	string	Да
id	string	Да

Отговор

Връща: GetEmailTemplate200Response

Пример

getEmailTemplate Пример

Copy

const tenantId: string = "acme-marketing-042";
const templateId: string = "tpl_welcome_2026";
const result: GetEmailTemplate200Response = await getEmailTemplate(tenantId, templateId);
const template: CustomEmailTemplate | undefined = result.template;
const subject: string | undefined = template?.subject;
const customParams: CustomConfigParameters | undefined = template?.customConfigParameters;

Получаване на дефиниции на имейл шаблони

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да

Отговор

Връща: GetEmailTemplateDefinitions200Response

Пример

getEmailTemplateDefinitions Пример

Copy

const tenantId: string = 'tenant_acme_eu_01';
const templates: GetEmailTemplateDefinitions200Response = await getEmailTemplateDefinitions(tenantId);
console.log('Email template definitions loaded for', tenantId, templates);

Получаване на грешки при рендиране на имейл шаблони

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
skip	number	Не

Отговор

Връща: GetEmailTemplateRenderErrors200Response

Пример

Пример за getEmailTemplateRenderErrors

Copy

(async () => {
  const tenantId: string = 'acme-tenant-42';
  const id: string = 'tmpl_3fa85f64-5717-4562-b3fc-2c963f66afa6';
  const skip: number = 20;
  const result: GetEmailTemplateRenderErrors200Response = await getEmailTemplateRenderErrors(tenantId, id, skip);
  console.log(result);
})();

Получаване на имейл шаблони

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
skip	number	Не

Отговор

Връща: GetEmailTemplates200Response

Пример

Пример за getEmailTemplates

Copy

async function main(): Promise<void> {
  const tenantId: string = 'tenant_5f3a9c2b';
  const templates: GetEmailTemplates200Response = await getEmailTemplates(tenantId);
  const skip: number = 20;
  const pagedTemplates: GetEmailTemplates200Response = await getEmailTemplates(tenantId, skip);
  console.log(templates, pagedTemplates);
}
main();

Рендиране на имейл шаблон

Параметри

Име	Тип	Задължително
tenantId	string	Да
renderEmailTemplateBody	RenderEmailTemplateBody	Да
locale	string	Не

Отговор

Връща: RenderEmailTemplate200Response

Пример

Пример за renderEmailTemplate

Copy

const tenantId: string = 'tenant_b6f3c2';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'comment-notification',
  recipient: { name: 'Ava Thompson', email: 'ava.thompson@publisher.com' },
  context: {
    siteName: 'City Gazette',
    commentText: 'Thanks for the in-depth coverage — very helpful.',
    articleTitle: 'Downtown Redevelopment Plan Advances',
    threadUrl: 'https://citygazette.example/articles/2026/redevelopment#comments'
  }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

Актуализиране на имейл шаблон

Параметри

Name	Type	Required
tenantId	string	Да
id	string	Да
updateEmailTemplateBody	UpdateEmailTemplateBody	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateEmailTemplate

Copy

const tenantId: string = "tenant_76a4b2";
const id: string = "template_9f3c1e";
const updateEmailTemplateBody: UpdateEmailTemplateBody = {
  name: "Comment Flag Notification",
  subject: "A comment was flagged on your-site.com",
  bodyHtml: "<p>Admin,</p><p>User {{commenterName}} flagged a comment: “{{commentText}}”</p>",
  isEnabled: true,
  description: "Email sent to moderators when a comment is flagged (optional field included)"
};
const result: FlagCommentPublic200Response = await updateEmailTemplate(tenantId, id, updateEmailTemplateBody);

Получаване на дневник на събитията

req tenantId urlId userIdWS

Параметри

Name	Type	Required
tenantId	string	Да
urlId	string	Да
userIdWS	string	Да
startTime	number	Да
endTime	number	Да

Отговор

Връща: GetEventLog200Response

Пример

Пример за getEventLog

Copy

const tenantId: string = 'fastcomments-tenant-01';
const urlId: string = 'article-2026-03-25';
const userIdWS: string | undefined = undefined; // незадължителна стойност от upstream
const startTime: number = Date.parse('2026-03-01T00:00:00Z');
const endTime: number = Date.parse('2026-03-25T23:59:59Z');
const eventLogResponse: GetEventLog200Response = await getEventLog(
  tenantId,
  urlId,
  userIdWS ?? 'ws_user_8b1f',
  startTime,
  endTime
);

Получаване на глобален дневник на събитията

req tenantId urlId userIdWS

Параметри

Name	Type	Required
tenantId	string	Да
urlId	string	Да
userIdWS	string	Да
startTime	number	Да
endTime	number	Да

Отговор

Връща: GetEventLog200Response

Пример

Пример за getGlobalEventLog

Copy

const tenantId: string = "tenant-84b2f1";
const urlId: string = "article-6721";
const userIdWS: string = "ws-conn-9a3c";
const startTime: number = Date.now() - 7 * 24 * 60 * 60 * 1000; // преди 7 дни
const endTimeOptional: number | undefined = undefined; // незадължителен край на времевия интервал
const endTime: number = endTimeOptional ?? Date.now();
const eventLog: GetEventLog200Response = await getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);

Създаване на публикация във фийда

Параметри

Име	Тип	Задължително
tenantId	string	Да
createFeedPostParams	CreateFeedPostParams	Да
broadcastId	string	Не
isLive	boolean	Не
doSpamCheck	boolean	Не
skipDupCheck	boolean	Не

Отговор

Връща: CreateFeedPost200Response

Пример

Пример за createFeedPost

Copy

const tenantId: string = 'tenant_87f3b2';
const mediaAsset: FeedPostMediaItemAsset = { url: 'https://cdn.example.com/images/post-123.jpg', mimeType: 'image/jpeg', width: 1200, height: 800, size: 245000 };
const mediaItem: FeedPostMediaItem = { id: 'media_1', type: 'image', assets: [mediaAsset], altText: 'Conference keynote stage' };
const link: FeedPostLink = { url: 'https://news.example.com/keynote-recap', title: 'Keynote recap' };
const createFeedPostParams: CreateFeedPostParams = {
  title: 'Product Launch Highlights',
  content: 'Highlights from today’s product launch and roadmap updates.',
  authorId: 'user_42',
  mediaItems: [mediaItem],
  links: [link],
  tags: ['product', 'launch', 'announcement']
};
const broadcastId: string = 'broadcast_20260424';
const isLive: boolean = true;
const doSpamCheck: boolean = true;
const skipDupCheck: boolean = false;
const result: CreateFeedPost200Response = await createFeedPost(tenantId, createFeedPostParams, broadcastId, isLive, doSpamCheck, skipDupCheck);

Създаване на публична публикация във фийда

Параметри

Име	Тип	Задължително
tenantId	string	Да
createFeedPostParams	CreateFeedPostParams	Да
broadcastId	string	Не
sso	string	Не

Отговор

Връща: CreateFeedPostPublic200Response

Пример

Пример за createFeedPostPublic

Copy

const tenantId: string = "tenant_987654321";
const asset: FeedPostMediaItemAsset = { url: "https://cdn.fastcomments.com/uploads/team-photo.jpg", mimeType: "image/jpeg", sizeBytes: 324512 };
const mediaItem: FeedPostMediaItem = { type: "image", assets: [asset], caption: "Team launch day" };
const link: FeedPostLink = { url: "https://www.example.com/blog/product-update-march-2026", title: "Product update — March 2026" };
const createFeedPostParams: CreateFeedPostParams = {
  title: "Product update — March 2026",
  content: "<p>We shipped performance improvements and two new integrations.</p>",
  media: [mediaItem],
  link,
  visibility: "public",
  tags: ["product","release","march-2026"],
  customConfig: { allowComments: true, requireTOS: false }
};
const broadcastId: string = "broadcast_2026_03_25_live";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NSIsImlhdCI6MTY5MDI0MDB9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: CreateFeedPostPublic200Response = await createFeedPostPublic(tenantId, createFeedPostParams, broadcastId, sso);

Изтриване на публична публикация във фийда

Параметри

Име	Тип	Задължително
tenantId	string	Да
postId	string	Да
broadcastId	string	Не
sso	string	Не

Отговор

Връща: DeleteFeedPostPublic200Response

Пример

deleteFeedPostPublic Пример

Copy

const tenantId: string = "tenant_5f8a9b3c";
const postId: string = "post_a1b2c3d4";
const broadcastId: string = "broadcast_2026-03-25T10:00:00Z";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyMTIzIiwiaWF0IjoxNjE5MjM5MjAwfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const resultWithOptional: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId, broadcastId, sso);
const resultRequiredOnly: DeleteFeedPostPublic200Response = await deleteFeedPostPublic(tenantId, postId);

Получаване на публикации във фийда

req tenantId afterId

Параметри

Name	Type	Required
tenantId	string	Да
afterId	string	Не
limit	number	Не
tags	Array	Не

Отговор

Връща: GetFeedPosts200Response

Пример

Пример за getFeedPosts

Copy

const initialPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', undefined, 20, ['sports', 'local']);
const nextPage: GetFeedPosts200Response = await getFeedPosts('tenant_9f1b3d', 'post_abc123', 20, ['sports', 'local']);

Получаване на публични публикации във фийда

req tenantId afterId

Параметри

Name	Type	Required
tenantId	string	Да
afterId	string	Не
limit	number	Не
tags	Array	Не
sso	string	Не
isCrawler	boolean	Не
includeUserInfo	boolean	Не

Отговор

Връща: GetFeedPostsPublic200Response

Пример

Пример за getFeedPostsPublic

Copy

const tenantId: string = 'tenant_acme_01';
const afterId: string = 'fp_20260301_042';
const limit: number = 25;
const tags: Array<string> = ['technology', 'announcement'];
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjoiamRvZSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
const isCrawler: boolean = false;
const includeUserInfo: boolean = true;
const response: GetFeedPostsPublic200Response = await getFeedPostsPublic(tenantId, afterId, limit, tags, sso, isCrawler, includeUserInfo);

Получаване на статистики за публикации във фийда

Параметри

Име	Тип	Задължително
tenantId	string	Да
postIds	Array	Да
sso	string	Не

Отговор

Връща: GetFeedPostsStats200Response

Пример

Пример за getFeedPostsStats

Copy

const tenantId: string = 'tenant_9b2f1c4a';
const postIds: Array<string> = [
  '8f14e45f-ea82-4c7a-b6b2-1a2b3c4d5e6f',
  'd0e1f2a3-b4c5-6d7e-8f90-1234567890ab'
];
const sso: string = 'sso_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.signature';
const statsWithoutSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds);
const statsWithSSO: GetFeedPostsStats200Response = await getFeedPostsStats(tenantId, postIds, sso);

Получаване на публични реакции на потребителя

Параметри

Име	Тип	Задължително
tenantId	string	Да
postIds	Array	Не
sso	string	Не

Отговор

Връща: GetUserReactsPublic200Response

Пример

Пример за getUserReactsPublic

Copy

const tenantId: string = "acme-tenant-8a4d2c";
const postIds: string[] = ["post-645a2f", "post-645a30"];
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyXzEyMyIsImlhdCI6MTY2MTYwMDAwMH0.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: GetUserReactsPublic200Response = await getUserReactsPublic(tenantId, postIds, sso);

Реакция към публична публикация във фийда

Параметри

Име	Тип	Задължително
tenantId	string	Да
postId	string	Да
reactBodyParams	ReactBodyParams	Да
isUndo	boolean	Не
broadcastId	string	Не
urlId	string	Не
sso	string	Не

Отговор

Връща: ReactFeedPostPublic200Response

Пример

reactFeedPostPublic Пример

Copy

const tenantId: string = 'tenant_84f2b1';
const postId: string = 'post_12ac9e';
const reactBodyParams: ReactBodyParams = { emoji: 'thumbs_up', intensity: 1 };
const isUndo: boolean = false;
const broadcastId: string = 'broadcast_20260503_01';
const urlId: string = 'article-4527';
const sso: string = 'sso_token_7f3b2c';
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, urlId, sso);

Актуализиране на публикация във фийда

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
feedPost	FeedPost	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateFeedPost

Copy

const tenantId: string = 'acme-global-tenant-42';
const id: string = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const asset: FeedPostMediaItemAsset = {
  url: 'https://cdn.acme.com/images/product-launch.jpg',
  mimeType: 'image/jpeg',
  width: 1200,
  height: 630
};
const mediaItem: FeedPostMediaItem = {
  id: 'media-001',
  type: 'image',
  asset
};
const link: FeedPostLink = {
  url: 'https://acme.com/blog/product-launch',
  title: 'Product Launch Details'
};
const feedPost: FeedPost = {
  title: 'Introducing the Q3 Product Suite',
  body: 'We are excited to unveil our new lineup for Q3, focusing on performance and security improvements.',
  media: [mediaItem],     // незадължителен масив, включен
  links: [link],          // незадължителни връзки, включени
  isPublished: true       // незадължителен флаг за публикуване, използван тук
};
const result: FlagCommentPublic200Response = await updateFeedPost(tenantId, id, feedPost);

Актуализиране на публична публикация във фийда

Параметри

Име	Тип	Задължително
tenantId	string	Да
postId	string	Да
updateFeedPostParams	UpdateFeedPostParams	Да
broadcastId	string	Не
sso	string	Не

Отговор

Връща: CreateFeedPostPublic200Response

Пример

Пример за updateFeedPostPublic

Copy

const tenantId: string = "tenant_9f4b2";
const postId: string = "post_21a8e";
const updateFeedPostParams: UpdateFeedPostParams = {
  title: "Quarterly product update",
  body: "Major performance improvements and bug fixes deployed today. See release notes and schedule.",
  links: [{ url: "https://status.example.com/release-notes", title: "Release notes" }],
  media: [
    {
      type: "image",
      assets: [{ url: "https://cdn.example.com/updates/q2.png", mimeType: "image/png", width: 1200, height: 628 }]
    }
  ]
};
const broadcastId: string = "broadcast_live_202603";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.signature";
const result: CreateFeedPostPublic200Response = await updateFeedPostPublic(tenantId, postId, updateFeedPostParams, broadcastId, sso);

Докладване на публичен коментар

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
isFlagged	boolean	Да
sso	string	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

flagCommentPublic Пример

Copy

const tenantId: string = "tenant_9f8b3c";
const commentId: string = "comment_72a1d4";
const isFlagged: boolean = true;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1Njc4OSJ9.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
const result: FlagCommentPublic200Response = await flagCommentPublic(tenantId, commentId, isFlagged, sso);

Получаване на голям GIF

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
largeInternalURLSanitized	string	Да

Отговор

Връща: GifGetLargeResponse

Пример

Пример за getGifLarge

Copy

const tenantId: string = 'acme_marketing_tenant_7';
const largeInternalURLSanitized: string = 'https://cdn.acmeinc.com/gifs/promo-spring-2026_large_sanitized.gif';
const includePreview: boolean | undefined = undefined; // незадължителен флаг, който повикващият може да използва
const result: GifGetLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);
console.log(result, includePreview);

Търсене на гифове

Параметри

Име	Тип	Задължително
tenantId	string	Да
search	string	Да
locale	string	Не
rating	string	Не
page	number	Не

Отговор

Връща: GifSearchResponse

Пример

Пример за getGifsSearch

Copy

const tenantId: string = "tenant_fcm_42";
const search: string = "funny golden retriever";
const locale: string = "en-US";
const rating: string = "pg";
const page: number = 2;
const result: GifSearchResponse = await getGifsSearch(tenantId, search, locale, rating, page);

Параметри

Име	Тип	Задължително
tenantId	string	Да
locale	string	Не
rating	string	Не
page	number	Не

Отговор

Връща: GifSearchResponse

Пример

Пример за getGifsTrending

Copy

const tenantId: string = "acme-tenant-01";
const trendingBasic: GifSearchResponse = await getGifsTrending(tenantId);
const locale: string = "en-GB";
const rating: string = "pg";
const page: number = 1;
const trendingWithOptions: GifSearchResponse = await getGifsTrending(tenantId, locale, rating, page);

Добавяне на хаштаг

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Не
createHashTagBody	CreateHashTagBody	Не

Отговор

Връща: AddHashTag200Response

Пример

addHashTag Пример

Copy

const tenantId: string | undefined = undefined;
const createHashTagBody: CreateHashTagBody = {
  name: 'release-2026',
  description: 'Feedback and bug reports for the April 2026 product release',
  synonyms: ['v2-release', 'launch-2026'],
  color: '#1d72b8',
  isActive: true,
  createdBy: 'product.manager@acme-corp.com'
};
const result: AddHashTag200Response = await addHashTag(tenantId, createHashTagBody);

Масово добавяне на хаштагове

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Не
bulkCreateHashTagsBody	BulkCreateHashTagsBody	Не

Отговор

Връща: AddHashTagsBulk200Response

Пример

Пример за addHashTagsBulk

Copy

const tenantId: string = 'tenant_acme_corp_01';
const bulkCreateHashTagsBody: BulkCreateHashTagsBody = {
  tags: [
    { name: 'feature-request', slug: 'feature-request', description: 'Requests for new capabilities', isActive: true, customConfig: { visibility: 'public' } as unknown as CustomConfigParameters }
  ]
};
const addHashTagsResponse: AddHashTagsBulk200Response = await addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
const bulkCreateHashTagsBodyNoTenant: BulkCreateHashTagsBody = {
  tags: [
    { name: 'ux-feedback', slug: 'ux-feedback', description: 'User experience suggestions', isActive: true }
  ]
};
const addHashTagsResponseNoTenant: AddHashTagsBulk200Response = await addHashTagsBulk(undefined, bulkCreateHashTagsBodyNoTenant);

Изтриване на хаштаг

Параметри

Име	Тип	Задължително
tag	string	Да
tenantId	string	Не
deleteHashTagRequest	DeleteHashTagRequest	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteHashTag

Copy

const tag: string = "spring-sale-2026";
const tenantId: string = "tenant-9876";
const deleteHashTagRequest: DeleteHashTagRequest = {
  requestedBy: "admin@retailco.com",
  reason: "Campaign ended; remove associated auto-tags",
  cascadeDelete: true
};
const result: FlagCommentPublic200Response = await deleteHashTag(tag, tenantId, deleteHashTagRequest);

Получаване на хаштагове

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
page	number	Не

Отговор

Връща: GetHashTags200Response

Пример

Пример за getHashTags

Copy

const tenantId: string = 'acme-tenant-42';
const pageNumber: number = 2;
const responseWithPage: GetHashTags200Response = await getHashTags(tenantId, pageNumber);
const responseWithoutPage: GetHashTags200Response = await getHashTags(tenantId);

Частична промяна на хаштаг

Параметри

Име	Тип	Задължително
tag	string	Да
tenantId	string	Не
updateHashTagBody	UpdateHashTagBody	Не

Отговор

Връща: PatchHashTag200Response

Пример

Пример за patchHashTag

Copy

const tag: string = "feature-ux-refresh";
const tenantId: string = "tenant_4f92c1";
const updateHashTagBody: UpdateHashTagBody = {
  label: "UX Refresh",
  description: "Track comments related to the 2026 UX redesign",
  isActive: true,
  metadata: { owner: "product-design", rolloutPhase: "phase-2" }
};
const response: PatchHashTag200Response = await patchHashTag(tag, tenantId, updateHashTagBody);

Създаване на модератор

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createModeratorBody	CreateModeratorBody	Да

Отговор

Връща: CreateModerator200Response

Пример

Пример за createModerator

Copy

const tenantId: string = "tenant_8f3b6c";
const optionalConfig: CustomConfigParameters = { moderationThreshold: 5, escalateOnRepeatedOffenses: true };
const newModerator: CreateModeratorBody = {
  email: "lina.gomez@dailynews.com",
  fullName: "Lina Gomez",
  role: "senior_moderator",
  enabled: true,
  notifyByEmail: true,
  customConfig: optionalConfig
};
const response: CreateModerator200Response = await createModerator(tenantId, newModerator);

Изтриване на модератор

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
sendEmail	string	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteModerator

Copy

const tenantId: string = 'tenant_9f8b7c6d';
const id: string = 'mod_4a3e11ec9d1f0242ac120003';
const sendEmail: string = 'true';
const result: FlagCommentPublic200Response = await deleteModerator(tenantId, id, sendEmail);

Получаване на модератор

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetModerator200Response

Пример

Пример за getModerator

Copy

const tenantId: string = 'acme-corp-tenant-123';
const id: string = 'mod-987654321';
const moderatorResponse: GetModerator200Response = await getModerator(tenantId, id);

Получаване на модератори

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
skip	number	Не

Отговор

Връща: GetModerators200Response

Пример

Пример за getModerators

Copy

const tenantId: string = 'tenant-12345-prod';
const moderatorsPage1: GetModerators200Response = await getModerators(tenantId);
const moderatorsPage2: GetModerators200Response = await getModerators(tenantId, 50);

Изпращане на покана

Параметри

Name	Type	Required
tenantId	string	Да
id	string	Да
fromName	string	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за sendInvite

Copy

const tenantId: string = 'tenant_acme-42';
const id: string = 'comment_8f3b21a7';
const fromName: string = 'Elena Morales';
const replyToEmail: string | undefined = undefined;
const result: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName, replyToEmail);

Актуализиране на модератор

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
updateModeratorBody	UpdateModeratorBody	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateModerator

Copy

const tenantId: string = "acme-enterprises-42";
const id: string = "moderator_517";
const updateModeratorBody: UpdateModeratorBody = {
  displayName: "Sofia Martinez",
  email: "sofia.martinez@acme.com",
  permissions: ["approve_comments", "flag_spam", "suspend_users"],
  active: true,
  avatarUrl: "https://cdn.acme.com/avatars/sofia.jpg" // демонстрирано опционално поле
};
const result: FlagCommentPublic200Response = await updateModerator(tenantId, id, updateModeratorBody);

Изтриване на брой уведомления

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteNotificationCount

Copy

const tenantId: string = "org-72a8f1b9";
const id: string = "notif-8f9c2e4a";
const result: FlagCommentPublic200Response = await deleteNotificationCount(tenantId, id);
console.log(result);

Получаване на кеширан брой уведомления

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetCachedNotificationCount200Response

Пример

Пример за getCachedNotificationCount

Copy

const tenantId: string = 'tenant_acme_42';
const id: string = 'user_00012345';
const includeUnreadOnly: boolean | undefined = true; // незадължителен флаг за параметър (демонстрирано)
const result: GetCachedNotificationCount200Response = await getCachedNotificationCount(tenantId, id);

Получаване на брой уведомления

Параметри

Име	Тип	Задължително
tenantId	string	Да
userId	string	Не
urlId	string	Не
fromCommentId	string	Не
viewed	boolean	Не
type	string	Не

Отговор

Връща: GetNotificationCount200Response

Пример

Пример за getNotificationCount

Copy

const tenantId: string = 'tenant_abc123';
const userId: string = 'user_987654321';
const urlId: string = 'https://example.com/news/2026/new-features';
const viewed: boolean = false;
const type: string = 'reply';
const notificationCountResponse: GetNotificationCount200Response = await getNotificationCount(tenantId, userId, urlId, undefined, viewed, type);

Получаване на уведомления

Параметри

Име	Type	Задължително
tenantId	string	Да
userId	string	Не
urlId	string	Не
fromCommentId	string	Не
viewed	boolean	Не
type	string	Не
skip	number	Не

Отговор

Връща: GetNotifications200Response

Пример

Пример за getNotifications

Copy

const tenantId: string = "tenant_84b3f2";
const userId: string = "user_1279";
const urlId: string = "https://www.example.com/articles/2026/03/25/new-feature";
const fromCommentId: string = "cmt_5421";
const viewed: boolean = false;
const type: string = "mention";
const skip: number = 0;
const notifications: GetNotifications200Response = await getNotifications(tenantId, userId, urlId, fromCommentId, viewed, type, skip);

Актуализиране на уведомление

Параметри

Name	Type	Задължително
tenantId	string	Да
id	string	Да
updateNotificationBody	UpdateNotificationBody	Да
userId	string	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateNotification

Copy

const tenantId: string = 'tenant_prod_8f4b2c';
const id: string = 'notification_61a2e9';
const userId: string = 'moderator_107';
const updateNotificationBody: UpdateNotificationBody = {
  name: 'Flagged Comment Notification',
  enabled: true,
  channels: ['email', 'inbox'],
  templateId: 'tmpl_mod_alerts_01',
  severity: 'high'
};
const result: FlagCommentPublic200Response = await updateNotification(tenantId, id, updateNotificationBody, userId);

Добавяне на страница

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createAPIPageData	CreateAPIPageData	Да

Отговор

Връща: AddPageAPIResponse

Изтриване на страница

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: DeletePageAPIResponse

Получаване на страница по URL идентификатор

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
urlId	string	Да

Отговор

Връща: GetPageByURLIdAPIResponse

Получаване на страници

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да

Отговор

Връща: GetPagesAPIResponse

Частична промяна на страница

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
updateAPIPageData	UpdateAPIPageData	Да

Отговор

Връща: PatchPageAPIResponse

Изтриване на чакащо уебхук събитие

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

deletePendingWebhookEvent Пример

Copy

const tenantId: string = "tenant_7f3b2a";
const webhookEventId: string = "wh_evt_9a8c7d1234";
const dryRun: boolean | undefined = undefined; // пример за опционален флаг (не е задължителен за това извикване)
const result: FlagCommentPublic200Response = await deletePendingWebhookEvent(tenantId, webhookEventId);

Получаване на брой чакащи уебхук събития

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Не
externalId	string	Не
eventType	string	Не
type	string	Не
domain	string	Не
attemptCountGT	number	Не

Отговор

Връща: GetPendingWebhookEventCount200Response

Пример

Пример за getPendingWebhookEventCount

Copy

const tenantId: string = "tenant_8d3b7a2f";
const commentId: string | undefined = "comment_79a2b";
const eventType: string | undefined = "comment.created";
const domain: string | undefined = "forum.acme-corp.com";
const attemptCountGT: number | undefined = 1;
const result: GetPendingWebhookEventCount200Response = await getPendingWebhookEventCount(
  tenantId,
  commentId,
  undefined,
  eventType,
  undefined,
  domain,
  attemptCountGT
);

Получаване на чакащи уебхук събития

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Не
externalId	string	Не
eventType	string	Не
type	string	Не
domain	string	Не
attemptCountGT	number	Не
skip	number	Не

Отговор

Връща: GetPendingWebhookEvents200Response

Пример

Пример getPendingWebhookEvents

Copy

const tenantId: string = 'tenant_9b3f7c';
const commentId: string | undefined = undefined;
const externalId: string | undefined = 'external-572a';
const eventType: string | undefined = 'comment.updated';
const type: string | undefined = 'outbound';
const domain: string | undefined = 'reviews.example.com';
const attemptCountGT: number | undefined = 1;
const skip: number | undefined = 20;
const result: GetPendingWebhookEvents200Response = await getPendingWebhookEvents(
  tenantId,
  commentId,
  externalId,
  eventType,
  type,
  domain,
  attemptCountGT,
  skip
);

Създаване на конфигурация на въпрос

Параметри

Name	Type	Required	Description
tenantId	string	Да
createQuestionConfigBody	CreateQuestionConfigBody	Да

Response

Връща: CreateQuestionConfig200Response

Пример

Пример за createQuestionConfig

Copy

const tenantId: string = "tenant_acme_01";
const createQuestionConfigBody: CreateQuestionConfigBody = {
  title: "Post-purchase feedback",
  description: "Quick survey about your recent order",
  required: true,
  renderingType: "single_choice",
  options: [
    { label: "Very dissatisfied", value: "1" },
    { label: "Dissatisfied", value: "2" },
    { label: "Neutral", value: "3" },
    { label: "Satisfied", value: "4" },
    { label: "Very satisfied", value: "5" }
  ] as QuestionConfigCustomOptionsInner[]
} as CreateQuestionConfigBody;
const result: CreateQuestionConfig200Response = await createQuestionConfig(tenantId, createQuestionConfigBody);

Изтриване на конфигурация на въпрос

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteQuestionConfig

Copy

const tenantId: string = "tenant_42fa9b7c";
const id: string = "qcfg-0f8fad5b-d9cb-469f-a165-70867728950e";
const result: FlagCommentPublic200Response = await deleteQuestionConfig(tenantId, id);

Получаване на конфигурация на въпрос

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetQuestionConfig200Response

Пример

Пример за getQuestionConfig

Copy

const tenantId: string = 'acme-tenant-92';
const id: string = 'question-2026-07-42';
const response: GetQuestionConfig200Response = await getQuestionConfig(tenantId, id);
function summarize(cfg: GetQuestionConfig200Response, includeDetails?: boolean): string {
  return includeDetails ? 'Question config (detailed)' : 'Question config (summary)';
}
const summary: string = summarize(response);

Получаване на конфигурации на въпроси

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
skip	number	Не

Отговор

Връща: GetQuestionConfigs200Response

Пример

Пример за getQuestionConfigs

Copy

const tenantId: string = "tenant_acme_9876";
const configsWithoutSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId);
const configsWithSkip: GetQuestionConfigs200Response = await getQuestionConfigs(tenantId, 20);

Актуализиране на конфигурация на въпрос

Параметри

Име	Тип	Задължителен
tenantId	string	Да
id	string	Да
updateQuestionConfigBody	UpdateQuestionConfigBody	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateQuestionConfig

Copy

const tenantId: string = 'tenant_42e8b';
const id: string = 'question_9f4a2';
const updateQuestionConfigBody: UpdateQuestionConfigBody = {
  questionText: 'How helpful was this article?',
  description: 'Shown to users below the question (optional)',
  required: true,
  renderingType: 'Likert' as QuestionRenderingType,
  customOptions: [
    { label: 'Very helpful', value: '5' } as QuestionConfigCustomOptionsInner,
    { label: 'Somewhat helpful', value: '3' } as QuestionConfigCustomOptionsInner,
    { label: 'Not helpful', value: '1' } as QuestionConfigCustomOptionsInner
  ],
  whenSave: 'notify' as QuestionWhenSave
};
const result: FlagCommentPublic200Response = await updateQuestionConfig(tenantId, id, updateQuestionConfigBody);

Създаване на резултат от въпрос

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createQuestionResultBody	CreateQuestionResultBody	Да

Отговор

Връща: CreateQuestionResult200Response

Пример

Пример за createQuestionResult

Copy

const tenantId: string = 'fastcomments-tenant-01';
const createQuestionResultBody: CreateQuestionResultBody = {
  questionId: 'q-34567',
  respondentId: 'user-8923',
  answers: [{ optionId: 'opt_A', text: 'Agree', count: 1 }],
  score: 5,
  meta: [{ key: 'platform', value: 'web' }],
  notifyModerators: false // незадължителен параметър
} as CreateQuestionResultBody;
const result: CreateQuestionResult200Response = await createQuestionResult(tenantId, createQuestionResultBody);

Изтриване на резултат от въпрос

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteQuestionResult

Copy

const tenantIdEnv: string | undefined = process.env.FASTCOMMENTS_TENANT_ID;
const tenantId: string = tenantIdEnv ?? 'tenant_78b3f2';
const id: string = 'qres-9f2a3b1c';
const response: FlagCommentPublic200Response = await deleteQuestionResult(tenantId, id);

Получаване на резултат от въпрос

Параметри

Име	Тип	Задължителен	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetQuestionResult200Response

Пример

Пример за getQuestionResult

Copy

const post: { title: string; questionId?: string } = { title: 'Product feedback' };
const tenantId: string = 'acme-corp-tenant-01';
const id: string = post.questionId ?? 'q-8f3a7b2c4d9e';
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);

Получаване на резултати от въпроси

Параметри

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Не
userId	string	Не
startDate	string	Не
questionId	string	Не
questionIds	string	Не
skip	number	Не

Отговор

Връща: GetQuestionResults200Response

Пример

Пример за getQuestionResults

Copy

const tenantId: string = "tenant_acme_001";
const urlId: string = "articles/product-launch-2026";
const userId: string = "user_2048";
const startDate: string = "2026-03-01T00:00:00Z";
const questionId: string | undefined = undefined;
const questionIds: string | undefined = "q_101,q_102";
const skip: number | undefined = 0;
const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, questionId, questionIds, skip);

Актуализиране на резултат от въпрос

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
updateQuestionResultBody	UpdateQuestionResultBody	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

updateQuestionResult Пример

Copy

const tenantId: string = 'tenant_7f8b3c';
const id: string = 'questionResult_4621';
const updateQuestionResultBody: UpdateQuestionResultBody = {
  questionId: 'q_1024',
  result: 'flagged',
  score: 0.92,
  notes: 'Automated moderation flagged for review',
  meta: [{ key: 'source', value: 'ai-moderator' }] as MetaItem[], // опционални метаданни
  status: { code: 'review_pending' } as APIStatus
} as UpdateQuestionResultBody;
const result: FlagCommentPublic200Response = await updateQuestionResult(tenantId, id, updateQuestionResultBody);

Агрегиране на резултати от въпроси

Параметри

Name	Type	Required
tenantId	string	Да
questionId	string	Не
questionIds	Array	Не
urlId	string	Не
timeBucket	AggregateTimeBucket	Не
startDate	Date	Не
forceRecalculate	boolean	Не

Отговор

Връща: AggregateQuestionResults200Response

Пример

Пример за aggregateQuestionResults

Copy

const tenantId: string = "tenant_acme_001";
const questionIds: string[] = ["q-2026-sales", "q-2026-support"];
const urlId: string = "url_7f2c";
const timeBucket: AggregateTimeBucket = { unit: "week", size: 1 };
const startDate: Date = new Date("2026-01-01T00:00:00Z");
const forceRecalculate: boolean = true;
const result: AggregateQuestionResults200Response = await aggregateQuestionResults(
  tenantId,
  undefined,
  questionIds,
  urlId,
  timeBucket,
  startDate,
  forceRecalculate
);

Масово агрегиране на резултати от въпроси

Параметри

Име	Тип	Задължително
tenantId	string	Да
bulkAggregateQuestionResultsRequest	BulkAggregateQuestionResultsRequest	Да
forceRecalculate	boolean	Не

Отговор

Връща: BulkAggregateQuestionResults200Response

Пример

Пример за bulkAggregateQuestionResults

Copy

const tenantId: string = "tenant_acme_42";
const bulkAggregateQuestionResultsRequest: BulkAggregateQuestionResultsRequest = {
  questions: [
    { questionId: "q-001", threadId: "thread-1001", questionType: "rating" },
    { questionId: "q-002", threadId: "thread-1002", questionType: "yes_no" }
  ],
  timeRange: { from: "2026-03-01T00:00:00Z", to: "2026-04-01T00:00:00Z" },
  groupBy: ["questionId", "threadId"]
};
const forceRecalculate: boolean = true;
const result: BulkAggregateQuestionResults200Response = await bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);

Комбиниране на коментари с резултати от въпроси

Параметри

Name	Type	Required
tenantId	string	Да
questionId	string	Не
questionIds	Array	Не
urlId	string	Не
startDate	Date	Не
forceRecalculate	boolean	Не
minValue	number	Не
maxValue	number	Не
limit	number	Не

Отговор

Връща: CombineCommentsWithQuestionResults200Response

Пример

Пример за combineCommentsWithQuestionResults

Copy

const tenantId: string = 'tenant-acme-001';
const questionId: string | undefined = 'q-analytics-42';
const questionIds: string[] | undefined = ['q-analytics-42', 'q-feedback-17'];
const urlId: string | undefined = 'url-987654';
const startDate: Date | undefined = new Date('2026-01-01T00:00:00Z');
const forceRecalculate: boolean | undefined = true;
const minValue: number | undefined = 1;
const maxValue: number | undefined = 5;
const limit: number | undefined = 250;
const result: CombineCommentsWithQuestionResults200Response = await combineCommentsWithQuestionResults(
  tenantId,
  questionId,
  questionIds,
  urlId,
  startDate,
  forceRecalculate,
  minValue,
  maxValue,
  limit
);

Добавяне на SSO потребител

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createAPISSOUserData	CreateAPISSOUserData	Да

Отговор

Връща: AddSSOUserAPIResponse

Изтриване на SSO потребител

Параметри

Name	Type	Required
tenantId	string	Да
id	string	Да
deleteComments	boolean	Не
commentDeleteMode	string	Не

Отговор

Връща: DeleteSSOUserAPIResponse

Получаване на SSO потребител по имейл

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
email	string	Да

Отговор

Връща: GetSSOUserByEmailAPIResponse

Получаване на SSO потребител по идентификатор

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetSSOUserByIdAPIResponse

Получаване на SSO потребители

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
skip	number	Не

Отговор

Връща: GetSSOUsers200Response

Частична промяна на SSO потребител

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
updateAPISSOUserData	UpdateAPISSOUserData	Да
updateComments	boolean	Не

Отговор

Връща: PatchSSOUserAPIResponse

Замяна на SSO потребител

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
updateAPISSOUserData	UpdateAPISSOUserData	Да
updateComments	boolean	Не

Отговор

Връща: PutSSOUserAPIResponse

Създаване на абонамент

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createAPIUserSubscriptionData	CreateAPIUserSubscriptionData	Да

Отговор

Връща: CreateSubscriptionAPIResponse

Пример

Пример за createSubscription

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, // демонстриран незадължителен параметър
  metadata: { campaign: "spring_launch" } // демонстриран незадължителен параметър
};
const result: CreateSubscriptionAPIResponse = await createSubscription(tenantId, createAPIUserSubscriptionData);

Изтриване на абонамент

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
userId	string	Не

Отговор

Връща: DeleteSubscriptionAPIResponse

Получаване на абонаменти

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
userId	string	Не

Отговор

Връща: GetSubscriptionsAPIResponse

Пример

Пример за getSubscriptions

Copy

const tenantId: string = 'tenant_acme_corp_01';
const userId: string = 'user_76a3b9f2';
const subscriptionsForUser: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId, userId);
const subscriptionsForTenant: GetSubscriptionsAPIResponse = await getSubscriptions(tenantId);

Актуализиране на абонамент

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
updateAPIUserSubscriptionData	UpdateAPIUserSubscriptionData	Да
userId	string	Не

Отговор

Връща: UpdateSubscriptionAPIResponse

Пример

Пример за updateSubscription

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

Получаване на дневна употреба на наематели

Параметри

Name	Type	Required
tenantId	string	Да
yearNumber	number	Не
monthNumber	number	Не
dayNumber	number	Не
skip	number	Не

Отговор

Връща: GetTenantDailyUsages200Response

Пример

Пример за getTenantDailyUsages

Copy

const tenantId: string = 'tenant_5f4a3b2c-1d6e-4f9a-b9d8-123456789abc';
const yearNumber: number = 2026;
const monthNumber: number = 3;
const dayNumber: number = 24;
const skip: number = 0;
const result: GetTenantDailyUsages200Response = await getTenantDailyUsages(tenantId, yearNumber, monthNumber, dayNumber, skip);

Създаване на пакет за наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
createTenantPackageBody	CreateTenantPackageBody	Yes

Отговор

Връща: CreateTenantPackage200Response

Пример

Пример на createTenantPackage

Copy

const tenantId: string = "tenant_acme-corp_001";
const createTenantPackageBody: CreateTenantPackageBody = {
  name: "Acme Standard Package",
  description: "Default package for Acme Corp comments with moderation and SSO enabled",
  enabled: true,
  maxCommentsPerThread: 500,
  voteStyle: "thumbs",
  gifRating: "PG-13",
  tosConfig: { enabled: true, url: "https://acme.example.com/terms" } // optional parameter demonstrated
};
const result: CreateTenantPackage200Response = await createTenantPackage(tenantId, createTenantPackageBody);

Изтриване на пакет на наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

deleteTenantPackage Пример

Copy

(async () => {
  const tenantId: string = "tenant_8f3a2b4c9d01";
  const packageId: string = "pkg_2026-04-security-patch";
  const result: FlagCommentPublic200Response = await deleteTenantPackage(tenantId, packageId);
  console.log(result);
})();

Получаване на пакет на наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetTenantPackage200Response

Пример

Пример за getTenantPackage

Copy

const tenantId: string = 'tenant_7f3b2c8';
const packageId: string = 'pkg_standard_2026';
const requestOptions: { includeConfig?: boolean } = { includeConfig: true };
const packageResponse: GetTenantPackage200Response = await getTenantPackage(tenantId, packageId);

Получаване на пакети на наематели

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
skip	number	Не

Отговор

Връща: GetTenantPackages200Response

Пример

Пример за getTenantPackages

Copy

const tenantId: string = "tenant_7f8e3b4c";
const skip: number = 20;
const packagesDefault: GetTenantPackages200Response = await getTenantPackages(tenantId);
const packagesWithSkip: GetTenantPackages200Response = await getTenantPackages(tenantId, skip);

Замяна на пакет на наемател

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
replaceTenantPackageBody	ReplaceTenantPackageBody	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за replaceTenantPackage

Copy

const tenantId: string = "tenant-9f3c2a";
const id: string = "pkg_4f8b21";
const replaceTenantPackageBody: ReplaceTenantPackageBody = {
  packageName: "Premium Moderation Pack",
  enabled: true,
  apiStatus: { mode: "active" } as APIStatus,
  customConfigParameters: { maxFlagsBeforeReview: 5 } as CustomConfigParameters,
  voteStyle: "thumbs" as VoteStyle,
  tosConfig: { requireAcceptance: true } as TOSConfig
};
const result: FlagCommentPublic200Response = await replaceTenantPackage(tenantId, id, replaceTenantPackageBody);

Актуализиране на пакет на наемател

Параметри

Name	Type	Required
tenantId	string	Да
id	string	Да
updateTenantPackageBody	UpdateTenantPackageBody	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateTenantPackage

Copy

const tenantId: string = "tenant_3b7f9d-prod";
const id: string = "pkg_enterprise_2026";
const updateTenantPackageBody: UpdateTenantPackageBody = {
  name: "Enterprise Plus",
  isActive: true,
  // опционалните полета са умишлено пропуснати (напр., description, limits)
} as UpdateTenantPackageBody;
const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);

Създаване на потребител на наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createTenantUserBody	CreateTenantUserBody	Да

Отговор

Връща: CreateTenantUser200Response

Пример

Пример за createTenantUser

Copy

const tenantId: string = "tenant_74b3a9f4b";
const createTenantUserBody: CreateTenantUserBody = {
  email: "jane.doe@acmecorp.com",
  displayName: "Jane Doe",
  role: "moderator",
  sendWelcomeEmail: true, // демонстрация на опционален параметър
  metadata: { department: "Customer Support" }
};
const result: CreateTenantUser200Response = await createTenantUser(tenantId, createTenantUserBody);

Изтриване на потребител на наемател

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
deleteComments	string	Не
commentDeleteMode	string	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

deleteTenantUser Пример

Copy

async function run(): Promise<void> {
  const tenantId: string = "acme_corp_tenant_9f1a2b";
  const id: string = "user_4d2a1b6c";
  const deleteComments: string = "true"; // премахнете и коментарите на потребителя
  const commentDeleteMode: string = "permanent"; // "permanent" или "soft"
  const result: FlagCommentPublic200Response = await deleteTenantUser(tenantId, id, deleteComments, commentDeleteMode);
  console.log(result);
}
run();

Получаване на потребител на наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
id	string	Yes

Отговор

Връща: GetTenantUser200Response

Пример

Пример за getTenantUser

Copy

const tenantId: string = 'tenant_fc5a9b2c';
const userId: string = 'user_0a12b3';
const result: GetTenantUser200Response = await getTenantUser(tenantId, userId);
const user: User | undefined = (result as any).user; // достъп до полезните данни
const userEmail: string | undefined = user?.email;
console.log('Fetched user email:', userEmail);

Получаване на потребители на наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
skip	number	Не

Отговор

Връща: GetTenantUsers200Response

Пример

getTenantUsers Пример

Copy

const tenantId: string = 'tenant_prod_8a3f2c';
const skip: number = 50;
const usersWithSkip: GetTenantUsers200Response = await getTenantUsers(tenantId, skip);
const usersNoSkip: GetTenantUsers200Response = await getTenantUsers(tenantId);

Замяна на потребител на наемател

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
replaceTenantUserBody	ReplaceTenantUserBody	Да
updateComments	string	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

replaceTenantUser Пример

Copy

const tenantId: string = 'tenant_9d8f4b2c';
const id: string = 'user_f47ac10b';
const replaceTenantUserBody: ReplaceTenantUserBody = {
  externalId: 'ext-5234',
  email: 'jane.doe@acme.com',
  displayName: 'Jane Doe',
  roles: ['moderator'],
  metadata: { department: 'product', region: 'us-east-1' }
};
const updateComments: string = 'propagate-display-name-to-comments';
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

Изпращане на линк за вход

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
redirectURL	string	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за sendLoginLink

Copy

const tenantId: string = "tenant_12a9f3b7";
const id: string = "user_84b2c7d1";
const redirectURL: string = "https://app.mycompany.com/welcome?ref=login_email";
const resultWithoutRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id);
const resultWithRedirect: FlagCommentPublic200Response = await sendLoginLink(tenantId, id, redirectURL);

Актуализиране на потребител на наемател

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
updateTenantUserBody	UpdateTenantUserBody	Да
updateComments	string	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateTenantUser

Copy

const tenantId: string = "tenant_8f3b2a9d";
const id: string = "user_52c9f1ab";
const updateTenantUserBody: UpdateTenantUserBody = {
  email: "jane.doe@example.com",
  displayName: "Jane Doe",
  roles: ["moderator"],
  isActive: true,
  metadata: { signupSource: "sso", locale: "en-US" }
};
const updateComments: string = "Promoted to moderator and updated display name";
const result: FlagCommentPublic200Response = await updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);

Създаване на наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createTenantBody	CreateTenantBody	Да

Отговор

Връща: CreateTenant200Response

Пример

Пример за createTenant

Copy

const tenantId: string = 'acme-corp-001';
const createTenantBody: CreateTenantBody = {
  name: 'Acme Corporation',
  domainConfiguration: { primaryDomain: 'comments.acme.com', enforceHttps: true } as APIDomainConfiguration,
  billingInfo: { planId: 'enterprise', contactEmail: 'billing@acme.com' } as BillingInfo
  // опционални полета като ssoConfig или customConfig са умишлено пропуснати
} as CreateTenantBody;
const result: CreateTenant200Response = await createTenant(tenantId, createTenantBody);

Изтриване на наемател

Parameters

Name	Тип	Задължително
tenantId	string	Да
id	string	Да
sure	string	Не

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за deleteTenant

Copy

const tenantId: string = 'tenant_42c9f1';
const id: string = 'flag_9a7b3c';
const sure: string = 'confirm-delete';
const result: FlagCommentPublic200Response = await deleteTenant(tenantId, id, sure);

Получаване на наемател

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
id	string	Yes

Отговор

Връща: GetTenant200Response

Пример

Пример за getTenant

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // незадължителен override, ако е наличен
const id: string = idOverride ?? "site_3e7a6b2f";
const response: GetTenant200Response = await getTenant(tenantId, id);
console.log(response);

Получаване на наематели

Параметри

Име	Тип	Задължително
tenantId	string	Да
meta	string	Не
skip	number	Не

Отговор

Връща: GetTenants200Response

Пример

Пример за getTenants

Copy

const tenantId: string = 'tenant_8421e7';
const meta: string = 'include=domains,billing,customConfig';
const skip: number = 20;
const tenantsBasic: GetTenants200Response = await getTenants(tenantId);
const tenantsWithOptions: GetTenants200Response = await getTenants(tenantId, meta, skip);

Актуализиране на наемател

Параметри

Name	Type	Required
tenantId	string	Да
id	string	Да
updateTenantBody	UpdateTenantBody	Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за updateTenant

Copy

const tenantId: string = "tenant_4821";
const id: string = "flag_7b9e";
const billingInfo: BillingInfo | undefined = undefined; // по избор, пропуснете, за да запазите текущото фактуриране
const updateTenantBody: UpdateTenantBody = {
  name: "Acme News Comments",
  defaultDomain: "comments.acme.com",
  ...(billingInfo ? { billingInfo } : {})
};
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

Промяна на състоянието на тикет

Параметри

Name	Type	Required
tenantId	string	Да
userId	string	Да
id	string	Да
changeTicketStateBody	ChangeTicketStateBody	Да

Отговор

Връща: ChangeTicketState200Response

Пример

Пример за changeTicketState

Copy

const tenantId: string = "tenant_7f3b2c9a";
const userId: string = "user_5a1d9fb2";
const id: string = "ticket_3e8a1b6f";
const changeTicketStateBody: ChangeTicketStateBody = {
  state: "closed",
  reason: "Fixed in backend release 2.4.1",
  notifyUsers: true,
  metadata: { resolutionOwner: "agent_12", priority: "high" } // демонстрирани опционални полета
};
const result: ChangeTicketState200Response = await changeTicketState(tenantId, userId, id, changeTicketStateBody);

Създаване на тикет

Параметри

Име	Тип	Задължително
tenantId	string	Да
userId	string	Да
createTicketBody	CreateTicketBody	Да

Отговор

Връща: CreateTicket200Response

Пример

Пример за createTicket

Copy

const tenantId: string = '7f3e9b1a-1c2d-4a5b-b6c7-d8e9f0123456';
const userId: string = 'd290f1ee-6c54-4b01-90e6-d701748f0851';
const createTicketBody: CreateTicketBody = {
  subject: 'Unable to post comments on product update',
  message: 'Submitting a comment returns a 504 timeout after ~10s. Reproducible in Chrome and Firefox.',
  priority: 'high', // незадължително поле, включено
  contactEmail: 'jane.doe@acme-corp.com',
  ccEmails: ['eng-oncall@acme-corp.com'], // незадължително поле, включено
  metadata: { page: '/blog/product-update', browser: 'Chrome 112' } // незадължително
};
const response: CreateTicket200Response = await createTicket(tenantId, userId, createTicketBody);

Получаване на тикет

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
userId	string	Не

Отговор

Връща: GetTicket200Response

Пример

Пример за getTicket

Copy

const tenantId: string = 'acme-corp-tenant-01';
const ticketId: string = 'tkt-20260325-42';
const userId: string = 'user-8452';
const ticketResponseWithUser: GetTicket200Response = await getTicket(tenantId, ticketId, userId);
const ticketResponseWithoutUser: GetTicket200Response = await getTicket(tenantId, ticketId);

Получаване на тикети

Параметри

Име	Тип	Задължително
tenantId	string	Да
userId	string	Не
state	number	Не
skip	number	Не
limit	number	Не

Отговор

Връща: GetTickets200Response

Пример

Пример за getTickets

Copy

const tenantId: string = "tenant_92f3b4c1";
const userId: string = "user_742a9f3e";
const state: number = 1;
const skip: number = 0;
const limit: number = 25;
const ticketsFull: GetTickets200Response = await getTickets(tenantId, userId, state, skip, limit);
const ticketsMinimal: GetTickets200Response = await getTickets("tenant_92f3b4c1");

Получаване на преводи

Параметри

Name	Тип	Задължително
namespace	string	Да
component	string	Да
locale	string	Не
useFullTranslationIds	boolean	Не

Отговор

Връща: GetTranslationsResponse

Пример

Пример за getTranslations

Copy

const translationsBase: GetTranslationsResponse = await getTranslations("acme-site-482", "commentThread");
const translationsSpanishFullIds: GetTranslationsResponse = await getTranslations("acme-site-482", "commentThread", "es-ES", true);

Качване на изображение

Качване и преоразмеряване на изображение

Параметри

Име	Тип	Задължително
tenantId	string	Да
file	Blob	Да
sizePreset	SizePreset	Не
urlId	string	Не

Отговор

Връща: UploadImageResponse

Получаване на напредъка на значката по идентификатор

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetUserBadgeProgressById200Response

Пример

Пример за getUserBadgeProgressById

Copy

const optionalTenantSuffix: string | undefined = undefined;
const tenantId: string = `5f8d0d55-1234-4ab1-9e2a-3f2b5c6d7e8f${optionalTenantSuffix ?? ''}`;
const id: string = '3a2b1c4d-5678-4ef0-9abc-def123456789';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressById(tenantId, id);

Получаване на напредъка на значката по идентификатор на потребител

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Yes
userId	string	Yes

Отговор

Връща: GetUserBadgeProgressById200Response

Пример

Пример за getUserBadgeProgressByUserId

Copy

const tenantId: string = 'tenant_7f9c2d3b';
const maybeUserId: string | undefined = 'user_4b8e1f9a'; // опционален източник (може да бъде undefined)
const userId: string = maybeUserId ?? 'user_fallback0001';
const result: GetUserBadgeProgressById200Response = await getUserBadgeProgressByUserId(tenantId, userId);
console.log(result);

Получаване на списък с напредък на значки

Параметри

Име	Тип	Задължително
tenantId	string	Да
userId	string	Не
limit	number	Не
skip	number	Не

Отговор

Връща: GetUserBadgeProgressList200Response

Пример

Пример за getUserBadgeProgressList

Copy

(async () => {
  const tenantId: string = 'tenant_4f8c2b9d';
  const userId: string = 'user_9a7e215c';
  const limit: number = 25;
  const skip: number = 0;
  const resultMinimal: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId);
  const resultFull: GetUserBadgeProgressList200Response = await getUserBadgeProgressList(tenantId, userId, limit, skip);
  console.log(resultMinimal, resultFull);
})();

Създаване на потребителска значка

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
createUserBadgeParams	CreateUserBadgeParams	Да

Отговор

Връща: CreateUserBadge200Response

Пример

Пример за createUserBadge

Copy

const tenantId: string = "tenant_9a8b7c";
const params: CreateUserBadgeParams = {
  name: "Top Contributor",
  slug: "top-contributor",
  description: "Awarded for 100 approved comments",
  iconUrl: "https://cdn.fastcomments.com/badges/top-contributor.png",
  active: true,
  criteria: { approvedComments: 100 },
  customConfig: { showOnProfile: true } // незадължителен параметър
};
const result: CreateUserBadge200Response = await createUserBadge(tenantId, params);

Изтриване на потребителска значка

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: UpdateUserBadge200Response

Пример

Пример за deleteUserBadge

Copy

type DeleteOptions = { notifyModerators?: boolean };
const tenantId: string = 'tenant_8a3f21';
const id: string = 'badge_71f2b';
const options: DeleteOptions = { notifyModerators: true };
const result: UpdateUserBadge200Response = await deleteUserBadge(tenantId, id);

Получаване на потребителска значка

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetUserBadge200Response

Пример

Пример за getUserBadge

Copy

const tenantId: string = "tenant_acme_01";
const id: string = "badge_8c7d2f";
const response: GetUserBadge200Response = await getUserBadge(tenantId, id);

Получаване на потребителски значки

Параметри

Име	Тип	Задължително
tenantId	string	Да
userId	string	Не
badgeId	string	Не
type	number	Не
displayedOnComments	boolean	Не
limit	number	Не
skip	number	Не

Отговор

Връща: GetUserBadges200Response

Пример

Пример на getUserBadges

Copy

const tenantId: string = 'tenant_acme_01';
const userId: string = 'user_5f4d3c2a';
const badgeId: string = 'badge_top_contributor';
const type: number = 1;
const displayedOnComments: boolean = true;
const limit: number = 50;
const skip: number = 0;
const result: GetUserBadges200Response = await getUserBadges(tenantId, userId, badgeId, type, displayedOnComments, limit, skip);

Актуализиране на потребителска значка

Параметри

Име	Тип	Задължително
tenantId	string	Да
id	string	Да
updateUserBadgeParams	UpdateUserBadgeParams	Да

Отговор

Връща: UpdateUserBadge200Response

Пример

Пример за updateUserBadge

Copy

(async () => {
  const tenantId: string = 'tenant_acme_987';
  const id: string = 'badge_top_contributor_42';
  const updateUserBadgeParams: UpdateUserBadgeParams = {
    title: 'Top Contributor',
    description: 'Awarded for reaching 100 high-quality comments',
    color: '#FFD700',
    iconUrl: 'https://cdn.acme.com/badges/top-contributor.svg',
    active: true,
    notifyUsers: true
  } as UpdateUserBadgeParams;
  const result: UpdateUserBadge200Response = await updateUserBadge(tenantId, id, updateUserBadgeParams);
  console.log(result);
})();

Получаване на брой потребителски уведомления

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
sso	string	Не

Отговор

Връща: GetUserNotificationCount200Response

Пример

Пример за getUserNotificationCount

Copy

(async () => {
  const tenantId: string = '9f1e2d3c-4b5a-6d7e-8f90-123456789abc';
  const ssoToken: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI0MjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c';
  const resultWithSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId, ssoToken);
  const resultWithoutSSO: GetUserNotificationCount200Response = await getUserNotificationCount(tenantId);
  console.log(resultWithSSO, resultWithoutSSO);
})();

Получаване на потребителски уведомления

Параметри

Name	Type	Required
tenantId	string	Да
pageSize	number	Не
afterId	string	Не
includeContext	boolean	Не
afterCreatedAt	number	Не
unreadOnly	boolean	Не
dmOnly	boolean	Не
noDm	boolean	Не
includeTranslations	boolean	Не
sso	string	Не

Отговор

Връща: GetUserNotifications200Response

Пример

Пример за getUserNotifications

Copy

const tenantId: string = 'tenant_7f3b1c';
const pageSize: number = 25;
const afterId: string = 'notif_b2f9e4';
const includeContext: boolean = true;
const afterCreatedAt: number = Date.now() - 24 * 60 * 60 * 1000;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const noDm: boolean = false;
const includeTranslations: boolean = true;
const sso: string = 'sso_tok_user_9f8d7c';
const response: GetUserNotifications200Response = await getUserNotifications(
  tenantId,
  pageSize,
  afterId,
  includeContext,
  afterCreatedAt,
  unreadOnly,
  dmOnly,
  noDm,
  includeTranslations,
  sso
);

Нулиране на брой потребителски уведомления

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
sso	string	Не

Отговор

Връща: ResetUserNotifications200Response

Пример

Пример за resetUserNotificationCount

Copy

(async () => {
  const tenantId: string = "tenant_9f3b2c4a";
  const ssoToken: string | undefined = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9._sample_payload_.signature";
  const responseWithSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId, ssoToken);
  const responseWithoutSSO: ResetUserNotifications200Response = await resetUserNotificationCount(tenantId);
  console.log(responseWithSSO, responseWithoutSSO);
})();

Нулиране на потребителски уведомления

Параметри

Име	Тип	Задължително
tenantId	string	Да
afterId	string	Не
afterCreatedAt	number	Не
unreadOnly	boolean	Не
dmOnly	boolean	Не
noDm	boolean	Не
sso	string	Не

Отговор

Връща: ResetUserNotifications200Response

Пример

Пример за resetUserNotifications

Copy

const tenantId: string = "tenant_prod_4a9f12";
const afterId: string = "notification_87213";
const afterCreatedAt: number = Math.floor(Date.now() / 1000) - 3600;
const unreadOnly: boolean = true;
const dmOnly: boolean = false;
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.example.payload";
const result: ResetUserNotifications200Response = await resetUserNotifications(tenantId, afterId, afterCreatedAt, unreadOnly, dmOnly, undefined, sso);

Актуализиране на статуса на абонамент за уведомления за коментари на потребителя

Активиране или деактивиране на уведомления за конкретен коментар.

Параметри

Име	Тип	Задължително
tenantId	string	Да
notificationId	string	Да
optedInOrOut	UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum	Да
commentId	string	Да
sso	string	Не

Отговор

Връща: UpdateUserNotificationStatus200Response

Пример

Пример за updateUserNotificationCommentSubscriptionStatus

Copy

const tenantId: string = 'acme-tenant-001';
const notificationId: string = 'notif-2026-03-25-01';
const commentId: string = 'cmt-8f3a2b';
const optedInOrOut: UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum = UpdateUserNotificationCommentSubscriptionStatusOptedInOrOutEnum.OptIn;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso-payload.signature';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);

Актуализиране на статуса на абонамент за уведомления за страници на потребителя

Активиране или деактивиране на уведомления за страница. Когато потребителите са абонирани за страница, се създават уведомления за нови коренови коментари, както и

Parameters

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Да
url	string	Да
pageTitle	string	Да
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Да
sso	string	Не

Отговор

Връща: UpdateUserNotificationStatus200Response

Пример

updateUserNotificationPageSubscriptionStatus Пример

Copy

const tenantId: string = 'acme-tenant-42';
const urlId: string = 'blog-launch-2026';
const url: string = 'https://acme.example.com/blog/launch-march-2026';
const pageTitle: string = 'Acme Product Launch — March 2026';
const subscribedOrUnsubscribed: UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum = UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum.Subscribed;
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const response: UpdateUserNotificationStatus200Response = await updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);

Актуализиране на статуса на потребителските уведомления

Параметри

Име	Тип	Задължително
tenantId	string	Да
notificationId	string	Да
newStatus	UpdateUserNotificationStatusNewStatusEnum	Да
sso	string	Не

Отговор

Връща: UpdateUserNotificationStatus200Response

Пример

Пример за updateUserNotificationStatus

Copy

const tenantId: string = 'tenant_84a2c3';
const notificationId: string = 'notif_20260325_01';
const newStatus: UpdateUserNotificationStatusNewStatusEnum = UpdateUserNotificationStatusNewStatusEnum.Read;
const sso: string = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.sso_signature_example';
const result: UpdateUserNotificationStatus200Response = await updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);

Получаване на статуси на присъствие на потребителите

Параметри

Name	Type	Required
tenantId	string	Yes
urlIdWS	string	Yes
userIds	string	Yes

Отговор

Връща: GetUserPresenceStatuses200Response

Пример

Пример за getUserPresenceStatuses

Copy

const tenantId: string = 'tenant_7f3a2b';
const urlIdWS: string = 'articles/2026/03/25/fastcomments-integration';
const maybeUserIds: string | undefined = 'user_123,user_456'; // незадължителен източник
const userIds: string = maybeUserIds ?? 'user_123';
const presence: GetUserPresenceStatuses200Response = await getUserPresenceStatuses(tenantId, urlIdWS, userIds);

Търсене на потребители

Параметри

Име	Тип	Задължително
tenantId	string	Да
urlId	string	Да
usernameStartsWith	string	Не
mentionGroupIds	Array	Не
sso	string	Не
searchSection	SearchUsersSearchSectionEnum	Не

Отговор

Връща: SearchUsers200Response

Пример

Пример за searchUsers

Copy

const tenantId: string = 'tenant_8392';
const urlId: string = 'articles/2026/03/25/fastcomments-release';
const usernameStartsWith: string = 'jo';
const mentionGroupIds: Array<string> = ['editors', 'senior-writers'];
const sso: string = 'sso_jwt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
const searchSection: SearchUsersSearchSectionEnum = SearchUsersSearchSectionEnum.ALL;
const result: SearchUsers200Response = await searchUsers(tenantId, urlId, usernameStartsWith, mentionGroupIds, sso, searchSection);

Получаване на потребител

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
id	string	Да

Отговор

Връща: GetUser200Response

Пример

Пример за getUser

Copy

const tenantId: string = 'tenant_7b3f42';
const id: string = 'user_9c4d2a';
const userResponse: GetUser200Response = await getUser(tenantId, id);
console.log(userResponse);

Създаване на глас

Параметри

Име	Тип	Задължително
tenantId	string	Да
commentId	string	Да
direction	CreateVoteDirectionEnum	Да
userId	string	Не
anonUserId	string	Не

Отговор

Връща: VoteComment200Response

Пример

Пример за createVote

Copy

const tenantId: string = 'tenant_5f2a9b';
const commentId: string = 'cmt_3b7e21';
const direction: CreateVoteDirectionEnum = CreateVoteDirectionEnum.Up;
const anonUserId: string = 'anon_9x7k2p';
const voteResult: VoteComment200Response = await createVote(tenantId, commentId, direction, undefined, anonUserId);

Изтриване на глас

Параметри

Name	Type	Required
tenantId	string	Да
id	string	Да
editKey	string	Не

Отговор

Връща: DeleteCommentVote200Response

Пример

Пример за deleteVote

Copy

const tenantId: string = '123e4567-e89b-12d3-a456-426614174000';
const id: string = 'vote-7a1b2c3d-9f8e-4b6a-8123-abcdef012345';
const editKey: string = 'editKey_4f3e2d1c';
const resultWithEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id, editKey);
const resultWithoutEditKey: DeleteCommentVote200Response = await deleteVote(tenantId, id);

Получаване на гласове

Параметри

Име	Тип	Задължително	Описание
tenantId	string	Да
urlId	string	Да

Отговор

Връща: GetVotes200Response

Пример

getVotes Пример

Copy

const tenantId: string = 'acme-corp-8f3b';
const refCampaign: string | undefined = 'newsletter-march2026'; // незадължителен параметър на заявката
const urlId: string = `https://www.example.com/articles/2026/03/25/fastcomments-integration${refCampaign ? `?ref=${refCampaign}` : ''}`;
const votes: GetVotes200Response = await getVotes(tenantId, urlId);

Получаване на гласове за потребител

Параметри

Име	Тип	Задължителен
tenantId	string	Да
urlId	string	Да
userId	string	Не
anonUserId	string	Не

Отговор

Връща: GetVotesForUser200Response

Пример

Пример за getVotesForUser

Copy

(async (): Promise<void> => {
  const tenantId: string = "local-news-ny";
  const urlId: string = "articles/2026-03-25/ev-infrastructure-update";
  const userId: string = "user_78b6f3d9";
  const anonUserId: string = "anon_9c3f7a1b";
  const result: GetVotesForUser200Response = await getVotesForUser(tenantId, urlId, userId, anonUserId);
  console.log(result);
})();

Нужна помощ?

Ако срещнете проблеми или имате въпроси относно JavaScript/TypeScript SDK, моля:

Принос

Приносите са добре дошли! Моля посетете репозитория в GitHub за указания относно приноса.

Език 🇧🇬 Български

Първи стъпки

Референция на API

Документация

Използване

Агрегиране

Логове за одит

Блокиране от коментар

Проверка на блокирани коментари

Коментари

Коментари за потребител

Конфигурации на домейни

Шаблони за имейл

Дневник на събитията

Публикации във фийда

Докладване на коментар

Гифове

Хаштагове

Модератори

Брой уведомления

Уведомления

Страници

Чакащи уебхук събития

Конфигурации на въпроси

Резултати от въпроси

Агрегиране на резултати от въпроси

SSO потребители

Абонаменти

Дневна употреба на наемател

Пакети на наематели

Потребители на наемател

Наематели

Тикети

Преводи

Качване на изображение

Напредък на значката на потребителя

Потребителски значки

Потребителски уведомления

Статус на присъствие на потребителя

Търсене на потребители

Потребители

Гласове

FastComments JavaScript/TypeScript SDK

Хранилище

Инсталация

Документация на API

Пълна справка за API: docs/api/README.md

Съвместимост между браузър и сървър

Използване

Използване в браузъра (клиентска страна)

Използване на сървъра (Node.js)

Импорт само на типове

Използване на отделни API класове

Браузърна среда

Сървърна среда

Публични и защитени API

Пример: Използване на Public API (безопасно за браузър)

Пример: Използване на Default API (само от страна на сървъра)

SSO (Еднократен вход) интеграция

Прост SSO (само от страна на сървъра)

Сигурен SSO (от страна на сървъра, препоръчително)

Използване на SSO от браузъра (с токен, генериран от сървъра)

SSO с създаване на коментар

Често срещани случаи на употреба

Получаване на коментари за страница

Създаване на коментар

Гласуване за коментар

Управление на потребители (изисква API ключ)

Живи събития (Актуализации в реално време)

Събития на ниво страница

Абониране за потребителски събития

Получаване на userIdWS

Идентификатори за излъчване

Обработка на грешки

Агрегиране

Параметри

Отговор

Получаване на логове за одит

Параметри

Отговор