
Langue 🇫🇷 Français (France)
Premiers pas
Documentation
Agrégation
Journaux d'audit
Authentification
Blocage depuis un commentaire
Vérifier les commentaires bloqués
Commentaires
Commentaires pour l'utilisateur
Configurations de domaine
Modèles d'e-mail
Journal d'é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 questions
Résultats de questions
Agrégation des résultats de questions
Utilisateurs SSO
Abonnements
Utilisation quotidienne du locataire
Forfaits du locataire
Utilisateurs du locataire
Locataires
Tickets
Traductions
Téléverser une image
Progression des badges utilisateur
Badges utilisateur
Notifications utilisateur
Statuts de présence utilisateur
Recherche d'utilisateurs
Utilisateurs
Votes
SDK Python FastComments
Ceci est le SDK Python officiel pour FastComments.
SDK Python officiel pour l'API FastComments
Repository
Installation 
Installer depuis GitHub
Installez directement à partir d'une balise de version (recommandé, entièrement reproductible) :
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Épinglez la balise plutôt qu'une branche afin que les builds soient déterministes. Le même format fonctionne dans requirements.txt :
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Chaque version balisée GitHub Release possède également une roue compilée attachée si vous préférez installer directement un artefact binaire.
Contenu de la bibliothèque
Cette bibliothèque contient deux modules : le client API généré et la bibliothèque principale Python qui contient des utilitaires écrits à la main pour faciliter le travail avec l'API, y compris le support SSO.
API publiques vs sécurisées
Pour le client API, il existe trois classes, DefaultApi, PublicApi et ModerationApi. Le DefaultApi contient des méthodes qui nécessitent votre clé API, et le PublicApi contient des méthodes qui peuvent être appelées directement depuis un navigateur/appareil mobile/etc. sans authentification. Le ModerationApi fournit une suite étendue d'API de modération en temps réel et rapides. Chaque méthode du ModerationApi accepte un paramètre sso et peut s'authentifier via SSO ou un cookie de session FastComments.com.
Démarrage rapide 
Utilisation des API authentifiées (DefaultApi)
Important : Vous devez définir votre clé API dans la Configuration avant d'effectuer des requêtes authentifiées. Sinon, les requêtes échoueront avec une erreur 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Create and configure the API client
config = Configuration()
config.host = "https://fastcomments.com"
# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}
# Create the API instance with the configured client
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Now you can make authenticated API calls
try:
# Example: Add an SSO user
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user("YOUR_TENANT_ID", user_data)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Common errors:
# - 401: API key is missing or invalid
# - 400: Request validation failed
Utilisation des API publiques (PublicApi)
Les points de terminaison publics ne nécessitent pas d'authentification :
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
print(response)
except Exception as e:
print(f"Error: {e}")
Utilisation du tableau de bord de modération (ModerationApi)
L'ModerationApi alimente le tableau de bord du modérateur. Les méthodes sont appelées au nom d'un modérateur en passant un jeton sso :
from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)
try:
# Count the comments awaiting moderation
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
Utilisation du SSO (Single Sign-On)
Le SDK inclut des utilitaires pour générer des jetons SSO sécurisés :
from sso import FastCommentsSSO, SecureSSOUserData
# Create user data (id, email, and username are required)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Sign it with your API secret (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# Generate the SSO token to pass to the widget or an API call
sso_token = sso.create_token()
# Use this token in your frontend or pass to API calls
print(f"SSO Token: {sso_token}")
Pour un SSO simple (moins sécurisé, pour les tests) :
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
username="johndoe",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Problèmes courants
- Erreur 401 "missing-api-key" : Assurez-vous de définir
config.api_key = {"api_key": "YOUR_KEY"}avant de créer l'instance DefaultApi. - Classe API incorrecte : Utilisez
DefaultApipour les requêtes authentifiées côté serveur,PublicApipour les requêtes côté client/public, etModerationApipour les requêtes du tableau de bord de modération. - Erreurs d'importation : Assurez-vous d'importer depuis le module correct :
- Client API :
from client import ... - Utilitaires SSO :
from sso import ...
- Client API :
Remarques 
Identifiants de diffusion
Vous verrez que vous devez transmettre un broadcast_id dans certains appels d'API. Lorsque vous recevez des événements, vous récupérerez cet ID, ce qui vous permettra d'ignorer l'événement si vous prévoyez d'appliquer de manière optimiste des modifications côté client (ce que vous voudrez probablement faire car cela offre la meilleure expérience). Passez un UUID ici. L'ID doit être suffisamment unique pour ne pas apparaître deux fois au cours d'une session de navigateur.
Prérequis 
- Python >= 3.8
L'installation de base est pure‑stdlib et fournit les utilitaires SSO. Le client API généré (DefaultApi/PublicApi/ModerationApi) nécessite l'extra client, qui récupère urllib3 >= 1.25.3, python-dateutil >= 2.8.2, pydantic >= 2.0.0 et typing-extensions >= 4.0.0 :
pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0"
Agréger 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| parentTenantId | string | query | Non | |
| includeStats | boolean | query | Non |
Response
Renvoie : AggregateResponse
Example

