
Jezik 🇸🇮 Slovenščina
Uvod
Dokumentacija
Referenca API
Agregacija
Revizijski dnevniki
Avtentikacija
Blokiranje zaradi komentarja
Preverjanje blokiranih komentarjev
Komentarji
Komentarji za uporabnika
Konfiguracije domene
Predloge e-pošte
Dnevnik dogodkov
Objave vira
Označevanje komentarjev
GIF-i
Hashtagi
Moderacija
Moderatorji
Število obvestil
Obvestila
Reakcije strani
Strani
Čakajoči webhook dogodki
Konfiguracije vprašanj
Rezultati vprašanj
Agregacija rezultatov vprašanj
SSO uporabniki
Naročnine
Dnevna poraba najemnika
Paketi najemnika
Uporabniki najemnika
Najemniki
Tiketi
Prevodi
Naloži sliko
Napredek značke uporabnika
Značke uporabnika
Uporabniška obvestila
Status prisotnosti uporabnika
Iskanje uporabnikov
Uporabniki
Glasovi
FastComments SDK za Swift
To je uradni Swift SDK za FastComments.
Uradni Swift SDK za FastComments API
Repozitorij
Installation 
Swift Package Manager
Add the following to your Package.swift file:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.0.0")
]
Or in Xcode:
- Datoteka > Dodaj pakete...
- Vnesite URL repozitorija:
https://github.com/fastcomments/fastcomments-swift.git - Izberite verzijo, ki jo želite uporabiti
Requirements
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Library Contents 
FastComments Swift SDK je sestavljen iz več modulov:
-
Client Module - API odjemalec za FastComments REST API-je
- Celovite definicije tipov za vse API modele
- Metode: avtenticirane (
DefaultAPI), javne (PublicAPI) in za moderacijo (ModerationAPI) - Popolna podpora za async/await
- Oglejte si client/README.md za podrobno dokumentacijo API-ja
-
SSO Module - Strežniški pripomočki za Single Sign-On
- Varen postopek generiranja žetonov za preverjanje pristnosti uporabnika
- Podpora tako za preprost kot varen način SSO
- Podpisovanje žetonov, temelječe na HMAC-SHA256, z uporabo CryptoKit
Quick Start 
Uporaba javnega API-ja
import FastCommentsSwift
// Pridobi komentarje za stran
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)")
}
Uporaba avtenticiranega API-ja
import FastCommentsSwift
// Nastavite svoj API ključ v deljeni konfiguraciji (poslano kot glava x-api-key)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Pridobite komentarje z avtenticiranim API-jem
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)")
}
Uporaba Moderacijskega API-ja
import FastCommentsSwift
// Metode moderiranja so avtorizirane s `sso` žetonom za delujočega moderatorja
// (ustvarite ga s FastCommentsSSO, glejte razdelek SSO zgoraj).
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)")
}
Uporaba SSO za avtentikacijo
Varno SSO (priporočeno za produkcijo)
import FastCommentsSwift
let apiKey = "your-api-key"
// Ustvarite varne SSO uporabniške podatke (samo na strežniku!)
let userData = SecureSSOUserData(
id: "user-123", // User ID
email: "user@example.com", // Email
username: "johndoe", // Username
avatar: "https://example.com/avatar.jpg" // Avatar URL
)
// Generirajte SSO žeton
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Posredujte ta žeton vašemu frontendu za avtentikacijo
} catch {
print("Error creating SSO token: \(error)")
}
Preprosto SSO (za razvoj/testiranje)
import FastCommentsSwift
// Ustvarite preproste SSO uporabniške podatke (ni potrebnega API ključa)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Generirajte preprost SSO žeton
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API Clients 
FastComments SDK zagotavlja tri API odjemalce:
PublicAPI - Metode, varne za odjemalca
PublicAPI vsebuje metode, ki so varne za klicanje iz odjemalske kode (iOS/macOS aplikacije). Te metode:
- Ne zahtevajo API ključa
- Lahko uporabljajo SSO žetone za overjanje
- So omejene po hitrosti na uporabnika/napravo
- So primerne za aplikacije, usmerjene končnemu uporabniku
Primer uporabe: Pridobivanje in ustvarjanje komentarjev v vaši iOS aplikaciji
DefaultAPI - Metode na strežniški strani
DefaultAPI vsebuje avtenticirane metode, ki zahtevajo API ključ. Te metode:
- Zahtevajo vaš FastComments API ključ
- Morajo biti klicane le iz strežniške kode
- Omogočajo popoln dostop do vaših FastComments podatkov
- So omejene po hitrosti na najemnika
Primer uporabe: Administrativna opravila, množični izvoz podatkov, upravljanje uporabnikov
ModerationAPI - Metode nadzorne plošče moderatorja
ModerationAPI ponuja obsežen nabor hitrih in živih moderacijskih API-jev. Vsaka metoda ModerationAPI sprejme parameter sso in se lahko overi prek SSO ali FastComments.com piškotka seje.
Primer uporabe: Gradnja moderacijske izkušnje za moderatorje vaše skupnosti
POMEMBNO: Nikoli ne razkrivajte svojega API ključa v odjemalski kodi. API ključe je treba uporabljati le na strežniku.
Making API Calls 
Swift SDK uporablja sodobno sintakso async/await za vse klice API-jev:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Common Issues 
401 napake nepooblaščene
Če dobivate napake 401 pri uporabi avtenticiranega API-ja:
- Preverite svoj API ključ: Prepričajte se, da uporabljate pravilen API ključ iz vašega nadzornega plošča FastComments
- Preverite ID najemnika: Prepričajte se, da se ID najemnika ujema z vašim računom
- Oblika API ključa: API ključ naj bo nastavljen kot glava
x-api-keyv skupni konfiguraciji:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Uporaba napačnega API-ja: Prepričajte se, da uporabljate
DefaultAPI(nePublicAPI) za avtenticirane klice
Težave s SSO žetoni
Če SSO žetoni ne delujejo:
- Uporabite varen način za produkcijo: Vedno uporabljajte
FastCommentsSSO.createSecure()s svojim API ključem za produkcijo - Samo strežniška stran: Generirajte varne SSO žetone na vašem strežniku, nikoli ne razkrivajte svojega API ključa odjemalcem
- Preverite podatke uporabnika: Prepričajte se, da so zagotovljena vsa obvezna polja (id, e-pošta, uporabniško ime)
- Iztek žetona: Varni SSO žetoni vsebujejo časovni žig in lahko potečejo. Po potrebi ustvarite sveže žetone.
SSL/TLS napake
Če naletite na SSL/TLS napake:
- Prepričajte se, da vaša datoteka Info.plist aplikacije dovoljuje HTTPS povezave do fastcomments.com
- Preverite, da ne uporabljate izjem App Transport Security, ki bi lahko blokirale povezavo
Notes 
ID-ji za oddajanje
Videli boste, da morate v nekaterih klicih API posredovati broadcastId. Ko prejmete dogodke, boste ta ID dobili nazaj, tako da boste vedeli, da ga lahko prezrete, če nameravate optimistično uporabiti spremembe na odjemalcu (kar boste verjetno želeli storiti, saj nudi najboljšo izkušnjo). Tukaj posredujte UUID. ID naj bo dovolj edinstven, da se v eni seji ne pojavi dvakrat.
let broadcastId = UUID().uuidString
aggregate 
Aggregira dokumente z njihovim grupiranjem (če je podan parameter groupBy) in uporabo več operacij. Podprte so različne operacije (npr. sum, countDistinct, avg itd.).
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| parentTenantId | string | query | Ne | |
| includeStats | boolean | query | Ne |
Odziv
Vrne: AggregateResponse
Primer

