
Taal 🇳🇱 Nederlands
Documentatie
Aan de slag
Gebruik
Aggregatie
Auditlogs
Authenticatie
Blokkeren vanuit commentaar
Controleer geblokkeerde commentaren
Commentaren
Commentaren voor gebruiker
Domeinconfiguraties
E-mailtemplates
Eventlog
Feedberichten
Commentaar markeren
GIF's
Hashtags
Moderatie
Moderators
Notificatietelling
Notificaties
Paginareacties
Pagina's
In afwachting zijnde webhookgebeurtenissen
Vraagconfiguraties
Vraagresultaten
Aggregatie van vraagresultaten
SSO-gebruikers
Abonnementen
Dagelijks tenantgebruik
Tenantpakketten
Tenantgebruikers
Tenants
Tickets
Vertalingen
Afbeelding uploaden
Badgevoortgang van gebruiker
Gebruikersbadges
Gebruikersnotificaties
Aanwezigheidsstatus van gebruiker
Gebruikers zoeken
Gebruikers
Stemmen
FastComments Go SDK
Dit is de officiële Go SDK voor FastComments.
Officiële Go SDK voor de FastComments API
Repository
AI-coderingsagenten 
Geef je code‑agent de FastComments‑context die hij nodig heeft - widgets, configuratie, Secure SSO, de REST‑API en de SDK’s:
npx skills add fastcomments/skills
Werkt met Claude Code, Codex, Cursor, Copilot, Gemini en elke andere agent die de skills CLI ondersteunt.
Installatie 
go get github.com/fastcomments/fastcomments-go
Gebruik van de API‑client
Openbare API (Geen authenticatie)
De PublicAPI staat ongeauthentiseerde toegang tot openbare eindpunten toe:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Haal reacties op met PublicAPI
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Standaard API (Vereist API‑sleutel)
De DefaultAPI vereist authenticatie met behulp van uw API‑sleutel:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Maak een geauthentiseerde context met API‑sleutel
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// Haal reacties op met geauthentiseerde DefaultAPI
response, httpResp, err := apiClient.DefaultAPI.GetComments(auth).
TenantId("your-tenant-id").
UrlId("your-page-url-id").
Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Moderatie‑API (Moderator‑dashboard)
De ModerationAPI biedt een uitgebreide reeks live‑ en snelle moderatie‑API’s. Alle moderatiemethoden accepteren een sso‑parameter en kunnen authenticeren via SSO of een FastComments.com‑sessiecookie:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Lijst met reacties voor moderatie met ModerationAPI
response, httpResp, err := apiClient.ModerationAPI.GetApiComments(
context.Background(),
).Sso("your-sso-token").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Gebruik 
Eenvoudige SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Maak Eenvoudige SSO-token
user := &sso.SimpleSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Avatar: "https://example.com/avatar.jpg",
}
ssoInstance := sso.NewSimple(user)
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("SSO Token:", token)
// Gebruik het SSO-token om een geauthenticeerde API-aanroep te doen
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Beveiligde SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Maak Beveiligde SSO-token
user := &sso.SecureSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Username: "johndoe",
Avatar: "https://example.com/avatar.jpg",
}
apiKey := "your-api-key"
ssoInstance, err := sso.NewSecure(apiKey, user)
if err != nil {
panic(err)
}
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("Secure SSO Token:", token)
// Gebruik het SSO-token om een geauthenticeerde API-aanroep te doen
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Aggregatie 
Aggegregeert documenten door ze te groeperen (als groupBy is opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, enz.) worden ondersteund.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nee | |
| includeStats | boolean | query | Nee |
Antwoord
Retourneert: AggregateResponse
Voorbeeld

Auditlogs ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| limit | number | query | Nee | |
| skip | number | query | Nee | |
| order | string | query | Nee | |
| after | number | query | Nee | |
| before | number | query | Nee |
Antwoord
Geeft terug: GetAuditLogsResponse
Voorbeeld

Openbare uitlog 
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

Openbare blokkering vanuit commentaar 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Antwoord
Geeft terug: BlockSuccess
Voorbeeld

