
Langue 🇨🇦 Français (Canada)
Premiers pas
Utilisation
Agrégation
Journaux d'audit
Authentification
Bloquer depuis un commentaire
Vérifier les commentaires bloqués
Commentaires
Commentaires pour un utilisateur
Configurations de domaine
Modèles d'e-mail
Journal des événements
Publications
Signaler un commentaire
GIFs
Hashtags
Modération
Modérateurs
Nombre de notifications
Notifications
Réactions de page
Pages
Événements Webhook en attente
Configurations de question
Résultats des questions
Agrégation des résultats des questions
Utilisateurs SSO
Abonnements
Utilisation quotidienne du locataire
Forfaits du locataire
Utilisateurs du locataire
Locataires
Tickets
Traductions
Téléverser une image
Progression du badge utilisateur
Badges utilisateur
Notifications utilisateur
Statuts de présence utilisateur
Recherche d'utilisateurs
Utilisateurs
Votes
SDK Go de FastComments
Ceci est le SDK Go officiel pour FastComments.
SDK Go officiel pour l'API FastComments
Dépôt
Installation 
go get github.com/fastcomments/fastcomments-go
Utilisation du client API
API publique (sans authentification)
L'API publique permet un accès non authentifié aux points de terminaison publics :
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Obtenir les commentaires en utilisant l'API publique
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)
}
API par défaut (requiert une clé API)
L'API par défaut requiert une authentification en utilisant votre clé API :
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Créer un contexte authentifié avec la clé API
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// Obtenir les commentaires en utilisant l'API par défaut authentifiée
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)
}
API de modération (tableau de bord du modérateur)
L'API de modération fournit une suite étendue d'APIs de modération en temps réel et rapides. Toutes les méthodes de modération acceptent un paramètre sso et peuvent s'authentifier via SSO ou un cookie de session FastComments.com :
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Répertorier les commentaires pour la modération en utilisant l'API de modération
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)
}
Utilisation 
SSO simple
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Créer un jeton SSO simple
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)
// Utiliser le jeton SSO pour effectuer un appel API authentifié
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)
}
SSO sécurisé
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Créer un jeton SSO sécurisé
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)
// Utiliser le jeton SSO pour effectuer un appel API authentifié
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)
}
Agrégation 
Agrège des documents en les regroupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (p. ex. sum, countDistinct, avg, etc.) sont prises en charge.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Réponse
Retourne : AggregateResponse
Exemple

Obtenir les journaux d'audit 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Réponse
Renvoie: GetAuditLogsResponse
Exemple

Déconnexion publique 
Réponse
Renvoie : APIEmptyResponse
Exemple

Bloquer depuis un commentaire (public) 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: BlockSuccess
Exemple

Débloquer un commentaire (public) 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne: UnblockSuccess
Exemple

Vérifier les commentaires bloqués 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentIds | string | query | Oui | Une liste d'identifiants de commentaires séparés par des virgules. |
| sso | string | query | Non |
Réponse
Retourne : CheckBlockedCommentsResponse
Exemple

Bloquer un utilisateur depuis un commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Retourne : BlockSuccess
Exemple

Créer un commentaire public 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| urlId | string | requête | Oui | |
| broadcastId | string | requête | Oui | |
| sessionId | string | requête | Non | |
| sso | string | requête | Non |
Réponse
Renvoie: SaveCommentsResponseWithPresence
Exemple

Supprimer un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Réponse
Renvoie : DeleteCommentResult
Exemple

Supprimer un commentaire public 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : PublicAPIDeleteCommentResponse
Exemple

Supprimer le vote sur un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| voteId | string | path | Oui | |
| urlId | string | query | Oui | |
| broadcastId | string | query | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : VoteDeleteResponse
Exemple

Signaler un commentaire 
Paramètres
| Name | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie : FlagCommentResponse
Exemple

Obtenir un commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIGetCommentResponse
Exemple

Obtenir des commentaires 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | integer | query | Non | |
| limit | integer | query | Non | |
| skip | integer | query | Non | |
| asTree | boolean | query | Non | |
| skipChildren | integer | query | Non | |
| limitChildren | integer | query | Non | |
| maxTreeDepth | integer | query | Non | |
| urlId | string | query | Non | |
| userId | string | query | Non | |
| anonUserId | string | query | Non | |
| contextUserId | string | query | Non | |
| hashTag | string | query | Non | |
| parentId | string | query | Non | |
| direction | string | query | Non | |
| fromDate | integer | query | Non | |
| toDate | integer | query | Non |
Réponse
Renvoie : APIGetCommentsResponse
Exemple

