
Мова 🇺🇦 Українська
Початок роботи
Використання
Агрегація
Журнали аудиту
Аутентифікація
Блокування через коментар
Перевірка заблокованих коментарів
Коментарі
Коментарі користувача
Налаштування домену
Шаблони електронної пошти
Журнал подій
Пости стрічки
Скарга на коментар
Гіфки
Хештеги
Модерація
Модератори
Кількість сповіщень
Сповіщення
Реакції сторінки
Сторінки
Очікувані події вебхука
Налаштування запитань
Результати запитань
Агрегація результатів запитань
Користувачі SSO
Підписки
Щоденне використання орендаря
Пакети орендаря
Користувачі орендаря
Орендарі
Тикети
Переклади
Завантажити зображення
Прогрес бейджів користувача
Бейджі користувача
Сповіщення користувача
Статуси присутності користувача
Пошук користувачів
Користувачі
Голоси
FastComments SDK для Go
Це офіційний Go SDK для FastComments.
Офіційний Go SDK для FastComments API
Репозиторій
Встановлення 
go get github.com/fastcomments/fastcomments-go
Використання клієнта API
Публічний API (без автентифікації)
PublicAPI дозволяє доступ без автентифікації до публічних кінцевих точок:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Отримати коментарі за допомогою PublicAPI
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Стандартний API (вимагає API ключа)
DefaultAPI вимагає автентифікації за допомогою вашого API ключа:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Створити автентифікований контекст за допомогою API ключа
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// Отримати коментарі за допомогою автентифікованого DefaultAPI
response, httpResp, err := apiClient.DefaultAPI.GetComments(auth).
TenantId("your-tenant-id").
UrlId("your-page-url-id").
Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Модераційний API (панель модератора)
ModerationAPI надає широке набор живих та швидких модераційних API. Усі методи модерації приймають параметр sso і можуть автентифікуватися через SSO або сесійну cookie FastComments.com:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Перелічити коментарі для модерації за допомогою ModerationAPI
response, httpResp, err := apiClient.ModerationAPI.GetApiComments(
context.Background(),
).Sso("your-sso-token").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Використання 
Простий SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Створення токена простого SSO
user := &sso.SimpleSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Avatar: "https://example.com/avatar.jpg",
}
ssoInstance := sso.NewSimple(user)
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("SSO Token:", token)
// Використайте SSO токен для виконання автентифікованого виклику API
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Захищений SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Створення токена захищеного SSO
user := &sso.SecureSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Username: "johndoe",
Avatar: "https://example.com/avatar.jpg",
}
apiKey := "your-api-key"
ssoInstance, err := sso.NewSecure(apiKey, user)
if err != nil {
panic(err)
}
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("Secure SSO Token:", token)
// Використайте SSO токен для виконання автентифікованого виклику API
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Агрегація 
Агрегує документи, групуючи їх (якщо надано groupBy) та застосовуючи кілька операцій. Підтримуються різні операції (наприклад sum, countDistinct, avg тощо).
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| parentTenantId | string | query | Ні | |
| includeStats | boolean | query | Ні |
Відповідь
Повертає: AggregateResponse
Приклад

Отримати журнали аудиту 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| limit | number | query | Ні | |
| skip | number | query | Ні | |
| order | string | query | Ні | |
| after | number | query | Ні | |
| before | number | query | Ні |
Відповідь
Повертає: GetAuditLogsResponse
Приклад

Вихід (публічно) 
Відповідь
Повертає: APIEmptyResponse
Приклад

Заблокувати за коментарем (публічно) 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: BlockSuccess
Приклад

Розблокувати коментар (публічно) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UnblockSuccess
Приклад

Перевірка заблокованих коментарів 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentIds | string | query | Так | Список ідентифікаторів коментарів, розділених комами. |
| sso | string | query | Ні |
Відповідь
Повертає: CheckBlockedCommentsResponse
Приклад

Заблокувати користувача за коментарем 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: BlockSuccess
Приклад

Створити коментар (публічно) 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: SaveCommentsResponseWithPresence
Приклад

Видалити коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| contextUserId | string | query | Ні | |
| isLive | boolean | query | Ні |
Відповідь
Повертає: DeleteCommentResult
Приклад

