
Език 🇧🇬 Български
Първи стъпки
Документация
Използване
Агрегиране
Логове за одит
Аутентификация
Блокиране от коментар
Проверка на блокирани коментари
Коментари
Коментари за потребителя
Конфигурации на домейни
Имейл шаблони
Дневник на събитията
Публикации в емисията
Сигнализиране на коментар
Гифове
Хаштагове
Модерация
Модератори
Брой известия
Известия
Реакции на страница
Страници
Очакващи Webhook събития
Конфигурации на въпроси
Резултати от въпроси
Агрегиране на резултати от въпроси
SSO потребители
Абонаменти
Дневна употреба на тенант
Пакети на тенант
Потребители на тенант
Тенанти
Тикети
Преводи
Качване на изображение
Напредък на значки на потребителя
Потребителски значки
Известия за потребителя
Статуси на присъствие на потребителя
Търсене на потребители
Потребители
Гласове
FastComments Ruby SDK
Това е официалният Ruby SDK за FastComments.
Официален Ruby SDK за API на FastComments
Репозитория
Инсталиране 
Add this line to your application's Gemfile:
gem 'fastcomments'
And then execute:
bundle install
Or install it yourself as:
gem install fastcomments
Library Contents
Тази библиотека съдържа генерирания клиент за API и SSO инструменти, които улесняват работата с API.
Public vs Secured APIs
За клиентския API има три класа – DefaultApi, PublicApi и ModerationApi. DefaultApi съдържа методи, които изискват вашия API ключ, а PublicApi съдържа API повиквания, които могат да се направят директно от браузър/мобилно устройство/и т.н. без удостоверяване. ModerationApi съдържа методите, които захранват таблото за модератори.
ModerationApi предоставя обширен набор от живи и бързи API за модериране. Всеки метод на ModerationApi приема параметър sso и може да се удостоверява чрез SSO или с бисквитка от сесия на FastComments.com.
Бърз старт 
Използване на удостоверени API (DefaultApi)
Важно: Трябва да зададете вашия API ключ на ApiClient преди да правите удостоверени заявки. Ако не го направите, заявките ще се провалят с грешка 401.
require 'fastcomments'
# Create and configure the API client
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# Create the API instance with the configured client
api = FastCommentsClient::DefaultApi.new(api_client)
# Now you can make authenticated API calls
begin
# Example: Add an SSO user
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# Common errors:
# - 401: API key is missing or invalid
# - 400: Request validation failed
end
Използване на публични API (PublicApi)
Публичните крайни точки не изискват удостоверяване:
require 'fastcomments'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
'YOUR_TENANT_ID',
'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Използване на Модерационни API (ModerationApi)
Методите за модерация захранват таблото на модератора. Предайте sso токен, за да бъде заявката изпратена от името на модератор, удостоверен чрез SSO:
require 'fastcomments'
moderation_api = FastCommentsClient::ModerationApi.new
begin
# Example: List comments in the moderation queue
response = moderation_api.get_api_comments(
sso: 'YOUR_MODERATOR_SSO_TOKEN'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Чести проблеми
- 401 "missing-api-key" грешка: Уверете се, че сте задали
config.api_key['x-api-key'] = 'YOUR_KEY'преди да създадете инстанция на DefaultApi. - Грешен API клас: Използвайте
DefaultApiза сървърни удостоверени заявки,PublicApiза клиентски/публични заявки иModerationApiза заявки към таблото на модератора. - Нулев API ключ: SDK ще пропусне удостоверяването без да даде съобщение, ако API ключът е null, което води до грешки 401.
Бележки 
Идентификатори на предавания
Ще видите, че трябва да предавате broadcastId в някои API повиквания. Когато получите събития, ще получите този ID обратно, така че да знаете да игнорирате събитието, ако планирате да приложите промените оптимистично на клиента
(което вероятно ще искате да направите, тъй като осигурява най-доброто преживяване). Предайте тук UUID. ID-то трябва да е достатъчно уникално, за да не се появи два пъти в рамките на сесия на браузъра.
SSO (Еднократно влизане)
За примери за SSO, вижте по-долу.
Използване на SSO 
Проста SSO
require 'fastcomments'
# Създаване на прост SSO токен
user = FastComments::SSO::SimpleSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
avatar: 'https://example.com/avatar.jpg'
)
sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token
puts "SSO Token: #{token}"
# Използване на SSO токена за извършване на удостоверен API повикване
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
'your-tenant-id',
'your-page-url-id',
sso: token
)
puts "Status: #{response}"
Сигурен SSO
require 'fastcomments'
# Създаване на сигурен SSO токен
user = FastComments::SSO::SecureSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
username: 'johndoe',
avatar: 'https://example.com/avatar.jpg'
)
api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token
puts "Secure SSO Token: #{token}"
# Използване на SSO токена за извършване на удостоверен API повикване
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
'your-tenant-id',
'your-page-url-id',
sso: token
)
puts "Status: #{response}"
aggregate 
Агрегира документи чрез групиране (ако е посочено groupBy) и прилагане на множество операции. Поддържат се различни операции (например sum, countDistinct, avg и т.н.).
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| parentTenantId | string | query | Не | |
| includeStats | boolean | query | Не |
Отговор
Връща: AggregateResponse
Пример

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

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

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

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

