
Język 🇵🇱 Polski
Pierwsze kroki
Dokumentacja
Agregacja
Logi audytu
Autoryzacja
Blokowanie z Komentarza
Sprawdź zablokowane komentarze
Komentarze
Komentarze Użytkownika
Konfiguracje domen
Szablony e-mail
Log zdarzeń
Posty kanału
Oznacz komentarz
Gify
Tagi
Moderacja
Moderatorzy
Licznik powiadomień
Powiadomienia
Reakcje strony
Strony
Oczekujące zdarzenia webhook
Konfiguracje pytań
Wyniki pytań
Agregacja wyników pytań
Użytkownicy SSO
Subskrypcje
Dzienne zużycie najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Zgłoszenia
Tłumaczenia
Przesyłanie obrazu
Postępy odznak użytkownika
Odznaki użytkownika
Powiadomienia użytkownika
Status obecności użytkownika
Wyszukiwanie użytkownika
Użytkownicy
Głosy
FastComments Python SDK
To jest oficjalne SDK Pythona dla FastComments.
Oficjalne SDK Pythona dla API FastComments
Repozytorium
Instalacja 
Instalacja z GitHub
Instaluj bezpośrednio z tagu wydania (zalecane, w pełni powtarzalne):
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Zaciągnij tag zamiast gałęzi, aby budowy były deterministyczne. Ten sam format działa w requirements.txt:
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Każde otagowane GitHub Release ma również dołączony zbudowany wheel, jeśli wolisz zainstalować binarny artefakt bezpośrednio.
Zawartość Biblioteki
Ta biblioteka zawiera dwa moduły: wygenerowanego klienta API oraz rdzeniową 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, które wymagają Twojego klucza API, a PublicApi zawiera metody, które mogą być wywoływane bezpośrednio z przeglądarki/urządzenia mobilnego/etc bez uwierzytelnienia. ModerationApi zapewnia rozbudowany zestaw szybkich i działających w czasie rzeczywistym API moderacji. Każda metoda ModerationApi przyjmuje parametr sso i może uwierzytelnić się za pomocą SSO lub cookie sesji FastComments.com.
Szybki start 
Korzystanie z uwierzytelnionych API (DefaultApi)
Ważne: Musisz ustawić swój klucz API w Configuration 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 przy użyciu skonfigurowanego klienta
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: Niepowodzenie walidacji żądania
Korzystanie z publicznych API (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}")
Korzystanie z panelu moderacji (ModerationApi)
ModerationApi obsługuje 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}")
Korzystanie z 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 używając swojego sekretu 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ż do wywołań API
print(f"SSO Token: {sso_token}")
For simple SSO (less secure, for testing):
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()
Typowe problemy
- 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 żądań uwierzytelnionych 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 ...
- Klient API:
Notatki 
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.
Wymagania 
- Python >= 3.8
Podstawowa instalacja jest czystą biblioteką standardową i udostępnia narzędzia SSO. Wygenerowany klient API (DefaultApi/PublicApi/ModerationApi) wymaga dodatku 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.0.0"
agreguj 
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

pobierz_logi_audytu 
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

wyloguj_publiczny 
Response
Zwraca: APIEmptyResponse
Przykład

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

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

sprawdzone_komentarze_zablokowane 
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

zablokuj_uzytkownika_z_komentarza 
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

utworz_komentarz_publiczny 
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

usuń_komentarz 
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

usuń_komentarz_publiczny 
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

usuń_glos_komentarza 
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

oznacz_komentarz 
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

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

pobierz_tresc_komentarza 
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

pobierz_uzytkownikow_glosujacych_na_komentarz 
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

pobierz_komentarze 
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

pobierz_komentarze_publiczne 
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

zablokuj_komentarz 
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

przypnij_komentarz 
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

zapisz_komentarz 
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

zapisz_komentarze_hurtowo 
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

ustaw_tresc_komentarza 
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

odblokuj_uzytkownika_z_komentarza 
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

odznacz_komentarz 
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

odblokuj_komentarz 
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

odepnij_komentarz 
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

