
Мова 🇺🇦 Українська
Документація
Початок
Посилання на API
Поширені проблеми
Примітки
Орендарі агентів
Агрегат
Журнали аудиту
Аутентифікація
Пакетні завдання
Блокування з коментаря
Перевірка заблокованих коментарів
Коментарі
Коментарі для користувача
Конфігурації домену
Шаблони електронної пошти
Журнал подій
Пости у стрічці
Позначити коментар
GIF
Хештеги
Я
Модерація
Модератори
Кількість сповіщень
Сповіщення
Реакції на сторінці
Сторінки
Очікуючі події вебхука
Голосування в опитуваннях
Опитування
Конфігурації питань
Результати питань
Агрегація результатів питань
Користувачі SSO
Підписки
Щоденне використання орендаря
Пакети орендаря
Користувачі орендаря
Орендарі
Тікети
Переклади
Завантажити зображення
Прогрес значків користувача
Значки користувача
Сповіщення користувача
Статус присутності користувача
Пошук користувачів
Користувачі
Голоси
Вебхуки
FastComments Swift SDK
Це офіційний Swift SDK для FastComments.
Офіційний Swift SDK для API FastComments
Репозиторій
AI агенти кодування 
Надайте вашому агенту коду контекст FastComments, який йому потрібен - віджети, конфігурація, Secure SSO, REST API та SDK:
npx skills add fastcomments/skills
Працює з Claude Code, Codex, Cursor, Copilot, Gemini та будь‑яким іншим агентом, який підтримує skills CLI.
Installation 
Swift Package Manager
Додайте наступне до вашого файлу Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Або в Xcode:
- File > Add Packages...
- Введіть URL репозиторію:
https://github.com/fastcomments/fastcomments-swift.git - Виберіть потрібну версію
Вимоги
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Library Contents 
FastComments Swift SDK складається з кількох модулів:
-
Client Module - клієнт API для FastComments REST APIs
- Повні визначення типів для всіх моделей API
- Автентифіковані (
DefaultAPI), публічні (PublicAPI) та модераційні (ModerationAPI) методи - Повна підтримка async/await
- Див. client/README.md для детальної документації API
-
SSO Module - серверні утиліти Single Sign-On
- Безпечне генерування токенів для автентифікації користувачів
- Підтримка як простого, так і захищеного режимів SSO
- Підписування токенів на основі HMAC-SHA256 із використанням CryptoKit
Quick Start 
Використання публічного API
import FastCommentsSwift
// Отримати коментарі для сторінки
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Використання автентифікованого API
import FastCommentsSwift
// Налаштуйте ваш API-ключ у спільній конфігурації (надсилається у заголовку x-api-key)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Отримати коментарі, використовуючи автентифікований API
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Використання API модерації
import FastCommentsSwift
// Методи модерації авторизуються за допомогою токену `sso` для діючого модератора
// (згенеруйте його за допомогою FastCommentsSSO, дивіться розділ SSO вище).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Використання SSO для автентифікації
Безпечний SSO (рекомендовано для продакшн)
import FastCommentsSwift
let apiKey = "your-api-key"
// Створіть безпечні дані користувача SSO (лише на сервері!)
let userData = SecureSSOUserData(
id: "user-123", // ID користувача
email: "user@example.com", // Електронна пошта
username: "johndoe", // Ім'я користувача
avatar: "https://example.com/avatar.jpg" // URL аватара
)
// Створіть SSO токен
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Передайте цей токен вашому фронтенду для автентифікації
} catch {
print("Error creating SSO token: \(error)")
}
Простий SSO (для розробки/тестування)
import FastCommentsSwift
// Створіть прості дані користувача SSO (не потрібен API-ключ)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Створіть простий SSO токен
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API Clients 
SDK FastComments надає три API-клієнти:
PublicAPI - Методи, безпечні для клієнта
PublicAPI містить методи, які безпечно викликати з клієнтського коду (застосунків iOS/macOS). Ці методи:
- Не потребують API-ключа
- Можуть використовувати SSO-токени для автентифікації
- Мають обмеження частоти запитів на користувача/пристрій
- Підходять для застосунків, орієнтованих на кінцевих користувачів
Приклад використання: Отримання та створення коментарів у вашому застосунку iOS
DefaultAPI - Серверні методи
DefaultAPI містить автентифіковані методи, які потребують API-ключа. Ці методи:
- Потребують вашого API-ключа FastComments
- Повинні викликатися ЛИШЕ з серверного коду
- Надають повний доступ до ваших даних FastComments
- Мають обмеження частоти запитів на орендаря (tenant)
Приклад використання: Адміністративні операції, масове експортування даних, керування користувачами
ModerationAPI - Методи панелі модератора
ModerationAPI надає розширений набір API для швидкої модерізації в реальному часі. Кожен метод ModerationAPI приймає параметр sso і може автентифікуватися через SSO або сесійний cookie FastComments.com.
Приклад використання: Створення досвіду модерації для модераторів вашої спільноти
ВАЖЛИВО: Ніколи не викривайте свій API-ключ у клієнтському коді. API-ключі слід використовувати лише на сервері.
Making API Calls 
Swift SDK використовує сучасний синтаксис async/await для всіх викликів API:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Common Issues 
401 Неавторизовані помилки
Якщо ви отримуєте помилки 401 під час використання автентифікованого API:
- Перевірте ваш API‑ключ: Переконайтеся, що ви використовуєте правильний API‑ключ з вашої панелі FastComments
- Перевірте ідентифікатор орендаря: Переконайтеся, що ID орендаря відповідає вашому обліковому запису
- Формат API‑ключа: API‑ключ має бути встановлений як заголовок
x-api-keyу спільній конфігурації:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Використання неправильного API: Переконайтеся, що ви використовуєте
DefaultAPI(а неPublicAPI) для автентифікованих викликів
Проблеми з токеном SSO
Якщо токени SSO не працюють:
- Використовувати безпечний режим у продакшн: Завжди використовуйте
FastCommentsSSO.createSecure()з вашим API‑ключем у продакшн‑середовищі - Тільки на сервері: Генеруйте безпечні SSO‑токени на вашому сервері, ніколи не розкривайте ваш API‑ключ клієнтам
- Перевірте дані користувача: Переконайтеся, що всі необхідні поля (id, email, username) надані
- Термін дії токену: Безпечні SSO‑токени містять мітку часу і можуть закінчитися. Генеруйте нові токени за потреби.
Помилки SSL/TLS
Якщо ви стикаєтеся з помилками SSL/TLS:
- Переконайтеся, що ваш файл Info.plist у додатку дозволяє HTTPS‑з’єднання з fastcomments.com
- Перевірте, що ви не використовуєте виключення App Transport Security, які можуть блокувати з’єднання
Notes 
Ідентифікатори Broadcast
Ви побачите, що у деяких викликах API потрібно передавати broadcastId. Коли ви отримуватимете події, ви отримаєте цей ID назад, тож знатимете, що слід ігнорувати подію, якщо плануєте оптимістично застосовувати зміни на клієнті (що, ймовірно, ви захочете зробити, оскільки це забезпечує найкращий досвід). Передайте тут UUID. ID має бути достатньо унікальним, щоб не повторюватися двічі в одній сесії.
let broadcastId = UUID().uuidString
createAgentTenant 
Створює новий пробний обліковий запис для AI-агента без участі людини. Для виклику не потрібен API-ключ.
Відповідь містить ідентифікатор орендаря (tenant id), API-ключ, який одразу працює з REST API та MCP-сервером, а також URL для підтвердження (claim URL). Передайте цей URL людині, на яку ви працюєте: відкриття посилання під час входу в FastComments прив'язує обліковий запис до неї. Непідтверджені облікові записи та їхні ключі видаляються через 72 години після створення. До підтвердження обліковий запис має стандартні обмеження пробного періоду.
Відповідь
Повертає: CreateAgentTenantResponse
Приклад