checked_comments_for_blocked 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentIds | string | query | Да | Списък с идентификатори на коментари, разделени със запетаи. |
| sso | string | query | Не |
Отговор
Връща: CheckBlockedCommentsResponse
Пример

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

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

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

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

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

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

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

get_comment_text 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: PublicAPIGetCommentTextResponse
Пример

get_comment_vote_user_names 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| dir | integer | query | Да | |
| sso | string | query | Не |
Отговор
Връща: GetCommentVoteUserNamesSuccessResponse
Пример

get_comments 
Параметри
| 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 | Не | |
| fromDate | integer | query | Не | |
| toDate | integer | query | Не |
Отговор
Връща: APIGetCommentsResponse
Пример

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

lock_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | път | Да | |
| commentId | string | път | Да | |
| broadcastId | string | заявка | Да | |
| sso | string | заявка | Не |
Отговор
Връща: APIEmptyResponse
Пример

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

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

save_comments_bulk 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| isLive | boolean | query | Не | |
| doSpamCheck | boolean | query | Не | |
| sendEmails | boolean | query | Не | |
| populateNotifications | boolean | query | Не |
Отговор
Връща: SaveCommentsBulkResponse
Пример

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

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

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

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

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

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

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

get_comments_for_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

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

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

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

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

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

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

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

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

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

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

get_email_template_render_errors 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| skip | number | query | Не |
Отговор
Връща: GetEmailTemplateRenderErrorsResponse
Пример

get_email_templates 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetEmailTemplatesResponse
Пример

render_email_template 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| locale | string | query | Не |
Отговор
Връща: RenderEmailTemplateResponse
Пример

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

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

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

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

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

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

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

get_feed_posts_public 
req tenantId afterId
Параметри
| 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 | Не |
Отговор
Връща: PublicFeedPostsResponse
Пример

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

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

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

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

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

flag_comment_public 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| isFlagged | boolean | query | Да | |
| sso | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

get_gif_large 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| largeInternalURLSanitized | string | query | Да |
Отговор
Връща: GifGetLargeResponse
Пример

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

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

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

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

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

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

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

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

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

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

get_api_ids 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

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

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

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

get_count 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

get_counts 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Response
Returns: GetBannedUsersCountResponse
Example

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

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

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

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

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

get_pre_ban_summary 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

get_search_comments_summary 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Response
Връща: ModerationCommentSearchResponse
Пример

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

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

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

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

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

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

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

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

post_api_export 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Response
Връща: ModerationExportResponse
Пример

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

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

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

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

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

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

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

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

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

post_set_comment_spam_status 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

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

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

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

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

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

put_remove_badge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Връща: RemoveUserBadgeResponse
Example

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

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

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

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

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

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

send_invite 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| fromName | string | query | Да |
Response
Връща: APIEmptyResponse
Example

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

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

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

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

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

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

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

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

delete_v1_page_react 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Отговор
Връща: CreateV1PageReact
Пример

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

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

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

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

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

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

