
Язык 🇺🇦 Русский (Украина)
Документация
Агрегация
Журналы аудита
Аутентификация
Блокировка из комментария
Проверка заблокированных комментариев
Комментарии
Комментарии пользователя
Конфигурации домена
Шаблоны писем
Журнал событий
Записи ленты
Пометка комментария
GIF
Хештеги
Модерация
Модераторы
Количество уведомлений
Уведомления
Реакции на страницу
Страницы
Ожидающие события вебхука
Конфигурации вопросов
Результаты вопросов
Агрегация результатов вопросов
SSO пользователи
Подписки
Ежедневное использование арендатора
Пакеты арендатора
Пользователи арендатора
Арендаторы
Тикеты
Переводы
Загрузка изображений
Прогресс бейджей пользователя
Бейджи пользователя
Уведомления пользователя
Статус присутствия пользователя
Поиск пользователей
Пользователи
Голоса
FastComments Dart SDK
Это официальная библиотека Dart SDK для FastComments.
Управляйте комментариями, пользователями, SSO и модерацией из ваших приложений на Dart и Flutter.
Repository
Макет 
fastcomments-dart/
client/ сгенерированный dart‑клиент (не редактировать вручную)
sso/ ручные вспомогательные функции SSO‑токенов
openapi.json закоммиченная копия спецификации, используемой для генерации
config.json конфигурация openapi‑generator
update.py восстановить клиент из спецификации
Использование 
dependencies:
fastcomments_dart: ^3.0.0
Помощники SSO включены в пакет (package:fastcomments_dart/sso/...).
Клиент предоставляет три класса API:
DefaultApi— методы, аутентифицирующиеся по API‑ключу, предназначены для серверного использования.PublicApi— публичные методы, не требующие API‑ключа, безопасные для браузерных и мобильных клиентов.ModerationApi— обширный набор живых и быстрых API модерации. Каждый методModerationApiпринимает параметрssoи может аутентифицироваться через SSO или cookie‑сессию FastComments.com.
import 'package:fastcomments_dart/api.dart';
final api = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final comments = await api.getCommentsPublic('YOUR_TENANT_ID', 'YOUR_URL_ID');import 'package:fastcomments_dart/api.dart';
final publicApi = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final feedPosts = await publicApi.getFeedPostsPublic('YOUR_TENANT_ID');import 'package:fastcomments_dart/api.dart';
final moderation = ModerationApi(ApiClient(basePath: 'https://fastcomments.com'));
final result = await moderation.getApiComments(
GetApiCommentsOptions(sso: 'SSO_TOKEN'),
);
SSO 
import 'package:fastcomments_dart/sso/fastcomments_sso.dart';
import 'package:fastcomments_dart/sso/secure_sso_user_data.dart';
final sso = FastCommentsSSO.secure(
apiKey: 'YOUR_API_SECRET',
user: SecureSSOUserData(
id: 'user-123',
email: 'jane@example.com',
username: 'jane',
avatar: 'https://example.com/jane.png',
),
);
final token = sso.prepareToSend();
Агрегировать 
Агрегирует документы, группируя их (если указан параметр groupBy) и применяя несколько операций.
Поддерживаются различные операции (например, sum, countDistinct, avg и т.д.).
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| parentTenantId | string | query | Нет | |
| includeStats | boolean | query | Нет |
Ответ
Возвращает: AggregateResponse
Пример

Получить журналы аудита 
Параметри
| Назва | Тип | Розташування | Обовʼязковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Відповідь
Повертає: GetAuditLogsResponse
Приклад

Выйти публично 
Ответ
Возвращает: APIEmptyResponse
Пример

Блокировать из комментария публично 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: BlockSuccess
Приклад

Разблокировать комментарий публично 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Ответ
Возвращает: UnblockSuccess
Пример

Проверенные комментарии на блокировку 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentIds | string | query | Так | Список ідентифікаторів коментарів, розділених комами. |
| sso | string | query | Ні |
Відповідь
Повертає: CheckBlockedCommentsResponse
Приклад

