
Idioma 🇧🇷 Português (Brasil)
Documentação
Começando
Uso
Agregação
Logs de Auditoria
Autenticação
Bloquear do Comentário
Verificar Comentários Bloqueados
Comentários
Comentários do Usuário
Configurações de Domínio
Modelos de Email
Log de Evento
Postagens no Feed
Denunciar Comentário
GIFs
Hashtags
Moderação
Moderadores
Contagem de Notificações
Notificações
Reações de Página
Páginas
Eventos Webhook Pendentes
Configurações de Pergunta
Resultados de Pergunta
Agregação de Resultados de Pergunta
Usuários SSO
Assinaturas
Uso Diário do Inquilino
Pacotes de Inquilino
Usuários de Inquilino
Inquilinos
Tickets
Traduções
Carregar Imagem
Progresso de Distintivo do Usuário
Distintivos de Usuário
Notificações do Usuário
Status de Presença do Usuário
Busca de Usuários
Usuários
Votos
FastComments SDK Go
Este é o SDK oficial em Go para o FastComments.
SDK oficial em Go para a API do FastComments
Repositório
Agentes de codificação IA 
Forneça ao seu agente de codificação o contexto do FastComments que ele precisa - widgets, configuração, Secure SSO, a REST API e os SDKs:
npx skills add fastcomments/skills
Funciona com Claude Code, Codex, Cursor, Copilot, Gemini e todos os outros agentes que o skills CLI suporta.
Instalação 
go get github.com/fastcomments/fastcomments-go
Usando o Cliente da API
API Pública (Sem Autenticação)
A PublicAPI permite acesso não autenticado a endpoints públicos:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Obter comentários usando 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 Default (Requer Chave API)
A DefaultAPI requer autenticação usando sua chave API:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Criar contexto autenticado com chave API
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// Obter comentários usando a DefaultAPI autenticada
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 de Moderação (Painel do Moderador)
A ModerationAPI fornece um conjunto extenso de APIs de moderação ao vivo e rápidas. Todos os métodos de moderação aceitam um parâmetro sso e podem autenticar via SSO ou um cookie de sessão do FastComments.com:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Listar comentários para moderação usando a 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)
}
Uso 
SSO Simples
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Criar token SSO simples
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)
// Use o token SSO para fazer uma chamada de API autenticada
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 Seguro
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Criar token SSO seguro
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)
// Use o token SSO para fazer uma chamada de API autenticada
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)
}
Agregação 
Agrega documentos agrupando-os (se groupBy for fornecido) e aplicando múltiplas operações. Diferentes operações (por exemplo sum, countDistinct, avg, etc.) são suportadas.
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| parentTenantId | string | query | Não | |
| includeStats | boolean | query | Não |
Resposta
Retorna: AggregateResponse
Exemplo

ObterLogsDeAuditoria 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| limit | number | query | Não | |
| skip | number | query | Não | |
| order | string | query | Não | |
| after | number | query | Não | |
| before | number | query | Não |
Resposta
Retorna: GetAuditLogsResponse
Exemplo

LogoutPúblico 
Resposta
Retorna: APIEmptyResponse
Exemplo

BloquearDoComentárioPúblico 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: BlockSuccess
Exemplo

DesbloquearComentárioPúblico 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: UnblockSuccess
Exemplo

ComentáriosVerificadosParaBloqueados 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentIds | string | query | Sim | Uma lista de IDs de comentários separados por vírgula. |
| sso | string | query | Não |
Resposta
Retorna: CheckBlockedCommentsResponse
Exemplo

BloquearUsuárioDoComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: BlockSuccess
Exemplo

CriarComentárioPúblico 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: SaveCommentsResponseWithPresence
Exemplo

ExcluirComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| contextUserId | string | query | Não | |
| isLive | boolean | query | Não |
Resposta
Retorna: DeleteCommentResult
Exemplo

ExcluirComentárioPúblico 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| editKey | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: PublicAPIDeleteCommentResponse
Exemplo

ExcluirVotoDoComentário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| voteId | string | path | Sim | |
| urlId | string | query | Sim | |
| broadcastId | string | query | Sim | |
| editKey | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: VoteDeleteResponse
Exemplo

DenunciarComentário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: FlagCommentResponse
Exemplo

ObterComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIGetCommentResponse
Exemplo

