
Język 🇵🇱 Polski
Pierwsze kroki
Użycie
Agregacja
Logi audytu
Uwierzytelnianie
Blokada z komentarza
Sprawdź zablokowane komentarze
Komentarze
Komentarze użytkownika
Konfiguracje domen
Szablony e-mail
Dziennik zdarzeń
Posty w aktualnościach
Oznaczenie komentarza
Gify
Hashtagi
Moderacja
Moderatorzy
Licznik powiadomień
Powiadomienia
Reakcje na stronie
Strony
Oczekujące zdarzenia webhooka
Konfiguracje pytań
Wyniki pytań
Agregacja wyników pytań
Użytkownicy SSO
Subskrypcje
Dzienne zużycie najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Zgłoszenia
Tłumaczenia
Przesyłanie obrazu
Postęp odznak użytkownika
Odznaki użytkownika
Powiadomienia użytkownika
Status obecności użytkownika
Wyszukiwanie użytkownika
Użytkownicy
Głosy
FastComments Go SDK
To jest oficjalne Go SDK dla FastComments.
Oficjalne Go SDK dla API FastComments
Repozytorium
Instalacja 
go get github.com/fastcomments/fastcomments-go
Korzystanie z klienta API
Public API (brak uwierzytelnienia)
PublicAPI umożliwia dostęp bez uwierzytelnienia do publicznych endpointów:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Pobierz komentarze przy użyciu PublicAPI
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Default API (wymaga klucza API)
DefaultAPI wymaga uwierzytelnienia przy użyciu Twojego klucza API:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Utwórz uwierzytelniony kontekst przy użyciu klucza API
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// Pobierz komentarze przy użyciu uwierzytelnionego DefaultAPI
response, httpResp, err := apiClient.DefaultAPI.GetComments(auth).
TenantId("your-tenant-id").
UrlId("your-page-url-id").
Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Moderation API (Panel moderatora)
ModerationAPI oferuje rozbudowany zestaw szybkich i na żywo API do moderacji. Wszystkie metody moderacji akceptują parametr sso i mogą uwierzytelnić się za pomocą SSO lub ciasteczka sesji FastComments.com:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Wyświetl komentarze do moderacji przy użyciu ModerationAPI
response, httpResp, err := apiClient.ModerationAPI.GetApiComments(
context.Background(),
).Sso("your-sso-token").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Użycie 
Proste SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Utwórz token prostego SSO
user := &sso.SimpleSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Avatar: "https://example.com/avatar.jpg",
}
ssoInstance := sso.NewSimple(user)
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("SSO Token:", token)
// Użyj tokenu SSO, aby wykonać uwierzytelnione wywołanie API
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Bezpieczne SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Utwórz token bezpiecznego SSO
user := &sso.SecureSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Username: "johndoe",
Avatar: "https://example.com/avatar.jpg",
}
apiKey := "your-api-key"
ssoInstance, err := sso.NewSecure(apiKey, user)
if err != nil {
panic(err)
}
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("Secure SSO Token:", token)
// Użyj tokenu SSO, aby wykonać uwierzytelnione wywołanie API
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Agregacja 
Agreguje 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Odpowiedź
Zwraca: AggregateResponse
Przykład

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

WylogujPubliczny 
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

ZablokujZKomentarzaPublicznego 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| commentId | string | ścieżka | Tak | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: BlockSuccess
Przykład

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

SprawdzoneKomentarzeZablokowane 
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

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

UtwórzKomentarzPubliczny 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| sessionId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SaveCommentsResponseWithPresence
Przykład

UsuńKomentarz 
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

UsuńKomentarzPubliczny 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PublicAPIDeleteCommentResponse
Przykład

UsuńGłosKomentarza 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| voteId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: VoteDeleteResponse
Przykład

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

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

PobierzKomentarze 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | integer | query | Nie | |
| limit | integer | query | Nie | |
| skip | integer | query | Nie | |
| asTree | boolean | query | Nie | |
| skipChildren | integer | query | Nie | |
| limitChildren | integer | query | Nie | |
| maxTreeDepth | integer | query | Nie | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie | |
| contextUserId | string | query | Nie | |
| hashTag | string | query | Nie | |
| parentId | string | query | Nie | |
| direction | string | query | Nie | |
| fromDate | integer | query | Nie | |
| toDate | integer | query | Nie |
Odpowiedź
Zwraca: APIGetCommentsResponse
Przykład

