
Język 🇵🇱 Polski
Dokumentacja
Rozpoczęcie
Referencja API
Użycie
Agregacja
Logi audytu
Uwierzytelnianie
Blokowanie z komentarza
Sprawdź zablokowane komentarze
Komentarze
Komentarze dla użytkownika
Konfiguracje domen
Szablony e‑mail
Log wydarzeń
Posty w kanale
Oznacz komentarz
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
Dzienny użytek najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Zgłoszenia
Tłumaczenia
Przesyłanie obrazu
Postęp odznak użytkownika
Odznaki użytkownika
Powiadomienia użytkownika
Statusy obecności użytkownika
Wyszukiwanie użytkowników
Użytkownicy
Głosy
FastComments C++ SDK
Oto oficjalne SDK C++ dla FastComments.
Oficjalne SDK C++ dla API FastComments
Repozytorium
Agenci kodowania AI 
Daj swojemu agentowi kodującemu 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 i każdym innym agentem, który obsługuje skills CLI.
Wymagania 
- C++17 lub nowszy
- CMake 3.14 lub nowszy
- OpenSSL
- C++ REST SDK (cpprestsdk)
- Boost
- Google Test (automatycznie pobierany do testów)
Instalacja 
Instalacja zależności
sudo apt install libcpprest-dev libboost-all-dev
Budowanie ze źródła
mkdir build
cd build
cmake ..
make
Instalacja
sudo make install
Zawartość biblioteki
Ta biblioteka zawiera wygenerowanego klienta API oraz narzędzia SSO, które ułatwiają pracę z API.
Publiczne vs Zabezpieczone API
Dla klienta API istnieją trzy klasy: DefaultApi, PublicApi i ModerationApi. DefaultApi zawiera metody, które wymagają klucza API, a PublicApi zawiera
metody, które mogą być wywoływane bezpośrednio z przeglądarki/urządzenia mobilnego itp. bez uwierzytelnienia. ModerationApi oferuje rozbudowany zestaw szybkich i bieżących interfejsów moderacji. Każda metoda ModerationApi przyjmuje parametr sso i może uwierzytelnić się za pomocą SSO lub pliku cookie sesji FastComments.com.
Szybki start 
Using Authenticated APIs (DefaultAPI)
Ważne:
- Musisz ustawić podstawowy URL (generator cpp-restsdk nie odczytuje go z specyfikacji OpenAPI)
- Musisz ustawić swój klucz API w ApiClient przed wykonywaniem uwierzytelnionych żądań. Jeśli tego nie zrobisz, żądania zakończą się błędem 401.
#include <iostream>
#include "FastCommentsClient/api/DefaultApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// WYMAGANE: Ustaw podstawowy URL (wybierz swój region)
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com")); // US
// LUB: config->setBaseUrl(utility::conversions::to_string_t("https://eu.fastcomments.com")); // EU
// WYMAGANE: Ustaw swój klucz API
config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_API_KEY_HERE"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// Teraz wykonaj uwierzytelnione wywołania API
return 0;
}
Using Public APIs (PublicAPI)
Publiczne endpointy nie wymagają uwierzytelnienia:
#include <iostream>
#include "FastCommentsClient/api/PublicApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// WYMAGANE: Ustaw podstawowy URL
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::PublicApi publicApi(apiClient);
// Wykonaj publiczne wywołania API
return 0;
}
Using Moderation APIs (ModerationApi)
API ModerationApi napędza panel moderatora. Każda metoda przyjmuje parametr sso, więc wywołanie jest wykonywane w imieniu moderatora uwierzytelnionego przez SSO (zobacz sekcję SSO poniżej, aby dowiedzieć się, jak utworzyć token):
#include <iostream>
#include "FastCommentsClient/api/ModerationApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// WYMAGANE: Ustaw podstawowy URL
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::ModerationApi moderationApi(apiClient);
// Przekaż token SSO moderatora, aby uwierzytelnić wywołanie
auto ssoToken = utility::conversions::to_string_t("YOUR_MODERATOR_SSO_TOKEN");
org::openapitools::client::api::GetCountOptions options;
options.sso = ssoToken;
auto response = moderationApi.getCount(options).get();
return 0;
}
Common Issues
- Błąd "URI must contain a hostname": Upewnij się, że wywołujesz
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"))przed utworzeniem ApiClient. Generator cpp-restsdk nie odczytuje automatycznie URL serwera z specyfikacji OpenAPI. - Błąd 401 "missing-api-key": Upewnij się, że wywołujesz
config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_KEY"))przed utworzeniem instancji DefaultAPI. - Nieprawidłowa klasa API: Użyj
DefaultApidla żądań uwierzytelnionych po stronie serwera,PublicApidla żądań po stronie klienta/publicznych, orazModerationApidla żądań panelu moderatora (uwierzytelnionych tokenem SSO moderatora).
Wywoływanie API: synchroniczne vs asynchroniczne 
Wszystkie metody API w tym SDK zwracają pplx::task<std::shared_ptr<ResponseType>> z C++ REST SDK. Daje to elastyczność w tym, jak obsługujesz odpowiedzi API.
Wywołania synchroniczne przy użyciu .get()
Użyj .get(), aby zablokować wywołujący wątek aż żądanie zostanie zakończone i pobrać wynik synchronicznie:
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
utility::conversions::to_string_t("YOUR_API_KEY"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// Required parameters are positional; optional ones go in the options struct
org::openapitools::client::api::GetCommentsOptions options;
options.urlId = utility::conversions::to_string_t("your-url-id");
// Call .get() to block and get the result synchronously
auto response = api.getComments(
utility::conversions::to_string_t("your-tenant-id"),
options
).get(); // Blokuje do momentu zakończenia żądania HTTP
if (response && response->comments) {
std::cout << "Found " << response->comments->size() << " comments" << std::endl;
}
Wywołania asynchroniczne przy użyciu .then()
Użyj .then(), aby wykonać nieblokujące asynchroniczne wywołanie z funkcjami zwrotnymi:
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
utility::conversions::to_string_t("YOUR_API_KEY"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// Required parameters are positional; optional ones go in the options struct
org::openapitools::client::api::GetCommentsOptions options;
options.urlId = utility::conversions::to_string_t("your-url-id");
// Use .then() for asynchronous callback-based execution
api.getComments(
utility::conversions::to_string_t("your-tenant-id"),
options
).then([](std::shared_ptr<GetComments_200_response> response) {
// To zostaje wykonane asynchronicznie po zakończeniu żądania
if (response && response->comments) {
std::cout << "Found " << response->comments->size() << " comments" << std::endl;
}
});
// Execution continues immediately without blocking
std::cout << "Request sent, continuing..." << std::endl; // Wykonanie kontynuuje się natychmiast bez blokowania
Wybór pomiędzy synchronicznym a asynchronicznym
Wybór zależy od środowiska uruchomieniowego i architektury aplikacji:
.get() (Synchronous blocking)
- Blokuje wywołujący wątek aż żądanie HTTP zostanie zakończone
- Prostszy przepływ kodu, łatwiejszy do zrozumienia
- Odpowiedni dla dedykowanych wątków roboczych, przetwarzania wsadowego lub narzędzi wiersza poleceń
- Nieodpowiedni dla pętli zdarzeń, wątków GUI lub serwerów jednowątkowych
.then() (Asynchronous non-blocking)
- Zwraca natychmiast, funkcja zwrotna jest wywoływana po zakończeniu żądania
- Nie blokuje wywołującego wątku
- Wymagany w architekturach zdarzeniowych, aplikacjach GUI lub jednowątkowych pętlach zdarzeń
- Umożliwia łączenie wielu operacji
- Bardziej złożony przepływ sterowania
Zestaw testów SDK używa wyłącznie .get(), ale jest to odpowiednie dla środowiska testowego, w którym blokowanie jest dopuszczalne.
Notatki 
Identyfikatory Broadcast
Zauważysz, że w niektórych wywołaniach API trzeba przekazać broadcastId. Gdy otrzymasz zdarzenia, otrzymasz z powrotem ten identyfikator, dzięki czemu będziesz mógł zignorować zdarzenie, jeśli planujesz optymistycznie zastosować zmiany po stronie klienta
(na co prawdopodobnie zechcesz się zdecydować, ponieważ zapewnia to najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być na tyle unikalny, aby nie wystąpił dwukrotnie w sesji przeglądarki.
SSO (logowanie jednokrotne)
Przykłady SSO znajdziesz poniżej.
Użycie SSO 
Proste SSO
#include <fastcomments/sso/fastcomments_sso.hpp>
#include <iostream>
using namespace fastcomments::sso;
int main() {
SimpleSSOUserData user("user-123", "user@example.com", "https://example.com/avatar.jpg");
FastCommentsSSO sso = FastCommentsSSO::newSimple(user);
std::string token = sso.createToken();
std::cout << "SSO Token: " << token << std::endl;
return 0;
}
Bezpieczne SSO
#include <fastcomments/sso/fastcomments_sso.hpp>
#include <iostream>
using namespace fastcomments::sso;
int main() {
SecureSSOUserData user("user-123", "user@example.com", "johndoe", "https://example.com/avatar.jpg");
std::string apiKey = "your-api-key";
FastCommentsSSO sso = FastCommentsSSO::newSecure(apiKey, user);
std::string token = sso.createToken();
std::cout << "Secure SSO Token: " << token << std::endl;
return 0;
}
Dokumentacja dla FastComments 
Documentation for API Endpoints
All URIs are relative to https://fastcomments.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported. |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | req tenantId afterId |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/mod_api/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/mod_api/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/mod_api/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/mod_api/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/mod_api/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/mod_api/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/mod_api/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/mod_api/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/mod_api/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/mod_api/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/mod_api/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/mod_api/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/mod_api/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/mod_api/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/mod_api/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/mod_api/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/mod_api/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/mod_api/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/mod_api/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/mod_api/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/mod_api/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/mod_api/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/mod_api/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | req tenantId urlId |
| PublicApi | getEventLog | GET /event-log/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | req tenantId afterId |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost. |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate). |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires enableFChat to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access. |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | getUsersInfo | GET /pages/{tenantId}/users/info | Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked). |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | Enable or disable notifications for a specific comment. |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | Upload and resize an image |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Documentation for Models
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBase_meta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponse_anyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequest_sort
- AggregationResponse
- AggregationResponse_stats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchType
- BannedUserMatch_matchedOnValue
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBody_tags_inner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponse_results_inner
- BulkPreBanParams
- BulkPreBanSummary
- ChangeCommentPinStatusResponse
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CommentsByIdsParams
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPostParams
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadgeParams
- CreateV1PageReact
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentResult
- DeleteDomainConfigResponse
- DeleteFeedPostPublicResponse
- DeleteHashTagRequestBody
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FComment_meta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentResponse
- GetAuditLogsResponse
- GetBannedUsersCountResponse
- GetBannedUsersFromCommentResponse
- GetCachedNotificationCountResponse
- GetCommentBanStatusResponse
- GetCommentTextResponse
- GetCommentVoteUserNamesSuccessResponse
- GetCommentsForUserResponse
- GetCommentsResponseWithPresence_PublicComment_
- GetCommentsResponse_PublicComment_
- GetDomainConfigResponse
- GetDomainConfigsResponse
- GetDomainConfigsResponse_anyOf
- GetDomainConfigsResponse_anyOf_1
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplatesResponse
- GetEventLogResponse
- GetFeedPostsResponse
- GetGifsSearchResponse
- GetGifsTrendingResponse
- GetHashTagsResponse
- GetModeratorResponse
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCountResponse
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetPublicPagesResponse
- GetQuestionConfigResponse
- GetQuestionConfigsResponse
- GetQuestionResultResponse
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsersResponse
- GetSubscriptionsAPIResponse
- GetTenantDailyUsagesResponse
- GetTenantManualBadgesResponse
- GetTenantPackageResponse
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUserResponse
- GetTenantUsersResponse
- GetTenantsResponse
- GetTicketResponse
- GetTicketsResponse
- GetTranslationsResponse
- GetUserInternalProfileResponse
- GetUserInternalProfileResponse_profile
- GetUserManualBadgesResponse
- GetUserNotificationCountResponse
- GetUserPresenceStatusesResponse
- GetUserResponse
- GetUserTrustFactorResponse
- GetV1PageLikes
- GetV2PageReactUsersResponse
- GetV2PageReacts
- GetVotesForUserResponse
- GetVotesResponse
- GifGetLargeResponse
- GifRating
- GifSearchInternalError
- GifSearchResponse
- GifSearchResponse_images_inner_inner
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAgentApprovalNotificationFrequency
- ImportedSiteType
- LiveEvent
- LiveEventType
- LiveEvent_extraInfo
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- ModerationAPIChildCommentsResponse
- ModerationAPIComment
- ModerationAPICommentLog
- ModerationAPICommentResponse
- ModerationAPICountCommentsResponse
- ModerationAPIGetCommentIdsResponse
- ModerationAPIGetCommentsResponse
- ModerationAPIGetLogsResponse
- ModerationCommentSearchResponse
- ModerationExportResponse
- ModerationExportStatusResponse
- ModerationFilter
- ModerationPageSearchProjected
- ModerationPageSearchResponse
- ModerationSiteSearchProjected
- ModerationSiteSearchResponse
- ModerationSuggestResponse
- ModerationUserSearchProjected
- ModerationUserSearchResponse
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PageUserEntry
- PageUsersInfoResponse
- PageUsersOfflineResponse
- PageUsersOnlineResponse
- PagesSortBy
- PatchDomainConfigParams
- PatchDomainConfigResponse
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PostRemoveCommentApiResponse
- PreBanSummary
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicPage
- PublicVote
- PutDomainConfigResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicate_value
- QuestionConfig
- QuestionConfig_customOptions_inner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostResponse
- Record_string__before_string_or_null__after_string_or_null___value
- RemoveCommentActionResponse
- RemoveUserBadgeResponse
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotificationsResponse
- SORT_DIR
- SSOSecurityLevel
- SaveCommentResponseOptimized
- SaveCommentsBulkResponse
- SaveCommentsResponseWithPresence
- SearchUsersResponse
- SearchUsersResult
- SearchUsersSectionedResponse
- SetCommentApprovedResponse
- SetCommentTextParams
- SetCommentTextResponse
- SetCommentTextResult
- SetUserTrustFactorResponse
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantBadge
- TenantHashTag
- TenantPackage
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadgeParams
- UpdateUserNotificationCommentSubscriptionStatusResponse
- UpdateUserNotificationPageSubscriptionStatusResponse
- UpdateUserNotificationStatusResponse
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- UsersListLocation
- VoteBodyParams
- VoteDeleteResponse
- VoteResponse
- VoteResponseUser
- VoteStyle
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
Agregacja 
Aggreguje dokumenty, grupując je (jeśli podano groupBy) i stosując wiele operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg itp.).
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| aggregationRequest | AggregationRequest | Tak | |
| options | const AggregateOptions& | Tak |
Odpowiedź
Zwraca: AggregateResponse
Przykład