ObterComentários 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| page | integer | query | Não | |
| limit | integer | query | Não | |
| skip | integer | query | Não | |
| asTree | boolean | query | Não | |
| skipChildren | integer | query | Não | |
| limitChildren | integer | query | Não | |
| maxTreeDepth | integer | query | Não | |
| urlId | string | query | Não | |
| userId | string | query | Não | |
| anonUserId | string | query | Não | |
| contextUserId | string | query | Não | |
| hashTag | string | query | Não | |
| parentId | string | query | Não | |
| direction | string | query | Não | |
| fromDate | integer | query | Não | |
| toDate | integer | query | Não |
Resposta
Retorna: APIGetCommentsResponse
Exemplo

ObterComentáriosPúblicos 
req tenantId urlId
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| page | integer | query | Não | |
| direction | string | query | Não | |
| sso | string | query | Não | |
| skip | integer | query | Não | |
| skipChildren | integer | query | Não | |
| limit | integer | query | Não | |
| limitChildren | integer | query | Não | |
| countChildren | boolean | query | Não | |
| fetchPageForCommentId | string | query | Não | |
| includeConfig | boolean | query | Não | |
| countAll | boolean | query | Não | |
| includei10n | boolean | query | Não | |
| locale | string | query | Não | |
| modules | string | query | Não | |
| isCrawler | boolean | query | Não | |
| includeNotificationCount | boolean | query | Não | |
| asTree | boolean | query | Não | |
| maxTreeDepth | integer | query | Não | |
| useFullTranslationIds | boolean | query | Não | |
| parentId | string | query | Não | |
| searchText | string | query | Não | |
| hashTags | array | query | Não | |
| userId | string | query | Não | |
| customConfigStr | string | query | Não | |
| afterCommentId | string | query | Não | |
| beforeCommentId | string | query | Não |
Resposta
Retorna: GetCommentsResponseWithPresencePublicComment
Exemplo

ObterTextoDoComentário 
Parameters
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| editKey | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: PublicAPIGetCommentTextResponse
Exemplo

ObterNomesDeUsuáriosQueVotaramComentário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| dir | integer | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetCommentVoteUserNamesSuccessResponse
Exemplo

TrancarComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

FixarComentário 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: ChangeCommentPinStatusResponse
Exemplo

SalvarComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| isLive | boolean | query | Não | |
| doSpamCheck | boolean | query | Não | |
| sendEmails | boolean | query | Não | |
| populateNotifications | boolean | query | Não |
Resposta
Retorna: APISaveCommentResponse
Exemplo

SalvarComentáriosEmLote 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| isLive | boolean | query | Não | |
| doSpamCheck | boolean | query | Não | |
| sendEmails | boolean | query | Não | |
| populateNotifications | boolean | query | Não |
Resposta
Retorna: []SaveCommentsBulkResponse
Exemplo

DefinirTextoDoComentário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| editKey | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: PublicAPISetCommentTextResponse
Exemplo

DesbloquearUsuárioDoComentário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: UnblockSuccess
Exemplo

RemoverDenúnciaDoComentário 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: FlagCommentResponse
Exemplo

DestrancarComentário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

DesfixarComentário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: ChangeCommentPinStatusResponse
Exemplo

AtualizarComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| contextUserId | string | query | Não | |
| doSpamCheck | boolean | query | Não | |
| isLive | boolean | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

VotarComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| urlId | string | query | Sim | |
| broadcastId | string | query | Sim | |
| sessionId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: VoteResponse
Exemplo

ObterComentáriosDoUsuário 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| userId | string | query | Não | |
| direction | string | query | Não | |
| repliesToUserId | string | query | Não | |
| page | number | query | Não | |
| includei10n | boolean | query | Não | |
| locale | string | query | Não | |
| isCrawler | boolean | query | Não |
Resposta
Retorna: GetCommentsForUserResponse
Exemplo

AdicionarConfiguraçãoDeDomínio 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: AddDomainConfigResponse
Exemplo

ExcluirConfiguraçãoDeDomínio 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| domain | string | path | Sim |
Resposta
Retorna: DeleteDomainConfigResponse
Exemplo

ObterConfiguraçãoDeDomínio 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| domain | string | path | Sim |
Resposta
Retorna: GetDomainConfigResponse
Exemplo

