
Език 🇧🇬 Български
Първи стъпки
Използване
Агрегиране
Одитни записи
Автентикация
Блокиране от коментар
Проверка на блокирани коментари
Коментари
Коментари за потребител
Конфигурации на домейн
Имейл шаблони
Регистър на събития
Публикации във фийда
Докладване на коментар
GIF
Хаштагове
Модерация
Модератори
Брой известия
Известия
Реакции на страница
Страници
Очакващи webhook събития
Конфигурации на въпроси
Резултати от въпроси
Агрегиране на резултати от въпроси
SSO потребители
Абонаменти
Дневна употреба на наемателя
Пакети на наемателя
Потребители на наемателя
Наематели
Тикети
Преводи
Качване на изображение
Прогрес за значки на потребител
Значки на потребителя
Потребителски известия
Статус на присъствие на потребител
Търсене на потребители
Потребители
Гласове
FastComments Go SDK
Това е официалният 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)
// Get comments using 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)
// Create authenticated context with API key
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// Get comments using authenticated 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)
// List comments for moderation using 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() {
// Създаване на Simple 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 и др.).
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| parentTenantId | string | query | Не | |
| includeStats | boolean | query | Не |
Отговор
Връща: AggregateResponse
Пример

Получаване на одитни записи 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

Разблокиране на коментар (публично) 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Response
Връща: UnblockSuccess
Пример

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

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

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

Изтриване на коментар (публично) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: PublicAPIDeleteCommentResponse
Пример

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

Докладване на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

Получаване на текст на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

Закачане на коментар 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Response
Връща: ChangeCommentPinStatusResponse
Example

Запазване на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

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

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

Премахване на закачане на коментар 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

Получаване на коментари за потребител 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 | Да |
Отговор
Връща: AddDomainConfigResponse
Пример

Изтриване на конфигурация на домейн 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Отговор
Връща: DeleteDomainConfigResponse
Пример

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

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

Промяна на конфигурация на домейн (PATCH) 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Отговор
Връща: PatchDomainConfigResponse
Пример

Замяна/създаване на конфигурация на домейн (PUT) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Отговор
Връща: PutDomainConfigResponse
Пример

Създаване на имейл шаблон 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateEmailTemplateResponse
Пример

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

Изтриване на грешка при рендериране на имейл шаблон 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

Рендериране на имейл шаблон 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| locale | string | query | Не |
Отговор
Връща: RenderEmailTemplateResponse
Пример

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

Получаване на регистър на събития 
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
Пример

Получаване на глобален регистър на събития 
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
Пример

Създаване на публикация във фийда (публично) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: CreateFeedPostResponse
Пример

Изтриване на публикация във фийда (публично) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: DeleteFeedPostPublicResponse
Пример

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

Получаване на публикации във фийда (публично) 
req tenantId afterId
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| afterId | string | query | Не | |
| limit | integer | query | Не | |
| tags | array | query | Не | |
| sso | string | query | Не | |
| isCrawler | boolean | query | Не | |
| includeUserInfo | boolean | query | Не |
Отговор
Връща: PublicFeedPostsResponse
Пример

Получаване на статистики за публикации във фийда 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postIds | array | query | Да | |
| sso | string | query | Не |
Отговор
Връща: FeedPostsStatsResponse
Пример

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

Реакция на публикация във фийда (публично) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| isUndo | boolean | query | Не | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ReactFeedPostResponse
Пример

Актуализиране на публикация във фийда 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

Актуализиране на публикация във фийда (публично) 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: CreateFeedPostResponse
Пример

Докладване на коментар (публично) 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| isFlagged | boolean | query | Да | |
| sso | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

Получаване на голям GIF 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| locale | string | query | Не | |
| rating | string | query | Не | |
| page | number | query | Не |
Отговор
Връща: GetGifsTrendingResponse
Пример

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

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

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

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

Промяна на хаштаг (PATCH) 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| tag | string | path | Да |
Отговор
Връща: UpdateHashTagResponse
Пример

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

Получаване на API коментари 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 |
Response
Връща: ModerationAPIGetCommentsResponse
Example

Получаване на статус на API експорта 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| batchJobId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: 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
Example

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

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

Получаване на деца на коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: 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 | Да | |
| sso | string | query | Не |
Отговор
Връща: GetBannedUsersCountResponse
Пример

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

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

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

Получаване на модерационен коментар 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | запитване | Да | |
| commentId | string | път | Да | |
| includeEmail | boolean | запитване | Не | |
| includeIP | boolean | запитване | Не | |
| sso | string | запитване | Не |
Response
Returns: ModerationAPICommentResponse
Example

Получаване на текст на модерационен коментар 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Отговор
Връща: 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
Пример

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

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

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

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

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

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

Получаване на вътрешен профил на потребител 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 |
Отговор
Връща: ModerationExportResponse
Пример

Блокиране на потребител от коментар (POST) 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 | Да | |
| sso | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

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

Получаване на коментари по идентификатори (POST) 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: ModerationAPIChildCommentsResponse
Пример

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

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

Възстановяване на изтрит коментар (POST) 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Отговор
Връща: APIEmptyResponse
Пример

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

Задаване на текст на коментар (POST) 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: SetCommentTextResponse
Example

Премахване на доклад за коментар (POST) 
Parameters
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: APIEmptyResponse
Example

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

Даване на значка 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: AwardUserBadgeResponse
Example

Затваряне на нишка 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 |
Отговор
Returns: RemoveUserBadgeResponse
Пример

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

