
Langue 🇫🇷 Français (France)
Documentation
Commencer
Référence API
Locataires d'agents
Agrégation
Journaux d'audit
Authentification
Jobs par lots
Bloquer depuis le commentaire
Vérifier les commentaires bloqués
Commentaires
Commentaires pour l'utilisateur
Configurations de domaine
Modèles d'email
Journal d'événements
Publications du fil
Signaler le commentaire
GIFs
Hashtags
Moi
Modération
Modérateurs
Compteur de notifications
Notifications
Réactions de page
Pages
Événements webhook en attente
Votes de sondage
Sondages
Configurations de questions
Résultats de questions
Agrégation des résultats de questions
Utilisateurs SSO
Abonnements
Utilisation quotidienne du locataire
Forfaits de locataire
Utilisateurs du locataire
Locataires
Tickets
Traductions
Télécharger une image
Progression des badges utilisateur
Badges utilisateur
Notifications utilisateur
Statut de présence utilisateur
Recherche d'utilisateurs
Utilisateurs
Votes
Webhooks
SDK Swift FastComments
Ceci est le SDK Swift officiel pour FastComments.
SDK Swift officiel pour l'API FastComments
Repository
Agents de codage IA 
Donnez à votre agent de codage le contexte FastComments dont il a besoin - widgets, configuration, SSO sécurisé, l'API REST et les SDK :
npx skills add fastcomments/skills
Fonctionne avec Claude Code, Codex, Cursor, Copilot, Gemini et tout autre agent pris en charge par le skills CLI supports.
Installation 
Swift Package Manager
Ajoutez ce qui suit à votre fichier Package.swift :
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Ou dans Xcode :
- File > Add Packages...
- Saisissez l'URL du dépôt :
https://github.com/fastcomments/fastcomments-swift.git - Sélectionnez la version que vous souhaitez utiliser
Prérequis
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Contenu de la bibliothèque 
Le SDK Swift FastComments se compose de plusieurs modules :
-
Module Client - Client API pour les API REST de FastComments
- Définitions complètes des types 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
- Voir client/README.md pour une documentation API détaillée
-
Module SSO - Utilitaires Single Sign-On côté serveur
- 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 en utilisant 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
// Configurer votre clé API sur la configuration partagée (envoyée dans l'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 agissant
// (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 du 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 de l'utilisateur
email: "user@example.com", // Email
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 ?? "")")
// Transmettez ce jeton à votre front‑end 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 (pas de 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 
Le SDK FastComments fournit trois clients API :
PublicAPI - Méthodes sûres pour le client
Le PublicAPI contient des méthodes qui peuvent être appelées depuis le code côté client (applications iOS/macOS). Ces méthodes :
- Ne nécessitent pas de clé API
- Peuvent utiliser des jetons SSO pour l’authentification
- Sont limitées en débit par utilisateur/appareil
- Conviennent aux applications destinées aux utilisateurs finaux
Exemple d’utilisation : Récupérer et créer des commentaires dans votre application iOS
DefaultAPI - Méthodes côté serveur
Le DefaultAPI contient des méthodes authentifiées qui nécessitent une clé API. Ces méthodes :
- Exigent votre clé API FastComments
- DOIVENT être appelées UNIQUEMENT depuis le code côté serveur
- Offrent un accès complet à vos données FastComments
- Sont limitées en débit par locataire
Exemple d’utilisation : Opérations administratives, exportation massive de données, gestion des utilisateurs
ModerationAPI - Méthodes du tableau de bord des modérateurs
Le ModerationAPI fournit une suite complète 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.
Exemple d’utilisation : Créer une expérience de modération pour les modérateurs de votre communauté
IMPORTANT : Ne jamais exposer votre clé API dans le code côté client. Les clés API ne doivent être utilisées que côté serveur.
Effectuer des appels API 
Le SDK Swift utilise la syntaxe async/await moderne 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é en production : Utilisez toujours
FastCommentsSSO.createSecure()avec votre clé API en production - Serveur uniquement : Générez les jetons SSO sécurisés sur votre serveur, ne jamais exposer votre clé API aux clients
- Vérifiez les données utilisateur : Assurez‑vous que tous les champs requis (id, email, 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
Notes 
Identifiants de diffusion
Vous verrez qu'on vous demande de passer un broadcastId dans certains appels d'API. Lorsque vous recevez des événements, vous récupérerez cet ID en retour, ce qui vous permettra d'ignorer l'événement si vous prévoyez d'appliquer des changements de manière optimiste côté client (ce que vous souhaiterez 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.
let broadcastId = UUID().uuidString
createAgentTenant 
Crée un nouveau compte d'essai pour un agent IA sans inscription humaine. Aucune clé API n'est nécessaire pour appeler ceci.
La réponse contient l'identifiant du tenant, une clé API qui fonctionne immédiatement avec l'API REST et le serveur MCP, ainsi qu'une URL de revendication. Donnez l'URL de revendication à l'humain pour lequel vous travaillez : l'ouvrir tout en étant connecté à FastComments rattache le compte à cette personne. Les comptes non revendiqués, ainsi que leurs clés, sont supprimés 72 heures après leur création. Tant que le compte n'est pas revendiqué, il est soumis aux limites standard de l'essai.
Réponse
Retourne : CreateAgentTenantResponse
Exemple

aggregate 
Agrège les documents en les groupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (par ex. sum, countDistinct, avg, etc.) sont prises en charge.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Réponse
Renvoie : AggregateResponse
Exemple

getAuditLogs 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | Le locataire dont il faut lire les journaux d'audit. |
| limit | integer | query | No | Nombre de journaux à renvoyer. Max 10000, par défaut 1000. |
| skip | integer | query | No | Nombre de journaux à ignorer, pour la pagination. |
| order | string | query | No | Direction de tri sur le temps de l'événement. Par défaut DESC (du plus récent au plus ancien). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | Ne renvoie que les événements effectués par cet utilisateur. |
| ip | string | query | No | Ne renvoie que les événements provenant de cette adresse IP. |
| crudType | string | query | No | Ne renvoie que les événements de ce type : c, r, u, d, ou login. |
| resourceName | string | query | No | Ne renvoie que les événements pour cette ressource, par ex. User ou Moderator. |
| targetId | string | query | No | Ne renvoie que les événements dont l'objet affecté possède cet identifiant. |
| target | string | query | No | Correspondance insensible à la casse d'une sous-chaîne sur le libellé de l'objet affecté, par ex. un nom d'utilisateur ou un e‑mail. |
| includeManagedTenants | boolean | query | No | Renvoie également les événements des locataires gérés par ce locataire. |
Réponse
Renvoie : GetAuditLogsResponse
Exemple

logoutPublic 
Réponse
Renvoie: APIEmptyResponse
Exemple

getBatchJob 
Statut, progression et, une fois terminé, le résultat d’un travail par lots.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne : GetBatchJobAPIResponse
Exemple

getBatchJobs 
The tenant's batch jobs (imports, exports, page migrations...), newest first.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| type | string | query | No | Uniquement les travaux de ce type, par exemple migrate-pages. |
| status | string | query | No | Uniquement les travaux dans cet état : requested, running, success ou failed. |
| skip | integer | query | No | Nombre de travaux à ignorer, pour la pagination. |
Response
Renvoie: GetBatchJobsAPIResponse
Example

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 | Obligatoire | 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 | Yes | |
| commentIds | string | query | Yes | Une liste d'identifiants de commentaires séparés par des virgules. |
| sso | string | query | No |
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 | |
| locale | string | query | Non |
Réponse
Renvoie : SaveCommentsResponseWithPresence
Exemple

deleteComment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Réponse
Renvoie : DeleteCommentResult
Exemple

deleteCommentPublic 
Parameters
| 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 |
Response
Retourne : PublicAPIDeleteCommentResponse
Example

deleteCommentVote 
Parameters
| Name | Type | Location | Required | 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 |
Response
Retourne : VoteDeleteResponse
Example

flagComment 
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 : FlagCommentResponse
Exemple

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

getComments 
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
Renvoie : APIGetCommentsResponse
Exemple

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

getCommentText 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : 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
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Réponse
Renvoie : APIEmptyResponse
Exemple

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

saveComment 
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

saveCommentsBulk 
Parameters
| 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
Renvoie : [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
Renvoie : PublicAPISetCommentTextResponse
Exemple

translateComments 
Traduit les commentaires donnés dans la langue du widget. Disponible uniquement lorsque la règle de personnalisation du widget correspondante a la traduction des commentaires définie sur Automatique ou Manuel.
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| locale | string | query | No |
Response
Returns: CommentTranslationsResponse
Example

unBlockUserFromComment 
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

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
Renvoie : FlagCommentResponse
Exemple

unLockComment 
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
Retourne : APIEmptyResponse
Exemple

unPinComment 
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: ChangeCommentPinStatusResponse
Exemple

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

voteComment 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Response
Retourne : VoteResponse
Example

getCommentsForUser 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| userId | string | query | Non | |
| direction | string | query | Non | |
| repliesToUserId | string | query | Non | |
| page | number | query | Non | |
| includei10n | boolean | query | Non | |
| locale | string | query | Non | |
| isCrawler | boolean | query | Non |
Réponse
Retourne: GetCommentsForUserResponse
Exemple

addDomainConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : 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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Retourne: GetDomainConfigResponse
Exemple

getDomainConfigs 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : GetDomainConfigsResponse
Exemple

patchDomainConfig 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domainToUpdate | string | path | Oui |
Réponse
Renvoie : PatchDomainConfigResponse
Exemple

putDomainConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
Renvoie : CreateEmailTemplateResponse
Exemple

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

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

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

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

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

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

renderEmailTemplate 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| locale | string | query | Non |
Réponse
Renvoie : RenderEmailTemplateResponse
Exemple

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

getEventLog 
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

getGlobalEventLog 
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

createFeedPost 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Réponse
Renvoie : CreateFeedPostsResponse
Exemple

createFeedPostPublic 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retourne : CreateFeedPostResponse
Exemple

deleteFeedPostPublic 
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 : DeleteFeedPostPublicResponse
Exemple

getFeedPosts 
req tenantId afterId
Paramètres
| 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
Retourne : 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Réponse
Renvoie : UserReactsResponse
Exemple

reactFeedPostPublic 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| isUndo | boolean | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
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
Retourne : CreateFeedPostResponse
Exemple

flagCommentPublic 
Paramètres
| Name | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Réponse
Renvoie: APIEmptyResponse
Exemple

getGifLarge 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| largeInternalURLSanitized | string | query | Oui |
Réponse
Retourne : 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
Retour : 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 | Oui |
Réponse
Retourne : CreateHashTagResponse
Exemple

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

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

getHashTags 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | number | query | Non |
Réponse
Renvoie : GetHashTagsResponse
Exemple

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

getMe 
Identifie les informations d’identification utilisées : le locataire auquel elles appartiennent et, pour les jetons OAuth, l’utilisateur qui les a autorisées.
Les intégrations utilisent cela pour tester une connexion et l’étiqueter.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : GetMeResponse
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 | 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

getApiExportStatus 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| batchJobId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : 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
Retourne : ModerationAPIGetCommentIdsResponse
Exemple

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

getCommentBanStatus 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Réponse
Returns: GetCommentBanStatusResponse
Exemple

getCommentChildren 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Réponse
Renvoie : ModerationAPIChildCommentsResponse
Exemple

getCount 
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
Renvoie : ModerationAPICountCommentsResponse
Exemple

getCounts 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne : 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
Retourne : 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
Retourne : GetUserManualBadgesResponse
Exemple

getModerationComment 
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
Renvoie : ModerationAPICommentResponse
Exemple

getModerationCommentText 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Response
Retourne : GetCommentTextResponse
Exemple

getPreBanSummary 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| includeByUserIdAndEmail | boolean | query | Non | |
| includeByIP | boolean | query | Non | |
| includeByEmailDomain | boolean | query | Non | |
| sso | string | query | Non |
Response
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
Retourne : ModerationCommentSearchResponse
Exemple

getSearchPages 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : ModerationPageSearchResponse
Exemple

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

getSearchSuggest 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : ModerationSuggestResponse
Exemple

getSearchUsers 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
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 | Requis | 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 | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : AdjustVotesResponse
Exemple

postApiExport 
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
Renvoie : 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
Retourne : BanUserFromCommentResult
Exemple

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

postBulkPreBanSummary 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Réponse
Renvoie : BulkPreBanSummary
Exemple

postCommentsByIds 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Returns: 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
Retourne : APIEmptyResponse
Exemple

postSetCommentApprovalStatus 
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
Retourne : SetCommentApprovedResponse
Exemple

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

postSetCommentSpamStatus 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : 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 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : APIEmptyResponse
Exemple

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
Returns: 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
Retourne : AwardUserBadgeResponse
Exemple

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

putRemoveBadge 
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
Retourne : RemoveUserBadgeResponse
Exemple

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

setTrustFactor 
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

createModerator 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : GetModeratorResponse
Exemple

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

sendInvite 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| fromName | string | query | Oui |
Réponse
Retourne: 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetCachedNotificationCountResponse
Exemple

getNotificationCount 
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 |
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 | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

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

createV2PageReact 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : CreateV1PageReact
Exemple

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

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

getV1PageLikes 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Lorsqu'il est défini, renvoie les utilisateurs qui ont aimé la page (avatars et noms d'utilisateur). Seul "public" est accepté, ce qui omet les profils privés. |
Réponse
Retourne : GetV1PageLikes
Exemple

getV2PageReacts 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| sso | string | query | Non | |
| includeUserInfo | string | query | Non | Lorsqu'il est défini, renvoie les utilisateurs pour chaque identifiant de réaction (avatars et noms d'utilisateur). Seul "public" est accepté, ce qui omet les profils privés. |
Réponse
Retourne : GetV2PageReacts
Exemple