Obtenir des commentaires publics 
req tenantId urlId
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| page | integer | query | Non | |
| direction | string | query | Non | |
| sso | string | query | Non | |
| skip | integer | query | Non | |
| skipChildren | integer | query | Non | |
| limit | integer | query | Non | |
| limitChildren | integer | query | Non | |
| countChildren | boolean | query | Non | |
| fetchPageForCommentId | string | query | Non | |
| includeConfig | boolean | query | Non | |
| countAll | boolean | query | Non | |
| includei10n | boolean | query | Non | |
| locale | string | query | Non | |
| modules | string | query | Non | |
| isCrawler | boolean | query | Non | |
| includeNotificationCount | boolean | query | Non | |
| asTree | boolean | query | Non | |
| maxTreeDepth | integer | query | Non | |
| useFullTranslationIds | boolean | query | Non | |
| parentId | string | query | Non | |
| searchText | string | query | Non | |
| hashTags | array | query | Non | |
| userId | string | query | Non | |
| customConfigStr | string | query | Non | |
| afterCommentId | string | query | Non | |
| beforeCommentId | string | query | Non |
Réponse
Renvoie : GetCommentsResponseWithPresencePublicComment
Exemple

Obtenir le texte du commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : PublicAPIGetCommentTextResponse
Exemple

Obtenir les noms d'utilisateurs des votes de commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| dir | integer | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetCommentVoteUserNamesSuccessResponse
Exemple

Verrouiller un commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| commentId | string | chemin | Oui | |
| broadcastId | string | requête | Oui | |
| sso | string | requête | Non |
Réponse
Renvoie: APIEmptyResponse
Exemple

Épingler un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : ChangeCommentPinStatusResponse
Exemple

Enregistrer un commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| isLive | boolean | query | Non | |
| doSpamCheck | boolean | query | Non | |
| sendEmails | boolean | query | Non | |
| populateNotifications | boolean | query | Non |
Réponse
Renvoie: APISaveCommentResponse
Exemple

Enregistrer des commentaires en masse 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| isLive | boolean | query | Non | |
| doSpamCheck | boolean | query | Non | |
| sendEmails | boolean | query | Non | |
| populateNotifications | boolean | query | Non |
Réponse
Renvoie : []SaveCommentsBulkResponse
Exemple

Définir le texte du commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie: PublicAPISetCommentTextResponse
Exemple

Débloquer un utilisateur depuis un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie: UnblockSuccess
Exemple

Retirer le signalement du commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie : FlagCommentResponse
Exemple

Déverrouiller un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: APIEmptyResponse
Exemple

Désépingler un commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : ChangeCommentPinStatusResponse
Exemple

Mettre à jour un commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| contextUserId | string | query | Non | |
| doSpamCheck | boolean | query | Non | |
| isLive | boolean | query | Non |
Réponse
Renvoie: APIEmptyResponse
Exemple

Voter sur un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| urlId | string | query | Oui | |
| broadcastId | string | query | Oui | |
| sessionId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : VoteResponse
Exemple

Obtenir les commentaires pour un utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| userId | string | query | Non | |
| direction | string | query | Non | |
| repliesToUserId | string | query | Non | |
| page | number | query | Non | |
| includei10n | boolean | query | Non | |
| locale | string | query | Non | |
| isCrawler | boolean | query | Non |
Réponse
Renvoie : GetCommentsForUserResponse
Exemple

Ajouter une configuration de domaine 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: AddDomainConfigResponse
Exemple

Supprimer une configuration de domaine 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie : DeleteDomainConfigResponse
Exemple

Obtenir une configuration de domaine 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Réponse
Renvoie: GetDomainConfigResponse
Exemple

Obtenir les configurations de domaine 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : GetDomainConfigsResponse
Exemple

Modifier partiellement une configuration de domaine 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Réponse
Renvoie : PatchDomainConfigResponse
Exemple

