
Мова 🇺🇦 Українська
Початок роботи
Довідник API
Документація
Аутентифікація
Агрегування
Журнали аудиту
Блокування через коментар
Перевірка заблокованих коментарів
Коментарі
Коментарі користувача
Конфігурації домену
Шаблони електронної пошти
Журнал подій
Пости стрічки
Поскаржитися на коментар
GIF
Хештеги
Модерація
Модератори
Кількість сповіщень
Сповіщення
Реакції сторінки
Сторінки
Очікувані події вебхука
Налаштування питань
Результати питань
Агрегація результатів питань
Користувачі SSO
Підписки
Щоденне використання орендаря
Пакети орендаря
Користувачі орендаря
Орендарі
Тікети
Переклади
Завантажити зображення
Прогрес бейджів користувача
Бейджі користувача
Сповіщення користувача
Статуси присутності користувача
Пошук користувачів
Користувачі
Голосування
FastComments SDK для PHP
Це офіційний PHP SDK для FastComments.
Офіційний PHP SDK для API FastComments
Репозиторій
Installation & Usage 
Вимоги
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
Щоб встановити bindings за допомогою Composer, додайте наступне до composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php:
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');
Getting Started 
Будь ласка, дотримуйтесь процедури встановлення, а потім виконайте наступне:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Налаштуйте авторизацію ключем API: api_key
// Розкоментуйте нижче, щоб встановити префікс (наприклад, Bearer) для ключа API, якщо потрібно
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
// Якщо ви хочете використовувати власний http-клієнт, передайте свій клієнт, який реалізує `GuzzleHttp\ClientInterface`.
// Це необов'язково, за замовчуванням буде використано `GuzzleHttp\Client`.
new GuzzleHttp\Client(),
$config
);
$tenant_id = 'tenant_id_example'; // рядок
$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;
}
API Clients 
The SDK надає три класи клієнтів API:
DefaultApi- методи, автентифіковані за допомогою API-ключа, для використання на сервері. Налаштуйте API-ключ, як показано у розділі Getting Started.PublicApi- публічні методи, які не вимагають API-ключа, безпечні для виклику з браузерів та мобільних додатків.ModerationApi- широким набором живих та швидких API модерації. Кожен методModerationApiприймає параметр$ssoі може автентифікуватися через SSO або cookie сесії FastComments.com.
Використання PublicApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Public methods do not require an API key.
$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;
}
Використання ModerationApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
new GuzzleHttp\Client()
);
$sso = 'sso_example'; // string - SSO payload authenticating the moderator
try {
$result = $apiInstance->getCount([
'sso' => $sso,
]);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}
API Methods 
Усі URI відносні до https://fastcomments.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/set-trust-factor | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | |
| PublicApi | getEventLog | GET /event-log/{tenantId} | |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | getUsersInfo | GET /pages/{tenantId}/users/info | |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Models 
- 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
Authorization 
Схеми автентифікації, визначені для API:
api_key
- Тип: Ключ API
- Назва параметра ключа API: x-api-key
- Розташування: заголовок HTTP
aggregate 
Агрегує документи, групуючи їх (якщо вказано groupBy) та застосовуючи кілька операцій. Підтримуються різні операції (наприклад, sum, countDistinct, avg тощо).
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| parentTenantId | string | query | Ні | |
| includeStats | boolean | query | Ні |
Відповідь
Повертає: AggregateResponse
Приклад

getAuditLogs 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Відповідь
Повертає: GetAuditLogsResponse
Приклад

logoutPublic 
Відповідь
Повертає: APIEmptyResponse
Приклад

blockFromCommentPublic 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: BlockSuccess
Приклад

unBlockCommentPublic 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: UnblockSuccess
Приклад

checkedCommentsForBlocked 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | Список ідентифікаторів коментарів, розділений комами. |
| sso | string | query | No |
Response
Returns: CheckBlockedCommentsResponse
Example

blockUserFromComment 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Відповідь
Повертає: BlockSuccess
Приклад

createCommentPublic 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: SaveCommentsResponseWithPresence
Приклад

deleteComment 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Відповідь
Повертає: DeleteCommentResult
Приклад

deleteCommentPublic 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: PublicAPIDeleteCommentResponse
Приклад

deleteCommentVote 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| voteId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: VoteDeleteResponse
Приклад

flagComment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: FlagCommentResponse
Приклад

