
Език 🇧🇬 Български
Първи стъпки
Референция на API
Документация
Удостоверяване
Агрегиране
Журнали за одит
Блокиране от коментар
Проверка на блокирани коментари
Коментари
Конфигурации на домейн
Имейл шаблони
Дневник на събитията
Публикации във фийда
Докладване на коментар
Хаштагове
Модератори
Брой известия
Известия
Страници
Чакащи уебхук събития
Конфигурации на въпроси
Резултати от въпроси
Агрегиране на резултати от въпроси
SSO потребители
Абонаменти
Дневна употреба на наемателя
Пакети за наематели
Потребители на наематели
Наематели
Билети
Качване на изображение
Напредък на потребителски значки
Потребителски значки
Потребителски известия
Статус на присъствие на потребител
Търсене на потребители
Потребители
Гласове
FastComments PHP SDK
Това е официалният PHP SDK за FastComments.
Официален PHP SDK за FastComments API
Репозитория
Инсталиране и използване 
Изисквания
PHP 7.4 и по-нови. Трябва да работи и с PHP 8.0.
Composer
За да инсталирате пакета чрез Composer, добавете следното към composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}
След това изпълнете composer install
Ръчна инсталация
Изтеглете файловете и включете autoload.php:
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');
Първи стъпки 
Моля, следвайте процедурата за инсталиране и след това изпълнете следното:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Конфигуриране на авторизация с API ключ: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_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'; // string
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
try {
$result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}
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 | |
| 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} | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | |
| PublicApi | getEventLog | GET /event-log/{tenantId} | |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote | |
| --- |
Модели 
- APIAuditLog
- APIComment
- APICommentBase
- APICommentBaseMeta
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIPage
- APISSOUser
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfig200Response
- AddDomainConfig200ResponseAnyOf
- AddDomainConfigParams
- AddHashTag200Response
- AddHashTagsBulk200Response
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AggregateQuestionResults200Response
- AggregateQuestionResultsResponse
- AggregateTimeBucket
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- BillingInfo
- BlockFromCommentParams
- BlockFromCommentPublic200Response
- BlockSuccess
- BulkAggregateQuestionItem
- BulkAggregateQuestionResults200Response
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBodyTagsInner
- BulkCreateHashTagsResponse
- ChangeCommentPinStatusResponse
- ChangeTicketState200Response
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CheckedCommentsForBlocked200Response
- CombineCommentsWithQuestionResults200Response
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateCommentPublic200Response
- CreateEmailTemplate200Response
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPost200Response
- CreateFeedPostParams
- CreateFeedPostPublic200Response
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModerator200Response
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfig200Response
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResult200Response
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenant200Response
- CreateTenantBody
- CreateTenantPackage200Response
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUser200Response
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicket200Response
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadge200Response
- CreateUserBadgeParams
- CustomConfigParameters
- CustomEmailTemplate
- DeleteComment200Response
- DeleteCommentAction
- DeleteCommentPublic200Response
- DeleteCommentResult
- DeleteCommentVote200Response
- DeleteDomainConfig200Response
- DeleteFeedPostPublic200Response
- DeleteFeedPostPublic200ResponseAnyOf
- DeleteHashTagRequest
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagComment200Response
- FlagCommentPublic200Response
- FlagCommentResponse
- GetAuditLogs200Response
- GetAuditLogsResponse
- GetCachedNotificationCount200Response
- GetCachedNotificationCountResponse
- GetComment200Response
- GetCommentText200Response
- GetCommentVoteUserNames200Response
- GetCommentVoteUserNamesSuccessResponse
- GetComments200Response
- GetCommentsPublic200Response
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfig200Response
- GetDomainConfigs200Response
- GetDomainConfigs200ResponseAnyOf
- GetDomainConfigs200ResponseAnyOf1
- GetEmailTemplate200Response
- GetEmailTemplateDefinitions200Response
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrors200Response
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplates200Response
- GetEmailTemplatesResponse
- GetEventLog200Response
- GetEventLogResponse
- GetFeedPosts200Response
- GetFeedPostsPublic200Response
- GetFeedPostsResponse
- GetFeedPostsStats200Response
- GetHashTags200Response
- GetHashTagsResponse
- GetModerator200Response
- GetModeratorResponse
- GetModerators200Response
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCount200Response
- GetNotificationCountResponse
- GetNotifications200Response
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCount200Response
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEvents200Response
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetQuestionConfig200Response
- GetQuestionConfigResponse
- GetQuestionConfigs200Response
- GetQuestionConfigsResponse
- GetQuestionResult200Response
- GetQuestionResultResponse
- GetQuestionResults200Response
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsers200Response
- GetSubscriptionsAPIResponse
- GetTenant200Response
- GetTenantDailyUsages200Response
- GetTenantDailyUsagesResponse
- GetTenantPackage200Response
- GetTenantPackageResponse
- GetTenantPackages200Response
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUser200Response
- GetTenantUserResponse
- GetTenantUsers200Response
- GetTenantUsersResponse
- GetTenants200Response
- GetTenantsResponse
- GetTicket200Response
- GetTicketResponse
- GetTickets200Response
- GetTicketsResponse
- GetUser200Response
- GetUserBadge200Response
- GetUserBadgeProgressById200Response
- GetUserBadgeProgressList200Response
- GetUserBadges200Response
- GetUserNotificationCount200Response
- GetUserNotificationCountResponse
- GetUserNotifications200Response
- GetUserPresenceStatuses200Response
- GetUserPresenceStatusesResponse
- GetUserReactsPublic200Response
- GetUserResponse
- GetVotes200Response
- GetVotesForUser200Response
- GetVotesForUserResponse
- GetVotesResponse
- GifRating
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedSiteType
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- LockComment200Response
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PatchDomainConfigParams
- PatchHashTag200Response
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PinComment200Response
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicVote
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionConfig
- QuestionConfigCustomOptionsInner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostPublic200Response
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RecordStringStringOrNumberValue
- RenderEmailTemplate200Response
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotifications200Response
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveComment200Response
- SaveCommentResponse
- SaveCommentResponseOptimized
- SaveCommentsResponseWithPresence
- SearchUsers200Response
- SearchUsersResponse
- SearchUsersSectionedResponse
- SetCommentText200Response
- SetCommentTextResult
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantHashTag
- TenantPackage
- UnBlockCommentPublic200Response
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadge200Response
- UpdateUserBadgeParams
- UpdateUserNotificationStatus200Response
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- VoteBodyParams
- VoteComment200Response
- VoteDeleteResponse
- VoteResponse
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
Авторизация 
Схеми за удостоверяване, дефинирани за API:
api_key
- Тип: API key
- Име на параметъра за API key: x-api-key
- Местоположение: HTTP header
агрегиране 
Агрегира документи чрез групиране (ако е зададен groupBy) и прилагане на множество операции. Поддържат се различни операции (напр. sum, countDistinct, avg и т.н.).
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| parentTenantId | string | query | Не | |
| includeStats | boolean | query | Не |
Отговор
Връща: AggregationResponse
Пример

