
Język 🇵🇱 Polski
Rozpoczęcie pracy
Referencja API
Dokumentacja
Uwierzytelnianie
Agregacja
Dzienniki audytu
Autoryzacja
Blokowanie z komentarza
Sprawdzanie zablokowanych komentarzy
Komentarze
Komentarze użytkownika
Konfiguracje domeny
Szablony e-mail
Dziennik zdarzeń
Wpisy kanału
Zgłaszanie komentarza
Gify
Hashtagi
Moderacja
Moderatorzy
Liczba powiadomień
Powiadomienia
Reakcje strony
Strony
Oczekujące zdarzenia webhook
Konfiguracje pytań
Wyniki pytań
Agregacja wyników pytań
Użytkownicy SSO
Subskrypcje
Dzienne użycie najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Zgłoszenia
Tłumaczenia
Prześlij obraz
Postępy odznak użytkownika
Odznaki użytkownika
Powiadomienia użytkownika
Status obecności użytkownika
Wyszukiwanie użytkowników
Użytkownicy
Głosy
FastComments PHP SDK
To jest oficjalne SDK PHP dla FastComments.
Oficjalne SDK PHP dla API FastComments
Repozytorium
Instalacja i użycie 
Wymagania
PHP 7.4 lub nowszy. Powinno również działać z PHP 8.0.
Composer
Aby zainstalować powiązania za pomocą Composer, dodaj do composer.json następujące:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}
Następnie uruchom composer install
Ręczna instalacja
Pobierz pliki i dołącz autoload.php:
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');
Rozpoczęcie pracy 
Proszę postępować zgodnie z procedurą instalacji, a następnie uruchomić poniższe:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Skonfiguruj autoryzację klucza API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Odkomentuj poniżej, aby ustawić prefiks (np. Bearer) dla klucza API, jeśli to konieczne
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
// Jeśli chcesz użyć niestandardowego klienta HTTP, przekaż klienta, który implementuje `GuzzleHttp\ClientInterface`.
// Jest to opcjonalne, `GuzzleHttp\Client` will be used as default.
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;
}
Klienci API 
The SDK udostępnia trzy klasy klientów API:
DefaultApi– metody uwierzytelniane kluczem API do użycia po stronie serwera. Skonfiguruj klucz API, jak pokazano w Getting Started.PublicApi– publiczne metody, które nie wymagają klucza API, bezpieczne do wywoływania z przeglądarek i aplikacji mobilnych.ModerationApi– rozbudowany zestaw szybkich i bieżących API moderacji. Każda metodaModerationApiakceptuje parametr$ssoi może uwierzytelnić się za pomocą SSO lub pliku cookie sesji FastComments.com.
Używanie PublicApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Publiczne metody nie wymagają klucza API.
$apiInstance = new FastComments\Client\Api\PublicApi(
new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
$result = $apiInstance->getCommentsPublic($tenant_id, $url_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}
Używanie ModerationApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
new GuzzleHttp\Client()
);
$sso = 'sso_example'; // string - ładunek SSO uwierzytelniający moderatora
try {
$result = $apiInstance->getCount([
'sso' => $sso,
]);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}
Metody API 
Wszystkie URI są względne względem https://fastcomments.com
| Klasa | Metoda | Żądanie HTTP | Opis |
|---|---|---|---|
| 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 |
Modele 
- 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
Autoryzacja 
Schematy uwierzytelniania zdefiniowane dla API:
api_key
- Typ: API key
- Nazwa parametru klucza API: x-api-key
- Lokalizacja: HTTP header
aggregate 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Odpowiedź
Returns: AggregateResponse
Przykład

getAuditLogs 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Odpowiedź
Zwraca: GetAuditLogsResponse
Przykład

logoutPublic 
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

blockFromCommentPublic 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Returns: BlockSuccess
Example

unBlockCommentPublic 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UnblockSuccess
Przykład

checkedCommentsForBlocked 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentIds | string | query | Tak | Lista identyfikatorów komentarzy oddzielona przecinkami. |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CheckBlockedCommentsResponse
Example

blockUserFromComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Returns: BlockSuccess
Przykład