getComment 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIGetCommentResponse
Приклад

getComments 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Відповідь
Повертає: APIGetCommentsResponse
Приклад

getCommentsPublic 
req tenantId urlId
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| page | integer | query | Ні | |
| direction | string | query | Ні | |
| sso | string | query | Ні | |
| skip | integer | query | Ні | |
| skipChildren | integer | query | Ні | |
| limit | integer | query | Ні | |
| limitChildren | integer | query | Ні | |
| countChildren | boolean | query | Ні | |
| fetchPageForCommentId | string | query | Ні | |
| includeConfig | boolean | query | Ні | |
| countAll | boolean | query | Ні | |
| includei10n | boolean | query | Ні | |
| locale | string | query | Ні | |
| modules | string | query | Ні | |
| isCrawler | boolean | query | Ні | |
| includeNotificationCount | boolean | query | Ні | |
| asTree | boolean | query | Ні | |
| maxTreeDepth | integer | query | Ні | |
| useFullTranslationIds | boolean | query | Ні | |
| parentId | string | query | Ні | |
| searchText | string | query | Ні | |
| hashTags | array | query | Ні | |
| userId | string | query | Ні | |
| customConfigStr | string | query | Ні | |
| afterCommentId | string | query | Ні | |
| beforeCommentId | string | query | Ні |
Відповідь
Повертає: GetCommentsResponseWithPresencePublicComment
Приклад

getCommentText 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Відповідь
Returns: PublicAPIGetCommentTextResponse
Приклад

getCommentVoteUserNames 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: GetCommentVoteUserNamesSuccessResponse
Приклад

lockComment 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

pinComment 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ChangeCommentPinStatusResponse
Приклад

saveComment 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| sendEmails | boolean | query | Ні | |
| populateNotifications | boolean | query | Ні |
Відповідь
Повертає: APISaveCommentResponse
Приклад

saveCommentsBulk 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Відповідь
Повертає: SaveCommentsBulkResponse
Приклад

setCommentText 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: PublicAPISetCommentTextResponse
Приклад

unBlockUserFromComment 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Відповідь
Returns: UnblockSuccess
Приклад

unFlagComment 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: FlagCommentResponse
Приклад

unLockComment 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

unPinComment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: ChangeCommentPinStatusResponse
Приклад

updateComment 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

voteComment 
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Response
Returns: VoteResponse
Example

getCommentsForUser 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Returns: GetCommentsForUserResponse
Приклад

addDomainConfig 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: AddDomainConfigResponse
Приклад

deleteDomainConfig 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Відповідь
Повертає: DeleteDomainConfigResponse
Приклад

getDomainConfig 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Відповідь
Повертає: GetDomainConfigResponse
Приклад

getDomainConfigs 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetDomainConfigsResponse
Приклад

patchDomainConfig 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domainToUpdate | string | path | Так |
Відповідь
Повертає: PatchDomainConfigResponse
Приклад

putDomainConfig 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Відповідь
Повертає: PutDomainConfigResponse
Приклад

createEmailTemplate 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateEmailTemplateResponse
Приклад

deleteEmailTemplate 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

deleteEmailTemplateRenderError 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

getEmailTemplate 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: GetEmailTemplateResponse
Приклад

getEmailTemplateDefinitions 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetEmailTemplateDefinitionsResponse
Приклад

getEmailTemplateRenderErrors 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetEmailTemplateRenderErrorsResponse
Приклад

getEmailTemplates 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Відповідь
Повертає: GetEmailTemplatesResponse
Приклад

renderEmailTemplate 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| locale | string | query | Ні |
Відповідь
Повертає: RenderEmailTemplateResponse
Приклад

updateEmailTemplate 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Повертає: APIEmptyResponse
Example

getEventLog 
req tenantId urlId userIdWS
Параметри
| Назва | Тип | Location | Required | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Ні |
Відповідь
Повертає: GetEventLogResponse
Приклад

getGlobalEventLog 
запит tenantId urlId userIdWS
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Ні |
Відповідь
Повертає: GetEventLogResponse
Приклад

createFeedPost 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| broadcastId | string | query | Ні | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| skipDupCheck | boolean | query | Ні |
Відповідь
Повертає: CreateFeedPostsResponse
Приклад

createFeedPostPublic 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Returns: CreateFeedPostResponse
Приклад