pobierzLogiAudytu 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetAuditLogsOptions& | Yes |
Odpowiedź
Zwraca: GetAuditLogsResponse
Przykład

wylogujPublicznie 
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

zablokujZKomentarzaPublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: BlockSuccess
Przykład

odblokujKomentarzPublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: UnblockSuccess
Przykład

sprawdzoneKomentarzeDlaZablokowanych 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentIds | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: CheckBlockedCommentsResponse
Przykład

zablokujUżytkownikaZKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| blockFromCommentParams | BlockFromCommentParams | Tak | |
| options | const BlockUserFromCommentOptions& | Tak |
Odpowiedź
Zwraca: BlockSuccess
Przykład

utwórzKomentarzPublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak | |
| broadcastId | string | Tak | |
| commentData | CommentData | Tak | |
| options | const CreateCommentPublicOptions& | Tak |
Odpowiedź
Zwraca: SaveCommentsResponseWithPresence
Przykład

usuńKomentarz 
Parametry
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| options | const DeleteCommentOptions& | Yes |
Odpowiedź
Zwraca: DeleteCommentResult
Przykład

usuńKomentarzPublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| broadcastId | string | Tak | |
| options | const DeleteCommentPublicOptions& | Tak |
Odpowiedź
Zwraca: PublicAPIDeleteCommentResponse
Przykład

usuńGłosKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| voteId | string | Tak | |
| urlId | string | Tak | |
| broadcastId | string | Tak | |
| options | const DeleteCommentVoteOptions& | Tak |
Odpowiedź
Zwraca: VoteDeleteResponse
Przykład

oznaczKomentarz 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| options | const FlagCommentOptions& | Yes |
Odpowiedź
Zwraca: FlagCommentResponse
Przykład

pobierzKomentarz 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Odpowiedź
Zwraca: APIGetCommentResponse
Przykład

pobierzKomentarze 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetCommentsOptions& | Tak |
Odpowiedź
Zwraca: APIGetCommentsResponse
Przykład

pobierzKomentarzePublicznie 
req tenantId urlId
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| options | const GetCommentsPublicOptions& | Yes |
Odpowiedź
Returns: GetCommentsResponseWithPresence_PublicComment_
Przykład

pobierzTekstKomentarza 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const GetCommentTextOptions& | Yes |
Response
Zwraca: PublicAPIGetCommentTextResponse
Example

pobierzNazwyUżytkownikówGłosówKomentarza 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| dir | int32_t | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: GetCommentVoteUserNamesSuccessResponse
Przykład

zablokujKomentarz 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | Yes | |
| sso | string | No |
Response
Zwraca: APIEmptyResponse
Example