Заблокировать пользователя из комментария 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет | |
| anonUserId | string | query | Нет |
Ответ
Возвращает: BlockSuccess
Пример

Создать комментарий публично 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: SaveCommentsResponseWithPresence
Приклад

Удалить комментарий 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Ответ
Возвращает: DeleteCommentResult
Пример

Удалить комментарий публично 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: PublicAPIDeleteCommentResponse
Пример

Удалить голос за комментарий 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: VoteDeleteResponse
Пример

Пометить комментарий 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Відповідь
Повертає: FlagCommentResponse
Приклад

Получить комментарий 
Параметри
| Назва | Тип | Розташування | Обовʼязково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIGetCommentResponse
Приклад

Получить комментарии 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Ответ
Возвращает: APIGetCommentsResponse
Пример

Получить публичные комментарии 
запрос
tenantId
urlId
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Ответ
Возвращает: GetCommentsResponseWithPresencePublicComment
Пример

Получить текст комментария 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: PublicAPIGetCommentTextResponse
Приклад

Получить имена пользователей, проголосовавших за комментарий 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| dir | integer | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: GetCommentVoteUserNamesSuccessResponse
Пример

Заблокировать комментарий 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Ответ
Returns: APIEmptyResponse
Пример

Прикрепить комментарий 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ChangeCommentPinStatusResponse
Приклад

Сохранить комментарий 
Parameters
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Response
Возвращает: APISaveCommentResponse
Example

Сохранить комментарии массово 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| sendEmails | boolean | query | Ні | |
| populateNotifications | boolean | query | Ні |
Відповідь
Повертає: SaveCommentsBulkResponse
Приклад

Установить текст комментария 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: PublicAPISetCommentTextResponse
Пример

Разблокировать пользователя из комментария 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: UnblockSuccess
Приклад

Снять пометку с комментария 
Параметри
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Відповідь
Повертає: FlagCommentResponse
Приклад

Разблокировать комментарий 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: APIEmptyResponse
Пример

Открепить комментарий 
Параметри
| Назва | Тип | Розташування | Обовʼязково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: ChangeCommentPinStatusResponse
Приклад

Обновить комментарий 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Ответ
Возвращает: APIEmptyResponse
Пример

Голосовать за комментарий 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| sessionId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: VoteResponse
Пример

Получить комментарии пользователя 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| userId | string | query | Нет | |
| direction | string | query | Нет | |
| repliesToUserId | string | query | Нет | |
| page | number | query | Нет | |
| includei10n | boolean | query | Нет | |
| locale | string | query | Нет | |
| isCrawler | boolean | query | Нет |
Ответ
Возвращает: GetCommentsForUserResponse
Пример

Добавить конфигурацию домена 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: AddDomainConfigResponse
Пример

Удалить конфигурацию домена 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Ответ
Возвращает: DeleteDomainConfigResponse
Пример

Получить конфигурацию домена 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Ответ
Возвращает: GetDomainConfigResponse
Пример

Получить конфигурации домена 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: GetDomainConfigsResponse
Пример

Обновить часть конфигурации домена 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Ответ
Возвращает: PatchDomainConfigResponse
Пример

Заменить конфигурацию домена 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Відповідь
Повертає: PutDomainConfigResponse
Приклад

Создать шаблон письма 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateEmailTemplateResponse
Приклад

Удалить шаблон письма 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Returns: APIEmptyResponse
Приклад

Удалить ошибку рендеринга шаблона письма 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Ответ
Возвращает: APIEmptyResponse
Пример

Получить шаблон письма 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: GetEmailTemplateResponse
Пример

Получить определения шаблонов писем 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: GetEmailTemplateDefinitionsResponse
Пример

Получить ошибки рендеринга шаблонов писем 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Відповідь
Повертає: GetEmailTemplateRenderErrorsResponse
Приклад

Получить шаблоны писем 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Ответ
Returns: GetEmailTemplatesResponse
Пример

Отрисовать шаблон письма 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| locale | string | query | Нет |
Ответ
Возвращает: RenderEmailTemplateResponse
Пример