deleteFeedPostPublic 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: DeleteFeedPostPublicResponse
Приклад

getFeedPosts 
req tenantId afterId
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Відповідь
Повертає: GetFeedPostsResponse
Приклад

getFeedPostsPublic 
req tenantId afterId
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні | |
| sso | string | query | Ні | |
| isCrawler | boolean | query | Ні | |
| includeUserInfo | boolean | query | Ні |
Відповідь
Повертає: PublicFeedPostsResponse
Приклад

getFeedPostsStats 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postIds | array | query | Так | |
| sso | string | query | Ні |
Response
Повертає: FeedPostsStatsResponse
Example

getUserReactsPublic 
Параметри
| Ім’я | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postIds | array | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: UserReactsResponse
Приклад

reactFeedPostPublic 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ReactFeedPostResponse
Приклад

updateFeedPost 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

updateFeedPostPublic 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: CreateFeedPostResponse
Приклад

flagCommentPublic 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

getGifLarge 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| largeInternalURLSanitized | string | query | Так |
Відповідь
Повертає: GifGetLargeResponse
Приклад

getGifsSearch 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| search | string | query | Так | |
| locale | string | query | Ні | |
| rating | string | query | Ні | |
| page | number | query | Ні |
Відповідь
Повертає: GetGifsSearchResponse
Приклад

getGifsTrending 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Відповідь
Повертає: GetGifsTrendingResponse
Приклад

addHashTag 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateHashTagResponse
Приклад

addHashTagsBulk 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: BulkCreateHashTagsResponse
Приклад

deleteHashTag 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

getHashTags 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No |
Відповідь
Повертає: GetHashTagsResponse
Приклад

patchHashTag 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| tag | string | path | Так |
Відповідь
Повертає: UpdateHashTagResponse
Приклад

deleteModerationVote 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: VoteDeleteResponse
Приклад

getApiComments 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationAPIGetCommentsResponse
Приклад

getApiExportStatus 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| batchJobId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationExportStatusResponse
Приклад

getApiIds 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationAPIGetCommentIdsResponse
Приклад

getBanUsersFromComment 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetBannedUsersFromCommentResponse
Приклад

getCommentBanStatus 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: GetCommentBanStatusResponse
Приклад

getCommentChildren 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Повертає: ModerationAPIChildCommentsResponse
Example

getCount 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Повертає: ModerationAPICountCommentsResponse
Приклад

getCounts 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Returns: GetBannedUsersCountResponse
Приклад

getLogs 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationAPIGetLogsResponse
Приклад

getManualBadges 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Повертає: GetTenantManualBadgesResponse
Example

getManualBadgesForUser 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: GetUserManualBadgesResponse
Приклад

getModerationComment 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| includeEmail | boolean | query | Ні | |
| includeIP | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationAPICommentResponse
Приклад

getModerationCommentText 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetCommentTextResponse
Приклад

getPreBanSummary 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: PreBanSummary
Приклад

getSearchCommentsSummary 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| filters | string | query | Ні | |
| searchFilters | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationCommentSearchResponse
Приклад

getSearchPages 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationPageSearchResponse
Приклад

getSearchSites 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationSiteSearchResponse
Приклад

getSearchSuggest 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationSuggestResponse
Приклад

getSearchUsers 
Parameters
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| sso | string | query | Ні |
Response
Повертає: ModerationUserSearchResponse
Example

getTrustFactor 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| sso | string | query | Ні |
Response
Повертає: GetUserTrustFactorResponse
Приклад

getUserBanPreference 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIModerateGetUserBanPreferencesResponse
Приклад

getUserInternalProfile 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserInternalProfileResponse
Приклад

postAdjustCommentVotes 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: AdjustVotesResponse
Приклад

postApiExport 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Повертає: ModerationExportResponse
Приклад

postBanUserFromComment 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| banEmail | boolean | query | Ні | |
| banEmailDomain | boolean | query | Ні | |
| banIP | boolean | query | Ні | |
| deleteAllUsersComments | boolean | query | Ні | |
| bannedUntil | string | query | Ні | |
| isShadowBan | boolean | query | Ні | |
| updateId | string | query | Ні | |
| banReason | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: BanUserFromCommentResult
Приклад

postBanUserUndo 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