createCommentPublic 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: SaveCommentsResponseWithPresence
Przykład

deleteComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Odpowiedź
Zwraca: DeleteCommentResult
Przykład

deleteCommentPublic 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Zwraca: PublicAPIDeleteCommentResponse
Przykład

deleteCommentVote 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: VoteDeleteResponse
Przykład

flagComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odpowiedź
Zwraca: FlagCommentResponse
Przykład

getComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIGetCommentResponse
Przykład

getComments 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | integer | query | Nie | |
| limit | integer | query | Nie | |
| skip | integer | query | Nie | |
| asTree | boolean | query | Nie | |
| skipChildren | integer | query | Nie | |
| limitChildren | integer | query | Nie | |
| maxTreeDepth | integer | query | Nie | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie | |
| contextUserId | string | query | Nie | |
| hashTag | string | query | Nie | |
| parentId | string | query | Nie | |
| direction | string | query | Nie | |
| fromDate | integer | query | Nie | |
| toDate | integer | query | Nie |
Odpowiedź
Zwraca: APIGetCommentsResponse
Przykład

getCommentsPublic 
req
tenantId
urlId
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| page | integer | query | Nie | |
| direction | string | query | Nie | |
| sso | string | query | Nie | |
| skip | integer | query | Nie | |
| skipChildren | integer | query | Nie | |
| limit | integer | query | Nie | |
| limitChildren | integer | query | Nie | |
| countChildren | boolean | query | Nie | |
| fetchPageForCommentId | string | query | Nie | |
| includeConfig | boolean | query | Nie | |
| countAll | boolean | query | Nie | |
| includei10n | boolean | query | Nie | |
| locale | string | query | Nie | |
| modules | string | query | Nie | |
| isCrawler | boolean | query | Nie | |
| includeNotificationCount | boolean | query | Nie | |
| asTree | boolean | query | Nie | |
| maxTreeDepth | integer | query | Nie | |
| useFullTranslationIds | boolean | query | Nie | |
| parentId | string | query | Nie | |
| searchText | string | query | Nie | |
| hashTags | array | query | Nie | |
| userId | string | query | Nie | |
| customConfigStr | string | query | Nie | |
| afterCommentId | string | query | Nie | |
| beforeCommentId | string | query | Nie |
Odpowiedź
Zwraca: GetCommentsResponseWithPresencePublicComment
Przykład

getCommentText 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PublicAPIGetCommentTextResponse
Przykład

getCommentVoteUserNames 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| dir | integer | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetCommentVoteUserNamesSuccessResponse
Przykład

lockComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

pinComment 
Parameters
| Name | Typ | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ChangeCommentPinStatusResponse
Przykład

saveComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| sendEmails | boolean | query | Nie | |
| populateNotifications | boolean | query | Nie |
Odpowiedź
Zwraca: APISaveCommentResponse
Przykład

saveCommentsBulk 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Odpowiedź
Zwraca: SaveCommentsBulkResponse
Przykład

setCommentText 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: PublicAPISetCommentTextResponse
Przykład

unBlockUserFromComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: UnblockSuccess
Przykład

unFlagComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odpowiedź
Zwraca: FlagCommentResponse
Przykład

unLockComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

unPinComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ChangeCommentPinStatusResponse
Przykład

updateComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

voteComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: VoteResponse
Przykład

getCommentsForUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: GetCommentsForUserResponse
Przykład

addDomainConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: AddDomainConfigResponse
Przykład

deleteDomainConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Odpowiedź
Zwraca: DeleteDomainConfigResponse
Przykład

getDomainConfig 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| domain | string | ścieżka | Tak |
Odpowiedź
Zwraca: GetDomainConfigResponse
Przykład

getDomainConfigs 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: GetDomainConfigsResponse
Przykład

patchDomainConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domainToUpdate | string | path | Tak |
Odpowiedź
Zwraca: PatchDomainConfigResponse
Przykład

putDomainConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Odpowiedź
Zwraca: PutDomainConfigResponse
Przykład

createEmailTemplate 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: CreateEmailTemplateResponse
Przykład