Обновить шаблон письма 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Возвращает: APIEmptyResponse
Example

Получить журнал событий 
req tenantId urlId userIdWS
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Нет |
Ответ
Возвращает: GetEventLogResponse
Пример

Получить глобальный журнал событий 
req tenantId urlId userIdWS
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Ні |
Відповідь
Повертає: GetEventLogResponse
Приклад

Создать запись в ленте 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Відповідь
Повертає: CreateFeedPostsResponse
Приклад

Создать публичную запись в ленте 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: CreateFeedPostResponse
Пример

Удалить публичную запись в ленте 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: DeleteFeedPostPublicResponse
Приклад

Получить записи ленты 
req tenantId afterId
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Ответ
Возвращает: GetFeedPostsResponse
Пример

Получить публичные записи ленты 
req tenantId afterId
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| afterId | string | query | Нет | |
| limit | integer | query | Нет | |
| tags | array | query | Нет | |
| sso | string | query | Нет | |
| isCrawler | boolean | query | Нет | |
| includeUserInfo | boolean | query | Нет |
Ответ
Returns: PublicFeedPostsResponse
Пример

Получить статистику записей ленты 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: FeedPostsStatsResponse
Приклад

Получить реакции пользователей публично 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Відповідь
Повертає: UserReactsResponse
Приклад

Публично отреагировать на запись ленты 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ReactFeedPostResponse
Приклад

Обновить запись ленты 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: APIEmptyResponse
Пример

Обновить публичную запись ленты 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: CreateFeedPostResponse
Пример

Публично пометить комментарий 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

Получить большой GIF 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| largeInternalURLSanitized | string | query | Да |
Ответ
Возвращает: GifGetLargeResponse
Пример

Поиск GIF 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Відповідь
Повертає: GetGifsSearchResponse
Приклад

Трендовые GIF 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Ответ
Возвращает: GetGifsTrendingResponse
Пример

Добавить хештег 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Ответ
Возвращает: CreateHashTagResponse
Пример

Массово добавить хештеги 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Ответ
Возвращает: BulkCreateHashTagsResponse
Пример

Удалить хештег 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| tag | string | path | Да |
Ответ
Возвращает: APIEmptyResponse
Пример

Получить хештеги 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No |
Ответ
Returns: GetHashTagsResponse
Пример

Обновить часть хештега 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Ответ
Возвращает: UpdateHashTagResponse
Пример

Удалить модерационный голос 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: VoteDeleteResponse
Пример

Получить API комментарии 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationAPIGetCommentsResponse
Приклад

Получить статус экспорта API 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: ModerationExportStatusResponse
Пример

Получить API ID 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Ответ
Возвращает: ModerationAPIGetCommentIdsResponse
Пример

Получить забаненных пользователей из комментариев 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: GetBannedUsersFromCommentResponse
Приклад

Получить статус бана комментария 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Ответ
Возвращает: GetCommentBanStatusResponse
Пример

Получить дочерние комментарии 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: ModerationAPIChildCommentsResponse
Пример

Получить количество 
Параметри
| Ім'я | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Відповідь
Returns: ModerationAPICountCommentsResponse
Приклад

Получить количества 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: GetBannedUsersCountResponse
Пример

Получить логи 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Ответ
Returns: ModerationAPIGetLogsResponse
Пример

Получить вручную созданные бейджи 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: GetTenantManualBadgesResponse
Пример

Получить вручные бейджи пользователя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| badgesUserId | string | query | Ні | |
| commentId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserManualBadgesResponse
Приклад

Получить комментарий модерации 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| includeEmail | boolean | query | Ні | |
| includeIP | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationAPICommentResponse
Приклад

Получить текст комментария модерации 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: GetCommentTextResponse
Пример

Получить сводку предбанов 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Ответ
Возвращает: PreBanSummary
Пример

Получить сводку поиска комментариев 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Нет | |
| filters | string | query | Нет | |
| searchFilters | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: ModerationCommentSearchResponse
Пример