getAuditLogs 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| limit | number | query | Ne | |
| skip | number | query | Ne | |
| order | string | query | Ne | |
| after | number | query | Ne | |
| before | number | query | Ne |
Odgovor
Vrne: GetAuditLogsResponse
Primer

logoutPublic 
Odgovor
Vrne: APIEmptyResponse
Primer

blockFromCommentPublic 
Parametri
| Ime | Tip | Location | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: BlockSuccess
Primer

unBlockCommentPublic 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| sso | string | query | Ne |
Odziv
Vrne: UnblockSuccess
Primer

checkedCommentsForBlocked 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentIds | string | query | Da | Seznam ID-jev komentarjev, ločen z vejicami. |
| sso | string | query | Ne |
Odgovor
Vrača: CheckBlockedCommentsResponse
Primer

blockUserFromComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne | |
| anonUserId | string | query | Ne |
Odgovor
Vrne: BlockSuccess
Primer

createCommentPublic 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: SaveCommentsResponseWithPresence
Primer

deleteComment 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Odgovor
Vrne: DeleteCommentResult
Primer

deleteCommentPublic 
Parameters
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Da | |
| editKey | string | query | Ne | |
| sso | string | query | Ne |
Response
Vrne: PublicAPIDeleteCommentResponse
Primer

