
Język 🇵🇱 Polski
Dokumentacja
Rozpoczęcie
Referencja API
Najemcy agentów
Agregacja
Logi audytu
Uwierzytelnianie
Zadania wsadowe
Blokowanie z komentarza
Sprawdzanie zablokowanych komentarzy
Komentarze
Komentarze dla użytkownika
Konfiguracje domen
Szablony e-mail
Dziennik zdarzeń
Posty w kanale
Zgłoszenie komentarza
GIFy
Hashtagi
Ja
Moderacja
Moderatorzy
Liczba powiadomień
Powiadomienia
Reakcje na stronie
Strony
Oczekujące zdarzenia webhook
Głosy w ankiecie
Ankiety
Konfiguracje pytań
Wyniki pytań
Agregacja wyników pytań
Użytkownicy SSO
Subskrypcje
Użycie dzienne najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Zgłoszenia
Tłumaczenia
Prześlij obraz
Postęp odznak użytkownika
Odznaki użytkownika
Powiadomienia użytkownika
Status obecności użytkownika
Wyszukiwanie użytkowników
Użytkownicy
Głosy
Webhooki
FastComments Swift SDK
To oficjalne SDK Swift dla FastComments.
Oficjalne SDK Swift dla API FastComments
Repozytorium
Agenci kodowania AI 
Daj swojemu agentowi kodującemu kontekst FastComments, którego potrzebuje – widgety, konfiguracja, Secure SSO, REST API i SDK:
npx skills add fastcomments/skills
Działa z Claude Code, Codex, Cursor, Copilot, Gemini oraz każdym innym agentem obsługiwanym przez skills CLI.
Instalacja 
Swift Package Manager
Dodaj następujący kod do pliku Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Lub w Xcode:
- File > Add Packages...
- Wprowadź adres URL repozytorium:
https://github.com/fastcomments/fastcomments-swift.git - Wybierz wersję, której chcesz użyć
Wymagania
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Zawartość biblioteki 
The FastComments Swift SDK składa się z kilku modułów:
-
Client Module - Klient API dla FastComments REST API
- Pełne definicje typów dla wszystkich modeli API
- Metody uwierzytelnione (
DefaultAPI), publiczne (PublicAPI) i moderacyjne (ModerationAPI) - Pełne wsparcie dla async/await
- Zobacz client/README.md dla szczegółowej dokumentacji API
-
SSO Module - Narzędzia Single Sign-On po stronie serwera
- Bezpieczne generowanie tokenów do uwierzytelniania użytkowników
- Obsługa zarówno prostego, jak i bezpiecznego trybu SSO
- Podpisywanie tokenów oparte na HMAC-SHA256 przy użyciu CryptoKit
Szybki start 
Korzystanie z publicznego API
import FastCommentsSwift
// Pobierz komentarze dla strony
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Korzystanie z uwierzytelnionego API
import FastCommentsSwift
// Skonfiguruj swój klucz API we współdzielonej konfiguracji (wysyłany jako nagłówek x-api-key)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Pobierz komentarze za pomocą uwierzytelnionego API
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Korzystanie z API moderacji
import FastCommentsSwift
// Metody moderacji są autoryzowane tokenem `sso` działającego moderatora
// (wygeneruj go za pomocą FastCommentsSSO, zobacz sekcję SSO powyżej).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Korzystanie z SSO do uwierzytelniania
Bezpieczne SSO (zalecane dla produkcji)
import FastCommentsSwift
let apiKey = "your-api-key"
// Utwórz bezpieczne dane użytkownika SSO (tylko po stronie serwera!)
let userData = SecureSSOUserData(
id: "user-123", // ID użytkownika
email: "user@example.com", // Email
username: "johndoe", // Nazwa użytkownika
avatar: "https://example.com/avatar.jpg" // URL awatara
)
// Wygeneruj token SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Przekaż ten token do frontendu w celu uwierzytelnienia
} catch {
print("Error creating SSO token: \(error)")
}
Proste SSO (do rozwoju/testowania)
import FastCommentsSwift
// Utwórz proste dane użytkownika SSO (nie wymaga klucza API)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Wygeneruj prosty token SSO
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
Klienci API 
SDK FastComments udostępnia trzech klientów API:
PublicAPI - Metody bezpieczne dla klienta
PublicAPI zawiera metody, które można bezpiecznie wywoływać z kodu po stronie klienta (aplikacje iOS/macOS). Te metody:
- Nie wymagają klucza API
- Mogą używać tokenów SSO do uwierzytelniania
- Są ograniczone limitem żądań na użytkownika/urządzenie
- Nadają się do aplikacji przeznaczonych dla użytkowników końcowych
Przykładowy przypadek użycia: Pobieranie i tworzenie komentarzy w aplikacji iOS
DefaultAPI - Metody po stronie serwera
DefaultAPI zawiera metody uwierzytelniane, które wymagają klucza API. Te metody:
- Wymagają klucza API FastComments
- Powinny być wywoływane WYŁĄCZNIE z kodu po stronie serwera
- Zapewniają pełny dostęp do danych FastComments
- Są ograniczone limitem żądań na najemcę (tenant)
Przykładowy przypadek użycia: Operacje administracyjne, masowy eksport danych, zarządzanie użytkownikami
ModerationAPI - Metody panelu moderatora
ModerationAPI oferuje rozbudowany zestaw API do moderacji na żywo i szybkiej moderacji. Każda metoda ModerationAPI przyjmuje parametr sso i może uwierzytelniać się za pomocą SSO lub ciasteczka sesji FastComments.com.
Przykładowy przypadek użycia: Budowanie doświadczenia moderacji dla moderatorów Twojej społeczności
WAŻNE: Nigdy nie ujawniaj klucza API w kodzie po stronie klienta. Klucze API powinny być używane tylko po stronie serwera.
Wykonywanie wywołań API 
SDK Swift używa nowoczesnej składni async/await we wszystkich wywołaniach API:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Typowe problemy 
Błędy 401 Nieautoryzowane
Jeśli otrzymujesz błędy 401 podczas korzystania z uwierzytelnionego API:
- Sprawdź swój klucz API: Upewnij się, że używasz prawidłowego klucza API z panelu FastComments
- Zweryfikuj identyfikator najemcy: Upewnij się, że identyfikator najemcy odpowiada Twojemu kontu
- Format klucza API: Klucz API powinien być ustawiony jako nagłówek
x-api-keyw wspólnej konfiguracji:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Używanie niewłaściwego API: Upewnij się, że używasz
DefaultAPI(niePublicAPI) dla uwierzytelnionych wywołań
Problemy z tokenami SSO
Jeśli tokeny SSO nie działają:
- Używaj trybu zabezpieczonego w produkcji: Zawsze używaj
FastCommentsSSO.createSecure()z kluczem API w środowisku produkcyjnym - Tylko po stronie serwera: Generuj bezpieczne tokeny SSO na serwerze, nigdy nie ujawniaj klucza API klientom
- Sprawdź dane użytkownika: Upewnij się, że wszystkie wymagane pola (id, email, username) są dostarczone
- Wygaśnięcie tokenu: Bezpieczne tokeny SSO zawierają znacznik czasu i mogą wygasać. Generuj nowe tokeny w razie potrzeby.
Błędy SSL/TLS
Jeśli napotkasz błędy SSL/TLS:
- Upewnij się, że plik Info.plist Twojej aplikacji zezwala na połączenia HTTPS do fastcomments.com
- Sprawdź, czy nie używasz wyjątków App Transport Security, które mogą blokować połączenie
Notatki 
Identyfikatory transmisji
Zobaczysz, że w niektórych wywołaniach API powinieneś przekazać broadcastId. Gdy otrzymasz zdarzenia, otrzymasz ten identyfikator z powrotem, dzięki czemu będziesz wiedzieć, aby zignorować zdarzenie, jeśli planujesz optymistycznie zastosować zmiany po stronie klienta (czego prawdopodobnie będziesz chciał zrobić, ponieważ daje to najlepsze doświadczenie). Przekaż tutaj UUID. Identyfikator powinien być wystarczająco unikalny, aby nie występował dwukrotnie w trakcie sesji.
let broadcastId = UUID().uuidString
createAgentTenant 
Tworzy nowe konto próbne dla agenta AI bez rejestracji przez człowieka. Do wywołania tego endpointu nie jest potrzebny klucz API.
Odpowiedź zawiera identyfikator tenanta, klucz API działający natychmiast z REST API i serwerem MCP oraz URL do przejęcia konta (claim URL). Przekaż claim URL człowiekowi, dla którego pracujesz: otwarcie go będąc zalogowanym do FastComments przypisuje konto do tej osoby. Nieprzejęte konta oraz ich klucze są usuwane 72 godziny po utworzeniu. Do momentu przejęcia konto ma standardowe limity wersji próbnej.
Odpowiedź
Zwraca: CreateAgentTenantResponse
Przykład

