
Језик 🇷🇸 Српски
Документација
Започните
API референца
Тенанти агената
Агрегат
Аудит логови
Аутентикација
Батч послови
Блокирање из коментара
Провера блокираних коментара
Коментари
Коментари за корисника
Конфигурације домена
Шаблони е-поште
Дневник догађаја
Објаве у фиду
Пријави коментар
Гифови
Хеш ознаке
Ја
Модерација
Модератори
Број обавештења
Обавештења
Реакције на страницу
Странице
Текући вебхук догађаји
Гласање у анкетама
Анкете
Конфигурације питања
Резултати питања
Агрегација резултата питања
SSO корисници
Претплате
Дневна употреба тенаната
Пакети тенаната
Корисници тенаната
Тенанти
Тикети
Преводи
Отпремање слике
Напредак значке корисника
Значке корисника
Обавештења корисника
Статус присутности корисника
Претрага корисника
Корисници
Гласање
Вебхукови
FastComments Swift SDK
Ово је званични Swift SDK за FastComments.
Званични Swift SDK за FastComments API
Репозиторијум
AI агенти за кодирање 
Дајте вашем кодујућем агенту FastComments контекст који му је потребан - виџети, конфигурација, Secure SSO, REST API и SDK‑ови:
npx skills add fastcomments/skills
Ради са Claude Code, Codex, Cursor, Copilot, Gemini, и свим осталим агентима које подржава skills CLI.
Инсталација 
Swift Package Manager
Додајте следеће у вашу Package.swift датотеку:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Или у Xcode-у:
- File > Add Packages...
- Унесите URL репозиторијума:
https://github.com/fastcomments/fastcomments-swift.git - Изаберите верзију коју желите да користите
Захтеви
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Садржај библиотеке 
The FastComments Swift SDK се састоји од неколико модула:
-
Client модул - API клијент за FastComments REST API-је
- Комплетне дефиниције типова за све API моделе
- Аутентификоване (
DefaultAPI), јавне (PublicAPI) и методе за модерацију (ModerationAPI) - Пуна подршка за async/await
- Погледајте client/README.md за детаљну API документацију
-
SSO модул - алатке за Single Sign-On на серверској страни
- Сигурна генерација токена за аутентификацију корисника
- Подршка за оба режима SSO: једноставан и сигуран
- Потписивање токена засновано на HMAC-SHA256 уз коришћење CryptoKit
Брзи почетак 
Коришћење јавног API-ја
import FastCommentsSwift
// Fetch comments for a page
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Коришћење аутентификованог API-ја
import FastCommentsSwift
// Configure your API key on the shared configuration (sent as the x-api-key header)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Fetch comments using authenticated API
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Коришћење API-ја за модерацију
import FastCommentsSwift
// Moderation methods are authorized with an `sso` token for the acting moderator
// (generate it with FastCommentsSSO, see the SSO section above).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Коришћење SSO за аутентификацију
Сигурни SSO (Препоручено за продукцију)
import FastCommentsSwift
let apiKey = "your-api-key"
// Create secure SSO user data (server-side only!)
let userData = SecureSSOUserData(
id: "user-123", // User ID
email: "user@example.com", // Email
username: "johndoe", // Username
avatar: "https://example.com/avatar.jpg" // Avatar URL
)
// Generate SSO token
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Pass this token to your frontend for authentication
} catch {
print("Error creating SSO token: \(error)")
}
Једноставни SSO (За развој/тестирање)
import FastCommentsSwift
// Create simple SSO user data (no API key needed)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Generate simple SSO token
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API клијенти 
FastComments SDK пружа три API клијента:
PublicAPI - Метoде безбедне за клијент
PublicAPI садржи методе које је безбедно позивати из кода на страни клијента (iOS/macOS апликације). Ове методе:
- Не захтевају API кључ
- Могу користити SSO токене за аутентификацију
- Ограничене су по броју захтева по кориснику/уређају
- Погодне су за апликације усмерене према крајњим корисницима
Пример употребе: Прибављање и креирање коментара у вашој iOS апликацији
DefaultAPI - Методе на страни сервера
DefaultAPI садржи аутентификоване методе које захтевају API кључ. Ове методе:
- Захтевају ваш FastComments API кључ
- Треба их позивати ИСКЉУЧИВО из кода на страни сервера
- Омогућавају пун приступ вашим FastComments подацима
- Ограничене су по броју захтева по тенанту
Пример употребе: Административне операције, масовни извоз података, управљање корисницима
ModerationAPI - Методе табле модератора
ModerationAPI пружа обиман сет живих и брзих API‑ја за модерацију. Сваки метод ModerationAPI прихвата параметар sso и може се аутентификовати преко SSO или FastComments.com колачића сесије.
Пример употребе: Изградња искуства модерације за модераторе ваше заједнице
ВАЖНО: Никада не откривајте ваш API кључ у коду на страни клијента. API кључеви треба да се користе само на страни сервера.
Извожење API позива 
Swift SDK користи модерну async/await синтаксу за све API позиве:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Уобичајени проблеми 
401 Неовлашћене грешке
Ако добијате 401 грешке приликом коришћења аутентификованог API-ја:
- Проверите ваш API кључ: Уверите се да користите тачан API кључ са вашег FastComments контролног панела
- Проверите tenant ID: Уверите се да ID тенанта одговара вашем налогу
- API key format: API кључ треба да буде постављен као
x-api-keyзаглавље у заједничкој конфигурацији:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Using the wrong API: Уверите се да користите
DefaultAPI(а неPublicAPI) за аутентификоване позиве
Проблеми са SSO токенима
Ако SSO токени не раде:
- Use secure mode for production: Увек користите
FastCommentsSSO.createSecure()са вашим API кључем за продукцију - Server-side only: Генеришите безбедне SSO токене на вашем серверу, никада не излагайте ваш API кључ клијентима
- Check user data: Уверите се да су сви потребни поља (id, email, username) достављени
- Token expiration: Безбедни SSO токени садрже временски печат и могу истећи. Генеришите нове токене по потреби.
SSL/TLS грешке
Ако наиђете на SSL/TLS грешке:
- Уверите се да ваш Info.plist дозвољава HTTPS везе ка fastcomments.com
- Проверите да не користите искључења App Transport Security која могу блокирати везу
Белешке 
Broadcast ID-ovi
Videćete da treba da prosledite broadcastId u nekim API позивима. Када примате догађаје, добићете овај ID назад, па ћете знати да игноришете догађај ако планирате оптимистично применити измене на клијенту (што ћете вероватно желети да урадите, јер пружа најбоље корисничко искуство). Проследите овде UUID. ID би требало да буде довољно јединствен да се не појави два пута у току сесије.
let broadcastId = UUID().uuidString
createAgentTenant 
Креира нови пробни налог за AI агента без људске регистрације. За позив није потребан API кључ.
Одговор садржи ID закупца, API кључ који одмах функционише против REST API‑ја и MCP сервера, као и URL за преузимање. Дайте URL за преузимање особи за коју радите: отварање док сте пријављени у FastComments везује налог за њих. Непреузети налози и њихови кључеви се бришу 72 сата након креирања. До преузимања, налог има стандардна пробна ограничења.
Response
Returns: CreateAgentTenantResponse
Example