postBulkPreBanSummary 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| includeByUserIdAndEmail | boolean | query | Ні | |
| includeByIP | boolean | query | Ні | |
| includeByEmailDomain | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: BulkPreBanSummary
Приклад

postCommentsByIds 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationAPIChildCommentsResponse
Приклад

postFlagComment 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

postRemoveComment 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: PostRemoveCommentApiResponse
Приклад

postRestoreDeletedComment 
Параметри
| Назва | Тип | Місце | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Returns: APIEmptyResponse
Приклад

postSetCommentApprovalStatus 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| approved | boolean | query | Ні | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: SetCommentApprovedResponse
Приклад

postSetCommentReviewStatus 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

postSetCommentSpamStatus 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

postSetCommentText 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: SetCommentTextResponse
Приклад

postUnFlagComment 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

postVote 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Returns: VoteResponse
Приклад

putAwardBadge 
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Повертає: AwardUserBadgeResponse
Приклад

putCloseThread 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

putRemoveBadge 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| badgeId | string | query | Так | |
| userId | string | query | Ні | |
| commentId | string | query | Ні | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: RemoveUserBadgeResponse
Приклад

putReopenThread 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

setTrustFactor 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| trustFactor | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: SetUserTrustFactorResponse
Приклад

createModerator 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateModeratorResponse
Приклад

deleteModerator 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| sendEmail | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

getModerator 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetModeratorResponse
Приклад

getModerators 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Відповідь
Повертає: GetModeratorsResponse
Приклад

sendInvite 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| fromName | string | query | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

updateModerator 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

deleteNotificationCount 
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Response
Повертає: APIEmptyResponse
Приклад

getCachedNotificationCount 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: GetCachedNotificationCountResponse
Приклад

getNotificationCount 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| urlId | string | query | Ні | |
| fromCommentId | string | query | Ні | |
| viewed | boolean | query | Ні | |
| type | string | query | Ні |
Відповідь
Повертає: GetNotificationCountResponse
Приклад

getNotifications 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Повертає: GetNotificationsResponse
Приклад

updateNotification 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

createV1PageReact 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No |
Відповідь
Повертає: CreateV1PageReact
Приклад

createV2PageReact 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No |
Відповідь
Повертає: CreateV1PageReact
Приклад

deleteV1PageReact 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Відповідь
Повертає: CreateV1PageReact
Приклад

deleteV2PageReact 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| id | string | query | Так |
Відповідь
Повертає: CreateV1PageReact
Приклад

getV1PageLikes 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Відповідь
Повертає: GetV1PageLikes
Приклад

getV2PageReacts 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: GetV2PageReacts
Приклад

getV2PageReactUsers 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Відповідь
Повертає: GetV2PageReactUsersResponse
Приклад

addPage 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: AddPageAPIResponse
Приклад

deletePage 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: DeletePageAPIResponse
Приклад

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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Ідентифікатор URL сторінки (очищений на сервері). |
| afterName | string | query | No | Курсор: передайте nextAfterName з попередньої відповіді. |
| afterUserId | string | query | No | Тібрейкер курсора: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли afterName встановлено, щоб уникнути втрати записів через однакові імена. |
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).
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Ідентифікатор URL сторінки (очищений на сервері). |
| afterName | string | query | No | Курсор: передайте nextAfterName з попередньої відповіді. |
| afterUserId | string | query | No | Тай-брейкер курсора: передайте nextAfterUserId з попередньої відповіді. Обов’язково, коли afterName встановлено, щоб уникнути пропуску записів у випадку однакових імен. |
Response
Повертає: PageUsersOnlineResponse
Example

getPageByURLId 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Відповідь
Повертає: GetPageByURLIdAPIResponse
Приклад

getPages 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: GetPagesAPIResponse
Приклад

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Ukrainian: Перелічити сторінки для орендаря. Використовується настільним клієнтом FChat для заповнення списку кімнат.
Requires enableFChat to be true on the resolved custom config for each page.
Ukrainian: Потрібно, щоб enableFChat було true у розв'язаній користувацькій конфігурації для кожної сторінки.
Pages that require SSO are filtered against the requesting user's group access.
Ukrainian: Сторінки, що вимагають SSO, фільтруються згідно з груповим доступом запитуючого користувача.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Непрозорий курсор пагінації, повернений як nextCursor з попереднього запиту. Пов'язаний з тим же sortBy. |
| limit | integer | query | No | 1..200, за замовчуванням 50 |
| q | string | query | No | Необов'язковий нечутливий до регістру фільтр префікса назви. |
| sortBy | string | query | No | Порядок сортування. updatedAt (за замовчуванням, спочатку найновіші), commentCount (спочатку з найбільшою кількістю коментарів) або title (за алфавітом). |
| hasComments | boolean | query | No | Якщо true, повернути лише сторінки, що мають хоча б один коментар. |
Response
Повертає: 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).
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| ids | string | query | Так | Кома‑розділені userIds. |
Відповідь
Returns: PageUsersInfoResponse
Приклад

