
Langue 🇨🇦 Français (Canada)
Premiers pas
Référence de l'API
Documentation
Authentification
Agrégation
Journaux d'audit
Blocage depuis un commentaire
Vérification des commentaires bloqués
Commentaires
Configurations de domaine
Modèles de courriel
Journal d'événements
Publications du fil
Signalement de commentaire
Mots-clic
Modérateurs
Compteur de notifications
Notifications
Pages
Événements webhook en attente
Configurations de question
Résultats de question
Agrégation des résultats de question
Utilisateurs SSO
Abonnements
Utilisation quotidienne du locataire
Forfaits de locataire
Utilisateurs du locataire
Locataires
Téléversement d'image
Progression du badge utilisateur
Badges utilisateur
Notifications de l'utilisateur
Statuts de présence des utilisateurs
Recherche d'utilisateurs
Utilisateurs
Votes
FastComments PHP SDK
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écutez ce qui suit :
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configurer l'autorisation par clé API : api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Décommentez la ligne ci-dessous pour configurer le préfixe (par 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'; // string
$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;
}
Points de terminaison de l'API 
Toutes les URI sont relatives à https://fastcomments.com
| Classe | Méthode | HTTP request | Description |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| 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 | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| 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 | getFeedPosts | GET /api/v1/feed-posts | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| 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 | 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 | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| 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 | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| 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 | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| 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 | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| 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 | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| 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 | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| 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 
- APICreateUserBadgeResponse
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIPage
- APISSOUser
- APIStatus
- APIUserSubscription
- AddDomainConfig200Response
- AddDomainConfig200ResponseAnyOf
- AddDomainConfigParams
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AggregateQuestionResults200Response
- AggregateQuestionResultsResponse
- AggregateTimeBucket
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- BlockFromCommentParams
- BlockFromCommentPublic200Response
- BlockSuccess
- BulkAggregateQuestionItem
- BulkAggregateQuestionResults200Response
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- ChangeCommentPinStatusResponse
- CheckBlockedCommentsResponse
- CheckedCommentsForBlocked200Response
- CombineCommentsWithQuestionResults200Response
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateCommentPublic200Response
- CreateFeedPost200Response
- CreateFeedPostParams
- CreateFeedPostPublic200Response
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateSubscriptionAPIResponse
- CreateUserBadge200Response
- CreateUserBadgeParams
- CustomConfigParameters
- DeleteComment200Response
- DeleteCommentAction
- DeleteCommentPublic200Response
- DeleteCommentResult
- DeleteCommentVote200Response
- DeleteDomainConfig200Response
- DeleteFeedPostPublic200Response
- DeleteFeedPostPublic200ResponseAnyOf
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagComment200Response
- FlagCommentPublic200Response
- FlagCommentResponse
- GetAuditLogs200Response
- GetAuditLogsResponse
- GetComment200Response
- GetCommentText200Response
- GetCommentVoteUserNames200Response
- GetCommentVoteUserNamesSuccessResponse
- GetComments200Response
- GetCommentsPublic200Response
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfig200Response
- GetDomainConfigs200Response
- GetDomainConfigs200ResponseAnyOf
- GetDomainConfigs200ResponseAnyOf1
- GetEventLog200Response
- GetEventLogResponse
- GetFeedPosts200Response
- GetFeedPostsPublic200Response
- GetFeedPostsResponse
- GetFeedPostsStats200Response
- GetMyNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPublicFeedPostsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsers200Response
- GetSubscriptionsAPIResponse
- GetUserBadge200Response
- GetUserBadgeProgressById200Response
- GetUserBadgeProgressList200Response
- GetUserBadges200Response
- GetUserNotificationCount200Response
- GetUserNotificationCountResponse
- GetUserNotifications200Response
- GetUserPresenceStatuses200Response
- GetUserPresenceStatusesResponse
- GetUserReactsPublic200Response
- GifRating
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAPIStatusFAILED
- ImportedAPIStatusSUCCESS
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- LockComment200Response
- MediaAsset
- MetaItem
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PatchDomainConfigParams
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PickAPICommentUpdatableCommentFields
- PickFCommentAPICommentFieldsKeys
- PickFCommentAPICommentFieldsKeysMeta
- PickFCommentApprovedOrCommentHTML
- PickFCommentIsDeletedOrCommentHTMLOrCommenterNameOrUserId
- PickFCommentPublicCommentFieldsKeys
- PickOmitFCommentDatePublicCommentPubSubFieldsKeys
- PickTenantAuditLogTenantAuditLogKeys
- PinComment200Response
- PubSubComment
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicFeedPostsResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostPublic200Response
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RecordStringStringOrNumberValue
- RenderableUserNotification
- ResetUserNotifications200Response
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveComment200Response
- SaveCommentResponse
- SaveCommentResponseOptimized
- SaveCommentsResponseWithPresence
- SearchUsers200Response
- SearchUsersResponse
- SetCommentText200Response
- SizePreset
- SortDirections
- SpamRule
- UnBlockCommentPublic200Response
- UnBlockFromCommentParams
- UnblockSuccess
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateDomainConfigParams
- UpdateFeedPostParams
- UpdateUserBadge200Response
- UpdateUserBadgeParams
- UpdateUserNotificationStatus200Response
- UploadImageResponse
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSessionInfo
- VoteBodyParams
- VoteComment200Response
- VoteDeleteResponse
- VoteDeleteResponseStatus
- 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
Agréger 
Agrège des documents en les regroupant (si groupBy est fourni) et en appliquant plusieurs opérations. Différentes opérations (p. ex. sum, countDistinct, avg, etc.) sont prises en charge.
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Réponse
Retourne : AggregationResponse
Exemple