deleteEmailTemplate 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

deleteEmailTemplateRenderError 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| errorId | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getEmailTemplate 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: GetEmailTemplateResponse
Przykład

getEmailTemplateDefinitions 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Response
Zwraca: GetEmailTemplateDefinitionsResponse
Przykład

getEmailTemplateRenderErrors 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetEmailTemplateRenderErrorsResponse
Przykład

getEmailTemplates 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetEmailTemplatesResponse
Przykład

renderEmailTemplate 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| locale | string | query | No |
Odpowiedź
Zwraca: RenderEmailTemplateResponse
Przykład

updateEmailTemplate 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getEventLog 
req tenantId urlId userIdWS
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| userIdWS | string | query | Tak | |
| startTime | integer | query | Tak | |
| endTime | integer | query | Nie |
Odpowiedź
Zwraca: GetEventLogResponse
Przykład

getGlobalEventLog 
req tenantId urlId userIdWS
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| userIdWS | string | query | Tak | |
| startTime | integer | query | Tak | |
| endTime | integer | query | Nie |
Odpowiedź
Zwraca: GetEventLogResponse
Przykład

createFeedPost 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| broadcastId | string | query | Nie | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| skipDupCheck | boolean | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostsResponse
Przykład

createFeedPostPublic 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostResponse
Przykład

deleteFeedPostPublic 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: DeleteFeedPostPublicResponse
Example

getFeedPosts 
req
tenantId
afterId
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsResponse
Przykład

getFeedPostsPublic 
req tenantId afterId
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Odpowiedź
Zwraca: PublicFeedPostsResponse
Przykład

getFeedPostsStats 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: FeedPostsStatsResponse
Przykład

getUserReactsPublic 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UserReactsResponse
Przykład

reactFeedPostPublic 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ReactFeedPostResponse
Przykład

updateFeedPost 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Response
Zwraca: APIEmptyResponse
Example

updateFeedPostPublic 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostResponse
Przykład

flagCommentPublic 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getGifLarge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| largeInternalURLSanitized | string | query | Yes |
Odpowiedź
Returns: GifGetLargeResponse
Przykład

getGifsSearch 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Odpowiedź
Zwraca: GetGifsSearchResponse
Przykład

getGifsTrending 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Odpowiedź
Zwraca: GetGifsTrendingResponse
Przykład

addHashTag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Returns: CreateHashTagResponse
Przykład

addHashTagsBulk 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: BulkCreateHashTagsResponse
Przykład

deleteHashTag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| tag | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getHashTags 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | number | query | Nie |
Odpowiedź
Zwraca: GetHashTagsResponse
Przykład

patchHashTag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Odpowiedź
Zwraca: UpdateHashTagResponse
Przykład

deleteModerationVote 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Zwraca: VoteDeleteResponse
Example

getApiComments 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | number | query | Nie | |
| count | number | query | Nie | |
| text-search | string | query | Nie | |
| byIPFromComment | string | query | Nie | |
| filters | string | query | Nie | |
| searchFilters | string | query | Nie | |
| sorts | string | query | Nie | |
| demo | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationAPIGetCommentsResponse
Przykład

getApiExportStatus 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| batchJobId | string | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: ModerationExportStatusResponse
Przykład

getApiIds 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: ModerationAPIGetCommentIdsResponse
Przykład

getBanUsersFromComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetBannedUsersFromCommentResponse
Przykład

getCommentBanStatus 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetCommentBanStatusResponse
Przykład

getCommentChildren 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationAPIChildCommentsResponse
Przykład

getCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationAPICountCommentsResponse
Przykład

getCounts 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetBannedUsersCountResponse
Przykład

getLogs 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationAPIGetLogsResponse
Przykład

getManualBadges 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetTenantManualBadgesResponse
Przykład

getManualBadgesForUser 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| badgesUserId | string | query | Nie | |
| commentId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserManualBadgesResponse
Przykład

getModerationComment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationAPICommentResponse
Przykład

getModerationCommentText 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetCommentTextResponse
Przykład

getPreBanSummary 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: PreBanSummary
Przykład