getV2PageReactUsers 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| id | string | query | Oui | |
| sso | string | query | Non |
Response
Retourne : GetV2PageReactUsersResponse
Example

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

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

getOfflineUsers 
Commentateurs passés sur la page qui ne sont PAS actuellement en ligne. Triés par displayName. À utiliser après avoir épuisé /users/online pour afficher une section « Membres ». Pagination par curseur sur commenterName : le serveur parcourt l'index partiel {tenantId, urlId, commenterName} depuis afterName en avant via $gt, sans coût de $skip.
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | Identifiant de l'URL de la page (nettoyé côté serveur). |
| afterName | string | query | Non | Curseur : passez nextAfterName de la réponse précédente. |
| afterUserId | string | query | Non | Départage du curseur : passez nextAfterUserId de la réponse précédente. Requis lorsque afterName est défini afin que les ex æquo de nom ne suppriment pas d'entrées. |
Réponse
Renvoie : PageUsersOfflineResponse
Exemple

getOnlineUsers 
Visionneurs en ligne d'une page : personnes dont la session WebSocket est abonnée à la page en ce moment. Retourne anonCount + totalCount (abonnés de la salle, y compris les visiteurs anonymes que nous n'énumérotions pas).
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | Identifiant d'URL de la page (nettoyé côté serveur). |
| afterName | string | query | Non | Curseur : transmettre nextAfterName depuis la réponse précédente. |
| afterUserId | string | query | Non | Anti-égalité du curseur : transmettre nextAfterUserId depuis la réponse précédente. Requis lorsque afterName est défini afin que les égalités de noms ne suppriment pas d'entrées. |
Réponse
Retourne : PageUsersOnlineResponse
Exemple