Получить страницы поиска 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: ModerationPageSearchResponse
Пример

Получить сайты поиска 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationSiteSearchResponse
Приклад

Получить предложения поиска 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| text-search | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationSuggestResponse
Приклад

Получить пользователей поиска 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: ModerationUserSearchResponse
Пример

Получить коэффициент доверия 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: GetUserTrustFactorResponse
Пример

Получить предпочтения бана пользователя 
Parameters
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Response
Повертає: APIModerateGetUserBanPreferencesResponse
Example

Получить внутренний профиль пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: GetUserInternalProfileResponse
Пример

Отправить корректировку голосов за комментарий 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: AdjustVotesResponse
Пример

Отправить экспорт API 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| text-search | string | query | Нет | |
| byIPFromComment | string | query | Нет | |
| filters | string | query | Нет | |
| searchFilters | string | query | Нет | |
| sorts | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: ModerationExportResponse
Пример

Отправить бан пользователя из комментария 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| banEmail | boolean | query | Нет | |
| banEmailDomain | boolean | query | Нет | |
| banIP | boolean | query | Нет | |
| deleteAllUsersComments | boolean | query | Нет | |
| bannedUntil | string | query | Нет | |
| isShadowBan | boolean | query | Нет | |
| updateId | string | query | Нет | |
| banReason | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: BanUserFromCommentResult
Пример

Отменить бан пользователя 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отправить массовую сводку предбанов 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: BulkPreBanSummary
Приклад

Отправить комментарии по ID 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Ответ
Возвращает: ModerationAPIChildCommentsResponse
Пример

Отправить пометку комментария 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: APIEmptyResponse
Пример

Отправить удаление комментария 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: PostRemoveCommentApiResponse
Пример

Отправить восстановление удаленного комментария 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: APIEmptyResponse
Пример

Отправить установку статуса одобрения комментария 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: SetCommentApprovedResponse
Приклад

Отправить установку статуса проверки комментария 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Returns: APIEmptyResponse
Пример

Отправить установку статуса спама комментария 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отправить установку текста комментария 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: SetCommentTextResponse
Приклад

Отправить снятие пометки с комментария 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Returns: APIEmptyResponse
Пример

Отправить голос 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: VoteResponse
Пример

Выдать бейдж 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| badgeId | string | query | Да | |
| userId | string | query | Нет | |
| commentId | string | query | Нет | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: AwardUserBadgeResponse
Пример

Закрыть ветку 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Ответ
Returns: APIEmptyResponse
Пример

Удалить бейдж 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| badgeId | string | query | Так | |
| userId | string | query | Ні | |
| commentId | string | query | Ні | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Ответ
Возвращает: RemoveUserBadgeResponse
Пример

Снова открыть ветку 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | рядок | запит | Так | |
| urlId | рядок | запит | Так | |
| sso | рядок | запит | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Установить коэффициент доверия 
Параметри
| Назва | Тип | Місце | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: SetUserTrustFactorResponse
Приклад

Создать модератора 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateModeratorResponse
Приклад

Удалить модератора 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sendEmail | string | query | No |
Ответ
Возвращает: APIEmptyResponse
Пример

Получить модератора 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: GetModeratorResponse
Пример

Получить модераторов 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetModeratorsResponse
Пример

Отправить приглашение 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| fromName | string | query | Да |
Ответ
Возвращает: APIEmptyResponse
Пример

Обновить модератора 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: APIEmptyResponse
Пример

Удалить счётчик уведомлений 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: APIEmptyResponse
Пример

Получить кешированный счётчик уведомлений 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: GetCachedNotificationCountResponse
Приклад

Получить количество уведомлений 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Відповідь
Повертає: GetNotificationCountResponse
Приклад

Получить уведомления 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Відповідь
Повертає: GetNotificationsResponse
Приклад

Обновить уведомление 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Ответ
Returns: APIEmptyResponse
Пример

Создать реакцию на страницу V1 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No |
Відповідь
Returns: CreateV1PageReact
Приклад

