
Језик 🇷🇸 Српски
Почетак рада
Документација
Употреба
Агрегација
Дневник ревизије
Аутентификација
Блокирање из коментара
Провера блокираних коментара
Коментари
Коментари корисника
Конфигурације домена
Шаблони е-поште
Дневник догађаја
Објаве фида
Пријави коментар
Гифови
Хештегови
Модерација
Модератори
Број обавештења
Обавештења
Реакције странице
Странице
Очекујући webhook догађаји
Конфигурације питања
Резултати питања
Агрегација резултата питања
SSO корисници
Претплате
Дневна употреба тенанта
Пакети тенанта
Корисници тенанта
Тенанти
Тикети
Преводи
Отпремање слике
Напредак значке корисника
Значке корисника
Корисничка обавештења
Статус присутности корисника
Претрага корисника
Корисници
Гласови
FastComments Ruby SDK
Ово је званични Ruby SDK за FastComments.
Званични Ruby SDK за FastComments API
Репозиторијум
Инсталација 
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 сесијског колачића.
Брзи почетак 
Korišćenje autentifikovanih API‑ja (DefaultApi)
Važno: Morate postaviti vaš API ključ u ApiClient pre slanja autentifikovanih zahteva. Ako to ne uradite, zahtevi će propasti uz grešku 401.
require 'fastcomments'
# Kreirajte i konfigurišite API klijent
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# OBAVEZNO: Postavite vaš API ključ (preuzmite ga iz FastComments kontrolne table)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# Kreirajte API instancu sa konfigurisanim klijentom
api = FastCommentsClient::DefaultApi.new(api_client)
# Sada možete izvršavati autentifikovane API pozive
begin
# Primer: Dodavanje SSO korisnika
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}"
# Uobičajene greške:
# - 401: API ključ nedostaje ili je neispravan
# - 400: Validacija zahteva nije uspela
end
Korišćenje javnih API‑ja (PublicApi)
Javni krajnji (public) endpointi ne zahtevaju autentifikaciju:
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
Korišćenje moderacionih API‑ja (ModerationApi)
Metode za moderaciju pokreću moderacijski kontrolni panel. Prosledite sso token kako bi zahtev bio postavljen u ime moderatora autentifikovanog putem SSO:
require 'fastcomments'
moderation_api = FastCommentsClient::ModerationApi.new
begin
# Primer: Lista komentara u moderacionom redu
response = moderation_api.get_api_comments(
sso: 'YOUR_MODERATOR_SSO_TOKEN'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Uobičajeni problemi
- 401 greška "missing-api-key": Uverite se da ste postavili
config.api_key['x-api-key'] = 'YOUR_KEY'pre kreiranja DefaultApi instance. - Pogrešna API klasa: Koristite
DefaultApiza server‑side autentifikovane zahteve,PublicApiza klijentske/javne zahteve, iModerationApiza zahteve moderacijskog kontrolnog panela. - Null API ključ: SDK će tiho preskočiti autentifikaciju ako je API ključ null, što dovodi do grešaka 401.
Напомене 
Broadcast идентификатори
Видећете да треба да проследите broadcastId у неким API позивима. Када примите догађаје, добићете овај ID назад, тако да знате да игноришете догађај ако планирате да оптимистички примените измене на клијенту
(што ћете вероватно желети да урадите јер пружа најбоље корисничко искуство). Проследите UUID овде. ИД би требало да буде довољно јединствен да се не појави два пута у оквиру једне сесије прегледача.
SSO (Једнократна пријава)
За примере SSO-а, погледајте доле.
Коришћење SSO 
Једноставни SSO
require 'fastcomments'
# Креирање Simple 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'
# Креирање Secure 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 итд.).
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| parentTenantId | string | query | Не | |
| includeStats | boolean | query | Не |
Одговор
Враћа: AggregateResponse
Пример

get_audit_logs 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Одговор
Враћа: UnblockSuccess
Пример

checked_comments_for_blocked 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentIds | string | query | Да | Листа идентификатора коментара одвојених зарезом. |
| sso | string | query | Не |
Одговор
Враћа: CheckBlockedCommentsResponse
Пример

block_user_from_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Одговор
Враћа: BlockSuccess
Пример

create_comment_public 
Parametri
| Назив | Тип | Локација | Обavezno | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| sessionId | string | query | Не | |
| sso | string | query | Не |
Одговор
Vraća: 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Локација | Потребно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: PublicAPIGetCommentTextResponse
Пример

get_comment_vote_user_names 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Оpis |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Одговор
Vraća: APIEmptyResponse
Primer

pin_comment 
Параметри
| Име | Тип | Локација | Потребно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: ChangeCommentPinStatusResponse
Пример

save_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: PublicAPISetCommentTextResponse
Пример

un_block_user_from_comment 
Параметри
| Назив | Тип | Локација | Захтевано | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Одговор
Враћа: UnblockSuccess
Пример

un_flag_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Одговор
Враћа: FlagCommentResponse
Пример

un_lock_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

un_pin_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| userId | string | query | Не | |
| direction | string | query | Не | |
| repliesToUserId | string | query | Не | |
| page | number | query | Не | |
| includei10n | boolean | query | Не | |
| locale | string | query | Не | |
| isCrawler | boolean | query | Не |
Одговор
Враћа: GetCommentsForUserResponse
Пример

add_domain_config 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: AddDomainConfigResponse
Пример

delete_domain_config 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Одговор
Враћа: DeleteDomainConfigResponse
Пример

get_domain_config 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Одговор
Враћа: GetDomainConfigResponse
Пример

get_domain_configs 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: GetDomainConfigsResponse
Пример

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

put_domain_config 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Одговор
Враћа: PutDomainConfigResponse
Пример

create_email_template 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateEmailTemplateResponse
Пример

delete_email_template 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

delete_email_template_render_error 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: GetEmailTemplateDefinitionsResponse
Пример

get_email_template_render_errors 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetEmailTemplateRenderErrorsResponse
Пример

get_email_templates 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vraća: APIEmptyResponse
Primer

get_event_log 
req tenantId urlId userIdWS
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Не |
Одговор
Враћа: GetEventLogResponse
Primer

get_global_event_log 
req tenantId urlId userIdWS
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Не |
Одговор
Враћа: GetEventLogResponse
Пример

create_feed_post 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| broadcastId | string | query | Не | |
| isLive | boolean | query | Не | |
| doSpamCheck | boolean | query | Не | |
| skipDupCheck | boolean | query | Не |
Одговор
Враћа: CreateFeedPostsResponse
Пример

create_feed_post_public 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
захтев tenantId afterId
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| isUndo | boolean | query | Не | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: ReactFeedPostResponse
Пример

update_feed_post 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Одговор
Враћа: APIEmptyResponse
Пример

update_feed_post_public 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Одговор
Враћа: GetGifsTrendingResponse
Пример

add_hash_tag 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateHashTagResponse
Пример

add_hash_tags_bulk 
Parameters
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da |
Response
Returns: BulkCreateHashTagsResponse
Primer

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 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Odgovor
Vraća: ModerationAPIGetCommentsResponse
Primer

get_api_export_status 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: 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 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Vraća: GetBannedUsersFromCommentResponse
Primer

get_comment_ban_status 
Parameters
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| sso | string | query | Ne |
Response
Vraća: GetCommentBanStatusResponse
Example

get_comment_children 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| sso | string | query | Ne |
Odgovor
Vraća: ModerationAPIChildCommentsResponse
Primer

get_count 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| 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 |
Odgovor
Vraća: ModerationAPICountCommentsResponse
Primer

get_counts 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Одговор
Враћа: GetBannedUsersCountResponse
Пример

get_logs 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Одговор
Враћа: ModerationAPIGetLogsResponse
Пример

get_manual_badges 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vraća: GetTenantManualBadgesResponse
Primer

get_manual_badges_for_user 
Parameters
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Response
Vraća: GetUserManualBadgesResponse
Primer

get_moderation_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| includeEmail | boolean | query | Не | |
| includeIP | boolean | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: ModerationAPICommentResponse
Пример

get_moderation_comment_text 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| sso | string | query | Ne |
Odgovor
Vraća: GetCommentTextResponse
Primer

get_pre_ban_summary 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| includeByUserIdAndEmail | boolean | query | Не | |
| includeByIP | boolean | query | Не | |
| includeByEmailDomain | boolean | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: PreBanSummary
Пример

get_search_comments_summary 
Параметри
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| value | string | query | Ne | |
| filters | string | query | Ne | |
| searchFilters | string | query | Ne | |
| sso | string | query | Ne |
Одговор
Враћа: ModerationCommentSearchResponse
Пример

get_search_pages 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: ModerationPageSearchResponse
Primer

get_search_sites 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: ModerationSiteSearchResponse
Primer

get_search_suggest 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| text-search | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: ModerationSuggestResponse
Primer

get_search_users 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| value | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: ModerationUserSearchResponse
Primer

get_trust_factor 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: GetUserTrustFactorResponse
Пример

get_user_ban_preference 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vraća: APIModerateGetUserBanPreferencesResponse
Primer

get_user_internal_profile 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: GetUserInternalProfileResponse
Primer

post_adjust_comment_votes 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: AdjustVotesResponse
Primer

post_api_export 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| text-search | string | query | Ne | |
| byIPFromComment | string | query | Ne | |
| filters | string | query | Ne | |
| searchFilters | string | query | Ne | |
| sorts | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: ModerationExportResponse
Primer

post_ban_user_from_comment 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| 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 |
Odgovor
Vraća: BanUserFromCommentResult
Primer

post_ban_user_undo 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vraća: APIEmptyResponse
Primer

post_bulk_pre_ban_summary 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| includeByUserIdAndEmail | boolean | query | Ne | |
| includeByIP | boolean | query | Ne | |
| includeByEmailDomain | boolean | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: BulkPreBanSummary
Primer

post_comments_by_ids 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Одговор
Враћа: ModerationAPIChildCommentsResponse
Пример

post_flag_comment 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: APIEmptyResponse
Primer

post_remove_comment 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: PostRemoveCommentApiResponse
Primer

post_restore_deleted_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: APIEmptyResponse
Пример

post_set_comment_approval_status 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: SetCommentApprovedResponse
Primer

post_set_comment_review_status 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: APIEmptyResponse
Primer

post_set_comment_spam_status 
Параметри
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| spam | boolean | query | Ne | |
| permNotSpam | boolean | query | Ne | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Одговор
Враћа: APIEmptyResponse
Пример

post_set_comment_text 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: SetCommentTextResponse
Пример

post_un_flag_comment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: APIEmptyResponse
Пример

post_vote 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| commentId | string | path | Da | |
| direction | string | query | Ne | |
| broadcastId | string | query | Ne | |
| sso | string | query | Ne |
Odgovor
Vraća: VoteResponse
Primer

put_award_badge 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: AwardUserBadgeResponse
Primer

put_close_thread 
Parameters
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| urlId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vraća: APIEmptyResponse
Primer

put_remove_badge 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: RemoveUserBadgeResponse
Пример

put_reopen_thread 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| urlId | string | query | Da | |
| sso | string | query | Ne |
Odgovor
Vraća: APIEmptyResponse
Primer

set_trust_factor 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Odgovor
Vraća: SetUserTrustFactorResponse
Primer

create_moderator 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateModeratorResponse
Пример

delete_moderator 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sendEmail | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

get_moderator 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Враћа
Враћа: GetModeratorResponse
Пример

get_moderators 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetModeratorsResponse
Пример

send_invite 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| fromName | string | query | Да |
Одговор
Враћа: APIEmptyResponse
Пример

update_moderator 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

delete_notification_count 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_cached_notification_count 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vraća: GetCachedNotificationCountResponse
Primer

get_notification_count 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| urlId | string | query | Не | |
| fromCommentId | string | query | Не | |
| viewed | boolean | query | Не | |
| type | string | query | Не |
Одговор
Враћа: GetNotificationCountResponse
Пример

get_notifications 
Параметри
| Name | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| urlId | string | query | Не | |
| fromCommentId | string | query | Не | |
| viewed | boolean | query | Не | |
| type | string | query | Не | |
| skip | number | query | Не |
Одговор
Враћа: GetNotificationsResponse
Пример

update_notification 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne |
Odgovor
Vraća: APIEmptyResponse
Primer

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 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Одговор
Враћа: CreateV1PageReact
Пример

delete_v2_page_react 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да |
Одговор
Враћа: GetV2PageReacts
Пример

add_page 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: AddPageAPIResponse
Пример

delete_page 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 | Да | |
| urlId | string | query | Да | Идентификатор URL странице (очишћен на серверу). |
| afterName | string | query | Не | Курсор: проследите nextAfterName из претходног одговора. |
| afterUserId | string | query | Не | Курсор-тјебрејкер: проследите nextAfterUserId из претходног одговора. Обавезно када је afterName подешен како се у случају истих имена уноси не би изгубили. |
Одговор
Враћа: PageUsersOnlineResponse
Пример

get_page_by_urlid 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Одговор
Враћа: GetPageByURLIdAPIResponse
Пример

get_pages 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Пакетне информације о корисницима за tenant. За дате userIds, враћа информације за приказ из User / SSOUser. Користи се у виџету коментара да обогати кориснике који су се управо појавили путем догађаја присутности. Нема контекста странице: приватност се примењује уједначено (приватни профили су сакривени).
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| ids | string | query | Да | userIds раздвојени зарезом. |
Одговор
Враћа: PageUsersInfoResponse
Пример

patch_page 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: PatchPageAPIResponse
Пример

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

get_pending_webhook_event_count 
Параметри
| 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 | Не |
Одговор
Враћа: GetPendingWebhookEventCountResponse
Пример

get_pending_webhook_events 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_question_config 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetQuestionConfigResponse
Пример

get_question_configs 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetQuestionConfigsResponse
Пример

update_question_config 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

create_question_result 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateQuestionResultResponse
Пример

delete_question_result 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_question_result 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetQuestionResultResponse
Пример

get_question_results 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vraća: APIEmptyResponse
Primer

aggregate_question_results 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| questionId | string | query | Не | |
| questionIds | array | query | Не | |
| urlId | string | query | Не | |
| timeBucket | string | query | Не | |
| startDate | string | query | Не | |
| forceRecalculate | boolean | query | Не |
Одговор
Враћа: AggregateQuestionResultsResponse
Пример

bulk_aggregate_question_results 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| forceRecalculate | boolean | query | Не |
Одговор
Враћа: BulkAggregateQuestionResultsResponse
Пример

combine_comments_with_question_results 
Параметри
| 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: AddSSOUserAPIResponse
Пример

delete_sso_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Да | |
| string | path | Да |
Одговор
Враћа: GetSSOUserByEmailAPIResponse
Пример

get_sso_user_by_id 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odgovor
Vraća: GetSSOUserByIdAPIResponse
Primer

get_sso_users 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | integer | query | No |
Одговор
Враћа: GetSSOUsersResponse
Пример

patch_sso_user 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Одговор
Враћа: PatchSSOUserAPIResponse
Пример

put_sso_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Одговор
Враћа: PutSSOUserAPIResponse
Пример

create_subscription 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateSubscriptionAPIResponse
Пример

delete_subscription 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Одговор
Враћа: DeleteSubscriptionAPIResponse
Пример

get_subscriptions 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не |
Респонс
Враћа: GetSubscriptionsAPIResponse
Пример

update_subscription 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Response
Враћа: 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 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

get_tenant_package 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetTenantPackageResponse
Пример

get_tenant_packages 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetTenantPackagesResponse
Пример

replace_tenant_package 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

update_tenant_package 
Parametri
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vraća: APIEmptyResponse
Primer

create_tenant_user 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: CreateTenantUserResponse
Пример

delete_tenant_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetTenantUsersResponse
Пример

replace_tenant_user 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Response
Враћа: APIEmptyResponse
Пример

send_login_link 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| redirectURL | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

update_tenant_user 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Одговор
Враћа: APIEmptyResponse
Пример

create_tenant 
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| meta | string | query | Не | |
| skip | number | query | Не |
Одговор
Враћа: GetTenantsResponse
Пример

update_tenant 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da |
Odgovor
Vraća: APIEmptyResponse
Primer

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

create_ticket 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Да |
Одговор
Враћа: CreateTicketResponse
Пример

get_ticket 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Otpremanje i promena veličine slike
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Da | |
| sizePreset | string | query | Ne | Podešavanje veličine: "Default" (1000x1000px) ili "CrossPlatform" (kreira veličine za popularne uređaje) |
| urlId | string | query | Ne | ID stranice sa koje se vrši otpremanje, za konfiguraciju |
Odgovor
Vraća: UploadImageResponse
Primer

get_user_badge_progress_by_id 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIGetUserBadgeProgressResponse
Пример

get_user_badge_progress_by_user_id 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | path | Да |
Одговор
Враћа: APIGetUserBadgeProgressResponse
Пример

get_user_badge_progress_list 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| limit | number | query | Не | |
| skip | number | query | Не |
Одговор
Враћа: APIGetUserBadgeProgressListResponse
Пример

create_user_badge 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: APICreateUserBadgeResponse
Пример

delete_user_badge 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptySuccessResponse
Пример

get_user_badge 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIGetUserBadgeResponse
Пример

get_user_badges 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: APIEmptySuccessResponse
Пример

get_user_notification_count 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: GetUserNotificationCountResponse
Пример

get_user_notifications 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 
Омогући или онемогући обавештења за страницу. Када су корисници претплаћени на страницу, обавештења се креирају за нове коренске коментаре, и такође
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| url | string | query | Да | |
| pageTitle | string | query | Да | |
| subscribedOrUnsubscribed | string | path | Да | |
| sso | string | query | Не |
Одговор
Враћа: UpdateUserNotificationPageSubscriptionStatusResponse
Пример

update_user_notification_status 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | упит | Да | |
| notificationId | string | путања | Да | |
| newStatus | string | путања | Да | |
| sso | string | упит | Не |
Одговор
Враћа: 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 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: 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 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Одговор
Враћа: GetVotesForUserResponse
Пример

Треба помоћ?
Ако наиђете на проблеме или имате питања у вези са Ruby SDK-ом, молимо вас:
Допринес
Допринеси су добродошли! Молимо посетите репозиторијум на GitHub-у за смернице о доприносу.