Obtenir les journaux d'audit 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| limit | number | query | Non | |
| skip | number | query | Non | |
| order | string | query | Non | |
| after | number | query | Non | |
| before | number | query | Non |
Réponse
Renvoie: GetAuditLogs200Response
Exemple

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

Débloquer le commentaire public 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| commentId | string | path | Oui | |
| sso | string | query | Non |
Réponse
Renvoie: UnBlockCommentPublic200Response
Exemple

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

Bloquer l'utilisateur depuis un commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Renvoie : BlockFromCommentPublic200Response
Exemple

Créer un commentaire public 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| broadcastId | string | query | Oui | |
| sessionId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : CreateCommentPublic200Response
Exemple

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

Supprimer le commentaire public 
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 : DeleteCommentPublic200Response
Exemple

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

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

Obtenir le commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: GetComment200Response
Exemple

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

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

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

Obtenir les noms d'utilisateur ayant voté 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Réponse
Renvoie: GetCommentVoteUserNames200Response
Exemple

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

Épingler le commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| commentId | string | chemin | Oui | |
| broadcastId | string | requête | Oui | |
| sso | string | requête | Non |
Réponse
Retourne: PinComment200Response
Exemple

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

Enregistrer plusieurs commentaires 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| isLive | boolean | query | Non | |
| doSpamCheck | boolean | query | Non | |
| sendEmails | boolean | query | Non | |
| populateNotifications | boolean | query | Non |
Réponse
Renvoie : SaveComment200Response
Exemple

Définir le texte du commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Réponse
Renvoie: SetCommentText200Response
Exemple

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

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

Déverrouiller le commentaire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| broadcastId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne : LockComment200Response
Exemple

Désépingler le commentaire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | chemin | Oui | |
| commentId | string | chemin | Oui | |
| broadcastId | string | requête | Oui | |
| sso | string | requête | Non |
Réponse
Renvoie: PinComment200Response
Exemple

Mettre à jour le commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| contextUserId | string | query | Non | |
| doSpamCheck | boolean | query | Non | |
| isLive | boolean | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Voter pour un commentaire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| commentId | string | path | Oui | |
| urlId | string | query | Oui | |
| broadcastId | string | query | Oui | |
| sessionId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : VoteComment200Response
Exemple

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

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

Obtenir la configuration de domaine 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| domain | string | path | Oui |
Réponse
Renvoie : GetDomainConfig200Response
Exemple

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

Mettre à jour partiellement la configuration de domaine 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Réponse
Renvoie : GetDomainConfig200Response
Exemple

Remplacer la configuration de domaine 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Réponse
Retourne : GetDomainConfig200Response
Exemple

Créer un modèle de courriel 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateEmailTemplate200Response
Exemple

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

Supprimer l'erreur de rendu du modèle de courriel 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| errorId | string | path | Oui |
Réponse
Retourne : FlagCommentPublic200Response
Exemple

