
Язык 🇷🇺 Русский
Документация
Начало работы
Справочник API
Арендаторы агентов
Агрегация
Журналы аудита
Авторизация
Пакетные задания
Блокировка из комментария
Проверка заблокированных комментариев
Комментарии
Комментарии для пользователя
Конфигурации домена
Шаблоны электронной почты
Журнал событий
Посты ленты
Пометить комментарий
GIF
Хэштеги
Профиль
Модерация
Модераторы
Счётчик уведомлений
Уведомления
Реакции на страницу
Страницы
Ожидающие события вебхука
Голосования в опросах
Опросы
Конфигурации вопросов
Результаты вопросов
Агрегация результатов вопросов
Пользователи SSO
Подписки
Ежедневное использование арендатора
Пакеты арендатора
Пользователи арендатора
Арендаторы
Тикеты
Переводы
Загрузка изображения
Прогресс значков пользователя
Значки пользователя
Уведомления пользователя
Статус присутствия пользователя
Поиск пользователей
Пользователи
Голоса
Вебхуки
FastComments Swift SDK
Это официальный Swift SDK для FastComments.
Официальный Swift SDK для API FastComments
Репозиторий
AI‑агенты кодирования 
Дайте вашему код‑агенту контекст FastComments, который ему нужен — виджеты, конфигурацию, Secure SSO, REST API и SDK:
npx skills add fastcomments/skills
Работает с Claude Code, Codex, Cursor, Copilot, Gemini и любым другим агентом, поддерживаемым skills CLI.
Установка 
Swift Package Manager
Добавьте следующее в ваш файл Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Или в Xcode:
- File > Add Packages...
- Введите URL репозитория:
https://github.com/fastcomments/fastcomments-swift.git - Выберите нужную версию
Требования
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Содержимое библиотеки 
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 - Методы, безопасные для клиента
PublicAPI содержит методы, которые безопасно вызывать из клиентского кода (приложения iOS/macOS). Эти методы:
- Не требуют API-ключа
- Могут использовать SSO-токены для аутентификации
- Ограничены по частоте запросов для каждого пользователя/устройства
- Подходят для приложений, ориентированных на конечных пользователей
Пример использования: Получение и создание комментариев в вашем iOS-приложении
DefaultAPI - Серверные методы
DefaultAPI содержит аутентифицированные методы, требующие API-ключа. Эти методы:
- Требуют ваш FastComments API-ключ
- Должны вызываться ТОЛЬКО из серверного кода
- Предоставляют полный доступ к вашим данным FastComments
- Ограничены по частоте запросов для каждого арендатора (tenant)
Пример использования: Административные операции, массовый экспорт данных, управление пользователями
ModerationAPI - Методы панели модератора
ModerationAPI предоставляет обширный набор быстрых API для модерации в реальном времени. Каждый метод ModerationAPI принимает параметр sso и может аутентифицироваться через SSO или сессионный cookie FastComments.com.
Пример использования: Создание опыта модерации для модераторов вашего сообщества
ВАЖНО: Никогда не раскрывайте свой API-ключ в клиентском коде. API-ключи должны использоваться только на стороне сервера.
Выполнение вызовов 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
createAgentTenant 
Создает новую пробную учетную запись для AI‑агента без регистрации человеком. Для вызова этого метода API‑ключ не требуется.
Ответ содержит идентификатор арендатора, API‑ключ, который сразу же работает с REST API и сервером MCP, а также URL‑адрес для привязки. Передайте URL‑адрес привязки человеку, для которого вы работаете: открытие его, будучи авторизованным в FastComments, привязывает учетную запись к этому человеку. Непривязанные учетные записи и их ключи удаляются через 72 часа после создания. Пока учетная запись не привязана, она имеет стандартные ограничения пробного периода.
Ответ
Returns: CreateAgentTenantResponse
Пример

aggregate 
Собирает документы, группируя их (если указано groupBy), и применяя несколько операций.
Поддерживаются различные операции (например, sum, countDistinct, avg и т.д.).
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Ответ
Returns: AggregateResponse
Пример

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

logoutPublic 
Ответ
Возвращает: APIEmptyResponse
Пример

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