deleteCommentVote 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | 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 |
Odziv
Vrne: VoteDeleteResponse
Primer

flagComment 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne | |
| anonUserId | string | query | Ne |
Odziv
Vrne: FlagCommentResponse
Primer

getComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIGetCommentResponse
Primer

getComments 
Parametri
| Ime | Tip | Lokacija | Obvezno | 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 |
Odziv
Vrne: APIGetCommentsResponse
Primer

getCommentsPublic 
zahteva tenantId urlId
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Odgovor
Vrne: GetCommentsResponseWithPresencePublicComment
Primer

getCommentText 
Parameters
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: PublicAPIGetCommentTextResponse
Primer

getCommentVoteUserNames 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| commentId | string | path | Da | |
| dir | integer | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: GetCommentVoteUserNamesSuccessResponse
Primer

lockComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrača: APIEmptyResponse
Primer

pinComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: ChangeCommentPinStatusResponse
Primer

saveComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| isLive | boolean | query | Ne | |
| doSpamCheck | boolean | query | Ne | |
| sendEmails | boolean | query | Ne | |
| populateNotifications | boolean | query | Ne |
Odziv
Vrne: APISaveCommentResponse
Primer

saveCommentsBulk 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Odgovor
Vrne: [SaveCommentsBulkResponse]
Primer

setCommentText 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Da | |
| editKey | string | query | Ne | |
| sso | string | query | Ne |
Response
Vrne: PublicAPISetCommentTextResponse
Example

unBlockUserFromComment 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne | |
| anonUserId | string | query | Ne |
Odziv
Vrne: UnblockSuccess
Primer

unFlagComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odgovor
Vrne: FlagCommentResponse
Primer

unLockComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

unPinComment 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: ChangeCommentPinStatusResponse
Primer

updateComment 
Parameters
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| contextUserId | string | query | Ne | |
| doSpamCheck | boolean | query | Ne | |
| isLive | boolean | query | Ne |
Response
Vrne: APIEmptyResponse
Primer

voteComment 
Parameters
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| commentId | string | path | Da | |
| urlId | string | query | Da | |
| broadcastId | string | query | Da | |
| sessionId | string | query | Ne | |
| sso | string | query | Ne |
Response
Vrne: VoteResponse
Primer

getCommentsForUser 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| 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 |
Odgovor
Vrne: GetCommentsForUserResponse
Primer

addDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: AddDomainConfigResponse
Primer

deleteDomainConfig 
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| domain | string | path | Da |
Odziv
Vrne: DeleteDomainConfigResponse
Primer

getDomainConfig 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| domain | string | path | Da |
Odziv
Vrne: GetDomainConfigResponse
Primer

getDomainConfigs 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: GetDomainConfigsResponse
Primer

patchDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| domainToUpdate | string | path | Da |
Odgovor
Vrne: PatchDomainConfigResponse
Primer

putDomainConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| domainToUpdate | string | path | Da |
Odziv
Vrača: PutDomainConfigResponse
Primer

createEmailTemplate 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: CreateEmailTemplateResponse
Primer

deleteEmailTemplate 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

deleteEmailTemplateRenderError 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| errorId | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

getEmailTemplate 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: GetEmailTemplateResponse
Primer

getEmailTemplateDefinitions 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: GetEmailTemplateDefinitionsResponse
Primer

getEmailTemplateRenderErrors 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| skip | number | query | Ne |
Odgovor
Vrne: GetEmailTemplateRenderErrorsResponse
Primer

getEmailTemplates 
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| skip | number | query | Ne |
Odziv
Vrne: GetEmailTemplatesResponse
Primer

renderEmailTemplate 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| locale | string | query | Ne |
Odgovor
Vrača: RenderEmailTemplateResponse
Primer

updateEmailTemplate 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

getEventLog 
req tenantId urlId userIdWS
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | |
| userIdWS | string | query | Da | |
| startTime | integer | query | Da | |
| endTime | integer | query | Ne |
Odgovor
Vrača: GetEventLogResponse
Primer

getGlobalEventLog 
req tenantId urlId userIdWS
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | |
| userIdWS | string | query | Da | |
| startTime | integer | query | Da | |
| endTime | integer | query | Ne |
Odgovor
Vrne: GetEventLogResponse
Primer