Openbare deblokkering van commentaar 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: UnblockSuccess
Voorbeeld

Gecontroleerde commentaren voor geblokkeerd 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | Een door komma's gescheiden lijst met commentaar-ids. |
| sso | string | query | Nee |
Response
Retourneert: CheckBlockedCommentsResponse
Voorbeeld

Gebruiker blokkeren vanuit commentaar 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Geeft terug: BlockSuccess
Voorbeeld

Openbaar commentaar aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: SaveCommentsResponseWithPresence
Voorbeeld

Commentaar verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Respons
Geeft terug: DeleteCommentResult
Voorbeeld

Openbaar commentaar verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: PublicAPIDeleteCommentResponse
Voorbeeld

Stem op commentaar verwijderen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: VoteDeleteResponse
Voorbeeld

Commentaar markeren 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Response
Retourneert: FlagCommentResponse
Voorbeeld

Commentaar ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Geeft terug: APIGetCommentResponse
Voorbeeld

Commentaren ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | integer | query | Nee | |
| limit | integer | query | Nee | |
| skip | integer | query | Nee | |
| asTree | boolean | query | Nee | |
| skipChildren | integer | query | Nee | |
| limitChildren | integer | query | Nee | |
| maxTreeDepth | integer | query | Nee | |
| urlId | string | query | Nee | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee | |
| contextUserId | string | query | Nee | |
| hashTag | string | query | Nee | |
| parentId | string | query | Nee | |
| direction | string | query | Nee | |
| fromDate | integer | query | Nee | |
| toDate | integer | query | Nee |
Respons
Retourneert: APIGetCommentsResponse
Voorbeeld

Openbare commentaren ophalen 
req tenantId urlId
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| page | integer | query | Nee | |
| direction | string | query | Nee | |
| sso | string | query | Nee | |
| skip | integer | query | Nee | |
| skipChildren | integer | query | Nee | |
| limit | integer | query | Nee | |
| limitChildren | integer | query | Nee | |
| countChildren | boolean | query | Nee | |
| fetchPageForCommentId | string | query | Nee | |
| includeConfig | boolean | query | Nee | |
| countAll | boolean | query | Nee | |
| includei10n | boolean | query | Nee | |
| locale | string | query | Nee | |
| modules | string | query | Nee | |
| isCrawler | boolean | query | Nee | |
| includeNotificationCount | boolean | query | Nee | |
| asTree | boolean | query | Nee | |
| maxTreeDepth | integer | query | Nee | |
| useFullTranslationIds | boolean | query | Nee | |
| parentId | string | query | Nee | |
| searchText | string | query | Nee | |
| hashTags | array | query | Nee | |
| userId | string | query | Nee | |
| customConfigStr | string | query | Nee | |
| afterCommentId | string | query | Nee | |
| beforeCommentId | string | query | Nee |
Response
Retourneert: GetCommentsResponseWithPresencePublicComment
Voorbeeld

Commentaartekst ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: PublicAPIGetCommentTextResponse
Voorbeeld

Gebruikersnamen van commentaarstemmen ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetCommentVoteUserNamesSuccessResponse
Voorbeeld

Commentaar vergrendelen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Commentaar vastzetten 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ChangeCommentPinStatusResponse
Voorbeeld

Commentaar opslaan 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| sendEmails | boolean | query | Nee | |
| populateNotifications | boolean | query | Nee |
Respons
Geeft terug: APISaveCommentResponse
Voorbeeld

Commentaren in bulk opslaan 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| sendEmails | boolean | query | Nee | |
| populateNotifications | boolean | query | Nee |
Antwoord
Retourneert: []SaveCommentsBulkResponse
Voorbeeld

Commentaartekst instellen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: PublicAPISetCommentTextResponse
Voorbeeld

Gebruiker deblokkeren vanuit commentaar 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Response
Retourneert: UnblockSuccess
Voorbeeld

Markering van commentaar verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Antwoord
Geeft terug: FlagCommentResponse
Voorbeeld