Obtenir les journaux d'audit 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
Retourne : 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : UnblockSuccess
Exemple

Vérifier les commentaires bloqués 
Paramètres
| Name | Type | Location | Required | 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Réponse
Renvoie : BlockSuccess
Exemple

Créer un commentaire (public) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| broadcastId | string | query | Oui | |
| sessionId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : SaveCommentsResponseWithPresence
Exemple

Supprimer un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| contextUserId | string | query | Non | |
| isLive | boolean | query | Non |
Réponse
Retourne : DeleteCommentResult
Exemple

Supprimer un commentaire (public) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : PublicAPIDeleteCommentResponse
Exemple

Supprimer le vote sur un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : VoteDeleteResponse
Exemple

Signaler un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Retourne : 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 le texte du commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : PublicAPIGetCommentTextResponse
Exemple

Obtenir les noms d'utilisateurs ayant voté sur le commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| dir | integer | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetCommentVoteUserNamesSuccessResponse
Exemple

Obtenir les commentaires 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
Returns: APIGetCommentsResponse
Exemple

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

Verrouiller 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
Retourne : 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Réponse
Retourne : 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : PublicAPISetCommentTextResponse
Exemple

Débloquer un utilisateur depuis un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Réponse
Renvoie : UnblockSuccess
Exemple

Annuler le signalement d'un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
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 |
Response
Renvoie : APIEmptyResponse
Exemple

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

Mettre à jour un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Réponse
Retourne : 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
Renvoie : VoteResponse
Exemple

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

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

Supprimer une configuration de domaine 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie : DeleteDomainConfigResponse
Exemple

Obtenir la configuration de domaine 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie : GetDomainConfigResponse
Exemple

Obtenir les configurations de domaine 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Renvoie : 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Réponse
Renvoie : PutDomainConfigResponse
Exemple

Créer un modèle d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Retourne : CreateEmailTemplateResponse
Exemple

Supprimer un modèle d'e-mail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetEmailTemplateResponse
Exemple

Obtenir les définitions de modèles d'e-mail 
Parameters
| Nom | Type | Emplacement | Obligatoire | 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
Retourne: GetEmailTemplateRenderErrorsResponse
Exemple

Obtenir les modèles d'e-mail 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Retourne: 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
| Nom | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Response
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
Renvoie : 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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| broadcastId | string | query | Non | |
| isLive | boolean | query | Non | |
| doSpamCheck | boolean | query | Non | |
| skipDupCheck | boolean | query | Non |
Réponse
Renvoie : CreateFeedPostsResponse
Exemple

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

Supprimer une publication (publique) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : DeleteFeedPostPublicResponse
Exemple

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

