
Език 🇧🇬 Български
Документация
Първи стъпки
Референция на API
Употреба
Агрегация
Одитни журнали
Блокиране от коментар
Проверка на блокирани коментари
Коментари
Конфигурации на домейни
Шаблони за имейли
Журнал на събитията
Фийд публикации
Сигнализиране на коментар
Хаштагове
Модератори
Брой известия
Известия
Страници
Чакащи webhook събития
Конфигурации на въпроси
Резултати от въпроси
Агрегация на резултатите от въпроси
SSO потребители
Абонаменти
Дневна употреба на наемателя
Пакети на наемателя
Потребители на наемателя
Наематели
Качване на изображение
Напредък на потребителските значки
Потребителски значки
Потребителски известия
Статуси на присъствие на потребителя
Търсене на потребители
Потребители
Гласове
FastComments C++ SDK
Това е официалното C++ SDK за FastComments.
Официално C++ SDK за FastComments API
Репозитория
Изисквания 
- C++17 или по-нова версия
- CMake 3.14 или по-нова версия
- OpenSSL
- C++ REST SDK (cpprestsdk)
- Boost
- Google Test (автоматично се изтегля за тестване)
Инсталиране 
Инсталиране на зависимости
sudo apt install libcpprest-dev libboost-all-dev
Изграждане от изходния код
mkdir build
cd build
cmake ..
make
Инсталиране
sudo make install
Съдържание на библиотеката
Тази библиотека съдържа генерирания API клиент и SSO инструментите, за да улесни работата с API-то.
Публични срещу защитени API
За API клиента има два класа, DefaultAPI и PublicAPI. Класът DefaultAPI съдържа методи, които изискват вашия API ключ, а PublicAPI съдържа извиквания на API
които могат да се извършат директно от браузър/мобилно устройство/и т.н. без удостоверяване.
Бърз старт 
Използване на удостоверени API-та (DefaultAPI)
Важно:
- Трябва да зададете базовия URL (cpp-restsdk генераторът не го чете от OpenAPI спецификацията)
- Трябва да зададете вашия API ключ на ApiClient преди да правите удостоверени заявки. Ако не го направите, заявките ще върнат грешка 401.
#include <iostream>
#include "FastCommentsClient/api/DefaultApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// ЗАДЪЛЖИТЕЛНО: Задайте базовия URL (изберете вашия регион)
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com")); // US
// OR: config->setBaseUrl(utility::conversions::to_string_t("https://eu.fastcomments.com")); // EU
// ЗАДЪЛЖИТЕЛНО: Задайте вашия API ключ
config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_API_KEY_HERE"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// Сега извършете удостоверени повиквания към API-то
return 0;
}
Използване на публични API-та (PublicAPI)
Публичните крайни точки не изискват удостоверяване:
#include <iostream>
#include "FastCommentsClient/api/PublicApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// ЗАДЪЛЖИТЕЛНО: Задайте базовия URL
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::PublicApi publicApi(apiClient);
// Извършете публични повиквания към API-то
return 0;
}
Общи проблеми
- "URI must contain a hostname" error: Уверете се, че извиквате
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"))преди да създадете ApiClient. cpp-restsdk генераторът не чете автоматично URL-а на сървъра от OpenAPI спецификацията. - 401 "missing-api-key" error: Уверете се, че извиквате
config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_KEY"))преди да създадете инстанция на DefaultAPI. - Wrong API class: Използвайте
DefaultAPIза удостоверени заявки от страна на сървъра,PublicAPIза клиентски/публични заявки.
Извършване на API повиквания: Синхронни и асинхронни 
Всички API методи в това SDK връщат pplx::task<std::shared_ptr<ResponseType>> от C++ REST SDK. Това ви дава гъвкавост в начина, по който обработвате отговорите от API-то.
Синхронни повиквания с .get()
Използвайте .get() за да блокирате извикващия нишка, докато заявката не завърши, и да получите резултата синхронно:
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
utility::conversions::to_string_t("YOUR_API_KEY"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// Извикайте .get() за да блокирате и да получите резултата синхронно
auto response = api.getComments(
utility::conversions::to_string_t("your-tenant-id"),
boost::none, // page
boost::none, // limit
boost::none, // skip
boost::none, // asTree
boost::none, // skipChildren
boost::none, // limitChildren
boost::none, // maxTreeDepth
utility::conversions::to_string_t("your-url-id"), // urlId
boost::none, // userId
boost::none, // anonUserId
boost::none, // contextUserId
boost::none, // hashTag
boost::none, // parentId
boost::none // direction
).get(); // Блокира, докато HTTP заявката не приключи
if (response && response->comments) {
std::cout << "Found " << response->comments->size() << " comments" << std::endl;
}
Асинхронни повиквания с .then()
Използвайте .then() за неблокиращо асинхронно изпълнение с callback-и:
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
utility::conversions::to_string_t("YOUR_API_KEY"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// Use .then() for asynchronous callback-based execution
api.getComments(
utility::conversions::to_string_t("your-tenant-id"),
boost::none, boost::none, boost::none, boost::none, boost::none,
boost::none, boost::none,
utility::conversions::to_string_t("your-url-id"),
boost::none, boost::none, boost::none, boost::none, boost::none, boost::none
).then([](std::shared_ptr<GetComments_200_response> response) {
// Това се изпълнява асинхронно, когато заявката завърши
if (response && response->comments) {
std::cout << "Found " << response->comments->size() << " comments" << std::endl;
}
});
// Изпълнението продължава веднага без блокиране
std::cout << "Request sent, continuing..." << std::endl;
Избор между синхронно и асинхронно
Изборът зависи от средата за изпълнение и архитектурата на приложението:
.get() (Синхронно блокиращо)
- Блокира извикващата нишка, докато HTTP заявката не завърши
- По-прост поток на кода, по-лесно за разбиране
- Подходящо за отделни работни нишки, пакетна обработка или командни инструменти
- Не е подходящо за цикли на събития, GUI нишки или еднонишкови сървъри
.then() (Асинхронно неблокиращо)
- Връща веднага, функцията за обратно извикване се изпълнява, когато заявката завърши
- Не блокира извикващата нишка
- Изисква се за архитектури, базирани на събития, GUI приложения или еднонишкови цикли на събития
- Позволява верижно изпълнение на множество операции
- По-сложен поток на управлението
Наборът от тестове на SDK използва изключително .get(), но това е подходящо за тестовата среда, където блокирането е приемливо.
Бележки 
Идентификатори на излъчване
Ще видите, че трябва да подадете broadcastId в някои API повиквания. Когато получавате събития, ще получите този идентификатор обратно, така че да знаете да игнорирате събитието, ако планирате да приложите промените оптимистично на клиента (което вероятно ще искате да направите, тъй като това осигурява най-доброто изживяване). Подайте UUID тук. Идентификаторът трябва да бъде достатъчно уникален, за да не се появи два пъти в една браузърна сесия.
SSO (Единно влизане)
За примери за SSO вижте по-долу.
Използване на SSO 
Просто SSO
#include <fastcomments/sso/fastcomments_sso.hpp>
#include <iostream>
using namespace fastcomments::sso;
int main() {
SimpleSSOUserData user("user-123", "user@example.com", "https://example.com/avatar.jpg");
FastCommentsSSO sso = FastCommentsSSO::newSimple(user);
std::string token = sso.createToken();
std::cout << "SSO Token: " << token << std::endl;
return 0;
}
Сигурно SSO
#include <fastcomments/sso/fastcomments_sso.hpp>
#include <iostream>
using namespace fastcomments::sso;
int main() {
SecureSSOUserData user("user-123", "user@example.com", "johndoe", "https://example.com/avatar.jpg");
std::string apiKey = "your-api-key";
FastCommentsSSO sso = FastCommentsSSO::newSecure(apiKey, user);
std::string token = sso.createToken();
std::cout << "Secure SSO Token: " << token << std::endl;
return 0;
}
Документация за FastComments 
Документация за API крайни точки
Всички URI са относителни към https://fastcomments.com
| Клас | Метод | HTTP заявка | Описание |
|---|---|---|---|
| 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 | Събира документи чрез групирането им (ако е предоставен groupBy) и прилагането на множество операции. Поддържат се различни операции (напр. sum, countDistinct, avg и др.). |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | 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 | 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 | req tenantId afterId |
| 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 | 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 | 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} | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | req tenantId urlId |
| PublicApi | getEventLog | GET /event-log/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | req tenantId afterId |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | Разрешаване или забраняване на известията за конкретен коментар. |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | Разрешаване или забраняване на известията за страница. Когато потребителите са абонирани за страница, се създават известия за нови коренови коментари, а също така |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | Качване и преоразмеряване на изображение |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Документация за модели
- APIAuditLog
- APIComment
- APICommentBase
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIPage
- APISSOUser
- APIStatus
- APITenant
- APITenantDailyUsage
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfig_200_response
- AddDomainConfig_200_response_anyOf
- AddHashTag_200_response
- AddHashTagsBulk_200_response
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AggregateQuestionResultsResponse
- AggregateQuestionResults_200_response
- AggregateTimeBucket
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequest_sort
- AggregationResponse
- AggregationResponse_stats
- AggregationValue
- BillingInfo
- BlockFromCommentParams
- BlockFromCommentPublic_200_response
- BlockSuccess
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkAggregateQuestionResults_200_response
- BulkCreateHashTagsBody
- BulkCreateHashTagsBody_tags_inner
- BulkCreateHashTagsResponse
- ChangeCommentPinStatusResponse
- CheckBlockedCommentsResponse
- CheckedCommentsForBlocked_200_response
- CombineCommentsWithQuestionResults_200_response
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateCommentPublic_200_response
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateEmailTemplate_200_response
- CreateFeedPostParams
- CreateFeedPostPublic_200_response
- CreateFeedPostResponse
- CreateFeedPost_200_response
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateModerator_200_response
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionConfig_200_response
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateQuestionResult_200_response
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantPackage_200_response
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTenantUser_200_response
- CreateTenant_200_response
- CreateUserBadgeParams
- CreateUserBadge_200_response
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentPublic_200_response
- DeleteCommentResult
- DeleteCommentVote_200_response
- DeleteComment_200_response
- DeleteDomainConfig_200_response
- DeleteFeedPostPublic_200_response
- DeleteFeedPostPublic_200_response_anyOf
- DeleteHashTag_request
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FComment_meta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentPublic_200_response
- FlagCommentResponse
- FlagComment_200_response
- GetAuditLogsResponse
- GetAuditLogs_200_response
- GetCachedNotificationCountResponse
- GetCachedNotificationCount_200_response
- GetCommentText_200_response
- GetCommentVoteUserNamesSuccessResponse
- GetCommentVoteUserNames_200_response
- GetComment_200_response
- GetCommentsPublic_200_response
- GetCommentsResponseWithPresence_PublicComment_
- GetCommentsResponse_PublicComment_
- GetComments_200_response
- GetDomainConfig_200_response
- GetDomainConfigs_200_response
- GetDomainConfigs_200_response_anyOf
- GetDomainConfigs_200_response_anyOf_1
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateDefinitions_200_response
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateRenderErrors_200_response
- GetEmailTemplateResponse
- GetEmailTemplate_200_response
- GetEmailTemplatesResponse
- GetEmailTemplates_200_response
- GetEventLogResponse
- GetEventLog_200_response
- GetFeedPostsPublic_200_response
- GetFeedPostsResponse
- GetFeedPostsStats_200_response
- GetFeedPosts_200_response
- GetHashTagsResponse
- GetHashTags_200_response
- GetModeratorResponse
- GetModerator_200_response
- GetModeratorsResponse
- GetModerators_200_response
- GetMyNotificationsResponse
- GetNotificationCountResponse
- GetNotificationCount_200_response
- GetNotificationsResponse
- GetNotifications_200_response
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEventCount_200_response
- GetPendingWebhookEventsResponse
- GetPendingWebhookEvents_200_response
- GetPublicFeedPostsResponse
- GetQuestionConfigResponse
- GetQuestionConfig_200_response
- GetQuestionConfigsResponse
- GetQuestionConfigs_200_response
- GetQuestionResultResponse
- GetQuestionResult_200_response
- GetQuestionResultsResponse
- GetQuestionResults_200_response
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsers_200_response
- GetSubscriptionsAPIResponse
- GetTenantDailyUsagesResponse
- GetTenantDailyUsages_200_response
- GetTenantPackageResponse
- GetTenantPackage_200_response
- GetTenantPackagesResponse
- GetTenantPackages_200_response
- GetTenantResponse
- GetTenantUserResponse
- GetTenantUser_200_response
- GetTenantUsersResponse
- GetTenantUsers_200_response
- GetTenant_200_response
- GetTenantsResponse
- GetTenants_200_response
- GetUserBadgeProgressById_200_response
- GetUserBadgeProgressList_200_response
- GetUserBadge_200_response
- GetUserBadges_200_response
- GetUserNotificationCountResponse
- GetUserNotificationCount_200_response
- GetUserNotifications_200_response
- GetUserPresenceStatusesResponse
- GetUserPresenceStatuses_200_response
- GetUserReactsPublic_200_response
- GetUserResponse
- GetUser_200_response
- GetVotesForUserResponse
- GetVotesForUser_200_response
- GetVotesResponse
- GetVotes_200_response
- GifRating
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedSiteType
- LiveEvent
- LiveEventType
- LiveEvent_extraInfo
- LockComment_200_response
- MediaAsset
- MetaItem
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PatchDomainConfigParams
- PatchHashTag_200_response
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PinComment_200_response
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- [PublicBlockFromCommentParams](https://github.com
aggregate 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| aggregationRequest | AggregationRequest | Да | |
| parentTenantId | string | Не | |
| includeStats | bool | Не |
Отговор
Връща: AggregationResponse
Пример

getAuditLogs 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| limit | double | Не | |
| skip | double | Не | |
| order | SORT_DIR | Не | |
| after | double | Не | |
| before | double | Не |
Отговор
Връща: GetAuditLogs_200_response
Пример

blockFromCommentPublic 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Да | |
| sso | string | Не |
Отговор
Връща: BlockFromCommentPublic_200_response
Пример

unBlockCommentPublic 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Да | |
| sso | string | Не |
Отговор
Връща: UnBlockCommentPublic_200_response
Пример

checkedCommentsForBlocked 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentIds | string | Да | |
| sso | string | Не |
Отговор
Връща: CheckedCommentsForBlocked_200_response
Пример

blockUserFromComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| blockFromCommentParams | BlockFromCommentParams | Да | |
| userId | string | Не | |
| anonUserId | string | Не |
Отговор
Връща: BlockFromCommentPublic_200_response
Пример

createCommentPublic 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| broadcastId | string | Да | |
| commentData | CommentData | Да | |
| sessionId | string | Не | |
| sso | string | Не |
Отговор
Връща: CreateCommentPublic_200_response
Пример

deleteComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| contextUserId | string | Не | |
| isLive | bool | Не |
Отговор
Връща: DeleteComment_200_response
Пример

deleteCommentPublic 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| broadcastId | string | Да | |
| editKey | string | Не | |
| sso | string | Не |
Отговор
Връща: DeleteCommentPublic_200_response
Пример

deleteCommentVote 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| voteId | string | Да | |
| urlId | string | Да | |
| broadcastId | string | Да | |
| editKey | string | Не | |
| sso | string | Не |
Отговор
Връща: DeleteCommentVote_200_response
Пример

flagComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| userId | string | Не | |
| anonUserId | string | Не |
Отговор
Връща: FlagComment_200_response
Пример

getComment 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Отговор
Връща: GetComment_200_response
Пример

getComments 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| page | int32_t | Не | |
| limit | int32_t | Не | |
| skip | int32_t | Не | |
| asTree | bool | Не | |
| skipChildren | int32_t | Не | |
| limitChildren | int32_t | Не | |
| maxTreeDepth | int32_t | Не | |
| urlId | string | Не | |
| userId | string | Не | |
| anonUserId | string | Не | |
| contextUserId | string | Не | |
| hashTag | string | Не | |
| parentId | string | Не | |
| direction | SortDirections | Не |
Отговор
Връща: GetComments_200_response
Пример

getCommentsPublic 
req tenantId urlId
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| page | int32_t | Не | |
| direction | SortDirections | Не | |
| sso | string | Не | |
| skip | int32_t | Не | |
| skipChildren | int32_t | Не | |
| limit | int32_t | Не | |
| limitChildren | int32_t | Не | |
| countChildren | bool | Не | |
| fetchPageForCommentId | string | Не | |
| includeConfig | bool | Не | |
| countAll | bool | Не | |
| includei10n | bool | Не | |
| locale | string | Не | |
| modules | string | Не | |
| isCrawler | bool | Не | |
| includeNotificationCount | bool | Не | |
| asTree | bool | Не | |
| maxTreeDepth | int32_t | Не | |
| useFullTranslationIds | bool | Не | |
| parentId | string | Не | |
| searchText | string | Не | |
| hashTags | vector<string | Не | |
| userId | string | Не | |
| customConfigStr | string | Не | |
| afterCommentId | string | Не | |
| beforeCommentId | string | Не |
Отговор
Връща: GetCommentsPublic_200_response
Пример

getCommentText 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| editKey | string | Не | |
| sso | string | Не |
Отговор
Връща: GetCommentText_200_response
Пример

getCommentVoteUserNames 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| dir | int32_t | Да | |
| sso | string | Не |
Отговор
Връща: GetCommentVoteUserNames_200_response
Пример

lockComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| broadcastId | string | Да | |
| sso | string | Не |
Отговор
Връща: LockComment_200_response
Пример

pinComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| broadcastId | string | Да | |
| sso | string | Не |
Отговор
Връща: PinComment_200_response
Пример

saveComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createCommentParams | CreateCommentParams | Да | |
| isLive | bool | Не | |
| doSpamCheck | bool | Не | |
| sendEmails | bool | Не | |
| populateNotifications | bool | Не |
Отговор
Връща: SaveComment_200_response
Пример

setCommentText 
Параметри
| Name | Type | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| broadcastId | string | Да | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Да | |
| editKey | string | Не | |
| sso | string | Не |
Отговор
Връща: SetCommentText_200_response
Пример

unBlockUserFromComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Да | |
| userId | string | Не | |
| anonUserId | string | Не |
Отговор
Връща: UnBlockCommentPublic_200_response
Пример

unFlagComment 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| userId | string | Не | |
| anonUserId | string | Не |
Отговор
Връща: FlagComment_200_response
Пример

unLockComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| broadcastId | string | Да | |
| sso | string | Не |
Отговор
Връща: LockComment_200_response
Пример

unPinComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| broadcastId | string | Да | |
| sso | string | Не |
Отговор
Връща: PinComment_200_response
Пример

updateComment 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updatableCommentParams | UpdatableCommentParams | Да | |
| contextUserId | string | Не | |
| doSpamCheck | bool | Не | |
| isLive | bool | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

voteComment 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| urlId | string | Да | |
| broadcastId | string | Да | |
| voteBodyParams | VoteBodyParams | Да | |
| sessionId | string | Не | |
| sso | string | Не |
Отговор
Връща: VoteComment_200_response
Пример

addDomainConfig 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| addDomainConfigParams | AddDomainConfigParams | Да |
Отговор
Връща: AddDomainConfig_200_response
Пример

deleteDomainConfig 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| domain | string | Да |
Отговор
Връща: DeleteDomainConfig_200_response
Пример

getDomainConfig 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| domain | string | Да |
Отговор
Връща: GetDomainConfig_200_response
Пример

getDomainConfigs 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да |
Отговор
Връща: GetDomainConfigs_200_response
Пример

patchDomainConfig 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| domainToUpdate | string | Да | |
| patchDomainConfigParams | PatchDomainConfigParams | Да |
Отговор
Връща: GetDomainConfig_200_response
Пример

putDomainConfig 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| domainToUpdate | string | Да | |
| updateDomainConfigParams | UpdateDomainConfigParams | Да |
Отговор
Връща: GetDomainConfig_200_response
Пример

createEmailTemplate 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createEmailTemplateBody | CreateEmailTemplateBody | Да |
Отговор
Връща: CreateEmailTemplate_200_response
Пример

deleteEmailTemplate 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

deleteEmailTemplateRenderError 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| errorId | string | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getEmailTemplate 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetEmailTemplate_200_response
Пример

getEmailTemplateDefinitions 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да |
Отговор
Връща: GetEmailTemplateDefinitions_200_response
Пример

getEmailTemplateRenderErrors 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| skip | double | Не |
Отговор
Връща: GetEmailTemplateRenderErrors_200_response
Пример

getEmailTemplates 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| skip | double | Не |
Отговор
Връща: GetEmailTemplates_200_response
Пример

renderEmailTemplate 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Да | |
| locale | string | Не |
Отговор
Връща: RenderEmailTemplate_200_response
Пример

updateEmailTemplate 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getEventLog 
req tenantId urlId userIdWS
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| userIdWS | string | Да | |
| startTime | int64_t | Да | |
| endTime | int64_t | Да |
Отговор
Връща: GetEventLog_200_response
Пример

getGlobalEventLog 
req tenantId urlId userIdWS
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| userIdWS | string | Да | |
| startTime | int64_t | Да | |
| endTime | int64_t | Да |
Отговор
Връща: GetEventLog_200_response
Пример

createFeedPost 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createFeedPostParams | CreateFeedPostParams | Да | |
| broadcastId | string | Не | |
| isLive | bool | Не | |
| doSpamCheck | bool | Не | |
| skipDupCheck | bool | Не |
Отговор
Връща: CreateFeedPost_200_response
Пример

createFeedPostPublic 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| createFeedPostParams | CreateFeedPostParams | Да | |
| broadcastId | string | Не | |
| sso | string | Не |
Отговор
Връща: CreateFeedPostPublic_200_response
Пример

deleteFeedPostPublic 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| postId | string | Да | |
| broadcastId | string | Не | |
| sso | string | Не |
Отговор
Връща: DeleteFeedPostPublic_200_response
Пример

getFeedPosts 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| afterId | string | Не | |
| limit | int32_t | Не | |
| tags | vector<string | Не |
Отговор
Връща: GetFeedPosts_200_response
Пример

getFeedPostsPublic 
req tenantId afterId
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| afterId | string | Не | |
| limit | int32_t | Не | |
| tags | vector<string | Не | |
| sso | string | Не | |
| isCrawler | bool | Не | |
| includeUserInfo | bool | Не |
Отговор
Връща: GetFeedPostsPublic_200_response
Пример

getFeedPostsStats 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| postIds | vector<string | Да | |
| sso | string | Не |
Отговор
Връща: GetFeedPostsStats_200_response
Пример

getUserReactsPublic 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| postIds | vector<string | Не | |
| sso | string | Не |
Отговор
Връща: GetUserReactsPublic_200_response
Пример

reactFeedPostPublic 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| postId | string | Да | |
| reactBodyParams | ReactBodyParams | Да | |
| isUndo | bool | Не | |
| broadcastId | string | Не | |
| sso | string | Не |
Отговор
Връща: ReactFeedPostPublic_200_response
Пример

updateFeedPost 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| feedPost | FeedPost | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

updateFeedPostPublic 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| postId | string | Да | |
| updateFeedPostParams | UpdateFeedPostParams | Да | |
| broadcastId | string | Не | |
| sso | string | Не |
Отговор
Връща: CreateFeedPostPublic_200_response
Пример

flagCommentPublic 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| isFlagged | bool | Да | |
| sso | string | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

addHashTag 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Не | |
| createHashTagBody | CreateHashTagBody | Не |
Отговор
Връща: AddHashTag_200_response
Пример

addHashTagsBulk 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Не | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | Не |
Отговор
Връща: AddHashTagsBulk_200_response
Пример

deleteHashTag 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tag | string | Да | |
| tenantId | string | Не | |
| deleteHashTagRequest | DeleteHashTag_request | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getHashTags 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| page | double | Не |
Отговор
Връща: GetHashTags_200_response
Пример

patchHashTag 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tag | string | Yes | |
| tenantId | string | No | |
| updateHashTagBody | UpdateHashTagBody | No |
Отговор
Връща: PatchHashTag_200_response
Пример

createModerator 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createModeratorBody | CreateModeratorBody | Да |
Отговор
Връща: CreateModerator_200_response
Пример

deleteModerator 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| sendEmail | string | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getModerator 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetModerator_200_response
Пример

getModerators 
Параметри
| Име | Тип | Задължителен | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| skip | double | Не |
Отговор
Връща: GetModerators_200_response
Пример

sendInvite 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| fromName | string | Yes |
Отговор
Връща: FlagCommentPublic_200_response
Пример

updateModerator 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| updateModeratorBody | UpdateModeratorBody | Yes |
Отговор
Връща: FlagCommentPublic_200_response
Пример

deleteNotificationCount 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getCachedNotificationCount 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetCachedNotificationCount_200_response
Пример

getNotificationCount 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Не | |
| urlId | string | Не | |
| fromCommentId | string | Не | |
| viewed | bool | Не | |
| type | string | Не |
Отговор
Връща: GetNotificationCount_200_response
Пример

getNotifications 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Не | |
| urlId | string | Не | |
| fromCommentId | string | Не | |
| viewed | bool | Не | |
| type | string | Не | |
| skip | double | Не |
Отговор
Връща: GetNotifications_200_response
Пример

updateNotification 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateNotificationBody | UpdateNotificationBody | Да | |
| userId | string | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

addPage 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createAPIPageData | CreateAPIPageData | Да |
Отговор
Връща: AddPageAPIResponse
Пример

deletePage 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: DeletePageAPIResponse
Пример

getPageByURLId 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да |
Отговор
Връща: GetPageByURLIdAPIResponse
Пример

getPages 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да |
Отговор
Връща: GetPagesAPIResponse
Пример

patchPage 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateAPIPageData | UpdateAPIPageData | Да |
Отговор
Връща: PatchPageAPIResponse
Пример

deletePendingWebhookEvent 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getPendingWebhookEventCount 
Параметри
| Име | Тип | Задължителен | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Не | |
| externalId | string | Не | |
| eventType | string | Не | |
| type | string | Не | |
| domain | string | Не | |
| attemptCountGT | double | Не |
Отговор
Връща: GetPendingWebhookEventCount_200_response
Пример

getPendingWebhookEvents 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Не | |
| externalId | string | Не | |
| eventType | string | Не | |
| type | string | Не | |
| domain | string | Не | |
| attemptCountGT | double | Не | |
| skip | double | Не |
Отговор
Връща: GetPendingWebhookEvents_200_response
Пример

createQuestionConfig 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createQuestionConfigBody | CreateQuestionConfigBody | Да |
Отговор
Връща: CreateQuestionConfig_200_response
Пример

deleteQuestionConfig 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getQuestionConfig 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetQuestionConfig_200_response
Пример

getQuestionConfigs 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| skip | double | Не |
Отговор
Връща: GetQuestionConfigs_200_response
Пример

updateQuestionConfig 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

createQuestionResult 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createQuestionResultBody | CreateQuestionResultBody | Да |
Отговор
Връща: CreateQuestionResult_200_response
Пример

deleteQuestionResult 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getQuestionResult 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetQuestionResult_200_response
Пример

getQuestionResults 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Не | |
| userId | string | Не | |
| startDate | string | Не | |
| questionId | string | Не | |
| questionIds | string | Не | |
| skip | double | Не |
Отговор
Връща: GetQuestionResults_200_response
Пример

updateQuestionResult 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateQuestionResultBody | UpdateQuestionResultBody | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

aggregateQuestionResults 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| questionId | string | Не | |
| questionIds | vector<string | Не | |
| urlId | string | Не | |
| timeBucket | AggregateTimeBucket | Не | |
| startDate | datetime | Не | |
| forceRecalculate | bool | Не |
Отговор
Връща: AggregateQuestionResults_200_response
Пример

bulkAggregateQuestionResults 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Да | |
| forceRecalculate | bool | Не |
Отговор
Връща: BulkAggregateQuestionResults_200_response
Пример

combineCommentsWithQuestionResults 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| questionId | string | Не | |
| questionIds | vector<string | Не | |
| urlId | string | Не | |
| startDate | datetime | Не | |
| forceRecalculate | bool | Не | |
| minValue | double | Не | |
| maxValue | double | Не | |
| limit | double | Не |
Отговор
Връща: CombineCommentsWithQuestionResults_200_response
Пример

addSSOUser 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| createAPISSOUserData | CreateAPISSOUserData | Yes |
Отговор
Връща: AddSSOUserAPIResponse
Пример

deleteSSOUser 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| deleteComments | bool | Не | |
| commentDeleteMode | string | Не |
Отговор
Връща: DeleteSSOUserAPIResponse
Пример

getSSOUserByEmail 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| string | Да |
Отговор
Връща: GetSSOUserByEmailAPIResponse
Пример

getSSOUserById 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Response
Връща: GetSSOUserByIdAPIResponse
Пример

getSSOUsers 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| skip | int32_t | Не |
Отговор
Връща: GetSSOUsers_200_response
Пример

patchSSOUser 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateAPISSOUserData | UpdateAPISSOUserData | Да | |
| updateComments | bool | Не |
Отговор
Връща: PatchSSOUserAPIResponse
Пример

putSSOUser 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateAPISSOUserData | UpdateAPISSOUserData | Да | |
| updateComments | bool | Не |
Отговор
Връща: PutSSOUserAPIResponse
Пример

createSubscription 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | Да |
Отговор
Връща: CreateSubscriptionAPIResponse
Пример

deleteSubscription 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| userId | string | Не |
Отговор
Връща: DeleteSubscriptionAPIResponse
Пример

getSubscriptions 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Не |
Отговор
Връща: GetSubscriptionsAPIResponse
Пример

getTenantDailyUsages 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| yearNumber | double | Не | |
| monthNumber | double | Не | |
| dayNumber | double | Не | |
| skip | double | Не |
Отговор
Връща: GetTenantDailyUsages_200_response
Пример

createTenantPackage 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createTenantPackageBody | CreateTenantPackageBody | Да |
Отговор
Връща: CreateTenantPackage_200_response
Пример

deleteTenantPackage 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getTenantPackage 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes |
Отговор
Връща: GetTenantPackage_200_response
Пример

getTenantPackages 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| skip | double | Не |
Отговор
Връща: GetTenantPackages_200_response
Пример

replaceTenantPackage 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

updateTenantPackage 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateTenantPackageBody | UpdateTenantPackageBody | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

createTenantUser 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| createTenantUserBody | CreateTenantUserBody | Да |
Отговор
Връща: CreateTenantUser_200_response
Пример

deleteTenantUser 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| deleteComments | string | Не | |
| commentDeleteMode | string | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getTenantUser 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetTenantUser_200_response
Пример

getTenantUsers 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| skip | double | Не |
Отговор
Връща: GetTenantUsers_200_response
Пример

replaceTenantUser 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| replaceTenantUserBody | ReplaceTenantUserBody | Да | |
| updateComments | string | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

sendLoginLink 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| redirectURL | string | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

updateTenantUser 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateTenantUserBody | UpdateTenantUserBody | Да | |
| updateComments | string | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

createTenant 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createTenantBody | CreateTenantBody | Да |
Отговор
Връща: CreateTenant_200_response
Пример

deleteTenant 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| sure | string | Не |
Отговор
Връща: FlagCommentPublic_200_response
Пример

getTenant 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetTenant_200_response
Пример

getTenants 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| meta | string | Не | |
| skip | double | Не |
Отговор
Връща: GetTenants_200_response
Пример

updateTenant 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateTenantBody | UpdateTenantBody | Да |
Отговор
Връща: FlagCommentPublic_200_response
Пример

uploadImage 
Качване и преоразмеряване на изображение
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| file | HttpContent | Да | |
| sizePreset | SizePreset | Не | |
| urlId | string | Не |
Отговор
Връща: UploadImageResponse
Пример

getUserBadgeProgressById 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetUserBadgeProgressById_200_response
Пример

getUserBadgeProgressByUserId 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Да |
Отговор
Връща: GetUserBadgeProgressById_200_response
Пример

getUserBadgeProgressList 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Не | |
| limit | double | Не | |
| skip | double | Не |
Отговор
Връща: GetUserBadgeProgressList_200_response
Пример

createUserBadge 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| createUserBadgeParams | CreateUserBadgeParams | Да |
Отговор
Връща: CreateUserBadge_200_response
Пример

deleteUserBadge 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: UpdateUserBadge_200_response
Пример

getUserBadge 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetUserBadge_200_response
Пример

getUserBadges 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| userId | string | Не | |
| badgeId | string | Не | |
| type | double | Не | |
| displayedOnComments | bool | Не | |
| limit | double | Не | |
| skip | double | Не |
Отговор
Връща: GetUserBadges_200_response
Пример

updateUserBadge 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| updateUserBadgeParams | UpdateUserBadgeParams | Да |
Отговор
Връща: UpdateUserBadge_200_response
Пример

getUserNotificationCount 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| sso | string | Не |
Отговор
Връща: GetUserNotificationCount_200_response
Пример

getUserNotifications 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| pageSize | int32_t | Не | |
| afterId | string | Не | |
| includeContext | bool | Не | |
| afterCreatedAt | int64_t | Не | |
| unreadOnly | bool | Не | |
| dmOnly | bool | Не | |
| noDm | bool | Не | |
| includeTranslations | bool | Не | |
| sso | string | Не |
Отговор
Връща: GetUserNotifications_200_response
Пример

resetUserNotificationCount 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| sso | string | Не |
Отговор
Връща: ResetUserNotifications_200_response
Пример

resetUserNotifications 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| afterId | string | Не | |
| afterCreatedAt | int64_t | Не | |
| unreadOnly | bool | Не | |
| dmOnly | bool | Не | |
| noDm | bool | Не | |
| sso | string | Не |
Отговор
Връща: ResetUserNotifications_200_response
Пример

updateUserNotificationCommentSubscriptionStatus 
Активиране или деактивиране на известия за конкретен коментар.
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| notificationId | string | Да | |
| optedInOrOut | string | Да | |
| commentId | string | Да | |
| sso | string | Не |
Отговор
Връща: UpdateUserNotificationStatus_200_response
Пример

updateUserNotificationPageSubscriptionStatus 
Включване или изключване на известия за страница. Когато потребителите са абонирани за страница, се създават известия за нови коренни коментари, както и
Parameters
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| url | string | Да | |
| pageTitle | string | Да | |
| subscribedOrUnsubscribed | string | Да | |
| sso | string | Не |
Отговор
Връща: UpdateUserNotificationStatus_200_response
Пример

updateUserNotificationStatus 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| notificationId | string | Да | |
| newStatus | string | Да | |
| sso | string | Не |
Отговор
Връща: UpdateUserNotificationStatus_200_response
Пример

getUserPresenceStatuses 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| urlIdWS | string | Да | |
| userIds | string | Да |
Отговор
Връща: GetUserPresenceStatuses_200_response
Пример

searchUsers 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| usernameStartsWith | string | Не | |
| mentionGroupIds | vector<string | Не | |
| sso | string | Не |
Отговор
Връща: SearchUsers_200_response
Пример

getUser 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да |
Отговор
Връща: GetUser_200_response
Пример

createVote 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| commentId | string | Да | |
| direction | string | Да | |
| userId | string | Не | |
| anonUserId | string | Не |
Отговор
Връща: VoteComment_200_response
Пример

deleteVote 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Да | |
| id | string | Да | |
| editKey | string | Не |
Отговор
Връща: DeleteCommentVote_200_response
Пример

getVotes 
Параметри
| Име | Тип | Задължително | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да |
Отговор
Връща: GetVotes_200_response
Пример

getVotesForUser 
Параметри
| Име | Тип | Задължителен | Описание |
|---|---|---|---|
| tenantId | string | Да | |
| urlId | string | Да | |
| userId | string | Не | |
| anonUserId | string | Не |
Отговор
Връща: GetVotesForUser_200_response
Пример

Нуждаете ли се от помощ?
Ако срещнете проблеми или имате въпроси относно C++ SDK, моля:
Принос
Приноси са добре дошли! Моля, посетете репозитория в GitHub за указания относно приносянето.