Commentaar ontgrendelen 
Parameters
| Naam | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Commentaar losmaken 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | pad | Ja | |
| commentId | string | pad | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: ChangeCommentPinStatusResponse
Voorbeeld

Commentaar bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| isLive | boolean | query | Nee |
Response
Retourneert: APIEmptyResponse
Voorbeeld

Stem op commentaar 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee |
Antwoord
Geeft terug: VoteResponse
Voorbeeld

Commentaren voor gebruiker ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| userId | string | query | Nee | |
| direction | string | query | Nee | |
| repliesToUserId | string | query | Nee | |
| page | number | query | Nee | |
| includei10n | boolean | query | Nee | |
| locale | string | query | Nee | |
| isCrawler | boolean | query | Nee |
Antwoord
Retourneert: GetCommentsForUserResponse
Voorbeeld

Domeinconfiguratie toevoegen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Geeft terug: AddDomainConfigResponse
Voorbeeld

Domeinconfiguratie verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Response
Geeft terug: DeleteDomainConfigResponse
Voorbeeld

Domeinconfiguratie ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Response
Retourneert: GetDomainConfigResponse
Voorbeeld

Domeinconfiguraties ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Geeft terug: GetDomainConfigsResponse
Voorbeeld

Domeinconfiguratie patchen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Respons
Retourneert: PatchDomainConfigResponse
Voorbeeld

Domeinconfiguratie plaatsen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Antwoord
Retourneert: PutDomainConfigResponse
Voorbeeld

E-mailtemplate aanmaken 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateEmailTemplateResponse
Voorbeeld

E-mailtemplate verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

Renderfout van e-mailtemplate verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

E-mailtemplate ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: GetEmailTemplateResponse
Voorbeeld

Definities van e-mailtemplates ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: GetEmailTemplateDefinitionsResponse
Voorbeeld

Renderfouten van e-mailtemplates ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetEmailTemplateRenderErrorsResponse
Voorbeeld

E-mailtemplates ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetEmailTemplatesResponse
Voorbeeld

E-mailtemplate renderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nee |
Respons
Geeft terug: RenderEmailTemplateResponse
Voorbeeld

E-mailtemplate bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

Eventlog ophalen 
req tenantId urlId userIdWS
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nee |
Antwoord
Geeft terug: GetEventLogResponse
Voorbeeld

Globale eventlog ophalen 
req tenantId urlId userIdWS
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nee |
Antwoord
Retourneert: GetEventLogResponse
Voorbeeld

Feedbericht aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| broadcastId | string | query | Nee | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| skipDupCheck | boolean | query | Nee |
Respons
Retourneert: CreateFeedPostsResponse
Voorbeeld

Openbaar feedbericht aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: CreateFeedPostResponse
Voorbeeld

Openbaar feedbericht verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Antwoord
Retourneert: DeleteFeedPostPublicResponse
Voorbeeld

Feedberichten ophalen 
req tenantId afterId
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nee | |
| limit | integer | query | Nee | |
| tags | array | query | Nee |
Response
Geeft terug: GetFeedPostsResponse
Voorbeeld

Openbare feedberichten ophalen 
req tenantId afterId
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nee | |
| limit | integer | query | Nee | |
| tags | array | query | Nee | |
| sso | string | query | Nee | |
| isCrawler | boolean | query | Nee | |
| includeUserInfo | boolean | query | Nee |
Response
Retourneert: PublicFeedPostsResponse
Voorbeeld

Statistieken van feedberichten ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: FeedPostsStatsResponse
Voorbeeld

Openbare gebruikersreacties ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: UserReactsResponse
Voorbeeld

Openbare reactie op feedbericht 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ReactFeedPostResponse
Voorbeeld

Feedbericht bijwerken 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

Openbaar feedbericht bijwerken 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Antwoord
Retourneert: CreateFeedPostResponse
Voorbeeld

Openbaar commentaar markeren 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Voorbeeld

Grote GIF ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| largeInternalURLSanitized | string | query | Ja |
Respons
Geeft terug: GifGetLargeResponse
Voorbeeld

