
Język 🇵🇱 Polski
Dokumentacja
Rozpoczęcie
Agregacja
Logi Audytu
Uwierzytelnianie
Blokowanie z komentarza
Sprawdzanie zablokowanych komentarzy
Komentarze
Komentarze dla użytkownika
Konfiguracje domen
Szablony e-mail
Log zdarzeń
Posty w kanale
Zgłoszenie komentarza
Gify
Hashtagi
Moderacja
Moderatorzy
Liczba powiadomień
Powiadomienia
Reakcje na stronie
Strony
Oczekujące zdarzenia webhook
Konfiguracje pytań
Wyniki pytań
Agregacja wyników pytań
Użytkownicy SSO
Subskrypcje
Dzienne użycie najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Zgłoszenia
Tłumaczenia
Prześlij obraz
Postęp odznak użytkownika
Odznaki użytkownika
Powiadomienia użytkownika
Status obecności użytkownika
Wyszukiwanie użytkowników
Użytkownicy
Głosy
FastComments Python SDK
To jest oficjalne SDK Pythona dla FastComments.
Oficjalne SDK Pythona dla API FastComments
Repozytorium
AI coding agents 
Daj swojemu agentowi programistycznemu kontekst FastComments, którego potrzebuje – widżety, konfiguracja, Secure SSO, REST API i SDK:
npx skills add fastcomments/skills
Działa z Claude Code, Codex, Cursor, Copilot, Gemini oraz każdym innym agentem obsługiwanym przez skills CLI.
Installation 
Instalacja z GitHub
Instaluj bezpośrednio z tagu wydania (zalecane, w pełni odtwarzalne):
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0
Zablokuj tag zamiast gałęzi, aby kompilacje były deterministyczne. Ten sam format działa w requirements.txt:
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0
Każde otagowane GitHub Release ma również dołączony zbudowany plik wheel, jeśli wolisz zainstalować binarny artefakt bezpośrednio.
Zawartość biblioteki
Ta biblioteka zawiera dwa moduły: wygenerowanego klienta API oraz podstawową bibliotekę Pythona, która zawiera ręcznie napisane narzędzia ułatwiające pracę z API, w tym obsługę SSO.
Publiczne vs zabezpieczone API
Dla klienta API dostępne są trzy klasy, DefaultApi, PublicApi i ModerationApi. DefaultApi zawiera metody wymagające klucza API, a PublicApi zawiera metody, które mogą być wywoływane bezpośrednio z przeglądarki/urządzenia mobilnego/etc. bez uwierzytelnienia. ModerationApi oferuje rozbudowany zestaw szybkich i bieżących API moderacji. Każda metoda ModerationApi przyjmuje parametr sso i może uwierzytelnić się za pomocą SSO lub ciasteczka sesji FastComments.com.
Quick Start 
Using Authenticated APIs (DefaultApi)
Ważne: Musisz ustawić swój klucz API w konfiguracji przed wykonywaniem uwierzytelnionych żądań. Jeśli tego nie zrobisz, żądania zakończą się błędem 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Utwórz i skonfiguruj klienta API
config = Configuration()
config.host = "https://fastcomments.com"
# WYMAGANE: Ustaw swój klucz API (pobierz go z panelu FastComments)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}
# Utwórz instancję API z skonfigurowanym klientem
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Teraz możesz wykonywać uwierzytelnione wywołania API
try:
# Przykład: Dodaj użytkownika 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}")
# Typowe błędy:
# - 401: Brak klucza API lub jest nieprawidłowy
# - 400: Walidacja żądania nie powiodła się
Using Public APIs (PublicApi)
Publiczne endpointy nie wymagają uwierzytelnienia:
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}")
Using the Moderation Dashboard (ModerationApi)
ModerationApi napędza panel moderatora. Metody są wywoływane w imieniu moderatora poprzez przekazanie tokenu 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:
# Policz komentarze oczekujące na moderację
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
Using SSO (Single Sign-On)
SDK zawiera narzędzia do generowania bezpiecznych tokenów SSO:
from sso import FastCommentsSSO, SecureSSOUserData
# Utwórz dane użytkownika (id, email i nazwa użytkownika są wymagane)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Podpisz go swoim sekretem API (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# Wygeneruj token SSO, aby przekazać go do widgetu lub wywołania API
sso_token = sso.create_token()
# Użyj tego tokenu w frontendzie lub przekaż go w wywołaniach API
print(f"SSO Token: {sso_token}")
Dla prostego SSO (mniej bezpiecznego, do testów):
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()
Live Subscriptions (PubSub)
Moduł pubsub pozwala subskrybować zdarzenia komentarzy w czasie rzeczywistym (nowe komentarze, głosy, edycje, powiadomienia itp.) przez WebSocket, odzwierciedlając LiveEventSubscriber z FastComments Java SDK. Wymaga dodatkowego pakietu pubsub, który dodaje klienta WebSocket na szczycie wygenerowanego klienta API:
pip install "fastcomments[pubsub] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0"from pubsub import LiveEventSubscriber
subscriber = LiveEventSubscriber()
def handle_live_event(event):
print(f"Live event: {event.type}")
if event.comment:
print(f" comment: {event.comment.comment}")
result = subscriber.subscribe_to_changes(
tenant_id_ws="YOUR_TENANT_ID",
url_id="page-url-id",
url_id_ws="page-url-id",
user_id_ws="a-unique-presence-id", # np. UUID dla tej sesji
handle_live_event=handle_live_event,
on_connection_status_change=lambda connected, last_event_time: print(
f"connected={connected}"
),
region=None, # ustaw na "eu" dla regionu UE
)
# ...później, gdy nie chcesz już otrzymywać aktualizacji:
result.close()
Subskrybent uruchamia połączenie w tle w wątku demona, automatycznie ponownie łączy się z jitterem i pobiera wszelkie zdarzenia, które zostały pominięte podczas rozłączenia z endpointem event-log przy ponownym połączeniu. Przekaż opcjonalny callback can_see_comments (List[str] -> Dict[str, str], zwracający identyfikatory, które użytkownik NIE może zobaczyć), aby odfiltrować zdarzenia dla komentarzy, które użytkownik nie ma zakaz wyświetlania. Ustaw disable_live_commenting=True, aby subscribe_to_changes stało się operacją pustą zwracającą None.
Common Issues
- 401 "missing-api-key" error: Upewnij się, że ustawiłeś
config.api_key = {"api_key": "YOUR_KEY"}przed utworzeniem instancji DefaultApi. - Wrong API class: Użyj
DefaultApido uwierzytelnionych żądań po stronie serwera,PublicApido żądań po stronie klienta/publicznych orazModerationApido żądań panelu moderatora. - Import errors: Upewnij się, że importujesz z właściwego modułu:
- Klient API:
from client import ... - Narzędzia SSO:
from sso import ... - Subskrypcje na żywo:
from pubsub import ...(wymaga dodatkowego pakietupubsub)
- Klient API:
Notes 
Identyfikatory Broadcast
Zobaczysz, że w niektórych wywołaniach API powinieneś przekazać broadcast_id. Kiedy otrzymasz zdarzenia, otrzymasz ten identyfikator z powrotem, dzięki czemu będziesz wiedzieć, aby zignorować zdarzenie, jeśli zamierzasz optymistycznie zastosować zmiany po stronie klienta (co prawdopodobnie będziesz chciał zrobić, ponieważ zapewnia to najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być na tyle unikalny, żeby nie wystąpił dwukrotnie w sesji przeglądarki.
Requirements 
- Python >= 3.8
Podstawowa instalacja jest czystą biblioteką standardową i zapewnia narzędzia SSO. Wygenerowany
klient API (DefaultApi/PublicApi/ModerationApi) wymaga dodatkowego pakietu client,
który pobiera urllib3 >= 1.25.3, python-dateutil >= 2.8.2,
pydantic >= 2.0.0 oraz typing-extensions >= 4.0.0:
pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0"
aggregate 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| parentTenantId | string | query | Nie | |
| includeStats | boolean | query | Nie |
Odpowiedź
Returns: AggregateResponse
Przykład

get_audit_logs 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Odpowiedź
Zwraca: GetAuditLogsResponse
Przykład

logout_public 
Response
Zwraca: APIEmptyResponse
Przykład

block_from_comment_public 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: BlockSuccess
Przykład

un_block_comment_public 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UnblockSuccess
Przykład

checked_comments_for_blocked 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentIds | string | query | Tak | Lista identyfikatorów komentarzy rozdzielona przecinkami. |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CheckBlockedCommentsResponse
Przykład

block_user_from_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odpowiedź
Zwraca: BlockSuccess
Przykład

create_comment_public 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| sessionId | string | query | Nie | |
| sso | string | query | Nie |
Response
Returns: SaveCommentsResponseWithPresence
Example

delete_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Odpowiedź
Zwraca: DeleteCommentResult
Przykład

delete_comment_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: PublicAPIDeleteCommentResponse
Przykład

delete_comment_vote 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: VoteDeleteResponse
Przykład

flag_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odpowiedź
Zwraca: FlagCommentResponse
Przykład

get_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIGetCommentResponse
Przykład

get_comment_text 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: PublicAPIGetCommentTextResponse
Przykład

get_comment_vote_user_names 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| dir | integer | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetCommentVoteUserNamesSuccessResponse
Przykład

get_comments 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: APIGetCommentsResponse
Przykład

get_comments_public 
req tenantId urlId
Parametry
| 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 |
Odpowiedź
Returns: GetCommentsResponseWithPresencePublicComment
Przykład

lock_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pin_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ChangeCommentPinStatusResponse
Przykład

save_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Odpowiedź
Zwraca: APISaveCommentResponse
Przykład

save_comments_bulk 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| sendEmails | boolean | query | Nie | |
| populateNotifications | boolean | query | Nie |
Odpowiedź
Returns: SaveCommentsBulkResponse
Przykład

set_comment_text 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: PublicAPISetCommentTextResponse
Przykład

un_block_user_from_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odpowiedź
Returns: UnblockSuccess
Przykład

un_flag_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentResponse
Przykład

un_lock_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

un_pin_comment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ChangeCommentPinStatusResponse
Przykład

update_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

vote_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| sessionId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: VoteResponse
Przykład

get_comments_for_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| userId | string | query | Nie | |
| direction | string | query | Nie | |
| repliesToUserId | string | query | Nie | |
| page | number | query | Nie | |
| includei10n | boolean | query | Nie | |
| locale | string | query | Nie | |
| isCrawler | boolean | query | Nie |
Odpowiedź
Zwraca: GetCommentsForUserResponse
Przykład

add_domain_config 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: AddDomainConfigResponse
Przykład

delete_domain_config 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domain | string | path | Tak |
Odpowiedź
Zwraca: DeleteDomainConfigResponse
Przykład

get_domain_config 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domain | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfigResponse
Przykład

get_domain_configs 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetDomainConfigsResponse
Przykład

patch_domain_config 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Odpowiedź
Zwraca: PatchDomainConfigResponse
Przykład

put_domain_config 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domainToUpdate | string | path | Tak |
Odpowiedź
Zwraca: PutDomainConfigResponse
Przykład

create_email_template 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateEmailTemplateResponse
Przykład

delete_email_template 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

delete_email_template_render_error 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| errorId | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_email_template 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetEmailTemplateResponse
Przykład

get_email_template_definitions 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetEmailTemplateDefinitionsResponse
Przykład

get_email_template_render_errors 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetEmailTemplateRenderErrorsResponse
Przykład

get_email_templates 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetEmailTemplatesResponse
Przykład

render_email_template 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| locale | string | query | Nie |
Odpowiedź
Zwraca: RenderEmailTemplateResponse
Przykład

update_email_template 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_event_log 
req tenantId urlId userIdWS
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak | |
| userIdWS | string | zapytanie | Tak | |
| startTime | integer | zapytanie | Tak | |
| endTime | integer | zapytanie | Nie |
Odpowiedź
Zwraca: GetEventLogResponse
Przykład

get_global_event_log 
req tenantId urlId userIdWS
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | No |
Odpowiedź
Zwraca: GetEventLogResponse
Przykład

create_feed_post 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| broadcastId | string | query | Nie | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| skipDupCheck | boolean | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostsResponse
Przykład

create_feed_post_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Returns: CreateFeedPostResponse
Przykład

delete_feed_post_public 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Zwraca: DeleteFeedPostPublicResponse
Example

get_feed_posts 
req
tenantId
afterId
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsResponse
Przykład

get_feed_posts_public 
req tenantId afterId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: PublicFeedPostsResponse
Przykład

get_feed_posts_stats 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: FeedPostsStatsResponse
Przykład

get_user_reacts_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Returns: UserReactsResponse
Przykład

react_feed_post_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| isUndo | boolean | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ReactFeedPostResponse
Przykład

update_feed_post 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

update_feed_post_public 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: CreateFeedPostResponse
Przykład

flag_comment_public 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| isFlagged | boolean | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_gif_large 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| largeInternalURLSanitized | string | query | Tak |
Odpowiedź
Zwraca: GifGetLargeResponse
Przykład

get_gifs_search 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Odpowiedź
Zwraca: GetGifsSearchResponse
Przykład

get_gifs_trending 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Odpowiedź
Zwraca: GetGifsTrendingResponse
Przykład

add_hash_tag 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Zwraca: CreateHashTagResponse
Example

add_hash_tags_bulk 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Returns: BulkCreateHashTagsResponse
Przykład

delete_hash_tag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_hash_tags 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | number | query | Nie |
Odpowiedź
Zwraca: GetHashTagsResponse
Przykład

patch_hash_tag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| tag | string | path | Tak |
Odpowiedź
Zwraca: UpdateHashTagResponse
Przykład

delete_moderation_vote 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: VoteDeleteResponse
Przykład

get_api_comments 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | number | query | Nie | |
| count | number | query | Nie | |
| text-search | string | query | Nie | |
| byIPFromComment | string | query | Nie | |
| filters | string | query | Nie | |
| searchFilters | string | query | Nie | |
| sorts | string | query | Nie | |
| demo | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationAPIGetCommentsResponse
Przykład

get_api_export_status 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| batchJobId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationExportStatusResponse
Przykład

get_api_ids 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| text-search | string | query | Nie | |
| byIPFromComment | string | query | Nie | |
| filters | string | query | Nie | |
| searchFilters | string | query | Nie | |
| afterId | string | query | Nie | |
| demo | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationAPIGetCommentIdsResponse
Przykład

get_ban_users_from_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetBannedUsersFromCommentResponse
Przykład

get_comment_ban_status 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| commentId | string | ścieżka | Tak | |
| sso | string | zapytanie | Nie |
Response
Returns: GetCommentBanStatusResponse
Przykład

get_comment_children 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationAPIChildCommentsResponse
Przykład

get_count 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| text-search | string | query | Nie | |
| byIPFromComment | string | query | Nie | |
| filter | string | query | Nie | |
| searchFilters | string | query | Nie | |
| demo | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationAPICountCommentsResponse
Przykład

get_counts 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetBannedUsersCountResponse
Przykład

get_logs 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationAPIGetLogsResponse
Przykład

get_manual_badges 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetTenantManualBadgesResponse
Przykład

get_manual_badges_for_user 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Response
Zwraca: GetUserManualBadgesResponse
Przykład

get_moderation_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| includeEmail | boolean | query | Nie | |
| includeIP | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Returns: ModerationAPICommentResponse
Przykład

get_moderation_comment_text 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Response
Returns: GetCommentTextResponse
Example

get_pre_ban_summary 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| includeByUserIdAndEmail | boolean | query | Nie | |
| includeByIP | boolean | query | Nie | |
| includeByEmailDomain | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PreBanSummary
Przykład

get_search_comments_summary 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| value | string | query | Nie | |
| filters | string | query | Nie | |
| searchFilters | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Returns: ModerationCommentSearchResponse
Example

get_search_pages 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
Zwraca: ModerationPageSearchResponse
Przykład

get_search_sites 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| value | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationSiteSearchResponse
Przykład

get_search_suggest 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| text-search | string | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: ModerationSuggestResponse
Example

get_search_users 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
Zwraca: ModerationUserSearchResponse
Example

get_trust_factor 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserTrustFactorResponse
Przykład

get_user_ban_preference 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIModerateGetUserBanPreferencesResponse
Przykład

get_user_internal_profile 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserInternalProfileResponse
Przykład

post_adjust_comment_votes 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: AdjustVotesResponse
Przykład

post_api_export 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| text-search | string | query | Nie | |
| byIPFromComment | string | query | Nie | |
| filters | string | query | Nie | |
| searchFilters | string | query | Nie | |
| sorts | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationExportResponse
Przykład

post_ban_user_from_comment 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Response
Zwraca: BanUserFromCommentResult
Example

post_ban_user_undo 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

post_bulk_pre_ban_summary 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| includeByUserIdAndEmail | boolean | query | Nie | |
| includeByIP | boolean | query | Nie | |
| includeByEmailDomain | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: BulkPreBanSummary
Przykład

post_comments_by_ids 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationAPIChildCommentsResponse
Przykład

post_flag_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

post_remove_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PostRemoveCommentApiResponse
Przykład

post_restore_deleted_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

post_set_comment_approval_status 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: SetCommentApprovedResponse
Przykład

post_set_comment_review_status 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

post_set_comment_spam_status 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

post_set_comment_text 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SetCommentTextResponse
Przykład

post_un_flag_comment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

post_vote 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| direction | string | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Returns: VoteResponse
Przykład

put_award_badge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| badgeId | string | zapytanie | Tak | |
| userId | string | zapytanie | Nie | |
| commentId | string | zapytanie | Nie | |
| broadcastId | string | zapytanie | Nie | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: AwardUserBadgeResponse
Przykład

put_close_thread 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

put_remove_badge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Zwraca: RemoveUserBadgeResponse
Example

put_reopen_thread 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

set_trust_factor 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| trustFactor | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SetUserTrustFactorResponse
Przykład

create_moderator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateModeratorResponse
Przykład

delete_moderator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sendEmail | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_moderator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetModeratorResponse
Przykład

get_moderators 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| skip | number | zapytanie | Nie |
Response
Zwraca: GetModeratorsResponse
Przykład

send_invite 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| fromName | string | query | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

update_moderator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

delete_notification_count 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_cached_notification_count 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetCachedNotificationCountResponse
Przykład

get_notification_count 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Response
Zwraca: GetNotificationCountResponse
Example

get_notifications 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| urlId | string | query | Nie | |
| fromCommentId | string | query | Nie | |
| viewed | boolean | query | Nie | |
| type | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetNotificationsResponse
Przykład

update_notification 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

create_v1_page_react 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| title | string | query | Nie |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

create_v2_page_react 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| id | string | query | Tak | |
| title | string | query | Nie |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

delete_v1_page_react 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

delete_v2_page_react 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

get_v1_page_likes 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetV1PageLikes
Przykład

get_v2_page_react_users 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| id | string | query | Tak |
Odpowiedź
Zwraca: GetV2PageReactUsersResponse
Przykład

get_v2_page_reacts 
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetV2PageReacts
Przykład

add_page 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Response
Zwraca: AddPageAPIResponse
Przykład

delete_page 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: DeletePageAPIResponse
Przykład

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 "Członkowie" 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 | Tak | |
| urlId | string | query | Tak | Identyfikator URL strony (czyszczony po stronie serwera). |
| afterName | string | query | Nie | Kursor: przekaż nextAfterName z poprzedniej odpowiedzi. |
| afterUserId | string | query | Nie | Kursor‑rozstrzygnięcie: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy ustawiono afterName, aby powiązania nazw nie pomijały wpisów. |
Odpowiedź
Returns: PageUsersOfflineResponse
Przykład

get_online_users 
Obecnie online widzowie strony: osoby, których sesja websocket jest subskrybowana do tej strony w tej chwili.
Zwraca anonCount + totalCount (subskrybenci całego pokoju, w tym anonimowi widzowie, których nie wymieniamy).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identyfikator URL strony (oczyszczony po stronie serwera). |
| afterName | string | query | No | Kursor: przekaż nextAfterName z poprzedniej odpowiedzi. |
| afterUserId | string | query | No | Tiebreaker kursora: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy afterName jest ustawione, aby nie tracić rekordów przy remisie nazw. |
Response
Zwraca: PageUsersOnlineResponse
Example

get_page_by_urlid 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetPageByURLIdAPIResponse
Przykład

get_pages 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetPagesAPIResponse
Przykład

get_pages_public 
Wyświetla listę stron dla najemcy. Używane przez klienta desktopowego FChat do wypełniania jego listy pokoi.
Wymaga, aby enableFChat było ustawione na true w rozwiązanej niestandardowej konfiguracji dla każdej strony.
Strony, które wymagają SSO, są filtrowane w oparciu o dostęp grupowy użytkownika żądającego.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Nietransparentny kursor paginacji zwrócony jako nextCursor z poprzedniego żądania. Powiązany z tym samym sortBy. |
| limit | integer | query | No | 1..200, domyślnie 50 |
| q | string | query | No | Opcjonalny filtr prefiksu tytułu nie uwzględniający wielkości liter. |
| sortBy | string | query | No | Kolejność sortowania. updatedAt (domyślnie, najnowsze najpierw), commentCount (najwięcej komentarzy najpierw) lub title (alfabetycznie). |
| hasComments | boolean | query | No | Jeśli true, zwróć tylko strony z co najmniej jednym komentarzem. |
Odpowiedź
Returns: GetPublicPagesResponse
Przykład

get_users_info 
Informacje zbiorcze o użytkownikach dla tenant'a. Dla podanych userIds zwraca informacje wyświetlane z User / SSOUser. Używane przez widżet komentarzy do wzbogacania użytkowników, którzy właśnie pojawili się na skutek zdarzenia obecności. Brak kontekstu strony: prywatność jest egzekwowana jednolicie (prywatne profile są maskowane).
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| ids | string | query | Tak | userIds rozdzielone przecinkami. |
Odpowiedź
Zwraca: PageUsersInfoResponse
Przykład

patch_page 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: PatchPageAPIResponse
Przykład

delete_pending_webhook_event 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_pending_webhook_event_count 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie |
Odpowiedź
Returns: GetPendingWebhookEventCountResponse
Przykład

get_pending_webhook_events 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetPendingWebhookEventsResponse
Przykład

create_question_config 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionConfigResponse
Przykład

delete_question_config 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_question_config 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionConfigResponse
Przykład

get_question_configs 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionConfigsResponse
Przykład

update_question_config 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

create_question_result 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionResultResponse
Przykład

delete_question_result 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_question_result 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionResultResponse
Przykład

get_question_results 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| startDate | string | query | Nie | |
| questionId | string | query | Nie | |
| questionIds | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionResultsResponse
Przykład

update_question_result 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

aggregate_question_results 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| questionId | string | query | Nie | |
| questionIds | array | query | Nie | |
| urlId | string | query | Nie | |
| timeBucket | string | query | Nie | |
| startDate | string | query | Nie | |
| forceRecalculate | boolean | query | Nie |
Odpowiedź
Zwraca: AggregateQuestionResultsResponse
Przykład

bulk_aggregate_question_results 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| forceRecalculate | boolean | query | Nie |
Odpowiedź
Zwraca: BulkAggregateQuestionResultsResponse
Przykład

combine_comments_with_question_results 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Odpowiedź
Zwraca: CombineQuestionResultsWithCommentsResponse
Przykład

add_sso_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: AddSSOUserAPIResponse
Przykład

delete_sso_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | boolean | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: DeleteSSOUserAPIResponse
Przykład

get_sso_user_by_email 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| string | path | Tak |
Odpowiedź
Zwraca: GetSSOUserByEmailAPIResponse
Przykład

get_sso_user_by_id 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak |
Odpowiedź
Zwraca: GetSSOUserByIdAPIResponse
Przykład

get_sso_users 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | integer | query | Nie |
Odpowiedź
Zwraca: GetSSOUsersResponse
Przykład

patch_sso_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PatchSSOUserAPIResponse
Przykład

put_sso_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PutSSOUserAPIResponse
Przykład

create_subscription 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateSubscriptionAPIResponse
Przykład

delete_subscription 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: DeleteSubscriptionAPIResponse
Przykład

get_subscriptions 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: GetSubscriptionsAPIResponse
Przykład

update_subscription 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: UpdateSubscriptionAPIResponse
Przykład

get_tenant_daily_usages 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| yearNumber | number | query | Nie | |
| monthNumber | number | query | Nie | |
| dayNumber | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantDailyUsagesResponse
Przykład

create_tenant_package 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantPackageResponse
Przykład

delete_tenant_package 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_tenant_package 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantPackageResponse
Przykład

get_tenant_packages 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Response
Zwraca: GetTenantPackagesResponse
Przykład

replace_tenant_package 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

update_tenant_package 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

create_tenant_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantUserResponse
Przykład

delete_tenant_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | string | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_tenant_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantUserResponse
Przykład

get_tenant_users 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantUsersResponse
Przykład

replace_tenant_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

send_login_link 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| redirectURL | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

update_tenant_user 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

create_tenant 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantResponse
Przykład

delete_tenant 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sure | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

get_tenant 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantResponse
Przykład

get_tenants 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| meta | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantsResponse
Przykład

update_tenant 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

change_ticket_state 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: ChangeTicketStateResponse
Przykład

create_ticket 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Tak |
Odpowiedź
Zwraca: CreateTicketResponse
Przykład

get_ticket 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: GetTicketResponse
Przykład

get_tickets 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Odpowiedź
Zwraca: GetTicketsResponse
Przykład

get_translations 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Odpowiedź
Returns: GetTranslationsResponse
Przykład

upload_image 
Upload and resize an image
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Preset rozmiaru: "Default" (1000x1000px) lub "CrossPlatform" (tworzy rozmiary dla popularnych urządzeń) |
| urlId | string | query | No | Id strony, z której odbywa się upload, aby skonfigurować |
Response
Returns: UploadImageResponse
Example

get_user_badge_progress_by_id 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIGetUserBadgeProgressResponse
Przykład

get_user_badge_progress_by_user_id 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | path | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeProgressResponse
Przykład

get_user_badge_progress_list 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: APIGetUserBadgeProgressListResponse
Przykład

create_user_badge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: APICreateUserBadgeResponse
Przykład

delete_user_badge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptySuccessResponse
Przykład

get_user_badge 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeResponse
Przykład

get_user_badges 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: APIGetUserBadgesResponse
Przykład

update_user_badge 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptySuccessResponse
Przykład

get_user_notification_count 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserNotificationCountResponse
Przykład

get_user_notifications 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Używany do określenia, czy bieżąca strona jest subskrybowana. |
| 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 |
Odpowiedź
Zwraca: GetMyNotificationsResponse
Przykład

reset_user_notification_count 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: ResetUserNotificationsResponse
Przykład

reset_user_notifications 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: ResetUserNotificationsResponse
Example

update_user_notification_comment_subscription_status 
Włącz lub wyłącz powiadomienia dla określonego komentarza.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| notificationId | string | path | Tak | |
| optedInOrOut | string | path | Tak | |
| commentId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationCommentSubscriptionStatusResponse
Przykład

update_user_notification_page_subscription_status 
Włączanie lub wyłączanie powiadomień dla strony. Gdy użytkownicy są subskrybowani na stronę, powiadomienia są tworzone dla nowych komentarzy głównych, oraz także
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| url | string | query | Tak | |
| pageTitle | string | query | Tak | |
| subscribedOrUnsubscribed | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationPageSubscriptionStatusResponse
Przykład

update_user_notification_status 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| notificationId | string | path | Tak | |
| newStatus | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatusResponse
Przykład

get_user_presence_statuses 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlIdWS | string | query | Tak | |
| userIds | string | query | Tak |
Odpowiedź
Zwraca: GetUserPresenceStatusesResponse
Przykład

search_users 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| usernameStartsWith | string | query | Nie | |
| mentionGroupIds | array | query | Nie | |
| sso | string | query | Nie | |
| searchSection | string | query | Nie |
Odpowiedź
Zwraca: SearchUsersResult
Przykład

get_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserResponse
Przykład

create_vote 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odpowiedź
Zwraca: VoteResponse
Przykład

delete_vote 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| editKey | string | query | Nie |
Odpowiedź
Zwraca: VoteDeleteResponse
Przykład

get_votes 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetVotesResponse
Przykład

get_votes_for_user 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: GetVotesForUserResponse
Przykład

Potrzebujesz pomocy?
Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące SDK Pythona, prosimy:
Contributing
Wkład jest mile widziany! Proszę odwiedzić repozytorium GitHub w celu zapoznania się z wytycznymi dotyczącymi kontrybucji.