
Sprog 🇩🇰 Dansk
Kom godt i gang
Dokumentation
API-reference
Aggregering
Revisionslogge
Autentificering
Bloker fra kommentar
Tjek blokerede kommentarer
Kommentarer
Kommentarer for bruger
Domænekonfigurationer
E-mail-skabeloner
Hændelseslog
Feedindlæg
Rapportér kommentar
GIF'er
Hashtags
Moderering
Moderatorer
Antal notifikationer
Notifikationer
Side-reaktioner
Sider
Afventende webhook-hændelser
Spørgsmålskonfigurationer
Spørgeresultater
Aggregering af spørgeresultater
SSO-brugere
Abonnementer
Lejers daglige forbrug
Lejerpakker
Lejerbrugere
Lejere
Tickets
Oversættelser
Upload billede
Brugerbadge-fremskridt
Brugerbadges
Brugernotifikationer
Bruger-tilstedeværelsesstatus
Brugersøgning
Brugere
Stemmer
FastComments Swift SDK
Dette er den officielle Swift SDK til FastComments.
Officiel Swift SDK til FastComments API'et
Repository
Installation 
Swift Package Manager
Tilføj følgende til din Package.swift-fil:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.0.0")
]
Eller i Xcode:
- Fil > Tilføj pakker…
- Indtast repository‑URL'en:
https://github.com/fastcomments/fastcomments-swift.git - Vælg den version, du vil bruge
Krav
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Biblioteksindhold 
The FastComments Swift SDK består af flere moduler:
-
Client Module - API-klient til FastComments REST-API'er
- Fuldstændige typedefinitioner for alle API-modeller
- Autentificerede (
DefaultAPI), offentlige (PublicAPI) og moderationsmetoder (ModerationAPI) - Fuld understøttelse af async/await
- Se client/README.md for detaljeret API-dokumentation
-
SSO Module - Server-side Single Sign-On-værktøjer
- Sikker token-generering til brugergodkendelse
- Understøtter både simple og sikre SSO-tilstande
- HMAC-SHA256-baseret token-signering ved hjælp af CryptoKit
Hurtig start 
Brug af den offentlige API
import FastCommentsSwift
// Hent kommentarer for en side
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)")
}
Brug af den autentificerede API
import FastCommentsSwift
// Konfigurer din API-nøgle i den delte konfiguration (sendt som x-api-key-headeren)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Hent kommentarer ved brug af den autentificerede API
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Brug af Moderations-API
import FastCommentsSwift
// Moderationsmetoder er autoriseret med en `sso`-token for den handlende moderator
// (generer den med FastCommentsSSO, se SSO-sektionen ovenfor).
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)")
}
Brug af SSO til autentificering
Sikker SSO (Anbefalet til produktion)
import FastCommentsSwift
let apiKey = "your-api-key"
// Opret sikker SSO-brugerdata (kun server-side!)
let userData = SecureSSOUserData(
id: "user-123", // Bruger-ID
email: "user@example.com", // E-mail
username: "johndoe", // Brugernavn
avatar: "https://example.com/avatar.jpg" // Avatar-URL
)
// Generer SSO-token
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Send denne token til din frontend for autentificering
} catch {
print("Error creating SSO token: \(error)")
}
Simpel SSO (Til udvikling/testning)
import FastCommentsSwift
// Opret simpel SSO-brugerdata (ingen API-nøgle nødvendig)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Generer simpel SSO-token
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-klienter 
The FastComments SDK provides three API clients:
PublicAPI - Klientsikre metoder
The PublicAPI contains methods that are safe to call from client-side code (iOS/macOS apps). These methods:
- Do not require an API key → Kræver ikke en API-nøgle
- Can use SSO tokens for authentication → Kan bruge SSO‑tokens til godkendelse
- Are rate-limited per user/device → Er hastighedsbegrænset pr. bruger/enhed
- Are suitable for end-user facing applications → Er egnet til slutbruger‑orienterede applikationer
Eksempel på brug: Fetching and creating comments in your iOS app → Hentning og oprettelse af kommentarer i din iOS‑app
DefaultAPI - Server‑side metoder
The DefaultAPI contains authenticated methods that require an API key. These methods:
- Require your FastComments API key → Kræver din FastComments API‑nøgle
- Should ONLY be called from server-side code → Bør KUN kaldes fra server‑side kode
- Provide full access to your FastComments data → Giver fuld adgang til dine FastComments‑data
- Are rate-limited per tenant → Er hastighedsbegrænset pr. lejer
Eksempel på brug: Administrative operations, bulk data export, user management → Administrative operationer, masse‑dataeksport, brugeradministration
ModerationAPI - Moderatorsdashboard‑metoder
The ModerationAPI provides an extensive suite of live and fast moderation APIs. Every ModerationAPI method accepts an sso parameter and can authenticate via SSO or a FastComments.com session cookie. → ModerationAPI leverer en omfattende suite af live og hurtige moderations‑API'er. Hver ModerationAPI‑metode accepterer en sso‑parameter og kan autentificeres via SSO eller en FastComments.com‑sessions‑cookie.
Eksempel på brug: Building a moderation experience for moderators of your community → Bygge en moderationsoplevelse for moderatorer af dit fællesskab
VIGTIGT: Never expose your API key in client-side code. API keys should only be used server-side. → Udsæt aldrig din API‑nøgle i klient‑side kode. API‑nøgler bør kun bruges på server‑siden.
Foretag API-kald 
Swift SDK'en bruger moderne async/await-syntaks til alle API‑kald:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Almindelige problemer 
401 Uautoriserede fejl
Hvis du får 401-fejl, når du bruger den autentificerede API:
- Kontrollér din API-nøgle: Sørg for, at du bruger den korrekte API-nøgle fra dit FastComments-dashboard
- Bekræft lejer-ID'et: Sørg for, at lejer-ID'et stemmer overens med din konto
- API-nøgleformat: API-nøglen skal sættes som
x-api-keyheaderen i den delte konfiguration:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Brug af den forkerte API: Sørg for, at du bruger
DefaultAPI(ikkePublicAPI) til autentificerede kald
SSO-tokenproblemer
Hvis SSO-tokens ikke virker:
- Brug sikker tilstand til produktion: Brug altid
FastCommentsSSO.createSecure()med din API-nøgle til produktion - Kun på serversiden: Generér sikre SSO-tokens på din server, og udsæt aldrig din API-nøgle for klienter
- Kontrollér brugerdata: Sørg for, at alle krævede felter (id, e‑mail, brugernavn) er angivet
- Tokenudløb: Sikker SSO-tokens indeholder et tidsstempel og kan udløbe. Generér friske tokens efter behov.
SSL/TLS-fejl
Hvis du støder på SSL/TLS-fejl:
- Sørg for, at din apps Info.plist tillader HTTPS-forbindelser til fastcomments.com
- Kontrollér, at du ikke bruger App Transport Security-undtagelser, som kan blokere forbindelsen.
Noter 
Broadcast-ID'er
Du vil se, at du skal sende et broadcastId i nogle API-kald. Når du modtager hændelser, får du dette ID tilbage, så du ved, at du kan ignorere hændelsen, hvis du planlægger at anvende ændringer optimistisk på klienten (hvilket du sandsynligvis vil gøre, da det giver den bedste oplevelse). Pass et UUID her. ID'et bør være unikt nok til ikke at forekomme to gange i en session.
let broadcastId = UUID().uuidString
Aggreger 
Aggregere dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Response
Returns: AggregateResponse
Example