przypnijKomentarz 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | Yes | |
| sso | string | No |
Odpowiedź
Zwraca: ChangeCommentPinStatusResponse
Przykład

zapiszKomentarz 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| createCommentParams | CreateCommentParams | Yes | |
| options | const SaveCommentOptions& | Yes |
Odpowiedź
Zwraca: APISaveCommentResponse
Przykład

ustawTekstKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | Yes | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Yes | |
| options | const SetCommentTextOptions& | Yes |
Odpowiedź
Zwraca: PublicAPISetCommentTextResponse
Przykład

odblokujUżytkownikaZKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Yes | |
| options | const UnBlockUserFromCommentOptions& | Yes |
Odpowiedź
Zwraca: UnblockSuccess
Przykład

odznaczKomentarz 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| options | const UnFlagCommentOptions& | Yes |
Odpowiedź
Zwraca: FlagCommentResponse
Przykład

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

odpinKomentarz 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | Yes | |
| sso | string | No |
Odpowiedź
Zwraca: ChangeCommentPinStatusResponse
Przykład

zaktualizujKomentarz 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| updatableCommentParams | UpdatableCommentParams | Tak | |
| options | const UpdateCommentOptions& | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

głosujZaKomentarzem 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| urlId | string | Yes | |
| broadcastId | string | Yes | |
| voteBodyParams | VoteBodyParams | Yes | |
| options | const VoteCommentOptions& | Yes |
Odpowiedź
Zwraca: VoteResponse
Przykład

pobierzKomentarzeDlaUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| options | const GetCommentsForUserOptions& | Tak |
Odpowiedź
Zwraca: GetCommentsForUserResponse
Przykład

dodajKonfiguracjęDomeny 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| addDomainConfigParams | AddDomainConfigParams | Tak |
Odpowiedź
Zwraca: AddDomainConfigResponse
Przykład

usuńKonfiguracjęDomeny 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| domain | string | Tak |
Odpowiedź
Zwraca: DeleteDomainConfigResponse
Przykład

pobierzKonfiguracjęDomeny 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| domain | string | Yes |
Response
Zwraca: GetDomainConfigResponse
Przykład

pobierzKonfiguracjeDomen 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes |
Odpowiedź
Zwraca: GetDomainConfigsResponse
Przykład

modyfikujKonfiguracjęDomeny 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| domainToUpdate | string | Yes | |
| patchDomainConfigParams | PatchDomainConfigParams | Yes |
Odpowiedź
Zwraca: PatchDomainConfigResponse
Przykład

zapiszKonfiguracjęDomeny 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| domainToUpdate | string | Yes | |
| updateDomainConfigParams | UpdateDomainConfigParams | Yes |
Odpowiedź
Zwraca: PutDomainConfigResponse
Przykład

utwórzSzablonE‑mail 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| createEmailTemplateBody | CreateEmailTemplateBody | Tak |
Response
Zwraca: CreateEmailTemplateResponse
Przykład

usuńSzablonE‑mail 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Response
Zwraca: APIEmptyResponse
Example

usuńBłądRenderowaniaSzablonuE‑mail 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| errorId | string | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierzSzablonE‑mail 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: GetEmailTemplateResponse
Przykład

pobierzDefinicjeSzablonuE‑mail 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak |
Odpowiedź
Zwraca: GetEmailTemplateDefinitionsResponse
Przykład

pobierzBłędyRenderowaniaSzablonuE‑mail 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| skip | double | Nie |
Odpowiedź
Zwraca: GetEmailTemplateRenderErrorsResponse
Przykład

pobierzSzablonyE‑mail 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| skip | double | No |
Odpowiedź
Zwraca: GetEmailTemplatesResponse
Przykład

renderujSzablonE‑mail 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Tak | |
| locale | string | Nie |
Response
Zwraca: RenderEmailTemplateResponse
Example

zaktualizujSzablonE‑mail 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierzLogWydarzeń 
req tenantId urlId userIdWS
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak | |
| userIdWS | string | Tak | |
| startTime | int64_t | Tak | |
| endTime | int64_t | Nie |
Odpowiedź
Zwraca: GetEventLogResponse
Przykład

pobierzGlobalnyLogWydarzeń 
req tenantId urlId userIdWS
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak | |
| userIdWS | string | Tak | |
| startTime | int64_t | Tak | |
| endTime | int64_t | Nie |
Odpowiedź
Zwraca: GetEventLogResponse
Przykład

utwórzPostNaKanale 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| createFeedPostParams | CreateFeedPostParams | Tak | |
| options | const CreateFeedPostOptions& | Tak |
Odpowiedź
Zwraca: CreateFeedPostsResponse
Przykład

utwórzPostNaKanalePublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| createFeedPostParams | CreateFeedPostParams | Tak | |
| options | const CreateFeedPostPublicOptions& | Tak |
Odpowiedź
Zwraca: CreateFeedPostResponse
Przykład

usuńPostNaKanalePublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| postId | string | Tak | |
| options | const DeleteFeedPostPublicOptions& | Tak |
Odpowiedź
Zwraca: DeleteFeedPostPublicResponse
Przykład

pobierzPostyNaKanale 
req tenantId afterId
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetFeedPostsOptions& | Yes |
Odpowiedź
Zwraca: GetFeedPostsResponse
Przykład

