
Език 🇧🇬 Български
Първи стъпки
Документация
Агрегиране
Журнали за одит
Удостоверяване
Блокиране от коментар
Проверка за блокирани коментари
Коментари
Коментари за потребител
Конфигурации на домейни
Шаблони за имейли
Регистър на събитията
Публикации в емисията
Отбелязване на коментар
GIF
Хаштагове
Модерация
Модератори
Брой известия
Известия
Реакции на страница
Страници
Очакващи Webhook събития
Настройки на въпроси
Резултати от въпросите
Агрегиране на резултатите от въпросите
SSO потребители
Абонаменти
Дневна употреба на наемателя
Пакети на наемателя
Потребители на наемателя
Наематели
Тикети
Преводи
Качване на изображение
Напредък на значките на потребителя
Значки на потребителя
Известия за потребителя
Статуси на присъствие на потребителя
Търсене на потребители
Потребители
Гласове
FastComments SDK за Python
Това е официалният Python SDK за FastComments.
Официален Python SDK за API-то на FastComments
Репозитория
Инсталиране 
Инсталиране от 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, ако предпочитате да инсталирате бинарен артефакт директно.
Съдържание на библиотеката
Тази библиотека съдържа два модула: генерирания клиент за API и основната Python библиотека, която съдържа ръчно написани помощни функции за улесняване на работата с API‑то, включително поддръжка на SSO.
Публични срещу защитени API‑та
За клиентския API има три класа – DefaultApi, PublicApi и ModerationApi. DefaultApi съдържа методи, които изискват вашия API ключ, а PublicApi съдържа методи, които могат да се извикат директно от браузър/мобилно устройство и пр. без автентификация. ModerationApi предоставя обширен набор от живи и бързи модерационни API‑та. Всеки метод на ModerationApi приема параметър sso и може да се автентикира чрез SSO или 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_id в някои API заявки. Когато получите събития, ще получите този идентификатор обратно, така че да знаете да игнорирате събитието, ако планирате да приложите промените оптимистично на клиента (което вероятно ще искате да направите, тъй като осигурява най-доброто потребителско изживяване). Подайте тук UUID. Идентификаторът трябва да е достатъчно уникален, за да не се появи два пъти в една сесия на браузъра.
Изисквания 
- Python >= 3.8
Базовата инсталация е чисто stdlib и предоставя SSO помощни функции. Генерираният API клиент (DefaultApi/PublicApi/ModerationApi) изисква extra 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"
aggregate 
Агрегира документи чрез групиране (ако е предоставен groupBy) и прилагане на множество операции.
Поддържат се различни операции (например sum, countDistinct, avg и др.).
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Отговор
Връща: AggregateResponse
Пример

get_audit_logs 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| limit | number | query | Не | |
| skip | number | query | Не | |
| order | string | query | Не | |
| after | number | query | Не | |
| before | number | query | Не |
Отговор
Returns: GetAuditLogsResponse
Пример

logout_public 
Отговор
Връща: APIEmptyResponse
Пример

block_from_comment_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: BlockSuccess
Пример

un_block_comment_public 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UnblockSuccess
Пример

checked_comments_for_blocked 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | Списък с идентификатори на коментари, разделени със запетаи. |
| sso | string | query | No |
Отговор
Връща: CheckBlockedCommentsResponse
Пример

block_user_from_comment 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Връща: BlockSuccess
Example

create_comment_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| sessionId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: SaveCommentsResponseWithPresence
Пример

delete_comment 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Отговор
Връща: DeleteCommentResult
Пример

delete_comment_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Отговор
Връща: PublicAPIDeleteCommentResponse
Пример

delete_comment_vote 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Отговор
Returns: VoteDeleteResponse
Пример

flag_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: FlagCommentResponse
Пример

get_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: APIGetCommentResponse
Пример

get_comment_text 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Отговор
Връща: PublicAPIGetCommentTextResponse
Пример

get_comment_vote_user_names 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| dir | integer | query | Да | |
| sso | string | query | Не |
Отговор
Връща: GetCommentVoteUserNamesSuccessResponse
Пример

get_comments 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

get_comments_public 
req tenantId urlId
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

lock_comment 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

pin_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: ChangeCommentPinStatusResponse
Пример

