FastComments SDK для JavaScript/TypeScript

Это официальный SDK на JavaScript/TypeScript для 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 доступна только в серверном экспорте, так как требует возможностей crypto в Node.js.

Simple SSO (Server-Side Only)

Простой SSO должен генерироваться на стороне сервера и отправляться клиенту:

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

// Create simple SSO using the built-in helper  
const userData = {
  username: 'john_doe',
  email: 'john@example.com',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg'
};

const sso = FastCommentsSSO.createSimple(userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoToken = sso.createToken();

// Отправьте ssoToken на клиент
// Код на стороне клиента затем может использовать этот токен с браузерным SDK

Secure SSO (Server-Side, Recommended)

Защищённый SSO должен реализовываться на стороне сервера и обеспечивает лучшую безопасность:

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

// Create secure SSO using the built-in helper
const userData = {
  id: 'user-123',
  email: 'john@example.com',
  username: 'john_doe',
  displayName: 'John Doe',
  avatar: 'https://example.com/avatar.jpg',
  isAdmin: false,
  isModerator: false
};

const sso = FastCommentsSSO.createSecure('your-api-key', userData, {
  loginURL: '/login',
  logoutURL: '/logout'
});

const ssoConfig = sso.prepareToSend();

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

// Или отправьте ssoConfig клиенту для использования в браузере

Using SSO from Browser (with Server-Generated Token)

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

// Получите SSO токен с вашего серверного эндпоинта
const ssoToken = await fetch('/api/sso-token').then(r => r.json());

const publicApi = new PublicApi();
const response = await publicApi.getCommentsPublic({
  tenantId: 'your-tenant-id',
  urlId: 'page-url-id',
  sso: ssoToken // Use the server-generated SSO token
});

SSO with Comment Creation

// На стороне сервера: создать 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'
});

Live события (обновления в реальном времени)

Подпишитесь на live-события, чтобы получать обновления в реальном времени о комментариях, голосах и других действиях.

События на уровне страницы

Отслеживайте live-события на конкретной странице (комментарии, голоса и т.д.):

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

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

// Подписаться на live-события для страницы
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');
  }
);

// Close the subscription when done
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 требуется для live-событий и может быть получен из ответов API:

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

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

if (userIdWS) {
  // Теперь можно подписаться на live-события
  const subscription = subscribeToChanges(config, tenantIdWS, urlIdWS, userIdWS, handleEvent);
}

Идентификаторы трансляций

Вы увидите, что в некоторых вызовах API требуется передавать broadcastId. Когда вы получаете события, вы получите этот ID обратно, так что сможете игнорировать событие, если планируете оптимистично применять изменения на клиенте (и, вероятно, вам захочется так сделать, поскольку это обеспечивает лучший опыт). Передайте здесь UUID. Этот ID должен быть достаточно уникальным, чтобы не повториться дважды в рамках одной сессии браузера.

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() // Уникальный ID для этой операции
  }
});

Обработка ошибок

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

Заблокировать по публичному комментарию

Параметры

Name	Type	Required
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
);

Создать публичный комментарий

Параметры

Name	Type	Required
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
);

Удалить голос за комментарий

Параметры

Name	Type	Required
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

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

Параметры

Имя	Тип	Обязательно
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

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', // urlId
  '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
);

Получить текст комментария

Параметры

Name	Type	Required
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);

Получить имена пользователей, проголосовавших за комментарий

Параметры

Имя	Тип	Обязательно
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);
})();

Заблокировать комментарий

Параметры

Name	Type	Required
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	Yes
commentId	string	Yes
broadcastId	string	Yes
sso	string	No

Ответ

Возвращает: 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);

Сохранить комментарий

Параметры

Name	Type	Required
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);

Сохранить комментарии пакетно

Параметры