getPageByURLId 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui |
Réponse
Retourne : GetPageByURLIdAPIResponse
Exemple

getPageLikes 
Nombre de likes pour une page, avec éventuellement les utilisateurs qui ont aimé.
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| includeUserInfo | string | query | Non | "public" omet les utilisateurs avec des profils privés, "include-private" les inclut. |
Réponse
Renvoie : GetPageLikesAPIResponse
Exemple

getPageReacts 
Compteurs de réactions personnalisés pour une page, éventuellement avec les utilisateurs ayant réagi.
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| includeUserInfo | string | query | Non | "public" omet les utilisateurs avec des profils privés, "include-private" les inclut. |
Réponse
Retourne : GetPageReactsAPIResponse
Exemple

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

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

getUsersInfo 
Informations groupées des utilisateurs pour un tenant. Étant donné des userIds, renvoie les informations d'affichage de User / SSOUser. Utilisé par le widget de commentaire 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 | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| ids | string | query | Oui | userIds délimités par des virgules. |
Réponse
Retourne : PageUsersInfoResponse
Exemple

migratePages 
Met en file d'attente un travail par lots qui déplace les commentaires, les pages et les enregistrements associés d'un urlId ou d'un domaine à un autre.
"urlId" migrations ne correspondent qu'à l'urlId exact. "domain" migrations recherchent/remplacent la valeur à l'intérieur de chaque urlId et url.
Interrogez GET /api/v1/batch-jobs/{batchJobId} : une fois terminé, il renvoie les résultats par migration et un undoId.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : QueuePageMigrationJobAPIResponse
Exemple

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