Remplacer une configuration de domaine 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Réponse
Retourne : PutDomainConfigResponse
Exemple

Créer un modèle d'e-mail 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateEmailTemplateResponse
Exemple

Supprimer un modèle d'e-mail 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : APIEmptyResponse
Exemple

Supprimer une erreur de rendu de modèle d'e-mail 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| errorId | string | path | Oui |
Réponse
Retourne : APIEmptyResponse
Exemple

Obtenir un modèle d'e-mail 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetEmailTemplateResponse
Exemple

Obtenir les définitions de modèles d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: GetEmailTemplateDefinitionsResponse
Exemple

Obtenir les erreurs de rendu des modèles d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetEmailTemplateRenderErrorsResponse
Exemple

Obtenir les modèles d'e-mail 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetEmailTemplatesResponse
Exemple

Rendre un modèle d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| locale | string | query | Non |
Réponse
Renvoie : RenderEmailTemplateResponse
Exemple

Mettre à jour un modèle d'e-mail 
Paramètres
| Name | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

Obtenir le journal d'événements 
req tenantId urlId userIdWS
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| userIdWS | string | query | Oui | |
| startTime | integer | query | Oui | |
| endTime | integer | query | Non |
Réponse
Retourne: GetEventLogResponse
Exemple

Obtenir le journal d'événements global 
req tenantId urlId userIdWS
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| userIdWS | string | query | Oui | |
| startTime | integer | query | Oui | |
| endTime | integer | query | Non |
Réponse
Renvoie : GetEventLogResponse
Exemple

Créer une publication 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Réponse
Renvoie: CreateFeedPostsResponse
Exemple

Créer une publication publique 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne: CreateFeedPostResponse
Exemple

Supprimer une publication publique 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : DeleteFeedPostPublicResponse
Exemple

Obtenir des publications 
req tenantId afterId
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Réponse
Renvoie : GetFeedPostsResponse
Exemple

Obtenir des publications publiques 
req tenantId afterId
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| afterId | string | query | Non | |
| limit | integer | query | Non | |
| tags | array | query | Non | |
| sso | string | query | Non | |
| isCrawler | boolean | query | Non | |
| includeUserInfo | boolean | query | Non |
Réponse
Renvoie: PublicFeedPostsResponse
Exemple

Obtenir les statistiques des publications 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postIds | array | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : FeedPostsStatsResponse
Exemple

Obtenir les réactions d'un utilisateur (public) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| postIds | array | requête | Non | |
| sso | string | requête | Non |
Réponse
Retourne : UserReactsResponse
Exemple

Réagir à une publication (public) 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| isUndo | boolean | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie: ReactFeedPostResponse
Exemple

Mettre à jour une publication 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

Mettre à jour une publication (publique) 
Paramètres
| Name | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie: CreateFeedPostResponse
Exemple

Signaler un commentaire (public) 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| isFlagged | boolean | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne: APIEmptyResponse
Exemple

Obtenir GIF grand 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| largeInternalURLSanitized | string | query | Oui |
Réponse
Renvoie : GifGetLargeResponse
Exemple

Rechercher des GIFs 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| search | string | query | Oui | |
| locale | string | query | Non | |
| rating | string | query | Non | |
| page | number | query | Non |
Réponse
Renvoie: GetGifsSearchResponse
Exemple

Obtenir les GIFs tendance 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| locale | string | query | Non | |
| rating | string | query | Non | |
| page | number | query | Non |
Réponse
Renvoie : GetGifsTrendingResponse
Exemple

Ajouter un hashtag 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateHashTagResponse
Exemple

Ajouter des hashtags en masse 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : BulkCreateHashTagsResponse
Exemple

Supprimer un hashtag 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Réponse
Retourne : APIEmptyResponse
Exemple

Obtenir les hashtags 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | number | query | Non |
Réponse
Retourne : GetHashTagsResponse
Exemple

Modifier partiellement un hashtag 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| tag | string | path | Oui |
Réponse
Renvoie : UpdateHashTagResponse
Exemple

Supprimer un vote de modération 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| voteId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : VoteDeleteResponse
Exemple