Видалити коментар (публічно) 
Parameters
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Response
Повертає: PublicAPIDeleteCommentResponse
Приклад

Видалити голос за коментар 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| voteId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: VoteDeleteResponse
Приклад

Поскаржитися на коментар 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: FlagCommentResponse
Приклад

Отримати коментар 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIGetCommentResponse
Приклад

Отримати коментарі 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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
Приклад

Отримати коментарі (публічно) 
обов'язкові tenantId urlId
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Приклад

Отримати текст коментаря 
Параметри
| Name | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: PublicAPIGetCommentTextResponse
Приклад

Отримати імена користувачів, які голосували за коментар 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| dir | integer | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetCommentVoteUserNamesSuccessResponse
Приклад

Заблокувати коментар 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Закріпити коментар 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: ChangeCommentPinStatusResponse
Приклад

Зберегти коментар 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| sendEmails | boolean | query | Ні | |
| populateNotifications | boolean | query | Ні |
Відповідь
Повертає: APISaveCommentResponse
Приклад

Масове збереження коментарів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| sendEmails | boolean | query | Ні | |
| populateNotifications | boolean | query | Ні |
Відповідь
Повертає: []SaveCommentsBulkResponse
Приклад

Встановити текст коментаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| editKey | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: PublicAPISetCommentTextResponse
Приклад

Розблокувати користувача за коментарем 
Параметри
| Назва | Type | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: UnblockSuccess
Приклад

Зняти позначку зі скарги на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Відповідь
Повертає: FlagCommentResponse
Приклад

Розблокувати коментар 
Параметри
| Назва | Тип | Location | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Зняти закріплення коментаря 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ChangeCommentPinStatusResponse
Приклад

Оновити коментар 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| contextUserId | string | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| isLive | boolean | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Проголосувати за коментар 
Параметри
| Назва | Тип | Location | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| commentId | string | path | Так | |
| urlId | string | query | Так | |
| broadcastId | string | query | Так | |
| sessionId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: VoteResponse
Приклад

Отримати коментарі користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| userId | string | query | Ні | |
| direction | string | query | Ні | |
| repliesToUserId | string | query | Ні | |
| page | number | query | Ні | |
| includei10n | boolean | query | Ні | |
| locale | string | query | Ні | |
| isCrawler | boolean | query | Ні |
Відповідь
Повертає: GetCommentsForUserResponse
Приклад

Додати конфігурацію домену 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Response
Повертає: AddDomainConfigResponse
Приклад

Видалити конфігурацію домену 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domain | string | path | Так |
Відповідь
Повертає: DeleteDomainConfigResponse
Приклад

Отримати конфігурацію домену 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domain | string | path | Так |
Відповідь
Повертає: GetDomainConfigResponse
Приклад

Отримати конфігурації домену 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetDomainConfigsResponse
Приклад

Частково оновити конфігурацію домену 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domainToUpdate | string | path | Так |
Відповідь
Повертає: PatchDomainConfigResponse
Приклад

Замінити конфігурацію домену 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| domainToUpdate | string | path | Так |
Відповідь
Повертає: PutDomainConfigResponse
Приклад

Створити шаблон електронного листа 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateEmailTemplateResponse
Приклад

Видалити шаблон електронного листа 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Видалити помилку рендерингу шаблона листа 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| errorId | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати шаблон електронного листа 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetEmailTemplateResponse
Приклад

Отримати визначення шаблонів листів 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetEmailTemplateDefinitionsResponse
Приклад

Отримати помилки рендерингу шаблонів листів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetEmailTemplateRenderErrorsResponse
Приклад

Отримати шаблони електронних листів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetEmailTemplatesResponse
Приклад

Відрендерити шаблон електронного листа 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| locale | string | query | No |
Відповідь
Повертає: RenderEmailTemplateResponse
Приклад

Оновити шаблон електронного листа 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати журнал подій 
req tenantId urlId userIdWS
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| userIdWS | string | query | Так | |
| startTime | integer | query | Так | |
| endTime | integer | query | Ні |
Відповідь
Повертає: GetEventLogResponse
Приклад

Отримати глобальний журнал подій 
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
Приклад