Name	Тип	Обязательно
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-42';
const commentId: string = 'cmt-8932';
const broadcastId: string = 'brd-2023-07';
const updateRequest: CommentTextUpdateRequest = {
  text: 'Updated comment text for the product launch — congrats team!',
  mentions: [{ userId: 'user-17', displayName: 'Ava Nguyen' }] as CommentUserMentionInfo[],
  hashtags: [{ tag: 'ProductLaunch' }] as CommentUserHashTagInfo[]
};
const editKey: string = 'edtk-9f7b';
const sso: string = 'sso-token-abc123';
const result: SetCommentText200Response = await setCommentText(tenantId, commentId, broadcastId, updateRequest, 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	Да
commentId	string	Да
broadcastId	string	Да
sso	string	Нет

Ответ

Возвращает: 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_3f47b2a1";
const id: string = "comment_9a12b3c4";
const updatableCommentParams: UpdatableCommentParams = {
  body: "Thanks for the update — I've adjusted my view accordingly."
};
const contextUserId: string = "user_8721";
const doSpamCheck: boolean = true;
const isLive: boolean = false;
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);

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

Параметры

Name	Type	Обязательный
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_82f9b';
const tenantId: string = 'tenant_22';
const page: number = 2;
const lastGenDate: number = Date.now();
const includei10n: boolean = true;
const useFullTranslationIds: boolean = false;
const locale: string = 'en-US';
const includeConfig: boolean = true;
const includeNotificationCount: boolean = true;
const countAll: boolean = false;
const sso: string = 'sso-token-1a2b';
const commentsResponse: GetCommentsForUserResponse = await getCommentsForUser(userId, tenantId, undefined, page, undefined, lastGenDate, undefined, undefined, includei10n, useFullTranslationIds, locale, includeConfig, includeNotificationCount, countAll, sso);

Добавить конфигурацию домена

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
addDomainConfigParams	AddDomainConfigParams	Да

Ответ

Возвращает: AddDomainConfig200Response

Удалить конфигурацию домена

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
domain	string	Да

Ответ

Возвращает: DeleteDomainConfig200Response

Получить конфигурацию домена

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
domain	string	Да

Ответ

Возвращает: GetDomainConfig200Response

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

Параметры

Name	Type	Required	Description
tenantId	string	Да

Ответ

Возвращает: GetDomainConfigs200Response

Изменить конфигурацию домена (PATCH)

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
domainToUpdate	string	Да
patchDomainConfigParams	PatchDomainConfigParams	Да

Ответ

Возвращает: GetDomainConfig200Response

Заменить конфигурацию домена (PUT)

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
domainToUpdate	string	Да
updateDomainConfigParams	UpdateDomainConfigParams	Да

Ответ

Возвращает: GetDomainConfig200Response

Создать шаблон email

Параметры

Имя	Тип	Обязательно	Описание
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);
})();

Удалить шаблон email

Parameters

Имя	Тип	Обязательно	Описание
tenantId	string	Да
id	string	Да

Response

Возвращает: FlagCommentPublic200Response

Example

Пример 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);

Удалить ошибку рендера шаблона email

Параметры

Имя	Тип	Обязательно
tenantId	string	Yes
id	string	Yes
errorId	string	Yes

Ответ

Возвращает: 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);
// Если бы поддерживался необязательный объект options, он мог бы выглядеть так:
// await deleteEmailTemplateRenderError(tenantId, id, errorId /*, { includeStackTrace } */);

Получить шаблон email

Параметры

Имя	Тип	Обязательно	Описание
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;

Получить определения шаблонов email

Параметры

Имя	Тип	Обязательно	Описание
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);

Получить ошибки рендера шаблонов email

Параметры

Name	Type	Required
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);
})();

Получить шаблоны email

Параметры

Name	Type	Required	Description
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();

Отрендерить шаблон email

Параметры

Name	Type	Обязательно
tenantId	string	Да
renderEmailTemplateBody	RenderEmailTemplateBody	Да
locale	string	Нет

Ответ

Возвращает: RenderEmailTemplate200Response

Пример