агрегат 
Агрегира документе груписањем (ако је наведен groupBy) и примењивањем више операција.
Подржане су различите операције (нпр. sum, countDistinct, avg, итд.).
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Одговор
Враћа: AggregateResponse
Пример

getAuditLogs 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | Тенант за који се читају аудиторски записи. |
| limit | integer | query | No | Колико записа да се врати. Максимум 10000, подразумевано 1000. |
| skip | integer | query | No | Колико записа да се прескочи, за пагинацију. |
| order | string | query | No | Смер сортирања по времену догађаја. Подразумевано DESC (најновији први). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | Враћа само догађаје извршене од стране овог корисничког имена. |
| ip | string | query | No | Враћа само догађаје са ове IP адресе. |
| crudType | string | query | No | Враћа само догађаје овог типа: c, r, u, d, или login. |
| resourceName | string | query | No | Враћа само догађаје за овај ресурс, нпр. User или Moderator. |
| targetId | string | query | No | Враћа само догађаје чији је утицани објекат има овај ID. |
| target | string | query | No | Поклапање подстринга без разликовања величине слова на ознаци утицаног објекта, нпр. корисничко име или е‑mail. |
| includeManagedTenants | boolean | query | No | Такође враћа догађаје од тенаната које овај тенант управља. |
Одговор
Враћа: GetAuditLogsResponse
Пример