getSearchCommentsSummary 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationCommentSearchResponse
Przykład

getSearchPages 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationPageSearchResponse
Przykład

getSearchSites 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| value | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationSiteSearchResponse
Przykład

getSearchSuggest 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| text-search | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationSuggestResponse
Przykład

getSearchUsers 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationUserSearchResponse
Przykład

getTrustFactor 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserTrustFactorResponse
Przykład

getUserBanPreference 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Zwraca: APIModerateGetUserBanPreferencesResponse
Przykład

getUserInternalProfile 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserInternalProfileResponse
Przykład

postAdjustCommentVotes 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: AdjustVotesResponse
Przykład

postApiExport 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ModerationExportResponse
Przykład

postBanUserFromComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: BanUserFromCommentResult
Przykład

postBanUserUndo 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagany | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

postBulkPreBanSummary 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| includeByUserIdAndEmail | boolean | query | Nie | |
| includeByIP | boolean | query | Nie | |
| includeByEmailDomain | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: BulkPreBanSummary
Przykład

postCommentsByIds 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ModerationAPIChildCommentsResponse
Przykład

postFlagComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

postRemoveComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: PostRemoveCommentApiResponse
Przykład

postRestoreDeletedComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

postSetCommentApprovalStatus 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| approved | boolean | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SetCommentApprovedResponse
Przykład

postSetCommentReviewStatus 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

postSetCommentSpamStatus 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| spam | boolean | query | Nie | |
| permNotSpam | boolean | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

postSetCommentText 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: SetCommentTextResponse
Przykład

postUnFlagComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

postVote 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| direction | string | query | Nie | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: VoteResponse
Przykład

putAwardBadge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: AwardUserBadgeResponse
Przykład

putCloseThread 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

putRemoveBadge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: RemoveUserBadgeResponse
Przykład

putReopenThread 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

setTrustFactor 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| trustFactor | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SetUserTrustFactorResponse
Przykład

createModerator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateModeratorResponse
Przykład

deleteModerator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sendEmail | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getModerator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: GetModeratorResponse
Przykład

getModerators 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetModeratorsResponse
Przykład

sendInvite 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| fromName | string | query | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

updateModerator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

deleteNotificationCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Returns: APIEmptyResponse
Przykład

getCachedNotificationCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: GetCachedNotificationCountResponse
Przykład

getNotificationCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Odpowiedź
Returns: GetNotificationCountResponse
Przykład

getNotifications 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: GetNotificationsResponse
Przykład

updateNotification 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

createV1PageReact 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

createV2PageReact 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| id | string | query | Tak | |
| title | string | query | Nie |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

deleteV1PageReact 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak |
Response
Zwraca: CreateV1PageReact
Example

deleteV2PageReact 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak | |
| id | string | zapytanie | Tak |
Odpowiedź
Zwraca: CreateV1PageReact
Przykład

getV1PageLikes 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Odpowiedź
Zwraca: GetV1PageLikes
Przykład

getV2PageReacts 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| urlId | string | zapytanie | Tak |
Response
Zwraca: GetV2PageReacts
Przykład

getV2PageReactUsers 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Odpowiedź
Zwraca: GetV2PageReactUsersResponse
Przykład

addPage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: AddPageAPIResponse
Przykład

deletePage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: DeletePageAPIResponse
Przykład

getOfflineUsers 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identyfikator URL strony (czyszczony po stronie serwera). |
| afterName | string | query | No | Kursor: przekazać nextAfterName z poprzedniej odpowiedzi. |
| afterUserId | string | query | No | Rozstrzygacz kursora: przekazać nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy afterName jest ustawione, aby powiązania nazw nie pomijały wpisów. |
Response
Returns: PageUsersOfflineResponse
Example

getOnlineUsers 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identyfikator URL strony (czyszczony po stronie serwera). |
| afterName | string | query | No | Kursor: przekaż nextAfterName z poprzedniej odpowiedzi. |
| afterUserId | string | query | No | Tiebreaker kursora: przekaż nextAfterUserId z poprzedniej odpowiedzi. Wymagane, gdy ustawiono afterName, aby nie pomijało wpisów przy remisie nazw. |
Odpowiedź
Returns: PageUsersOnlineResponse
Przykład