aggregate 
Aggreguje dokumenty, grupując je (jeśli podano groupBy) i stosując wiele operacji.
Różne operacje (np. sum, countDistinct, avg itp.) są obsługiwane.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| parentTenantId | string | query | Nie | |
| includeStats | boolean | query | Nie |
Odpowiedź
Zwraca: AggregateResponse
Przykład

getAuditLogs 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | Tenant, dla którego odczytywane są logi audytu. |
| limit | integer | query | No | Ile logów zwrócić. Maksymalnie 10000, domyślnie 1000. |
| skip | integer | query | No | Ile logów pominąć, w celu paginacji. |
| order | string | query | No | Kierunek sortowania według czasu zdarzenia. Domyślnie DESC (najnowsze najpierw). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | Zwróć tylko zdarzenia wykonane przez tę nazwę użytkownika. |
| ip | string | query | No | Zwróć tylko zdarzenia z tego adresu IP. |
| crudType | string | query | No | Zwróć tylko zdarzenia tego typu: c, r, u, d lub login. |
| resourceName | string | query | No | Zwróć tylko zdarzenia dla tego zasobu, np. User lub Moderator. |
| targetId | string | query | No | Zwróć tylko zdarzenia, których dotknięty obiekt ma ten identyfikator. |
| target | string | query | No | Dopasowanie podciągu (bez rozróżniania wielkości liter) w etykiecie dotkniętego obiektu, np. nazwa użytkownika lub e-mail. |
| includeManagedTenants | boolean | query | No | Zwróć także zdarzenia z tenantów, które ten tenant zarządza. |
Odpowiedź
Zwraca: GetAuditLogsResponse
Przykład