Hent revisionslogge 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Response
Returnerer: GetAuditLogsResponse
Eksempel

Logud (offentlig) 
Svar
Returnerer: APIEmptyResponse
Eksempel

Bloker fra kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: BlockSuccess
Eksempel

Ophæv blokering af kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Respons
Returnerer: UnblockSuccess
Eksempel

Tjek kommentarer for blokering 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | En kommasepareret liste over kommentar-id'er. |
| sso | string | query | Nej |
Respons
Returnerer: CheckBlockedCommentsResponse
Eksempel

Bloker bruger fra kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: BlockSuccess
Eksempel

Opret kommentar (offentlig) 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Svar
Returns: SaveCommentsResponseWithPresence
Eksempel

Slet kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| isLive | boolean | query | Nej |
Svar
Returnerer: DeleteCommentResult
Eksempel

Slet kommentar (offentlig) 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: PublicAPIDeleteCommentResponse
Eksempel

Slet stemme på kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Response
Returnerer: VoteDeleteResponse
Eksempel

Rapportér kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: FlagCommentResponse
Eksempel

Hent kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIGetCommentResponse
Eksempel

Hent kommentarer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| 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 |
Svar
Returnerer: APIGetCommentsResponse
Eksempel

Hent kommentarer (offentlig) 
req tenantId urlId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| 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 |
Svar
Returnerer: GetCommentsResponseWithPresencePublicComment
Eksempel