getPageByURLId 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Response
Zwraca: GetPageByURLIdAPIResponse
Example

getPages 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetPagesAPIResponse
Przykład

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 | Niewidoczny wskaźnik stronicowania zwrócony jako nextCursor z poprzedniego żądania. Powiązany z tym samym sortBy. |
| limit | integer | query | No | 1..200, domyślnie 50 |
| q | string | query | No | Opcjonalny filtr prefiksu tytułu, nie rozróżniający wielkości liter. |
| sortBy | string | query | No | Kolejność sortowania. updatedAt (domyślnie, najnowsze najpierw), commentCount (najwięcej komentarzy najpierw) lub title (alfabetycznie). |
| hasComments | boolean | query | No | Jeśli true, zwróć tylko strony z co najmniej jednym komentarzem. |
Response
Returns: GetPublicPagesResponse
Example

getUsersInfo 
Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds oddzielone przecinkami. |
Response
Zwraca: PageUsersInfoResponse
Przykład

patchPage 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: PatchPageAPIResponse
Przykład

deletePendingWebhookEvent 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getPendingWebhookEventCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: GetPendingWebhookEventCountResponse
Przykład

getPendingWebhookEvents 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: GetPendingWebhookEventsResponse
Przykład

createQuestionConfig 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Response
Zwraca: CreateQuestionConfigResponse
Przykład

deleteQuestionConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getQuestionConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionConfigResponse
Przykład

getQuestionConfigs 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetQuestionConfigsResponse
Przykład

updateQuestionConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

createQuestionResult 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Returns: CreateQuestionResultResponse
Przykład

deleteQuestionResult 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getQuestionResult 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionResultResponse
Przykład

getQuestionResults 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Odpowiedź
Zwraca: GetQuestionResultsResponse
Przykład

updateQuestionResult 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Zwraca: APIEmptyResponse
Example

aggregateQuestionResults 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| 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 |
Response
Zwraca: AggregateQuestionResultsResponse
Przykład

bulkAggregateQuestionResults 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| forceRecalculate | boolean | query | No |
Odpowiedź
Zwraca: BulkAggregateQuestionResultsResponse
Przykład

combineCommentsWithQuestionResults 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| questionId | string | query | Nie | |
| questionIds | array | query | Nie | |
| urlId | string | query | Nie | |
| startDate | string | query | Nie | |
| forceRecalculate | boolean | query | Nie | |
| minValue | number | query | Nie | |
| maxValue | number | query | Nie | |
| limit | number | query | Nie |
Odpowiedź
Returns: CombineQuestionResultsWithCommentsResponse
Przykład

addSSOUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: AddSSOUserAPIResponse
Przykład

deleteSSOUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | boolean | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: DeleteSSOUserAPIResponse
Przykład

getSSOUserByEmail 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| string | path | Tak |
Odpowiedź
Zwraca: GetSSOUserByEmailAPIResponse
Przykład

getSSOUserById 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: GetSSOUserByIdAPIResponse
Przykład

getSSOUsers 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | integer | query | Nie |
Odpowiedź
Zwraca: GetSSOUsersResponse
Przykład

patchSSOUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Odpowiedź
Zwraca: PatchSSOUserAPIResponse
Przykład

putSSOUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PutSSOUserAPIResponse
Przykład

createSubscription 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Returns: CreateSubscriptionAPIResponse
Przykład

deleteSubscription 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: DeleteSubscriptionAPIResponse
Przykład

getSubscriptions 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No |
Odpowiedź
Zwraca: GetSubscriptionsAPIResponse
Przykład

updateSubscription 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: UpdateSubscriptionAPIResponse
Przykład

getTenantDailyUsages 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| yearNumber | number | query | Nie | |
| monthNumber | number | query | Nie | |
| dayNumber | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantDailyUsagesResponse
Przykład

createTenantPackage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantPackageResponse
Przykład

deleteTenantPackage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getTenantPackage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: GetTenantPackageResponse
Przykład

