
Langue 🇨🇦 Français (Canada)
Prise en main
Documentation
Référence de l'API
Agrégation
Journaux d'audit
Authentification
Blocage depuis le commentaire
Vérifier les commentaires bloqués
Commentaires
Commentaires pour l'utilisateur
Configurations de domaine
Modèles de courriel
Journal d'événements
Publications
Signaler un commentaire
GIFs
Mots-clics
Modération
Modérateurs
Nombre de notifications
Notifications
Réactions de page
Pages
Événements webhook en attente
Configurations de question
Résultats de question
Agrégation des résultats de question
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
FastComments SDK Swift
Ceci est le SDK Swift officiel pour FastComments.
SDK Swift officiel pour l’API FastComments
Dépôt
Installation 
Gestionnaire de paquets Swift
Ajoutez ce qui suit à votre fichier Package.swift :
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.0.0")
]
Ou dans Xcode :
- Fichier > Ajouter des paquets…
- Entrez l’URL du référentiel :
https://github.com/fastcomments/fastcomments-swift.git - Sélectionnez la version que vous souhaitez utiliser
Exigences
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Contenu de la bibliothèque 
Le SDK FastComments Swift se compose de plusieurs modules :
-
Module Client - client API pour les API REST de FastComments
- Définitions de types complètes pour tous les modèles d'API
- Méthodes authentifiées (
DefaultAPI), publiques (PublicAPI) et de modération (ModerationAPI) - Prise en charge complète d'async/await
- Consultez client/README.md pour la documentation détaillée de l'API
-
Module SSO - utilitaires côté serveur pour Single Sign-On
- Génération sécurisée de jetons pour l'authentification des utilisateurs
- Prise en charge des modes SSO simple et sécurisé
- Signature des jetons basée sur HMAC-SHA256 avec CryptoKit
Démarrage rapide 
Utilisation de l’API publique
import FastCommentsSwift
// Récupérer les commentaires pour une page
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Utilisation de l’API authentifiée
import FastCommentsSwift
// Configurez votre clé API dans la configuration partagée (envoyée en tant qu’en-tête x-api-key)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Récupérer les commentaires en utilisant l'API authentifiée
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Utilisation de l’API de modération
import FastCommentsSwift
// Les méthodes de modération sont autorisées avec un jeton `sso` pour le modérateur en exercice
// (générez-le avec FastCommentsSSO, voir la section SSO ci‑dessus).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Utilisation de SSO pour l’authentification
SSO sécurisé (recommandé pour la production)
import FastCommentsSwift
let apiKey = "your-api-key"
// Créer des données d’utilisateur SSO sécurisées (serveur uniquement !)
let userData = SecureSSOUserData(
id: "user-123", // ID d’utilisateur
email: "user@example.com", // Courriel
username: "johndoe", // Nom d’utilisateur
avatar: "https://example.com/avatar.jpg" // URL de l’avatar
)
// Générer le jeton SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Transmettre ce jeton à votre interface frontal pour l’authentification
} catch {
print("Error creating SSO token: \(error)")
}
SSO simple (pour le développement/les tests)
import FastCommentsSwift
// Créer des données d’utilisateur SSO simples (aucune clé API requise)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Générer le jeton SSO simple
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
Clients API 
The FastComments SDK provides three API clients:
PublicAPI - Méthodes sécurisées pour le client
The PublicAPI contains methods that are safe to call from client-side code (iOS/macOS apps). These methods:
- Do not require an API key
- Can use SSO tokens for authentication
- Are rate-limited per user/device
- Are suitable for end-user facing applications
Exemple d’utilisation: Fetching and creating comments in your iOS app
DefaultAPI - Méthodes côté serveur
The DefaultAPI contains authenticated methods that require an API key. These methods:
- Require your FastComments API key
- Should ONLY be called from server-side code
- Provide full access to your FastComments data
- Are rate-limited per tenant
Exemple d’utilisation: Administrative operations, bulk data export, user management
ModerationAPI - Méthodes du tableau de bord des modérateurs
The ModerationAPI provides an extensive suite of live and fast moderation APIs. Every ModerationAPI method accepts an sso parameter and can authenticate via SSO or a FastComments.com session cookie.
Exemple d’utilisation: Building a moderation experience for moderators of your community
IMPORTANT: Never expose your API key in client-side code. API keys should only be used server-side.
Effectuer des appels API 
Le SDK Swift utilise la syntaxe moderne async/await pour tous les appels d'API :
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Problèmes courants 
Erreurs 401 Non autorisées
Si vous obtenez des erreurs 401 lors de l'utilisation de l'API authentifiée :
- Vérifiez votre clé API : assurez‑vous d’utiliser la bonne clé API depuis votre tableau de bord FastComments
- Vérifiez l’ID du locataire : assurez‑vous que l’ID du locataire correspond à votre compte
- Format de la clé API : la clé API doit être définie dans l’en‑tête
x-api-keyde la configuration partagée :
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Utilisation de la mauvaise API : assurez‑vous d’utiliser
DefaultAPI(et nonPublicAPI) pour les appels authentifiés
Problèmes de jeton SSO
Si les jetons SSO ne fonctionnent pas :
- Utilisez le mode sécurisé pour la production : utilisez toujours
FastCommentsSSO.createSecure()avec votre clé API en production - Uniquement côté serveur : générez des jetons SSO sécurisés sur votre serveur, n’exposez jamais votre clé API aux clients
- Vérifiez les données utilisateur : assurez‑vous que tous les champs requis (id, courriel, nom d’utilisateur) sont fournis
- Expiration du jeton : les jetons SSO sécurisés incluent un horodatage et peuvent expirer. Générez de nouveaux jetons au besoin.
Erreurs SSL/TLS
Si vous rencontrez des erreurs SSL/TLS :
- Assurez‑vous que le fichier Info.plist de votre application autorise les connexions HTTPS vers fastcomments.com
- Vérifiez que vous n’utilisez pas d’exceptions App Transport Security qui pourraient bloquer la connexion.
Remarques 
Identifiants de diffusion
Vous verrez que vous devez passer un broadcastId dans certaines requêtes d'API. Lorsque vous recevez des événements, vous récupérerez cet ID, ce qui vous permet de savoir qu'il faut ignorer l'événement si vous prévoyez d'appliquer des changements de façon optimiste 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 même session.
let broadcastId = UUID().uuidString
aggregate 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Différentes opérations (par ex. sum, countDistinct, avg, etc.) sont prises en charge.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Response
Returns: AggregateResponse
Example