Obtenir les commentaires via l'API 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | number | query | Non | |
| count | number | query | Non | |
| text-search | string | query | Non | |
| byIPFromComment | string | query | Non | |
| filters | string | query | Non | |
| searchFilters | string | query | Non | |
| sorts | string | query | Non | |
| demo | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationAPIGetCommentsResponse
Exemple

Obtenir le statut d'exportation API 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| batchJobId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : ModerationExportStatusResponse
Exemple

Obtenir les identifiants API 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| text-search | string | query | Non | |
| byIPFromComment | string | query | Non | |
| filters | string | query | Non | |
| searchFilters | string | query | Non | |
| afterId | string | query | Non | |
| demo | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : ModerationAPIGetCommentIdsResponse
Exemple

Obtenir les utilisateurs bannis d'un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne : GetBannedUsersFromCommentResponse
Exemple

Obtenir le statut de bannissement d'un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Réponse
Renvoie : GetCommentBanStatusResponse
Exemple

Obtenir les réponses d'un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationAPIChildCommentsResponse
Exemple

Obtenir le nombre 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Réponse
Renvoie : ModerationAPICountCommentsResponse
Exemple

Obtenir les totaux 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Réponse
Returns: GetBannedUsersCountResponse
Exemple

Obtenir les journaux 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationAPIGetLogsResponse
Exemple

Obtenir les badges manuels 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetTenantManualBadgesResponse
Exemple

Obtenir les badges manuels pour un utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| badgesUserId | string | query | Non | |
| commentId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserManualBadgesResponse
Exemple

Obtenir le commentaire de modération 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| includeEmail | boolean | query | Non | |
| includeIP | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationAPICommentResponse
Exemple

Obtenir le texte du commentaire de modération 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetCommentTextResponse
Exemple

Obtenir le résumé préalable au bannissement 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Réponse
Renvoie : PreBanSummary
Exemple

Obtenir le résumé de recherche de commentaires 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| value | string | query | Non | |
| filters | string | query | Non | |
| searchFilters | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationCommentSearchResponse
Exemple

Obtenir les pages de recherche 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| value | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationPageSearchResponse
Exemple

Obtenir les sites de recherche 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| value | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationSiteSearchResponse
Exemple

Obtenir les suggestions de recherche 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : ModerationSuggestResponse
Exemple

Obtenir les utilisateurs recherchés 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| value | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationUserSearchResponse
Exemple

Obtenir le facteur de confiance 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserTrustFactorResponse
Exemple

Obtenir la préférence de bannissement de l'utilisateur 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Réponse
Retourne : APIModerateGetUserBanPreferencesResponse
Exemple

Obtenir le profil interne de l'utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : GetUserInternalProfileResponse
Exemple

Ajuster les votes des commentaires 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : AdjustVotesResponse
Exemple

Lancer une exportation API 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| text-search | string | requête | Non | |
| byIPFromComment | string | requête | Non | |
| filters | string | requête | Non | |
| searchFilters | string | requête | Non | |
| sorts | string | requête | Non | |
| sso | string | requête | Non |
Réponse
Retourne : ModerationExportResponse
Exemple

Bannir un utilisateur depuis un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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 |
Réponse
Retourne : BanUserFromCommentResult
Exemple

Annuler le bannissement d'un utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne : APIEmptyResponse
Exemple

Générer un résumé préalable de bannissement en masse 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| includeByUserIdAndEmail | boolean | query | Non | |
| includeByIP | boolean | query | Non | |
| includeByEmailDomain | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : BulkPreBanSummary
Exemple

Obtenir les commentaires par ID 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Réponse
Retourne : ModerationAPIChildCommentsResponse
Exemple

Signaler un commentaire (modération) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : APIEmptyResponse
Exemple

Retirer un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : PostRemoveCommentApiResponse
Exemple

Restaurer un commentaire supprimé 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : APIEmptyResponse
Exemple

Définir le statut d'approbation d'un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| approved | boolean | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : SetCommentApprovedResponse
Exemple

Définir le statut de révision d'un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| reviewed | boolean | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : APIEmptyResponse
Exemple

Définir le statut de spam d'un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| spam | boolean | query | Non | |
| permNotSpam | boolean | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

Définir le texte d'un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Returns: SetCommentTextResponse
Exemple

Retirer le signalement d'un commentaire (modération) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

Publier un vote 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Returns: VoteResponse
Exemple