Obtenir le modèle de courriel 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetEmailTemplate200Response
Exemple

Obtenir les définitions des modèles de courriel 
Paramètres
| Nom | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: GetEmailTemplateDefinitions200Response
Exemple

Obtenir les erreurs de rendu des modèles de courriel 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| skip | number | query | Non |
Réponse
Retourne: GetEmailTemplateRenderErrors200Response
Exemple

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

Générer le rendu du modèle de courriel 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| locale | string | query | Non |
Réponse
Renvoie : RenderEmailTemplate200Response
Exemple

Mettre à jour le modèle de courriel 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Obtenir le journal d'événements 
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 | Oui |
Réponse
Renvoie: GetEventLog200Response
Exemple

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

Créer une publication du fil 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Réponse
Retourne: CreateFeedPost200Response
Exemple

Créer une publication du fil publique 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne : CreateFeedPostPublic200Response
Exemple

Supprimer la publication du fil publique 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie : DeleteFeedPostPublic200Response
Exemple

Obtenir les publications du fil 
req tenantId afterId
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| afterId | string | query | Non | |
| limit | integer | query | Non | |
| tags | array | query | Non |
Réponse
Renvoie: GetFeedPosts200Response
Exemple

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

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

Obtenir les réactions des utilisateurs publiques 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postIds | array | query | Non | |
| sso | string | query | Non |
Réponse
Retourne: GetUserReactsPublic200Response
Exemple

Réagir à une publication du fil publique 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| postId | string | path | Oui | |
| isUndo | boolean | query | Non | |
| broadcastId | string | query | Non | |
| sso | string | query | Non |
Réponse
Retourne: ReactFeedPostPublic200Response
Exemple

Mettre à jour la publication du fil 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Retourne : FlagCommentPublic200Response
Exemple

Mettre à jour la publication du fil publique 
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
Renvoie : CreateFeedPostPublic200Response
Exemple

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

Ajouter un mot-clic 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Non |
Réponse
Renvoie : AddHashTag200Response
Exemple

Ajouter des mots-clic en masse 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Non |
Réponse
Renvoie: AddHashTagsBulk200Response
Exemple

Supprimer le mot-clic 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Oui | |
| tenantId | string | query | Non |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Obtenir les mots-clic 
Paramètres
| Name | Type | Location | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| page | number | query | Non |
Réponse
Retourne : GetHashTags200Response
Exemple

Mettre à jour partiellement le mot-clic 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Oui | |
| tenantId | string | query | Non |
Réponse
Renvoie : PatchHashTag200Response
Exemple

Créer un modérateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie: CreateModerator200Response
Exemple

Supprimer le modérateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| sendEmail | string | query | Non |
Réponse
Retourne : FlagCommentPublic200Response
Exemple

Obtenir le modérateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: GetModerator200Response
Exemple

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

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

Mettre à jour le modérateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

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

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

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

Obtenir les notifications 
Paramètres
| Nom | Type | Emplacement | Requis | 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
Renvoie : GetNotifications200Response
Exemple

Mettre à jour la notification 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| userId | string | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

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

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

Obtenir la page par ID d'URL 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui |
Réponse
Retourne : GetPageByURLIdAPIResponse
Exemple

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

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

Supprimer l'événement webhook en attente 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

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

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

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

Supprimer la configuration de question 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

Obtenir la configuration de question 
Paramètres
| Nom | Type | Location | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : GetQuestionConfig200Response
Exemple

Obtenir les configurations de question 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| skip | number | query | Non |
Réponse
Retourne : GetQuestionConfigs200Response
Exemple

Mettre à jour la configuration de question 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

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

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

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

Obtenir les résultats de question 
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
Renvoie : GetQuestionResults200Response
Exemple

Mettre à jour le résultat de question 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

Agréger les résultats de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| questionId | string | query | Non | |
| questionIds | array | query | Non | |
| urlId | string | query | Non | |
| timeBucket | string | query | Non | |
| startDate | string | query | Non | |
| forceRecalculate | boolean | query | Non |
Réponse
Renvoie: AggregateQuestionResults200Response
Exemple

Agréger en masse les résultats de question 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| forceRecalculate | boolean | query | Non |
Réponse
Renvoie: BulkAggregateQuestionResults200Response
Exemple

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

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