Создать реакцию на страницу V2 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| id | string | query | Так | |
| title | string | query | Ні |
Відповідь
Повертає: CreateV1PageReact
Приклад

Удалить реакцию на страницу V1 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Ответ
Returns: CreateV1PageReact
Пример

Удалить реакцию на страницу V2 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Відповідь
Повертає: CreateV1PageReact
Приклад

Получить лайки страницы V1 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Ответ
Returns: GetV1PageLikes
Пример

Получить реакции страницы V2 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Ответ
Возвращает: GetV2PageReacts
Пример

Получить пользователей реакций страницы V2 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Ответ
Возвращает: GetV2PageReactUsersResponse
Пример

Добавить страницу 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Ответ
Возвращает: AddPageAPIResponse
Пример

Удалить страницу 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: DeletePageAPIResponse
Пример

Получить офлайн пользователей 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Ідентифікатор URL сторінки (очищений на сервері). |
| afterName | string | query | No | Курсор: передати nextAfterName з попередньої відповіді. |
| afterUserId | string | query | No | Тій‑брейкер курсора: передати nextAfterUserId з попередньої відповіді. Потрібно, коли afterName встановлено, щоб уникнути втрати записів через однакові імена. |
Response
Повертає: PageUsersOfflineResponse
Example

Получить онлайн пользователей 
Текущие онлайн‑просмотрщики страницы: пользователи, чья WebSocket‑сессия подписана на страницу в данный момент.
Возвращает anonCount + totalCount (подписчики в комнате, включая анонимных зрителей, которые не перечисляются).
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | Идентификатор URL страницы (очищенный на стороне сервера). |
| afterName | string | query | Нет | Курсор: передайте nextAfterName из предыдущего ответа. |
| afterUserId | string | query | Нет | Разрешитель конфликтов курсора: передайте nextAfterUserId из предыдущего ответа. Требуется, когда установлен afterName, чтобы привязки по имени не пропускали записи. |
Ответ
Returns: PageUsersOnlineResponse
Пример

Получить страницу по URL ID 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: GetPageByURLIdAPIResponse
Приклад

Получить страницы 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: GetPagesAPIResponse
Пример

Получить публичные страницы 
Список страниц для арендатора. Используется настольным клиентом FChat для заполнения списка комнат.
Требуется, чтобы enableFChat был установлен в true в разрешённой пользовательской конфигурации для каждой страницы.
Страницы, требующие SSO, фильтруются по групповому доступу запрашивающего пользователя.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Непрозрачный курсор пагинации, возвращённый как nextCursor из предыдущего запроса. Связан с тем же sortBy. |
| limit | integer | query | No | 1..200, по умолчанию 50 |
| q | string | query | No | Необязательный фильтр префикса названия без учёта регистра. |
| sortBy | string | query | No | Порядок сортировки. updatedAt (по умолчанию, новые первые), commentCount (сначала страницы с наибольшим количеством комментариев) или title (по алфавиту). |
| hasComments | boolean | query | No | Если true, возвращать только страницы, содержащие хотя бы один комментарий. |
Response
Возвращает: GetPublicPagesResponse
Example

Получить информацию о пользователях 
Сводная информация о пользователях для арендатора. По заданным userIds возвращается отображаемая информация из User / SSOUser.
Используется виджетом комментариев для обогащения данных о пользователях, которые только что появились через событие присутствия.
Нет контекста страницы: конфиденциальность применяется единообразно (частные профили скрыты).
Parameters
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| ids | string | query | Да | Разделённые запятыми userIds. |
Response
Returns: PageUsersInfoResponse
Example

Обновить часть страницы 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: PatchPageAPIResponse
Пример

Удалить ожидающее событие вебхука 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Returns: APIEmptyResponse
Пример

Получить количество ожидающих событий вебхука 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні |
Відповідь
Повертає: GetPendingWebhookEventCountResponse
Приклад