ObterConfiguraçõesDeDomínio 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: GetDomainConfigsResponse
Exemplo

AtualizarParcialConfiguraçãoDeDomínio 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| domainToUpdate | string | path | Sim |
Resposta
Retorna: PatchDomainConfigResponse
Exemplo

SubstituirConfiguraçãoDeDomínio 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| domainToUpdate | string | path | Sim |
Resposta
Retorna: PutDomainConfigResponse
Exemplo

CriarModeloDeEmail 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateEmailTemplateResponse
Exemplo

ExcluirModeloDeEmail 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

ExcluirErroDeRenderizaçãoDoModeloDeEmail 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| errorId | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterModeloDeEmail 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetEmailTemplateResponse
Exemplo

ObterDefiniçõesDoModeloDeEmail 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: GetEmailTemplateDefinitionsResponse
Exemplo

ObterErrosDeRenderizaçãoDoModeloDeEmail 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetEmailTemplateRenderErrorsResponse
Exemplo

ObterModelosDeEmail 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetEmailTemplatesResponse
Exemplo

RenderizarModeloDeEmail 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| locale | string | query | Não |
Resposta
Retorna: RenderEmailTemplateResponse
Exemplo

AtualizarModeloDeEmail 
Parâmetros
| Name | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterLogDeEvento 
req tenantId urlId userIdWS
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| userIdWS | string | query | Sim | |
| startTime | integer | query | Sim | |
| endTime | integer | query | Não |
Resposta
Retorna: GetEventLogResponse
Exemplo

ObterLogDeEventoGlobal 
req tenantId urlId userIdWS
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| userIdWS | string | query | Sim | |
| startTime | integer | query | Sim | |
| endTime | integer | query | Não |
Resposta
Retorna: GetEventLogResponse
Exemplo

CriarPostagemNoFeed 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| broadcastId | string | query | Não | |
| isLive | boolean | query | Não | |
| doSpamCheck | boolean | query | Não | |
| skipDupCheck | boolean | query | Não |
Resposta
Retorna: CreateFeedPostsResponse
Exemplo

CriarPostagemNoFeedPública 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: CreateFeedPostResponse
Exemplo

ExcluirPostagemNoFeedPública 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| postId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: DeleteFeedPostPublicResponse
Exemplo

ObterPostagensNoFeed 
req tenantId afterId
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| afterId | string | query | Não | |
| limit | integer | query | Não | |
| tags | array | query | Não |
Resposta
Retorna: GetFeedPostsResponse
Exemplo

ObterPostagensNoFeedPúblicas 
req tenantId afterId
Parâmetros
| Nome | Type | Location | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| afterId | string | query | Não | |
| limit | integer | query | Não | |
| tags | array | query | Não | |
| sso | string | query | Não | |
| isCrawler | boolean | query | Não | |
| includeUserInfo | boolean | query | Não |
Resposta
Retorna: PublicFeedPostsResponse
Exemplo

ObterEstatísticasDasPostagensNoFeed 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| postIds | array | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: FeedPostsStatsResponse
Exemplo

ObterReaçõesDoUsuárioPúblicas 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| postIds | array | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: UserReactsResponse
Exemplo

ReagirÀPostagemNoFeedPública 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| postId | string | path | Sim | |
| isUndo | boolean | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ReactFeedPostResponse
Exemplo

AtualizarPostagemNoFeed 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

AtualizarPostagemNoFeedPública 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| postId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: CreateFeedPostResponse
Exemplo

DenunciarComentárioPúblico 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| isFlagged | boolean | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterGifGrande 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| largeInternalURLSanitized | string | query | Sim |
Resposta
Retorna: GifGetLargeResponse
Exemplo

BuscarGIFs 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| search | string | query | Sim | |
| locale | string | query | Não | |
| rating | string | query | Não | |
| page | number | query | Não |
Resposta
Retorna: GetGifsSearchResponse
Exemplo

ObterGIFsEmAlta 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| locale | string | query | Não | |
| rating | string | query | Não | |
| page | number | query | Não |
Resposta
Retorna: GetGifsTrendingResponse
Exemplo

AdicionarHashtag 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateHashTagResponse
Exemplo

AdicionarHashtagsEmLote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: BulkCreateHashTagsResponse
Exemplo