Створити пост стрічки 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| broadcastId | string | query | Ні | |
| isLive | boolean | query | Ні | |
| doSpamCheck | boolean | query | Ні | |
| skipDupCheck | boolean | query | Ні |
Відповідь
Повертає: CreateFeedPostsResponse
Приклад

Створити пост стрічки (публічно) 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: CreateFeedPostResponse
Приклад

Видалити пост стрічки (публічно) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: DeleteFeedPostPublicResponse
Приклад

Отримати пости стрічки 
req tenantId afterId
Параметри
| Назва | Type | Location | Required | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні |
Відповідь
Повертає: GetFeedPostsResponse
Приклад

Отримати пости стрічки (публічно) 
запит tenantId afterId
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| afterId | string | query | Ні | |
| limit | integer | query | Ні | |
| tags | array | query | Ні | |
| sso | string | query | Ні | |
| isCrawler | boolean | query | Ні | |
| includeUserInfo | boolean | query | Ні |
Відповідь
Повертає: PublicFeedPostsResponse
Приклад

Отримати статистику постів стрічки 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postIds | array | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: FeedPostsStatsResponse
Приклад

Отримати реакції користувача (публічно) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postIds | array | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: UserReactsResponse
Приклад

Поставити реакцію посту (публічно) 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postId | string | path | Так | |
| isUndo | boolean | query | Ні | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ReactFeedPostResponse
Приклад

Оновити пост стрічки 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

Оновити пост стрічки (публічно) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| postId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: CreateFeedPostResponse
Приклад

Поскаржитися на коментар (публічно) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| isFlagged | boolean | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати великий GIF 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| largeInternalURLSanitized | string | query | Так |
Відповідь
Повертає: GifGetLargeResponse
Приклад

Пошук GIF 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| search | string | query | Так | |
| locale | string | query | Ні | |
| rating | string | query | Ні | |
| page | number | query | Ні |
Відповідь
Повертає: GetGifsSearchResponse
Приклад

Трендові GIF 
Параметри
| Назва | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| locale | string | query | Ні | |
| rating | string | query | Ні | |
| page | number | query | Ні |
Відповідь
Повертає: GetGifsTrendingResponse
Приклад

Додати хештег 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: CreateHashTagResponse
Приклад

Масове додавання хештегів 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: BulkCreateHashTagsResponse
Приклад

Видалити хештег 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати хештеги 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| page | number | query | Ні |
Відповідь
Повертає: GetHashTagsResponse
Приклад

Частково оновити хештег 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Відповідь
Повертає: UpdateHashTagResponse
Приклад

Видалити голос модерації 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: VoteDeleteResponse
Приклад

Отримати API коментарі 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationAPIGetCommentsResponse
Приклад

Отримати статус експорту API 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationExportStatusResponse
Приклад

Отримати API ідентифікатори 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Response
Повертає: ModerationAPIGetCommentIdsResponse
Приклад

Отримати заблокованих користувачів за коментарем 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetBannedUsersFromCommentResponse
Приклад

Отримати статус бану коментаря 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: GetCommentBanStatusResponse
Приклад

Отримати дочірні коментарі 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationAPIChildCommentsResponse
Приклад

Отримати лічильник 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| text-search | string | query | Ні | |
| byIPFromComment | string | query | Ні | |
| filter | string | query | Ні | |
| searchFilters | string | query | Ні | |
| demo | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationAPICountCommentsResponse
Приклад

Отримати лічильники 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: GetBannedUsersCountResponse
Приклад

Отримати журнали 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Відповідь
Повертає: ModerationAPIGetLogsResponse
Приклад

Отримати ручні бейджі 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: GetTenantManualBadgesResponse
Приклад

Отримати ручні бейджі для користувача 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| badgesUserId | string | query | Ні | |
| commentId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Returns: GetUserManualBadgesResponse
Приклад

Отримати коментар для модерації 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Відповідь
Returns: ModerationAPICommentResponse
Приклад

Отримати текст коментаря для модерації 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetCommentTextResponse
Приклад

Отримати попередню зведену інформацію про бан 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Відповідь
Повертає: PreBanSummary
Приклад

Отримати зведення пошукових коментарів 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| filters | string | query | Ні | |
| searchFilters | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationCommentSearchResponse
Приклад

