
Език 🇧🇬 Български
Документация
Агрегация
Одит Журнали
Удостоверяване
Блокиране от коментар
Проверка на блокирани коментари
Коментари
Маркиране на коментар
Коментари за потребител
Конфигурации на домейн
Шаблони за имейл
Регистър на събития
Публикации във фийд
GIF файлове
Хаштагове
Модерация
Модератори
Брой известия
Известия
Реакции към страници
Страници
Чакащи уебhook събития
Конфигурации на въпроси
Резултати от въпроси
Агрегиране на резултати от въпроси
SSO потребители
Абонаменти
Дневно използване на наемател
Пакети за наемател
Потребители на наемател
Наематели
Билети
Преводи
Качване на изображение
Прогрес на потребителски значки
Потребителски значки
Потребителски известия
Статус на присъствие
Търсене на потребители
Потребители
Гласове
FastComments Dart SDK
Това е официалният Dart SDK за FastComments.
Управлявайте коментари, потребители, SSO и модерация от вашите Dart и Flutter приложения.
Repository
Оформление 
fastcomments-dart/
client/ generated dart client (do not edit by hand)
sso/ hand-written SSO token helpers
openapi.json committed copy of the spec used for generation
config.json openapi-generator config
update.py regenerate the client from the spec
Използване 
dependencies:
fastcomments_dart: ^3.0.0
Помощните функции за SSO са включени в пакета (package:fastcomments_dart/sso/...).
Клиентът предоставя три API класа:
DefaultApi– методи, аутентикирани с API‑ключ, за сървърна употреба.PublicApi– публични методи, които не изискват API ключ, безопасни за браузъри и мобилни клиенти.ModerationApi– обширен набор от живи и бързи API‑та за модериране. Всеки метод наModerationApiприема параметърssoи може да се аутентицира чрез SSO или с FastComments.com сесийна бисквитка.
import 'package:fastcomments_dart/api.dart';
final api = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final comments = await api.getCommentsPublic('YOUR_TENANT_ID', 'YOUR_URL_ID');import 'package:fastcomments_dart/api.dart';
final publicApi = PublicApi(ApiClient(basePath: 'https://fastcomments.com'));
final feedPosts = await publicApi.getFeedPostsPublic('YOUR_TENANT_ID');import 'package:fastcomments_dart/api.dart';
final moderation = ModerationApi(ApiClient(basePath: 'https://fastcomments.com'));
final result = await moderation.getApiComments(
GetApiCommentsOptions(sso: 'SSO_TOKEN'),
);
SSO 
import 'package:fastcomments_dart/sso/fastcomments_sso.dart';
import 'package:fastcomments_dart/sso/secure_sso_user_data.dart';
final sso = FastCommentsSSO.secure(
apiKey: 'YOUR_API_SECRET',
user: SecureSSOUserData(
id: 'user-123',
email: 'jane@example.com',
username: 'jane',
avatar: 'https://example.com/jane.png',
),
);
final token = sso.prepareToSend();
агрегиране 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| parentTenantId | string | query | Не | |
| includeStats | boolean | query | Не |
Response
Връща: AggregateResponse
Пример

getAuditLogs 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Отговор
Връща: GetAuditLogsResponse
Пример

logoutPublic 
Отговор
Връща: APIEmptyResponse
Пример

blockFromCommentPublic 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: BlockSuccess
Пример

unBlockCommentPublic 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: UnblockSuccess
Пример

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

blockUserFromComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: BlockSuccess
Пример

createCommentPublic 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: SaveCommentsResponseWithPresence
Пример

deleteComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Отговор
Връща: DeleteCommentResult
Пример

deleteCommentPublic 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Отговор
Връща: PublicAPIDeleteCommentResponse
Пример

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

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

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

getComments 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Отговор
Връща: APIGetCommentsResponse
Пример