Attribuer un badge 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| badgeId | string | query | Oui | |
| userId | string | query | Non | |
| commentId | string | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : AwardUserBadgeResponse
Exemple

Fermer un fil 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

Retirer un badge 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : RemoveUserBadgeResponse
Exemple

Rouvrir un fil 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne : APIEmptyResponse
Exemple

Définir le facteur de confiance 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| trustFactor | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : SetUserTrustFactorResponse
Exemple

Créer un modérateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: CreateModeratorResponse
Exemple

Supprimer un modérateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| sendEmail | string | query | Non |
Réponse
Renvoie: APIEmptyResponse
Exemple

Obtenir un modérateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : GetModeratorResponse
Exemple

Obtenir les modérateurs 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetModeratorsResponse
Exemple

Envoyer une invitation 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| fromName | string | query | Oui |
Réponse
Retourne : APIEmptyResponse
Exemple

Mettre à jour un modérateur 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: APIEmptyResponse
Exemple

Supprimer le nombre de notifications 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

Obtenir le nombre de notifications mis en cache 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : GetCachedNotificationCountResponse
Exemple

Obtenir le nombre de notifications 
Paramètres
| Name | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| urlId | string | query | Non | |
| fromCommentId | string | query | Non | |
| viewed | boolean | query | Non | |
| type | string | query | Non |
Réponse
Renvoie : GetNotificationCountResponse
Exemple

Obtenir les notifications 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| urlId | string | query | Non | |
| fromCommentId | string | query | Non | |
| viewed | boolean | query | Non | |
| type | string | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetNotificationsResponse
Exemple

Mettre à jour une notification 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

Créer une réaction de page V1 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| title | string | query | Non |
Réponse
Renvoie: CreateV1PageReact
Exemple

Créer une réaction de page V2 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| id | string | query | Oui | |
| title | string | query | Non |
Réponse
Renvoie : CreateV1PageReact
Exemple

Supprimer une réaction de page V1 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui |
Réponse
Retourne : CreateV1PageReact
Exemple

Supprimer une réaction de page V2 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| urlId | string | requête | Oui | |
| id | string | requête | Oui |
Réponse
Retourne: CreateV1PageReact
Exemple

Obtenir les likes V1 de la page 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui |
Réponse
Renvoie: GetV1PageLikes
Exemple

Obtenir les réactions V2 de la page 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| urlId | string | requête | Oui |
Réponse
Retourne: GetV2PageReacts
Exemple

Obtenir les utilisateurs ayant réagi V2 de la page 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| id | string | query | Oui |
Réponse
Renvoie : GetV2PageReactUsersResponse
Exemple

Ajouter une page 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: AddPageAPIResponse
Exemple

Supprimer une page 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : DeletePageAPIResponse
Exemple

Obtenir les utilisateurs hors ligne 
Auteurs de commentaires précédents sur la page qui ne sont pas actuellement en ligne. Triés par displayName. Utilisez ceci après avoir épuisé /users/online pour afficher une section « Membres ». Pagination par curseur sur commenterName : le serveur parcourt l'index partiel {tenantId, urlId, commenterName} à partir de afterName vers l'avant via $gt, sans coût de $skip.
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identifiant d'URL de la page (nettoyé côté serveur). |
| afterName | string | query | No | Curseur : transmettre nextAfterName de la réponse précédente. |
| afterUserId | string | query | No | Désambiguïsateur du curseur : transmettre nextAfterUserId de la réponse précédente. Requis lorsque afterName est défini afin que les égalités de nom n'entraînent pas la suppression d'entrées. |
Réponse
Renvoie : PageUsersOfflineResponse
Exemple

Obtenir les utilisateurs en ligne 
Visiteurs actuellement en ligne d'une page: personnes dont la session websocket est abonnée à la page en ce moment. Renvoie anonCount + totalCount (abonnés de la salle, y compris les visiteurs anonymes que nous n'énumérons pas).
Parameters
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | Identificateur d'URL de la page (nettoyé côté serveur). |
| afterName | string | query | Non | Curseur : transmettre nextAfterName de la réponse précédente. |
| afterUserId | string | query | Non | Desempteur de curseur : transmettre nextAfterUserId de la réponse précédente. Requis lorsque afterName est défini afin que des égalités de nom n'entraînent pas la suppression d'entrées. |
Réponse
Renvoie: PageUsersOnlineResponse
Exemple