Hent kommentartekst 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: PublicAPIGetCommentTextResponse
Eksempel

Hent brugernavne for kommentarsstemmer 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentVoteUserNamesSuccessResponse
Eksempel

Lås kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Fastgør kommentar 
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ChangeCommentPinStatusResponse
Eksempel

Gem kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| sendEmails | boolean | query | Nej | |
| populateNotifications | boolean | query | Nej |
Svar
Returnerer: APISaveCommentResponse
Eksempel

Gem kommentarer i bulk 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| sendEmails | boolean | query | Nej | |
| populateNotifications | boolean | query | Nej |
Svar
Returnerer: [SaveCommentsBulkResponse]
Eksempel

Sæt kommentartekst 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: PublicAPISetCommentTextResponse
Eksempel

Ophæv blokering af bruger fra kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: UnblockSuccess
Eksempel

Fjern rapportering af kommentar 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: FlagCommentResponse
Eksempel

Lås op for kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

Fjern fastgørelse af kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ChangeCommentPinStatusResponse
Eksempel

Opdater kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| isLive | boolean | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Stem på kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: VoteResponse
Eksempel

Hent kommentarer for bruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| 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 |
Response
Returnerer: GetCommentsForUserResponse
Eksempel

Tilføj domænekonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddDomainConfigResponse
Eksempel

Slet domænekonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Svar
Returnerer: DeleteDomainConfigResponse
Eksempel

Hent domænekonfiguration 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Svar
Returnerer: GetDomainConfigResponse
Eksempel

Hent domænekonfigurationer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetDomainConfigsResponse
Eksempel

Patch domænekonfiguration 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Svar
Returnerer: PatchDomainConfigResponse
Eksempel

Erstat domænekonfiguration 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Response
Returnerer: PutDomainConfigResponse
Eksempel

Opret e-mail-skabelon 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateEmailTemplateResponse
Eksempel

Slet e-mail-skabelon 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Slet fejl i rendering af e-mail-skabelon 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent e-mail-skabelon 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetEmailTemplateResponse
Eksempel

Hent definitioner af e-mail-skabeloner 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetEmailTemplateDefinitionsResponse
Eksempel

Hent renderingsfejl for e-mail-skabeloner 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplateRenderErrorsResponse
Eksempel

Hent e-mail-skabeloner 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplatesResponse
Eksempel

Render e-mail-skabelon 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nej |
Svar
Returnerer: RenderEmailTemplateResponse
Eksempel

Opdater e-mail-skabelon 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent hændelseslog 
req tenantId urlId userIdWS
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nej |
Svar
Returnerer: GetEventLogResponse
Eksempel