Журнали за одит 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| limit | number | query | Не | |
| skip | number | query | Не | |
| order | string | query | Не | |
| after | number | query | Не | |
| before | number | query | Не |
Отговор
Връща: GetAuditLogs200Response
Пример

Блокиране от публичен коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: BlockFromCommentPublic200Response
Пример

Разблокиране на публичен коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: UnBlockCommentPublic200Response
Пример

Проверка за блокирани коментари 
Параметри
| Име | Тип | Location | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentIds | string | query | Да | Списък от id-та на коментари, разделени със запетаи. |
| sso | string | query | Не |
Отговор
Връща: CheckedCommentsForBlocked200Response
Пример

Блокиране на потребител от коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: BlockFromCommentPublic200Response
Пример

Създаване на публичен коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| sessionId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: CreateCommentPublic200Response
Пример

Изтриване на коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| contextUserId | string | query | Не | |
| isLive | boolean | query | Не |
Отговор
Връща: DeleteComment200Response
Пример

Изтриване на публичен коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Връща
Връща: DeleteCommentPublic200Response
Пример

Изтриване на глас за коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| voteId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: DeleteCommentVote200Response
Пример

Докладване на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: FlagComment200Response
Пример

Получаване на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetComment200Response
Пример

Получаване на коментари 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| page | integer | query | Не | |
| limit | integer | query | Не | |
| skip | integer | query | Не | |
| asTree | boolean | query | Не | |
| skipChildren | integer | query | Не | |
| limitChildren | integer | query | Не | |
| maxTreeDepth | integer | query | Не | |
| urlId | string | query | Не | |
| userId | string | query | Не | |
| anonUserId | string | query | Не | |
| contextUserId | string | query | Не | |
| hashTag | string | query | Не | |
| parentId | string | query | Не | |
| direction | string | query | Не |
Отговор
Връща: GetComments200Response
Пример