createFeedPost 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| broadcastId | string | query | Ne | |
| isLive | boolean | query | Ne | |
| doSpamCheck | boolean | query | Ne | |
| skipDupCheck | boolean | query | Ne |
Odgovor
Vrne: CreateFeedPostsResponse
Primer

createFeedPostPublic 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: CreateFeedPostResponse
Primer

deleteFeedPostPublic 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| postId | string | path | Da | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: DeleteFeedPostPublicResponse
Primer

getFeedPosts 
req tenantId afterId
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| afterId | string | query | Ne | |
| limit | integer | query | Ne | |
| tags | array | query | Ne |
Odgovor
Vrne: GetFeedPostsResponse
Primer

getFeedPostsPublic 
req tenantId afterId
Parametri
| Ime | Vrsta | Lokacija | Obvezno | 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 |
Odgovor
Vrne: PublicFeedPostsResponse
Primer

getFeedPostsStats 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| postIds | array | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: FeedPostsStatsResponse
Primer

getUserReactsPublic 
Parametri
| Ime | Tip | Mesto | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Odgovor
Vrne: UserReactsResponse
Primer

reactFeedPostPublic 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: ReactFeedPostResponse
Primer

updateFeedPost 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrača: APIEmptyResponse
Primer

updateFeedPostPublic 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: CreateFeedPostResponse
Primer

flagCommentPublic 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| isFlagged | boolean | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrača: APIEmptyResponse
Primer

getGifLarge 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| largeInternalURLSanitized | string | query | Da |
Odgovor
Vrne: GifGetLargeResponse
Primer

getGifsSearch 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Odgovor
Vrne: GetGifsSearchResponse
Primer

getGifsTrending 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Odgovor
Returns: GetGifsTrendingResponse
Primer

addHashTag 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: CreateHashTagResponse
Primer

addHashTagsBulk 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odgovor
Vrne: BulkCreateHashTagsResponse
Primer

deleteHashTag 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Odgovor
Vrne: APIEmptyResponse
Primer

getHashTags 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| page | number | query | Ne |
Odgovor
Vrne: GetHashTagsResponse
Primer

patchHashTag 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| tag | string | path | Da |
Odgovor
Vrne: UpdateHashTagResponse
Primer

deleteModerationVote 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: VoteDeleteResponse
Primer

getApiComments 
Parametri
| Ime | Tip | Lokacija | Obvezno | 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 |
Odgovor
Vrne: ModerationAPIGetCommentsResponse
Primer

getApiExportStatus 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: ModerationExportStatusResponse
Primer

getApiIds 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Odgovor
Vrne: ModerationAPIGetCommentIdsResponse
Primer

getBanUsersFromComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odgovor
Vrne: GetBannedUsersFromCommentResponse
Primer

getCommentBanStatus 
Parameters
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odgovor
Vrne: GetCommentBanStatusResponse
Primer

getCommentChildren 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: ModerationAPIChildCommentsResponse
Primer

getCount 
Parametri
| Ime | Tip | Lokacija | Obvezno | 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 |
Odgovor
Vrne: ModerationAPICountCommentsResponse
Primer

getCounts 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odgovor
Vrne: GetBannedUsersCountResponse
Primer

getLogs 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: ModerationAPIGetLogsResponse
Primer

getManualBadges 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: GetTenantManualBadgesResponse
Primer

getManualBadgesForUser 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| badgesUserId | string | query | Ne | |
| commentId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: GetUserManualBadgesResponse
Primer

getModerationComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Odgovor
Vrne: ModerationAPICommentResponse
Primer

getModerationCommentText 
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| sso | string | query | Ne |
Odziv
Vrne: GetCommentTextResponse
Primer

getPreBanSummary 
Parametri
| Ime | Tip | Lokacija | Obvezno | 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 |
Odgovor
Vrne: PreBanSummary
Primer

getSearchCommentsSummary 
Parametri
| Ime | Tip | Lokacija | Oblobiten | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Odgovor
Returns: ModerationCommentSearchResponse
Primer

getSearchPages 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: ModerationPageSearchResponse
Primer

getSearchSites 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| value | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: ModerationSiteSearchResponse
Primer

getSearchSuggest 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| text-search | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: ModerationSuggestResponse
Primer

getSearchUsers 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| value | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: ModerationUserSearchResponse
Primer