GIF-zoekopdracht ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | pad | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nee | |
| rating | string | query | Nee | |
| page | number | query | Nee |
Respons
Retourneert: GetGifsSearchResponse
Voorbeeld

Trending GIF's ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| locale | string | query | Nee | |
| rating | string | query | Nee | |
| page | number | query | Nee |
Respons
Retourneert: GetGifsTrendingResponse
Voorbeeld

Hashtag toevoegen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returns: CreateHashTagResponse
Voorbeeld

Hashtags in bulk toevoegen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: BulkCreateHashTagsResponse
Voorbeeld

Hashtag verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Hashtags ophalen 
Parameteren
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee |
Antwoord
Retourneert: GetHashTagsResponse
Voorbeeld

Hashtag patchen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Respons
Retourneert: UpdateHashTagResponse
Voorbeeld

Moderatie-stem verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Reactie
Retourneert: VoteDeleteResponse
Voorbeeld

API-commentaren ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee | |
| count | number | query | Nee | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sorts | string | query | Nee | |
| demo | boolean | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPIGetCommentsResponse
Voorbeeld

API-exportstatus ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Response
Retourneert: ModerationExportStatusResponse
Example

API-ID's ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| 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 |
Respons
Returns: ModerationAPIGetCommentIdsResponse
Voorbeeld

Gebruikers verbannen vanuit commentaar ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Returns: GetBannedUsersFromCommentResponse
Voorbeeld

Banstatus van commentaar ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Respons
Retourneert: GetCommentBanStatusResponse
Voorbeeld

Kindcommentaren ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPIChildCommentsResponse
Voorbeeld

Aantal ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filter | string | query | Nee | |
| searchFilters | string | query | Nee | |
| demo | boolean | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPICountCommentsResponse
Voorbeeld

Aantallen ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Returns: GetBannedUsersCountResponse
Voorbeeld

Logboeken ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Retourneert: ModerationAPIGetLogsResponse
Example

Handmatige badges ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetTenantManualBadgesResponse
Voorbeeld

Handmatige badges voor gebruiker ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgesUserId | string | query | Nee | |
| commentId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: GetUserManualBadgesResponse
Voorbeeld

Moderatie-commentaar ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Respons
Retourneert: ModerationAPICommentResponse
Voorbeeld

Moderatie-commentaartekst ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: GetCommentTextResponse
Example

Pre-ban samenvatting ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeByUserIdAndEmail | boolean | query | Nee | |
| includeByIP | boolean | query | Nee | |
| includeByEmailDomain | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: PreBanSummary
Example

Samenvatting van zoekcommentaren ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationCommentSearchResponse
Voorbeeld

Zoekpagina's ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationPageSearchResponse
Example

Zoeksites ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationSiteSearchResponse
Voorbeeld

Zoeksuggesties ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationSuggestResponse
Voorbeeld

Zoekgebruikers ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationUserSearchResponse
Voorbeeld

Vertrouwensfactor ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: GetUserTrustFactorResponse
Voorbeeld

Banvoorkeur van gebruiker ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Returns: APIModerateGetUserBanPreferencesResponse
Example

Intern profiel van gebruiker ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: GetUserInternalProfileResponse
Voorbeeld

Stemmen op commentaar aanpassen 
Parameters
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: AdjustVotesResponse
Voorbeeld

API-export plaatsen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sorts | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationExportResponse
Voorbeeld

Gebruiker verbannen vanuit commentaar 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Response
Returns: BanUserFromCommentResult
Example

Ban van gebruiker ongedaan maken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Example

Bulk pre-ban samenvatting plaatsen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| includeByUserIdAndEmail | boolean | query | Nee | |
| includeByIP | boolean | query | Nee | |
| includeByEmailDomain | boolean | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: BulkPreBanSummary
Voorbeeld

Commentaren op ID's plaatsen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPIChildCommentsResponse
Voorbeeld

Commentaar markeren 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Commentaar verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retouneert: PostRemoveCommentApiResponse
Example

Verwijderd commentaar herstellen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Reactie
Retourneert: APIEmptyResponse
Voorbeeld