save_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Отговор
Връща: APISaveCommentResponse
Пример

save_comments_bulk 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| isLive | boolean | query | Не | |
| doSpamCheck | boolean | query | Не | |
| sendEmails | boolean | query | Не | |
| populateNotifications | boolean | query | Не |
Отговор
Връща: SaveCommentsBulkResponse
Пример

set_comment_text 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Отговор
Връща: PublicAPISetCommentTextResponse
Пример

un_block_user_from_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Отговор
Връща: UnblockSuccess
Пример

un_flag_comment 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Връща: FlagCommentResponse
Example

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

un_pin_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: ChangeCommentPinStatusResponse
Пример

update_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Отговор
Връща: APIEmptyResponse
Пример

vote_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

get_comments_for_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| userId | string | query | Не | |
| direction | string | query | Не | |
| repliesToUserId | string | query | Не | |
| page | number | query | Не | |
| includei10n | boolean | query | Не | |
| locale | string | query | Не | |
| isCrawler | boolean | query | Не |
Отговор
Връща: GetCommentsForUserResponse
Пример

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

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

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

get_domain_configs 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: GetDomainConfigsResponse
Пример

patch_domain_config 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Отговор
Връща: PatchDomainConfigResponse
Пример

put_domain_config 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Отговор
Връща: PutDomainConfigResponse
Пример

create_email_template 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Отговор
Връща: CreateEmailTemplateResponse
Пример

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

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

get_email_template 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetEmailTemplateResponse
Пример

get_email_template_definitions 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: GetEmailTemplateDefinitionsResponse
Пример

get_email_template_render_errors 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| skip | number | query | Не |
Отговор
Връща: GetEmailTemplateRenderErrorsResponse
Пример

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

render_email_template 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| locale | string | query | Не |
Отговор
Връща: RenderEmailTemplateResponse
Пример

update_email_template 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

get_event_log 
req tenantId urlId userIdWS
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Не |
Отговор
Връща: GetEventLogResponse
Пример

get_global_event_log 
req tenantId urlId userIdWS
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Не |
Отговор
Връща: GetEventLogResponse
Пример

create_feed_post 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Отговор
Връща: CreateFeedPostsResponse
Пример

create_feed_post_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: CreateFeedPostResponse
Пример

delete_feed_post_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: DeleteFeedPostPublicResponse
Пример

get_feed_posts 
req tenantId afterId
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Отговор
Връща: GetFeedPostsResponse
Пример

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

get_feed_posts_stats 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postIds | array | query | Да | |
| sso | string | query | Не |
Отговор
Връща: FeedPostsStatsResponse
Пример

get_user_reacts_public 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postIds | array | query | Не | |
| sso | string | query | Не |
Response
Returns: UserReactsResponse
Example

react_feed_post_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| isUndo | boolean | query | Не | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ReactFeedPostResponse
Пример

update_feed_post 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

update_feed_post_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Returns: CreateFeedPostResponse
Пример

flag_comment_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| isFlagged | boolean | query | Да | |
| sso | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

get_gif_large 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| largeInternalURLSanitized | string | query | Да |
Отговор
Връща: GifGetLargeResponse
Пример

get_gifs_search 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| search | string | query | Да | |
| locale | string | query | Не | |
| rating | string | query | Не | |
| page | number | query | Не |
Отговор
Връща: GetGifsSearchResponse
Пример

get_gifs_trending 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| locale | string | query | Не | |
| rating | string | query | Не | |
| page | number | query | Не |
Отговор
Връща: GetGifsTrendingResponse
Пример

add_hash_tag 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Отговор
Returns: CreateHashTagResponse
Пример

add_hash_tags_bulk 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Отговор
Връща: BulkCreateHashTagsResponse
Пример

delete_hash_tag 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| tag | string | path | Да |
Отговор
Returns: APIEmptyResponse
Пример

get_hash_tags 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| page | number | query | Не |
Отговор
Връща: GetHashTagsResponse
Пример

patch_hash_tag 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Отговор
Връща: UpdateHashTagResponse
Пример

delete_moderation_vote 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: VoteDeleteResponse
Пример

get_api_comments 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

get_api_export_status 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: ModerationExportStatusResponse
Пример