logoutPublic 
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getBatchJob 
Status, postęp i, po zakończeniu, wynik jednego zadania wsadowego.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Response
Zwraca: GetBatchJobAPIResponse
Example

getBatchJobs 
The tenant's batch jobs (imports, exports, page migrations...), newest first.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| type | string | query | No | Only jobs of this type, for example migrate-pages. |
| status | string | query | No | Only jobs in this status: requested, running, success or failed. |
| skip | integer | query | No | How many jobs to skip, for paging. |
Response
Zwraca: GetBatchJobsAPIResponse
Przykład

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

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

checkedCommentsForBlocked 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentIds | string | query | Tak | Lista identyfikatorów komentarzy rozdzielona przecinkami. |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CheckBlockedCommentsResponse
Przykład

blockUserFromComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Zwraca: BlockSuccess
Example

createCommentPublic 
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 | |
| locale | string | query | Nie |
Response
Zwraca: SaveCommentsResponseWithPresence
Example

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

deleteCommentPublic 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Zwraca: PublicAPIDeleteCommentResponse
Example

deleteCommentVote 
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

flagComment 
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

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

getComments 
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

getCommentsPublic 
req tenantId urlId
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| page | integer | query | Nie | |
| direction | string | query | Nie | |
| sso | string | query | Nie | |
| skip | integer | query | Nie | |
| skipChildren | integer | query | Nie | |
| limit | integer | query | Nie | |
| limitChildren | integer | query | Nie | |
| countChildren | boolean | query | Nie | |
| fetchPageForCommentId | string | query | Nie | |
| includeConfig | boolean | query | Nie | |
| countAll | boolean | query | Nie | |
| includei10n | boolean | query | Nie | |
| locale | string | query | Nie | |
| modules | string | query | Nie | |
| isCrawler | boolean | query | Nie | |
| includeNotificationCount | boolean | query | Nie | |
| asTree | boolean | query | Nie | |
| maxTreeDepth | integer | query | Nie | |
| useFullTranslationIds | boolean | query | Nie | |
| parentId | string | query | Nie | |
| searchText | string | query | Nie | |
| hashTags | array | query | Nie | |
| userId | string | query | Nie | |
| customConfigStr | string | query | Nie | |
| afterCommentId | string | query | Nie | |
| beforeCommentId | string | query | Nie | |
| questionId | string | query | Nie | |
| questionValue | integer | query | Nie |
Odpowiedź
Zwraca: GetCommentsResponseWithPresencePublicComment
Przykład