pobierzPostyNaKanalePublicznie 
req tenantId afterId
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetFeedPostsPublicOptions& | Tak |
Odpowiedź
Zwraca: PublicFeedPostsResponse
Przykład

pobierzStatystykiPostówNaKanale 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| postIds | vector<string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: FeedPostsStatsResponse
Przykład

pobierzReakcjeUżytkownikaPublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetUserReactsPublicOptions& | Tak |
Odpowiedź
Zwraca: UserReactsResponse
Przykład

zareagujNaPostNaKanalePublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| postId | string | Tak | |
| reactBodyParams | ReactBodyParams | Tak | |
| options | const ReactFeedPostPublicOptions& | Tak |
Odpowiedź
Zwraca: ReactFeedPostResponse
Przykład

zaktualizujPostNaKanale 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| feedPost | FeedPost | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

zaktualizujPostNaKanalePublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| postId | string | Yes | |
| updateFeedPostParams | UpdateFeedPostParams | Yes | |
| options | const UpdateFeedPostPublicOptions& | Yes |
Odpowiedź
Zwraca: CreateFeedPostResponse
Przykład

oznaczKomentarzPublicznie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| isFlagged | bool | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierzDużyGif 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| largeInternalURLSanitized | string | Yes |
Response
Zwraca: GifGetLargeResponse
Example

wyszukajGify 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| search | string | Yes | |
| options | const GetGifsSearchOptions& | Yes |
Odpowiedź
Zwraca: GetGifsSearchResponse
Przykład

pobierzPopularneGify 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetGifsTrendingOptions& | Tak |
Odpowiedź
Zwraca: GetGifsTrendingResponse
Przykład

dodajHashtag 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| createHashTagBody | CreateHashTagBody | Tak |
Odpowiedź
Zwraca: CreateHashTagResponse
Przykład

dodajHashtagiMasowo 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | Yes |
Odpowiedź
Zwraca: BulkCreateHashTagsResponse
Przykład

usuńHashtag 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| tag | string | Tak | |
| deleteHashTagRequestBody | DeleteHashTagRequestBody | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierzHashtagi 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| page | double | Nie |
Odpowiedź
Zwraca: GetHashTagsResponse
Przykład

modyfikujHashtag 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| tag | string | Tak | |
| updateHashTagBody | UpdateHashTagBody | Tak |
Odpowiedź
Zwraca: UpdateHashTagResponse
Przykład

usuńGłosModeracji 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| voteId | string | Yes | |
| options | const DeleteModerationVoteOptions& | Yes |
Odpowiedź
Zwraca: VoteDeleteResponse
Przykład

pobierzKomentarzeAPI 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetApiCommentsOptions& | Tak |
Odpowiedź
Zwraca: ModerationAPIGetCommentsResponse
Przykład

pobierzStatusEksportuAPI 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetApiExportStatusOptions& | Tak |
Odpowiedź
Zwraca: ModerationExportStatusResponse
Przykład

pobierzIdAPI 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetApiIdsOptions& | Tak |
Odpowiedź
Zwraca: ModerationAPIGetCommentIdsResponse
Przykład

pobierzZbanowanychUżytkownikówZKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: GetBannedUsersFromCommentResponse
Przykład

pobierzStatusBanaKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: GetCommentBanStatusResponse
Przykład

pobierzPodkomentarze 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| sso | string | No |
Response
Zwraca: ModerationAPIChildCommentsResponse
Example

pobierzLiczbę 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetCountOptions& | Tak |
Odpowiedź
Zwraca: ModerationAPICountCommentsResponse
Przykład

pobierzLiczby 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: GetBannedUsersCountResponse
Przykład

pobierzLogi 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| sso | string | Nie |
Response
Zwraca: ModerationAPIGetLogsResponse
Example

pobierzRęczneOdznaki 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: GetTenantManualBadgesResponse
Przykład

pobierzRęczneOdznakiDlaUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetManualBadgesForUserOptions& | Tak |
Odpowiedź
Zwraca: GetUserManualBadgesResponse
Przykład

pobierzKomentarzModeracji 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const GetModerationCommentOptions& | Yes |
Odpowiedź
Returns: ModerationAPICommentResponse
Przykład

pobierzTekstKomentarzaModeracji 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| sso | string | No |
Odpowiedź
Zwraca: GetCommentTextResponse
Przykład

pobierzPodsumowaniePrzedBanem 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| options | const GetPreBanSummaryOptions& | Tak |
Odpowiedź
Zwraca: PreBanSummary
Przykład

pobierzPodsumowanieWyszukiwaniaKomentarzy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetSearchCommentsSummaryOptions& | Tak |
Odpowiedź
Zwraca: ModerationCommentSearchResponse
Przykład

pobierzStronyWyszukiwania 
Parametry
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetSearchPagesOptions& | Yes |
Odpowiedź
Zwraca: ModerationPageSearchResponse
Przykład

pobierzStronyWyszukiwania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetSearchSitesOptions& | Tak |
Odpowiedź
Zwraca: ModerationSiteSearchResponse
Przykład

pobierzSugestieWyszukiwania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetSearchSuggestOptions& | Tak |
Odpowiedź
Zwraca: ModerationSuggestResponse
Przykład

pobierzUżytkownikówWyszukiwania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetSearchUsersOptions& | Tak |
Odpowiedź
Zwraca: ModerationUserSearchResponse
Przykład

pobierzWspółczynnikZaufania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetTrustFactorOptions& | Yes |
Odpowiedź
Zwraca: GetUserTrustFactorResponse
Przykład

pobierzPreferencjeBanaUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: APIModerateGetUserBanPreferencesResponse
Przykład

pobierzWewnętrznyProfilUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetUserInternalProfileOptions& | Yes |
Odpowiedź
Zwraca: GetUserInternalProfileResponse
Przykład