getAuditLogs 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| limit | number | query | Non | |
| skip | number | query | Non | |
| order | string | query | Non | |
| after | number | query | Non | |
| before | number | query | Non |
Réponse
Renvoie : GetAuditLogsResponse
Exemple

logoutPublic 
Réponse
Renvoie: APIEmptyResponse
Exemple

blockFromCommentPublic 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne : BlockSuccess
Exemple

unBlockCommentPublic 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne : UnblockSuccess
Exemple

checkedCommentsForBlocked 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentIds | string | query | Oui | Une liste séparée par des virgules d'identifiants de commentaires. |
| sso | string | query | Non |
Réponse
Renvoie : CheckBlockedCommentsResponse
Exemple

blockUserFromComment 
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
Renvoie : BlockSuccess
Exemple

createCommentPublic 
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

deleteComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Response
Returns: DeleteCommentResult
Example

deleteCommentPublic 
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 : PublicAPIDeleteCommentResponse
Exemple

deleteCommentVote 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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

flagComment 
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

getComment 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : APIGetCommentResponse
Exemple

getComments 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Réponse
Renvoie : APIGetCommentsResponse
Exemple

getCommentsPublic 
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

getCommentText 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : PublicAPIGetCommentTextResponse
Exemple

getCommentVoteUserNames 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| dir | integer | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne: GetCommentVoteUserNamesSuccessResponse
Exemple

lockComment 
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

pinComment 
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

saveComment 
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
Returns: APISaveCommentResponse
Exemple

saveCommentsBulk 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| isLive | boolean | requête | Non | |
| doSpamCheck | boolean | requête | Non | |
| sendEmails | boolean | requête | Non | |
| populateNotifications | boolean | requête | Non |
Response
Retourne : [SaveCommentsBulkResponse]
Exemple