Obtenir une page par URL/ID 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | paramètre de requête | Oui | |
| urlId | string | paramètre de requête | Oui |
Réponse
Renvoie : GetPageByURLIdAPIResponse
Exemple

Obtenir les pages 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: GetPagesAPIResponse
Exemple

Obtenir les pages publiques 
Liste les pages pour un locataire. Utilisé par le client de bureau FChat pour remplir sa liste de salons.
Nécessite enableFChat à true dans la configuration personnalisée résolue pour chaque page.
Les pages nécessitant SSO sont filtrées en fonction des accès de groupe de l'utilisateur demandeur.
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| cursor | string | query | Non | Curseur de pagination opaque renvoyé comme nextCursor à partir d'une requête précédente. Lié au même sortBy. |
| limit | integer | query | Non | 1..200, par défaut 50 |
| q | string | query | Non | Filtre optionnel sur le préfixe du titre, insensible à la casse. |
| sortBy | string | query | Non | Ordre de tri. updatedAt (par défaut, les plus récents en premier), commentCount (les plus commentés en premier), ou title (alphabétique). |
| hasComments | boolean | query | Non | Si true, ne retourner que les pages ayant au moins un commentaire. |
Réponse
Renvoie: GetPublicPagesResponse
Exemple

Obtenir les informations des utilisateurs 
Infos utilisateur en masse pour un locataire. Étant donné des userIds, renvoie les informations d’affichage depuis User / SSOUser. Utilisé par le widget de commentaires pour enrichir les utilisateurs qui viennent d’apparaître via un événement de présence. Pas de contexte de page : la confidentialité est appliquée de manière uniforme (les profils privés sont masqués).
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| ids | string | query | Oui | Identifiants d'utilisateur délimités par des virgules. |
Réponse
Renvoie : PageUsersInfoResponse
Exemple

Modifier partiellement une page 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: PatchPageAPIResponse
Exemple

Supprimer un événement webhook en attente 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

Obtenir le nombre d'événements webhook en attente 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Non | |
| externalId | string | query | Non | |
| eventType | string | query | Non | |
| type | string | query | Non | |
| domain | string | query | Non | |
| attemptCountGT | number | query | Non |
Réponse
Renvoie : GetPendingWebhookEventCountResponse
Exemple

Obtenir les événements webhook en attente 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Non | |
| externalId | string | query | Non | |
| eventType | string | query | Non | |
| type | string | query | Non | |
| domain | string | query | Non | |
| attemptCountGT | number | query | Non | |
| skip | number | query | Non |
Réponse
Retourne: GetPendingWebhookEventsResponse
Exemple

Créer une configuration de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : CreateQuestionConfigResponse
Exemple

Supprimer une configuration de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

Obtenir une configuration de question 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| id | string | chemin | Oui |
Réponse
Renvoie : GetQuestionConfigResponse
Exemple

Obtenir les configurations de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Retourne: GetQuestionConfigsResponse
Exemple

Mettre à jour une configuration de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: APIEmptyResponse
Exemple

Créer un résultat de question 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateQuestionResultResponse
Exemple

Supprimer un résultat de question 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : APIEmptyResponse
Exemple

Obtenir un résultat de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: GetQuestionResultResponse
Exemple

Obtenir les résultats de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Non | |
| userId | string | query | Non | |
| startDate | string | query | Non | |
| questionId | string | query | Non | |
| questionIds | string | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie: GetQuestionResultsResponse
Exemple

Mettre à jour un résultat de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

Agréger les résultats des questions 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| questionId | string | query | Non | |
| questionIds | array | query | Non | |
| urlId | string | query | Non | |
| timeBucket | string | query | Non | |
| startDate | string | query | Non | |
| forceRecalculate | boolean | query | Non |
Réponse
Retourne : AggregateQuestionResultsResponse
Exemple

Agrégation en masse des résultats des questions 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| forceRecalculate | boolean | query | Non |
Réponse
Renvoie : BulkAggregateQuestionResultsResponse
Exemple