ExcluirHashtag 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| tag | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterHashtags 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| page | number | query | Não |
Resposta
Retorna: GetHashTagsResponse
Exemplo

AtualizarParcialHashtag 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| tag | string | path | Sim |
Resposta
Retorna: UpdateHashTagResponse
Exemplo

ExcluirVotoDeModeração 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| voteId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: VoteDeleteResponse
Exemplo

ObterComentáriosDaAPI 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Resposta
Retorna: ModerationAPIGetCommentsResponse
Exemplo

ObterStatusDeExportaçãoDaAPI 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| batchJobId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationExportStatusResponse
Exemplo

ObterIdsDaAPI 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| text-search | string | query | Não | |
| byIPFromComment | string | query | Não | |
| filters | string | query | Não | |
| searchFilters | string | query | Não | |
| afterId | string | query | Não | |
| demo | boolean | query | Não | |
| sso | string | query | Não |
Response
Retorna: ModerationAPIGetCommentIdsResponse
Example

ObterUsuáriosBanidosDoComentário 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Response
Returns: GetBannedUsersFromCommentResponse
Exemplo

ObterStatusDeBanimentoDoComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetCommentBanStatusResponse
Exemplo

ObterFilhosDoComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: ModerationAPIChildCommentsResponse
Exemplo

ObterContagem 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Resposta
Retorna: ModerationAPICountCommentsResponse
Exemplo

ObterContagens 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetBannedUsersCountResponse
Exemplo

ObterLogs 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: ModerationAPIGetLogsResponse
Exemplo

ObterDistintivosManuais 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetTenantManualBadgesResponse
Exemplo

ObterDistintivosManuaisDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| badgesUserId | string | query | Não | |
| commentId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: GetUserManualBadgesResponse
Exemplo

ObterComentárioDeModeração 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| includeEmail | boolean | query | Não | |
| includeIP | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationAPICommentResponse
Exemplo

ObterTextoDoComentárioDeModeração 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetCommentTextResponse
Exemplo

ObterResumoPréBanimento 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| includeByUserIdAndEmail | boolean | query | Não | |
| includeByIP | boolean | query | Não | |
| includeByEmailDomain | boolean | query | Não | |
| sso | string | query | Não |
Response
Retorna: PreBanSummary
Example

ObterResumoDaBuscaDeComentários 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| value | string | query | Não | |
| filters | string | query | Não | |
| searchFilters | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationCommentSearchResponse
Exemplo

ObterPáginasDeBusca 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: ModerationPageSearchResponse
Exemplo

ObterSitesDeBusca 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| value | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationSiteSearchResponse
Exemplo

ObterSugestõesDeBusca 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| text-search | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationSuggestResponse
Exemplo

ObterUsuáriosDeBusca 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| value | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationUserSearchResponse
Exemplo

ObterFatorDeConfiança 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: GetUserTrustFactorResponse
Exemplo

ObterPreferênciaDeBanimentoDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIModerateGetUserBanPreferencesResponse
Exemplo

ObterPerfilInternoDoUsuário 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Response
Retorna: GetUserInternalProfileResponse
Exemplo

AjustarVotosDoComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: AdjustVotesResponse
Exemplo

ExportarAPI 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| text-search | string | query | Não | |
| byIPFromComment | string | query | Não | |
| filters | string | query | Não | |
| searchFilters | string | query | Não | |
| sorts | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationExportResponse
Exemplo

BanirUsuárioDoComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| banEmail | boolean | query | Não | |
| banEmailDomain | boolean | query | Não | |
| banIP | boolean | query | Não | |
| deleteAllUsersComments | boolean | query | Não | |
| bannedUntil | string | query | Não | |
| isShadowBan | boolean | query | Não | |
| updateId | string | query | Não | |
| banReason | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: BanUserFromCommentResult
Exemplo

DesfazerBanimentoDeUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

ResumoPréBanimentoEmLote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Resposta
Retorna: BulkPreBanSummary
Exemplo

PostarComentáriosPorIds 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Resposta
Retorna: ModerationAPIChildCommentsResponse
Exemplo

DenunciarComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

RemoverComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: PostRemoveCommentApiResponse
Exemplo

RestaurarComentárioExcluído 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: APIEmptyResponse
Exemplo

DefinirStatusDeAprovaçãoDoComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| approved | boolean | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: SetCommentApprovedResponse
Exemplo

