
Язык 🇷🇺 Русский
Начало работы
Документация
Справочник API
Агрегация
Журналы аудита
Аутентификация
Блокировка по комментарию
Проверка заблокированных комментариев
Комментарии
Комментарии пользователя
Конфигурации домена
Шаблоны электронной почты
Журнал событий
Посты ленты
Жалоба на комментарий
GIF
Хэштеги
Модерация
Модераторы
Количество уведомлений
Уведомления
Реакции на странице
Страницы
Ожидающие события вебхука
Настройки вопросов
Результаты вопросов
Агрегация результатов вопросов
SSO-пользователи
Подписки
Ежедневная статистика использования арендатора
Пакеты арендатора
Пользователи арендатора
Арендаторы
Тикеты
Переводы
Загрузка изображения
Прогресс значков пользователя
Значки пользователя
Уведомления пользователя
Статусы присутствия пользователя
Поиск пользователей
Пользователи
Голоса
FastComments SDK для Swift
Это официальный Swift SDK для FastComments.
Официальный Swift SDK для API FastComments
Репозиторий
Установка 
Swift Package Manager
Add the following to your Package.swift file:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.0.0")
]
Or in Xcode:
- File > Add Packages...
- Enter the repository URL:
https://github.com/fastcomments/fastcomments-swift.git - Select the version you want to use
Requirements
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Содержимое библиотеки 
The FastComments Swift SDK состоит из нескольких модулей:
-
Client Module - Клиент API для FastComments REST APIs
- Полные определения типов для всех моделей API
- Аутентифицированные (
DefaultAPI), публичные (PublicAPI), и модерационные (ModerationAPI) методы - Полная поддержка async/await
- See client/README.md for detailed API documentation
-
SSO Module - Утилиты серверной реализации Single Sign-On
- Безопасная генерация токенов для аутентификации пользователей
- Поддержка как простого, так и защищённого режимов SSO
- Подпись токенов на основе HMAC-SHA256 с использованием CryptoKit
Быстрый старт 
Использование публичного 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 
FastComments SDK предоставляет три клиента API:
PublicAPI - Client-Safe Methods
PublicAPI содержит методы, безопасные для вызова из клиентского кода (iOS/macOS‑приложения). Эти методы:
- Не требуют API‑ключа
- Может использовать токены SSO для аутентификации
- Ограничены по скорости для каждого пользователя/устройства
- Подходят для приложений, ориентированных на конечных пользователей
Example use case: Fetching and creating comments in your iOS app
DefaultAPI - Server-Side Methods
DefaultAPI содержит аутентифицированные методы, которые требуют API‑ключ. Эти методы:
- Требует ваш FastComments API‑ключ
- Должен вызываться ТОЛЬКО из серверного кода
- Обеспечивает полный доступ к вашим данным FastComments
- Ограничены по скорости для каждого арендатора
Example use case: Administrative operations, bulk data export, user management
ModerationAPI - Moderator Dashboard Methods
ModerationAPI предоставляет обширный набор живых и быстрых API модерации. Каждый метод ModerationAPI принимает параметр sso и может аутентифицироваться через SSO или cookie‑сессию FastComments.com.
Example use case: Building a moderation experience for moderators of your community
IMPORTANT: Never expose your API key in client-side code. API keys should only be used server-side.
Выполнение вызовов API 
Swift SDK использует современный синтаксис async/await для всех вызовов API:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Типичные проблемы 
401 Ошибки Unauthorized
Если вы получаете ошибки 401 при использовании аутентифицированного API:
- Проверьте ваш API-ключ: Убедитесь, что используете правильный API-ключ из панели управления FastComments
- Проверьте идентификатор арендатора: Убедитесь, что идентификатор арендатора соответствует вашему аккаунту
- Формат 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, которые могут блокировать соединение
Примечания 
Идентификаторы трансляций
Вы увидите, что в некоторых вызовах API нужно передавать broadcastId. Когда вы получаете события, вы получите этот идентификатор обратно, поэтому вы сможете игнорировать событие, если планируете оптимистично применить изменения на клиенте (что, вероятно, стоит сделать, поскольку это обеспечивает наилучший опыт). Передайте здесь UUID. Идентификатор должен быть достаточно уникальным, чтобы не повториться дважды в одной сессии.
let broadcastId = UUID().uuidString
Агрегировать 
Собирает документы, группируя их (если указано groupBy), и применяя несколько операций.
Поддерживаются различные операции (например, sum, countDistinct, avg и т.д.).
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Ответ
Returns: AggregateResponse
Пример

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

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

Заблокировать из комментария (публично) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: BlockSuccess
Пример

Разблокировать комментарий (публично) 
Параметры
| Имя | Type | Location | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: UnblockSuccess
Пример

Проверить комментарии на блокировки 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentIds | string | query | Да | Список идентификаторов комментариев, разделённых запятыми. |
| sso | string | query | Нет |
Ответ
Возвращает: CheckBlockedCommentsResponse
Пример

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