getTenantPackages 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantPackagesResponse
Przykład

replaceTenantPackage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

updateTenantPackage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

createTenantUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantUserResponse
Przykład

deleteTenantUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | string | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

getTenantUser 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Response
Returns: GetTenantUserResponse
Example

getTenantUsers 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantUsersResponse
Przykład

replaceTenantUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

sendLoginLink 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| redirectURL | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

updateTenantUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

createTenant 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Returns: CreateTenantResponse
Przykład

deleteTenant 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sure | string | query | Nie |
Odpowiedź
Returns: APIEmptyResponse
Przykład

getTenant 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: GetTenantResponse
Przykład

getTenants 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| meta | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantsResponse
Przykład

updateTenant 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIEmptyResponse
Przykład

changeTicketState 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: ChangeTicketStateResponse
Przykład

createTicket 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes |
Odpowiedź
Zwraca: CreateTicketResponse
Przykład

getTicket 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Response
Zwraca: GetTicketResponse
Example

getTickets 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Odpowiedź
Zwraca: GetTicketsResponse
Przykład

getTranslations 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Odpowiedź
Zwraca: GetTranslationsResponse
Przykład

uploadImage 
Prześlij i zmień rozmiar obrazu
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Predefiniowany rozmiar: "Default" (1000x1000px) lub "CrossPlatform" (tworzy rozmiary dla popularnych urządzeń) |
| urlId | string | query | No | Identyfikator strony, z której odbywa się przesyłanie, do konfiguracji |
Odpowiedź
Zwraca: UploadImageResponse
Przykład

getUserBadgeProgressById 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeProgressResponse
Przykład

getUserBadgeProgressByUserId 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | path | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeProgressResponse
Przykład

getUserBadgeProgressList 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: APIGetUserBadgeProgressListResponse
Przykład

createUserBadge 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: APICreateUserBadgeResponse
Przykład

deleteUserBadge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptySuccessResponse
Przykład

getUserBadge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: APIGetUserBadgeResponse
Przykład

getUserBadges 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| badgeId | string | query | Nie | |
| type | number | query | Nie | |
| displayedOnComments | boolean | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: APIGetUserBadgesResponse
Przykład

updateUserBadge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: APIEmptySuccessResponse
Przykład

getUserNotificationCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserNotificationCountResponse
Przykład

getUserNotifications 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Używany do określenia, czy bieżąca strona jest subskrybowana. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: GetMyNotificationsResponse
Przykład

resetUserNotificationCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: ResetUserNotificationsResponse
Przykład

resetUserNotifications 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: ResetUserNotificationsResponse
Przykład

updateUserNotificationCommentSubscriptionStatus 
Enable or disable notifications for a specific comment.
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Odpowiedź
Returns: UpdateUserNotificationCommentSubscriptionStatusResponse
Przykład

updateUserNotificationPageSubscriptionStatus 
Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: UpdateUserNotificationPageSubscriptionStatusResponse
Przykład

updateUserNotificationStatus 
Parametry
| Nazwa | Typ | Miejsce | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| newStatus | string | path | Yes | |
| sso | string | query | No |
Odpowiedź
Zwraca: UpdateUserNotificationStatusResponse
Przykład

getUserPresenceStatuses 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlIdWS | string | query | Tak | |
| userIds | string | query | Tak |
Odpowiedź
Zwraca: GetUserPresenceStatusesResponse
Przykład

searchUsers 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Odpowiedź
Zwraca: SearchUsersResult
Przykład

getUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: GetUserResponse
Przykład

createVote 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Odpowiedź
Zwraca: VoteResponse
Przykład

deleteVote 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| editKey | string | query | Nie |
Odpowiedź
Zwraca: VoteDeleteResponse
Przykład

getVotes 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetVotesResponse
Przykład

getVotesForUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: GetVotesForUserResponse
Przykład

Potrzebujesz pomocy?
Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące SDK dla PHP, prosimy:
Współtworzenie
Wkłady są mile widziane! Prosimy odwiedzić repozytorium na GitHubie w celu zapoznania się z wytycznymi dotyczącymi kontrybucji.