Пример renderEmailTemplate

Copy

const tenantId: string = 'acme-corp-987';
const renderEmailTemplateBody: RenderEmailTemplateBody = {
  templateId: 'user-invite',
  subject: "You're invited to Acme",
  placeholders: { firstName: 'Alex' },
  metadata: { source: 'signup-flow' }
};
const locale: string = 'en-US';
const result: RenderEmailTemplate200Response = await renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);

Обновить шаблон email

Параметры

Имя	Тип	Обязательно
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

Параметры

Имя	Тип	Обязательно
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);

Удалить публичную запись в ленте

Параметры

Name	Type	Required
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);

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

Параметры

Name	Type	Required
tenantId	string	Да
postId	string	Да
reactBodyParams	ReactBodyParams	Да
isUndo	boolean	Нет
broadcastId	string	Нет
urlId	string	Нет
sso	string	Нет

Ответ

Возвращает: ReactFeedPostPublic200Response

Пример

Пример reactFeedPostPublic

Copy

const tenantId: string = "global-markets";
const postId: string = "8e2c3f9a-4b6d-4f1a-9c2d-e8a1b2c3d4e5";
const reactBodyParams: ReactBodyParams = { reactionType: "like", clientApp: "web-ui", timestamp: new Date().toISOString() };
const isUndo: boolean = false;
const broadcastId: string = "broadcast-2026-05-20";
const urlId: string = "feed-post-8e2c";
const sso: string = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.fake.payload";
const result: ReactFeedPostPublic200Response = await reactFeedPostPublic(tenantId, postId, reactBodyParams, isUndo, broadcastId, urlId, sso);

Обновить запись ленты

Параметры

Name	Type	Обязательно
tenantId	string	Да
id	string	Да
feedPost	FeedPost	Да

Response

Возвращает: 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

Параметры

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

Ответ

Возвращает: GifGetLargeResponse

Пример

Пример getGifLarge

Copy

const tenantId: string = 'tenant_8a92f4';
const largeInternalURLSanitized: string = 'https://cdn.streamingco.com/gifs/product-demo-large.gif';
let maybeStatus: APIStatus | undefined = undefined; // необязательные метаданные, если доступны
const response: GifGetLargeResponse = await getGifLarge(tenantId, largeInternalURLSanitized);

Поиск GIF

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
search	string	Да
locale	string	Нет
rating	string	Нет
page	number	Нет

Ответ

Возвращает: GifSearchResponse

Пример

Пример getGifsSearch

Copy

(async () => {
  const tenantId: string = "global-media";
  const search: string = "laughing baby";
  const locale: string = "en-US";
  const rating: string = "pg";
  const page: number = 2;
  const result: GifSearchResponse = await getGifsSearch(tenantId, search, locale, rating, page);
  console.log(result);
})();

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
locale	string	Нет
rating	string	Нет
page	number	Нет

Ответ

Возвращает: GifSearchResponse

Пример

Пример getGifsTrending

Copy

const tenantId: string = 'tenant_42';
const locale: string = 'en-US';
const rating: string = 'PG';
const page: number = 1;
const result: 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);

Добавить хэштеги пакетно

Параметры

Name	Type	Required	Description
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	Yes
tenantId	string	No
deleteHashTagRequest	DeleteHashTagRequest	No

Ответ

Возвращает: 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);

Изменить хэштег (PATCH)

Параметры

Name	Type	Required
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);

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

Параметры

Имя	Type	Обязательно	Описание
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	Да

Response

Возвращает: FlagCommentPublic200Response

Пример

Пример использования sendInvite

Copy

const tenantId: string = 'acme-corp-128';
const id: string = 'comment-8421f';
const fromName: string = 'Marcus Lindström';
const note: string | undefined = undefined; // пример необязательного параметра
const response: FlagCommentPublic200Response = await sendInvite(tenantId, id, fromName);

Обновить модератора

Параметры

Name	Type	Required
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);

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

Параметры