get_offline_users 
Предишни коментирали на страницата, които НЕ са в момента онлайн. Подредени по displayName. Използвайте това след изчерпване на /users/online, за да рендерирате секция "Членове". Пагинация с курсор върху 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
Пример

get_online_users 
Понастоящем онлайн зрители на страница: хора, чиито websocket сесии са абонирани за страницата в този момент. Връща anonCount + totalCount (абонати на стаята, включително анонимни зрители, които не изброяваме).
Параметри
| 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 е зададено, за да не се изпускат записи при еднакви имена. |
Отговор
Връща: PageUsersOnlineResponse
Пример

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

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

get_pages_public 
Изброява страници за наемател. Използва се от десктоп клиента FChat за попълване на своя списък със стаи.
Изисква enableFChat да бъде true в разрешената персонализирана конфигурация за всяка страница.
Страниците, които изискват SSO, се филтрират въз основа на груповия достъп на потребителя, който прави заявката.
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| cursor | string | query | Не | Непрозрачен курсор за пагинация, върнат като nextCursor от предишна заявка. Свързан със същия sortBy. |
| limit | integer | query | Не | 1..200, по подразбиране 50 |
| q | string | query | Не | Незадължителен регистронезависим филтър по префикс на заглавието. |
| sortBy | string | query | Не | Ред на сортиране. updatedAt (по подразбиране, най-новите първи), commentCount (най-много коментари първи) или title (азбучно). |
| hasComments | boolean | query | Не | Ако е true, връща само страници с поне един коментар. |
Отговор
Връща: GetPublicPagesResponse
Пример

get_users_info 
Масова информация за потребители за един наемател. За дадени userIds връща информация за показване от User / SSOUser. Използва се от коментарния widget за обогатяване на потребители, които току-що се появиха чрез presence събитие. Няма контекст на страница: поверителността се прилага по единен начин (частните профили се маскират).
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds, разделени със запетая. |
Отговор
Връща: PageUsersInfoResponse
Пример

patch_page 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Response
Връща: PatchPageAPIResponse
Example

delete_pending_webhook_event 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Response
Връща: APIEmptyResponse
Пример

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

get_pending_webhook_events 
Параметри
| 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 | Не |
Отговор
Връща: GetPendingWebhookEventsResponse
Пример

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

delete_question_config 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Връща
Връща: APIEmptyResponse
Пример

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

get_question_configs 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetQuestionConfigsResponse
Пример

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

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

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

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

get_question_results 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Не | |
| userId | string | query | Не | |
| startDate | string | query | Не | |
| questionId | string | query | Не | |
| questionIds | string | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetQuestionResultsResponse
Пример

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

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

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

combine_comments_with_question_results 
Parameters
| 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 | Не |
Отговор
Връща: CombineQuestionResultsWithCommentsResponse
Пример

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

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

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

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

get_sso_users 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | integer | query | Не |
Отговор
Връща: GetSSOUsersResponse
Пример

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

get_translations 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| namespace | string | path | Да | |
| component | string | path | Да | |
| locale | string | query | Не | |
| useFullTranslationIds | boolean | query | Не |
Отговор
Връща: GetTranslationsResponse
Пример

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

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

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

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

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

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

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

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

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

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

get_user_notifications 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | 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 | Не | |
| includeTenantNotifications | boolean | query | Не | |
| sso | string | query | Не |
Отговор
Връща: GetMyNotificationsResponse
Пример

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

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

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

update_user_notification_page_subscription_status 
Активиране или деактивиране на известия за страница. Когато потребителите са абонирани за страница, се създават известия за нови основни коментари, както и
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| url | string | query | Да | |
| pageTitle | string | query | Да | |
| subscribedOrUnsubscribed | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationPageSubscriptionStatusResponse
Пример

update_user_notification_status 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| newStatus | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationStatusResponse
Пример

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

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

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

create_vote 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Да | |
| direction | string | query | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: VoteResponse
Пример

delete_vote 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| editKey | string | query | Не |
Отговор
Връща: VoteDeleteResponse
Пример

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

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

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