Получаване на публични коментари 
req tenantId urlId
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Отговор
Връща: GetCommentsPublic200Response
Пример

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

Потребителски имена на гласували за коментара 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Отговор
Връща: GetCommentVoteUserNames200Response
Пример

Заключване на коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: LockComment200Response
Пример

Прикрепване на коментар 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: PinComment200Response
Пример

Запазване на коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Отговор
Връща: SaveComment200Response
Пример

Масово запазване на коментари 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| isLive | boolean | query | Не | |
| doSpamCheck | boolean | query | Не | |
| sendEmails | boolean | query | Не | |
| populateNotifications | boolean | query | Не |
Отговор
Връща: SaveComment200Response
Пример

Задаване на текст на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: SetCommentText200Response
Пример

Разблокиране на потребител от коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: UnBlockCommentPublic200Response
Пример

Премахване на сигнал за коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Отговор
Връща: FlagComment200Response
Пример

Отключване на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: LockComment200Response
Пример

Откачване на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: PinComment200Response
Пример

Актуализиране на коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| contextUserId | string | query | Не | |
| doSpamCheck | boolean | query | Не | |
| isLive | boolean | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Гласуване за коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: VoteComment200Response
Пример

Добавяне на конфигурация на домейн 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: AddDomainConfig200Response
Пример

Изтриване на конфигурация на домейн 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Отговор
Връща: DeleteDomainConfig200Response
Пример

Получаване на конфигурация на домейн 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Отговор
Връща: GetDomainConfig200Response
Пример

Получаване на конфигурации на домейн 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: GetDomainConfigs200Response
Пример

Частична актуализация на конфигурация на домейн 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Отговор
Връща: GetDomainConfig200Response
Пример

Заместване на конфигурация на домейн 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Отговор
Връща: GetDomainConfig200Response
Пример

Създаване на имейл шаблон 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateEmailTemplate200Response
Пример

Изтриване на имейл шаблон 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: FlagCommentPublic200Response
Пример

Изтриване на грешка при рендиране на имейл шаблон 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| errorId | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Получаване на имейл шаблон 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetEmailTemplate200Response
Пример

Дефиниции на имейл шаблони 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: GetEmailTemplateDefinitions200Response
Пример

Грешки при рендиране на имейл шаблон 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| skip | number | query | Не |
Отговор
Връща: GetEmailTemplateRenderErrors200Response
Пример

Имейл шаблони 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Отговор
Връща: GetEmailTemplates200Response
Пример

Рендиране на имейл шаблон 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| locale | string | query | Не |
Отговор
Връща: RenderEmailTemplate200Response
Пример

Актуализиране на имейл шаблон 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Дневник на събитията 
req tenantId urlId userIdWS
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Да |
Отговор
Връща: GetEventLog200Response
Пример

Глобален дневник на събитията 
req tenantId urlId userIdWS
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Да |
Отговор
Връща: GetEventLog200Response
Пример