getTrustFactor 
Parameters
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| userId | string | query | Ne | |
| sso | string | query | Ne |
Response
Vrne: GetUserTrustFactorResponse
Example

getUserBanPreference 
Parameters
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| sso | string | query | Ne |
Response
Vrne: APIModerateGetUserBanPreferencesResponse
Example

getUserInternalProfile 
Parameters
| Ime | Tip | Mesto | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | query | Ne | |
| sso | string | query | Ne |
Response
Vrne: GetUserInternalProfileResponse
Primer

postAdjustCommentVotes 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: AdjustVotesResponse
Primer

postApiExport 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| text-search | string | query | Ne | |
| byIPFromComment | string | query | Ne | |
| filters | string | query | Ne | |
| searchFilters | string | query | Ne | |
| sorts | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: ModerationExportResponse
Primer

postBanUserFromComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| banEmail | boolean | query | Ne | |
| banEmailDomain | boolean | query | Ne | |
| banIP | boolean | query | Ne | |
| deleteAllUsersComments | boolean | query | Ne | |
| bannedUntil | string | query | Ne | |
| isShadowBan | boolean | query | Ne | |
| updateId | string | query | Ne | |
| banReason | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: BanUserFromCommentResult
Primer

postBanUserUndo 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

postBulkPreBanSummary 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Odgovor
Vrne: BulkPreBanSummary
Primer

postCommentsByIds 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odziv
Vrne: ModerationAPIChildCommentsResponse
Primer

postFlagComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: APIEmptyResponse
Primer

postRemoveComment 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: PostRemoveCommentApiResponse
Primer

postRestoreDeletedComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

postSetCommentApprovalStatus 
Parameters
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Vrne: SetCommentApprovedResponse
Example

postSetCommentReviewStatus 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: APIEmptyResponse
Primer

postSetCommentSpamStatus 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| spam | boolean | query | Ne | |
| permNotSpam | boolean | query | Ne | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

postSetCommentText 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: SetCommentTextResponse
Primer

postUnFlagComment 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vrne: APIEmptyResponse
Primer

postVote 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| direction | string | query | Ne | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: VoteResponse
Primer

putAwardBadge 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | 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 |
Odgovor
Vrne: AwardUserBadgeResponse
Primer

putCloseThread 
Parameters
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| urlId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

putRemoveBadge 
Parametri
| Ime | Tip | Lokacija | Obvezno | 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 |
Odgovor
Vrne: RemoveUserBadgeResponse
Primer

putReopenThread 
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Odgovor
Vrne: APIEmptyResponse
Primer

setTrustFactor 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| userId | string | query | Ne | |
| trustFactor | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vrne: SetUserTrustFactorResponse
Primer

createModerator 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: CreateModeratorResponse
Primer

deleteModerator 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| sendEmail | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

getModerator 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odgovor
Vrne: GetModeratorResponse
Primer

getModerators 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| skip | number | query | Ne |
Odgovor
Vrača: GetModeratorsResponse
Primer

sendInvite 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| fromName | string | query | Da |
Odgovor
Vrača: APIEmptyResponse
Primer

updateModerator 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

deleteNotificationCount 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

getCachedNotificationCount 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: GetCachedNotificationCountResponse
Primer

getNotificationCount 
Parameters
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| userId | string | query | Ne | |
| urlId | string | query | Ne | |
| fromCommentId | string | query | Ne | |
| viewed | boolean | query | Ne | |
| type | string | query | Ne |
Response
Vrne: GetNotificationCountResponse
Example

getNotifications 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | 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 |
Odgovor
Returns: GetNotificationsResponse
Primer

updateNotification 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

createV1PageReact 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | |
| title | string | query | Ne |
Response
Vrne: CreateV1PageReact
Example

createV2PageReact 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | |
| id | string | query | Da | |
| title | string | query | Ne |
Odgovor
Vrne: CreateV1PageReact
Primer

deleteV1PageReact 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da |
Odgovor
Vrača: CreateV1PageReact
Primer

deleteV2PageReact 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | |
| id | string | query | Da |
Odgovor
Vrne: CreateV1PageReact
Primer

getV1PageLikes 
Parametri
| Ime | Tip | Location | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da |
Odgovor
Vrne: GetV1PageLikes
Primer

getV2PageReacts 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da |
Odziv
Vrača: GetV2PageReacts
Primer