Goedkeuringsstatus van commentaar instellen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: SetCommentApprovedResponse
Voorbeeld

Reviewstatus van commentaar instellen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| reviewed | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Returns: APIEmptyResponse
Voorbeeld

Spamstatus van commentaar instellen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: APIEmptyResponse
Example

Commentaartekst instellen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: SetCommentTextResponse
Voorbeeld

Markering van commentaar verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Stem plaatsen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: VoteResponse
Voorbeeld

Badge toekennen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| 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
Retourneert: AwardUserBadgeResponse
Voorbeeld

Thread sluiten 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Badge verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| 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
Returns: RemoveUserBadgeResponse
Voorbeeld

Thread heropenen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Vertrouwensfactor instellen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: SetUserTrustFactorResponse
Voorbeeld

Moderator aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateModeratorResponse
Voorbeeld

Moderator verwijderen 
Parameters
| Name | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nee |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

Moderator ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetModeratorResponse
Voorbeeld

Moderators ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Response
Retourneert: GetModeratorsResponse
Voorbeeld

Uitnodiging verzenden 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Respons
Geeft terug: APIEmptyResponse
Voorbeeld

Moderator bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

Notificatietelling verwijderen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Gecachte notificatietelling ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Geeft terug: GetCachedNotificationCountResponse
Voorbeeld

Notificatietelling ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee |
Antwoord
Retourneert: GetNotificationCountResponse
Voorbeeld

Notificaties ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee | |
| skip | number | query | Nee |
Response
Retourneert: GetNotificationsResponse
Voorbeeld

Notificatie bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

V1-paginareactie aanmaken 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| title | string | query | Nee |
Respons
Retourneert: CreateV1PageReact
Voorbeeld

V2-paginareactie aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nee |
Respons
Retourneert: CreateV1PageReact
Voorbeeld

V1-paginareactie verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Respons
Retourneert: CreateV1PageReact
Voorbeeld

V2-paginareactie verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Response
Retourneert: CreateV1PageReact
Example

V1-pagina likes ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Response
Retourneert: GetV1PageLikes
Voorbeeld

V2-paginareacties ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Respons
Retourneert: GetV2PageReacts
Voorbeeld

Gebruikers van V2-paginareacties ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Response
Retourneert: GetV2PageReactUsersResponse
Voorbeeld

Pagina toevoegen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: AddPageAPIResponse
Voorbeeld

Pagina verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: DeletePageAPIResponse
Voorbeeld

Offline gebruikers ophalen 
Eerdere commentatoren op de pagina die NIET momenteel online zijn. Gesorteerd op displayName. Gebruik dit nadat u /users/online hebt uitgeput om een "Leden"-sectie weer te geven. Cursor-paginering op commenterName: de server loopt de partiële {tenantId, urlId, commenterName} index vanaf afterName voorwaarts via $gt, geen $skip-kosten.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Pagina-URL-identificatie (opgeschoond aan de serverzijde). |
| afterName | string | query | No | Cursor: geef nextAfterName door uit de vorige respons. |
| afterUserId | string | query | No | Cursor-tiebreaker: geef nextAfterUserId door uit de vorige respons. Vereist wanneer afterName is ingesteld zodat bij gelijke namen geen items wegvallen. |
Respons
Retourneert: PageUsersOfflineResponse
Voorbeeld

Online gebruikers ophalen 
Momenteel online kijkers van een pagina: mensen wiens websocket-sessie op dit moment op de pagina is geabonneerd. Retourneert anonCount + totalCount (room-brede abonnees, inclusief anonieme kijkers die we niet afzonderlijk opsommen).
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Pagina-URL-identificatie (op de server opgeschoond). |
| afterName | string | query | No | Cursor: geef nextAfterName door uit het vorige antwoord. |
| afterUserId | string | query | No | Tiebreaker voor cursor: geef nextAfterUserId door uit het vorige antwoord. Vereist wanneer afterName is ingesteld zodat bij gelijke namen geen vermeldingen wegvallen. |
Response
Retourneert: PageUsersOnlineResponse
Voorbeeld