patchPage 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: PatchPageAPIResponse
Приклад

deletePendingWebhookEvent 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

getPendingWebhookEventCount 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| 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 |
Відповідь
Повертає: GetPendingWebhookEventCountResponse
Приклад

getPendingWebhookEvents 
Parameters
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні | |
| skip | number | query | Ні |
Response
Returns: GetPendingWebhookEventsResponse
Приклад

createQuestionConfig 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateQuestionConfigResponse
Приклад

deleteQuestionConfig 
Параметри
| Ім'я | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

getQuestionConfig 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: GetQuestionConfigResponse
Приклад

getQuestionConfigs 
Параметри
| Ім'я | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Відповідь
Повертає: GetQuestionConfigsResponse
Приклад

updateQuestionConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Response
Returns: APIEmptyResponse
Example

createQuestionResult 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Returns: CreateQuestionResultResponse
Приклад

deleteQuestionResult 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

getQuestionResult 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetQuestionResultResponse
Приклад

getQuestionResults 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Ні | |
| userId | string | query | Ні | |
| startDate | string | query | Ні | |
| questionId | string | query | Ні | |
| questionIds | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetQuestionResultsResponse
Приклад

updateQuestionResult 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

aggregateQuestionResults 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| questionId | string | query | Ні | |
| questionIds | array | query | Ні | |
| urlId | string | query | Ні | |
| timeBucket | string | query | Ні | |
| startDate | string | query | Ні | |
| forceRecalculate | boolean | query | Ні |
Відповідь
Повертає: AggregateQuestionResultsResponse
Приклад

bulkAggregateQuestionResults 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| forceRecalculate | boolean | query | No |
Відповідь
Повертає: BulkAggregateQuestionResultsResponse
Приклад

combineCommentsWithQuestionResults 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Відповідь
Повертає: CombineQuestionResultsWithCommentsResponse
Приклад

addSSOUser 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: AddSSOUserAPIResponse
Приклад

deleteSSOUser 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| deleteComments | boolean | query | Ні | |
| commentDeleteMode | string | query | Ні |
Відповідь
Returns: DeleteSSOUserAPIResponse
Приклад

getSSOUserByEmail 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
Відповідь
Повертає: GetSSOUserByEmailAPIResponse
Приклад

getSSOUserById 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetSSOUserByIdAPIResponse
Приклад

getSSOUsers 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | integer | query | Ні |
Відповідь
Повертає: GetSSOUsersResponse
Приклад

patchSSOUser 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Response
Returns: PatchSSOUserAPIResponse
Example

putSSOUser 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Відповідь
Повертає: PutSSOUserAPIResponse
Приклад

createSubscription 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateSubscriptionAPIResponse
Приклад

deleteSubscription 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Відповідь
Returns: DeleteSubscriptionAPIResponse
Приклад

getSubscriptions 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No |
Відповідь
Повертає: GetSubscriptionsAPIResponse
Приклад

updateSubscription 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Відповідь
Повертає: UpdateSubscriptionAPIResponse
Приклад

getTenantDailyUsages 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| yearNumber | number | query | Ні | |
| monthNumber | number | query | Ні | |
| dayNumber | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantDailyUsagesResponse
Приклад

createTenantPackage 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateTenantPackageResponse
Приклад

deleteTenantPackage 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

getTenantPackage 
Параметри
| Назва | Тип | Розташування | Обовʼязковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantPackageResponse
Приклад

getTenantPackages 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantPackagesResponse
Приклад

replaceTenantPackage 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

updateTenantPackage 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

createTenantUser 
Параметри
| Name | Type | Location | Required | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateTenantUserResponse
Приклад

deleteTenantUser 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Відповідь
Returns: APIEmptyResponse
Приклад