getCommentsPublic 
заявка
tenantId
urlId
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| page | integer | query | Не | |
| direction | string | query | Не | |
| sso | string | query | Не | |
| skip | integer | query | Не | |
| skipChildren | integer | query | Не | |
| limit | integer | query | Не | |
| limitChildren | integer | query | Не | |
| countChildren | boolean | query | Не | |
| fetchPageForCommentId | string | query | Не | |
| includeConfig | boolean | query | Не | |
| countAll | boolean | query | Не | |
| includei10n | boolean | query | Не | |
| locale | string | query | Не | |
| modules | string | query | Не | |
| isCrawler | boolean | query | Не | |
| includeNotificationCount | boolean | query | Не | |
| asTree | boolean | query | Не | |
| maxTreeDepth | integer | query | Не | |
| useFullTranslationIds | boolean | query | Не | |
| parentId | string | query | Не | |
| searchText | string | query | Не | |
| hashTags | array | query | Не | |
| userId | string | query | Не | |
| customConfigStr | string | query | Не | |
| afterCommentId | string | query | Не | |
| beforeCommentId | string | query | Не |
Отговор
Връща: GetCommentsResponseWithPresencePublicComment
Пример

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

getCommentVoteUserNames 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Отговор
Returns: GetCommentVoteUserNamesSuccessResponse
Пример

lockComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

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

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

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

setCommentText 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Отговор
Returns: PublicAPISetCommentTextResponse
Пример

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

unFlagComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Отговор
Връща: FlagCommentResponse
Пример

unLockComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

unPinComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Отговор
Връща: ChangeCommentPinStatusResponse
Пример

updateComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Отговор
Връща: APIEmptyResponse
Пример

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

getCommentsForUser 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
Отговор
Връща: GetCommentsForUserResponse
Пример

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

deleteDomainConfig 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Отговор
Връща: DeleteDomainConfigResponse
Пример

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

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

patchDomainConfig 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Отговор
Връща: PatchDomainConfigResponse
Пример

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

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

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

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

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

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

getEmailTemplateRenderErrors 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Отговор
Returns: GetEmailTemplateRenderErrorsResponse
Пример

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

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

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

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

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

createFeedPost 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Отговор
Връща: CreateFeedPostsResponse
Пример

createFeedPostPublic 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: CreateFeedPostResponse
Пример

deleteFeedPostPublic 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: DeleteFeedPostPublicResponse
Пример

getFeedPosts 
req tenantId afterId
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Не | |
| limit | integer | query | Не | |
| tags | array | query | Не |
Отговор
Връща: GetFeedPostsResponse
Пример

getFeedPostsPublic 
req tenantId afterId
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Отговор
Връща: PublicFeedPostsResponse
Пример

getFeedPostsStats 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | Yes | |
| sso | string | query | No |
Отговор
Връща: FeedPostsStatsResponse
Пример

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

reactFeedPostPublic 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: ReactFeedPostResponse
Пример

updateFeedPost 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Returns: APIEmptyResponse
Пример

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

flagCommentPublic 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| isFlagged | boolean | query | Да | |
| sso | string | query | Не |
Response
Returns: APIEmptyResponse
Example

getGifLarge 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| largeInternalURLSanitized | string | query | Yes |
Отговор
Връща: GifGetLargeResponse
Пример

getGifsSearch 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Отговор
Връща: GetGifsSearchResponse
Пример

getGifsTrending 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| locale | string | query | Не | |
| rating | string | query | Не | |
| page | number | query | Не |
Отговор
Връща: GetGifsTrendingResponse
Пример

addHashTag 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreateHashTagResponse
Example

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

deleteHashTag 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Отговор
Връща: APIEmptyResponse
Пример

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

patchHashTag 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Response
Returns: UpdateHashTagResponse
Example

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

getApiComments 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Отговор
Връща: ModerationAPIGetCommentsResponse
Пример

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

getApiIds 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| text-search | string | query | Не | |
| byIPFromComment | string | query | Не | |
| filters | string | query | Не | |
| searchFilters | string | query | Не | |
| afterId | string | query | Не | |
| demo | boolean | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ModerationAPIGetCommentIdsResponse
Пример

getBanUsersFromComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: GetBannedUsersFromCommentResponse
Пример

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

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

getCount 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Отговор
Връща: ModerationAPICountCommentsResponse
Пример

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

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

getManualBadges 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Returns: GetTenantManualBadgesResponse
Пример

getManualBadgesForUser 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: GetUserManualBadgesResponse
Пример

getModerationComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Отговор
Връща: ModerationAPICommentResponse
Пример

getModerationCommentText 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: GetCommentTextResponse
Пример

getPreBanSummary 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Отговор
Връща: PreBanSummary
Пример