getBatchJobs 
Пакетные задания арендатора (импорт, экспорт, миграция страниц...), от новых к старым.
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| type | string | query | Нет | Только задания этого типа, например migrate-pages. |
| status | string | query | Нет | Только задания со статусом: requested, running, success или failed. |
| skip | integer | query | Нет | Сколько заданий пропустить, для постраничного вывода. |
Ответ
Возвращает: GetBatchJobsAPIResponse
Пример

blockFromCommentPublic 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: BlockSuccess
Пример

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

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

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

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

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

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

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

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

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

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

getCommentsPublic 
req tenantId urlId
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No | |
| questionId | string | query | No | |
| questionValue | integer | query | No |
Ответ
Возвращает: GetCommentsResponseWithPresencePublicComment
Пример

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

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

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

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

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

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

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

translateComments 
Переводит указанные комментарии в локаль виджета. Доступно только когда соответствующее правило настройки виджета имеет параметр Перевод комментариев, установленный в Автоматический или Ручной.
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| locale | string | query | No |
Ответ
Возвращает: CommentTranslationsResponse
Пример

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

unFlagComment 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Ответ
Возвращает: FlagCommentResponse
Пример

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

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

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

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

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

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

deleteDomainConfig 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Ответ
Возвращает: DeleteDomainConfigResponse
Пример

getDomainConfig 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Ответ
Возвращает: GetDomainConfigResponse
Пример

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

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

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

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

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

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

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

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

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

getEmailTemplates 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetEmailTemplatesResponse
Пример

renderEmailTemplate 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| locale | string | query | Нет |
Ответ
Возвращает: RenderEmailTemplateResponse
Пример

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getGifLarge 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| largeInternalURLSanitized | string | query | Да |
Ответ
Возвращает: GifGetLargeResponse
Пример

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

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

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

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

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

getHashTags 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| page | number | query | Нет |
Ответ
Возвращает: GetHashTagsResponse
Пример

patchHashTag 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Ответ
Возвращает: UpdateHashTagResponse
Пример

getMe 
Идентифицирует используемые учетные данные: арендатора, к которому они принадлежат, и, для OAuth‑токенов, пользователя, который их авторизовал.
Интеграции используют это для тестирования соединения и его маркировки.
Parameters
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Ответ
Возвращает: GetMeResponse
Пример

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

getApiComments 
Параметры
| 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
Пример

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

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

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

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

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

getCount 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Ответ
Возвращает: ModerationAPICountCommentsResponse
Пример

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

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

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

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

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

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

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

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

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

getSearchSites 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: ModerationSiteSearchResponse
Пример

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

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

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

getUserBanPreference 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Ответ
Возвращает: APIModerateGetUserBanPreferencesResponse
Пример

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

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

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

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

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

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

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

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

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

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

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

postSetCommentReviewStatus 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| reviewed | boolean | query | Нет | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: APIEmptyResponse
Пример

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

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

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

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

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

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

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

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

setTrustFactor 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Нет | |
| trustFactor | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: SetUserTrustFactorResponse
Пример

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getOfflineUsers 
Прошлые комментаторы страницы, которые НЕ в сети в данный момент. Отсортированы по displayName. Используйте этот метод после исчерпания /users/online для отображения раздела «Участники». Курсорная пагинация по commenterName: сервер проходит по частичному индексу {tenantId, urlId, commenterName} от afterName вперёд через $gt, без затрат на $skip.
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | Идентификатор URL страницы (очищается на сервере). |
| afterName | string | query | Нет | Курсор: передайте nextAfterName из предыдущего ответа. |
| afterUserId | string | query | Нет | Дополнительный ключ курсора: передайте nextAfterUserId из предыдущего ответа. Обязателен, когда задан afterName, чтобы совпадения имён не приводили к потере записей. |
Ответ
Возвращает: PageUsersOfflineResponse
Пример

getOnlineUsers 
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

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

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

getPageReacts 
Пользовательские счётчики реакций для страницы, опционально с пользователями, которые отреагировали.
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| includeUserInfo | string | query | Нет | "public" исключает пользователей с приватными профилями, "include-private" включает их. |
Ответ
Возвращает: GetPageReactsAPIResponse
Пример

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

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

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