Задаване на фактор на доверие 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| trustFactor | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: SetUserTrustFactorResponse
Пример

Създаване на модератор 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateModeratorResponse
Пример

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

Получаване на модератор 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetModeratorResponse
Пример

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

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

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

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

Получаване на кеширан брой известия 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: 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 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | път | Да | |
| urlId | string | заявка | Да | |
| title | string | заявка | Не |
Отговор
Връща: CreateV1PageReact
Пример

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

Изтриване на реакция на страница V1 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Да |
Отговор
Връща: AddPageAPIResponse
Пример

Изтриване на страница 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: DeletePageAPIResponse
Пример

Получаване на офлайн потребители 
Предишни коментиращи на страницата, които НЕ са в момента онлайн. Подредени по displayName. Използвайте това след изчерпване на /users/online, за да изобразите секция 'Членове'. Курсорна пагинация по commenterName: сървърът обхожда частичния индекс {tenantId, urlId, commenterName} от afterName напред чрез $gt, без разход за $skip.
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | Идентификатор на URL адреса на страницата (изчистен от сървъра). |
| afterName | string | query | Не | Курсор: подайте nextAfterName от предишния отговор. |
| afterUserId | string | query | Не | Курсорен критерий за равенство: подайте nextAfterUserId от предишния отговор. Задължително когато afterName е зададен, за да не се изпуснат записи при еднакви имена. |
Отговор
Връща: PageUsersOfflineResponse
Пример

Получаване на онлайн потребители 
В момента онлайн зрители на страница: хора, чиито websocket сесии са абонирани за страницата в момента. Връща anonCount + totalCount (абонати в рамките на стаята, включително анонимни зрители, които не изброяваме).
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | Идентификатор на URL на страницата (почистен от страна на сървъра). |
| afterName | string | query | Не | Курсор: подайте nextAfterName от предишния отговор. |
| afterUserId | string | query | Не | Курсор за разрешаване на равенство: подайте nextAfterUserId от предишния отговор. Задължително когато afterName е зададено, за да не се загубят записи при еднакви имена. |
Отговор
Връща: PageUsersOnlineResponse
Пример

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

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

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

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

Промяна на страница (PATCH) 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: PatchPageAPIResponse
Пример

Изтриване на очакващо webhook събитие 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

Получаване на брой очакващи webhook събития 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Не | |
| externalId | string | query | Не | |
| eventType | string | query | Не | |
| type | string | query | Не | |
| domain | string | query | Не | |
| attemptCountGT | number | query | Не |
Отговор
Връща: GetPendingWebhookEventCountResponse
Пример

Получаване на очакващи webhook събития 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| 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
Пример

Създаване на конфигурация на въпрос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateQuestionConfigResponse
Пример

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

Получаване на конфигурация на въпрос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetQuestionConfigResponse
Пример

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

Актуализиране на конфигурация на въпрос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

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

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

Получаване на резултат от въпрос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

Актуализиране на резултат от въпрос 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

Комбиниране на коментари с резултати от въпроси 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| questionId | string | query | Не | |
| questionIds | array | query | Не | |
| urlId | string | query | Не | |
| startDate | string | query | Не | |
| forceRecalculate | boolean | query | Не | |
| minValue | number | query | Не | |
| maxValue | number | query | Не | |
| limit | number | query | Не |
Отговор
Връща: CombineQuestionResultsWithCommentsResponse
Пример

Добавяне на SSO потребител 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: AddSSOUserAPIResponse
Пример

Изтриване на SSO потребител 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| deleteComments | boolean | query | Не | |
| commentDeleteMode | string | query | Не |
Отговор
Връща: DeleteSSOUserAPIResponse
Пример

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

Получаване на SSO потребител по идентификатор 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetSSOUserByIdAPIResponse
Пример

Получаване на SSO потребители 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | integer | query | Не |
Response
Връща: GetSSOUsersResponse
Пример

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

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

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

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

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

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

Получаване на дневна употреба на наемателя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| yearNumber | number | query | Не | |
| monthNumber | number | query | Не | |
| dayNumber | number | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetTenantDailyUsagesResponse
Пример

Създаване на пакет за наемателя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

Актуализиране на пакет на наемателя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: APIEmptyResponse
Пример

Създаване на потребител на наемателя 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

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

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

Изпращане на линк за вход 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| redirectURL | string | query | Не |
Отговор
Връща: APIEmptyResponse
Пример

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

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

Изтриване на наемател 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| 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 | Yes | |
| id | string | path | Yes |
Отговор
Връща: APIEmptyResponse
Пример

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

Получаване на билети 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| state | number | query | Не | |
| skip | number | query | Не | |
| limit | number | query | Не |
Връща
Returns: GetTicketsResponse
Пример

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

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

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

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

Получаване на списък с прогрес за значки на потребители 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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 | Yes | |
| id | string | path | Yes |
Отговор
Връща: APIGetUserBadgeResponse
Пример

Получаване на значки за потребител 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| badgeId | string | query | Не | |
| type | number | query | Не | |
| displayedOnComments | boolean | query | Не | |
| limit | number | query | Не | |
| skip | number | query | Не |
Отговор
Връща: APIGetUserBadgesResponse
Пример

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

Актуализиране на статус на известие за потребител 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| newStatus | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationStatusResponse
Пример

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

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

Получаване на потребител 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: 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 | Да | |
| urlId | string | query | Да |
Отговор
Връща: GetVotesResponse
Пример

Получаване на гласове за потребител 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: GetVotesForUserResponse
Пример

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