getSearchCommentsSummary 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Отговор
Връща: ModerationCommentSearchResponse
Пример

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

getSearchSites 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Не | |
| sso | string | query | Не |
Response
Връща: ModerationSiteSearchResponse
Example

getSearchSuggest 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Отговор
Връща: ModerationSuggestResponse
Пример

getSearchUsers 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Не | |
| sso | string | query | Не |
Response
Връща: ModerationUserSearchResponse
Example

getTrustFactor 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Response
Връща: GetUserTrustFactorResponse
Example

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

getUserInternalProfile 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Response
Връща: GetUserInternalProfileResponse
Пример

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

postApiExport 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| text-search | string | query | Не | |
| byIPFromComment | string | query | Не | |
| filters | string | query | Не | |
| searchFilters | string | query | Не | |
| sorts | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ModerationExportResponse
Пример

postBanUserFromComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Отговор
Връща: BanUserFromCommentResult
Пример

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

postBulkPreBanSummary 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| includeByUserIdAndEmail | boolean | query | Не | |
| includeByIP | boolean | query | Не | |
| includeByEmailDomain | boolean | query | Не | |
| sso | string | query | Не |
Отговор
Връща: BulkPreBanSummary
Пример

postCommentsByIds 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Отговор
Returns: ModerationAPIChildCommentsResponse
Пример

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

postRemoveComment 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: PostRemoveCommentApiResponse
Example

postRestoreDeletedComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Returns: APIEmptyResponse
Пример

postSetCommentApprovalStatus 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: SetCommentApprovedResponse
Пример

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

postSetCommentSpamStatus 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

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

postUnFlagComment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Returns: APIEmptyResponse
Пример

postVote 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: VoteResponse
Пример

putAwardBadge 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: AwardUserBadgeResponse
Пример

putCloseThread 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

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

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

setTrustFactor 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Отговор
Връща: SetUserTrustFactorResponse
Пример

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

deleteModerator 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| sendEmail | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

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

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

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

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

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

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

getNotificationCount 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Отговор
Връща: GetNotificationCountResponse
Пример

getNotifications 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Отговор
Returns: GetNotificationsResponse
Пример

updateNotification 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Returns: APIEmptyResponse
Пример

createV1PageReact 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| title | string | query | Не |
Отговор
Връща: CreateV1PageReact
Пример

createV2PageReact 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| id | string | query | Да | |
| title | string | query | Не |
Отговор
Връща: CreateV1PageReact
Пример

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

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

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

getV2PageReacts 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Отговор
Връща: GetV2PageReacts
Пример

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

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

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

getOfflineUsers 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Използвайте това след като изчерпите /users/online, за да покажете секция „Members“.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Курсорна пагинация по commenterName: сървърът обхожда частичния {tenantId, urlId, commenterName} индекс от afterName напред чрез $gt, без разход за $skip.
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Идентификатор за URL на страницата (почистен от сървъра). |
| afterName | string | query | No | Курсор: предайте nextAfterName от предишния отговор. |
| afterUserId | string | query | No | Курсор за разрешаване на равенства: предайте nextAfterUserId от предишния отговор. Задължително, когато е зададен afterName, за да равенствата по име не премахват записите. |
Отговор
Връща: PageUsersOfflineResponse
Пример

getOnlineUsers 
Текущо онлайн зрители на страница: хора, чиито уебсокет сесии са абонирани за страницата в момента.
Връща anonCount + totalCount (абонати в цялата стая, включително анонимни зрители, които не изброяваме).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Идентификатор на URL на страницата (почистен от сървъра). |
| afterName | string | query | No | Курсор: предайте nextAfterName от предишния отговор. |
| afterUserId | string | query | No | Тайбрейк на курсора: предайте nextAfterUserId от предишния отговор. Задължително, когато afterName е зададен, за да не се изпускат записи при равни имена. |
Response
Returns: PageUsersOnlineResponse
Example

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

getPages 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Отговор
Returns: GetPagesAPIResponse
Пример

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Непрозрачен курсор за странициране, върнат като nextCursor от предишна заявка. Свързан със същия sortBy. |
| limit | integer | query | No | 1..200, по подразбиране 50 |
| q | string | query | No | Незадължителен филтър за префикс на заглавието, без значение на главни/малки букви. |
| sortBy | string | query | No | Ред на сортиране. updatedAt (по подразбиране, най-новите първи), commentCount (най-много коментари първи), или title (по азбучен ред). |
| hasComments | boolean | query | No | Ако е true, връща само страници с поне един коментар. |
Response
Returns: GetPublicPagesResponse
Example