Supprimer l'utilisateur SSO 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| deleteComments | boolean | query | Non | |
| commentDeleteMode | string | query | Non |
Réponse
Renvoie : DeleteSSOUserAPIResponse
Exemple

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

Obtenir l'utilisateur SSO par ID 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : GetSSOUserByIdAPIResponse
Exemple

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

Mettre à jour partiellement l'utilisateur SSO 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| updateComments | boolean | query | Non |
Réponse
Renvoie : PatchSSOUserAPIResponse
Exemple

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

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

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

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

Obtenir les utilisations quotidiennes du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Réponse
Retourne: GetTenantDailyUsages200Response
Exemple

Créer un forfait de locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Renvoie : CreateTenantPackage200Response
Exemple

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

Obtenir le forfait de locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne : GetTenantPackage200Response
Exemple

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

Remplacer le forfait de locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: FlagCommentPublic200Response
Exemple

Mettre à jour le forfait de locataire 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

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

Supprimer l'utilisateur du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Réponse
Renvoie : FlagCommentPublic200Response
Exemple

Obtenir l'utilisateur du locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Réponse
Renvoie : GetTenantUser200Response
Exemple

Obtenir les utilisateurs du locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | requête | Oui | |
| skip | number | requête | Non |
Réponse
Renvoie : GetTenantUsers200Response
Exemple

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

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

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

Créer un locataire 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui |
Réponse
Retourne: CreateTenant200Response
Exemple

Supprimer le locataire 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| sure | string | query | Non |
Réponse
Renvoie: FlagCommentPublic200Response
Exemple

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

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

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

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

Obtenir la progression du badge utilisateur par ID 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: GetUserBadgeProgressById200Response
Exemple

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

Obtenir la liste des progressions de badges utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| userId | string | query | Non | |
| limit | number | query | Non | |
| skip | number | query | Non |
Réponse
Renvoie : GetUserBadgeProgressList200Response
Exemple

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

Supprimer le badge utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Renvoie: UpdateUserBadge200Response
Exemple

Obtenir le badge utilisateur 
Paramètres
| Nom | Type | Emplacement | Obligatoire | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: GetUserBadge200Response
Exemple

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

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

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

Obtenir les notifications de l'utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| 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 | |
| sso | string | query | Non |
Réponse
Renvoie : GetUserNotifications200Response
Exemple

Réinitialiser le compteur de notifications de l'utilisateur 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| sso | string | query | Non |
Réponse
Retourne: ResetUserNotifications200Response
Exemple

Réinitialiser les notifications de l'utilisateur 
Paramètres
| Name | Type | Location | Required | 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 : ResetUserNotifications200Response
Exemple

Mettre à jour le statut d'abonnement aux commentaires de notification de l'utilisateur 
Activer ou désactiver les notifications pour un commentaire spécifique.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| notificationId | string | path | Oui | |
| optedInOrOut | string | path | Oui | |
| commentId | string | query | Oui | |
| sso | string | query | Non |
Response
Renvoie : UpdateUserNotificationStatus200Response
Exemple

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

Mettre à jour le statut de notification de l'utilisateur 
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
Renvoie : UpdateUserNotificationStatus200Response
Exemple

Obtenir les statuts de présence des utilisateurs 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlIdWS | string | query | Oui | |
| userIds | string | query | Oui |
Réponse
Renvoie : GetUserPresenceStatuses200Response
Exemple

Rechercher des utilisateurs 
Paramètres
| Nom | Type | Emplacement | Requis | Description |
|---|---|---|---|---|
| tenantId | string | path | Oui | |
| urlId | string | query | Oui | |
| usernameStartsWith | string | query | Oui | |
| mentionGroupIds | array | query | Non | |
| sso | string | query | Non |
Réponse
Renvoie: SearchUsers200Response
Exemple

Obtenir l'utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui |
Réponse
Retourne: GetUser200Response
Exemple

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

Supprimer le vote 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| id | string | path | Oui | |
| editKey | string | query | Non |
Réponse
Retourne: DeleteCommentVote200Response
Exemple

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

Obtenir les votes pour l'utilisateur 
Paramètres
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Oui | |
| urlId | string | query | Oui | |
| userId | string | query | Non | |
| anonUserId | string | query | Non |
Réponse
Retourne: GetVotesForUser200Response
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.