logoutPublic 
Одговор
Враћа: APIEmptyResponse
Пример

getBatchJob 
Статус, напредак и, када се заврши, резултат једног пакетног посла.
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Одговор
Враћа: GetBatchJobAPIResponse
Пример

getBatchJobs 
Партијски послови закупца (увози, извози, миграције страница...), прво најновије.
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| type | string | query | No | Само послови овог типа, на пример migrate-pages. |
| status | string | query | No | Само послови у овом статусу: requested, running, success или failed. |
| skip | integer | query | No | Колико послова треба прескочити, за пагинацију. |
Одговор
Враћа: GetBatchJobsAPIResponse
Пример

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

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

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

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

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

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

deleteCommentPublic 
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Response
Враћа: PublicAPIDeleteCommentResponse
Пример

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

flagComment 
Parameters
| Ime | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Da | |
| id | string | path | Da | |
| userId | string | query | Ne | |
| anonUserId | string | query | Ne |
Response
Враћа: FlagCommentResponse
Example

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

getComments 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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
Пример

getCommentsPublic 
req tenantId urlId
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No | |
| questionId | string | query | No | |
| questionValue | integer | query | No |
Одговор
Враћа: GetCommentsResponseWithPresencePublicComment
Пример

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

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

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

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

saveComment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Одговор
Враћа: APISaveCommentResponse
Пример

saveCommentsBulk 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Одговор
Враћа: [SaveCommentsBulkResponse]
Пример

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

translateComments 
Преводи дате коментаре у локализацију виџета. Доступно је само када одговарајуће правило прилагођавања виџета има подешену Превод коментара на Аутоматски или Ручни.
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| sso | string | query | Не | |
| locale | string | query | Не |
Response
Returns: CommentTranslationsResponse
Example

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

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

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

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

updateComment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path Yes | ||
| contextUserId | string | query No | ||
| doSpamCheck | boolean | query No | ||
| isLive | boolean | query No |
Одговор
Враћа: APIEmptyResponse
Пример

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

getCommentsForUser 
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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 |
Response
Враћа: GetCommentsForUserResponse
Example

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

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

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

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

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

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

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

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

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

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

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

getEmailTemplateRenderErrors 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| skip | number | query | Не |
Одговор
Враћа: GetEmailTemplateRenderErrorsResponse
Пример

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

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

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

getEventLog 
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
Пример

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

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

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

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

getFeedPosts 
req tenantId afterId
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Не | |
| limit | integer | query | Не | |
| tags | array | query | Не |
Одговор
Враћа: GetFeedPostsResponse
Пример

getFeedPostsPublic 
req tenantId afterId
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| afterId | string | query | Не | |
| limit | integer | query | Не | |
| tags | array | query | Не | |
| sso | string | query | Не | |
| isCrawler | boolean | query | Не | |
| includeUserInfo | boolean | query | Не |
Одговор
Враћа: PublicFeedPostsResponse
Пример

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

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

reactFeedPostPublic 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Одговор
Returns: ReactFeedPostResponse
Пример

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

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

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

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

getGifsSearch 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| search | string | query | Да | |
| locale | string | query | Не | |
| rating | string | query | Не | |
| page | number | query | Не |
Одговор
Враћа: GetGifsSearchResponse
Пример

getGifsTrending 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| locale | string | query | Не | |
| rating | string | query | Не | |
| page | number | query | Не |
Одговор
Враћа: GetGifsTrendingResponse
Пример

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

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

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

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

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

getMe 
Идентификује кориснички акредитив у употреби: tenant коме припада и, за OAuth токене, корисника који га је ауторизовао.
Интеграције користе ово за тестирање везе и означавање.
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: GetMeResponse
Пример

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

getApiComments 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Одговор
Returns: ModerationAPIGetCommentsResponse
Пример

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

getApiIds 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Одговор
Враћа: ModerationAPIGetCommentIdsResponse
Пример

getBanUsersFromComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Враћа: GetBannedUsersFromCommentResponse
Example

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

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

getCount 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| text-search | string | query | Не | |
| byIPFromComment | string | query | Не | |
| filter | string | query | Не | |
| searchFilters | string | query | Не | |
| demo | boolean | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: ModerationAPICountCommentsResponse
Пример

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

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

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

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

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

getModerationCommentText 
Parametri
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Odgovor
Vraća: GetCommentTextResponse
Primer

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