undoPageMigrations 
Met en file d'attente un travail batch qui annule chaque migration d'un travail migrate-pages, du plus récent au plus ancien. Disponible pendant 90 jours.
Les enregistrements modifiés depuis la migration sont laissés intacts, de sorte qu'une modification ultérieure n'est jamais écrasée.
Interrogez GET /api/v1/batch-jobs/{batchJobId} pour obtenir les comptes restaurés/ignorés.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| undoId | string | path | Oui |
Réponse
Returns: QueuePageMigrationJobAPIResponse
Exemple

deletePendingWebhookEvent 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: 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
Retourne : GetPendingWebhookEventCountResponse
Exemple

getPendingWebhookEvents 
Paramètres
| Nom | Type | Emplacement | Requis | 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

createPollVote 
Enregistrez un vote sur un sondage, ou déplacez un vote existant vers une option différente. Un électeur ne peut avoir qu'un seul vote par sondage, ainsi appeler cette fonction à nouveau pour le même électeur déplace son vote plutôt que d'en ajouter un.
Cela respecte les paramètres de sondage du site : si le vote est limité aux utilisateurs connectés, un vote avec uniquement un anonUserId est rejeté, et les votes anonymes sont limités en fréquence par IP pour chaque sondage.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : CreatePollVoteResponse
Exemple