Отримати пошук сторінок 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Відповідь
Returns: ModerationPageSearchResponse
Приклад

Отримати пошук сайтів 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: ModerationSiteSearchResponse
Приклад

Отримати підказки пошуку 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| text-search | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ModerationSuggestResponse
Приклад

Пошук користувачів 
Параметри
| Назва | Тип | Місце | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| value | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Returns: ModerationUserSearchResponse
Приклад

Отримати коефіцієнт довіри 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserTrustFactorResponse
Приклад

Отримати налаштування бану користувача 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIModerateGetUserBanPreferencesResponse
Приклад

Отримати внутрішній профіль користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: GetUserInternalProfileResponse
Приклад

Налаштувати голоси коментарів 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: AdjustVotesResponse
Приклад

Запустити експорт API 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Відповідь
Returns: ModerationExportResponse
Приклад

Забанити користувача за коментар 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: BanUserFromCommentResult
Приклад

Скасувати бан користувача 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

Масове попереднє зведення про бан 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| includeByUserIdAndEmail | boolean | query | Ні | |
| includeByIP | boolean | query | Ні | |
| includeByEmailDomain | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: BulkPreBanSummary
Приклад

Отримати коментарі за ідентифікаторами 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Returns: ModerationAPIChildCommentsResponse
Приклад

Поскаржитися на коментар (модерація) 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

Вилучити коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: PostRemoveCommentApiResponse
Приклад

Відновити видалений коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: APIEmptyResponse
Приклад

Встановити статус затвердження коментаря 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| approved | boolean | query | Ні | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: SetCommentApprovedResponse
Приклад

Встановити статус перевірки коментаря 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| reviewed | boolean | query | Ні | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Встановити статус спаму коментаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| spam | boolean | query | Ні | |
| permNotSpam | boolean | query | Ні | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Встановити текст коментаря (модерація) 
Параметри
| Назва | Тип | Розташування | Обов’язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Відповідь
Returns: SetCommentTextResponse
Приклад

Зняти скаргу на коментар 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Проголосувати (модерація) 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | path | Так | |
| direction | string | query | Ні | |
| broadcastId | string | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: VoteResponse
Приклад

Нагородити бейдж 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| 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
Приклад

Закрити тему 
Параметри
| Назва | Тип | Місце | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Зняти бейдж 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| 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
Приклад

Відкрити тему 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Встановити коефіцієнт довіри 
Параметри
| Назва | Тип | Розташування | Обов’язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Відповідь
Повертає: SetUserTrustFactorResponse
Приклад

Створити модератора 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateModeratorResponse
Приклад

Видалити модератора 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| sendEmail | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати модератора 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetModeratorResponse
Приклад

Отримати модераторів 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetModeratorsResponse
Приклад

Відправити запрошення 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| fromName | string | query | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

Оновити модератора 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Видалити кількість сповіщень 
Параметри
| Ім'я | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати кешовану кількість сповіщень 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: GetCachedNotificationCountResponse
Приклад

Отримати кількість сповіщень 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| urlId | string | query | Ні | |
| fromCommentId | string | query | Ні | |
| viewed | boolean | query | Ні | |
| type | string | query | Ні |
Відповідь
Повертає: GetNotificationCountResponse
Приклад

Отримати сповіщення 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| urlId | string | query | Ні | |
| fromCommentId | string | query | Ні | |
| viewed | boolean | query | Ні | |
| type | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetNotificationsResponse
Приклад

Оновити сповіщення 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Створити реакцію сторінки v1 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| title | string | query | Ні |
Відповідь
Повертає: CreateV1PageReact
Приклад

Створити реакцію сторінки v2 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | шлях | Так | |
| urlId | string | параметр запиту | Так | |
| id | string | параметр запиту | Так | |
| title | string | параметр запиту | Ні |
Відповідь
Повертає: CreateV1PageReact
Приклад

Видалити реакцію сторінки v1 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: CreateV1PageReact
Приклад

Видалити реакцію сторінки v2 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| id | string | query | Так |
Відповідь
Повертає: CreateV1PageReact
Приклад

Отримати лайки сторінки v1 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: GetV1PageLikes
Приклад