Создать комментарий (публично) 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: SaveCommentsResponseWithPresence
Пример

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

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

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

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

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

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

Получить комментарии (публично) 
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 | Нет |
Ответ
Возвращает: GetCommentsResponseWithPresencePublicComment
Пример

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

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

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

Закрепить комментарий 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Ответ
Возвращает: ChangeCommentPinStatusResponse
Пример

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

Массовое сохранение комментариев 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| isLive | boolean | query | Нет | |
| doSpamCheck | boolean | query | Нет | |
| sendEmails | boolean | query | Нет | |
| populateNotifications | boolean | query | Нет |
Ответ
Возвращает: [SaveCommentsBulkResponse]
Пример

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

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

Снять жалобу с комментария 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Ответ
Возвращает: FlagCommentResponse
Пример

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

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

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

Проголосовать за комментарий 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| 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
Пример

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

Добавить конфигурацию домена 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: AddDomainConfigResponse
Пример

Удалить конфигурацию домена 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Ответ
Возвращает: DeleteDomainConfigResponse
Пример

Получить конфигурацию домена 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Ответ
Возвращает: GetDomainConfigResponse
Пример

Получить конфигурации доменов 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: GetDomainConfigsResponse
Пример

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

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

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

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

Удалить ошибку рендеринга шаблона письма 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| errorId | string | path | Да |
Ответ
Возвращает: APIEmptyResponse
Пример

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

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

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

Получить шаблоны писем 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetEmailTemplatesResponse
Пример

Рендерить шаблон письма 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| locale | string | query | Нет |
Ответ
Возвращает: RenderEmailTemplateResponse
Пример

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

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

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

Создать пост в ленте 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| broadcastId | string | query | Нет | |
| isLive | boolean | query | Нет | |
| doSpamCheck | boolean | query | Нет | |
| skipDupCheck | boolean | query | Нет |
Ответ
Возвращает: CreateFeedPostResponse
Пример

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

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

Получить посты ленты 
req tenantId afterId
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Ответ
Возвращает: GetFeedPostsResponse
Пример

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

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

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

Поставить реакцию на пост (публично) 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: ReactFeedPostResponse
Пример

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

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

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

Получить большой GIF 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| largeInternalURLSanitized | string | query | Да |
Ответ
Возвращает: GifGetLargeResponse
Пример

Поиск GIF 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| search | string | query | Да | |
| locale | string | query | Нет | |
| rating | string | query | Нет | |
| page | number | query | Нет |
Ответ
Возвращает: GetGifsSearchResponse
Пример

Трендовые GIF 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| locale | string | query | Нет | |
| rating | string | query | Нет | |
| page | number | query | Нет |
Ответ
Возвращает: GetGifsTrendingResponse
Пример

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

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

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

Получить хэштеги 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| page | number | query | Нет |
Ответ
Возвращает: GetHashTagsResponse
Пример

Изменить хэштег 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Response
Returns: UpdateHashTagResponse
Example

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

Получить комментарии API 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Ответ
Возвращает: ModerationAPIGetCommentsResponse
Пример

Получить статус экспорта API 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Response
Returns: ModerationExportStatusResponse
Example

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

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

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

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

Получить количество 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| 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
Пример

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

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

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

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

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

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

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

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

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

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

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

Поиск пользователей (для модерации) 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Returns: ModerationUserSearchResponse
Пример

Получить коэффициент доверия 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Response
Returns: GetUserTrustFactorResponse
Example

Получить предпочтения бана пользователя 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Ответ
Возвращает: APIModerateGetUserBanPreferencesResponse
Пример

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

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

Запустить экспорт API 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| 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
Пример

Забанить пользователя от комментирования 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| 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
Пример

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

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

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

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

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

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

Установить статус проверки комментария 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| reviewed | boolean | query | Нет | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: APIEmptyResponse
Пример

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

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

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

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

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

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

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

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

Установить коэффициент доверия 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Нет | |
| trustFactor | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: SetUserTrustFactorResponse
Пример

Создать модератора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateModeratorResponse
Пример

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

Получить модератора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetModeratorResponse
Пример

Получить модераторов 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Ответ
Возвращает: GetModeratorsResponse
Пример

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

Обновить модератора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: APIEmptyResponse
Пример

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

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

Получить счётчик уведомлений 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Ответ
Возвращает: GetNotificationCountResponse
Пример

Получить уведомления 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Нет | |
| urlId | string | query | Нет | |
| fromCommentId | string | query | Нет | |
| viewed | boolean | query | Нет | |
| type | string | query | Нет | |
| skip | number | query | Нет |
Ответ
Возвращает: GetNotificationsResponse
Пример

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

Создать реакцию на странице (v1) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| title | string | query | Нет |
Ответ
Возвращает: CreateV1PageReact
Пример

Создать реакцию на странице (v2) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No |
Ответ
Возвращает: CreateV1PageReact
Пример