Hent global hændelseslog 
req tenantId urlId userIdWS
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nej |
Svar
Returnerer: GetEventLogResponse
Eksempel

Opret feedindlæg 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Respons
Returnerer: CreateFeedPostsResponse
Eksempel

Opret feedindlæg (offentlig) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| broadcastId | string | forespørgsel | Nej | |
| sso | string | forespørgsel | Nej |
Svar
Returnerer: CreateFeedPostResponse
Eksempel

Slet feedindlæg (offentlig) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: DeleteFeedPostPublicResponse
Eksempel

Hent feedindlæg 
req tenantId afterId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nej | |
| limit | integer | query | Nej | |
| tags | array | query | Nej |
Svar
Returnerer: GetFeedPostsResponse
Eksempel

Hent feedindlæg (offentlig) 
req tenantId afterId
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nej | |
| limit | integer | query | Nej | |
| tags | array | query | Nej | |
| sso | string | query | Nej | |
| isCrawler | boolean | query | Nej | |
| includeUserInfo | boolean | query | Nej |
Svar
Returns: PublicFeedPostsResponse
Eksempel

Hent statistik for feedindlæg 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: FeedPostsStatsResponse
Eksempel

Hent brugerreaktioner (offentlig) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Respons
Returnerer: UserReactsResponse
Eksempel

Reager på feedindlæg (offentlig) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ReactFeedPostResponse
Eksempel

Opdater feedindlæg 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Opdater feedindlæg (offentlig) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: CreateFeedPostResponse
Eksempel

Rapportér kommentar (offentlig) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent stor GIF 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| largeInternalURLSanitized | string | query | Ja |
Svar
Returnerer: GifGetLargeResponse
Eksempel

Søg GIF'er 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nej | |
| rating | string | query | Nej | |
| page | number | query | Nej |
Respons
Returnerer: GetGifsSearchResponse
Eksempel

Hent populære GIF'er 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Response
Returnerer: GetGifsTrendingResponse
Example

Tilføj hashtag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | forespørgsel | Ja |
Svar
Returnerer: CreateHashTagResponse
Eksempel

Tilføj hashtags i bulk 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Svar
Returnerer: BulkCreateHashTagsResponse
Eksempel

Slet hashtag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent hashtags 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nej |
Svar
Returnerer: GetHashTagsResponse
Eksempel

Patch hashtag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Svar
Returnerer: UpdateHashTagResponse
Eksempel

Slet moderatorafgørelse 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: VoteDeleteResponse
Eksempel

Hent API-kommentarer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nej | |
| count | number | query | Nej | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filters | string | query | Nej | |
| searchFilters | string | query | Nej | |
| sorts | string | query | Nej | |
| demo | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPIGetCommentsResponse
Eksempel

Hent API-eksportstatus 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nej | |
| sso | string | query | Nej |
Respons
Returnerer: ModerationExportStatusResponse
Eksempel

Hent API-id'er 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filters | string | query | Nej | |
| searchFilters | string | query | Nej | |
| afterId | string | query | Nej | |
| demo | boolean | query | Nej | |
| sso | string | query | Nej |
Respons
Returns: ModerationAPIGetCommentIdsResponse
Eksempel

Hent blokerede brugere fra kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetBannedUsersFromCommentResponse
Eksempel

Hent kommentarens blokeringstatus 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentBanStatusResponse
Eksempel

Hent kommentarers underkommentarer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Svar
Returnerer: ModerationAPIChildCommentsResponse
Eksempel

Hent optælling 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filter | string | query | Nej | |
| searchFilters | string | query | Nej | |
| demo | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPICountCommentsResponse
Eksempel

Hent optællinger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetBannedUsersCountResponse
Eksempel

Hent logs 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Response
Returnerer: ModerationAPIGetLogsResponse
Eksempel

Hent manuelle badges 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetTenantManualBadgesResponse
Eksempel