setCommentText 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| editKey | string | query | Non | |
| sso | string | query | Non |
Réponse
Returns: PublicAPISetCommentTextResponse
Exemple

unBlockUserFromComment 
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
Renvoie : UnblockSuccess
Exemple

unFlagComment 
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
Retourne : FlagCommentResponse
Exemple

unLockComment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

unPinComment 
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

updateComment 
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
Returns: APIEmptyResponse
Exemple

voteComment 
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

getCommentsForUser 
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

addDomainConfig 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : AddDomainConfigResponse
Exemple

deleteDomainConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie : DeleteDomainConfigResponse
Exemple

getDomainConfig 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Retourne: GetDomainConfigResponse
Exemple

getDomainConfigs 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui |
Réponse
Renvoie: GetDomainConfigsResponse
Exemple

patchDomainConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Response
Renvoie: PatchDomainConfigResponse
Exemple

putDomainConfig 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Réponse
Retourne : PutDomainConfigResponse
Exemple

createEmailTemplate 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: CreateEmailTemplateResponse
Exemple

deleteEmailTemplate 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : APIEmptyResponse
Exemple

deleteEmailTemplateRenderError 
Paramètres
| Name | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| errorId | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

getEmailTemplate 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetEmailTemplateResponse
Exemple

getEmailTemplateDefinitions 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: GetEmailTemplateDefinitionsResponse
Exemple

getEmailTemplateRenderErrors 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetEmailTemplateRenderErrorsResponse
Exemple

getEmailTemplates 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie : GetEmailTemplatesResponse
Exemple

renderEmailTemplate 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| locale | string | requête | Non |
Réponse
Retourne : RenderEmailTemplateResponse
Exemple

updateEmailTemplate 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : APIEmptyResponse
Exemple

getEventLog 
req tenantId urlId userIdWS
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | No |
Réponse
Renvoie: GetEventLogResponse
Exemple

getGlobalEventLog 
req tenantId urlId userIdWS
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| urlId | string | requête | Oui | |
| userIdWS | string | requête | Oui | |
| startTime | integer | requête | Oui | |
| endTime | integer | requête | Non |
Réponse
Renvoie : GetEventLogResponse
Exemple

createFeedPost 
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
Retourne : CreateFeedPostResponse
Exemple

createFeedPostPublic 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Returns: CreateFeedPostResponse
Exemple

deleteFeedPostPublic 
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

getFeedPosts 
req tenantId afterId
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| afterId | string | query | Non | |
| limit | integer | query | Non | |
| tags | array | query | Non |
Réponse
Retourne : GetFeedPostsResponse
Exemple

getFeedPostsPublic 
req tenantId afterId
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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

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

getUserReactsPublic 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Réponse
Retourne : UserReactsResponse
Exemple

reactFeedPostPublic 
Paramètres
| 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 |
Réponse
Retourne : ReactFeedPostResponse
Exemple

updateFeedPost 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

updateFeedPostPublic 
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
Renvoie : CreateFeedPostResponse
Exemple

flagCommentPublic 
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

getGifLarge 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| largeInternalURLSanitized | string | query | Oui |
Réponse
Renvoie: GifGetLargeResponse
Exemple

getGifsSearch 
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
Retourne : GetGifsSearchResponse
Exemple

getGifsTrending 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| locale | string | query | Non | |
| rating | string | query | Non | |
| page | number | query | Non |
Réponse
Renvoie : GetGifsTrendingResponse
Exemple

addHashTag 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Renvoie : CreateHashTagResponse
Exemple

addHashTagsBulk 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : BulkCreateHashTagsResponse
Exemple

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

getHashTags 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | number | query | Non |
Response
Renvoie: GetHashTagsResponse
Exemple

patchHashTag 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| tag | string | path | Oui |
Réponse
Retourne : UpdateHashTagResponse
Exemple

deleteModerationVote 
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

getApiComments 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Réponse
Renvoie : ModerationAPIGetCommentsResponse
Exemple