getCommentText 
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

getCommentVoteUserNames 
Parametry
| Name | 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

lockComment 
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

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

saveComment 
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

saveCommentsBulk 
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: [SaveCommentsBulkResponse]
Przykład

setCommentText 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: PublicAPISetCommentTextResponse
Przykład

translateComments 
Tłumaczy podane komentarze na język widżetu. Dostępne tylko wtedy, gdy odpowiednia reguła dostosowywania widżetu ma ustawione Tłumaczenie komentarzy na Automatyczne lub Ręczne.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| locale | string | query | No |
Odpowiedź
Zwraca: CommentTranslationsResponse
Przykład

unBlockUserFromComment 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Zwraca: UnblockSuccess
Example

unFlagComment 
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

unLockComment 
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

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

updateComment 
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

voteComment 
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

getCommentsForUser 
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

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

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

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

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

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

putDomainConfig 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domainToUpdate | string | path | Tak |
Odpowiedź
Zwraca: PutDomainConfigResponse
Przykład

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

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

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

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

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

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

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

renderEmailTemplate 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| locale | string | query | Nie |
Odpowiedź
Zwraca: RenderEmailTemplateResponse
Przykład

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

getEventLog 
req tenantId urlId userIdWS
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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

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

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

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

deleteFeedPostPublic 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Zwraca: DeleteFeedPostPublicResponse
Example

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

getFeedPostsPublic 
req tenantId afterId
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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

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

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

reactFeedPostPublic 
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

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

updateFeedPostPublic 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Zwraca: CreateFeedPostResponse
Przykład

flagCommentPublic 
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

getGifLarge 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| largeInternalURLSanitized | string | query | Tak |
Odpowiedź
Zwraca: GifGetLargeResponse
Przykład

getGifsSearch 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| search | string | query | Tak | |
| locale | string | query | Nie | |
| rating | string | query | Nie | |
| page | number | query | Nie |
Odpowiedź
Zwraca: GetGifsSearchResponse
Przykład

getGifsTrending 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| locale | string | query | Nie | |
| rating | string | query | Nie | |
| page | number | query | Nie |
Odpowiedź
Zwraca: GetGifsTrendingResponse
Przykład

addHashTag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: CreateHashTagResponse
Przykład

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

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

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

patchHashTag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| tag | string | ścieżka | Tak |
Odpowiedź
Zwraca: UpdateHashTagResponse
Przykład

getMe 
Identyfikuje używane poświadczenie: dzierżawę, do której należy, a w przypadku tokenów OAuth — użytkownika, który je autoryzował. Integracje używają tego do przetestowania połączenia i nadania mu etykiety.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetMeResponse
Przykład

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

getApiComments 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Response
Zwraca: ModerationAPIGetCommentsResponse
Przykład

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

getApiIds 
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

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

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

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

getCount 
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

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

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

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

getManualBadgesForUser 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Returns: GetUserManualBadgesResponse
Przykład

getModerationComment 
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ź
Zwraca: ModerationAPICommentResponse
Przykład

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

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

getSearchCommentsSummary 
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ź
Zwraca: ModerationCommentSearchResponse
Przykład

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

getSearchSites 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| value | string | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: ModerationSiteSearchResponse
Example

getSearchSuggest 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationSuggestResponse
Przykład

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

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

getUserBanPreference 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIModerateGetUserBanPreferencesResponse
Przykład

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

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

postApiExport 
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

postBanUserFromComment 
Parametry
| 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 |
Odpowiedź
Zwraca: BanUserFromCommentResult
Przykład

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

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

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

postFlagComment 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Zwraca: APIEmptyResponse
Przykład

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

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

postSetCommentApprovalStatus 
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

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

postSetCommentSpamStatus 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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

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

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

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

putAwardBadge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: AwardUserBadgeResponse
Przykład

putCloseThread 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| sso | string | query | Nie |
Response
Zwraca: APIEmptyResponse
Example

putRemoveBadge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: RemoveUserBadgeResponse
Przykład

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