getSearchCommentsSummary 
Параметри
| 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 |
Одговор
Returns: ModerationCommentSearchResponse
Пример

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

getSearchSites 
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| value | string | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: ModerationSiteSearchResponse
Пример

getSearchSuggest 
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| text-search | string | query | Не | |
| sso | string | query | Не |
Response
Враћа: ModerationSuggestResponse
Пример

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

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

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

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

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

postApiExport 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| text-search | string | query | Не | |
| byIPFromComment | string | query | Не | |
| filters | string | query | Не | |
| searchFilters | string | query | Не | |
| sorts | string | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: ModerationExportResponse
Пример

postBanUserFromComment 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| banEmail | boolean | query | Не | |
| banEmailDomain | boolean | query | Не | |
| banIP | boolean | query | Не | |
| deleteAllUsersComments | boolean | query | Не | |
| bannedUntil | string | query | Не | |
| isShadowBan | boolean | query | Не | |
| updateId | string | query | Не | |
| banReason | string | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: BanUserFromCommentResult
Пример

postBanUserUndo 
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Враћа: APIEmptyResponse
Пример

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

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

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

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

postRestoreDeletedComment 
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Response
Returns: APIEmptyResponse
Пример

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

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

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

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

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

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

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

putCloseThread 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| sso | string | query | Не |
Одговор
Returns: APIEmptyResponse
Пример

putRemoveBadge 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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
Пример

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

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

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

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

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

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

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

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

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

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

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

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

updateNotification 
Parameters
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Response
Враћа: APIEmptyResponse
Example

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

createV2PageReact 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No | |
| sso | string | query | No |
Одговор
Враћа: CreateV1PageReact
Пример

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

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

getV1PageLikes 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| sso | string | query | Не | |
| includeUserInfo | string | query | Не | Када је постављено, враћа кориснике који су лајковали страницу (аватаре и корисничка имена). Прихваћено је само "public", што изоставља приватне профиле. |
Одговор
Враћа: GetV1PageLikes
Пример

getV2PageReacts 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Када је постављено, враћа кориснике за сваки react id (аватари и корисничка имена). Само "public" је прихваћено, што изоставља приватне профиле. |
Одговор
Враћа: GetV2PageReacts
Пример

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

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

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

getOfflineUsers 
Прошли коментатори на страници који ТРЕНУТНО НИСУ на мрежи. Сортирани по displayName. Користите ово након што исцрпите /users/online за приказ секције „Members". Пагинација помоћу курсора по commenterName: сервер пролази кроз парцијални {tenantId, urlId, commenterName} индекс од afterName напред помоћу $gt, без трошка $skip.
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | Идентификатор URL-а странице (очишћен на серверу). |
| afterName | string | query | Не | Курсор: проследите nextAfterName из претходног одговора. |
| afterUserId | string | query | Не | Додатни критеријум за курсор: проследите nextAfterUserId из претходног одговора. Обавезно када је afterName постављен, како се уноси са истим именом не би изгубили. |
Одговор
Враћа: PageUsersOfflineResponse
Пример

getOnlineUsers 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Тренутно онлајн посматрачи странице: људи чија је вебсокет сесија тренутно претплаћена на страницу.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Враћа anonCount + totalCount (претплатнике у соби, укључујући анонимне посматраче које не набрајамо).
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Идентификатор URL странице (очишћен на серверу). |
| afterName | string | query | No | Курзор: проследите nextAfterName из претходног одговора. |
| afterUserId | string | query | No | Курзор решавач везног разлога: проследите nextAfterUserId из претходног одговора. Обавезно када је afterName постављен како називне везе не би изгубиле уносе. |
Response
Returns: PageUsersOnlineResponse
Example

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

getPageLikes 
Број лајкова за страницу, опционо са корисницима који су лајковали.
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| includeUserInfo | string | query | Не | „public" изоставља кориснике са приватним профилима, „include-private" их укључује. |
Одговор
Враћа: GetPageLikesAPIResponse
Пример

getPageReacts 
Прилагођени број реакција за страницу, по потреби са корисницима који су реаговали.
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| includeUserInfo | string | query | Не | "public" изоставља кориснике са приватним профилима, "include-private" их укључује. |
Одговор
Returns: GetPageReactsAPIResponse
Пример

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