getV2PageReactUsers 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | |
| id | string | query | Da |
Odgovor
Vrne: GetV2PageReactUsersResponse
Primer

addPage 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrača: AddPageAPIResponse
Primer

deletePage 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: DeletePageAPIResponse
Primer

getOfflineUsers 
Past komentatorji na strani, ki NI trenutno online. Razvrščeni po displayName.
Uporabi to po izčrpavanju /users/online, da prikažeš razdelek “Člani”.
Cursor paginacija po commenterName: strežnik hodi po delnem {tenantId, urlId, commenterName} indeks od afterName naprej prek $gt, brez stroška $skip.
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | Identifikator URL strani (očiščen na strežniku). |
| afterName | string | query | Ne | Cursor: posreduj nextAfterName iz prejšnjega odgovora. |
| afterUserId | string | query | Ne | Cursor tiebreaker: posreduj nextAfterUserId iz prejšnjega odgovora. Obvezno, ko je nastavljen afterName, da se imenski neodločenost ne izpusti vnosi. |
Odgovor
Vrne: PageUsersOfflineResponse
Primer

getOnlineUsers 
Trenutno spletni gledalci strani: ljudje, katerih se seja WebSocket naroči na stran zdaj.
Vrne anonCount + totalCount (naročniki po celotni sobi, vključno z anonimnimi gledalci, ki jih ne izštejemo).
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | Identifikator URL naslova strani (čiščen na strežniku). |
| afterName | string | query | Ne | Kazalec: posredujte nextAfterName iz prejšnjega odgovora. |
| afterUserId | string | query | Ne | Razreševalnik za enake kazalce: posredujte nextAfterUserId iz prejšnjega odgovora. Obvezno, ko je nastavljen afterName, da se pri enakih imenih ne izpustijo vnosi. |
Odgovor
Vrne: PageUsersOnlineResponse
Primer

getPageByURLId 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| urlId | string | query | Da |
Odgovor
Vrne: GetPageByURLIdAPIResponse
Primer

getPages 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: GetPagesAPIResponse
Primer

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Neprozoren kurzor za paginacijo, vrnjen kot nextCursor iz prejšnje zahteve. Povezan z istim sortBy. |
| limit | integer | query | No | 1..200, privzeto 50 |
| q | string | query | No | Neobvezni neobčutljiv na velikost črk filter predpone naslova. |
| sortBy | string | query | No | Vrstni red. updatedAt (privzeto, najnovejše najprej), commentCount (največ komentarjev najprej) ali title (abecedno). |
| hasComments | boolean | query | No | Če je true, vrne le strani z vsaj enim komentarjem. |
Response
Vrne: GetPublicPagesResponse
Primer

getUsersInfo 
Skupinska informacija o uporabnikih za najemnika. Glede na userIds vrne prikazne informacije iz User / SSOUser. Uporablja se v pripomočku za komentarje za obogatitev uporabnikov, ki so se pravkar pojavili prek dogodka prisotnosti. Brez konteksta strani: zasebnost se dosledno uveljavlja (zasebni profili so zamaskirani).
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | Vrednosti userIds ločene z vejicami. |
Odgovor
Vrača: PageUsersInfoResponse
Primer

patchPage 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrača: PatchPageAPIResponse
Primer

deletePendingWebhookEvent 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

getPendingWebhookEventCount 
Parameters
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Response
Vrne: GetPendingWebhookEventCountResponse
Primer

getPendingWebhookEvents 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | query | Ne | |
| externalId | string | query | Ne | |
| eventType | string | query | Ne | |
| type | string | query | Ne | |
| domain | string | query | Ne | |
| attemptCountGT | number | query | Ne | |
| skip | number | query | Ne |
Odgovor
Vrne: GetPendingWebhookEventsResponse
Primer

createQuestionConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odgovor
Vrne: CreateQuestionConfigResponse
Primer

deleteQuestionConfig 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrača: APIEmptyResponse
Primer

getQuestionConfig 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrača: GetQuestionConfigResponse
Primer

getQuestionConfigs 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| skip | number | query | Ne |
Odgovor
Vrne: GetQuestionConfigsResponse
Primer

updateQuestionConfig 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

createQuestionResult 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odziv
Vrne: CreateQuestionResultResponse
Primer

deleteQuestionResult 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrača: APIEmptyResponse
Primer

getQuestionResult 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: GetQuestionResultResponse
Primer