Hent manuelle badges for bruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: GetUserManualBadgesResponse
Eksempel

Hent moderationskommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeEmail | boolean | query | Nej | |
| includeIP | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPICommentResponse
Eksempel

Hent tekst for moderationskommentar 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Returnerer: GetCommentTextResponse
Eksempel

Hent forudsagt karantæneresumé 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Response
Returns: PreBanSummary
Example

Hent søgekommentarers resumé 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationCommentSearchResponse
Eksempel

Hent søgesider 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationPageSearchResponse
Eksempel

Hent søgesites 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationSiteSearchResponse
Eksempel

Hent søgeforslag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationSuggestResponse
Eksempel

Hent søgebrugere 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Respons
Returns: ModerationUserSearchResponse
Eksempel

Hent tillidsfaktor 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserTrustFactorResponse
Eksempel

Hent brugerens blokeringpræference 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIModerateGetUserBanPreferencesResponse
Eksempel

Hent brugerens interne profil 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: GetUserInternalProfileResponse
Eksempel

Juster kommentarstemmer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: AdjustVotesResponse
Eksempel

Start API-eksport 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filters | string | query | Nej | |
| searchFilters | string | query | Nej | |
| sorts | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationExportResponse
Eksempel

Bloker bruger fra kommentar (post) 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| 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 |
Svar
Returnerer: BanUserFromCommentResult
Eksempel

Fortryd brugerblokering 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Bulk forud-karantæne resumé 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: BulkPreBanSummary
Eksempel

Hent kommentarer efter id'er 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPIChildCommentsResponse
Eksempel

Rapportér kommentar (post) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Fjern kommentar (post) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: PostRemoveCommentApiResponse
Eksempel

Gendan slettet kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Sæt kommentarens godkendelsesstatus 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| approved | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: SetCommentApprovedResponse
Eksempel

Sæt kommentarens gennemgangsstatus 
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

Sæt kommentar som spam 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Returnerer: APIEmptyResponse
Eksempel

Sæt kommentarens tekst (post) 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Response
Returnerer: SetCommentTextResponse
Example

Fjern anmeldelse af kommentar (post) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

Afstem (post) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: VoteResponse
Eksempel

Tildel badge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Returnerer: AwardUserBadgeResponse
Eksempel

Luk tråd 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel

Fjern badge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: RemoveUserBadgeResponse
Eksempel

Genåbn tråd 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Sæt tillidsfaktor 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: SetUserTrustFactorResponse
Eksempel

Opret moderator 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateModeratorResponse
Eksempel

Slet moderator 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent moderator 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetModeratorResponse
Eksempel

Hent moderatorer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | forespørgsel | Ja | |
| skip | number | forespørgsel | Nej |
Svar
Returnerer: GetModeratorsResponse
Eksempel

Send invitation 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Opdater moderator 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Slet notifikationsantal 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent cachet notifikationsantal 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetCachedNotificationCountResponse
Eksempel

Hent notifikationsantal 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Respons
Returnerer: GetNotificationCountResponse
Eksempel

Hent notifikationer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| urlId | string | query | Nej | |
| fromCommentId | string | query | Nej | |
| viewed | boolean | query | Nej | |
| type | string | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetNotificationsResponse
Eksempel

Opdater notifikation 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Opret version 1 side-reaktion 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| title | string | query | Nej |
Svar
Returnerer: CreateV1PageReact
Eksempel

Opret version 2 side-reaktion 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nej |
Response
Returnerer: CreateV1PageReact
Eksempel

Slet version 1 side-reaktion 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: CreateV1PageReact
Eksempel

Slet version 2 side-reaktion 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Svar
Returnerer: CreateV1PageReact
Eksempel

Hent version 1 side-likes 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: GetV1PageLikes
Eksempel

Hent version 2 side-reaktioner 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: GetV2PageReacts
Eksempel