DefinirStatusDeRevisãoDoComentário 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| reviewed | boolean | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Response
Returns: APIEmptyResponse
Example

DefinirStatusDeSpamDoComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: APIEmptyResponse
Exemplo

DefinirTextoDoComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: SetCommentTextResponse
Exemplo

RemoverDenúnciaDoComentário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: APIEmptyResponse
Exemplo

Votar 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: VoteResponse
Exemplo

ConcederDistintivo 
Parâmetros
| 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 |
Resposta
Returns: AwardUserBadgeResponse
Exemplo

FecharThread 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

RemoverDistintivo 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| badgeId | string | query | Sim | |
| userId | string | query | Não | |
| commentId | string | query | Não | |
| broadcastId | string | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: RemoveUserBadgeResponse
Exemplo

ReabrirThread 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

DefinirFatorDeConfiança 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| trustFactor | string | query | Não | |
| sso | string | query | Não |
Response
Retorna: SetUserTrustFactorResponse
Exemplo

CriarModerador 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateModeratorResponse
Exemplo

ExcluirModerador 
Parameters
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| sendEmail | string | query | Não |
Response
Retorna: APIEmptyResponse
Example

ObterModerador 
Parâmetros
| Name | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetModeratorResponse
Exemplo

ObterModeradores 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetModeratorsResponse
Exemplo

EnviarConvite 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| fromName | string | query | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

AtualizarModerador 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

ExcluirContagemDeNotificações 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterContagemDeNotificaçõesEmCache 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetCachedNotificationCountResponse
Exemplo

ObterContagemDeNotificações 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| urlId | string | query | Não | |
| fromCommentId | string | query | Não | |
| viewed | boolean | query | Não | |
| type | string | query | Não |
Resposta
Retorna: GetNotificationCountResponse
Exemplo

ObterNotificações 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| urlId | string | query | Não | |
| fromCommentId | string | query | Não | |
| viewed | boolean | query | Não | |
| type | string | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: GetNotificationsResponse
Exemplo

AtualizarNotificação 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

CriarReaçãoDePáginaV1 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| title | string | query | Não |
Resposta
Retorna: CreateV1PageReact
Exemplo

CriarReaçãoDePáginaV2 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| id | string | query | Sim | |
| title | string | query | Não |
Resposta
Retorna: CreateV1PageReact
Exemplo

ExcluirReaçãoDePáginaV1 
Parâmetros
| Nome | Tipo | Location | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim |
Resposta
Retorna: CreateV1PageReact
Exemplo

ExcluirReaçãoDePáginaV2 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| id | string | query | Sim |
Resposta
Retorna: CreateV1PageReact
Exemplo

ObterCurtidasDePáginaV1 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim |
Resposta
Retorna: GetV1PageLikes
Exemplo

ObterReaçõesDePáginaV2 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim |
Resposta
Retorna: GetV2PageReacts
Exemplo

ObterUsuáriosQueReagiramPáginaV2 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Resposta
Retorna: GetV2PageReactUsersResponse
Exemplo

AdicionarPágina 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: AddPageAPIResponse
Exemplo

ExcluirPágina 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: DeletePageAPIResponse
Exemplo

ObterUsuáriosOffline 
Comentadores anteriores na página que NÃO estão atualmente online. Ordenados por displayName. Use isto após esgotar /users/online para renderizar uma seção "Membros". Paginação por cursor em commenterName: o servidor percorre o índice parcial {tenantId, urlId, commenterName} index a partir de afterName para frente via $gt, sem custo de $skip.
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | Page URL identifier (cleaned server-side). |
| afterName | string | query | Não | Cursor: passe nextAfterName da resposta anterior. |
| afterUserId | string | query | Não | Desempate do cursor: passe nextAfterUserId da resposta anterior. Obrigatório quando afterName estiver definido para que empates de nome não façam entradas serem descartadas. |
Resposta
Retorna: PageUsersOfflineResponse
Exemplo