Pagina op URL-ID ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Retourneert: GetPageByURLIdAPIResponse
Voorbeeld

Pagina's ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: GetPagesAPIResponse
Voorbeeld

Openbare pagina's ophalen 
Lijst met pagina's voor een tenant. Wordt gebruikt door de FChat-desktopclient om de kamerlijst te vullen.
Vereist dat enableFChat op true staat in de opgeloste aangepaste configuratie voor elke pagina.
Pagina's die SSO vereisen, worden gefilterd op basis van de groepstoegang van de aanvragende gebruiker.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Ondoorzichtige paginacursor teruggegeven als nextCursor van een eerdere aanvraag. Gebonden aan dezelfde sortBy. |
| limit | integer | query | No | 1..200, standaard 50 |
| q | string | query | No | Optionele case-insensitieve prefixfilter voor titels. |
| sortBy | string | query | No | Sorteervolgorde. updatedAt (standaard, nieuwste eerst), commentCount (meeste reacties eerst), of title (alfabetisch). |
| hasComments | boolean | query | No | Als true, retourneer alleen pagina's met ten minste één opmerking. |
Respons
Retourneert: GetPublicPagesResponse
Voorbeeld

Gebruikersinformatie ophalen 
Bulk gebruikersinformatie voor een tenant. Gegeven userIds, retourneer weergavegegevens van User / SSOUser. Wordt gebruikt door de commentaar-widget om gebruikers aan te vullen die zojuist verschenen via een presence-evenement. Geen paginacontext: privacy wordt uniform afgedwongen (privéprofielen worden gemaskeerd).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | Door komma's gescheiden userIds. |
Response
Retourneert: PageUsersInfoResponse
Voorbeeld

Pagina patchen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: PatchPageAPIResponse
Voorbeeld

In afwachting zijnde webhookgebeurtenis verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

Aantal in afwachting zijnde webhookgebeurtenissen ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| externalId | string | query | Nee | |
| eventType | string | query | Nee | |
| type | string | query | Nee | |
| domain | string | query | Nee | |
| attemptCountGT | number | query | Nee |
Respons
Retourneert: GetPendingWebhookEventCountResponse
Voorbeeld

In afwachting zijnde webhookgebeurtenissen ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| externalId | string | query | Nee | |
| eventType | string | query | Nee | |
| type | string | query | Nee | |
| domain | string | query | Nee | |
| attemptCountGT | number | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetPendingWebhookEventsResponse
Voorbeeld

Vraagconfiguratie aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respons
Retourneert: CreateQuestionConfigResponse
Voorbeeld

Vraagconfiguratie verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Reactie
Retourneert: APIEmptyResponse
Voorbeeld

Vraagconfiguratie ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: GetQuestionConfigResponse
Voorbeeld

Vraagconfiguraties ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Antwoord
Retourneert: GetQuestionConfigsResponse
Voorbeeld

Vraagconfiguratie bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

Vraagresultaat aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: CreateQuestionResultResponse
Voorbeeld

Vraagresultaat verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Vraagresultaat ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetQuestionResultResponse
Voorbeeld

Vraagresultaten ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nee | |
| userId | string | query | Nee | |
| startDate | string | query | Nee | |
| questionId | string | query | Nee | |
| questionIds | string | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetQuestionResultsResponse
Voorbeeld

Vraagresultaat bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Vraagresultaten aggregeren 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nee | |
| questionIds | array | query | Nee | |
| urlId | string | query | Nee | |
| timeBucket | string | query | Nee | |
| startDate | string | query | Nee | |
| forceRecalculate | boolean | query | Nee |
Respons
Retourneert: AggregateQuestionResultsResponse
Voorbeeld

Bulk aggregatie van vraagresultaten 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nee |
Respons
Retourneert: BulkAggregateQuestionResultsResponse
Voorbeeld