migratePages 
Помещает в очередь пакетную задачу, которая перемещает комментарии, страницы и связанные записи из одного urlId или домена в другой.
"urlId" миграции соответствуют только точному urlId. "domain" миграции ищут/заменяют значение внутри каждого urlId и url.
Опрос GET /api/v1/batch-jobs/{batchJobId}: после завершения он содержит результаты каждой миграции и undoId.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: QueuePageMigrationJobAPIResponse
Example

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

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

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

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

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

createPollVote 
Записать голос в опросе или переместить существующий голос к другому варианту. У избирателя может быть не более одного голоса в каждом опросе, поэтому повторный вызов для того же избирателя перемещает его голос, а не добавляет новый.
Это соблюдает настройки опросов сайта: если голосование разрешено только для авторизованных пользователей, голос с только anonUserId отклоняется, а анонимные голоса ограничиваются по частоте запросов с одного IP для каждого опроса.
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Ответ
Возвращает: CreatePollVoteResponse
Пример

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

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

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
A poll belongs to a comment, so votes are always read one poll at a time - commentId is required. That keeps every query on the indexes the collection already has.
Obeys the poll's privacy: an anonymous poll's votes cannot be read (poll-anonymous), here or by id.
Parameters
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Да | |
| voterId | string | query | Нет | |
| optionId | string | query | Нет | |
| skip | integer | query | Нет |
Response
Возвращает: GetPollVotesResponse
Example

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

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

getPollVoters 
Кто проголосовал за какой вариант. Анонимные опросы никогда не отвечают, опросы только для администраторов отвечают только администратору или модератору.
Parameters
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
Response
Возвращает: GetPollVoterNamesSuccessResponse
Example

patchPoll 
Edit a poll in place, keeping its tallies: change the question, relabel an option, close or reopen it, or change who may see the voters. Options are addressed by id - to add, remove or reorder them, PUT the full list.
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Ответ
Возвращает: SavePollResponse
Пример

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getSSOUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | integer | query | Нет |
Response
Возвращает: GetSSOUsersResponse
Пример

patchSSOUser 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Ответ
Возвращает: 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 | Да | |
| userId | string | query | Нет |
Ответ
Возвращает: GetSubscriptionsAPIResponse
Пример

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

getTenantDailyUsages 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Ответ
Возвращает: GetTenantDailyUsagesResponse
Пример

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

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

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

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

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

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

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

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

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

getTenantUsers 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetTenantUsersResponse
Пример

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getUserBadgeProgressByUserId 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | path | Да |
Ответ
Возвращает: APIGetUserBadgeProgressResponse
Пример

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

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

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

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

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

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

getUserNotificationCount 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: GetUserNotificationCountResponse
Пример

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

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

resetUserNotifications 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Ответ
Возвращает: ResetUserNotificationsResponse
Пример

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

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

updateUserNotificationStatus 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| newStatus | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: UpdateUserNotificationStatusResponse
Пример

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

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

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

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

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

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

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

createWebhook 
Подписывает URL на событие комментария (REST‑hook подписка). Подписка того же URL на то же событие и домен снова возвращает существующую подписку. Доставки подписок подписаны HMAC, см. руководство по веб‑хукам; заголовок legacy token никогда не отправляется в подписки API.
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Ответ
Возвращает: CreateWebhookResponse
Пример

deleteWebhook 
Отписки (REST hook unsubscribe). Только подписки, созданные через этот API, могут быть удалены здесь; вебхуки, управляемые через панель, редактируются в панели.
Parameters
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Response
Returns: APIEmptyResponse
Example

getWebhooks 
Список вебхуков, настроенных для арендатора, как управляемых через панель, так и подписок API.
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| event | string | query | No | |
| domain | string | query | No | |
| source | string | query | No | |
| skip | number | query | No |
Ответ
Возвращает: GetWebhooksResponse
Пример

getWebhookSamplePayloads 
Recent comments in exactly the shape webhook deliveries use, for building integrations (for example Zapier
sample data). Every event delivers the same comment object, so event only has to be valid.
Parameters
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| event | string | query | Нет | |
| limit | number | query | Нет |
Response
Возвращает: GetWebhookSamplePayloadsResponse
Example

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