Отримати реакції сторінки v2 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: GetV2PageReacts
Приклад

Отримати користувачів реакцій сторінки v2 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| urlId | string | query | Так | |
| id | string | query | Так |
Відповідь
Повертає: GetV2PageReactUsersResponse
Приклад

Додати сторінку 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Відповідь
Повертає: AddPageAPIResponse
Приклад

Видалити сторінку 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: DeletePageAPIResponse
Приклад

Отримати офлайн-користувачів 
Попередні коментатори на сторінці, які НЕ зараз в мережі. Відсортовано за displayName. Використовуйте це після вичерпання /users/online, щоб відобразити розділ "Учасники". Пагінація курсором за commenterName: сервер проходить частковий індекс {tenantId, urlId, commenterName} від afterName уперед за допомогою $gt, без витрат $skip.
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Page URL identifier (cleaned server-side). |
| afterName | string | query | No | Курсор: передайте nextAfterName з попередньої відповіді. |
| afterUserId | string | query | No | Курсор-тайбрекер: передайте nextAfterUserId з попередньої відповіді. Обов'язково, коли afterName встановлено, щоб зв'язки за іменем не призводили до втрати записів. |
Відповідь
Повертає: PageUsersOfflineResponse
Приклад

Отримати онлайн-користувачів 
Користувачі, які зараз онлайн на сторінці: люди, чиї websocket-сесії зараз підписані на цю сторінку. Повертає anonCount + totalCount (підписники на кімнату, включаючи анонімних глядачів, яких ми не перераховуємо).
Parameters
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Ідентифікатор URL сторінки (очищено на сервері). |
| afterName | string | query | No | Курсор: передайте nextAfterName з попередньої відповіді. |
| afterUserId | string | query | No | Додатковий курсор для розв'язання однакових імен: передайте nextAfterUserId з попередньої відповіді. Необхідно, коли встановлено afterName, щоб записи з однаковими іменами не втрачалися. |
Response
Повертає: PageUsersOnlineResponse
Приклад

Отримати сторінку за URL/ID 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так |
Відповідь
Повертає: GetPageByURLIdAPIResponse
Приклад

Отримати сторінки 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: GetPagesAPIResponse
Приклад

Отримати сторінки (публічно) 
Перелік сторінок для орендаря. Використовується десктоп-клієнтом 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
Приклад

Отримати інформацію про користувачів 
Масова інформація про користувачів для тенанта. За заданими userIds повертає відображувану інформацію з User / SSOUser. Використовується віджетом коментарів для доповнення користувачів, які щойно з'явилися через подію присутності. Без контексту сторінки: приватність застосовується однаково (приватні профілі приховані).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Так | |
| ids | string | query | Так | userIds, розділені комою. |
Response
Повертає: PageUsersInfoResponse
Приклад

Частково оновити сторінку 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: PatchPageAPIResponse
Приклад

Видалити очікувану подію вебхука 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати кількість очікуваних подій вебхука 
Параметри
| Назва | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні |
Відповідь
Повертає: GetPendingWebhookEventCountResponse
Приклад

Отримати очікувані події вебхука 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Ні | |
| externalId | string | query | Ні | |
| eventType | string | query | Ні | |
| type | string | query | Ні | |
| domain | string | query | Ні | |
| attemptCountGT | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetPendingWebhookEventsResponse
Приклад

Створити конфігурацію питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | параметр запиту | Так |
Відповідь
Повертає: CreateQuestionConfigResponse
Приклад

Видалити конфігурацію питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати конфігурацію питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetQuestionConfigResponse
Приклад

Отримати конфігурації питань 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetQuestionConfigsResponse
Приклад

Оновити конфігурацію питання 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Створити результат питання 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateQuestionResultResponse
Приклад

Видалити результат питання 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати результат питання 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetQuestionResultResponse
Приклад

Отримати результати запитань 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Ні | |
| userId | string | query | Ні | |
| startDate | string | query | Ні | |
| questionId | string | query | Ні | |
| questionIds | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetQuestionResultsResponse
Приклад

Оновити результат питання 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Агрегувати результати запитань 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| questionId | string | query | Ні | |
| questionIds | array | query | Ні | |
| urlId | string | query | Ні | |
| timeBucket | string | query | Ні | |
| startDate | string | query | Ні | |
| forceRecalculate | boolean | query | Ні |
Відповідь
Повертає: AggregateQuestionResultsResponse
Приклад