aggregate 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| parentTenantId | string | query | Ні | |
| includeStats | boolean | query | Ні |
Відповідь
Повертає: AggregateResponse
Приклад

getAuditLogs 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | Орендар, для якого читаються журнали аудиту. |
| limit | integer | query | No | Кількість журналів, які повернути. Максимум 10000, за замовчуванням 1000. |
| skip | integer | query | No | Кількість журналів, які пропустити, для пагінації. |
| order | string | query | No | Напрямок сортування за часом події. За замовчуванням DESC (найновіші першими). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | Повернути лише події, виконані цим ім'ям користувача. |
| ip | string | query | No | Повернути лише події з цієї IP-адреси. |
| crudType | string | query | No | Повернути лише події цього типу: c, r, u, d або login. |
| resourceName | string | query | No | Повернути лише події для цього ресурсу, напр., User або Moderator. |
| targetId | string | query | No | Повернути лише події, у яких уражений об’єкт має цей ідентифікатор. |
| target | string | query | No | Пошук підрядка без урахування регістру в мітці ураженого об’єкта, напр., ім'я користувача або електронна пошта. |
| includeManagedTenants | boolean | query | No | Також повернути події від орендарів, якими керує цей орендар. |
Відповідь
Повертає: GetAuditLogsResponse
Приклад