getApiExportStatus 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| batchJobId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationExportStatusResponse
Exemple

getApiIds 
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
Renvoie : ModerationAPIGetCommentIdsResponse
Exemple

getBanUsersFromComment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne : GetBannedUsersFromCommentResponse
Exemple

getCommentBanStatus 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne : GetCommentBanStatusResponse
Exemple

getCommentChildren 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Réponse
Renvoie : ModerationAPIChildCommentsResponse
Exemple

getCount 
Paramètres
| Name | Type | Location | Required | 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

getCounts 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetBannedUsersCountResponse
Exemple

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

getManualBadges 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetTenantManualBadgesResponse
Exemple

getManualBadgesForUser 
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

getModerationComment 
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

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

getPreBanSummary 
Paramètres
| 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 |
Réponse
Retourne : PreBanSummary
Exemple

getSearchCommentsSummary 
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
Renvoie : ModerationCommentSearchResponse
Exemple

getSearchPages 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : ModerationPageSearchResponse
Exemple

getSearchSites 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : ModerationSiteSearchResponse
Exemple

getSearchSuggest 
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

getSearchUsers 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| value | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationUserSearchResponse
Exemple

getTrustFactor 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : GetUserTrustFactorResponse
Exemple

getUserBanPreference 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne : APIModerateGetUserBanPreferencesResponse
Exemple

getUserInternalProfile 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : GetUserInternalProfileResponse
Exemple

postAdjustCommentVotes 
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 : AdjustVotesResponse
Exemple

postApiExport 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : ModerationExportResponse
Exemple

postBanUserFromComment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| banEmail | boolean | query | Non | |
| banEmailDomain | boolean | query | Non | |
| banIP | boolean | query | Non | |
| deleteAllUsersComments | boolean | query | Non | |
| bannedUntil | string | query | Non | |
| isShadowBan | boolean | query | Non | |
| updateId | string | query | Non | |
| banReason | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : BanUserFromCommentResult
Exemple

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

postBulkPreBanSummary 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Response
Returns: BulkPreBanSummary
Example

postCommentsByIds 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne : ModerationAPIChildCommentsResponse
Exemple

postFlagComment 
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

postRemoveComment 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : PostRemoveCommentApiResponse
Exemple

postRestoreDeletedComment 
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

postSetCommentApprovalStatus 
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

postSetCommentReviewStatus 
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
Renvoie : APIEmptyResponse
Exemple

postSetCommentSpamStatus 
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

postSetCommentText 
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 : SetCommentTextResponse
Exemple

postUnFlagComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Response
Retourne : APIEmptyResponse
Example

postVote 
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
Renvoie : VoteResponse
Exemple

putAwardBadge 
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
Renvoie : AwardUserBadgeResponse
Exemple

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

putRemoveBadge 
Paramètres
| Nom | Type | Location | 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 : RemoveUserBadgeResponse
Exemple

putReopenThread 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Réponse
Renvoie : APIEmptyResponse
Exemple

setTrustFactor 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Réponse
Returns: SetUserTrustFactorResponse
Exemple

createModerator 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateModeratorResponse
Exemple

deleteModerator 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| sendEmail | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

getModerator 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetModeratorResponse
Exemple

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

sendInvite 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| fromName | string | query | Oui |
Réponse
Renvoie: APIEmptyResponse
Exemple

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

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

getCachedNotificationCount 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetCachedNotificationCountResponse
Exemple

getNotificationCount 
Parameters
| Nom | Type | Location | Obligatoire | 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

getNotifications 
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
Retourne: GetNotificationsResponse
Exemple

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

createV1PageReact 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| title | string | query | Non |
Réponse
Renvoie : CreateV1PageReact
Exemple

createV2PageReact 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| id | string | query | Oui | |
| title | string | query | Non |
Réponse
Renvoie: CreateV1PageReact
Exemple

deleteV1PageReact 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui |
Réponse
Renvoie : CreateV1PageReact
Exemple

deleteV2PageReact 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| id | string | query | Oui |
Réponse
Retourne : CreateV1PageReact
Exemple