Създаване на публикация във фийда 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| broadcastId | string | query | Не | |
| isLive | boolean | query | Не | |
| doSpamCheck | boolean | query | Не | |
| skipDupCheck | boolean | query | Не |
Отговор
Връща: CreateFeedPost200Response
Пример

Създаване на публична публикация във фийда 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: CreateFeedPostPublic200Response
Пример

Изтриване на публична публикация във фийда 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: DeleteFeedPostPublic200Response
Пример

Получаване на публикации във фийда 
req tenantId afterId
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Не | |
| limit | integer | query | Не | |
| tags | array | query | Не |
Отговор
Връща: GetFeedPosts200Response
Пример

Публични публикации във фийда 
req tenantId afterId
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| afterId | string | query | Не | |
| limit | integer | query | Не | |
| tags | array | query | Не | |
| sso | string | query | Не | |
| isCrawler | boolean | query | Не | |
| includeUserInfo | boolean | query | Не |
Response
Връща: GetFeedPostsPublic200Response
Пример

Статистики на публикации във фийда 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postIds | array | query | Да | |
| sso | string | query | Не |
Response
Връща: GetFeedPostsStats200Response
Example

Публични реакции на потребителя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postIds | array | query | Не | |
| sso | string | query | Не |
Отговор
Връща: GetUserReactsPublic200Response
Пример

Реакция на публична публикация във фийда 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| isUndo | boolean | query | Не | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ReactFeedPostPublic200Response
Пример

Актуализиране на публикация във фийда 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Актуализиране на публична публикация във фийда 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: CreateFeedPostPublic200Response
Пример

Докладване на публичен коментар 
Параметри
| Name | Тип | Location | Required | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| isFlagged | boolean | query | Да | |
| sso | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Добавяне на хаштаг 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Не |
Отговор
Връща: AddHashTag200Response
Пример

Масово добавяне на хаштагове 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Не |
Отговор
Връща: AddHashTagsBulk200Response
Пример

Изтриване на хаштаг 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tag | string | path | Да | |
| tenantId | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Получаване на хаштагове 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No |
Отговор
Връща: GetHashTags200Response
Пример

Частична актуализация на хаштаг 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tag | string | path | Да | |
| tenantId | string | query | Не |
Отговор
Връща: PatchHashTag200Response
Пример

Създаване на модератор 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Отговор
Връща: CreateModerator200Response
Пример

Изтриване на модератор 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sendEmail | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Получаване на модератор 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetModerator200Response
Пример

Получаване на модератори 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Отговор
Връща: GetModerators200Response
Пример

Изпращане на покана 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| fromName | string | query | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Актуализиране на модератор 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Изтриване на броя известия 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Кеширан брой известия 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetCachedNotificationCount200Response
Пример

Получаване на брой известия 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| urlId | string | query | Не | |
| fromCommentId | string | query | Не | |
| viewed | boolean | query | Не | |
| type | string | query | Не |
Отговор
Връща: GetNotificationCount200Response
Пример

Получаване на известия 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| urlId | string | query | Не | |
| fromCommentId | string | query | Не | |
| viewed | boolean | query | Не | |
| type | string | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetNotifications200Response
Пример

Актуализиране на известие 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Добавяне на страница 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: AddPageAPIResponse
Пример

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

Страница по URL идентификатор 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Отговор
Връща: GetPageByURLIdAPIResponse
Пример

Получаване на страници 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: GetPagesAPIResponse
Пример

Частична актуализация на страница 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: PatchPageAPIResponse
Пример

Изтриване на чакащо уебхук събитие 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Брой чакащи уебхук събития 
Параметри
| Име | Type | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Не | |
| externalId | string | query | Не | |
| eventType | string | query | Не | |
| type | string | query | Не | |
| domain | string | query | Не | |
| attemptCountGT | number | query | Не |
Отговор
Връща: GetPendingWebhookEventCount200Response
Пример

Получаване на чакащи уебхук събития 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Връща: GetPendingWebhookEvents200Response
Пример