logoutPublic 
Відповідь
Повертає: APIEmptyResponse
Приклад

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

getBatchJobs 
Пакетні завдання орендаря (імпорт, експорт, міграція сторінок...), новіші спочатку.
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| type | string | query | Ні | Лише завдання цього типу, наприклад migrate-pages. |
| status | string | query | Ні | Лише завдання у цьому статусі: requested, running, success або failed. |
| skip | integer | query | Ні | Скільки завдань пропустити, для пагінації. |
Відповідь
Returns: GetBatchJobsAPIResponse
Приклад

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

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

checkedCommentsForBlocked 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentIds | string | query | Так | Список ідентифікаторів коментарів, розділених комами. |
| sso | string | query | Ні |
Відповідь
Повертає: CheckBlockedCommentsResponse
Приклад

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

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

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

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

deleteCommentVote 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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
Приклад

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

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

getComments 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| 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
Приклад

getCommentsPublic 
req tenantId urlId
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| 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 | |
| questionId | string | query | No | |
| questionValue | integer | query | No |
Відповідь
Повертає: GetCommentsResponseWithPresencePublicComment
Приклад

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

getCommentVoteUserNames 
Параметри
| Name | Type | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| dir | integer | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetCommentVoteUserNamesSuccessResponse
Приклад

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

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

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

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

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

translateComments 
Перекладає вказані коментарі мовою віджета. Доступно лише тоді, коли відповідне правило налаштування віджета має Comment Translation зі значенням Automatic або Manual.
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| sso | string | query | Ні | |
| locale | string | query | Ні |
Відповідь
Повертає: CommentTranslationsResponse
Приклад

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

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

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

unPinComment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ChangeCommentPinStatusResponse
Приклад

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

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

getCommentsForUser 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| userId | string | query | Ні | |
| direction | string | query | Ні | |
| repliesToUserId | string | query | Ні | |
| page | number | query | Ні | |
| includei10n | boolean | query | Ні | |
| locale | string | query | Ні | |
| isCrawler | boolean | query | Ні |
Відповідь
Повертає: GetCommentsForUserResponse
Приклад

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

deleteDomainConfig 
Параметри
| Ім'я | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domain | string | path | Так |
Відповідь
Повертає: DeleteDomainConfigResponse
Приклад

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

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

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

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

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

deleteEmailTemplate 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

deleteEmailTemplateRenderError 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| errorId | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

getEmailTemplate 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetEmailTemplateResponse
Приклад

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

getEmailTemplateRenderErrors 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetEmailTemplateRenderErrorsResponse
Приклад

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

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

updateEmailTemplate 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

getEventLog 
запит tenantId urlId userIdWS
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Ні |
Відповідь
Повертає: GetEventLogResponse
Приклад