Получить ожидающие события вебхука 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Нет | |
| externalId | string | query | Нет | |
| eventType | string | query | Нет | |
| type | string | query | Нет | |
| domain | string | query | Нет | |
| attemptCountGT | number | query | Нет | |
| skip | number | query | Нет |
Ответ
Возвращает: GetPendingWebhookEventsResponse
Пример

Создать конфигурацию вопроса 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateQuestionConfigResponse
Пример

Удалить конфигурацию вопроса 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Возвращает: APIEmptyResponse
Example

Получить конфигурацию вопроса 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetQuestionConfigResponse
Приклад

Получить конфигурации вопросов 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetQuestionConfigsResponse
Пример

Обновить конфигурацию вопроса 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

Создать результат вопроса 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Returns: CreateQuestionResultResponse
Пример

Удалить результат вопроса 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Получить результат вопроса 
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Response
Повертає: GetQuestionResultResponse
Приклад

Получить результаты вопросов 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Ні | |
| userId | string | query | Ні | |
| startDate | string | query | Ні | |
| questionId | string | query | Ні | |
| questionIds | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetQuestionResultsResponse
Приклад

Агрегировать результаты вопросов 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Відповідь
Повертає: AggregateQuestionResultsResponse
Приклад

Массовая агрегация результатов вопросов 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| forceRecalculate | boolean | query | No |
Ответ
Returns: BulkAggregateQuestionResultsResponse
Пример

Объединить комментарии с результатами вопросов 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Ответ
Возвращает: CombineQuestionResultsWithCommentsResponse
Пример

Добавить SSO пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Ответ
Возвращает: AddSSOUserAPIResponse
Пример

Удалить SSO пользователя 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Відповідь
Повертає: DeleteSSOUserAPIResponse
Приклад

Получить SSO пользователя по email 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
Відповідь
Returns: GetSSOUserByEmailAPIResponse
Приклад

Получить SSO пользователя по ID 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetSSOUserByIdAPIResponse
Пример

Получить SSO пользователей 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | integer | query | Ні |
Відповідь
Повертає: GetSSOUsersResponse
Приклад

Обновить часть SSO пользователя 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Відповідь
Повертає: PatchSSOUserAPIResponse
Приклад

Заменить SSO пользователя 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Відповідь
Повертає: PutSSOUserAPIResponse
Приклад

Создать подписку 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Returns: CreateSubscriptionAPIResponse
Приклад

Удалить подписку 
Параметры
| Имя | Тип | Location | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет |
Ответ
Возвращает: DeleteSubscriptionAPIResponse
Пример

Получить подписки 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Нет |
Ответ
Возвращает: GetSubscriptionsAPIResponse
Пример

Обновить подписку 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет |
Ответ
Возвращает: UpdateSubscriptionAPIResponse
Пример

Получить ежедневное использование арендатора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Ответ
Возвращает: GetTenantDailyUsagesResponse
Пример

Создать пакет арендатора 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateTenantPackageResponse
Приклад

Удалить пакет арендатора 
Параметри
| Ім'я | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Получить пакет арендатора 
Parameters
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantPackageResponse
Приклад

Получить пакеты арендатора 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Відповідь
Returns: GetTenantPackagesResponse
Приклад

Заменить пакет арендатора 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Повертає: APIEmptyResponse
Example

Обновить пакет арендатора 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: APIEmptyResponse
Пример

Создать пользователя арендатора 
Параметри
| Назва | Тип | Розташування | Обовʼязковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Returns: CreateTenantUserResponse
Приклад

Удалить пользователя арендатора 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| deleteComments | string | query | Ні | |
| commentDeleteMode | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Получить пользователя арендатора 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetTenantUserResponse
Пример

Получить пользователей арендатора 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Ответ
Возвращает: GetTenantUsersResponse
Пример

Заменить пользователя арендатора 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Ответ
Возвращает: APIEmptyResponse
Пример

Отправить ссылку для входа 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

Обновить пользователя арендатора 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

Создать арендатора 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateTenantResponse
Пример

Удалить арендатора 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sure | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

Получить арендатора 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantResponse
Приклад