getPagesPublic 
Наводи странице за закупца (tenant). Користи FChat десктоп клијент да попуни листу својих соба.
Захтева да enableFChat буде true у resolved custom config-у за сваку страницу.
Странице које захтевају 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
Пример

getUsersInfo 
Батцх информације о корисницима за тенанта. За датих userIds, враћа приказну информацију из User / SSOUser. Користи га коментар видгет да обогати кориснике који су управо појавили путем presence догађаја. Нема контекста странице: приватност се примењује униформно (приватни профили су прикривени).
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds раздвојени зарезом. |
Одговор
Враћа: PageUsersInfoResponse
Пример

migratePages 
Стави у ред серијски посао који премешта коментаре, странице и повезане записе са једног urlId или домена на други. „urlId" миграције поклапају само тачан urlId. „domain" миграције траже/замењују вредност унутар сваког urlId и url. Питај GET /api/v1/batch-jobs/{batchJobId}: када је завршен, садржи резултате по миграцији и undoId.
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Одговор
Враћа: QueuePageMigrationJobAPIResponse
Пример

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

undoPageMigrations 
Стави у ред групни посао који поништава сваку миграцију из једног migrate-pages посла, од најновијег. Доступно 90 дана. Записи промењени од миграције се не дирају, тако да каснија измена никада неће бити преписана. Питај GET /api/v1/batch-jobs/{batchJobId} за бројеве враћених/прескочених.
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| undoId | string | path | Да |
Одговор
Враћа: QueuePageMigrationJobAPIResponse
Пример

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

getPendingWebhookEventCount 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Не | |
| externalId | string | query | Не | |
| eventType | string | query | Не | |
| type | string | query | Не | |
| domain | string | query | Не | |
| attemptCountGT | number | query | Не |
Одговор
Враћа: GetPendingWebhookEventCountResponse
Пример

getPendingWebhookEvents 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| 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
Пример

createPollVote 
Запишите глас у анкети, или преместите постојећи глас на другу опцију. Гласач може имати највише један глас по анкети, тако да поновним позивом за истог гласача премешта се његов глас уместо додавања новог.
Ово поштује подешавања анкете на сајту: ако је гласање омогућено само пријављеним корисницима, глас са само anonUserId се одбија, а анонимни гласови су ограничени по IP по анкети.
Parameters
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да |
Response
Враћа: CreatePollVoteResponse
Пример

deletePollVote 
Повуци глас. Опција на коју је глас био дат враћа свој бројач.
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Одговор
Враћа: DeletePollVoteResponse
Пример

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

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
Анонимна анкета не може да се чита (poll-anonymous), ни овде ни по ID-у.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| voterId | string | query | No | |
| optionId | string | query | No | |
| skip | integer | query | No |
Response
Returns: GetPollVotesResponse
Example

deletePoll 
Уклоните анкету из њеног коментара, заједно са свим гласовима датим за њу. Сам коментар остаје непромењен.
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да |
Одговор
Враћа: APIEmptyResponse
Пример

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

getPollVoters 
Ко је гласао за коју опцију. Анонимне анкете никада не одговарају, анкете доступне само администраторима одговарају само администратор или модератор.
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
Response
Returns: GetPollVoterNamesSuccessResponse
Example

patchPoll 
Измените анкету на месту, задржавајући њене резултате: промените питање, преименујте опцију, затворите или поново отворите анкету, или промените ко може да види гласаче. Опције се адресирају преко id - за додавање, уклањање или преређивање, пошаљите PUT са целом листом.
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да |
Одговор
Враћа: SavePollResponse
Пример

putPoll 
Прикачите анкету на коментар или поставите целокупно стање анкете коју већ има.
Опције се упарују по id: опција послата са id постојеће опције задржава своје гласове (и добија нову ознаку и позицију), опција послата без id се додаје, а постојеће опције које нису наведене на листи се уклањају заједно са гласовима датим на њима.
Ако се на анкети која има гласове не задржи ниједан постојећи id опције, сви гласови се бришу, тако да то захтева replaceVotes=true.
Параметри
| Назив | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| replaceVotes | boolean | query | Не |
Одговор
Враћа: SavePollResponse
Пример

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

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

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

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

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

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

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

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

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

getQuestionResults 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Одговор
Враћа: GetQuestionResultsResponse
Пример

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