getV1PageLikes 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui |
Réponse
Renvoie : GetV1PageLikes
Exemple

getV2PageReacts 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| urlId | string | requête | Oui |
Réponse
Renvoie: GetV2PageReacts
Exemple

getV2PageReactUsers 
Paramètres
| Nom | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| id | string | query | Oui |
Réponse
Renvoie : GetV2PageReactUsersResponse
Exemple

addPage 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: AddPageAPIResponse
Exemple

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

getOfflineUsers 
Past commentateurs sur la page QUI NE sont PAS en ligne actuellement. 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 le fragment partiel {tenantId, urlId, commenterName} à partir de afterName vers l’avant via $gt, sans coût $skip.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identifiant d’URL de page (nettoyé côté serveur). |
| afterName | string | query | No | Curseur : transmettez nextAfterName de la réponse précédente. |
| afterUserId | string | query | No | Critère de rupture d’égalité du curseur : transmettez 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. |
Response
Returns: PageUsersOfflineResponse
Example

getOnlineUsers 
Currently‑online viewers of a page: people whose websocket session is subscribed to the page right now.
Renvoie 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 : transmettre nextAfterName de la réponse précédente. |
| afterUserId | string | query | No | Critère de désambigüisation du curseur : transmettre nextAfterUserId de 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
Renvoie : PageUsersOnlineResponse
Exemple

getPageByURLId 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui |
Réponse
Renvoie : GetPageByURLIdAPIResponse
Exemple

getPages 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : GetPagesAPIResponse
Exemple

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| Nom | Type | Emplacement | Obligatoire | 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 insensible à la casse (facultatif). |
| sortBy | string | query | No | Ordre de tri. updatedAt (par défaut, le plus récent d'abord), commentCount (le plus de commentaires d'abord), ou title (alphabétique). |
| hasComments | boolean | query | No | Si vrai, ne renvoie que les pages contenant au moins un commentaire. |
Response
Renvoie : GetPublicPagesResponse
Example

getUsersInfo 
Informations utilisateur en masse pour un locataire. Étant donné des userIds, renvoie les informations d'affichage de 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 séparés par des virgules. |
Réponse
Renvoie : PageUsersInfoResponse
Exemple

patchPage 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : PatchPageAPIResponse
Exemple

deletePendingWebhookEvent 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

getPendingWebhookEventCount 
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

getPendingWebhookEvents 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Réponse
Renvoie : GetPendingWebhookEventsResponse
Exemple

createQuestionConfig 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Renvoie : CreateQuestionConfigResponse
Exemple

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

getQuestionConfig 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetQuestionConfigResponse
Exemple

getQuestionConfigs 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie: GetQuestionConfigsResponse
Exemple

updateQuestionConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptyResponse
Exemple

createQuestionResult 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateQuestionResultResponse
Exemple

deleteQuestionResult 
Paramètres
| Nom | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: APIEmptyResponse
Exemple

getQuestionResult 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetQuestionResultResponse
Exemple

getQuestionResults 
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
Renvoie : GetQuestionResultsResponse
Exemple

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

aggregateQuestionResults 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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

bulkAggregateQuestionResults 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| forceRecalculate | boolean | query | Non |
Réponse
Renvoie : BulkAggregateQuestionResultsResponse
Exemple

combineCommentsWithQuestionResults 
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

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

deleteSSOUser 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Réponse
Renvoie : DeleteSSOUserAPIResponse
Exemple

getSSOUserByEmail 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| string | path | Oui |
Réponse
Retourne : GetSSOUserByEmailAPIResponse
Exemple

getSSOUserById 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetSSOUserByIdAPIResponse
Exemple

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

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

putSSOUser 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | boolean | query | Non |
Réponse
Renvoie : PutSSOUserAPIResponse
Exemple

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

deleteSubscription 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Retourne: DeleteSubscriptionAPIResponse
Exemple

getSubscriptions 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non |
Réponse
Renvoie: GetSubscriptionsAPIResponse
Exemple

updateSubscription 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Retourne: UpdateSubscriptionAPIResponse
Exemple