Combiner les commentaires avec les résultats des questions 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| questionId | string | query | Non | |
| questionIds | array | query | Non | |
| urlId | string | query | Non | |
| startDate | string | query | Non | |
| forceRecalculate | boolean | query | Non | |
| minValue | number | query | Non | |
| maxValue | number | query | Non | |
| limit | number | query | Non |
Réponse
Retourne: CombineQuestionResultsWithCommentsResponse
Exemple

Ajouter un utilisateur SSO 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : AddSSOUserAPIResponse
Exemple

Supprimer un utilisateur SSO 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| deleteComments | boolean | query | Non | |
| commentDeleteMode | string | query | Non |
Réponse
Renvoie : DeleteSSOUserAPIResponse
Exemple

Obtenir un utilisateur SSO par courriel 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| string | path | Oui |
Réponse
Renvoie: GetSSOUserByEmailAPIResponse
Exemple

Obtenir un utilisateur SSO par ID 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: GetSSOUserByIdAPIResponse
Exemple

Obtenir les utilisateurs SSO 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | integer | query | Non |
Réponse
Retourne: GetSSOUsersResponse
Exemple

Modifier partiellement un utilisateur SSO 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | boolean | query | Non |
Réponse
Renvoie : PatchSSOUserAPIResponse
Exemple

Remplacer un utilisateur SSO 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | boolean | query | Non |
Réponse
Retourne: PutSSOUserAPIResponse
Exemple

Créer un abonnement 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateSubscriptionAPIResponse
Exemple

Supprimer un abonnement 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Retourne: DeleteSubscriptionAPIResponse
Exemple

Obtenir les abonnements 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non |
Réponse
Retourne: GetSubscriptionsAPIResponse
Exemple

Mettre à jour un abonnement 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Retourne: UpdateSubscriptionAPIResponse
Exemple

Obtenir l'utilisation quotidienne du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| yearNumber | number | query | Non | |
| monthNumber | number | query | Non | |
| dayNumber | number | query | Non | |
| skip | number | query | Non |
Réponse
Retourne: GetTenantDailyUsagesResponse
Exemple

Créer un forfait pour locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Renvoie : CreateTenantPackageResponse
Exemple

Supprimer un forfait pour locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: APIEmptyResponse
Exemple

Obtenir un forfait pour locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| id | string | chemin | Oui |
Réponse
Renvoie : GetTenantPackageResponse
Exemple

Obtenir les forfaits du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Retourne: GetTenantPackagesResponse
Exemple

Remplacer un forfait du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

Mettre à jour un forfait du locataire 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : APIEmptyResponse
Exemple

Créer un utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateTenantUserResponse
Exemple

Supprimer un utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| deleteComments | string | query | Non | |
| commentDeleteMode | string | query | Non |
Réponse
Retourne: APIEmptyResponse
Exemple

Obtenir un utilisateur du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : GetTenantUserResponse
Exemple

Obtenir les utilisateurs du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie: GetTenantUsersResponse
Exemple

Remplacer un utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

Envoyer un lien de connexion 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| redirectURL | string | query | Non |
Réponse
Retourne : APIEmptyResponse
Exemple

Mettre à jour un utilisateur du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

Créer un locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui |
Réponse
Retourne: CreateTenantResponse
Exemple

Supprimer un locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| id | string | chemin | Oui | |
| sure | string | requête | Non |
Réponse
Retourne: APIEmptyResponse
Exemple

Obtenir un locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetTenantResponse
Exemple

Obtenir les locataires 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| meta | string | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie: GetTenantsResponse
Exemple

Mettre à jour un locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

Changer l'état d'un ticket 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : ChangeTicketStateResponse
Exemple

Créer un ticket 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Oui |
Réponse
Renvoie : CreateTicketResponse
Exemple

Obtenir un ticket 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie : GetTicketResponse
Exemple

Obtenir les tickets 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Réponse
Retourne : GetTicketsResponse
Exemple

Obtenir les traductions 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| namespace | string | path | Oui | |
| component | string | path | Oui | |
| locale | string | query | Non | |
| useFullTranslationIds | boolean | query | Non |
Réponse
Retourne : GetTranslationsResponse
Exemple

