
Langue 🇨🇦 Français (Canada)
Premiers pas
Référence API
Documentation
Authentification
Agrégation
Journaux d'audit
Blocage depuis un commentaire
Vérifier les commentaires bloqués
Commentaires
Commentaires pour l'utilisateur
Configurations de domaine
Modèles de courriel
Journal des événements
Publications du fil
Signaler un commentaire
GIFs
Mots‑dièse
Modération
Modérateurs
Compteur de notifications
Notifications
Réactions de la page
Pages
Événements webhook en attente
Configurations de question
Résultats des questions
Agrégation des résultats des questions
Utilisateurs SSO
Abonnements
Utilisation quotidienne du locataire
Forfaits du locataire
Utilisateurs du locataire
Locataires
Tickets
Traductions
Téléverser une image
Progression du badge utilisateur
Badges utilisateur
Notifications utilisateur
Statuts de présence des utilisateurs
Recherche d'utilisateurs
Utilisateurs
Votes
SDK PHP de FastComments
Ceci est le SDK PHP officiel pour FastComments.
SDK PHP officiel pour l'API de FastComments
Dépôt
Installation et utilisation 
Exigences
PHP 7.4 et versions ultérieures. Devrait également fonctionner avec PHP 8.0.
Composer
Pour installer les bindings via Composer, ajoutez ce qui suit à composer.json :
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}
Puis exécutez composer install
Installation manuelle
Téléchargez les fichiers et incluez autoload.php :
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');
Premiers pas 
Veuillez suivre la procédure d'installation, puis exécuter ce qui suit :
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configurer l'authentification par clé API : api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Décommentez ci-dessous pour configurer le préfixe (p. ex. Bearer) pour la clé API, si nécessaire
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
// Si vous souhaitez utiliser un client HTTP personnalisé, passez votre client qui implémente `GuzzleHttp\ClientInterface`.
// Ceci est optionnel, `GuzzleHttp\Client` sera utilisé par défaut.
new GuzzleHttp\Client(),
$config
);
$tenant_id = 'tenant_id_example'; // chaîne
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
try {
$result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}
Clients API 
Le SDK expose trois classes client d’API :
DefaultApi– Méthodes authentifiées par clé API pour une utilisation côté serveur. Configurez une clé API comme indiqué dans Getting Started.PublicApi– Méthodes publiques qui ne nécessitent pas de clé API, sécurisées pour être appelées depuis les navigateurs et les applications mobiles.ModerationApi– Une suite étendue d’API de modération en temps réel et rapides. Chaque méthodeModerationApiaccepte un paramètre$ssoet peut s’authentifier via SSO ou un cookie de session FastComments.com.
Utilisation de PublicApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Les méthodes publiques ne nécessitent pas de clé API.
$apiInstance = new FastComments\Client\Api\PublicApi(
new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // chaîne
$url_id = 'url_id_example'; // chaîne
try {
$result = $apiInstance->getCommentsPublic($tenant_id, $url_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}
Utilisation de ModerationApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
new GuzzleHttp\Client()
);
$sso = 'sso_example'; // chaîne - charge utile SSO authentifiant le modérateur
try {
$result = $apiInstance->getCount([
'sso' => $sso,
]);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}
Méthodes API 
Toutes les URI sont relatives à https://fastcomments.com
| Classe | Méthode | Requête HTTP | Description |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/set-trust-factor | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | |
| PublicApi | getEventLog | GET /event-log/{tenantId} | |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | getUsersInfo | GET /pages/{tenantId}/users/info | |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Modèles 
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBaseMeta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponseAnyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchMatchedOnValue
- BannedUserMatchType
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBodyTagsInner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponseResultsInner
- BulkPreBanParams
- BulkPreBanSummary
- ChangeCommentPinStatusResponse
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CommentsByIdsParams
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPostParams
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadgeParams
- CreateV1PageReact
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentResult
- DeleteDomainConfigResponse
- DeleteFeedPostPublicResponse
- DeleteHashTagRequestBody
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentResponse
- GetAuditLogsResponse
- GetBannedUsersCountResponse
- GetBannedUsersFromCommentResponse
- GetCachedNotificationCountResponse
- GetCommentBanStatusResponse
- GetCommentTextResponse
- GetCommentVoteUserNamesSuccessResponse
- GetCommentsForUserResponse
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfigResponse
- GetDomainConfigsResponse
- GetDomainConfigsResponseAnyOf
- GetDomainConfigsResponseAnyOf1
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplatesResponse
- GetEventLogResponse
- GetFeedPostsResponse
- GetGifsSearchResponse
- GetGifsTrendingResponse
- GetHashTagsResponse
- GetModeratorResponse
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCountResponse
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetPublicPagesResponse
- GetQuestionConfigResponse
- GetQuestionConfigsResponse
- GetQuestionResultResponse
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsersResponse
- GetSubscriptionsAPIResponse
- GetTenantDailyUsagesResponse
- GetTenantManualBadgesResponse
- GetTenantPackageResponse
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUserResponse
- GetTenantUsersResponse
- GetTenantsResponse
- GetTicketResponse
- GetTicketsResponse
- GetTranslationsResponse
- GetUserInternalProfileResponse
- GetUserInternalProfileResponseProfile
- GetUserManualBadgesResponse
- GetUserNotificationCountResponse
- GetUserPresenceStatusesResponse
- GetUserResponse
- GetUserTrustFactorResponse
- GetV1PageLikes
- GetV2PageReactUsersResponse
- GetV2PageReacts
- GetVotesForUserResponse
- GetVotesResponse
- GifGetLargeResponse
- GifRating
- GifSearchInternalError
- GifSearchResponse
- GifSearchResponseImagesInnerInner
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAgentApprovalNotificationFrequency
- ImportedSiteType
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- ModerationAPIChildCommentsResponse
- ModerationAPIComment
- ModerationAPICommentLog
- ModerationAPICommentResponse
- ModerationAPICountCommentsResponse
- ModerationAPIGetCommentIdsResponse
- ModerationAPIGetCommentsResponse
- ModerationAPIGetLogsResponse
- ModerationCommentSearchResponse
- ModerationExportResponse
- ModerationExportStatusResponse
- ModerationFilter
- ModerationPageSearchProjected
- ModerationPageSearchResponse
- ModerationSiteSearchProjected
- ModerationSiteSearchResponse
- ModerationSuggestResponse
- ModerationUserSearchProjected
- ModerationUserSearchResponse
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PageUserEntry
- PageUsersInfoResponse
- PageUsersOfflineResponse
- PageUsersOnlineResponse
- PagesSortBy
- PatchDomainConfigParams
- PatchDomainConfigResponse
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PostRemoveCommentResponse
- PreBanSummary
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicPage
- PublicVote
- PutDomainConfigResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionConfig
- QuestionConfigCustomOptionsInner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RemoveCommentActionResponse
- RemoveUserBadgeResponse
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveCommentResponseOptimized
- SaveCommentsBulkResponse
- SaveCommentsResponseWithPresence
- SearchUsersResponse
- SearchUsersResult
- SearchUsersSectionedResponse
- SetCommentApprovedResponse
- SetCommentTextParams
- SetCommentTextResponse
- SetCommentTextResult
- SetUserTrustFactorResponse
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantBadge
- TenantHashTag
- TenantPackage
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadgeParams
- UpdateUserNotificationCommentSubscriptionStatusResponse
- UpdateUserNotificationPageSubscriptionStatusResponse
- UpdateUserNotificationStatusResponse
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- UsersListLocation
- VoteBodyParams
- VoteDeleteResponse
- VoteResponse
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
Autorisation 
Schémas d'authentification définis pour l'API:
api_key
- Type: clé API
- Nom du paramètre de la clé API: x-api-key
- Emplacement: en-tête HTTP
aggregate 
Agrège les documents en les regroupant (si groupBy est fourni) et en appliquant plusieurs opérations.
Différentes opérations (p. ex. sum, countDistinct, avg, etc.) sont prises en charge.
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| parentTenantId | string | query | Non | |
| includeStats | boolean | query | Non |
Réponse
Renvoie : AggregateResponse
Exemple

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
Retourne : GetAuditLogsResponse
Exemple

logoutPublic 
Response
Renvoie: APIEmptyResponse
Example

blockFromCommentPublic 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : 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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | Une liste séparée par des virgules d’identifiants de commentaires. |
| sso | string | query | No |
Réponse
Renvoie : CheckBlockedCommentsResponse
Exemple

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

createCommentPublic 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Réponse
Retour : SaveCommentsResponseWithPresence
Exemple

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

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

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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : 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
Retourne : GetCommentsResponseWithPresencePublicComment
Exemple

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

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

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

pinComment 
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
Retourne : 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
Renvoie : APISaveCommentResponse
Exemple

saveCommentsBulk 
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 : 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
Retourne : PublicAPISetCommentTextResponse
Exemple

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
| 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
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Returns: 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
Retourne : 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
Retourne : 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
Returns: GetCommentsForUserResponse
Exemple

addDomainConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: AddDomainConfigResponse
Example

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

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

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

patchDomainConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
| Nom | Type | Emplacement | Obligatoire | 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
Returns: APIEmptyResponse
Exemple

deleteEmailTemplateRenderError 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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 | Yes | |
| id | string | path | Yes |
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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Retourne : GetEmailTemplatesResponse
Exemple

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

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

getEventLog 
req tenantId urlId userIdWS
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| userIdWS | string | query | Oui | |
| startTime | integer | query | Oui | |
| endTime | integer | query | Non |
Réponse
Renvoie : GetEventLogResponse
Exemple

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

createFeedPostPublic 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Retourne : 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 
requête 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
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
Retourne : FeedPostsStatsResponse
Exemple

getUserReactsPublic 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
| Name | Type | Location | Required | 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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| isFlagged | boolean | query | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : APIEmptyResponse
Exemple

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

getGifsSearch 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Réponse
Retourne : GetGifsSearchResponse
Exemple

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

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 | 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
Renvoie : 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 | 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 | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : ModerationExportStatusResponse
Exemple

getApiIds 
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 | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Réponse
Retourne : ModerationAPIGetCommentIdsResponse
Exemple

getBanUsersFromComment 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : 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
Retourne : 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
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 | 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 | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Retourne : 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
Renvoie : 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
Returns: ModerationCommentSearchResponse
Exemple

getSearchPages 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| value | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : 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 | Oui | |
| text-search | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ModerationSuggestResponse
Exemple

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

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

getUserBanPreference 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| sso | string | requête | Non |
Réponse
Renvoie: 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 | 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
Renvoie : BanUserFromCommentResult
Exemple

postBanUserUndo 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Réponse
Returns: 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 | Oui | |
| sso | string | query | Non |
Réponse
Renvoie : 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
Renvoie : APIEmptyResponse
Exemple

postRemoveComment 
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 : 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 | Oui | |
| commentId | string | path | Oui | |
| reviewed | boolean | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Returns: APIEmptyResponse
Exemple

postSetCommentSpamStatus 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : APIEmptyResponse
Exemple

postSetCommentText 
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 : 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
Retourne : 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
Retourne : 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 | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Réponse
Renvoie : APIEmptyResponse
Exemple

putRemoveBadge 
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 : 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 | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie : SetUserTrustFactorResponse
Exemple

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

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

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

getModerators 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
Retourne : APIEmptyResponse
Exemple

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

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

getCachedNotificationCount 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| id | string | chemin | Oui |
Réponse
Retourne : 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
Retourne : 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 | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Réponse
Retourne : APIEmptyResponse
Exemple

createV1PageReact 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No |
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 | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Réponse
Renvoie : CreateV1PageReact
Exemple

deleteV2PageReact 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| urlId | string | requête | Oui | |
| id | string | requête | Oui |
Réponse
Renvoie : CreateV1PageReact
Exemple

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

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

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

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

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

getOfflineUsers 
Past commentateurs sur la page qui ne sont PAS actuellement en ligne. Triés par displayName.
Utilisez ceci après avoir épuisé /users/online pour afficher une section « Membres ».
Pagination par curseur sur commenterName : le serveur parcourt la partie {tenantId, urlId, commenterName} indice à 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 la page (nettoyé côté serveur). |
| afterName | string | query | No | Curseur : transmettre nextAfterName de la réponse précédente. |
| afterUserId | string | query | No | Curseur de désambigation : transmettre nextAfterUserId de 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. |
Response
Renvoie : PageUsersOfflineResponse
Example

getOnlineUsers 
Currently-online viewers of a page : personnes dont la session websocket est abonnée à la page en ce moment.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | Identifiant d’URL de page (nettoyé côté serveur). |
| afterName | string | query | Non | Curseur : transmettre nextAfterName de la réponse précédente. |
| afterUserId | string | query | Non | Curseur de résolution d’égalité : transmettre 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: PageUsersOnlineResponse
Example

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

getPages 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Réponse
Retourne : 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Curseur de pagination opaque renvoyé comme nextCursor à partir d'une requête précédente. Lié au même sortBy. |
| limit | integer | query | No | 1..200, défaut 50 |
| q | string | query | No | Filtre de préfixe de titre optionnel, insensible à la casse. |
| sortBy | string | query | No | Ordre de tri. updatedAt (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 provenant 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 uniformément (les profils privés sont masqués).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | Identifiants d’utilisateurs séparés par des virgules. |
Response
Returns: PageUsersInfoResponse
Exemple

patchPage 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Réponse
Retourne : GetPendingWebhookEventsResponse
Exemple

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

deleteQuestionConfig 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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 | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : GetQuestionConfigResponse
Exemple

getQuestionConfigs 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Réponse
Renvoie : GetQuestionConfigsResponse
Exemple

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

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

getQuestionResults 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Non | |
| userId | string | query | Non | |
| startDate | string | query | Non | |
| questionId | string | query | Non | |
| questionIds | string | query | Non | |
| skip | number | query | Non |
Réponse
Retourne : 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 | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Réponse
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
Renvoie : CombineQuestionResultsWithCommentsResponse
Exemple

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

deleteSSOUser 
Paramètres
| Name | Type | Location | Required | 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
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 | Yes | |
| skip | integer | query | No |
Réponse
Retourne : GetSSOUsersResponse
Exemple

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

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

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

deleteSubscription 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Response
Renvoie : DeleteSubscriptionAPIResponse
Example

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

updateSubscription 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
Retourne : CreateTenantPackageResponse
Exemple

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

getTenantPackage 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
Retourne : GetTenantPackagesResponse
Exemple

replaceTenantPackage 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Response
Renvoie : APIEmptyResponse
Exemple

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

createTenantUser 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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 | Yes | |
| id | string | path | Yes |
Réponse
Retourne : GetTenantUserResponse
Exemple

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

replaceTenantUser 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
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
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | string | query | Non |
Réponse
Returns: APIEmptyResponse
Exemple

createTenant 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui |
Réponse
Renvoie : CreateTenantResponse
Exemple

deleteTenant 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sure | string | query | No |
Réponse
Renvoie : 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 | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Réponse
Retourne : GetTenantsResponse
Exemple

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

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

createTicket 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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
Retourne : 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
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Jeu de tailles : "Default" (1000x1000px) ou "CrossPlatform" (crée des tailles pour les appareils populaires) |
| urlId | string | query | No | ID de page depuis lequel le téléversement a lieu, à 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | path | Oui |
Réponse
Retourne : 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
Renvoie : 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : APIEmptySuccessResponse
Exemple

getUserBadge 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
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
Renvoie : APIGetUserBadgesResponse
Exemple

updateUserBadge 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne : APIEmptySuccessResponse
Exemple

getUserNotificationCount 
Paramètres
| Nom | Type | Emplacement | Obligatoire | 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 | Oui | |
| urlId | string | query | Non | Utilisé pour déterminer si la page actuelle est abonnée. |
| pageSize | integer | query | Non | |
| afterId | string | query | Non | |
| includeContext | boolean | query | Non | |
| afterCreatedAt | integer | query | Non | |
| unreadOnly | boolean | query | Non | |
| dmOnly | boolean | query | Non | |
| noDm | boolean | query | Non | |
| includeTranslations | boolean | query | Non | |
| includeTenantNotifications | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : GetMyNotificationsResponse
Exemple

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

resetUserNotifications 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| afterId | string | query | Non | |
| afterCreatedAt | integer | query | Non | |
| unreadOnly | boolean | query | Non | |
| dmOnly | boolean | query | Non | |
| noDm | boolean | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : ResetUserNotificationsResponse
Exemple

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
Retourne : UpdateUserNotificationCommentSubscriptionStatusResponse
Exemple

updateUserNotificationPageSubscriptionStatus 
Enable 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 racine, et également
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 | Obligatoire | 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 | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
Réponse
Retourne : GetUserPresenceStatusesResponse
Exemple

searchUsers 
Paramètres
| Name | Type | Location | Required | 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 | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : GetUserResponse
Exemple

createVote 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Réponse
Renvoie : VoteResponse
Exemple

deleteVote 
Parameters
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| editKey | string | query | Non |
Response
Retourne : VoteDeleteResponse
Example

getVotes 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
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
Retourne : GetVotesForUserResponse
Exemple

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