PobierzKomentarzePubliczne 
req tenantId urlId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: GetCommentsResponseWithPresencePublicComment
Przykład

PobierzTekstKomentarza 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| commentId | string | ścieżka | Tak | |
| editKey | string | zapytanie | Nie | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: PublicAPIGetCommentTextResponse
Przykład

PobierzNazwyGłosującychKomentarzy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| dir | integer | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetCommentVoteUserNamesSuccessResponse
Przykład

ZablokujKomentarz 
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

PrzypnijKomentarz 
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

ZapiszKomentarz 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| sendEmails | boolean | query | Nie | |
| populateNotifications | boolean | query | Nie |
Response
Zwraca: APISaveCommentResponse
Przykład

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

UstawTekstKomentarza 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PublicAPISetCommentTextResponse
Przykład

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

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

OdblokujKomentarz 
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

OdepnijKomentarz 
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

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

OceńKomentarz 
Parametry
| Name | Type | Location | 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

PobierzKomentarzeUżytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
Odpowiedź
Zwraca: GetCommentsForUserResponse
Przykład

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

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

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

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

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

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

UtwórzSzablonEmail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateEmailTemplateResponse
Przykład

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

UsuńBłądRenderowaniaSzablonuEmail 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| errorId | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

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

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

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

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

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

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

PobierzDziennikZdarzeń 
req tenantId urlId userIdWS
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

PobierzGlobalnyDziennikZdarzeń 
req tenantId urlId userIdWS
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

UtwórzPostFeed 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| broadcastId | string | query | Nie | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| skipDupCheck | boolean | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostsResponse
Przykład

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

UsuńPublicznyPostFeed 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: DeleteFeedPostPublicResponse
Przykład

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

PobierzPublicznePostyFeed 
req tenantId afterId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie | |
| sso | string | query | Nie | |
| isCrawler | boolean | query | Nie | |
| includeUserInfo | boolean | query | Nie |
Odpowiedź
Zwraca: PublicFeedPostsResponse
Przykład

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

PobierzReakcjeUżytkownikówPubliczne 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| postIds | array | zapytanie | Nie | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: UserReactsResponse
Przykład

ReagujNaFeedPostPubliczny 
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

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

AktualizujPublicznyPostFeed 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: CreateFeedPostResponse
Przykład

OznaczKomentarzPublicznie 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| isFlagged | boolean | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

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

WyszukajGify 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

PobierzPopularneGify 
Parametry
| 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

DodajHashtag 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Response
Zwraca: CreateHashTagResponse
Przykład

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

UsuńHashtag 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Response
Zwraca: APIEmptyResponse
Example

PobierzHashtagi 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | number | query | Nie |
Odpowiedź
Zwraca: GetHashTagsResponse
Przykład

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

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

PobierzApiKomentarze 
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
Example

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

PobierzApiIdentyfikatory 
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

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

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

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

PobierzLiczbę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationAPICountCommentsResponse
Przykład

PobierzLiczby 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetBannedUsersCountResponse
Przykład

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

PobierzRęczneOdznaki 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Response
Zwraca: GetTenantManualBadgesResponse
Example

PobierzRęczneOdznakiUżytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| badgesUserId | string | query | Nie | |
| commentId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserManualBadgesResponse
Przykład

PobierzKomentarzModeracyjny 
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

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

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

PobierzPodsumowanieKomentarzyWyszukiwania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationCommentSearchResponse
Przykład

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

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

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

PobierzWyszukiwanychUżytkowników 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
Zwraca: ModerationUserSearchResponse
Example

PobierzWspółczynnikZaufania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetUserTrustFactorResponse
Przykład

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

PobierzWewnętrznyProfilUżytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetUserInternalProfileResponse
Przykład

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

EksportApi 
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

ZbanujUżytkownikaZKomentarza 
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

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

HurtowePodsumowaniePrzedBanem 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagany | 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

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

OznaczKomentarzModeracja 
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
Example

UsuńKomentarzModeracja 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: PostRemoveCommentApiResponse
Przykład

PrzywróćUsuniętyKomentarz 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

UstawStatusAkceptacjiKomentarza 
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

UstawStatusRecenzjiKomentarza 
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