Téléverser une image 
Téléverser et redimensionner une image
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Préréglage de taille : "Default" (1000x1000px) ou "CrossPlatform" (crée des tailles pour les appareils populaires) |
| urlId | string | query | No | ID de la page à partir de laquelle le téléversement est effectué, pour la configuration |
Réponse
Renvoie : UploadImageResponse
Exemple

Obtenir la progression du badge utilisateur par ID 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIGetUserBadgeProgressResponse
Exemple

Obtenir la progression du badge utilisateur par ID d'utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | path | Oui |
Réponse
Renvoie: APIGetUserBadgeProgressResponse
Exemple

Obtenir la liste de progression des badges utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| limit | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : APIGetUserBadgeProgressListResponse
Exemple

Créer un badge utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : APICreateUserBadgeResponse
Exemple

Supprimer un badge utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: APIEmptySuccessResponse
Exemple

Obtenir un badge utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : APIGetUserBadgeResponse
Exemple

Obtenir les badges utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| badgeId | string | query | Non | |
| type | number | query | Non | |
| displayedOnComments | boolean | query | Non | |
| limit | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : APIGetUserBadgesResponse
Exemple

Mettre à jour un badge utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| id | string | chemin | Oui |
Réponse
Renvoie : APIEmptySuccessResponse
Exemple

Obtenir le nombre de notifications d'un utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserNotificationCountResponse
Exemple

Obtenir les notifications utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Non | Utilisé pour déterminer si la page actuelle est abonnée. |
| pageSize | integer | query | Non | |
| afterId | string | query | Non | |
| includeContext | boolean | query | Non | |
| afterCreatedAt | integer | query | Non | |
| unreadOnly | boolean | query | Non | |
| dmOnly | boolean | query | Non | |
| noDm | boolean | query | Non | |
| includeTranslations | boolean | query | Non | |
| includeTenantNotifications | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Retourne: GetMyNotificationsResponse
Exemple

Réinitialiser le nombre de notifications d'un utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : ResetUserNotificationsResponse
Exemple

Réinitialiser les notifications d'un utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| afterId | string | query | Non | |
| afterCreatedAt | integer | query | Non | |
| unreadOnly | boolean | query | Non | |
| dmOnly | boolean | query | Non | |
| noDm | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ResetUserNotificationsResponse
Exemple

Mettre à jour le statut d'abonnement aux commentaires pour les notifications utilisateur 
Activer ou désactiver les notifications pour un commentaire spécifique.
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| notificationId | string | path | Oui | |
| optedInOrOut | string | path | Oui | |
| commentId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : UpdateUserNotificationCommentSubscriptionStatusResponse
Exemple

Mettre à jour le statut d'abonnement aux pages pour les notifications utilisateur 
Activer ou désactiver les notifications pour une page. Lorsque des utilisateurs sont abonnés à une page, des notifications sont créées pour les nouveaux commentaires racines, et aussi
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| url | string | query | Oui | |
| pageTitle | string | query | Oui | |
| subscribedOrUnsubscribed | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : UpdateUserNotificationPageSubscriptionStatusResponse
Exemple

Mettre à jour le statut d'une notification utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| notificationId | string | path | Oui | |
| newStatus | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : UpdateUserNotificationStatusResponse
Exemple

Obtenir les statuts de présence utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
Réponse
Renvoie : GetUserPresenceStatusesResponse
Exemple

Rechercher des utilisateurs 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| urlId | string | requête | Oui | |
| usernameStartsWith | string | requête | Non | |
| mentionGroupIds | array | requête | Non | |
| sso | string | requête | Non | |
| searchSection | string | requête | Non |
Réponse
Renvoie : SearchUsersResult
Exemple

Obtenir un utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetUserResponse
Exemple

Créer un vote 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Oui | |
| direction | string | query | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Renvoie
Renvoie: VoteResponse
Exemple

Supprimer un vote 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| editKey | string | query | Non |
Réponse
Renvoie : VoteDeleteResponse
Exemple

Obtenir les votes 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui |
Réponse
Renvoie: GetVotesResponse
Exemple

Obtenir les votes pour un utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie: GetVotesForUserResponse
Exemple

Besoin d'aide ?
Si vous rencontrez des problèmes ou avez des questions concernant le SDK Go, veuillez :
Contribuer
Les contributions sont les bienvenues ! Veuillez visiter le dépôt GitHub pour les directives de contribution.