Масова агрегація результатів запитань 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| forceRecalculate | boolean | query | Ні |
Відповідь
Повертає: BulkAggregateQuestionResultsResponse
Приклад

Поєднати коментарі з результатами запитань 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| 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
Приклад

Додати SSO користувача 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: AddSSOUserAPIResponse
Приклад

Видалити SSO користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| deleteComments | boolean | query | Ні | |
| commentDeleteMode | string | query | Ні |
Відповідь
Повертає: DeleteSSOUserAPIResponse
Приклад

Отримати SSO користувача за емейлом 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| string | path | Так |
Відповідь
Повертає: GetSSOUserByEmailAPIResponse
Приклад

Отримати SSO користувача за ID 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetSSOUserByIdAPIResponse
Приклад

Отримати SSO користувачів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | integer | query | Ні |
Відповідь
Повертає: GetSSOUsersResponse
Приклад

Частково оновити SSO користувача 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | boolean | query | Ні |
Відповідь
Повертає: PatchSSOUserAPIResponse
Приклад

Замінити SSO користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | boolean | query | Ні |
Відповідь
Повертає: PutSSOUserAPIResponse
Приклад

Створити підписку 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateSubscriptionAPIResponse
Приклад

Видалити підписку 
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: DeleteSubscriptionAPIResponse
Приклад

Отримати підписки 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: GetSubscriptionsAPIResponse
Приклад

Оновити підписку 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: UpdateSubscriptionAPIResponse
Приклад

Отримати щоденне використання орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| yearNumber | number | query | Ні | |
| monthNumber | number | query | Ні | |
| dayNumber | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantDailyUsagesResponse
Приклад

Створити пакет орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateTenantPackageResponse
Приклад

Видалити пакет орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати пакет орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantPackageResponse
Приклад

Отримати пакети орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantPackagesResponse
Приклад

Замінити пакет орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Відповідь
Повертає: APIEmptyResponse
Приклад

Оновити пакет орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptyResponse
Приклад

Створити користувача орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateTenantUserResponse
Приклад

Видалити користувача орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| deleteComments | string | query | Ні | |
| commentDeleteMode | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати користувача орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantUserResponse
Приклад

Отримати користувачів орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Відповідь
Повертає: GetTenantUsersResponse
Приклад

Замінити користувача орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Надіслати посилання для входу 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| redirectURL | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Оновити користувача орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| updateComments | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Створити орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: CreateTenantResponse
Приклад

Видалити орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| sure | string | query | Ні |
Відповідь
Повертає: APIEmptyResponse
Приклад

Отримати орендаря 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetTenantResponse
Приклад

Отримати орендарів 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| meta | string | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: GetTenantsResponse
Приклад

Оновити орендаря 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Повертає
Returns: APIEmptyResponse
Приклад

Змінити стан тикета 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: ChangeTicketStateResponse
Приклад

Створити тикет 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Так |
Відповідь
Повертає: CreateTicketResponse
Приклад

Отримати тикет 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| userId | string | query | Ні |
Відповідь
Повертає: GetTicketResponse
Приклад

Отримати тикети 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| state | number | query | Ні | |
| skip | number | query | Ні | |
| limit | number | query | Ні |
Відповідь
Повертає: GetTicketsResponse
Приклад

Отримати переклади 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| namespace | string | path | Так | |
| component | string | path | Так | |
| locale | string | query | Ні | |
| useFullTranslationIds | boolean | query | Ні |
Відповідь
Повертає: GetTranslationsResponse
Приклад

Завантажити зображення 
Завантажити та змінити розмір зображення
Параметри
| Назва | Тип | Розташування | Обов'язкове | Опис |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Пресет розміру: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв) |
| urlId | string | query | No | Ідентифікатор сторінки, з якої відбувається завантаження, для конфігурації |
Відповідь
Повертає: UploadImageResponse
Приклад

Отримати прогрес бейджа користувача за ID 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIGetUserBadgeProgressResponse
Приклад