Създаване на конфигурация за въпрос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateQuestionConfig200Response
Пример

Изтриване на конфигурация за въпрос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Получаване на конфигурация за въпрос 
Параметри
| Име | Тип | Разположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetQuestionConfig200Response
Пример

Получаване на конфигурации за въпроси 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetQuestionConfigs200Response
Пример

Актуализиране на конфигурация за въпрос 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Създаване на резултат от въпрос 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateQuestionResult200Response
Пример

Изтриване на резултат от въпрос 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Получаване на резултат от въпрос 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetQuestionResult200Response
Пример

Получаване на резултати от въпроси 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Не | |
| userId | string | query | Не | |
| startDate | string | query | Не | |
| questionId | string | query | Не | |
| questionIds | string | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetQuestionResults200Response
Пример

Актуализиране на резултат от въпрос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: FlagCommentPublic200Response
Пример

Агрегиране на резултати от въпроси 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| questionId | string | query | Не | |
| questionIds | array | query | Не | |
| urlId | string | query | Не | |
| timeBucket | string | query | Не | |
| startDate | string | query | Не | |
| forceRecalculate | boolean | query | Не |
Отговор
Връща: AggregateQuestionResults200Response
Пример

Масово агрегиране на резултати от въпроси 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| forceRecalculate | boolean | query | Не |
Отговор
Връща: BulkAggregateQuestionResults200Response
Пример

Комбиниране на коментари с резултати от въпроси 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| questionId | string | query | Не | |
| questionIds | array | query | Не | |
| urlId | string | query | Не | |
| startDate | string | query | Не | |
| forceRecalculate | boolean | query | Не | |
| minValue | number | query | Не | |
| maxValue | number | query | Не | |
| limit | number | query | Не |
Отговор
Връща: CombineCommentsWithQuestionResults200Response
Пример

Добавяне на SSO потребител 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: AddSSOUserAPIResponse
Пример

Изтриване на SSO потребител 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| deleteComments | boolean | query | Не | |
| commentDeleteMode | string | query | Не |
Отговор
Връща: DeleteSSOUserAPIResponse
Пример

Получаване на SSO потребител по имейл 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| string | path | Да |
Отговор
Връща: GetSSOUserByEmailAPIResponse
Пример

Получаване на SSO потребител по идентификатор 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetSSOUserByIdAPIResponse
Пример

Получаване на SSO потребители 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | integer | query | Не |
Отговор
Връща: GetSSOUsers200Response
Пример

Частична актуализация на SSO потребител 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Отговор
Връща: PatchSSOUserAPIResponse
Пример

Заместване на SSO потребител 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Отговор
Връща: PutSSOUserAPIResponse
Пример

Създаване на абонамент 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Отговор
Връща: CreateSubscriptionAPIResponse
Пример

Изтриване на абонамент 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Връща: DeleteSubscriptionAPIResponse
Пример

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

Актуализиране на абонамент 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Връща: UpdateSubscriptionAPIResponse
Пример

Дневна употреба на наемателя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| yearNumber | number | query | Не | |
| monthNumber | number | query | Не | |
| dayNumber | number | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetTenantDailyUsages200Response
Пример

Създаване на пакет за наемателя 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateTenantPackage200Response
Пример

Изтриване на пакет за наемателя 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Получаване на пакет за наемателя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetTenantPackage200Response
Пример

Получаване на пакети за наематели 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetTenantPackages200Response
Пример

Замяна на пакет за наемателя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Актуализиране на пакет за наемателя 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Създаване на потребител за наемател 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateTenantUser200Response
Пример

Изтриване на потребител на наемателя 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| deleteComments | string | query | Не | |
| commentDeleteMode | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Получаване на потребител на наемателя 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetTenantUser200Response
Пример

Получаване на потребители на наемателя 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetTenantUsers200Response
Пример