ObterUsuáriosOnline 
Atualmente, visualizadores online de uma página: pessoas cuja sessão websocket está inscrita na página agora. Retorna anonCount + totalCount (assinantes em toda a sala, incluindo visualizadores anônimos que não enumeramos).
Parâmetros
| Nome | Tipo | Location | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | Identificador da URL da página (limpo no servidor). |
| afterName | string | query | Não | Cursor: passe nextAfterName da resposta anterior. |
| afterUserId | string | query | Não | Desempate do cursor: passe nextAfterUserId da resposta anterior. Obrigatório quando afterName estiver definido para que empates de nome não descartem entradas. |
Resposta
Retorna: PageUsersOnlineResponse
Exemplo

ObterPáginaPorIdURL 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim |
Resposta
Retorna: GetPageByURLIdAPIResponse
Exemplo

ObterPáginas 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: GetPagesAPIResponse
Exemplo

ObterPáginasPúblicas 
Lista páginas para um tenant. Usado pelo cliente desktop FChat para preencher sua lista de salas.
Requer que enableFChat seja true na resolved custom config para cada página.
Páginas que requerem SSO são filtradas de acordo com o acesso de grupo do usuário solicitante.
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| cursor | string | query | Não | Cursor opaco de paginação retornado como nextCursor de uma requisição anterior. Vinculado ao mesmo sortBy. |
| limit | integer | query | Não | 1..200, padrão 50 |
| q | string | query | Não | Filtro opcional de prefixo do título, insensível a maiúsculas/minúsculas. |
| sortBy | string | query | Não | Ordem de classificação. updatedAt (padrão, mais recentes primeiro), commentCount (mais comentários primeiro), ou title (alfabética). |
| hasComments | boolean | query | Não | Se true, retorna apenas páginas com pelo menos um comentário. |
Resposta
Retorna: GetPublicPagesResponse
Exemplo

ObterInformaçõesDosUsuários 
Informações em massa de usuários para um tenant. Dado userIds, retorna informações de exibição de User / SSOUser. Usado pelo widget de comentários para enriquecer usuários que acabaram de aparecer via um evento de presença. Sem contexto de página: a privacidade é aplicada de forma uniforme (perfis privados são mascarados).
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| ids | string | query | Sim | IDs de usuário separados por vírgula. |
Resposta
Retorna: PageUsersInfoResponse
Exemplo

AtualizarParcialPágina 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: PatchPageAPIResponse
Exemplo

ExcluirEventoWebhookPendente 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterContagemDeEventosWebhookPendentes 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | query | Não | |
| externalId | string | query | Não | |
| eventType | string | query | Não | |
| type | string | query | Não | |
| domain | string | query | Não | |
| attemptCountGT | number | query | Não |
Resposta
Retorna: GetPendingWebhookEventCountResponse
Exemplo

ObterEventosWebhookPendentes 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | query | Não | |
| externalId | string | query | Não | |
| eventType | string | query | Não | |
| type | string | query | Não | |
| domain | string | query | Não | |
| attemptCountGT | number | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: GetPendingWebhookEventsResponse
Exemplo

CriarConfiguraçãoDePergunta 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateQuestionConfigResponse
Exemplo

ExcluirConfiguraçãoDePergunta 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterConfiguraçãoDePergunta 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetQuestionConfigResponse
Exemplo

ObterConfiguraçõesDePergunta 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetQuestionConfigsResponse
Exemplo

AtualizarConfiguraçãoDePergunta 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

CriarResultadoDePergunta 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateQuestionResultResponse
Exemplo

ExcluirResultadoDePergunta 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterResultadoDePergunta 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetQuestionResultResponse
Exemplo

ObterResultadosDePergunta 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Não | |
| userId | string | query | Não | |
| startDate | string | query | Não | |
| questionId | string | query | Não | |
| questionIds | string | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: GetQuestionResultsResponse
Exemplo

AtualizarResultadoDePergunta 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

AgregarResultadosDePergunta 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| questionId | string | query | Não | |
| questionIds | array | query | Não | |
| urlId | string | query | Não | |
| timeBucket | string | query | Não | |
| startDate | string | query | Não | |
| forceRecalculate | boolean | query | Não |
Resposta
Retorna: AggregateQuestionResultsResponse
Exemplo

AgregaçãoEmLoteDeResultadosDePergunta 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| forceRecalculate | boolean | query | Não |
Resposta
Retorna: BulkAggregateQuestionResultsResponse
Exemplo