Obtenir les publications (publiques) 
req tenantId afterId
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Réponse
Retourne : PublicFeedPostsResponse
Exemple

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

Obtenir les réactions des utilisateurs (publiques) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Réponse
Renvoie : UserReactsResponse
Exemple

Réagir à une publication (publique) 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Renvoie : ReactFeedPostResponse
Example

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

Mettre à jour une publication (publique) 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : CreateFeedPostResponse
Exemple

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

Obtenir un GIF en grand format 
Paramètres
| Nom | Type | Emplacement | Requis | 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 | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Réponse
Retourne : GetGifsSearchResponse
Exemple

Obtenir les GIFs tendance 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| locale | string | requête | Non | |
| rating | string | requête | Non | |
| page | number | requête | Non |
Réponse
Retourne : GetGifsTrendingResponse
Exemple

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

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

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

Obtenir les hashtags 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | number | query | Non |
Réponse
Renvoie: 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
Retourne : ModerationAPIGetCommentsResponse
Exemple

Obtenir le statut d'export via l'API 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| batchJobId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : 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 via un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetBannedUsersFromCommentResponse
Exemple

Obtenir le statut de bannissement du commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne : GetCommentBanStatusResponse
Exemple

Obtenir les réponses du 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 | Oui | |
| text-search | string | query | Non | |
| byIPFromComment | string | query | Non | |
| filter | string | query | Non | |
| searchFilters | string | query | Non | |
| demo | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : 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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne : 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 | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Réponse
Retourne : ModerationAPICommentResponse
Exemple

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

Obtenir le résumé pré-bannissement 
Parameters
| Nom | Type | Emplacement | Obligatoire | 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 |
Response
Returns: PreBanSummary
Example

Obtenir le résumé de recherche de commentaires 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : ModerationCommentSearchResponse
Exemple

Rechercher des pages 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| value | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationPageSearchResponse
Exemple

Rechercher des sites 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| value | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : ModerationSiteSearchResponse
Exemple

Obtenir des suggestions de recherche 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| text-search | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : ModerationSuggestResponse
Exemple

Rechercher des utilisateurs 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : ModerationUserSearchResponse
Exemple

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

Obtenir la préférence de bannissement de l'utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : APIModerateGetUserBanPreferencesResponse
Exemple

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

Ajuster les votes de 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 : AdjustVotesResponse
Exemple

Lancer un export via l'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 | |
| sorts | string | query | Non | |
| sso | string | query | 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 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Retourne : APIEmptyResponse
Example

Générer un résumé pré-bannissement en masse 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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

Publier des commentaires par ID 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationAPIChildCommentsResponse
Exemple

Signaler 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 : APIEmptyResponse
Exemple

Retirer un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
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
Retourne : APIEmptyResponse
Exemple

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

Définir le statut de revue du commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : APIEmptyResponse
Exemple

Définir le statut de spam du commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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 |
Réponse
Returns: APIEmptyResponse
Exemple

Définir le texte du 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

Annuler le signalement 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
Renvoie : APIEmptyResponse
Exemple

Enregistrer un vote 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| direction | string | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
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 une discussion 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne : 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 une discussion 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Response
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
Renvoie: 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : GetModeratorResponse
Exemple

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

Envoyer une invitation 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| fromName | string | query | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

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

Supprimer le compteur de notifications 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : APIEmptyResponse
Exemple

Obtenir le compteur de notifications en cache 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetCachedNotificationCountResponse
Exemple

Obtenir le nombre de notifications 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Réponse
Retourne : GetNotificationCountResponse
Exemple

Obtenir les notifications 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Réponse
Returns: GetNotificationsResponse
Exemple

Mettre à jour la notification 
Paramètres
| Name | Type | Location | Required | 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 | chemin | Oui | |
| urlId | string | requête | Oui | |
| title | string | requête | Non |
Réponse
Retourne: CreateV1PageReact
Exemple