UstawStatusSpamuKomentarza 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| spam | boolean | query | Nie | |
| permNotSpam | boolean | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

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

OdznaczKomentarzModeracja 
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

OddajGłos 
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

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

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

UsuńOdznakę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| badgeId | string | query | Tak | |
| userId | string | query | Nie | |
| commentId | string | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: RemoveUserBadgeResponse
Przykład

OtwórzPonownieWątek 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

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

UtwórzModeratora 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: CreateModeratorResponse
Przykład

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

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

PobierzModeratorów 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetModeratorsResponse
Przykład

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

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

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

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

PobierzLicznikPowiadomień 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Odpowiedź
Zwraca: GetNotificationCountResponse
Przykład

PobierzPowiadomienia 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| urlId | string | query | Nie | |
| fromCommentId | string | query | Nie | |
| viewed | boolean | query | Nie | |
| type | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetNotificationsResponse
Przykład

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

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

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

UsuńReakcjęNaStronieV1 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

UsuńReakcjęNaStronieV2 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| id | string | query | Tak |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

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

PobierzReakcjeStronyV2 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak |
Odpowiedź
Zwraca: GetV2PageReacts
Przykład

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

DodajStronę 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: AddPageAPIResponse
Przykład

UsuńStronę 
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: DeletePageAPIResponse
Przykład

PobierzUżytkownikówOffline 
Poprzedni komentujący na stronie, którzy NIE są obecnie online. Posortowane według displayName. Użyj tego po wyczerpaniu /users/online, aby wyświetlić sekcję "Członkowie". Paginacja kursorowa po commenterName: serwer przegląda częściowy indeks {tenantId, urlId, commenterName} zaczynając od afterName i idąc w przód za pomocą $gt, bez kosztu $skip.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identyfikator URL strony (oczyszczony po stronie serwera). |
| afterName | string | query | No | Kursor: przekaż nextAfterName z poprzedniej odpowiedzi. |
| afterUserId | string | query | No | Rozstrzygacz kursora: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy afterName jest ustawione, aby przy remisach nazw wpisy nie zostały pominięte. |
Response
Zwraca: PageUsersOfflineResponse
Example

PobierzUżytkownikówOnline 
Obecnie online widzowie strony: osoby, których sesja websocket jest aktualnie subskrybująca stronę. Zwraca anonCount + totalCount (subskrybenci w całym pokoju, wliczając anonimowych widzów, których nie wyliczamy).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identyfikator URL strony (oczyszczany po stronie serwera). |
| afterName | string | query | No | Cursor: przekaż nextAfterName z poprzedniej odpowiedzi. |
| afterUserId | string | query | No | Rozstrzygacz kursora: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy afterName jest ustawione, aby remisy nazw nie powodowały pominięcia wpisów. |
Response
Zwraca: PageUsersOnlineResponse
Example

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

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

PobierzStronyPubliczne 
Wylistuj strony dla najemcy. Używane przez klienta desktopowego FChat do wypełnienia swojej listy pokoi.
Wymaga, aby enableFChat było ustawione na true w rozstrzygniętej konfiguracji niestandardowej dla każdej strony.
Strony, które wymagają SSO, są filtrowane względem dostępu grupowego użytkownika wysyłającego żądanie.
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Niejawny kursor paginacji zwrócony jako nextCursor z poprzedniego żądania. Powiązany z tym samym sortBy. |
| limit | integer | query | No | 1..200, domyślnie 50 |
| q | string | query | No | Opcjonalny filtr prefiksu tytułu niezależny od wielkości liter. |
| sortBy | string | query | No | Kolejność sortowania. updatedAt (domyślnie, najnowsze pierwsze), commentCount (najpierw najwięcej komentarzy), lub title (alfabetycznie). |
| hasComments | boolean | query | No | Jeśli true, zwróć tylko strony mające co najmniej jeden komentarz. |
Odpowiedź
Zwraca: GetPublicPagesResponse
Przykład

PobierzInformacjeOUżytkownikach 
Zbiorcze informacje o użytkownikach dla tenant. Na podstawie userIds zwraca informacje wyświetlane z User / SSOUser. Używane przez widżet komentarzy do wzbogacenia użytkowników, którzy właśnie pojawili się w wyniku zdarzenia obecności. Brak kontekstu strony: prywatność jest egzekwowana jednakowo (profile prywatne są zamaskowane).
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| ids | string | query | Tak | userIds rozdzielone przecinkami. |
Odpowiedź
Zwraca: PageUsersInfoResponse
Przykład

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