getGlobalEventLog 
обов'язкові tenantId urlId userIdWS
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Ні |
Відповідь
Повертає: GetEventLogResponse
Приклад

createFeedPost 
Parameters
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| broadcastId | string | query | Ні | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| skipDupCheck | boolean | query | Ні |
Response
Повертає: CreateFeedPostsResponse
Example

createFeedPostPublic 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: CreateFeedPostResponse
Приклад

deleteFeedPostPublic 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Повертає: DeleteFeedPostPublicResponse
Example

getFeedPosts 
запит tenantId afterId
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні |
Відповідь
Повертає: GetFeedPostsResponse
Приклад

getFeedPostsPublic 
req tenantId afterId
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні | |
| sso | string | query | Ні | |
| isCrawler | boolean | query | Ні | |
| includeUserInfo | boolean | query | Ні |
Відповідь
Повертає: PublicFeedPostsResponse
Приклад

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

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

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

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

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

flagCommentPublic 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| isFlagged | boolean | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

getGifsSearch 
Parameters
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Response
Повертає: GetGifsSearchResponse
Example

getGifsTrending 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Відповідь
Повертає: GetGifsTrendingResponse
Приклад

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

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

deleteHashTag 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

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

getMe 
Визначає використані облікові дані: орендар, до якого вони належать, і, для OAuth‑токенів, користувача, який їх авторизував.
Інтеграції використовують це для тестування з’єднання та його маркування.
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetMeResponse
Приклад

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

getApiComments 
Параметри
| Назва | Тип | Місце | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| page | number | query | Ні | |
| count | number | query | Ні | |
| text-search | string | query | Ні | |
| byIPFromComment | string | query | Ні | |
| filters | string | query | Ні | |
| searchFilters | string | query | Ні | |
| sorts | string | query | Ні | |
| demo | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationAPIGetCommentsResponse
Приклад

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

getApiIds 
Параметри
| Назва | Тип | Розташування | Обовʼязково | Опис |
|---|---|---|---|---|
| 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
Приклад

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

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

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

getCount 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Повертає: ModerationAPICountCommentsResponse
Приклад

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

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

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

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

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

getModerationCommentText 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: GetCommentTextResponse
Приклад

getPreBanSummary 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| 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
Приклад

getSearchCommentsSummary 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationCommentSearchResponse
Приклад

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

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

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

getSearchUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| sso | string | query | Ні |
Response
Повертає: ModerationUserSearchResponse
Приклад

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

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

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

postAdjustCommentVotes 
Parameters
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Response
Повертає: AdjustVotesResponse
Приклад

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

postBanUserFromComment 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: BanUserFromCommentResult
Приклад

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

createModerator 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateModeratorResponse
Приклад

deleteModerator 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| sendEmail | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

getModerator 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetModeratorResponse
Приклад

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

sendInvite 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| fromName | string | query | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

updateModerator 
Параметри
| Назва | Type | Location | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

getCachedNotificationCount 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Response
Повертає: GetCachedNotificationCountResponse
Приклад

getNotificationCount 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| 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
Приклад

getNotifications 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| 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
Приклад

updateNotification 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

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

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

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

getV1PageLikes 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| sso | string | query | Ні | |
| includeUserInfo | string | query | Ні | Якщо встановлено, повертає користувачів, які вподобали сторінку (аватари та імена користувачів). Приймається лише "public", що виключає приватні профілі. |
Відповідь
Повертає: GetV1PageLikes
Приклад

getV2PageReacts 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Коли встановлено, повертає користувачів для кожного react id (аватари та імена користувачів). Приймається лише "public", що виключає приватні профілі. |
Відповідь
Повертає: GetV2PageReacts
Приклад

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

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

deletePage 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: DeletePageAPIResponse
Приклад

getOfflineUsers 
Колишні коментатори на сторінці, які НЕ перебувають онлайн. Впорядковано за displayName.
Використовуйте це після вичерпання /users/online, щоб відобразити розділ “Members”.
Пагінація курсором за commenterName: сервер проходить частковий {tenantId, urlId, commenterName} індекс від afterName вперед за допомогою $gt, без витрат $skip.
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
Returns: PageUsersOfflineResponse
Example

