
Язык 🇷🇺 Русский
Начало работы
Документация
Агрегация
Журналы аудита
Аутентификация
Блокировка по комментарию
Проверка заблокированных комментариев
Комментарии
Комментарии для пользователя
Конфигурации доменов
Шаблоны писем
Журнал событий
Публикации ленты
Жалоба на комментарий
GIF
Хештеги
Модерация
Модераторы
Счётчик уведомлений
Уведомления
Реакции на странице
Страницы
Ожидающие события вебхука
Настройки вопросов
Результаты вопросов
Агрегация результатов вопросов
SSO-пользователи
Подписки
Ежедневное использование арендатора
Пакеты арендатора
Пользователи арендатора
Арендаторы
Тикеты
Переводы
Загрузка изображения
Прогресс значков пользователя
Значки пользователя
Уведомления пользователя
Статусы присутствия пользователя
Поиск пользователей
Пользователи
Голоса
FastComments SDK для Python
Это официальный Python SDK для FastComments.
Официальный Python SDK для API FastComments
Репозиторий
Установка 
Install from GitHub
Установите напрямую из тега релиза (рекомендовано, полностью воспроизводимо):
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Закрепите тег, а не ветку, чтобы сборки были детерминированными. Тот же синтаксис работает в requirements.txt:
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Каждый помеченный GitHub Release также имеет прикреплённый построенный wheel, если вы предпочитаете установить бинарный артефакт напрямую.
Library Contents
Эта библиотека содержит два модуля: сгенерированный API‑клиент и ядро Python‑библиотеки, которое включает написанные вручную утилиты для упрощения работы с API, включая поддержку SSO.
Public vs Secured APIs
Для API‑клиента существует три класса: DefaultApi, PublicApi и ModerationApi. DefaultApi содержит методы, требующие вашего API‑ключа, а PublicApi — методы, которые можно вызывать напрямую из браузера/мобильного устройства и т.д. без аутентификации. ModerationApi предоставляет обширный набор живых и быстрых API модерации. Каждый метод ModerationApi принимает параметр sso и может аутентифицироваться через SSO или cookie сессии FastComments.com.
Быстрый старт 
Использование аутентифицированных API (DefaultApi)
Важно: Вы должны установить ваш API‑ключ в Configuration перед выполнением аутентифицированных запросов. Если этого не сделать, запросы будут завершаться ошибкой 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Создать и настроить клиент API
config = Configuration()
config.host = "https://fastcomments.com"
# ОБЯЗАТЕЛЬНО: Установите ваш API‑ключ (получите его в панели FastComments)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}
# Создать экземпляр API с настроенным клиентом
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Теперь вы можете выполнять аутентифицированные вызовы API
try:
# Пример: добавить SSO‑пользователя
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user("YOUR_TENANT_ID", user_data)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Распространённые ошибки:
# - 401: API‑ключ отсутствует или недействителен
# - 400: Ошибка валидации запроса
Использование публичных API (PublicApi)
Публичные конечные точки не требуют аутентификации:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
print(response)
except Exception as e:
print(f"Error: {e}")
Использование панели модерации (ModerationApi)
ModerationApi обеспечивает работу панели модератора. Методы вызываются от имени модератора путем передачи токена sso:
from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)
try:
# Подсчитать комментарии, ожидающие модерации
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
Использование SSO (Single Sign-On)
SDK включает утилиты для генерации безопасных SSO‑токенов:
from sso import FastCommentsSSO, SecureSSOUserData
# Создать данные пользователя (обязательны id, email и username)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Подписать их вашим секретом API (HMAC‑SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# Сгенерировать SSO‑токен для передачи в виджет или API‑вызов
sso_token = sso.create_token()
# Используйте этот токен в фронтенде или передайте в API‑вызовы
print(f"SSO Token: {sso_token}")
Для простого SSO (меньше защищённого, только для тестов):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
username="johndoe",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Распространённые проблемы
- Ошибка 401 "missing-api-key": Убедитесь, что вы установили
config.api_key = {"api_key": "YOUR_KEY"}до создания экземпляра DefaultApi. - Неправильный класс API: Используйте
DefaultApiдля серверных аутентифицированных запросов,PublicApiдля клиентских/публичных запросов иModerationApiдля запросов панели модератора. - Ошибки импорта: Убедитесь, что импортируете из правильного модуля:
- Клиент API:
from client import ... - Утилиты SSO:
from sso import ...
- Клиент API:
Примечания 
Идентификаторы Broadcast
Вы увидите, что в некоторых вызовах API нужно передавать broadcast_id. Когда вы будете получать события, вы получите этот идентификатор обратно, чтобы знать, нужно ли игнорировать событие, если вы планируете оптимистично применять изменения на клиенте (что, вероятно, вы захотите сделать, поскольку это обеспечивает лучший пользовательский опыт). Передайте здесь UUID. Идентификатор должен быть достаточно уникальным, чтобы не появляться дважды в рамках одной сессии браузера.
Требования 
- Python >= 3.8
Базовая установка является pure-stdlib и предоставляет утилиты SSO. Сгенерированный API‑клиент (DefaultApi/PublicApi/ModerationApi) требует дополнительный модуль client, который подтягивает urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 и typing-extensions >= 4.0.0:
pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0"
Агрегировать 
Агрегирует документы, группируя их (если указано groupBy) и применяя несколько операций.
Поддерживаются различные операции (например, sum, countDistinct, avg и т.д.).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Response
Returns: AggregateResponse
Example

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

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

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

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