Замяна на потребител на наемателя 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Изпращане на линк за влизане 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| redirectURL | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Актуализиране на потребител на наемателя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Създаване на наемател 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateTenant200Response
Пример

Изтриване на наемател 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sure | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

Получаване на наемател 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetTenant200Response
Пример

Получаване на наематели 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| meta | string | query | Не | |
| skip | number | query | Не |
Response
Връща: GetTenants200Response
Пример

Актуализиране на наемател 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

Промяна на състоянието на билет 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: ChangeTicketState200Response
Пример

Създаване на билет 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Да |
Отговор
Връща: CreateTicket200Response
Пример

Получаване на билет 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Връща: GetTicket200Response
Пример

Получаване на билети 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Отговор
Връща: GetTickets200Response
Пример

Качване на изображение 
Качване и преоразмеряване на изображение
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| sizePreset | string | query | Не | Предварително зададен размер: "Default" (1000x1000px) or "CrossPlatform" (създава размери за популярни устройства) |
| urlId | string | query | Не | ID на страницата, от която се извършва качването, за конфигуриране |
Отговор
Връща: UploadImageResponse
Пример

Напредък на потребителска значка по идентификатор 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetUserBadgeProgressById200Response
Пример

Напредък на потребителска значка по потребителски идентификатор 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | path | Да |
Отговор
Връща: GetUserBadgeProgressById200Response
Пример

Списък с напредък на потребителски значки 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| limit | number | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetUserBadgeProgressList200Response
Пример

Създаване на потребителска значка 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateUserBadge200Response
Пример

Изтриване на потребителска значка 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: UpdateUserBadge200Response
Пример

Получаване на потребителска значка 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetUserBadge200Response
Пример

Получаване на потребителски значки 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| badgeId | string | query | Не | |
| type | number | query | Не | |
| displayedOnComments | boolean | query | Не | |
| limit | number | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetUserBadges200Response
Пример

Актуализиране на потребителска значка 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: UpdateUserBadge200Response
Пример

Получаване на брой известия на потребителя 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: GetUserNotificationCount200Response
Пример

Получаване на потребителски известия 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| pageSize | integer | query | Не | |
| afterId | string | query | Не | |
| includeContext | boolean | query | Не | |
| afterCreatedAt | integer | query | Не | |
| unreadOnly | boolean | query | Не | |
| dmOnly | boolean | query | Не | |
| noDm | boolean | query | Не | |
| includeTranslations | boolean | query | Не | |
| sso | string | query | Не |
Отговор
Връща: GetUserNotifications200Response
Пример

Нулиране на брой потребителски известия 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: ResetUserNotifications200Response
Пример

Нулиране на потребителски известия 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Не | |
| afterCreatedAt | integer | query | Не | |
| unreadOnly | boolean | query | Не | |
| dmOnly | boolean | query | Не | |
| noDm | boolean | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ResetUserNotifications200Response
Пример

Актуализиране на статуса на абонамента за коментари на потребителя 
Включване или изключване на известия за конкретен коментар.
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| optedInOrOut | string | path | Да | |
| commentId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationStatus200Response
Пример

Актуализиране на статуса на абонамента за страница на потребителя 
Активиране или деактивиране на известия за страница. Когато потребителите са абонирани за страница, се създават известия за нови коренни коментари, както и
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: UpdateUserNotificationStatus200Response
Пример

Актуализиране на статуса на потребителско известие 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| newStatus | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationStatus200Response
Пример

Статуси на присъствие на потребителите 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlIdWS | string | query | Да | |
| userIds | string | query | Да |
Отговор
Връща: GetUserPresenceStatuses200Response
Пример

Търсене на потребители 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Отговор
Връща: SearchUsers200Response
Пример

Получаване на потребител 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetUser200Response
Пример

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

Изтриване на глас 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| editKey | string | query | Не |
Response
Връща: DeleteCommentVote200Response
Example

Получаване на гласове 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Отговор
Връща: GetVotes200Response
Пример

Получаване на гласове за потребител 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: GetVotesForUser200Response
Пример

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