getTenantDailyUsages 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| yearNumber | number | query | Non | |
| monthNumber | number | query | Non | |
| dayNumber | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetTenantDailyUsagesResponse
Exemple

createTenantPackage 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateTenantPackageResponse
Exemple

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

getTenantPackage 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetTenantPackageResponse
Exemple

getTenantPackages 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Retourne : GetTenantPackagesResponse
Exemple

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

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

createTenantUser 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : CreateTenantUserResponse
Exemple

deleteTenantUser 
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
Renvoie : APIEmptyResponse
Exemple

getTenantUser 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetTenantUserResponse
Exemple

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

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

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

updateTenantUser 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Response
Renvoie: APIEmptyResponse
Exemple

createTenant 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateTenantResponse
Exemple

deleteTenant 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| sure | string | query | Non |
Réponse
Retourne: APIEmptyResponse
Exemple

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

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

updateTenant 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: APIEmptyResponse
Exemple

changeTicketState 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: ChangeTicketStateResponse
Exemple

createTicket 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Oui |
Réponse
Renvoie: CreateTicketResponse
Exemple

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

getTickets 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| state | number | query | Non | |
| skip | number | query | Non | |
| limit | number | query | Non |
Réponse
Renvoie : GetTicketsResponse
Exemple

getTranslations 
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
Retourne : GetTranslationsResponse
Exemple

uploadImage 
Upload and resize an 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 | ID de page à partir de laquelle le téléversement a lieu, pour configurer |
Réponse
Retourne : UploadImageResponse
Exemple

getUserBadgeProgressById 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: APIGetUserBadgeProgressResponse
Exemple

getUserBadgeProgressByUserId 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | path | Oui |
Réponse
Renvoie : APIGetUserBadgeProgressResponse
Exemple

getUserBadgeProgressList 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Réponse
Returns: APIGetUserBadgeProgressListResponse
Exemple

createUserBadge 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : APICreateUserBadgeResponse
Exemple

deleteUserBadge 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptySuccessResponse
Exemple

getUserBadge 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: APIGetUserBadgeResponse
Exemple

getUserBadges 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Réponse
Renvoie : APIGetUserBadgesResponse
Exemple

updateUserBadge 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : APIEmptySuccessResponse
Exemple

getUserNotificationCount 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: GetUserNotificationCountResponse
Exemple

getUserNotifications 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Utilisé pour déterminer si la page actuelle est abonnée. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Réponse
Renvoie : GetMyNotificationsResponse
Exemple

resetUserNotificationCount 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : ResetUserNotificationsResponse
Exemple

resetUserNotifications 
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
Retourne : ResetUserNotificationsResponse
Exemple

updateUserNotificationCommentSubscriptionStatus 
Enable or disable notifications for a specific comment. Activer ou désactiver les notifications pour un commentaire spécifique.
Parameters
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| notificationId | string | path | Oui | |
| optedInOrOut | string | path | Oui | |
| commentId | string | query | Oui | |
| sso | string | query | Non |
Response
Réponse
Returns: UpdateUserNotificationCommentSubscriptionStatusResponse
Renvoie : UpdateUserNotificationCommentSubscriptionStatusResponse
Example
Exemple

updateUserNotificationPageSubscriptionStatus 
Activer ou désactiver les notifications pour une page. Lorsque les utilisateurs sont abonnés à une page, des notifications sont créées pour les nouveaux commentaires racines, et aussi
Paramètres
| Nom | Type | Emplacement | Requis | 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

updateUserNotificationStatus 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| notificationId | string | path | Oui | |
| newStatus | string | path | Oui | |
| sso | string | query | Non |
Réponse
Retourne: UpdateUserNotificationStatusResponse
Exemple

getUserPresenceStatuses 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlIdWS | string | query | Oui | |
| userIds | string | query | Oui |
Réponse
Renvoie: GetUserPresenceStatusesResponse
Exemple

searchUsers 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Réponse
Renvoie : SearchUsersResult
Exemple

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

createVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Oui | |
| direction | string | query | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Response
Renvoie : VoteResponse
Exemple

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

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

getVotesForUser 
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
Renvoie : GetVotesForUserResponse
Exemple

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