CombinarComentáriosComResultadosDePergunta 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| questionId | string | query | Não | |
| questionIds | array | query | Não | |
| urlId | string | query | Não | |
| startDate | string | query | Não | |
| forceRecalculate | boolean | query | Não | |
| minValue | number | query | Não | |
| maxValue | number | query | Não | |
| limit | number | query | Não |
Resposta
Retorna: CombineQuestionResultsWithCommentsResponse
Exemplo

AdicionarUsuárioSSO 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: AddSSOUserAPIResponse
Exemplo

ExcluirUsuárioSSO 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| deleteComments | boolean | query | Não | |
| commentDeleteMode | string | query | Não |
Resposta
Retorna: DeleteSSOUserAPIResponse
Exemplo

ObterUsuárioSSOPorEmail 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| string | path | Sim |
Resposta
Retorna: GetSSOUserByEmailAPIResponse
Exemplo

ObterUsuárioSSOPorId 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetSSOUserByIdAPIResponse
Exemplo

ObterUsuáriosSSO 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | integer | query | Não |
Resposta
Retorna: GetSSOUsersResponse
Exemplo

AtualizarParcialUsuárioSSO 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| updateComments | boolean | query | Não |
Resposta
Retorna: PatchSSOUserAPIResponse
Exemplo

SubstituirUsuárioSSO 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| updateComments | boolean | query | Não |
Resposta
Retorna: PutSSOUserAPIResponse
Exemplo

CriarAssinatura 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateSubscriptionAPIResponse
Exemplo

ExcluirAssinatura 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não |
Resposta
Retorna: DeleteSubscriptionAPIResponse
Exemplo

ObterAssinaturas 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não |
Resposta
Retorna: GetSubscriptionsAPIResponse
Exemplo

AtualizarAssinatura 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não |
Resposta
Retorna: UpdateSubscriptionAPIResponse
Exemplo

ObterUsosDiáriosDoInquilino 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| yearNumber | number | query | Não | |
| monthNumber | number | query | Não | |
| dayNumber | number | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: GetTenantDailyUsagesResponse
Exemplo

CriarPacoteDeInquilino 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateTenantPackageResponse
Exemplo

ExcluirPacoteDeInquilino 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterPacoteDeInquilino 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetTenantPackageResponse
Exemplo

ObterPacotesDeInquilino 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetTenantPackagesResponse
Exemplo

SubstituirPacoteDeInquilino 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

AtualizarPacoteDeInquilino 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

CriarUsuárioDeInquilino 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateTenantUserResponse
Exemplo

ExcluirUsuárioDeInquilino 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| deleteComments | string | query | Não | |
| commentDeleteMode | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterUsuárioDeInquilino 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetTenantUserResponse
Exemplo

ObterUsuáriosDeInquilino 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| skip | number | query | Não |
Resposta
Retorna: GetTenantUsersResponse
Exemplo

SubstituirUsuárioDeInquilino 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| updateComments | string | query | Não |
Response
Retorna: APIEmptyResponse
Exemplo

EnviarLinkDeLogin 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| redirectURL | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

AtualizarUsuárioDeInquilino 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| updateComments | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

CriarInquilino 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateTenantResponse
Exemplo

ExcluirInquilino 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| sure | string | query | Não |
Resposta
Retorna: APIEmptyResponse
Exemplo

ObterInquilino 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetTenantResponse
Exemplo

ObterInquilinos 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| meta | string | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: GetTenantsResponse
Exemplo

AtualizarInquilino 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Resposta
Retorna: APIEmptyResponse
Exemplo

AlterarEstadoDoTicket 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: ChangeTicketStateResponse
Exemplo

CriarTicket 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Sim |
Resposta
Retorna: CreateTicketResponse
Exemplo

ObterTicket 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não |
Resposta
Retorna: GetTicketResponse
Exemplo

ObterTickets 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| state | number | query | Não | |
| skip | number | query | Não | |
| limit | number | query | Não |
Resposta
Retorna: GetTicketsResponse
Exemplo

ObterTraduções 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| namespace | string | path | Sim | |
| component | string | path | Sim | |
| locale | string | query | Não | |
| useFullTranslationIds | boolean | query | Não |
Resposta
Retorna: GetTranslationsResponse
Exemplo

CarregarImagem 
Enviar e redimensionar uma imagem
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Predefinição de tamanho: "Default" (1000x1000px) ou "CrossPlatform" (cria tamanhos para dispositivos populares) |
| urlId | string | query | No | ID da página de onde o upload está sendo feito, para configurar |
Resposta
Retorna: UploadImageResponse
Exemplo