setTrustFactor 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| trustFactor | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SetUserTrustFactorResponse
Przykład

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

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

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

getModerators 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetModeratorsResponse
Przykład

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

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

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

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

getNotificationCount 
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 |
Odpowiedź
Returns: GetNotificationCountResponse
Przykład

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

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

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

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

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

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

getV1PageLikes 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Gdy ustawione, zwraca użytkowników, którzy polubili stronę (awatarów i nazw użytkowników). Tylko "public" jest akceptowane, co pomija prywatne profile. |
Odpowiedź
Zwraca: GetV1PageLikes
Przykład

getV2PageReacts 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Gdy ustawione, zwraca użytkowników dla każdego identyfikatora reakcji (awatarów i nazw użytkowników). Tylko "public" jest akceptowane, co pomija prywatne profile. |
Odpowiedź
Zwraca: GetV2PageReacts
Przykład

getV2PageReactUsers 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| id | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetV2PageReactUsersResponse
Przykład

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

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

getOfflineUsers 
Osoby komentujące wcześniej na stronie, które NIE są obecnie online. Sortowane według displayName. Użyj tego po wyczerpaniu /users/online, aby wyrenderować sekcję "Members". Paginacja kursorowa po commenterName: serwer przechodzi po częściowym indeksie {tenantId, urlId, commenterName} od afterName w przód za pomocą $gt, bez kosztu $skip.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | Identyfikator adresu URL strony (oczyszczany po stronie serwera). |
| afterName | string | query | Nie | Kursor: przekaż nextAfterName z poprzedniej odpowiedzi. |
| afterUserId | string | query | Nie | Kursor rozstrzygający remisy: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagany, gdy afterName jest ustawiony, aby remisy nazw nie gubiły wpisów. |
Odpowiedź
Zwraca: PageUsersOfflineResponse
Przykład

getOnlineUsers 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identyfikator URL strony (czyszczony po stronie serwera). |
| afterName | string | query | No | Kursor: przekaż nextAfterName z poprzedniej odpowiedzi. |
| afterUserId | string | query | No | Rozstrzygacz dla kursora: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy ustawiono afterName, aby w sytuacji remisów nazw nie pomijać wpisów. |
Response
Returns: PageUsersOnlineResponse
Example

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

getPageLikes 
Liczba polubień dla strony, opcjonalnie z użytkownikami, którzy ją polubili.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| includeUserInfo | string | query | Nie | "public" pomija użytkowników z prywatnymi profilami, "include-private" je uwzględnia. |
Odpowiedź
Zwraca: GetPageLikesAPIResponse
Przykład

getPageReacts 
Niestandardowe liczniki reakcji dla strony, opcjonalnie z użytkownikami, którzy zareagowali.
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| includeUserInfo | string | query | Nie | "public" pomija użytkowników z prywatnymi profilami, "include-private" je uwzględnia. |
Response
Zwraca: GetPageReactsAPIResponse
Example

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

getPagesPublic 
Wyświetla listę stron dla tenanta. Używane przez klienta desktopowego FChat do wypełnienia listy pokoi.
Wymaga ustawienia enableFChat na true w rozwiązanej konfiguracji niestandardowej dla każdej strony.
Strony wymagające SSO są filtrowane względem dostępu grupowego użytkownika wysyłającego żądanie.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| cursor | string | query | Nie | Nieprzezroczysty kursor paginacji zwrócony jako nextCursor z poprzedniego żądania. Powiązany z tym samym sortBy. |
| limit | integer | query | Nie | 1..200, domyślnie 50 |
| q | string | query | Nie | Opcjonalny filtr prefiksu tytułu, niewrażliwy na wielkość liter. |
| sortBy | string | query | Nie | Kolejność sortowania. updatedAt (domyślna, od najnowszych), commentCount (najpierw najwięcej komentarzy) lub title (alfabetycznie). |
| hasComments | boolean | query | Nie | Jeśli true, zwraca tylko strony z co najmniej jednym komentarzem. |
Odpowiedź
Zwraca: GetPublicPagesResponse
Przykład