Имя	Тип	Обязательный
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);

Обновить уведомление

Параметры

Имя	Тип	Обязательно
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 ID

Параметры

Название	Тип	Обязательно	Описание
tenantId	string	Да
urlId	string	Да

Ответ

Возвращает: GetPageByURLIdAPIResponse

Получить страницы

Параметры

Name	Type	Required	Description
tenantId	string	Да

Ответ

Возвращает: GetPagesAPIResponse

Изменить страницу (PATCH)

Параметры

Имя	Тип	Обязательно
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);

Получить количество ожидающих событий вебхуков

Параметры

Name	Type	Required
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
);

Получить ожидающие события вебхуков

Параметры

Name	Type	Required
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
);

Создать конфигурацию вопроса

Параметры

Имя	Тип	Обязательный	Описание
tenantId	string	Да
createQuestionConfigBody	CreateQuestionConfigBody	Да

Ответ

Возвращает: 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);

Получить конфигурацию вопроса

Параметры

Name	Type	Required	Description
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);

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

Parameters

Имя	Тип	Обязательно	Описание
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);

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

Параметры

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

Ответ

Возвращает: GetQuestionResult200Response

Пример

Пример getQuestionResult

Copy

const tenantId: string = 'acme-corp-42';
const id: string = 'question-9f8b7c';
const includeComments: boolean | undefined = true; // пример необязательного параметра
const result: GetQuestionResult200Response = await getQuestionResult(tenantId, id);
console.log(result);

Получить результаты вопросов

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
urlId	string	Нет
userId	string	Нет
startDate	string	Нет
questionId	string	Нет
questionIds	string	Нет
skip	number	Нет

Ответ

Возвращает: GetQuestionResults200Response

Пример

Пример getQuestionResults

Copy

(async () => {
  const tenantId: string = "tenant_9b3f";
  const urlId: string = "survey-2026-spring";
  const userId: string = "user_00123";
  const startDate: string = "2026-04-01T00:00:00Z";
  const questionIds: string = "q_42,q_43";
  const skip: number = 0;
  const result: GetQuestionResults200Response = await getQuestionResults(tenantId, urlId, userId, startDate, undefined, questionIds, skip);
  console.log(result);
})();

Обновить результат вопроса

Параметры

Name	Type	Required
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);

Агрегировать результаты вопросов

Параметры

Имя	Тип	Обязательно
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
);

Пакетная агрегация результатов вопросов

Параметры

Name	Type	Required
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	Тип	Обязательно
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

Параметры

Имя	Тип	Обязательный
tenantId	string	Да
id	string	Да
deleteComments	boolean	Нет
commentDeleteMode	string	Нет

Ответ

Возвращает: DeleteSSOUserAPIResponse

Получить пользователя SSO по email

Параметры

Имя	Тип	Требуется	Описание
tenantId	string	Да
email	string	Да

Ответ

Возвращает: GetSSOUserByEmailAPIResponse

Получить пользователя SSO по ID

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
id	string	Да

Ответ

Возвращает: GetSSOUserByIdAPIResponse

Получить пользователей SSO

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
skip	number	Нет

Ответ

Возвращает: GetSSOUsers200Response

Изменить пользователя SSO (PATCH)

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
id	string	Да
updateAPISSOUserData	UpdateAPISSOUserData	Да
updateComments	boolean	Нет

Ответ

Возвращает: PatchSSOUserAPIResponse

Заменить пользователя SSO (PUT)

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
id	string	Да
updateAPISSOUserData	UpdateAPISSOUserData	Да
updateComments	boolean	Нет

Ответ

Возвращает: PutSSOUserAPIResponse

Пример

Пример putSSOUser

Copy

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

Создать подписку

Параметры

Имя	Тип	Обязательно	Описание
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);

Удалить подписку

Параметры

Name	Type	Required
tenantId	string	Да
id	string	Да
userId	string	Нет

Ответ