aktualizuj_komentarz 
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

zaglosuj_komentarz 
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

pobierz_komentarze_uzytkownika 
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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pobierz_log_zdarzen 
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

pobierz_globalny_log_zdarzen 
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

utworz_post_kanalu 
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

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

usuń_post_kanalu_publiczny 
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

pobierz_posty_kanalu 
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

pobierz_posty_kanalu_publiczne 
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

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

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

reakcja_post_kanalu_publiczny 
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

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

aktualizuj_post_kanalu_publiczny 
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

oznacz_komentarz_publiczny 
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

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

wyszukaj_gify 
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

pobierz_modne_gify 
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

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

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

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

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

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

usuń_glos_moderacji 
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

pobierz_api_komentarze 
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

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

pobierz_api_id 
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

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

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

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

pobierz_liczbe 
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

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

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

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

pobierz_manualne_odznaki_uzytkownika 
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

pobierz_komentarz_moderacji 
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

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

pobierz_podsumowanie_przed_banem 
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

pobierz_podsumowanie_wyszukiwanych_komentarzy 
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

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

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

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

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

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

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

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

dostosuj_liczby_glosow_komentarza 
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

wyeksportuj_api 
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

zbanuj_uzytkownika_z_komentarza 
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

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

hurtowe_podsumowanie_przed_banem 
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

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

oznacz_komentarz_flaga 
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

usuń_komentarz_2 
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

przywroc_usuniety_komentarz 
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

ustaw_status_akceptacji_komentarza 
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

ustaw_status_recenzji_komentarza 
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

ustaw_status_spamu_komentarza 
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

ustaw_tresc_komentarza_2 
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

usun_oznaczenie_flaga 
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

zaglosuj 
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

przyznaj_odznake 
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

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

usuń_odznake 
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

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

ustaw_wspolczynnik_zaufania 
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

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

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

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

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

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

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

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

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

pobierz_licznik_powiadomień 
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

pobierz_powiadomienia 
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

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

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

dodaj_reakcję_strony_v2 
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

usuń_reakcję_strony_v1 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

usuń_reakcję_strony_v2 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

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

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

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

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

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

pobierz_uzytkownikow_offline 
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

pobierz_uzytkownikow_online 
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

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

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

pobierz_strony_publiczne 
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

pobierz_informacje_o_uzytkownikach 
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

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

usuń_oczekujące_zdarzenie_webhook 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierz_licznik_oczekujących_zdarzeń_webhook 
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

pobierz_oczekujące_zdarzenia_webhook 
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

utwórz_konfigurację_pytania 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionConfigResponse
Przykład

usuń_konfigurację_pytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

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

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

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

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

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

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

pobierz_wyniki_pytan 
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

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

agreguj_wyniki_pytan 
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

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

polacz_komentarze_z_wynikami_pytan 
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

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

usuń_uzytkownika_sso 
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

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

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

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

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

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

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

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

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

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

pobierz_dzienne_uzycie_najemcy 
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

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

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

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

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

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

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

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

usuń_uzytkownika_najemcy 
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

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

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

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

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

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

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

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

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

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

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

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

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

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

pobierz_zgłoszenia 
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

pobierz_tłumaczenia 
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

prześlij_obraz 
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

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

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

pobierz_liste_postepow_odznak_uzytkownika 
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

utwórz_odznakę_uzytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: APICreateUserBadgeResponse
Przykład

usuń_odznakę_uzytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptySuccessResponse
Przykład

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

pobierz_odznaki_uzytkownika 
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

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

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

pobierz_powiadomienia_uzytkownika 
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

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

zresetuj_powiadomienia_uzytkownika 
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

aktualizuj_status_subskrypcji_komentarza_powiadomienie_uzytkownika 
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

aktualizuj_status_subskrypcji_strony_powiadomienie_uzytkownika 
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

aktualizuj_status_powiadomienia_uzytkownika 
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

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

wyszukaj_uzytkownikow 
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

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

utwórz_glos 
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

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

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

pobierz_glosy_uzytkownika 
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.