deletePollVote 
Annuler un vote. L'option sur laquelle il a été exprimé récupère son total.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : DeletePollVoteResponse
Exemple

getPollVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Response
Retourne : GetPollVoteResponse
Example

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
Un sondage appartient à un commentaire, donc les votes sont toujours lus un sondage à la fois - commentId est requis. Cela maintient chaque requête sur les index que la collection possède déjà.
Respecte la confidentialité du sondage : les votes d'un sondage anonyme ne peuvent pas être lus (poll-anonymous), ici ou par identifiant.
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | query | Oui | |
| voterId | string | query | Non | |
| optionId | string | query | Non | |
| skip | integer | query | Non |
Response
Returns: GetPollVotesResponse
Example

deletePoll 
Supprimez un sondage de son commentaire, ainsi que chaque vote qui y a été casté. Le commentaire lui‑même reste inchangé.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui |
Réponse
Retourne : APIEmptyResponse
Exemple

getPoll 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Réponse
Retourne : GetPollResponse
Exemple

getPollVoters 
Who voted for which option. Anonymous polls never answer, admins-only polls answer only for an admin or moderator.
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | chaîne | chemin | Oui | |
| commentId | chaîne | chemin | Oui | |
| urlId | chaîne | requête | Non | |
| page | entier | requête | Non | |
| search | chaîne | requête | Non | |
| sso | chaîne | requête | Non |
Response
Returns: GetPollVoterNamesSuccessResponse
Example

patchPoll 
Modifiez un sondage en place, en conservant ses décomptes de voix : changez la question, renommez une option, fermez ou rouvrez le sondage, ou changez qui peut voir les votants. Les options sont adressées par id - pour en ajouter, supprimer ou réordonner, envoyez la liste complète via PUT.
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui |
Réponse
Retourne : SavePollResponse
Exemple

putPoll 
Attachez un sondage à un commentaire, ou définissez l'état complet du sondage qu'il possède déjà.
Les options sont associées par identifiant : une option envoyée avec l'identifiant d'une option existante conserve ses votes (et prend le nouveau libellé et la nouvelle position), une option envoyée sans identifiant est ajoutée, et les options existantes omises de la liste sont supprimées ainsi que les votes qui y ont été attribués.
Ne conserver aucun identifiant d'option existant sur un sondage qui possède des votes supprime toutes les options, il faut donc que replaceVotes=true.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| replaceVotes | boolean | query | Non |
Réponse
Retourne : SavePollResponse
Exemple

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

createQuestionConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Retourne : CreateQuestionConfigResponse
Exemple

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

getQuestionConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne : CreateQuestionResultResponse
Exemple

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

getQuestionResult 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| id | string | chemin | 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 | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| questionId | string | query | Non | |
| questionIds | array | query | Non | |
| urlId | string | query | Non | |
| timeBucket | string | query | Non | |
| startDate | string | query | Non | |
| forceRecalculate | boolean | query | Non |
Réponse
Renvoie : AggregateQuestionResultsResponse
Exemple

bulkAggregateQuestionResults 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| forceRecalculate | boolean | query | Non |
Réponse
Retourne: 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
Retourne : CombineQuestionResultsWithCommentsResponse
Exemple

addSSOUser 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : 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
Retourne : DeleteSSOUserAPIResponse
Exemple

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

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

getSSOUsers 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | integer | query | Non |
Réponse
Renvoie : GetSSOUsersResponse
Exemple

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

putSSOUser 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Réponse
Renvoie: PutSSOUserAPIResponse
Exemple

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

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

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

updateSubscription 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie: 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
Retourne : GetTenantDailyUsagesResponse
Exemple

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

deleteTenantPackage 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Response
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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Renvoie: GetTenantPackagesResponse
Exemple

replaceTenantPackage 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : 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 | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : GetTenantUserResponse
Exemple

getTenantUsers 
Paramètres
| Nom | Type | Emplacement | Requis | 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
| Name | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| redirectURL | string | query | Non |
Réponse
Renvoie: APIEmptyResponse
Exemple

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

createTenant 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Retourne : CreateTenantResponse
Exemple

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

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

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

updateTenant 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Response
Retourne : APIEmptyResponse
Example

changeTicketState 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: 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 | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie : 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 | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
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 | Identifiant de la page depuis laquelle le téléversement a lieu, à configurer |
Réponse
Returns: UploadImageResponse
Exemple

getUserBadgeProgressById 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne : APIGetUserBadgeProgressResponse
Exemple

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

getUserBadgeProgressList 
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
Retourne : APIGetUserBadgeProgressListResponse
Exemple

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

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

getUserBadge 
Paramètres
| Nom | Type | Emplacement | Requis | 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 | 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

updateUserBadge 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Response
Renvoie : APIEmptySuccessResponse
Exemple

getUserNotificationCount 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserNotificationCountResponse
Exemple

getUserNotifications 
Parameters
| 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 |
Response
Renvoie : GetMyNotificationsResponse
Example

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

resetUserNotifications 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Réponse
Renvoie: ResetUserNotificationsResponse
Exemple

updateUserNotificationCommentSubscriptionStatus 
Activer ou désactiver les notifications pour un commentaire spécifique.
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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

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 | 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

updateUserNotificationStatus 
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

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

getUser 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| id | string | chemin | Oui |
Réponse
Renvoie: GetUserResponse
Exemple

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

getVotesForUser 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Réponse
Retourne : GetVotesForUserResponse
Exemple

createWebhook 
Abonne une URL à un événement de commentaire (abonnement REST hook). S'abonner la même URL au même
événement et domaine à nouveau renvoie l'abonnement existant. Les livraisons sont signées HMAC, voir le
guide des webhooks ; l’en‑tête token hérité n’est jamais envoyé aux abonnements API.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreateWebhookResponse
Example

deleteWebhook 
Désabonnements (REST hook unsubscribe). Seules les souscriptions créées via cette API peuvent être supprimées ici ; les webhooks gérés via le tableau de bord sont modifiés dans le tableau de bord.
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Response
Returns: APIEmptyResponse
Example

getWebhooks 
Liste les webhooks configurés pour le locataire, à la fois les lignes gérées via le tableau de bord et les abonnements API.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| event | string | query | Non | |
| domain | string | query | Non | |
| source | string | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetWebhooksResponse
Exemple

getWebhookSamplePayloads 
Recent comments in exactly the shape webhook deliveries use, for building integrations (for example Zapier sample data). Every event delivers the same comment object, so event only has to be valid.
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| event | string | query | Non | |
| limit | number | query | Non |
Response
Returns: GetWebhookSamplePayloadsResponse
Example

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.