getOnlineUsers 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Поточні онлайн‑переглядачі сторінки: люди, чия WebSocket‑сесія підписана на сторінку саме зараз.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Повертає anonCount + totalCount (підписники по всій кімнаті, включаючи анонімних переглядачів, яких ми не перераховуємо).
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
Returns: PageUsersOnlineResponse
Example

getPageByURLId 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так |
Response
Повертає: GetPageByURLIdAPIResponse
Приклад

getPageLikes 
Кількість лайків для сторінки, опціонально з користувачами, які її лайкнули.
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| includeUserInfo | string | query | Ні | "public" виключає користувачів з приватними профілями, "include-private" включає їх. |
Відповідь
Повертає: GetPageLikesAPIResponse
Приклад

getPageReacts 
Користувацькі лічильники реакцій для сторінки, опціонально з користувачами, які відреагували.
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| includeUserInfo | string | query | Ні | "public" виключає користувачів із приватними профілями, "include-private" включає їх. |
Відповідь
Повертає: GetPageReactsAPIResponse
Приклад

getPages 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetPagesAPIResponse
Приклад

getPagesPublic 
Перелічує сторінки для тенанта. Використовується десктопним клієнтом FChat для заповнення списку кімнат.
Потребує enableFChat = true у вирішеному кастомному конфізі для кожної сторінки.
Сторінки, що потребують SSO, фільтруються відповідно до групового доступу користувача, що робить запит.
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| cursor | string | query | Ні | Непрозорий курсор пагінації, повернутий як nextCursor з попереднього запиту. Прив'язаний до того ж sortBy. |
| limit | integer | query | Ні | 1..200, за замовчуванням 50 |
| q | string | query | Ні | Необов'язковий фільтр за префіксом назви без урахування регістру. |
| sortBy | string | query | Ні | Порядок сортування. updatedAt (за замовчуванням, спочатку новіші), commentCount (спочатку з найбільшою кількістю коментарів) або title (за алфавітом). |
| hasComments | boolean | query | Ні | Якщо true, повертати лише сторінки з принаймні одним коментарем. |
Відповідь
Повертає: GetPublicPagesResponse
Приклад

getUsersInfo 
Пакетна інформація про користувачів для орендаря. За заданими userIds повертає відображувану інформацію з User / SSOUser. Використовується віджетом коментарів для доповнення інформації про користувачів, які щойно з'явилися через подію присутності. Без контексту сторінки: приватність застосовується однаково (приватні профілі замасковані).
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds, розділені комами. |
Відповідь
Повертає: PageUsersInfoResponse
Приклад

migratePages 
Додає у чергу пакетну задачу, яка переміщує коментарі, сторінки та пов’язані записи з одного urlId або домену в інший.
"urlId" міграції відповідають лише точному urlId. "domain" міграції виконують пошук/заміну значення у кожному urlId та url.
Опитування GET /api/v1/batch-jobs/{batchJobId}: після завершення вона повертає результати по кожній міграції та undoId.
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: QueuePageMigrationJobAPIResponse
Приклад

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

undoPageMigrations 
Створює пакетне завдання, яке скасовує всі міграції одного завдання migrate-pages, починаючи з найновіших. Доступне протягом 90 днів. Записи, змінені після міграції, не змінюються, тому пізніше редагування ніколи не буде перезаписано. Опитуйте GET /api/v1/batch-jobs/{batchJobId}, щоб отримати кількість відновлених/пропущених записів.
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| undoId | string | path | Так |
Відповідь
Повертає: QueuePageMigrationJobAPIResponse
Приклад

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

getPendingWebhookEventCount 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Відповідь
Повертає: GetPendingWebhookEventCountResponse
Приклад

getPendingWebhookEvents 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| 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
Приклад