getUsersInfo 
Zbiorcze informacje o użytkownikach dla najemcy. Dla podanych userIds zwracane są informacje wyświetlane z User / SSOUser. Używane przez widget komentarzy do wzbogacenia informacji o użytkownikach, którzy właśnie pojawili się poprzez zdarzenie obecności. Brak kontekstu strony: prywatność jest egzekwowana jednolicie (profile prywatne są maskowane).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds rozdzielone przecinkami. |
Response
Returns: PageUsersInfoResponse
Example

migratePages 
Kolejkuje zadanie wsadowe, które przenosi komentarze, strony i powiązane rekordy z jednego urlId lub domeny do innego. Migracje "urlId" dopasowują tylko dokładny urlId. Migracje "domain" wyszukują/zamieniają wartość w każdym urlId i url. Odpytuj GET /api/v1/batch-jobs/{batchJobId}: po zakończeniu zawiera wyniki poszczególnych migracji oraz undoId.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: QueuePageMigrationJobAPIResponse
Przykład

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

undoPageMigrations 
Kolejkuje zadanie wsadowe, które odwraca każdą migrację z jednego zadania migrate-pages, od najnowszych. Dostępne przez 90 dni. Rekordy zmienione od czasu migracji pozostają nietknięte, więc późniejsza edycja nigdy nie zostanie nadpisana. Odpytuj GET /api/v1/batch-jobs/{batchJobId}, aby uzyskać liczbę przywróconych/pominiętych rekordów.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| undoId | string | path | Tak |
Odpowiedź
Zwraca: QueuePageMigrationJobAPIResponse
Przykład

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

getPendingWebhookEventCount 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: GetPendingWebhookEventCountResponse
Przykład

getPendingWebhookEvents 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | 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 | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEventsResponse
Przykład

createPollVote 
Zagłosuj w ankiecie lub przenieś istniejący głos na inną opcję. Głosujący ma co najwyżej jeden głos na ankietę, więc ponowne wywołanie dla tego samego głosującego przenosi jego głos, a nie dodaje nowego.
Funkcja respektuje ustawienia ankiet witryny: jeśli głosowanie jest ograniczone do zalogowanych użytkowników, głos z samym anonUserId zostanie odrzucony, a anonimowe głosy są ograniczone limitem na IP na ankietę.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreatePollVoteResponse
Przykład

deletePollVote 
Cofnij głos. Opcja, na którą został oddany, zwraca swoją liczbę głosów.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: DeletePollVoteResponse
Przykład

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

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
A poll belongs to a comment, so votes are always read one poll at a time - commentId is required. That keeps every query on the indexes the collection already has.
Obeys the poll's privacy: an anonymous poll's votes cannot be read (poll-anonymous), here or by id.
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| voterId | string | query | No | |
| optionId | string | query | No | |
| skip | integer | query | No |
Response
Returns: GetPollVotesResponse
Example

deletePoll 
Usuwa ankietę z komentarza, wraz ze wszystkimi oddanymi na nią głosami. Sam komentarz pozostaje nietknięty.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

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

getPollVoters 
Kto zagłosował na którą opcję. Anonimowe ankiety nigdy nie odpowiadają, ankiety tylko dla administratorów odpowiadają wyłącznie administratorowi lub moderatorowi.
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| urlId | string | query | Nie | |
| page | integer | query | Nie | |
| search | string | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: GetPollVoterNamesSuccessResponse
Przykład

patchPoll 
Edytuj ankietę w miejscu, zachowując jej wyniki: zmień pytanie, zmień etykietę opcji, zamknij lub otwórz ją ponownie, lub zmień, kto może zobaczyć wyborców. Opcje są identyfikowane po id – aby dodać, usunąć lub zmienić ich kolejność, użyj PUT z pełną listą.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak |
Odpowiedź
Zwraca: SavePollResponse
Przykład

putPoll 
Dołącz ankietę do komentarza lub ustaw pełny stan ankiety, którą już posiada.
Opcje są dopasowywane po id: opcja wysłana z id istniejącej opcji zachowuje swoje głosy (i przyjmuje nową etykietę oraz pozycję), opcja wysłana bez id jest dodawana, a istniejące opcje pominięte na liście są usuwane wraz z oddanymi na nie głosami.
Niepozostawienie żadnego istniejącego id opcji w ankiecie, która ma głosy, usuwa wszystkie z nich, więc wymaga to replaceVotes=true.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| replaceVotes | boolean | query | Nie |
Odpowiedź
Zwraca: SavePollResponse
Przykład

