
Мова 🇺🇦 Українська
Початок роботи
Документація
Довідник API
Агрегація
Журнали аудиту
Блокування з коментаря
Перевірка заблокованих коментарів
Коментарі
Конфігурації домену
Шаблони електронних листів
Журнал подій
Пости стрічки
Позначити коментар
Хештеги
Модератори
Кількість сповіщень
Сповіщення
Сторінки
Очікувані події вебхука
Налаштування питань
Результати питань
Агрегація результатів питань
Користувачі SSO
Підписки
Щоденне використання орендаря
Пакети орендаря
Користувачі орендаря
Орендарі
Завантажити зображення
Прогрес значків користувача
Значки користувача
Сповіщення користувача
Статуси присутності користувача
Пошук користувачів
Користувачі
Голоси
FastComments Swift SDK
Це офіційний Swift SDK для FastComments.
Офіційний Swift SDK для API FastComments
Репозиторій
Встановлення 
Swift Package Manager
Додайте наступне до вашого файлу Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "0.0.1")
]
Або в Xcode:
- File > Add Packages...
- Enter the repository URL:
https://github.com/fastcomments/fastcomments-swift.git - Select the version you want to use
Вимоги
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Вміст бібліотеки 
The FastComments Swift SDK складається з кількох модулів:
Client Module - Автоматично згенерований клієнт API для REST API FastComments
- Повні визначення типів для всіх моделей API
- Як автентифіковані (
DefaultAPI), так і публічні (PublicAPI) кінцеві точки - Повна підтримка async/await
- Див. client/README.md для детальної документації API
SSO Module - Утиліти серверної реалізації Single Sign-On
- Безпечна генерація токенів для автентифікації користувачів
- Підтримка як простих, так і захищених режимів SSO
- Підписування токенів на основі HMAC-SHA256 із використанням CryptoKit
Швидкий старт 
Використання публічного API
import FastCommentsSwift
// Створити клієнта API
let publicApi = PublicAPI()
// Отримати коментарі для сторінки
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-ключем
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"
// Отримати коментарі з автентифікованого API
do {
let response = try await defaultApi.getComments(
tenantId: "your-tenant-id",
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)")
}
Використання 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 
The FastComments SDK надає два типи кінцевих точок API:
PublicAPI - Кінцеві точки, безпечні для клієнтського коду
The PublicAPI contains endpoints that are safe to call from client-side code (iOS/macOS apps). These endpoints:
- Не вимагають API-ключа
- Можуть використовувати SSO-токени для автентифікації
- Мають ліміти швидкості запитів на кожного користувача/пристрій
- Підходять для застосунків, орієнтованих на кінцевих користувачів
Приклад використання: Отримання та створення коментарів у вашому iOS-додатку
DefaultAPI - Кінцеві точки для серверної частини
The DefaultAPI contains authenticated endpoints that require an API key. These endpoints:
- Потребують вашого FastComments API-ключа
- Мають викликатися ТІЛЬКИ з серверного коду
- Надають повний доступ до ваших даних FastComments
- Мають обмеження швидкості запитів на рівні орендаря
Приклад використання: адміністративні операції, масовий експорт даних, інструменти модерування
ВАЖЛИВО: Ніколи не розголошуйте ваш API-ключ у клієнтському коді. API-ключі повинні використовуватися лише на стороні сервера.
Виклик API 
Swift SDK використовує сучасний синтаксис async/await для всіх викликів API:
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Поширені проблеми 
401 Помилки неавторизованого доступу
Якщо ви отримуєте помилки 401 при використанні автентифікованого API:
- Check your API key: Переконайтеся, що ви використовуєте правильний API key з вашої панелі керування FastComments
- Verify the tenant ID: Переконайтеся, що tenant ID відповідає вашому обліковому запису
- API key format: API key має бути встановлений на API client:
let defaultApi = DefaultAPI()
defaultApi.apiKey = "YOUR_API_KEY"
- Using the wrong API: Переконайтеся, що ви використовуєте
DefaultAPI(неPublicAPI) для автентифікованих викликів
Проблеми з SSO токенами
Якщо SSO токени не працюють:
- Use secure mode for production: Завжди використовуйте
FastCommentsSSO.createSecure()з вашим API key для продакшену - Server-side only: Генеруйте захищені SSO токени на вашому сервері, ніколи не розголошуйте ваш API key клієнтам
- Check user data: Переконайтесь, що всі необхідні поля (id, email, username) надані
- Token expiration: Secure SSO токени містять мітку часу і можуть закінчуватися. Генеруйте нові токени за потреби.
Помилки SSL/TLS
Якщо ви стикаєтеся з помилками SSL/TLS:
- Переконайтеся, що Info.plist вашого додатка дозволяє HTTPS-підключення до fastcomments.com
- Переконайтеся, що ви не використовуєте винятки App Transport Security, які можуть блокувати підключення
Примітки 
Ідентифікатори Broadcast
Ви побачите, що у деяких викликах API потрібно передавати broadcastId. Коли ви отримуватимете події, ви отримаєте цей ID назад, тож знатимете, що слід ігнорувати подію, якщо плануєте оптимістично застосовувати зміни на клієнті (що, ймовірно, ви захочете зробити, оскільки це забезпечує найкращий досвід). Передайте тут UUID. ID має бути достатньо унікальним, щоб не повторюватися двічі в одній сесії.
let broadcastId = UUID().uuidString
aggregate 
Агрегує документи, групуючи їх (якщо задано groupBy) та застосовуючи кілька операцій. Підтримуються різні операції (наприклад sum, countDistinct, avg тощо).
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| parentTenantId | string | query | Ні | |
| includeStats | boolean | query | Ні |
Відповідь
Повертає: AggregationResponse
Приклад

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

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

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

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

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