Hent brugere der reagerede på side (v2) 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Respons
Returnerer: GetV2PageReactUsersResponse
Eksempel

Tilføj side 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddPageAPIResponse
Eksempel

Slet side 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: DeletePageAPIResponse
Eksempel

Hent offline brugere 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Tidligere kommentatorer på siden, der IKKE er online i øjeblikket. Sorteret efter displayName.
Use this after exhausting /users/online to render a "Members" section.
Brug dette efter at have udtømt /users/online for at gengive en "Members"-sektion.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Cursor-paginering på commenterName: serveren gennemløber den delvise {tenantId, urlId, commenterName} indeks fra afterName fremad via $gt, uden $skip-omkostning.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Side-URL-identifikator (rengjort på serveren). |
| afterName | string | query | No | Cursor: send nextAfterName fra det foregående svar. |
| afterUserId | string | query | No | Cursor-tiebreaker: send nextAfterUserId fra det foregående svar. Påkrævet når afterName er sat, så navneties ikke udelader poster. |
Response
Returnerer: PageUsersOfflineResponse
Example

Hent online brugere 
Aktuelt online‑visere af en side: personer, hvis websocketsession er abonneret på siden lige nu.
Returnerer anonCount + totalCount (rum‑omfattende abonnenter, inklusive anonyme seere, som vi ikke tæller).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Side-URL-identifikator (ryddet server-side). |
| afterName | string | query | No | Markør: send nextAfterName fra den forrige respons. |
| afterUserId | string | query | No | Markør tie-breaker: send nextAfterUserId fra den forrige respons. Kræves når afterName er sat så navne-ties ikke dropper poster. |
Response
Returns: PageUsersOnlineResponse
Example

Hent side efter URL-id 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Returnerer: GetPageByURLIdAPIResponse
Eksempel

Hent sider 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetPagesAPIResponse
Eksempel

Hent sider (offentlig) 
List sider for en lejer. Brugt af FChat desktopklienten til at udfylde dens rumliste.
Kræver enableFChat skal være sand på den opløste brugerdefinerede konfiguration for hver side.
Sider, der kræver SSO, filtreres i forhold til den anmodende brugers gruppeadgang.
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Uigennemsigtig pagineringsmarkør returneret som nextCursor fra en tidligere anmodning. Bundet til den samme sortBy. |
| limit | integer | query | No | 1..200, standard 50 |
| q | string | query | No | Valgfri case‑insensitiv titelpræfiksfilter. |
| sortBy | string | query | No | Sorteringsorden. updatedAt (standard, nyeste først), commentCount (fleste kommentarer først), eller title (alfabetisk). |
| hasComments | boolean | query | No | Hvis sand, returneres kun sider med mindst én kommentar. |
Svar
Returns: GetPublicPagesResponse
Eksempel

Hent brugerinformation 
Bulk-brugeroplysninger for en tenant. Givet userIds returneres visningsoplysninger fra User / SSOUser. Bruges af kommentar-widgeten til at berige brugere, der netop dukkede op via en presence-begivenhed. Ingen sidekontekst: privatliv håndhæves ensartet (private profiler er maskeret).
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| ids | string | query | Ja | Komma-adskilte userIds. |
Svar
Returnerer: PageUsersInfoResponse
Eksempel

Patch side 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: PatchPageAPIResponse
Eksempel

Slet afventende webhook-hændelse 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent antal afventende webhook-hændelser 
Parametre
| 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 |
Svar
Returnerer: GetPendingWebhookEventCountResponse
Eksempel

Hent afventende webhook-hændelser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nej | |
| externalId | string | query | Nej | |
| eventType | string | query | Nej | |
| type | string | query | Nej | |
| domain | string | query | Nej | |
| attemptCountGT | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetPendingWebhookEventsResponse
Eksempel

Opret spørgekonfiguration 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateQuestionConfigResponse
Eksempel

Slet spørgekonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent spørgekonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: GetQuestionConfigResponse
Eksempel