get_api_ids 
Параметри
| 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 |
Отговор
Returns: ModerationAPIGetCommentIdsResponse
Пример

get_ban_users_from_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: GetBannedUsersFromCommentResponse
Пример

get_comment_ban_status 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: GetCommentBanStatusResponse
Пример

get_comment_children 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: ModerationAPIChildCommentsResponse
Пример

get_count 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 |
Отговор
Returns: ModerationAPICountCommentsResponse
Пример

get_counts 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Отговор
Връща: GetBannedUsersCountResponse
Пример

get_logs 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: ModerationAPIGetLogsResponse
Пример

get_manual_badges 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Returns: GetTenantManualBadgesResponse
Пример

get_manual_badges_for_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| badgesUserId | string | query | Не | |
| commentId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: GetUserManualBadgesResponse
Пример

get_moderation_comment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| includeEmail | boolean | query | Не | |
| includeIP | boolean | query | Не | |
| sso | string | query | Не |
Response
Връща: ModerationAPICommentResponse
Пример

get_moderation_comment_text 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: GetCommentTextResponse
Пример

get_pre_ban_summary 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

get_search_comments_summary 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Не | |
| filters | string | query | Не | |
| searchFilters | string | query | Не | |
| sso | string | query | Не |
Отговор
Returns: ModerationCommentSearchResponse
Пример

get_search_pages 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ModerationPageSearchResponse
Пример

get_search_sites 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ModerationSiteSearchResponse
Пример

get_search_suggest 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Отговор
Връща: ModerationSuggestResponse
Пример

get_search_users 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ModerationUserSearchResponse
Пример

get_trust_factor 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: GetUserTrustFactorResponse
Пример

get_user_ban_preference 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: APIModerateGetUserBanPreferencesResponse
Пример

get_user_internal_profile 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Response
Връща: GetUserInternalProfileResponse
Пример

post_adjust_comment_votes 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Response
Връща: AdjustVotesResponse
Пример

post_api_export 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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_ban_user_from_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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_ban_user_undo 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

post_bulk_pre_ban_summary 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Отговор
Връща: BulkPreBanSummary
Пример

post_comments_by_ids 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: ModerationAPIChildCommentsResponse
Пример

post_flag_comment 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Връща: APIEmptyResponse
Example

post_remove_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: PostRemoveCommentApiResponse
Пример

post_restore_deleted_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

post_set_comment_approval_status 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| approved | boolean | query | Не | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: SetCommentApprovedResponse
Пример

post_set_comment_review_status 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

post_set_comment_spam_status 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

post_set_comment_text 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: SetCommentTextResponse
Пример

post_un_flag_comment 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

post_vote 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: VoteResponse
Пример

put_award_badge 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: AwardUserBadgeResponse
Пример

put_close_thread 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| sso | string | query | Не |
Отговор
Returns: APIEmptyResponse
Пример

put_remove_badge 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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_reopen_thread 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

set_trust_factor 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Отговор
Връща: SetUserTrustFactorResponse
Пример

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

delete_moderator 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sendEmail | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

get_moderator 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: GetModeratorResponse
Пример

get_moderators 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetModeratorsResponse
Пример

send_invite 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| fromName | string | query | Да |
Отговор
Връща: APIEmptyResponse
Пример

update_moderator 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

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

get_cached_notification_count 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetCachedNotificationCountResponse
Пример

get_notification_count 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Отговор
Returns: GetNotificationCountResponse
Пример

get_notifications 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| urlId | string | query | Не | |
| fromCommentId | string | query | Не | |
| viewed | boolean | query | Не | |
| type | string | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetNotificationsResponse
Пример

update_notification 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

create_v1_page_react 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| title | string | query | Не |
Отговор
Връща: CreateV1PageReact
Пример

create_v2_page_react 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| id | string | query | Да | |
| title | string | query | Не |
Отговор
Връща: CreateV1PageReact
Пример

delete_v1_page_react 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Отговор
Връща: CreateV1PageReact
Пример

delete_v2_page_react 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| id | string | query | Да |
Отговор
Връща: CreateV1PageReact
Пример

get_v1_page_likes 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Отговор
Връща: GetV1PageLikes
Пример

get_v2_page_react_users 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| id | string | query | Да |
Отговор
Връща: GetV2PageReactUsersResponse
Пример