Créer une réaction de page v2 
Paramètres
| Nom | Type | Emplacement | Requis | 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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| urlId | string | requête | Oui |
Réponse
Renvoie : CreateV1PageReact
Exemple

Supprimer 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 |
Réponse
Retourne: CreateV1PageReact
Exemple

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

Obtenir les utilisateurs réagissant à la page v2 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| id | string | query | Oui |
Réponse
Renvoie : GetV2PageReactUsersResponse
Exemple

Obtenir les réactions de page v2 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui |
Réponse
Renvoie: GetV2PageReacts
Exemple

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

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

Obtenir les utilisateurs hors ligne 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Commentateurs précédents sur la page qui ne sont PAS actuellement en ligne. Triés par displayName.
Use this after exhausting /users/online to render a "Members" section.
Utilisez cela après avoir épuisé /users/online pour afficher une section "Membres".
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Pagination par curseur sur commenterName : le serveur parcourt l’index partiel {tenantId, urlId, commenterName} à partir de afterName en avant via $gt, sans coût $skip.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identifiant d'URL de page (nettoyé côté serveur). |
| afterName | string | query | No | Curseur : passer nextAfterName de la réponse précédente. |
| afterUserId | string | query | No | Critère de désaccord du curseur : passer nextAfterUserId de la réponse précédente. Requis lorsque afterName est défini afin que les égalités de nom ne suppriment pas d'entrées. |
Réponse
Returns: PageUsersOfflineResponse
Exemple

Obtenir les utilisateurs en ligne 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identifiant d'URL de la page (nettoyé côté serveur). |
| afterName | string | query | No | Curseur : passer nextAfterName depuis la réponse précédente. |
| afterUserId | string | query | No | Tiebreaker du curseur : passer nextAfterUserId depuis la réponse précédente. Obligatoire lorsque afterName est défini afin que les égalités de noms ne suppriment pas d'entrées. |
Réponse
Retourne : PageUsersOnlineResponse
Exemple

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

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

Obtenir les pages publiques 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Nécessite que enableFChat soit vrai dans la configuration personnalisée résolue pour chaque page.
Les pages nécessitant le SSO sont filtrées en fonction de l’accès aux groupes de l'utilisateur demandeur.
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Curseur de pagination opaque retourné comme nextCursor d'une requête précédente. Lié au même sortBy. |
| limit | integer | query | No | 1..200, par défaut 50 |
| q | string | query | No | Filtre de préfixe de titre optionnel insensible à la casse. |
| sortBy | string | query | No | Ordre de tri. updatedAt (par défaut, le plus récent d'abord), commentCount (les plus de commentaires d'abord), ou title (alphabétique). |
| hasComments | boolean | query | No | Si vrai, ne retourne que les pages contenant au moins un commentaire. |
Réponse
Returns: GetPublicPagesResponse
Exemple

Obtenir les informations des utilisateurs 
Informations utilisateurs en masse pour un tenant. Étant donné des userIds, retourne 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 | userIds délimités par des virgules. |
Réponse
Renvoie : PageUsersInfoResponse
Exemple

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

Supprimer un événement webhook en attente 
Paramètres
| Name | Type | Location | Required | 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 | Obligatoire | 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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Réponse
Retourne : GetPendingWebhookEventsResponse
Exemple

Créer une configuration de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateQuestionConfigResponse
Exemple

Supprimer une configuration de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne : APIEmptyResponse
Exemple

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

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

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

Créer un résultat de question 
Paramètres
| Name | Type | Location | Required | 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
Renvoie: APIEmptyResponse
Exemple

Obtenir le résultat de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetQuestionResultResponse
Exemple

Obtenir les résultats de questions 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Réponse
Retourne : GetQuestionResultsResponse
Exemple

Mettre à jour le résultat de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Response
Renvoie: APIEmptyResponse
Exemple

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

Agrégation en masse des résultats de 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 de questions 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Réponse
Renvoie : CombineQuestionResultsWithCommentsResponse
Exemple