wyślijDostosowanieGłosówKomentarza 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| adjustCommentVotesParams | AdjustCommentVotesParams | Yes | |
| options | const PostAdjustCommentVotesOptions& | Yes |
Response
Zwraca: AdjustVotesResponse
Example

wyślijEksportAPI 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const PostApiExportOptions& | Yes |
Odpowiedź
Zwraca: ModerationExportResponse
Przykład

wyślijBanUżytkownikaZKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| options | const PostBanUserFromCommentOptions& | Tak |
Odpowiedź
Zwraca: BanUserFromCommentResult
Przykład

wyślijCofnięcieBanaUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| banUserUndoParams | BanUserUndoParams | Yes | |
| sso | string | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

wyślijMasowePodsumowaniePrzedBanem 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| bulkPreBanParams | BulkPreBanParams | Yes | |
| options | const PostBulkPreBanSummaryOptions& | Yes |
Odpowiedź
Zwraca: BulkPreBanSummary
Przykład

wyślijKomentarzePoId 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentsByIdsParams | CommentsByIdsParams | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: ModerationAPIChildCommentsResponse
Przykład

wyślijOznaczenieKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostFlagCommentOptions& | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

wyślijUsunięcieKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostRemoveCommentOptions& | Yes |
Odpowiedź
Zwraca: PostRemoveCommentApiResponse
Przykład

wyślijPrzywrócenieUsuniętegoKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| options | const PostRestoreDeletedCommentOptions& | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

wyślijUstawStatusZatwierdzeniaKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostSetCommentApprovalStatusOptions& | Yes |
Odpowiedź
Zwraca: SetCommentApprovedResponse
Przykład

wyślijUstawStatusRecenzjiKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| options | const PostSetCommentReviewStatusOptions& | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

wyślijUstawStatusSpamuKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostSetCommentSpamStatusOptions& | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

wyślijUstawTekstKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| setCommentTextParams | SetCommentTextParams | Tak | |
| options | const PostSetCommentTextOptions& | Tak |
Odpowiedź
Zwraca: SetCommentTextResponse
Przykład

wyślijCofnięcieOznaczeniaKomentarza 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| commentId | string | Tak | |
| options | const PostUnFlagCommentOptions& | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

wyślijGłos 
Parametry
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostVoteOptions& | Yes |
Odpowiedź
Zwraca: VoteResponse
Przykład

przyznajOdznakę 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| badgeId | string | Yes | |
| options | const PutAwardBadgeOptions& | Yes |
Odpowiedź
Zwraca: AwardUserBadgeResponse
Przykład

zamknijWątek 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

usuńOdznakę 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| badgeId | string | Yes | |
| options | const PutRemoveBadgeOptions& | Yes |
Odpowiedź
Zwraca: RemoveUserBadgeResponse
Przykład

otwórzPonownieWątek 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

ustawWspółczynnikZaufania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const SetTrustFactorOptions& | Tak |
Odpowiedź
Zwraca: SetUserTrustFactorResponse
Przykład

utwórzModeratora 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| createModeratorBody | CreateModeratorBody | Yes |
Odpowiedź
Zwraca: CreateModeratorResponse
Przykład

usuńModeratora 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| sendEmail | string | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierzModeratora 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: GetModeratorResponse
Przykład

pobierzModeratorów 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| skip | double | Nie |
Odpowiedź
Zwraca: GetModeratorsResponse
Przykład

wyślijZaproszenie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| fromName | string | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

zaktualizujModeratora 
Parametry
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| updateModeratorBody | UpdateModeratorBody | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

usuńLiczbęPowiadomień 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierzZbuforowanąLiczbęPowiadomień 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Response
Returns: GetCachedNotificationCountResponse
Example

pobierzLiczbęPowiadomień 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetNotificationCountOptions& | Tak |
Odpowiedź
Zwraca: GetNotificationCountResponse
Przykład

pobierzPowiadomienia 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetNotificationsOptions& | Tak |
Odpowiedź
Zwraca: GetNotificationsResponse
Przykład

zaktualizujPowiadomienie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| updateNotificationBody | UpdateNotificationBody | Tak | |
| userId | string | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

utwórzReakcjęStronyV1 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| title | string | No |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

utwórzReakcjęStronyV2 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| id | string | Yes | |
| title | string | No |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

usuńReakcjęStronyV1 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

usuńReakcjęStronyV2 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

pobierzPolubieniaStronyV1 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak |
Odpowiedź
Zwraca: GetV1PageLikes
Przykład

pobierzReakcjeStronyV2 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak |
Odpowiedź
Zwraca: GetV2PageReacts
Przykład

pobierzUżytkownikówReakcjiStronyV2 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: GetV2PageReactUsersResponse
Przykład

dodajStronę 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| createAPIPageData | CreateAPIPageData | Yes |
Response
Returns: AddPageAPIResponse
Example

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

pobierzUżytkownikówOffline 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| options | const GetOfflineUsersOptions& | Yes |
Response
Returns: PageUsersOfflineResponse
Example

pobierzUżytkownikówOnline 
Obecnie online widzowie strony: osoby, których sesja websocket jest subskrybowana do tej strony w tej chwili.
Zwraca anonCount + totalCount (subskrybenci w całym pokoju, w tym anonimowi widzowie, których nie enumerujemy).
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak | |
| options | const GetOnlineUsersOptions& | Tak |
Odpowiedź
Zwraca: PageUsersOnlineResponse
Przykład

pobierzStronęPoIdURL 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak |
Odpowiedź
Zwraca: GetPageByURLIdAPIResponse
Przykład

pobierzStrony 
Parametry
| Name | Type | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak |
Odpowiedź
Zwraca: GetPagesAPIResponse
Przykład