Commentaren combineren met vraagresultaten 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nee | |
| questionIds | array | query | Nee | |
| urlId | string | query | Nee | |
| startDate | string | query | Nee | |
| forceRecalculate | boolean | query | Nee | |
| minValue | number | query | Nee | |
| maxValue | number | query | Nee | |
| limit | number | query | Nee |
Antwoord
Geeft terug: CombineQuestionResultsWithCommentsResponse
Voorbeeld

SSO-gebruiker toevoegen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Geeft terug: AddSSOUserAPIResponse
Voorbeeld

SSO-gebruiker verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nee | |
| commentDeleteMode | string | query | Nee |
Respons
Geeft terug: DeleteSSOUserAPIResponse
Voorbeeld

SSO-gebruiker op e-mail ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Antwoord
Retourneert: GetSSOUserByEmailAPIResponse
Voorbeeld

SSO-gebruiker op ID ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetSSOUserByIdAPIResponse
Voorbeeld

SSO-gebruikers ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nee |
Antwoord
Retourneert: GetSSOUsersResponse
Voorbeeld

SSO-gebruiker patchen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Antwoord
Geeft terug: PatchSSOUserAPIResponse
Voorbeeld

SSO-gebruiker plaatsen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Antwoord
Retourneert: PutSSOUserAPIResponse
Voorbeeld

Abonnement aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateSubscriptionAPIResponse
Voorbeeld

Abonnement verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Response
Retourneert: DeleteSubscriptionAPIResponse
Voorbeeld

Abonnementen ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee |
Antwoord
Retourneert: GetSubscriptionsAPIResponse
Voorbeeld

Abonnement bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Antwoord
Retourneert: UpdateSubscriptionAPIResponse
Voorbeeld

Dagelijkse gebruiksstatistieken van tenant ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nee | |
| monthNumber | number | query | Nee | |
| dayNumber | number | query | Nee | |
| skip | number | query | Nee |
Antwoord
Retourneert: GetTenantDailyUsagesResponse
Voorbeeld

Tenantpakket aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: CreateTenantPackageResponse
Voorbeeld

Tenantpakket verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Tenantpakket ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetTenantPackageResponse
Voorbeeld

Tenantpakketten ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetTenantPackagesResponse
Voorbeeld

Tenantpakket vervangen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

Tenantpakket bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Tenantgebruiker aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateTenantUserResponse
Voorbeeld

Tenantgebruiker verwijderen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nee | |
| commentDeleteMode | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Tenantgebruiker ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetTenantUserResponse
Voorbeeld

Tenantgebruikers ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Antwoord
Retourneert: GetTenantUsersResponse
Voorbeeld

Tenantgebruiker vervangen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nee |
Respons
Geeft terug: APIEmptyResponse
Voorbeeld

Inloglink verzenden 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Voorbeeld

Tenantgebruiker bijwerken 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Tenant aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Antwoord
Retourneert: CreateTenantResponse
Voorbeeld

Tenant verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nee |
Antwoord
Geeft terug: APIEmptyResponse
Voorbeeld

Tenant ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetTenantResponse
Voorbeeld

Tenants ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetTenantsResponse
Voorbeeld

Tenant bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

Ticketstatus wijzigen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returneert: ChangeTicketStateResponse
Voorbeeld

Ticket aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Respons
Geeft terug: CreateTicketResponse
Voorbeeld

Ticket ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Respons
Retourneert: GetTicketResponse
Voorbeeld

Tickets ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| state | number | query | Nee | |
| skip | number | query | Nee | |
| limit | number | query | Nee |
Respons
Retourneert: GetTicketsResponse
Voorbeeld

Vertalingen ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| namespace | string | path | Ja | |
| component | string | path | Ja | |
| locale | string | query | Nee | |
| useFullTranslationIds | boolean | query | Nee |
Antwoord
Retourneert: GetTranslationsResponse
Voorbeeld

Afbeelding uploaden 
Upload and resize an image
Parameters
| Naam | Type | Location | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| sizePreset | string | query | Nee | Groottevoorinstelling: "Default" (1000x1000px) of "CrossPlatform" (maakt formaten voor populaire apparaten) |
| urlId | string | query | Nee | Pagina-id waarvan de upload plaatsvindt, voor configuratie |
Response
Retourneert: UploadImageResponse
Voorbeeld