createCommentPublic 
Параметри
| Назва | Тип | Місцезнаходження | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: CreateCommentPublic200Response
Приклад

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

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

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

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

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

getComments 
Параметри
| Назва | Тип | Location | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| page | integer | query | Ні | |
| limit | integer | query | Ні | |
| skip | integer | query | Ні | |
| asTree | boolean | query | Ні | |
| skipChildren | integer | query | Ні | |
| limitChildren | integer | query | Ні | |
| maxTreeDepth | integer | query | Ні | |
| urlId | string | query | Ні | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні | |
| contextUserId | string | query | Ні | |
| hashTag | string | query | Ні | |
| parentId | string | query | Ні | |
| direction | string | query | Ні |
Відповідь
Повертає: GetComments200Response
Приклад

getCommentsPublic 
req tenantId urlId
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| page | integer | query | Ні | |
| direction | string | query | Ні | |
| sso | string | query | Ні | |
| skip | integer | query | Ні | |
| skipChildren | integer | query | Ні | |
| limit | integer | query | Ні | |
| limitChildren | integer | query | Ні | |
| countChildren | boolean | query | Ні | |
| fetchPageForCommentId | string | query | Ні | |
| includeConfig | boolean | query | Ні | |
| countAll | boolean | query | Ні | |
| includei10n | boolean | query | Ні | |
| locale | string | query | Ні | |
| modules | string | query | Ні | |
| isCrawler | boolean | query | Ні | |
| includeNotificationCount | boolean | query | Ні | |
| asTree | boolean | query | Ні | |
| maxTreeDepth | integer | query | Ні | |
| useFullTranslationIds | boolean | query | Ні | |
| parentId | string | query | Ні | |
| searchText | string | query | Ні | |
| hashTags | array | query | Ні | |
| userId | string | query | Ні | |
| customConfigStr | string | query | Ні | |
| afterCommentId | string | query | Ні | |
| beforeCommentId | string | query | Ні |
Відповідь
Повертає: GetCommentsPublic200Response
Приклад

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

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

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

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

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

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

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

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

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

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

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

updateComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| contextUserId | string | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| isLive | boolean | query | Ні |
Відповідь
Повертає: FlagCommentPublic200Response
Приклад

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

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

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

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

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

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

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

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

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

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

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

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

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

getEmailTemplates 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Response
Повертає: GetEmailTemplates200Response
Приклад

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

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

getEventLog 
req tenantId urlId userIdWS
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Так |
Відповідь
Повертає: GetEventLog200Response
Приклад

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

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

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

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

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

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 | Ні |
Відповідь
Повертає: GetFeedPostsPublic200Response
Приклад

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getNotifications 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| urlId | string | query | Ні | |
| fromCommentId | string | query | Ні | |
| viewed | boolean | query | Ні | |
| type | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetNotifications200Response
Приклад

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

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

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

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

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

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

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

getPendingWebhookEventCount 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні |
Відповідь
Повертає: GetPendingWebhookEventCount200Response
Приклад

getPendingWebhookEvents 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetPendingWebhookEvents200Response
Приклад

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

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

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

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

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

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

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

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

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

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

aggregateQuestionResults 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| questionId | string | query | Ні | |
| questionIds | array | query | Ні | |
| urlId | string | query | Ні | |
| timeBucket | string | query | Ні | |
| startDate | string | query | Ні | |
| forceRecalculate | boolean | query | Ні |
Відповідь
Повертає: AggregateQuestionResults200Response
Приклад

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

combineCommentsWithQuestionResults 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| questionId | string | query | Ні | |
| questionIds | array | query | Ні | |
| urlId | string | query | Ні | |
| startDate | string | query | Ні | |
| forceRecalculate | boolean | query | Ні | |
| minValue | number | query | Ні | |
| maxValue | number | query | Ні | |
| limit | number | query | Ні |
Відповідь
Повертає: CombineCommentsWithQuestionResults200Response
Приклад

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

deleteSSOUser 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| deleteComments | boolean | query | Ні | |
| commentDeleteMode | string | query | Ні |
Відповідь
Повертає: 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 | Ні |
Відповідь
Повертає: GetSSOUsers200Response
Приклад

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
Приклад

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

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

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

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

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

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

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

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

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

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

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

replaceTenantUser 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | string | query | Ні |
Response
Повертає: FlagCommentPublic200Response
Example

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

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

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

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

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

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

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

uploadImage 
Завантажити та змінити розмір зображення
Parameters
| Назва | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| sizePreset | string | query | Ні | Пресет розміру: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв) |
| urlId | string | query | Ні | Ідентифікатор сторінки, звідки відбувається завантаження, для конфігурації |
Response
Повертає: UploadImageResponse
Приклад

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

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

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

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

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

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

getUserBadges 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| badgeId | string | query | Ні | |
| type | number | query | Ні | |
| displayedOnComments | boolean | query | Ні | |
| limit | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetUserBadges200Response
Приклад

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

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

getUserNotifications 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | 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 | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserNotifications200Response
Приклад

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

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

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

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

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

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

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

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

createVote 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Так | |
| direction | string | query | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: VoteComment200Response
Приклад

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

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

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

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