Hent spørgekonfigurationer 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetQuestionConfigsResponse
Eksempel

Opdater spørgekonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Opret spørgeresultat 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateQuestionResultResponse
Eksempel

Slet spørgeresultat 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent spørgeresultat 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetQuestionResultResponse
Eksempel

Hent spørgeresultater 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nej | |
| userId | string | query | Nej | |
| startDate | string | query | Nej | |
| questionId | string | query | Nej | |
| questionIds | string | query | Nej | |
| skip | number | query | Nej |
Respons
Returnerer: GetQuestionResultsResponse
Eksempel

Opdater spørgeresultat 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Aggreger spørgeresultater 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nej | |
| questionIds | array | query | Nej | |
| urlId | string | query | Nej | |
| timeBucket | string | query | Nej | |
| startDate | string | query | Nej | |
| forceRecalculate | boolean | query | Nej |
Svar
Returnerer: AggregateQuestionResultsResponse
Eksempel

Bulk-aggreger spørgeresultater 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nej |
Svar
Returnerer: BulkAggregateQuestionResultsResponse
Eksempel

Kombinér kommentarer med spørgeresultater 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | forespørgsel | Ja | |
| questionId | string | forespørgsel | Nej | |
| questionIds | array | forespørgsel | Nej | |
| urlId | string | forespørgsel | Nej | |
| startDate | string | forespørgsel | Nej | |
| forceRecalculate | boolean | forespørgsel | Nej | |
| minValue | number | forespørgsel | Nej | |
| maxValue | number | forespørgsel | Nej | |
| limit | number | forespørgsel | Nej |
Svar
Returnerer: CombineQuestionResultsWithCommentsResponse
Eksempel

Tilføj SSO-bruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddSSOUserAPIResponse
Eksempel

Slet SSO-bruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: DeleteSSOUserAPIResponse
Eksempel

Hent SSO-bruger efter e-mail 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
Respons
Returnerer: GetSSOUserByEmailAPIResponse
Eksempel

Hent SSO-bruger efter id 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetSSOUserByIdAPIResponse
Eksempel

Hent SSO-brugere 
Parametre
| Name | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nej |
Svar
Returnerer: GetSSOUsersResponse
Eksempel

Patch SSO-bruger 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Svar
Returnerer: PatchSSOUserAPIResponse
Eksempel

Erstat/opret SSO-bruger 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Svar
Returnerer: PutSSOUserAPIResponse
Eksempel

Opret abonnement 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateSubscriptionAPIResponse
Eksempel

Slet abonnement 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: DeleteSubscriptionAPIResponse
Eksempel

Hent abonnementer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetSubscriptionsAPIResponse
Eksempel

Opdater abonnement 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: UpdateSubscriptionAPIResponse
Eksempel

Hent lejerens daglige forbrug 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nej | |
| monthNumber | number | query | Nej | |
| dayNumber | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantDailyUsagesResponse
Eksempel

Opret lejerpakke 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Svar
Returnerer: CreateTenantPackageResponse
Eksempel

Slet lejerpakke 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent lejerpakke 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returnerer: GetTenantPackageResponse
Eksempel

Hent lejerpakker 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantPackagesResponse
Eksempel

Erstat lejerpakke 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIEmptyResponse
Eksempel

Opdater lejerpakke 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Opret lejerbruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateTenantUserResponse
Eksempel

Slet lejerbruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent lejerbruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetTenantUserResponse
Eksempel

Hent lejerbrugere 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantUsersResponse
Eksempel

Erstat lejerbruger 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Send login-link 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Opdater lejerbruger 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Opret lejer 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: CreateTenantResponse
Eksempel

Slet lejer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel

Hent lejer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetTenantResponse
Eksempel

Hent lejere 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Svar
Returnerer: GetTenantsResponse
Eksempel

Opdater lejer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel

Ændr ticket-tilstand 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: ChangeTicketStateResponse
Eksempel

Opret ticket 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Respons
Returnerer: CreateTicketResponse
Eksempel

Hent ticket 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetTicketResponse
Eksempel

Hent tickets 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Respons
Returnerer: GetTicketsResponse
Eksempel

Hent oversættelser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| namespace | string | path | Ja | |
| component | string | path | Ja | |
| locale | string | query | Nej | |
| useFullTranslationIds | boolean | query | Nej |
Svar
Returnerer: GetTranslationsResponse
Eksempel

Upload billede 
Upload og ændre størrelse på et billede
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Størrelsesforudindstilling: "Default" (1000x1000px) eller "CrossPlatform" (opretter størrelser for populære enheder) |
| urlId | string | query | No | side-id, som uploaden sker fra, for at konfigurere |
Svar
Returns: UploadImageResponse
Eksempel

Hent brugerbadge-fremskridt efter id 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIGetUserBadgeProgressResponse
Eksempel

Hent brugerbadge-fremskridt efter bruger-id 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Svar
Returnerer: APIGetUserBadgeProgressResponse
Eksempel

Hent liste over brugerbadge-fremskridt 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Svar
Returns: APIGetUserBadgeProgressListResponse
Eksempel

Opret brugerbadge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: APICreateUserBadgeResponse
Eksempel

Slet brugerbadge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptySuccessResponse
Eksempel

Hent brugerbadge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIGetUserBadgeResponse
Eksempel

Hent brugerbadges 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| badgeId | string | query | Nej | |
| type | number | query | Nej | |
| displayedOnComments | boolean | query | Nej | |
| limit | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: APIGetUserBadgesResponse
Eksempel

Opdater brugerbadge 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptySuccessResponse
Eksempel

Hent brugers notifikationsantal 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserNotificationCountResponse
Eksempel

Hent brugers notifikationer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Brugt til at bestemme, om den aktuelle side er abonneret på. |
| 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 |
Svar
Returnerer: GetMyNotificationsResponse
Eksempel

Nulstil brugers notifikationsantal 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ResetUserNotificationsResponse
Eksempel

Nulstil brugers notifikationer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nej | |
| afterCreatedAt | integer | query | Nej | |
| unreadOnly | boolean | query | Nej | |
| dmOnly | boolean | query | Nej | |
| noDm | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ResetUserNotificationsResponse
Eksempel

Opdater brugers kommentarabonnementsstatus 
Aktivér eller deaktiver notifikationer for en specifik kommentar.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| optedInOrOut | string | path | Ja | |
| commentId | string | query | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: UpdateUserNotificationCommentSubscriptionStatusResponse
Eksempel

Opdater brugers sideabonnementsstatus 
Aktivér eller deaktiver notifikationer for en side. Når brugere er tilmeldt en side, oprettes der notifikationer for nye overordnede kommentarer, og også
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UpdateUserNotificationPageSubscriptionStatusResponse
Eksempel

Opdater brugers notifikationsstatus 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: UpdateUserNotificationStatusResponse
Eksempel

Hent brugers tilstedeværelsesstatusser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Svar
Returnerer: GetUserPresenceStatusesResponse
Eksempel

Søg brugere 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nej | |
| mentionGroupIds | array | query | Nej | |
| sso | string | query | Nej | |
| searchSection | string | query | Nej |
Svar
Returnerer: SearchUsersResult
Eksempel

Hent bruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetUserResponse
Eksempel

Opret stemme 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: VoteResponse
Eksempel

Slet stemme 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
Respons
Returnerer: VoteDeleteResponse
Eksempel

Hent stemmer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Returnerer: GetVotesResponse
Eksempel

Hent stemmer for bruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: GetVotesForUserResponse
Eksempel

Brug for hjælp?
Hvis du støder på problemer eller har spørgsmål om Swift SDK'et, så:
Bidrag
Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.