votePoll 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: VotePollResponse
Przykład

createQuestionConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: CreateQuestionConfigResponse
Przykład

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

getQuestionConfig 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Response
Zwraca: GetQuestionConfigResponse
Przykład

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

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

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

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

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

getQuestionResults 
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

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

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

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

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

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

deleteSSOUser 
Parameters
| 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

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

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

getSSOUsers 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | integer | query | Nie |
Odpowiedź
Zwraca: GetSSOUsersResponse
Przykład

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

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

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

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

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

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

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

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

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

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

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

replaceTenantPackage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

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

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

deleteTenantUser 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

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

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

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

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

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

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

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

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

getTenants 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetTenantsResponse
Przykład

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

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

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

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

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

getTranslations 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| namespace | string | path | Tak | |
| component | string | path | Tak | |
| locale | string | query | Nie | |
| useFullTranslationIds | boolean | query | Nie |
Odpowiedź
Zwraca: GetTranslationsResponse
Przykład

uploadImage 
Upload and resize an image → Prześlij i zmień rozmiar obrazu
Parameters → Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Predefiniowany rozmiar: "Default" (1000x1000px) lub "CrossPlatform" (tworzy rozmiary dla popularnych urządzeń) |
| urlId | string | query | No | Id strony, z której odbywa się przesyłanie, do konfiguracji |
Response → Odpowiedź
Returns: UploadImageResponse → Zwraca:
Example → Przykład

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

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

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

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

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

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

getUserBadges 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| badgeId | string | query | Nie | |
| type | number | query | Nie | |
| displayedOnComments | boolean | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Response
Zwraca: APIGetUserBadgesResponse
Przykład

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

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

getUserNotifications 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Używane 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

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

resetUserNotifications 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ResetUserNotificationsResponse
Przykład

updateUserNotificationCommentSubscriptionStatus 
Włączanie lub wyłączanie powiadomień dla konkretnego komentarza.
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

updateUserNotificationPageSubscriptionStatus 
Włącz lub wyłącz powiadomienia dla strony. Gdy użytkownicy subskrybują stronę, tworzone są powiadomienia dla nowych komentarzy głównych, a 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

updateUserNotificationStatus 
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

getUserPresenceStatuses 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlIdWS | string | query | Tak | |
| userIds | string | query | Tak |
Odpowiedź
Zwraca: GetUserPresenceStatusesResponse
Przykład

searchUsers 
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

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

createVote 
Parameters
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Tak | |
| direction | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Response
Zwraca: VoteResponse
Example

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

getVotes 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetVotesResponse
Przykład

getVotesForUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odpowiedź
Zwraca: GetVotesForUserResponse
Przykład

createWebhook 
Subskrybuje URL do zdarzenia komentarza (subskrypcja hooka REST). Ponowne subskrybowanie tego samego URL do tego samego zdarzenia i domeny zwraca istniejącą subskrypcję. Dostawy są podpisane HMAC, zobacz przewodnik po webhookach; starszy nagłówek token nigdy nie jest wysyłany do subskrypcji API.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreateWebhookResponse
Example

deleteWebhook 
Unsubscribes (REST hook unsubscribe). Only subscriptions created through this API can be deleted here; dashboard-managed webhooks are edited in the dashboard.
Anulowania subskrypcji (REST hook unsubscribe). Tylko subskrypcje utworzone za pośrednictwem tego API mogą być tutaj usunięte; webhooki zarządzane w panelu są edytowane w panelu.
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Zwraca: APIEmptyResponse
Example

getWebhooks 
Wyświetla listę webhooków skonfigurowanych dla tenanta, obejmując zarówno wiersze zarządzane z pulpitu, jak i subskrypcje API.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| event | string | query | Nie | |
| domain | string | query | Nie | |
| source | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetWebhooksResponse
Przykład

getWebhookSamplePayloads 
Ostatnie komentarze w dokładnym formacie używanym przez dostawy webhooków, przeznaczone do budowania integracji (na przykład dane przykładowe Zapier). Każde zdarzenie dostarcza ten sam obiekt komentarza, więc event musi być jedynie prawidłowy.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| event | string | query | Nie | |
| limit | number | query | Nie |
Odpowiedź
Zwraca: GetWebhookSamplePayloadsResponse
Przykład

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