Отримати прогрес бейджа користувача за ID користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | path | Так |
Відповідь
Повертає: APIGetUserBadgeProgressResponse
Приклад

Отримати список прогресу бейджів користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| limit | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: APIGetUserBadgeProgressListResponse
Приклад

Створити бейдж користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так |
Відповідь
Повертає: APICreateUserBadgeResponse
Приклад

Видалити бейдж користувача 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptySuccessResponse
Приклад

Отримати бейдж користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIGetUserBadgeResponse
Приклад

Отримати бейджі користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| userId | string | query | Ні | |
| badgeId | string | query | Ні | |
| type | number | query | Ні | |
| displayedOnComments | boolean | query | Ні | |
| limit | number | query | Ні | |
| skip | number | query | Ні |
Відповідь
Повертає: APIGetUserBadgesResponse
Приклад

Оновити бейдж користувача 
Параметри
| Назва | Тип | Location | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: APIEmptySuccessResponse
Приклад

Отримати кількість сповіщень користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: GetUserNotificationCountResponse
Приклад

Отримати сповіщення користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Ні | Використовується для визначення, чи підписана поточна сторінка. |
| pageSize | integer | query | Ні | |
| afterId | string | query | Ні | |
| includeContext | boolean | query | Ні | |
| afterCreatedAt | integer | query | Ні | |
| unreadOnly | boolean | query | Ні | |
| dmOnly | boolean | query | Ні | |
| noDm | boolean | query | Ні | |
| includeTranslations | boolean | query | Ні | |
| includeTenantNotifications | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: GetMyNotificationsResponse
Приклад

Скинути кількість сповіщень користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: ResetUserNotificationsResponse
Приклад

Скинути сповіщення користувача 
Параметри
| Назва | Тип | Розташування | Обов'язковий | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| afterId | string | query | Ні | |
| afterCreatedAt | integer | query | Ні | |
| unreadOnly | boolean | query | Ні | |
| dmOnly | boolean | query | Ні | |
| noDm | boolean | query | Ні | |
| sso | string | query | Ні |
Відповідь
Повертає: ResetUserNotificationsResponse
Приклад

Оновити статус підписки на коментарі користувача 
Увімкнути або вимкнути повідомлення для конкретного коментаря.
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Відповідь
Повертає: UpdateUserNotificationCommentSubscriptionStatusResponse
Приклад

Оновити статус підписки на сторінку користувача 
Увімкнути або вимкнути сповіщення для сторінки. Коли користувачі підписані на сторінку, створюються сповіщення для нових кореневих коментарів, а також
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| url | string | query | Так | |
| pageTitle | string | query | Так | |
| subscribedOrUnsubscribed | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationPageSubscriptionStatusResponse
Приклад

Оновити статус сповіщення користувача 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| notificationId | string | path | Так | |
| newStatus | string | path | Так | |
| sso | string | query | Ні |
Відповідь
Повертає: UpdateUserNotificationStatusResponse
Приклад

Отримати статуси присутності користувачів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlIdWS | string | query | Так | |
| userIds | string | query | Так |
Відповідь
Повертає: GetUserPresenceStatusesResponse
Приклад

Пошук користувачів 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Відповідь
Повертає: SearchUsersResult
Приклад

Отримати користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так |
Відповідь
Повертає: GetUserResponse
Приклад

Створити голос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| commentId | string | query | Так | |
| direction | string | query | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: VoteResponse
Приклад

Видалити голос 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| id | string | path | Так | |
| editKey | string | query | Ні |
Відповідь
Повертає: VoteDeleteResponse
Приклад

Отримати голоси 
Параметри
| Назва | Тип | Розташування | Обов'язково | Опис |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Відповідь
Повертає: GetVotesResponse
Приклад

Отримати голоси для користувача 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Так | |
| urlId | string | query | Так | |
| userId | string | query | Ні | |
| anonUserId | string | query | Ні |
Відповідь
Повертає: GetVotesForUserResponse
Приклад

Потрібна допомога?
Якщо у вас виникли проблеми або є питання щодо Go SDK, будь ласка:
Участь
Внески вітаються! Будь ласка, відвідайте репозиторій GitHub для отримання інструкцій щодо внесків.