getQuestionResults 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| urlId | string | query | Ne | |
| userId | string | query | Ne | |
| startDate | string | query | Ne | |
| questionId | string | query | Ne | |
| questionIds | string | query | Ne | |
| skip | number | query | Ne |
Odziv
Vrne: GetQuestionResultsResponse
Primer

updateQuestionResult 
Parametri
| Ime | Type | Location | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

aggregateQuestionResults 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | 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 |
Odgovor
Vrne: AggregateQuestionResultsResponse
Primer

bulkAggregateQuestionResults 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| forceRecalculate | boolean | query | Ne |
Odgovor
Vrne: BulkAggregateQuestionResultsResponse
Primer

combineCommentsWithQuestionResults 
Parametri
| Ime | Tip | Lokacija | Obvezno | 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 |
Odgovor
Vrne: CombineQuestionResultsWithCommentsResponse
Primer

addSSOUser 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: AddSSOUserAPIResponse
Primer

deleteSSOUser 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| deleteComments | boolean | query | Ne | |
| commentDeleteMode | string | query | Ne |
Odziv
Vrne: DeleteSSOUserAPIResponse
Primer

getSSOUserByEmail 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| string | path | Da |
Odgovor
Vrne: GetSSOUserByEmailAPIResponse
Primer

getSSOUserById 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: GetSSOUserByIdAPIResponse
Primer

getSSOUsers 
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| skip | integer | query | Ne |
Odziv
Vrne: GetSSOUsersResponse
Primer

patchSSOUser 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| updateComments | boolean | query | Ne |
Odgovor
Vrača: PatchSSOUserAPIResponse
Primer

putSSOUser 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| updateComments | boolean | query | Ne |
Odgovor
Vrne: PutSSOUserAPIResponse
Primer

createSubscription 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrača: CreateSubscriptionAPIResponse
Primer

deleteSubscription 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne |
Odgovor
Vrača: DeleteSubscriptionAPIResponse
Primer

getSubscriptions 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| userId | string | query | Ne |
Odgovor
Vrača: GetSubscriptionsAPIResponse
Primer

updateSubscription 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne |
Odziv
Vrne: UpdateSubscriptionAPIResponse
Primer

getTenantDailyUsages 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| yearNumber | number | query | Ne | |
| monthNumber | number | query | Ne | |
| dayNumber | number | query | Ne | |
| skip | number | query | Ne |
Odgovor
Vrne: GetTenantDailyUsagesResponse
Primer

createTenantPackage 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: CreateTenantPackageResponse
Primer

deleteTenantPackage 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

getTenantPackage 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: GetTenantPackageResponse
Primer

getTenantPackages 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| skip | number | query | Ne |
Odziv
Vrača: GetTenantPackagesResponse
Primer

replaceTenantPackage 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odziv
Vrača: APIEmptyResponse
Primer

updateTenantPackage 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrača: APIEmptyResponse
Primer

createTenantUser 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odziv
Vrača: CreateTenantUserResponse
Primer

deleteTenantUser 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Odgovor
Vrne: APIEmptyResponse
Primer

getTenantUser 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Response
Vrne: GetTenantUserResponse
Primer

getTenantUsers 
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| skip | number | query | Ne |
Odgovor
Vrača: GetTenantUsersResponse
Primer

replaceTenantUser 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| updateComments | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

sendLoginLink 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| redirectURL | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

updateTenantUser 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| updateComments | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

createTenant 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Odgovor
Vrne: CreateTenantResponse
Primer

deleteTenant 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| sure | string | query | Ne |
Odgovor
Vrne: APIEmptyResponse
Primer

getTenant 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: GetTenantResponse
Primer

getTenants 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| meta | string | query | Ne | |
| skip | number | query | Ne |
Odgovor
Vrne: GetTenantsResponse
Primer

updateTenant 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptyResponse
Primer

changeTicketState 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| userId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: ChangeTicketStateResponse
Primer

createTicket 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes |
Odgovor
Vrača: CreateTicketResponse
Primer

getTicket 
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne |
Odgovor
Vrne: GetTicketResponse
Primer

getTickets 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| userId | string | query | Ne | |
| state | number | query | Ne | |
| skip | number | query | Ne | |
| limit | number | query | Ne |
Odgovor
Vrne: GetTicketsResponse
Primer

getTranslations 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Odgovor
Vrne: GetTranslationsResponse
Primer