createPollVote 
Записати голос у опитуванні або перемістити існуючий голос до іншої опції. У виборця може бути не більше одного голосу на опитування, тому повторний виклик для того ж виборця переміщує його голос замість додавання нового.
Це дотримується налаштувань опитувань сайту: якщо голосування дозволено лише зареєстрованим користувачам, голос лише з anonUserId буде відхилено, а анонімні голоси обмежуються за кількістю запитів з одного IP на опитування.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreatePollVoteResponse
Example

deletePollVote 
Скасувати голос. Опція, на яку був відданий голос, повертає свій підрахунок.
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Response
Returns: DeletePollVoteResponse
Example

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

getPollVotes 
Окремі голоси за підсумками одного опитування, від найстаріших.
Опитування належить до коментаря, тому голоси завжди читаються по одному опитуванню за раз - commentId є обов'язковим. Це зберігає кожен запит на індексах, які колекція вже має.
Дотримується приватності опитування: голоси анонімного опитування не можна прочитати (poll-anonymous), ні тут, ні за id.
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Так | |
| voterId | string | query | Ні | |
| optionId | string | query | Ні | |
| skip | integer | query | Ні |
Відповідь
Повертає: GetPollVotesResponse
Приклад

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

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

getPollVoters 
Хто проголосував за яку опцію. Анонімні опитування ніколи не відповідають, опитування лише для адміністраторів відповідають лише адміністратору або модератору.
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| urlId | string | query | Ні | |
| page | integer | query | Ні | |
| search | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetPollVoterNamesSuccessResponse
Приклад

patchPoll 
Редагуйте опитування на місці, зберігаючи підрахунки: змініть питання, перейменуйте варіант, закрийте або відкрийте його, або змініть, хто може бачити голосуючих. Варіанти ідентифікуються за id — щоб додати, видалити або змінити їх порядок, використовуйте PUT повний список.
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так |
Відповідь
Returns: SavePollResponse
Приклад

putPoll 
Прикріпіть опитування до коментаря або встановіть повний стан опитування, яке вже існує.
Варіанти зіставляються за id: варіант, надісланий з id наявного варіанта, зберігає свої голоси (і отримує нову мітку та позицію), варіант без id додається, а наявні варіанти, відсутні у списку, видаляються разом із поданими за них голосами.
Якщо не залишити жодного наявного id варіанта в опитуванні, що має голоси, усі вони будуть видалені, тому потрібно replaceVotes=true.
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| replaceVotes | boolean | query | Ні |
Відповідь
Повертає: SavePollResponse
Приклад

votePoll 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: VotePollResponse
Приклад

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

deleteQuestionConfig 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

getQuestionConfigs 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetQuestionConfigsResponse
Приклад

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

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

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

getQuestionResult 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetQuestionResultResponse
Приклад

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

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

aggregateQuestionResults 
Параметри
| Name | Type | Location | Required | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Returns: AggregateQuestionResultsResponse
Приклад

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

combineCommentsWithQuestionResults 
Parameters
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | запит | Так | |
| questionId | string | запит | Ні | |
| questionIds | array | запит | Ні | |
| urlId | string | запит | Ні | |
| startDate | string | запит | Ні | |
| forceRecalculate | boolean | запит | Ні | |
| minValue | number | запит | Ні | |
| maxValue | number | запит | Ні | |
| limit | number | запит | Ні |
Response
Повертає: CombineQuestionResultsWithCommentsResponse
Example

addSSOUser 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: AddSSOUserAPIResponse
Приклад

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

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

getSSOUserById 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetSSOUserByIdAPIResponse
Приклад

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

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

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

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

deleteSubscription 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: DeleteSubscriptionAPIResponse
Приклад

getSubscriptions 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No |
Відповідь
Повертає: GetSubscriptionsAPIResponse
Приклад

updateSubscription 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Response
Повертає: UpdateSubscriptionAPIResponse
Приклад

getTenantDailyUsages 
Параметри
| 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
Приклад

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

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

getTenantPackage 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantPackageResponse
Приклад

getTenantPackages 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantPackagesResponse
Приклад

replaceTenantPackage 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

createTenantUser 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateTenantUserResponse
Приклад

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

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