Получить арендаторов 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Відповідь
Повертає: GetTenantsResponse
Приклад

Обновить арендатора 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: APIEmptyResponse
Пример

Изменить состояние тикета 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: ChangeTicketStateResponse
Приклад

Создать тикет 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes |
Ответ
Возвращает: CreateTicketResponse
Пример

Получить тикет 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Відповідь
Повертає: GetTicketResponse
Приклад

Получить тикеты 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Ответ
Возвращает: GetTicketsResponse
Пример

Получить переводы 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Ответ
Возвращает: GetTranslationsResponse
Пример

Загрузить изображение 
Завантажити та змінити розмір зображення
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Попереднє розмір: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв) |
| urlId | string | query | No | ID сторінки, з якої здійснюється завантаження, для налаштування |
Відповідь
Повертає: UploadImageResponse
Приклад

Получить прогресс бейджа пользователя по ID 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIGetUserBadgeProgressResponse
Приклад

Получить прогресс бейджа пользователя по ID пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | path | Да |
Ответ
Возвращает: APIGetUserBadgeProgressResponse
Пример

Получить список прогресса бейджей пользователя 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Ответ
Возвращает: APIGetUserBadgeProgressListResponse
Пример

Создать бейдж пользователя 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: APICreateUserBadgeResponse
Приклад

Удалить бейдж пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: APIEmptySuccessResponse
Пример

Получить бейдж пользователя 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Returns: APIGetUserBadgeResponse
Приклад

Получить бейджи пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Ответ
Возвращает: APIGetUserBadgesResponse
Пример

Обновить бейдж пользователя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptySuccessResponse
Приклад

Получить количество уведомлений пользователя 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserNotificationCountResponse
Приклад

Получить уведомления пользователя 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Використовується для визначення, чи підписана поточна сторінка. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: GetMyNotificationsResponse
Приклад

Сбросить количество уведомлений пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Ответ
Возвращает: ResetUserNotificationsResponse
Пример

Сбросить уведомления пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Нет | |
| afterCreatedAt | integer | query | Нет | |
| unreadOnly | boolean | query | Нет | |
| dmOnly | boolean | query | Нет | |
| noDm | boolean | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: ResetUserNotificationsResponse
Пример

Обновить статус подписки на комментарий в уведомлениях пользователя 
Enable or disable notifications for a specific comment.
Parameters
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| optedInOrOut | string | path | Да | |
| commentId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: UpdateUserNotificationCommentSubscriptionStatusResponse
Пример

Обновить статус подписки на страницу в уведомлениях пользователя 
Enable або disable сповіщення для сторінки. Коли користувачі підписані на сторінку, створюються сповіщення для нових кореневих коментарів, а також
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Response
Returns: UpdateUserNotificationPageSubscriptionResponse
Example

Обновить статус уведомления пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| newStatus | string | path | Yes | |
| sso | string | query | No |
Ответ
Возвращает: UpdateUserNotificationStatusResponse
Пример

Получить статусы присутствия пользователя 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlIdWS | string | query | Так | |
| userIds | string | query | Так |
Відповідь
Повертає: GetUserPresenceStatusesResponse
Приклад

Поиск пользователей 
Параметры
| Имя | Тип | Location | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| usernameStartsWith | string | query | Нет | |
| mentionGroupIds | array | query | Нет | |
| sso | string | query | Нет | |
| searchSection | string | query | Нет |
Ответ
Возвращает: SearchUsersResult
Пример

Получить пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: GetUserResponse
Пример

Создать голос 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Ответ
Returns: VoteResponse
Пример

Удалить голос 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
Ответ
Returns: VoteDeleteResponse
Пример

Получить голоса 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: GetVotesResponse
Приклад

Получить голоса пользователя 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: GetVotesForUserResponse
Приклад

Нужна помощь?
Если вы столкнулись с какими‑либо проблемами или у вас есть вопросы по Dart SDK, пожалуйста:
Вклад
Вклады приветствуются! Пожалуйста, посетите репозиторий GitHub для получения руководства по внесению вклада.