Возвращает: DeleteSubscriptionAPIResponse

Получить подписки

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
userId	string	Нет

Ответ

Возвращает: GetSubscriptionsAPIResponse

Пример

Пример getSubscriptions

Copy

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

Обновить подписку

Параметры

Name	Type	Required
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	Да
createTenantPackageBody	CreateTenantPackageBody	Да

Ответ

Возвращает: 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" } // демонстрация необязательного параметра
};
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-7b3c2f';
const skipCount: number = 10;
const packages: GetTenantPackages200Response = await getTenantPackages(tenantId, skipCount);
const packagesFromStart: GetTenantPackages200Response = await getTenantPackages(tenantId);

Заменить пакет тенанта

Параметры

Имя	Тип	Обязательно
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	Тип	Обязательно
tenantId	string	Да
id	string	Да
updateTenantPackageBody	UpdateTenantPackageBody	Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример updateTenantPackage

Copy

(async () => {
  const tenantId: string = "tenant_sf_001";
  const id: string = "pkg-premium-v2";
  const updateTenantPackageBody: UpdateTenantPackageBody = {
    name: "San Francisco Premium",
    enabled: true,
    customConfig: { maxComments: 500 },
    tosConfig: { required: true } // необязательные поля показаны в качестве примера; остальные опущены
  } as UpdateTenantPackageBody;
  const result: FlagCommentPublic200Response = await updateTenantPackage(tenantId, id, updateTenantPackageBody);
  console.log(result);
})();

Создать пользователя тенанта

Параметры

Имя	Тип	Обязательно	Описание
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);

Удалить пользователя тенанта

Параметры

Name	Type	Required
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	Да
id	string	Да

Ответ

Возвращает: 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_acmeCorp";
const id: string = "user_84b2";
const replaceTenantUserBody: ReplaceTenantUserBody = {
  email: "alice.jenkins@acmecorp.com",
  displayName: "Alice Jenkins",
  roles: ["moderator", "editor"],
  disabled: false
} as ReplaceTenantUserBody;
const updateComments: string = "Migrated user account and reattributed historical comments";
const result: FlagCommentPublic200Response = await replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);

Отправить ссылку для входа

Параметры

Name	Type	Обязательный
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);

Обновить пользователя тенанта

Параметры

Name	Type	Required
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);

Создать тенанта

Параметры

Name	Type	Required	Description
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);

Удалить тенанта

Параметры

Имя	Тип	Обязательно
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);

Получить тенанта

Параметры

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

Ответ

Возвращает: GetTenant200Response

Пример

Пример getTenant

Copy

const tenantId: string = "tenant_9f4b2c1a";
const idOverride: string | undefined = undefined; // необязательное переопределение, если доступно
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 = 'acme-corp-001';
const id: string = 'tenant-42';
const billingInfo: BillingInfo = { billingEmail: 'billing@acme.com', address: '123 Market St' } as BillingInfo;
const updateTenantBody: UpdateTenantBody = { displayName: 'Acme Corporation', billingInfo } as UpdateTenantBody;
const result: FlagCommentPublic200Response = await updateTenant(tenantId, id, updateTenantBody);

Изменить состояние тикета

Параметры

Имя	Тип	Обязательно
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);

Создать тикет

Параметры

Name	Type	Required
tenantId	string	Да
userId	string	Да
createTicketBody	CreateTicketBody	Да

Ответ

Возвращает: CreateTicket200Response

Пример

Пример createTicket

Copy

const tenantId: string = 'acme-company-001';
const userId: string = 'u_78f4b2';
const createTicketBody: CreateTicketBody = {
  title: 'Unable to access project dashboard',
  description: 'Receiving 403 when accessing /dashboard for project X',
  priority: 'high',
  tags: ['dashboard', 'access'] // демонстрация необязательного поля
};
const result: 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");

Получить переводы

Параметры

Имя	Тип	Обязательно
namespace	string	Да
component	string	Да
locale	string	Нет
useFullTranslationIds	boolean	Нет