pobierzStronyPublicznie 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetPagesPublicOptions& | Tak |
Response
Returns: GetPublicPagesResponse
Example

pobierzInfoUżytkowników 
Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| ids | string | Yes |
Response
Returns: PageUsersInfoResponse
Example

modyfikujStronę 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| updateAPIPageData | UpdateAPIPageData | Tak |
Odpowiedź
Returns: PatchPageAPIResponse
Przykład

usuńOczekująceZdarzenieWebhook 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierzLiczbęOczekującychZdarzeńWebhook 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetPendingWebhookEventCountOptions& | Tak |
Odpowiedź
Zwraca: GetPendingWebhookEventCountResponse
Przykład

pobierzOczekująceZdarzeniaWebhook 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetPendingWebhookEventsOptions& | Yes |
Odpowiedź
Zwraca: GetPendingWebhookEventsResponse
Przykład

utwórzKonfiguracjęPytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| createQuestionConfigBody | CreateQuestionConfigBody | Yes |
Odpowiedź
Zwraca: CreateQuestionConfigResponse
Przykład

usuńKonfiguracjęPytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierzKonfiguracjęPytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: GetQuestionConfigResponse
Przykład

pobierzKonfiguracjePytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| skip | double | No |
Odpowiedź
Zwraca: GetQuestionConfigsResponse
Przykład

zaktualizujKonfiguracjęPytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

utwórzWynikPytania 
Parametry
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| createQuestionResultBody | CreateQuestionResultBody | Yes |
Odpowiedź
Zwraca: CreateQuestionResultResponse
Przykład

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

pobierzWynikPytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Odpowiedź
Zwraca: GetQuestionResultResponse
Przykład

pobierzWynikiPytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetQuestionResultsOptions& | Tak |
Odpowiedź
Zwraca: GetQuestionResultsResponse
Przykład

zaktualizujWynikPytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| updateQuestionResultBody | UpdateQuestionResultBody | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

agregujWynikiPytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const AggregateQuestionResultsOptions& | Yes |
Odpowiedź
Zwraca: AggregateQuestionResultsResponse
Przykład

masowaAgregacjaWynikówPytania 
Parametry
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Yes | |
| forceRecalculate | bool | No |
Odpowiedź
Zwraca: BulkAggregateQuestionResultsResponse
Przykład

połączKomentarzeZWynikamiPytania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const CombineCommentsWithQuestionResultsOptions& | Tak |
Odpowiedź
Zwraca: CombineQuestionResultsWithCommentsResponse
Przykład

dodajUżytkownikaSSO 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| createAPISSOUserData | CreateAPISSOUserData | Tak |
Odpowiedź
Zwraca: AddSSOUserAPIResponse
Przykład

usuńUżytkownikaSSO 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| options | const DeleteSSOUserOptions& | Tak |
Response
Zwraca: DeleteSSOUserAPIResponse
Example

pobierzUżytkownikaSSOPoEmail 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| string | Tak |
Odpowiedź
Zwraca: GetSSOUserByEmailAPIResponse
Przykład

pobierzUżytkownikaSSOPoId 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Returns: GetSSOUserByIdAPIResponse
Przykład

pobierzUżytkownikówSSO 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| skip | int32_t | Nie |
Odpowiedź
Zwraca: GetSSOUsersResponse
Przykład

modyfikujUżytkownikaSSO 
Parametry
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| updateAPISSOUserData | UpdateAPISSOUserData | Tak | |
| updateComments | bool | Nie |
Odpowiedź
Zwraca: PatchSSOUserAPIResponse
Przykład

zapiszUżytkownikaSSO 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| updateAPISSOUserData | UpdateAPISSOUserData | Tak | |
| updateComments | bool | Nie |
Odpowiedź
Zwraca: PutSSOUserAPIResponse
Przykład

utwórzSubskrypcję 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | Tak |
Odpowiedź
Zwraca: CreateSubscriptionAPIResponse
Przykład

usuńSubskrypcję 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| userId | string | No |
Odpowiedź
Zwraca: DeleteSubscriptionAPIResponse
Przykład

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

zaktualizujSubskrypcję 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| updateAPIUserSubscriptionData | UpdateAPIUserSubscriptionData | Yes | |
| userId | string | No |
Odpowiedź
Zwraca: UpdateSubscriptionAPIResponse
Przykład

pobierzDziennyUżytekNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetTenantDailyUsagesOptions& | Tak |
Odpowiedź
Zwraca: GetTenantDailyUsagesResponse
Przykład

utwórzPakietNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| createTenantPackageBody | CreateTenantPackageBody | Yes |
Odpowiedź
Returns: CreateTenantPackageResponse
Przykład

usuńPakietNajemcy 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Response
Returns: APIEmptyResponse
Example

pobierzPakietNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Odpowiedź
Zwraca: GetTenantPackageResponse
Przykład

pobierzPakietyNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| skip | double | Nie |
Odpowiedź
Zwraca: GetTenantPackagesResponse
Przykład

zastąpPakietNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

zaktualizujPakietNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| updateTenantPackageBody | UpdateTenantPackageBody | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

utwórzUżytkownikaNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| createTenantUserBody | CreateTenantUserBody | Tak |
Odpowiedź
Zwraca: CreateTenantUserResponse
Przykład

usuńUżytkownikaNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| options | const DeleteTenantUserOptions& | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pobierzUżytkownikaNajemcy 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Response
Zwraca: GetTenantUserResponse
Example

pobierzUżytkownikówNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| skip | double | Nie |
Odpowiedź
Returns: GetTenantUsersResponse
Przykład

zastąpUżytkownikaNajemcy 
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| replaceTenantUserBody | ReplaceTenantUserBody | Tak | |
| updateComments | string | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

wyślijLinkLogowania 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| redirectURL | string | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