getUsersInfo 
Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Използва се от уиджетa за коментари, за да обогати потребителите, които току‑що се появиха чрез събитие за присъствие.
Без контекст на страница: поверителността се прилага еднородно (частните профили се маскират).
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | UserIds, разделени със запетая. |
Response
Returns: PageUsersInfoResponse
Example

patchPage 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Returns: PatchPageAPIResponse
Пример

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

getPendingWebhookEventCount 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Отговор
Връща: GetPendingWebhookEventCountResponse
Пример

getPendingWebhookEvents 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Отговор
Връща: GetPendingWebhookEventsResponse
Пример

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

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

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

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

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

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

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

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

getQuestionResults 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Response
Returns: GetQuestionResultsResponse
Example

updateQuestionResult 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Returns: APIEmptyResponse
Пример

aggregateQuestionResults 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Отговор
Връща: AggregateQuestionResultsResponse
Пример

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

combineCommentsWithQuestionResults 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Отговор
Връща: CombineQuestionResultsWithCommentsResponse
Пример

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

deleteSSOUser 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Отговор
Връща: DeleteSSOUserAPIResponse
Пример

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

getSSOUserById 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: GetSSOUserByIdAPIResponse
Пример

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

patchSSOUser 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Отговор
Returns: PatchSSOUserAPIResponse
Пример

putSSOUser 
Параметри
| Име | Тип | Location | Required | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Отговор
Returns: PutSSOUserAPIResponse
Пример

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

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

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

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

getTenantDailyUsages 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Response
Връща: GetTenantDailyUsagesResponse
Example

createTenantPackage 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Отговор
Връща: CreateTenantPackageResponse
Пример

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

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

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

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

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

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

deleteTenantUser 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

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

getTenantUsers 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Returns: GetTenantUsersResponse
Пример

replaceTenantUser 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Отговор
Returns: APIEmptyResponse
Пример

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

updateTenantUser 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

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

deleteTenant 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sure | string | query | Не |
Отговор
Returns: APIEmptyResponse
Пример

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

getTenants 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Отговор
Връща: GetTenantsResponse
Пример

updateTenant 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: APIEmptyResponse
Пример

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

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

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

getTickets 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Response
Връща: GetTicketsResponse
Example

getTranslations 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Response
Returns: GetTranslationsResponse
Example

uploadImage 
Upload and resize an image
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Предварително зададен размер: "Default" (1000x1000px) или "CrossPlatform" (създава размери за популярни устройства) |
| urlId | string | query | No | Идентификатор на страницата, от която се извършва качването, за конфигуриране |
Response
Връща: UploadImageResponse
Example

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

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

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

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

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

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

getUserBadges 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Отговор
Връща: APIGetUserBadgesResponse
Пример

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

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

getUserNotifications 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Използва се за определяне дали текущата страница е абонирана. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Отговор
Връща: GetMyNotificationsResponse
Пример

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

resetUserNotifications 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Не | |
| afterCreatedAt | integer | query | Не | |
| unreadOnly | boolean | query | Не | |
| dmOnly | boolean | query | Не | |
| noDm | boolean | query | Не | |
| sso | string | query | Не |
Отговор
Returns: ResetUserNotificationsResponse
Пример

updateUserNotificationCommentSubscriptionStatus 
Enable or disable notifications for a specific comment.
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| optedInOrOut | string | path | Да | |
| commentId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationCommentSubscriptionStatusResponse
Пример

updateUserNotificationPageSubscriptionStatus 
Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| url | string | query | Да | |
| pageTitle | string | query | Да | |
| subscribedOrUnsubscribed | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationPageSubscriptionStatusResponse
Пример

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

getUserPresenceStatuses 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
Отговор
Връща: GetUserPresenceStatusesResponse
Пример

searchUsers 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Отговор
Връща: SearchUsersResult
Пример

getUser 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: GetUserResponse
Пример

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

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

getVotes 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Отговор
Връща: GetVotesResponse
Пример

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

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