Badgevoortgang van gebruiker op ID ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: APIGetUserBadgeProgressResponse
Voorbeeld

Badgevoortgang van gebruiker op gebruikers-ID ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Antwoord
Geeft terug: APIGetUserBadgeProgressResponse
Voorbeeld

Lijst van badgevoortgang van gebruiker ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| limit | number | query | Nee | |
| skip | number | query | Nee |
Response
Retourneert: APIGetUserBadgeProgressListResponse
Voorbeeld

Gebruikersbadge aanmaken 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: APICreateUserBadgeResponse
Voorbeeld

Gebruikersbadge verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: APIEmptySuccessResponse
Voorbeeld

Gebruikersbadge ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: APIGetUserBadgeResponse
Voorbeeld

Gebruikersbadges ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Reactie
Geeft terug: APIGetUserBadgesResponse
Voorbeeld

Gebruikersbadge bijwerken 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: APIEmptySuccessResponse
Voorbeeld

Notificatietelling van gebruiker ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Response
Geeft terug: GetUserNotificationCountResponse
Voorbeeld

Gebruikersnotificaties ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nee | Wordt gebruikt om te bepalen of de huidige pagina is geabonneerd. |
| pageSize | integer | query | Nee | |
| afterId | string | query | Nee | |
| includeContext | boolean | query | Nee | |
| afterCreatedAt | integer | query | Nee | |
| unreadOnly | boolean | query | Nee | |
| dmOnly | boolean | query | Nee | |
| noDm | boolean | query | Nee | |
| includeTranslations | boolean | query | Nee | |
| includeTenantNotifications | boolean | query | Nee | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetMyNotificationsResponse
Voorbeeld

Notificatietelling van gebruiker resetten 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Respons
Retourneert: ResetUserNotificationsResponse
Voorbeeld

Gebruikersnotificaties resetten 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nee | |
| afterCreatedAt | integer | query | Nee | |
| unreadOnly | boolean | query | Nee | |
| dmOnly | boolean | query | Nee | |
| noDm | boolean | query | Nee | |
| sso | string | query | Nee |
Antwoord
Geeft terug: ResetUserNotificationsResponse
Voorbeeld

Abonnementsstatus voor commentaarnotificaties van gebruiker bijwerken 
Schakelt meldingen voor een specifieke reactie in of uit.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Antwoord
Geeft terug: UpdateUserNotificationCommentSubscriptionStatusResponse
Voorbeeld

Abonnementsstatus voor paginanotificaties van gebruiker bijwerken 
Schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich op een pagina hebben geabonneerd, worden meldingen aangemaakt voor nieuwe rootreacties, en ook
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Response
Retourneert: UpdateUserNotificationPageSubscriptionStatusResponse
Voorbeeld

Notificatiestatus van gebruiker bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| newStatus | string | path | Yes | |
| sso | string | query | No |
Response
Geeft terug: UpdateUserNotificationStatusResponse
Voorbeeld

Aanwezigheidsstatussen van gebruiker ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Respons
Retourneert: GetUserPresenceStatusesResponse
Voorbeeld

Gebruikers zoeken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nee | |
| mentionGroupIds | array | query | Nee | |
| sso | string | query | Nee | |
| searchSection | string | query | Nee |
Antwoord
Retourneert: SearchUsersResult
Voorbeeld

Gebruiker ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: GetUserResponse
Voorbeeld

Stem aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Antwoord
Retourneert: VoteResponse
Voorbeeld

Stem verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nee |
Respons
Retourneert: VoteDeleteResponse
Voorbeeld

Stemmen ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Geeft terug: GetVotesResponse
Voorbeeld

Stemmen voor gebruiker ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Antwoord
Retourneert: GetVotesForUserResponse
Voorbeeld

Hulp nodig?
Als u problemen ondervindt of vragen heeft over de Go SDK, doe dan het volgende:
Bijdragen
Bijdragen zijn welkom! Bezoek de GitHub-repository voor richtlijnen voor bijdragen.