zaktualizujUżytkownikaNajemcy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| updateTenantUserBody | UpdateTenantUserBody | Tak | |
| updateComments | string | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

utwórzNajemcę 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| createTenantBody | CreateTenantBody | Yes |
Odpowiedź
Zwraca: CreateTenantResponse
Przykład

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

pobierzNajemcę 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: GetTenantResponse
Przykład

pobierzNajemców 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetTenantsOptions& | Tak |
Odpowiedź
Zwraca: GetTenantsResponse
Przykład

zaktualizujNajemcę 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| updateTenantBody | UpdateTenantBody | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

zmieńStanZgłoszenia 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| userId | string | Tak | |
| id | string | Tak | |
| changeTicketStateBody | ChangeTicketStateBody | Tak |
Odpowiedź
Zwraca: ChangeTicketStateResponse
Przykład

utwórzZgłoszenie 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| userId | string | Tak | |
| createTicketBody | CreateTicketBody | Tak |
Odpowiedź
Zwraca: CreateTicketResponse
Przykład

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

pobierzZgłoszenia 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const GetTicketsOptions& | Tak |
Odpowiedź
Zwraca: GetTicketsResponse
Przykład

pobierzTłumaczenia 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| r_namespace | string | Tak | |
| component | string | Tak | |
| options | const GetTranslationsOptions& | Tak |
Odpowiedź
Zwraca: GetTranslationsResponse
Przykład

prześlijObraz 
Upload and resize an image
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| file | HttpContent | Tak | |
| options | const UploadImageOptions& | Tak |
Odpowiedź
Zwraca: UploadImageResponse
Przykład

pobierzPostępOdznakiUżytkownikaPoId 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeProgressResponse
Przykład

pobierzPostępOdznakiUżytkownikaPoIdUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| userId | string | Yes |
Odpowiedź
Zwraca: APIGetUserBadgeProgressResponse
Przykład

pobierzListęPostępuOdznakUżytkownika 
Parametry
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetUserBadgeProgressListOptions& | Yes |
Odpowiedź
Zwraca: APIGetUserBadgeProgressListResponse
Przykład

utwórzOdznakęUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| createUserBadgeParams | CreateUserBadgeParams | Yes |
Odpowiedź
Zwraca: APICreateUserBadgeResponse
Przykład

usuńOdznakęUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: APIEmptySuccessResponse
Przykład

pobierzOdznakęUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeResponse
Przykład

pobierzOdznakiUżytkownika 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetUserBadgesOptions& | Yes |
Response
Zwraca: APIGetUserBadgesResponse
Example

zaktualizujOdznakęUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak | |
| updateUserBadgeParams | UpdateUserBadgeParams | Tak |
Odpowiedź
Zwraca: APIEmptySuccessResponse
Przykład

pobierzLiczbęPowiadomieńUżytkownika 
Parametry
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: GetUserNotificationCountResponse
Przykład

pobierzPowiadomieniaUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetUserNotificationsOptions& | Yes |
Odpowiedź
Zwraca: GetMyNotificationsResponse
Przykład

zresetujLiczbęPowiadomieńUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| sso | string | No |
Odpowiedź
Zwraca: ResetUserNotificationsResponse
Przykład

zresetujPowiadomieniaUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| options | const ResetUserNotificationsOptions& | Tak |
Odpowiedź
Zwraca: ResetUserNotificationsResponse
Przykład

zaktualizujStatusSubskrypcjiPowiadomieńKomentarzyUżytkownika 
Enable or disable notifications for a specific comment.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| notificationId | string | Yes | |
| optedInOrOut | string | Yes | |
| commentId | string | Yes | |
| sso | string | No |
Response
Zwraca: UpdateUserNotificationCommentSubscriptionStatusResponse
Przykład

zaktualizujStatusSubskrypcjiPowiadomieńStronUżytkownika 
Enable lub wyłącz powiadomienia dla strony. Gdy użytkownicy są subskrybowani do strony, tworzone są powiadomienia dla nowych głównych komentarzy oraz również
Parameters
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak | |
| url | string | Tak | |
| pageTitle | string | Tak | |
| subscribedOrUnsubscribed | string | Tak | |
| sso | string | Nie |
Response
Zwraca: UpdateUserNotificationPageSubscriptionStatusResponse
Example

zaktualizujStatusPowiadomieńUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| notificationId | string | Tak | |
| newStatus | string | Tak | |
| sso | string | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatusResponse
Przykład

pobierzStatusyObecnościUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| urlIdWS | string | Yes | |
| userIds | string | Yes |
Odpowiedź
Zwraca: GetUserPresenceStatusesResponse
Przykład

szukajUżytkowników 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| options | const SearchUsersOptions& | Yes |
Odpowiedź
Zwraca: SearchUsersResult
Przykład

pobierzUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| id | string | Tak |
Odpowiedź
Zwraca: GetUserResponse
Przykład

utwórzGłos 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| direction | string | Yes | |
| options | const CreateVoteOptions& | Yes |
Odpowiedź
Zwraca: VoteResponse
Przykład

usuńGłos 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| editKey | string | No |
Odpowiedź
Zwraca: VoteDeleteResponse
Przykład

pobierzGłosy 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Tak | |
| urlId | string | Tak |
Odpowiedź
Zwraca: GetVotesResponse
Przykład

pobierzGłosyDlaUżytkownika 
Parametry
| Nazwa | Typ | Wymagane | Opis |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| options | const GetVotesForUserOptions& | Yes |
Odpowiedź
Zwraca: GetVotesForUserResponse
Przykład

Potrzebujesz pomocy?
Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące C++ SDK, prosimy:
Współtworzenie
Wkłady są mile widziane! Odwiedź repozytorium GitHub, aby zapoznać się z wytycznymi dotyczącymi wkładu.