get_v2_page_reacts 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Отговор
Връща: GetV2PageReacts
Пример

add_page 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: AddPageAPIResponse
Пример

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

get_offline_users 
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

get_online_users 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Връща anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Текущо онлайн зрители на страница: хора, чиито уебсокет сесия е абонирана за страницата в момента.
Връща anonCount + totalCount (абонати в цялата стая, включително анонимни зрители, които не изброяваме).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Page URL identifier (cleaned server-side). |
| afterName | string | query | No | Cursor: pass nextAfterName from the previous response. |
| afterUserId | string | query | No | Cursor tiebreaker: pass nextAfterUserId from the previous response. Required when afterName is set so name-ties don't drop entries. |
Response
Returns: PageUsersOnlineResponse
Example

get_page_by_urlid 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Отговор
Връща: GetPageByURLIdAPIResponse
Пример

get_pages 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: GetPagesAPIResponse
Пример

get_pages_public 
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, по подразбиране 50 |
| q | string | query | No | По избор, нечувствителен към регистъра филтър за началото на заглавието. |
| sortBy | string | query | No | Сортиране. updatedAt (по подразбиране, най-нови първи), commentCount (най‑много коментари първо), или title (по азбучен ред). |
| hasComments | boolean | query | No | Ако е истина, върнете само страници с поне един коментар. |
Response
Returns: GetPublicPagesResponse
Example

get_users_info 
Масова информация за потребители за един наемател. По зададени userIds връща данни за показване от User / SSOUser. Използва се от коментарния уиджет за обогатяване на потребители, които току-що са се появили чрез събитие за присъствие. Няма контекст на страница: поверителността се прилага еднакво (личните профили са маскирани).
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds, разделени със запетая. |
Отговор
Връща: PageUsersInfoResponse
Пример

patch_page 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: PatchPageAPIResponse
Пример

delete_pending_webhook_event 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

get_pending_webhook_event_count 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 |
Response
Връща: GetPendingWebhookEventCountResponse
Пример

get_pending_webhook_events 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | низ | заявка | Да | |
| commentId | низ | заявка | Не | |
| externalId | низ | заявка | Не | |
| eventType | низ | заявка | Не | |
| type | низ | заявка | Не | |
| domain | низ | заявка | Не | |
| attemptCountGT | число | заявка | Не | |
| skip | число | заявка | Не |
Отговор
Връща: GetPendingWebhookEventsResponse
Пример

create_question_config 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateQuestionConfigResponse
Пример

delete_question_config 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

get_question_config 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetQuestionConfigResponse
Пример

get_question_configs 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetQuestionConfigsResponse
Пример

update_question_config 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

create_question_result 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateQuestionResultResponse
Пример

delete_question_result 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

get_question_result 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetQuestionResultResponse
Пример

get_question_results 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

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

aggregate_question_results 
Параметри
| Име | Тип | Местоположение | Изисква се | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| questionId | string | query | Не | |
| questionIds | array | query | Не | |
| urlId | string | query | Не | |
| timeBucket | string | query | Не | |
| startDate | string | query | Не | |
| forceRecalculate | boolean | query | Не |
Отговор
Връща: AggregateQuestionResultsResponse
Пример

bulk_aggregate_question_results 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| forceRecalculate | boolean | query | Не |
Отговор
Връща: BulkAggregateQuestionResultsResponse
Пример

combine_comments_with_question_results 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

add_sso_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: AddSSOUserAPIResponse
Пример

delete_sso_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Отговор
Връща: DeleteSSOUserAPIResponse
Пример

get_sso_user_by_email 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
Отговор
Връща: GetSSOUserByEmailAPIResponse
Пример

get_sso_user_by_id 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetSSOUserByIdAPIResponse
Пример

get_sso_users 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | integer | query | Не |
Отговор
Връща: GetSSOUsersResponse
Пример

patch_sso_user 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Отговор
Връща: PatchSSOUserAPIResponse
Пример

put_sso_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Отговор
Връща: PutSSOUserAPIResponse
Пример

create_subscription 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateSubscriptionAPIResponse
Пример

delete_subscription 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Връща: DeleteSubscriptionAPIResponse
Пример