Проверка комментариев на блокировку 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentIds | string | query | Да | Список идентификаторов комментариев, разделённых запятыми. |
| sso | string | query | Нет |
Ответ
Возвращает: CheckBlockedCommentsResponse
Пример

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

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

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

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

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

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

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

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

Получить имена пользователей, проголосовавших за комментарий 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Ответ
Возвращает: GetCommentVoteUserNamesSuccessResponse
Пример

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

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

Закрепить комментарий 
Параметры
| Название | Тип | Location | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: 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
Пример

Установить текст комментария 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Returns: PublicAPISetCommentTextResponse
Example

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

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

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

Открепить комментарий 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Ответ
Returns: APIEmptyResponse
Пример

Проголосовать за комментарий 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Нет | |
| direction | string | query | Нет | |
| repliesToUserId | string | query | Нет | |
| page | number | query | Нет | |
| includei10n | boolean | query | Нет | |
| locale | string | query | Нет | |
| isCrawler | boolean | query | Нет |
Ответ
Возвращает: GetCommentsForUserResponse
Пример

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

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

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

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

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

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

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

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

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

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

Получить определения шаблонов писем 
Параметры
| 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
Параметры
| 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 |
Ответ
Возвращает: GetEventLogResponse
Пример

Создать публикацию в ленте 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Ответ
Возвращает: CreateFeedPostsResponse
Пример

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

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

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

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

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

Получить реакции пользователей (публично) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Ответ
Returns: UserReactsResponse
Пример

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

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

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

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

Получить большой GIF 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| 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 | путь | Да | |
| locale | string | запрос | Нет | |
| rating | string | запрос | Нет | |
| page | number | запрос | Нет |
Ответ
Возвращает: GetGifsTrendingResponse
Пример

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

Добавить хештеги массово 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Возвращает: BulkCreateHashTagsResponse
Example

Удалить хештег 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Ответ
Возвращает: 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 | Да | |
| commentId | string | path | Да | |
| voteId | string | path | Да | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: VoteDeleteResponse
Пример

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

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

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

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

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

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

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

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

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

Получить ручные значки 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Нет |
Response
Возвращает: GetTenantManualBadgesResponse
Example

Получить ручные значки для пользователя 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Response
Returns: GetUserManualBadgesResponse
Example

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

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

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

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

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

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

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

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

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

Получить предпочтения бана пользователя 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: 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
Пример

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

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

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

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

Пожаловаться на комментарий (POST) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: APIEmptyResponse
Пример

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

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

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

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

Установить статус спама комментария (POST) 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| spam | boolean | query | Нет | |
| permNotSpam | boolean | query | Нет | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Returns: APIEmptyResponse
Пример

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

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

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

Назначить значок (PUT) 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| badgeId | string | query | Да | |
| userId | string | query | Нет | |
| commentId | string | query | Нет | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: AwardUserBadgeResponse
Пример

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

Удалить значок (PUT) 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| 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
Пример

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

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

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

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

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

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

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

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

Удалить счётчик уведомлений 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | запрос | Да | |
| userId | string | запрос | Нет | |
| urlId | string | запрос | Нет | |
| fromCommentId | string | запрос | Нет | |
| viewed | boolean | запрос | Нет | |
| type | string | запрос | Нет | |
| skip | number | запрос | Нет |
Ответ
Возвращает: GetNotificationsResponse
Пример

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

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

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

Удалить реакцию на страницу v1 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Да | |
| id | string | query | Да |
Ответ
Возвращает: GetV2PageReactUsersResponse
Пример

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

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

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

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

Получить онлайн-пользователей 
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

Получить страницу по URL ID 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| 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
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| 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
Возвращает: GetPublicPagesResponse
Пример

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Обновить результат вопроса 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

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

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

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

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

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

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

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

Заменить SSO-пользователя 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Нет |
Response
Возвращает: PutSSOUserAPIResponse
Пример

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

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

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

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

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

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

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

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

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

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

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

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

Удалить пользователя арендатора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Ответ
Возвращает: APIEmptyResponse
Пример

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

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

Заменить пользователя арендатора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Ответ
Возвращает: APIEmptyResponse
Пример

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

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

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

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

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

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

Обновить арендатора 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

Получить тикет 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Returns: UploadImageResponse
Example

Получить прогресс значка пользователя по ID 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Нет |
Ответ
Returns: APIGetUserBadgeProgressListResponse
Пример

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

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

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

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

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

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

Получить уведомления пользователя 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| 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 | Нет | |
| sno | string | query | Нет |
Ответ
Возвращает: GetMyNotificationsResponse
Пример

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

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

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

Обновить статус подписки пользователя на страницу 
Включает или отключает уведомления для страницы. Когда пользователи подписаны на страницу, создаются уведомления для новых корневых комментариев, а также
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| 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 |
Ответ
Returns: SearchUsersResult
Пример

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

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

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

Получить голоса 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Ответ
Возвращает: GetVotesResponse
Пример

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

Нужна помощь?
Если вы столкнулись с какими-либо проблемами или у вас есть вопросы о Python SDK, пожалуйста:
Contributing
Contributions are welcome! Please visit the GitHub repository for contribution guidelines.