Ajouter un utilisateur SSO 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: AddSSOUserAPIResponse
Exemple

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

Obtenir un utilisateur SSO par e-mail 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| string | path | Oui |
Réponse
Renvoie : GetSSOUserByEmailAPIResponse
Exemple

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

Obtenir les utilisateurs SSO 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | integer | query | Non |
Réponse
Renvoie: GetSSOUsersResponse
Exemple

Modifier partiellement 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: PatchSSOUserAPIResponse
Exemple

Remplacer 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 : PutSSOUserAPIResponse
Exemple

Créer un abonnement 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Retourne: CreateSubscriptionAPIResponse
Exemple

Supprimer un abonnement 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie : 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
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Réponse
Retourne: UpdateSubscriptionAPIResponse
Exemple

Obtenir l'utilisation quotidienne du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Réponse
Renvoie : GetTenantDailyUsagesResponse
Exemple

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

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

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

Obtenir les forfaits du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenantPackagesResponse
Exemple

Remplacer le forfait du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne : APIEmptyResponse
Exemple

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

Créer un utilisateur du locataire 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Retourne : CreateTenantUserResponse
Exemple

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

Obtenir l'utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetTenantUserResponse
Exemple

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

Remplacer l'utilisateur du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Réponse
Retourne : APIEmptyResponse
Exemple

Envoyer le lien de connexion 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| redirectURL | string | query | Non |
Réponse
Retourne: APIEmptyResponse
Exemple

Mettre à jour l'utilisateur du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Réponse
Retourne : APIEmptyResponse
Exemple

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

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

Obtenir le locataire 
Paramètres
| Nom | Type | Emplacement | Requis | 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 | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Réponse
Renvoie : GetTenantsResponse
Exemple

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

Changer l'état du ticket 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne: ChangeTicketStateResponse
Exemple

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

Obtenir le ticket 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Retourne : 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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| namespace | string | path | Oui | |
| component | string | path | Oui | |
| locale | string | query | Non | |
| useFullTranslationIds | boolean | query | Non |
Réponse
Returns: GetTranslationsResponse
Exemple

Téléverser une image 
Téléverser et redimensionner une image
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| sizePreset | string | query | Non | Préréglage de taille : "Default" (1000x1000px) ou "CrossPlatform" (crée des tailles pour les appareils populaires) |
| urlId | string | query | Non | Identifiant de page d'où le téléversement se produit, à configurer |
Réponse
Retourne : UploadImageResponse
Exemple

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

Obtenir la progression du badge utilisateur par ID 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 | Obligatoire | 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
| Nom | Type | Emplacement | Obligatoire | 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: APIGetUserBadgeResponse
Exemple

Obtenir les badges utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | 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
Retourne : APIGetUserBadgesResponse
Exemple

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

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

Obtenir les notifications de l'utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
Renvoie : GetMyNotificationsResponse
Exemple

Réinitialiser le compteur de notifications de l'utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Réponse
Renvoie: ResetUserNotificationsResponse
Exemple

Réinitialiser les notifications de l'utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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 notifications de commentaires de l'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 notifications de page de l'utilisateur 
Activer ou désactiver les notifications pour une page. Lorsqu'un utilisateur est abonné à une page, des notifications sont créées pour les nouveaux commentaires racines, et aussi
Parameters
| Nom | Type | Emplacement | Obligatoire | 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 de notification de l'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 des utilisateurs 
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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| usernameStartsWith | string | query | Non | |
| mentionGroupIds | array | query | Non | |
| sso | string | query | Non | |
| searchSection | string | query | Non |
Réponse
Retourne : SearchUsersResult
Exemple

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

Créer un vote 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Réponse
Renvoie : VoteResponse
Exemple

Supprimer un vote 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| editKey | string | query | Non |
Réponse
Retourne : 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Réponse
Retourne : GetVotesForUserResponse
Exemple

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