Удалить реакцию на странице (v1) 
Параметры
| Имя | Тип | Location | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Ответ
Возвращает: CreateV1PageReact
Пример

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

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

Получить реакции страницы (v2) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Response
Возвращает: GetV2PageReacts
Пример

Получить пользователей реакций страницы (v2) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| id | string | query | Да |
Ответ
Возвращает: GetV2PageReactUsersResponse
Пример

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

Удалить страницу 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: DeletePageAPIResponse
Пример

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

Получить онлайн-пользователей 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
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
Возвращает: PageUsersOnlineResponse
Example

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

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

Получить страницы (публично) 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Необычный курсор пагинации, возвращённый как nextCursor из предыдущего запроса. Связан с тем же параметром sortBy. |
| limit | integer | query | No | 1..200, default 50 |
| q | string | query | No | Необязательный фильтр префикса названия без учёта регистра. |
| sortBy | string | query | No | Порядок сортировки. updatedAt (по умолчанию, от новых к старым), commentCount (со сначала страницы с наибольшим количеством комментариев), или title (по алфавиту). |
| hasComments | boolean | query | No | Если true, только возвращаются страницы, имеющие хотя бы один комментарий. |
Response
Returns: GetPublicPagesResponse
Example

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

Изменить страницу (patch) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: PatchPageAPIResponse
Пример

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

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

Получить ожидающие события вебхука 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | 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 | |
| skip | number | query | No |
Ответ
Возвращает: GetPendingWebhookEventsResponse
Пример

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

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

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

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

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

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

Удалить результат вопроса 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Response
Возвращает: APIEmptyResponse
Пример

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

Получить результаты вопросов 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Нет | |
| userId | string | query | Нет | |
| startDate | string | query | Нет | |
| questionId | string | query | Нет | |
| questionIds | string | query | Нет | |
| skip | number | query | Нет |
Ответ
Возвращает: GetQuestionResultsResponse
Пример

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

Агрегировать результаты вопросов 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Ответ
Возвращает: AggregateQuestionResultsResponse
Пример

Массовая агрегация результатов вопросов 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| forceRecalculate | boolean | query | Нет |
Ответ
Возвращает: BulkAggregateQuestionResultsResponse
Пример

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

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

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

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

Получить SSO-пользователя по id 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetSSOUserByIdAPIResponse
Пример

Получить SSO-пользователей 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | integer | query | Нет |
Response
Возвращает: GetSSOUsersResponse
Пример

Изменить SSO-пользователя (patch) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Ответ
Возвращает: PatchSSOUserAPIResponse
Пример

Заменить/создать SSO-пользователя (put) 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Нет |
Ответ
Возвращает: PutSSOUserAPIResponse
Пример

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

Удалить подписку 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет |
Ответ
Возвращает: DeleteSubscriptionAPIResponse
Пример

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

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

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

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

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

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

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

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

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

Создать пользователя арендатора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateTenantUserResponse
Пример

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

Получить пользователя арендатора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetTenantUserResponse
Пример

Получить пользователей арендатора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetTenantUsersResponse
Пример

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

Отправить ссылку для входа 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| redirectURL | string | query | Нет |
Ответ
Возвращает: APIEmptyResponse
Пример

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

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

Удалить арендатора 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sure | string | query | Нет |
Response
Возвращает: APIEmptyResponse
Example

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

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

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

Изменить состояние тикета 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: ChangeTicketStateResponse
Пример

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

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

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

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

Загрузить изображение 
Загрузка и изменение размера изображения
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Предустановки размеров: “Default” (1000x1000px) или “CrossPlatform” (создаёт размеры для популярных устройств) |
| urlId | string | query | No | Идентификатор страницы, с которой происходит загрузка, для настройки (опционально) |
Response
Возвращает: UploadImageResponse
Example

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

Получить прогресс бейджа пользователя по id пользователя 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | path | Да |
Ответ
Возвращает: APIGetUserBadgeProgressResponse
Пример

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

Создать бейдж пользователя 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: APICreateUserBadgeResponse
Пример

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

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

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

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

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

Получить уведомления пользователя 
Parameters
| Имя | Тип | Location | Обязательно | Описание |
|---|---|---|---|---|
| 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 | Нет |
Response
Возвращает: GetMyNotificationsResponse
Пример

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

Сбросить уведомления пользователя 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| 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
Пример

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

Обновить подписку пользователя на страницу 
Включает или отключает уведомления для страницы. Когда пользователи подписаны на страницу, уведомления создаются для новых корневых комментариев, а также
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| url | string | query | Да | |
| pageTitle | string | query | Да | |
| subscribedOrUnsubscribed | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: UpdateUserNotificationPageSubscriptionStatusResponse
Пример

Обновить статус уведомления пользователя 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| newStatus | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: UpdateUserNotificationStatusResponse
Пример

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

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

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

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

Удалить голос 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
Ответ
Возвращает: VoteDeleteResponse
Пример

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

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

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