uploadImage 
Naloži in spremeni velikost slike
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| sizePreset | string | query | Ne | Velikostni prednastavitev: "Default" (1000x1000px) ali "CrossPlatform" (ustvari velikosti za priljubljene naprave) |
| urlId | string | query | Ne | ID strani, s katere se izvaja nalaganje, za konfiguracijo |
Odgovor
Vrne: UploadImageResponse
Primer

getUserBadgeProgressById 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrača: APIGetUserBadgeProgressResponse
Primer

getUserBadgeProgressByUserId 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| userId | string | path | Da |
Odgovor
Vrača: APIGetUserBadgeProgressResponse
Primer

getUserBadgeProgressList 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| userId | string | query | Ne | |
| limit | number | query | Ne | |
| skip | number | query | Ne |
Odgovor
Vrne: APIGetUserBadgeProgressListResponse
Primer

createUserBadge 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | poizvedba | Da |
Odgovor
Vrača: APICreateUserBadgeResponse
Primer

deleteUserBadge 
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptySuccessResponse
Primer

getUserBadge 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIGetUserBadgeResponse
Primer

getUserBadges 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | poizvedba | Da | |
| userId | string | poizvedba | Ne | |
| badgeId | string | poizvedba | Ne | |
| type | number | poizvedba | Ne | |
| displayedOnComments | boolean | poizvedba | Ne | |
| limit | number | poizvedba | Ne | |
| skip | number | poizvedba | Ne |
Odgovor
Vrne: APIGetUserBadgesResponse
Primer

updateUserBadge 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: APIEmptySuccessResponse
Primer

getUserNotificationCount 
Parametri
| Ime | Tip | Lokacija | Zahtevano | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vrača: GetUserNotificationCountResponse
Primer

getUserNotifications 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Uporablja se za določitev, ali je trenutna stran naročena. |
| 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 |
Odgovor
Vrne: GetMyNotificationsResponse
Primer

resetUserNotificationCount 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| sso | string | query | Ne |
Odziv
Vrača: ResetUserNotificationsResponse
Primer

resetUserNotifications 
Parametri
| Ime | Vrsta | Lokacija | Obvezno | 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 |
Odgovor
Vrne: ResetUserNotificationsResponse
Primer

updateUserNotificationCommentSubscriptionStatus 
Omogoči ali onemogoči obvestila za določen komentar.
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| notificationId | string | path | Da | |
| optedInOrOut | string | path | Da | |
| commentId | string | query | Da | |
| sso | string | query | Ne | (neobvezno) |
Odziv
Vrne: UpdateUserNotificationCommentSubscriptionStatusResponse
Primer

updateUserNotificationPageSubscriptionStatus 
Omogočite ali onemogočite obvestila za stran. Ko so uporabniki naročeni na stran, se ustvarijo obvestila za nove korenske komentarje, in tudi
Parametri
| Ime | Vrsta | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Odgovor
Vrne: UpdateUserNotificationPageSubscriptionStatusResponse
Primer

updateUserNotificationStatus 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| notificationId | string | path | Da | |
| newStatus | string | path | Da | |
| sso | string | query | Ne |
Odgovor
Vrne: UpdateUserNotificationStatusResponse
Primer

getUserPresenceStatuses 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| urlIdWS | string | query | Da | |
| userIds | string | query | Da |
Odgovor
Vrne: GetUserPresenceStatusesResponse
Primer

searchUsers 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| urlId | string | query | Da | |
| usernameStartsWith | string | query | Ne | |
| mentionGroupIds | array | query | Ne | |
| sso | string | query | Ne | |
| searchSection | string | query | Ne |
Odziv
Vrne: SearchUsersResult
Primer

getUser 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vrne: GetUserResponse
Primer

createVote 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | query | Da | |
| direction | string | query | Da | |
| userId | string | query | Ne | |
| anonUserId | string | query | Ne |
Odziv
Vrne: VoteResponse
Primer

deleteVote 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| editKey | string | query | Ne |
Odziv
Vrne: VoteDeleteResponse
Primer

getVotes 
Parametri
| Ime | Tip | Lokacija | Obvezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| urlId | string | query | Da |
Odgovor
Vrne: GetVotesResponse
Primer

getVotesForUser 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Vrne: GetVotesForUserResponse
Example

Potrebujete pomoč?
Če naletite na težave ali imate vprašanja o Swift SDK, prosimo:
Prispevanje
Prispevki so dobrodošli! Prosimo, obiščite GitHub repozitorij za smernice za prispevanje.