getTenantUsers 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantUsersResponse
Приклад

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

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

updateTenantUser 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

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

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

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

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

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

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

createTicket 
Параметри
| Назва | Type | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Так |
Відповідь
Повертає: CreateTicketResponse
Приклад

getTicket 
Параметри
| Name | Type | Location | Обов'язково | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: GetTicketResponse
Приклад

getTickets 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| state | number | query | Ні | |
| skip | number | query | Ні | |
| limit | number | query | Ні |
Відповідь
Повертає: GetTicketsResponse
Приклад

getTranslations 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| namespace | string | path | Так | |
| component | string | path | Так | |
| locale | string | query | Ні | |
| useFullTranslationIds | boolean | query | Ні |
Відповідь
Повертає: GetTranslationsResponse
Приклад

uploadImage 
Upload and resize an image
Parameters
| Назва | Тип | Місце розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Попередньо заданий розмір: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв) |
| urlId | string | query | No | Ідентифікатор сторінки, з якої відбувається завантаження, для налаштування |
Response
Повертає: UploadImageResponse
Example

getUserBadgeProgressById 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIGetUserBadgeProgressResponse
Приклад

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

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

createUserBadge 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: APICreateUserBadgeResponse
Приклад

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

getUserBadge 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIGetUserBadgeResponse
Приклад

getUserBadges 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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
Приклад

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

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

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

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

resetUserNotifications 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ResetUserNotificationsResponse
Приклад

updateUserNotificationCommentSubscriptionStatus 
Увімкнути або вимкнути сповіщення для конкретного коментаря.
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: UpdateUserNotificationCommentSubscriptionStatusResponse
Приклад

updateUserNotificationPageSubscriptionStatus 
Увімкнути або вимкнути повідомлення для сторінки. Коли користувачі підписані на сторінку, створюються повідомлення для нових кореневих коментарів, а також
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| url | string | query | Так | |
| pageTitle | string | query | Так | |
| subscribedOrUnsubscribed | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationPageSubscriptionStatusResponse
Приклад

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

getUserPresenceStatuses 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
Відповідь
Повертає: GetUserPresenceStatusesResponse
Приклад

searchUsers 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| usernameStartsWith | string | query | Ні | |
| mentionGroupIds | array | query | Ні | |
| sso | string | query | Ні | |
| searchSection | string | query | Ні |
Відповідь
Повертає: SearchUsersResult
Приклад

getUser 
Параметри
| Назва | Тип | Location | Required | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetUserResponse
Приклад

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

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

getVotes 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так |
Response
Повертає: GetVotesResponse
Приклад

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

createWebhook 
Підписує URL на подію коментаря (REST hook subscribe). Підписка того самого URL на ту ж подію та домен знову повертає існуючу підписку. Доставки підписані HMAC, дивіться посібник з вебхук‑ів; застарілий заголовок token ніколи не надсилається в підписки API.
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateWebhookResponse
Приклад

deleteWebhook 
Відписки (REST hook unsubscribe). Тільки підписки, створені через цей API, можна видалити тут; вебхуки, керовані через панель, редагуються в панелі.
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

getWebhooks 
Перелічує вебхуки, налаштовані для орендаря: як рядки, керовані через панель керування, так і підписки через API.
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| event | string | query | Ні | |
| domain | string | query | Ні | |
| source | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetWebhooksResponse
Приклад

getWebhookSamplePayloads 
Недавні коментарі в точному вигляді, який використовують доставки вебхуків, для створення інтеграцій (наприклад, зразкові дані Zapier). Кожна подія доставляє один і той самий об’єкт коментаря, тому event має бути лише дійсним.
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| event | string | query | Ні | |
| limit | number | query | Ні |
Відповідь
Повертає: GetWebhookSamplePayloadsResponse
Приклад

Потрібна допомога?
Якщо ви зіткнулися з будь-якими проблемами або маєте запитання щодо Swift SDK, будь ласка:
Участь
Внески вітаються! Будь ласка, відвідайте репозиторій GitHub для отримання інструкцій щодо внесків.