get_subscriptions 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не |
Отговор
Връща: GetSubscriptionsAPIResponse
Пример

update_subscription 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Връща: UpdateSubscriptionAPIResponse
Пример

get_tenant_daily_usages 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Отговор
Връща: GetTenantDailyUsagesResponse
Пример

create_tenant_package 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateTenantPackageResponse
Пример

delete_tenant_package 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: APIEmptyResponse
Пример

get_tenant_package 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetTenantPackageResponse
Пример

get_tenant_packages 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetTenantPackagesResponse
Пример

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

update_tenant_package 
Параметри
| Name | Type | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

create_tenant_user 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateTenantUserResponse
Пример

delete_tenant_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| deleteComments | string | query | Не | |
| commentDeleteMode | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

get_tenant_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: GetTenantUserResponse
Пример

get_tenant_users 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetTenantUsersResponse
Пример

replace_tenant_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

send_login_link 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| redirectURL | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

update_tenant_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

create_tenant 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Отговор
Връща: CreateTenantResponse
Пример

delete_tenant 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sure | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

get_tenant 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetTenantResponse
Пример

get_tenants 
Параметри
| Име | Тип | Място | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Отговор
Връща: GetTenantsResponse
Пример

update_tenant 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

change_ticket_state 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: ChangeTicketStateResponse
Пример

create_ticket 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Да |
Отговор
Връща: CreateTicketResponse
Пример

get_ticket 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Връща: GetTicketResponse
Пример

get_tickets 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Отговор
Връща: GetTicketsResponse
Пример

get_translations 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Отговор
Връща: GetTranslationsResponse
Пример

upload_image 
Upload and resize an image
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

get_user_badge_progress_by_id 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIGetUserBadgeProgressResponse
Пример

get_user_badge_progress_by_user_id 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | path | Да |
Отговор
Връща: APIGetUserBadgeProgressResponse
Пример

get_user_badge_progress_list 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| limit | number | query | Не | |
| skip | number | query | Не |
Отговор
Връща: APIGetUserBadgeProgressListResponse
Пример

create_user_badge 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: APICreateUserBadgeResponse
Пример

delete_user_badge 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptySuccessResponse
Пример

get_user_badge 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIGetUserBadgeResponse
Пример

get_user_badges 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

update_user_badge 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptySuccessResponse
Пример

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

get_user_notifications 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Използва се за определяне дали текущата страница е абонирана. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Отговор
Връща: GetMyNotificationsResponse
Пример

reset_user_notification_count 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: ResetUserNotificationsResponse
Пример

reset_user_notifications 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Не | |
| afterCreatedAt | integer | query | Не | |
| unreadOnly | boolean | query | Не | |
| dmOnly | boolean | query | Не | |
| noDm | boolean | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ResetUserNotificationsResponse
Пример

update_user_notification_comment_subscription_status 
Активиране или деактивиране на известия за конкретен коментар.
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| optedInOrOut | string | path | Да | |
| commentId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationCommentSubscriptionStatusResponse
Пример

update_user_notification_page_subscription_status 
Активиране или деактивиране на известия за страница. Когато потребителите са абонирани за страница, се създават известия за нови коренни коментари, и също
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: UpdateUserNotificationPageSubscriptionStatusResponse
Пример

update_user_notification_status 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| newStatus | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationStatusResponse
Пример

get_user_presence_statuses 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlIdWS | string | query | Да | |
| userIds | string | query | Да |
Отговор
Връща: GetUserPresenceStatusesResponse
Пример

search_users 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| szo | string | query | No | |
| searchSection | string | query | No |
Отговор
Връща: SearchUsersResult
Пример

get_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetUserResponse
Пример

create_vote 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Да | |
| direction | string | query | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: VoteResponse
Пример

delete_vote 
Параметри
| Име | Type | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| editKey | string | query | Не |
Отговор
Връща: VoteDeleteResponse
Пример

get_votes 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Отговор
Връща: GetVotesResponse
Пример

get_votes_for_user 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Response
Returns: GetVotesForUserResponse
Example

Нуждаете ли се от помощ?
Ако срещнете проблеми или имате въпроси относно Python SDK, моля:
Принос
Приносите са добре дошли! Моля, посетете репозитория в GitHub за указания относно приноса.