ObterProgressoDoDistintivoDoUsuárioPorId 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Resposta
Retorna: APIGetUserBadgeProgressResponse
Exemplo

ObterProgressoDoDistintivoDoUsuárioPorIdDeUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | path | Sim |
Resposta
Retorna: APIGetUserBadgeProgressResponse
Exemplo

ObterListaDeProgressoDeDistintivosDoUsuário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| limit | number | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: APIGetUserBadgeProgressListResponse
Exemplo

CriarDistintivoDoUsuário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: APICreateUserBadgeResponse
Exemplo

ExcluirDistintivoDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptySuccessResponse
Exemplo

ObterDistintivoDoUsuário 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIGetUserBadgeResponse
Exemplo

ObterDistintivosDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| userId | string | query | Não | |
| badgeId | string | query | Não | |
| type | number | query | Não | |
| displayedOnComments | boolean | query | Não | |
| limit | number | query | Não | |
| skip | number | query | Não |
Resposta
Retorna: APIGetUserBadgesResponse
Exemplo

AtualizarDistintivoDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptySuccessResponse
Exemplo

ObterContagemDeNotificaçõesDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetUserNotificationCountResponse
Exemplo

ObterNotificaçõesDoUsuário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Não | Usado para determinar se a página atual está inscrita. |
| pageSize | integer | query | Não | |
| afterId | string | query | Não | |
| includeContext | boolean | query | Não | |
| afterCreatedAt | integer | query | Não | |
| unreadOnly | boolean | query | Não | |
| dmOnly | boolean | query | Não | |
| noDm | boolean | query | Não | |
| includeTranslations | boolean | query | Não | |
| includeTenantNotifications | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: GetMyNotificationsResponse
Exemplo

RedefinirContagemDeNotificaçõesDoUsuário 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Resposta
Retorna: ResetUserNotificationsResponse
Exemplo

RedefinirNotificaçõesDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| afterId | string | query | Não | |
| afterCreatedAt | integer | query | Não | |
| unreadOnly | boolean | query | Não | |
| dmOnly | boolean | query | Não | |
| noDm | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ResetUserNotificationsResponse
Exemplo

AtualizarStatusDeAssinaturaDeNotificaçãoDeComentárioDoUsuário 
Ativar ou desativar notificações para um comentário específico.
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Resposta
Retorna: UpdateUserNotificationCommentSubscriptionStatusResponse
Exemplo

AtualizarStatusDeAssinaturaDeNotificaçãoDePáginaDoUsuário 
Ativar ou desativar notificações para uma página. Quando os usuários estão inscritos em uma página, notificações são criadas para novos comentários raiz, e também
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| url | string | query | Sim | |
| pageTitle | string | query | Sim | |
| subscribedOrUnsubscribed | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: UpdateUserNotificationPageSubscriptionStatusResponse
Exemplo

AtualizarStatusDeNotificaçãoDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| notificationId | string | path | Sim | |
| newStatus | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: UpdateUserNotificationStatusResponse
Exemplo

ObterStatusDePresençaDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
Resposta
Retorna: GetUserPresenceStatusesResponse
Exemplo

BuscarUsuários 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| usernameStartsWith | string | query | Não | |
| mentionGroupIds | array | query | Não | |
| sso | string | query | Não | |
| searchSection | string | query | Não |
Resposta
Retorna: SearchUsersResult
Exemplo

ObterUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim |
Resposta
Retorna: GetUserResponse
Exemplo

CriarVoto 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | query | Sim | |
| direction | string | query | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: VoteResponse
Exemplo

ExcluirVoto 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| editKey | string | query | Não |
Resposta
Retorna: VoteDeleteResponse
Exemplo

ObterVotos 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Resposta
Retorna: GetVotesResponse
Exemplo

ObterVotosDoUsuário 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim | |
| userId | string | query | Não | |
| anonUserId | string | query | Não |
Resposta
Retorna: GetVotesForUserResponse
Exemplo

Precisa de ajuda?
Se você encontrar algum problema ou tiver dúvidas sobre o SDK para Go, por favor:
Contribuindo
Contribuições são bem-vindas! Por favor, visite o repositório no GitHub para as diretrizes de contribuição.