aggregateQuestionResults 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| questionId | string | query | Не | |
| questionIds | array | query | Не | |
| urlId | string | query | Не | |
| timeBucket | string | query | Не | |
| startDate | string | query | Не | |
| forceRecalculate | boolean | query | Не |
Одговор
Враћа: AggregateQuestionResultsResponse
Пример

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

combineCommentsWithQuestionResults 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Одговор
Returns: CombineQuestionResultsWithCommentsResponse
Пример

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

deleteSSOUser 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| deleteComments | boolean | query | Не | |
| commentDeleteMode | string | query | Не |
Одговор
Returns: DeleteSSOUserAPIResponse
Пример

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

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

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

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

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

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

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

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

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

getTenantDailyUsages 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Response
Враћа: GetTenantDailyUsagesResponse
Example

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getTickets 
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| state | number | query | Не | |
| skip | number | query | Не | |
| limit | number | query | Не |
Response
Враћа: GetTicketsResponse
Пример

getTranslations 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| namespace | string | path | Да | |
| component | string | path | Да | |
| locale | string | query | Не | |
| useFullTranslationIds | boolean | query | Не |
Одговор
Враћа: GetTranslationsResponse
Пример

uploadImage 
Upload and resize an image
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| sizePreset | string | query | Не | Претподешавање величине: "Default" (1000x1000px) или "CrossPlatform" (прави величине за популарне уређаје) |
| urlId | string | query | Не | Идентификатор странице са које се врши отпремање, за конфигурацију |
Одговор
Враћа: UploadImageResponse
Пример

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

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

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

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

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

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

getUserBadges 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Одговор
Враћа: APIGetUserBadgesResponse
Пример

updateUserBadge 
Parametri
| Naziv | Tip | Lokacija | Obavezno | Opis |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Odgovor
Vraća: APIEmptySuccessResponse
Primer

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

getUserNotifications 
Параметри
| Име | Тип | Локација | Потребно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Koristi se za određivanje da li je trenutna stranica pretplaćena. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Odgovor
Vraća: GetMyNotificationsResponse
Primer

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

resetUserNotifications 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Не | |
| afterCreatedAt | integer | query | Не | |
| unreadOnly | boolean | query | Не | |
| dmOnly | boolean | query | Не | |
| noDm | boolean | query | Не | |
| sso | string | query | Не |
Одговор
Враћа: ResetUserNotificationsResponse
Пример

updateUserNotificationCommentSubscriptionStatus 
Омогућите или онемогућите обавештења за одређени коментар.
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| optedInOrOut | string | path | Да | |
| commentId | string | query | Да | |
| sso | string | query | Не |
Одговор
Враћа: UpdateUserNotificationCommentSubscriptionStatusResponse
Пример

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

updateUserNotificationStatus 
Parametri
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| newStatus | string | path | Да | |
| sso | string | query | Не |
Одговор
Враћа: UpdateUserNotificationStatusResponse
Пример

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

searchUsers 
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Одговор
Враћа: SearchUsersResult
Пример

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

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

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

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

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

createWebhook 
Пријављује URL за догађај коментара (REST hook subscribe). Поновно пријављивање истог URL‑а за исти догађај и домен враћа постојећу претплату. Испоруке су HMAC потписане, погледајте водич за веб‑хоокове; наследни token заглавље се никада не шаље API претплатама.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreateWebhookResponse
Пример

deleteWebhook 
Одјаве (REST hook одјава). Само претплате креиране преко овог API‑ја могу бити обрисане овде; веб‑кукови управљани преко контролне табле се уређују у контролној табли.
Parameters
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Response
Returns: APIEmptyResponse
Example

getWebhooks 
Наводи вебхукове конфигурисане за станара, како редове управљане са контролне табле тако и API претплате.
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| event | string | query | Не | |
| domain | string | query | Не | |
| source | string | query | Не | |
| skip | number | query | Не |
Одговор
Враћа: GetWebhooksResponse
Пример

getWebhookSamplePayloads 
Скори коментари у тачно истом облику који користе испоруке вебхука, за изградњу интеграција (на пример Zapier пример података). Сваки догађај испоручује исти објекат коментара, тако да event мора бити валидан.
Параметри
| Име | Тип | Локација | Обавезно | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| event | string | query | No | |
| limit | number | query | No |
Одговор
Враћа: GetWebhookSamplePayloadsResponse
Пример

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