getTenantUser 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantUserResponse
Приклад

getTenantUsers 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantUsersResponse
Приклад

replaceTenantUser 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

sendLoginLink 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| redirectURL | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

updateTenantUser 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

createTenant 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateTenantResponse
Приклад

deleteTenant 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sure | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

getTenant 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantResponse
Приклад

getTenants 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Відповідь
Повертає: GetTenantsResponse
Приклад

updateTenant 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

changeTicketState 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: ChangeTicketStateResponse
Приклад

createTicket 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Так |
Відповідь
Повертає: CreateTicketResponse
Приклад

getTicket 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Відповідь
Повертає: GetTicketResponse
Приклад

getTickets 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| state | number | query | Ні | |
| skip | number | query | Ні | |
| limit | number | query | Ні |
Відповідь
Повертає: GetTicketsResponse
Приклад

getTranslations 
Параметри
| Ім'я | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| namespace | string | path | Так | |
| component | string | path | Так | |
| locale | string | query | Ні | |
| useFullTranslationIds | boolean | query | Ні |
Відповідь
Повертає: GetTranslationsResponse
Приклад

uploadImage 
Upload and resize an image
Parameters
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| sizePreset | string | query | Ні | Попередньо визначений розмір: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв) |
| urlId | string | query | Ні | Ідентифікатор сторінки, з якої виконується завантаження, для налаштування |
Response
Returns: UploadImageResponse
Example

getUserBadgeProgressById 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIGetUserBadgeProgressResponse
Приклад

getUserBadgeProgressByUserId 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | path | Yes |
Відповідь
Повертає: APIGetUserBadgeProgressResponse
Приклад

getUserBadgeProgressList 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| limit | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: APIGetUserBadgeProgressListResponse
Приклад

createUserBadge 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: APICreateUserBadgeResponse
Приклад

deleteUserBadge 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptySuccessResponse
Приклад

getUserBadge 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIGetUserBadgeResponse
Приклад

getUserBadges 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| badgeId | string | query | Ні | |
| type | number | query | Ні | |
| displayedOnComments | boolean | query | Ні | |
| limit | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: APIGetUserBadgesResponse
Приклад

updateUserBadge 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptySuccessResponse
Приклад

getUserNotificationCount 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserNotificationCountResponse
Приклад

getUserNotifications 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| 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 | |
| urlId | string | query | No | Використовується для визначення, чи підписана поточна сторінка. |
Відповідь
Повертає: GetMyNotificationsResponse
Приклад

resetUserNotificationCount 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ResetUserNotificationsResponse
Приклад

resetUserNotifications 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ResetUserNotificationsResponse
Приклад

updateUserNotificationCommentSubscriptionStatus 
Увімкнути або вимкнути сповіщення для конкретного коментаря.
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: UpdateUserNotificationCommentSubscriptionStatusResponse
Приклад

updateUserNotificationPageSubscriptionStatus 
Enable або disable сповіщення для сторінки. Коли користувачі підписані на сторінку, сповіщення створюються для нових кореневих коментарів, а також
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: UpdateUserNotificationPageSubscriptionStatusResponse
Приклад

updateUserNotificationStatus 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| newStatus | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: UpdateUserNotificationStatusResponse
Приклад

getUserPresenceStatuses 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlIdWS | string | query | Так | |
| userIds | string | query | Так |
Відповідь
Повертає: GetUserPresenceStatusesResponse
Приклад

searchUsers 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| usernameStartsWith | string | query | Ні | |
| mentionGroupIds | array | query | Ні | |
| sso | string | query | Ні | |
| searchSection | string | query | Ні |
Відповідь
Повертає: SearchUsersResult
Приклад

getUser 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetUserResponse
Приклад

createVote 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Так | |
| direction | string | query | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: VoteResponse
Приклад

deleteVote 
Parameters
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| editKey | string | query | Ні |
Response
Повертає: VoteDeleteResponse
Example

getVotes 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Відповідь
Повертає: GetVotesResponse
Приклад

getVotesForUser 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Відповідь
Повертає: GetVotesForUserResponse
Приклад

Потрібна допомога?
Якщо ви зіткнулися з будь-якими проблемами або маєте питання щодо PHP SDK, будь ласка:
Внесок
Внески вітаються! Будь ласка, відвідайте репозиторій на GitHub для інструкцій щодо внесків.