Ответ

Возвращает: GetTranslationsResponse

Пример

Пример getTranslations

Copy

const translationsDefault: GetTranslationsResponse = await getTranslations("payments", "checkout");
const translationsFrenchDetailed: GetTranslationsResponse = await getTranslations("payments", "checkout", "fr-FR", true);

Загрузить изображение

Загрузить и изменить размер изображения

Параметры

Name	Type	Required
tenantId	string	Да
file	Blob	Да
sizePreset	SizePreset	Нет
urlId	string	Нет

Ответ

Возвращает: UploadImageResponse

Получить прогресс значка пользователя по ID

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Yes
id	string	Yes

Ответ

Возвращает: 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);

Получить прогресс значка по ID пользователя

Параметры

Имя	Тип	Обязательно	Описание
tenantId	string	Да
userId	string	Да

Ответ

Возвращает: 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);
})();

Получить счётчик уведомлений пользователя

Параметры

Name	Type	Required	Description
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);

Обновить статус подписки пользователя на страницы

Включает или отключает уведомления для страницы. Когда пользователи подписаны на страницу, уведомления создаются для новых корневых комментариев, а также

Параметры

Имя	Тип	Обязательный
tenantId	string	Yes
urlId	string	Yes
url	string	Yes
pageTitle	string	Yes
subscribedOrUnsubscribed	UpdateUserNotificationPageSubscriptionStatusSubscribedOrUnsubscribedEnum	Yes
sso	string	No

Ответ

Возвращает: 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);

Получить статусы присутствия пользователей

Параметры

Имя	Тип	Обязательно
tenantId	string	Да
urlIdWS	string	Да
userIds	string	Да

Ответ

Возвращает: 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);

Получить пользователя

Параметры

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

Ответ

Возвращает: GetUser200Response

Пример

Пример использования getUser

Copy

const idSuffix: string | undefined = undefined;
const tenantId: string = "acme-enterprises";
const id: string = idSuffix ?? "user_98765";
const response: GetUser200Response = await getUser({ tenantId, id });

Создать голос

Параметры

Имя	Тип	Обязательно
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);

Удалить голос

Параметры

Имя	Тип	Обязательно
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);

Получить голоса

Параметры

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

Ответ

Возвращает: GetVotes200Response

Пример

Пример использования getVotes

Copy

const tenantId: string = 'tenant-42c-eu';
const urlId: string = 'article-7f9b';
const includeMetadata: boolean | undefined = true;
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

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

Использование

Агрегация

Журналы аудита

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

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

Комментарии

Комментарии пользователя

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

Шаблоны email

Журнал событий

Записи ленты

Пожаловаться на комментарий

Гифки

Хэштеги

Модераторы

Счётчик уведомлений

Уведомления

Страницы

Ожидающие события вебхуков

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

Результаты вопросов

Агрегация результатов вопросов

Пользователи SSO

Подписки

Ежедневное использование тенанта

Пакеты тенанта

Пользователи тенанта

Тенанты

Тикеты

Переводы

Загрузка изображения

Прогресс значка пользователя

Значки пользователя

Уведомления пользователя

Статусы присутствия пользователя

Поиск пользователей

Пользователи

Голоса

FastComments SDK для JavaScript/TypeScript

Репозиторий

Установка

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

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

Совместимость браузера и сервера

Использование

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

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

Импорт только типов

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

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

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

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

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

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

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

Simple SSO (Server-Side Only)

Secure SSO (Server-Side, Recommended)

Using SSO from Browser (with Server-Generated Token)

SSO with Comment Creation

Распространённые сценарии использования

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

Создание комментария

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

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

Live события (обновления в реальном времени)

События на уровне страницы

Подписка на пользовательские события

Получение userIdWS

Идентификаторы трансляций

Обработка ошибок

Агрегировать

Параметры

Ответ

Получить журналы аудита

Параметры

Ответ