UsuńOczekująceZdarzenieWebhooka 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

PobierzLiczbęOczekującychZdarzeńWebhooka 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEventCountResponse
Przykład

PobierzOczekująceZdarzeniaWebhooka 
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 | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetPendingWebhookEventsResponse
Przykład

UtwórzKonfiguracjęPytania 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionConfigResponse
Przykład

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

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

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

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

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

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

PobierzWynikiPytań 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

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

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

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

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

DodajUżytkownikaSSO 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: AddSSOUserAPIResponse
Przykład

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

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

PobierzUżytkownikaSSOPoId 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Zwraca
Zwraca: GetSSOUserByIdAPIResponse
Przykład

PobierzUżytkownikówSSO 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | integer | query | Nie |
Odpowiedź
Zwraca: GetSSOUsersResponse
Przykład

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

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

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

UsuńSubskrypcję 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak | |
| userId | string | zapytanie | Nie |
Odpowiedź
Zwraca: DeleteSubscriptionAPIResponse
Przykład

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

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

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

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

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

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

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

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

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

UtwórzUżytkownikaNajemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantUserResponse
Przykład

UsuńUżytkownikaNajemcy 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | string | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

PobierzUżytkownikaNajemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantUserResponse
Przykład

PobierzUżytkownikówNajemcy 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantUsersResponse
Przykład

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

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

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

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

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

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

PobierzNajemców 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| meta | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantsResponse
Przykład

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

ZmieńStanZgłoszenia 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| userId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak |
Odpowiedź
Zwraca: ChangeTicketStateResponse
Przykład

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

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

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

PobierzTłumaczenia 
Parametry
| 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

WyślijObraz 
Prześlij i zmień rozmiar obrazu
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| sizePreset | string | query | Nie | Ustawienie rozmiaru: "Default" (1000x1000px) lub "CrossPlatform" (tworzy rozmiary dla popularnych urządzeń) |
| urlId | string | query | Nie | ID strony, z której odbywa się przesyłanie, do konfiguracji |
Odpowiedź
Zwraca: UploadImageResponse
Przykład

PobierzPostępyOdznakUżytkownikaPoId 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeProgressResponse
Przykład

PobierzPostępyOdznakUżytkownikaPoUżytkownikuId 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | path | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeProgressResponse
Przykład

PobierzListęPostępówOdznakUżytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: APIGetUserBadgeProgressListResponse
Przykład

UtwórzOdznakęUżytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: APICreateUserBadgeResponse
Przykład

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

PobierzOdznakęUżytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeResponse
Przykład

PobierzOdznakiUżytkownika 
Parametry
| 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 |
Odpowiedź
Zwraca: APIGetUserBadgesResponse
Przykład

AktualizujOdznakęUżytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptySuccessResponse
Przykład

PobierzLicznikPowiadomieńUżytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserNotificationCountResponse
Przykład

PobierzPowiadomieniaUżytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Służy 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

ZresetujLicznikPowiadomieńUżytkownika 
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ResetUserNotificationsResponse
Przykład

ZresetujPowiadomieniaUżytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ResetUserNotificationsResponse
Przykład

AktualizujStatusSubskrypcjiPowiadomieńKomentarzyUżytkownika 
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

AktualizujStatusSubskrypcjiPowiadomieńStronyUżytkownika 
Włącz lub wyłącz powiadomienia dla strony. Gdy użytkownicy są subskrybowani do strony, powiadomienia są tworzone 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

AktualizujStatusPowiadomieniaUżytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| notificationId | string | path | Tak | |
| newStatus | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatusResponse
Przykład

PobierzStatusyObecnościUżytkownika 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlIdWS | string | query | Tak | |
| userIds | string | query | Tak |
Odpowiedź
Zwraca: GetUserPresenceStatusesResponse
Przykład

WyszukajUżytkowników 
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

PobierzUżytkownika 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserResponse
Przykład

UtwórzGłos 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odpowiedź
Zwraca: VoteResponse
Przykład

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

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

PobierzGłosyUżytkownika 
Parametry
| Name | Type | Location | Wymagane | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: GetVotesForUserResponse
Przykład

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