
Idioma 🇧🇷 Português (Brasil)
Documentação
Começando
Referência API
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
Posts de 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 do Inquilino
Inquilinos
Tickets
Traduções
Enviar Imagem
Progresso de Insignia do Usuário
Insignias de Usuário
Notificações do Usuário
Status de Presença do Usuário
Busca de Usuário
Usuários
Votos
FastComments SDK Swift
Este é o SDK oficial em Swift para o FastComments.
SDK oficial em Swift 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 
Swift Package Manager
Adicione o seguinte ao seu Package.swift file:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.0.0")
]
Ou no Xcode:
- File > Add Packages...
- Insira a URL do repositório:
https://github.com/fastcomments/fastcomments-swift.git - Selecione a versão que deseja usar
Requirements
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Conteúdo da Biblioteca 
O SDK FastComments Swift consiste em vários módulos:
-
Client Module - Cliente de API para as REST APIs do FastComments
- Definições completas de tipos para todos os modelos de API
- Métodos autenticados (
DefaultAPI), públicos (PublicAPI) e de moderação (ModerationAPI) - Suporte completo a async/await
- Veja client/README.md para documentação detalhada da API
-
SSO Module - Utilitários de Single Sign-On do lado do servidor
- Geração segura de tokens para autenticação de usuários
- Suporte para modos SSO simples e seguro
- Assinatura de token baseada em HMAC-SHA256 usando CryptoKit
Início Rápido 
Usando a API Pública
import FastCommentsSwift
// Buscar comentários para uma página
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Usando a API Autenticada
import FastCommentsSwift
// Configure sua chave de API na configuração compartilhada (enviada como o cabeçalho x-api-key)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Buscar comentários usando a API autenticada
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Usando a API de Moderação
import FastCommentsSwift
// Métodos de moderação são autorizados com um token `sso` para o moderador atuante
// (gere-o com FastCommentsSSO, veja a seção SSO acima).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Usando SSO para Autenticação
SSO Seguro (Recomendado para Produção)
import FastCommentsSwift
let apiKey = "your-api-key"
// Criar dados de usuário SSO seguros (apenas no lado do servidor!)
let userData = SecureSSOUserData(
id: "user-123", // ID do Usuário
email: "user@example.com", // Email
username: "johndoe", // Nome de usuário
avatar: "https://example.com/avatar.jpg" // URL do avatar
)
// Gerar token SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Passe este token ao seu front-end para autenticação
} catch {
print("Error creating SSO token: \(error)")
}
SSO Simples (Para Desenvolvimento/Testes)
import FastCommentsSwift
// Criar dados de usuário SSO simples (não é necessária chave de API)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Gerar token SSO simples
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
Clientes API 
O FastComments SDK fornece três clientes de API:
PublicAPI - Métodos Seguros para Cliente
A PublicAPI contém métodos que são seguros para chamar a partir de código cliente (apps iOS/macOS). Esses métodos:
- Não exigem uma chave de API
- Podem usar tokens SSO para autenticação
- São limitados por taxa por usuário/dispositivo
- São adequados para aplicações voltadas ao usuário final
Caso de uso: Buscar e criar comentários no seu app iOS
DefaultAPI - Métodos Lado do Servidor
A DefaultAPI contém métodos autenticados que exigem uma chave de API. Esses métodos:
- Exigem sua chave de API FastComments
- Devem SER CHAMADOS SOMENTE a partir de código do lado do servidor
- Fornecem acesso total aos seus dados FastComments
- São limitados por taxa por locatário
Caso de uso: Operações administrativas, exportação em massa de dados, gerenciamento de usuários
ModerationAPI - Métodos do Painel de Moderação
A ModerationAPI fornece um amplo conjunto de APIs de moderação ao vivo e rápidas. Cada método ModerationAPI aceita um parâmetro sso e pode autenticar via SSO ou um cookie de sessão FastComments.com.
Caso de uso: Construir uma experiência de moderação para moderadores da sua comunidade
IMPORTANTE: Nunca exponha sua chave de API no código cliente. As chaves de API devem ser usadas apenas no lado do servidor.
Fazendo Chamadas API 
O SDK Swift usa a sintaxe moderna async/await para todas as chamadas de API:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Problemas Comuns 
Erros 401 Não Autorizado
Se você estiver recebendo erros 401 ao usar a API autenticada:
- Verifique sua chave de API: Certifique‑se de que está usando a chave de API correta do seu painel do FastComments
- Verifique o ID do tenant: Certifique‑se de que o ID do tenant corresponde à sua conta
- Formato da chave de API: A chave de API deve ser definida como o cabeçalho
x-api-keyna configuração compartilhada:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Usando a API errada: Certifique‑se de que está usando
DefaultAPI(nãoPublicAPI) para chamadas autenticadas
Problemas com Token SSO
Se os tokens SSO não estiverem funcionando:
- Use modo seguro em produção: Sempre use
FastCommentsSSO.createSecure()com sua chave de API para produção - Somente no lado do servidor: Gere tokens SSO seguros no seu servidor, nunca exponha sua chave de API aos clientes
- Verifique os dados do usuário: Certifique‑se de que todos os campos obrigatórios (id, email, nome de usuário) foram fornecidos
- Expiração do token: Tokens SSO seguros incluem um carimbo de tempo e podem expirar. Gere novos tokens conforme necessário.
Erros SSL/TLS
Se você encontrar erros SSL/TLS:
- Certifique‑se de que o Info.plist do seu app permite conexões HTTPS para fastcomments.com
- Verifique se você não está usando exceções do App Transport Security que possam bloquear a conexão.
Notas 
IDs de Broadcast
Você verá que deve passar um broadcastId em algumas chamadas de API. Quando receber eventos, você obterá esse ID de volta, para que saiba ignorar o evento se planeja aplicar alterações de forma otimista no cliente (o que você provavelmente vai querer fazer, já que oferece a melhor experiência). Passe um UUID aqui. O ID deve ser suficientemente único para não ocorrer duas vezes em uma sessão.
let broadcastId = UUID().uuidString
agregar 
Aggrega documentos agrupando-os (se groupBy for fornecido) e aplicando múltiplas operações.
Operações diferentes (por exemplo, sum, countDistinct, avg, etc.) são suportadas.
Parâmetros
| Nome | Tipo | Localização | 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 | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Resposta
Retorna: GetAuditLogsResponse
Exemplo

logoutPublico 
Resposta
Retorna: APIEmptyResponse
Exemplo

bloquearDoComentarioPublico 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Resposta
Retorna: BlockSuccess
Exemplo

desbloquearComentarioPublico 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Resposta
Retorna: UnblockSuccess
Exemplo

verificarComentariosBloqueados 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentIds | string | query | Sim | Uma lista separada por vírgulas de ids de comentários. |
| sso | string | query | Não |
Resposta
Retorna: CheckBlockedCommentsResponse
Exemplo

bloquearUsuarioDoComentario 
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

criarComentarioPublico 
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

excluirComentario 
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

excluirComentarioPublico 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| broadcastId | string | query | Sim | |
| editKey | string | query | Não | |
| sso | string | query | Não |
Response
Retorna: PublicAPIDeleteCommentResponse
Exemplo

excluirVotoComentario 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: VoteDeleteResponse
Exemplo

denunciarComentario 
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: FlagCommentResponse
Exemplo

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

obterComentarios 
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

obterComentariosPublicos 
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

obterTextoComentario 
Parâmetros
| Nome | Tipo | Localização | 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

obterNomesUsuariosVotoComentario 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| commentId | string | path | Sim | |
| dir | integer | query | Sim | |
| sso | string | query | Não |
Resposta
Retorna: GetCommentVoteUserNamesSuccessResponse
Exemplo

trancarComentario 
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

fixarComentario 
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: ChangeCommentPinStatusResponse
Exemplo

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

salvarComentariosEmLote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Resposta
Retorna: [SaveCommentsBulkResponse]
Exemplo

definirTextoComentario 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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

desbloquearUsuarioDoComentario 
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: UnblockSuccess
Exemplo

removerDenunciaComentario 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Resposta
Retorna: FlagCommentResponse
Exemplo

destrancarComentario 
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

desfixarComentario 
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: ChangeCommentPinStatusResponse
Exemplo

atualizarComentario 
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

votarComentario 
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

obterComentariosDoUsuario 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| userId | string | query | No | |
| direction | string | query | No | |
| repliesToUserId | string | query | No | |
| page | number | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| isCrawler | boolean | query | No |
Resposta
Retorna: GetCommentsForUserResponse
Exemplo

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

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

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

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

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

putConfigDominio 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| domainToUpdate | string | path | Sim |
Resposta
Retorna: PutDomainConfigResponse
Exemplo

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

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

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

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

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

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

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

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

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

obterLogEvento 
req tenantId urlId userIdWS
Parâmetros
| Nome | Tipo | Location | 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

obterLogEventoGlobal 
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

criarPostFeed 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Resposta
Retorna: CreateFeedPostsResponse
Exemplo

criarPostFeedPublico 
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

excluirPostFeedPublico 
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

obterPostsFeed 
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

obterPostsFeedPublicos 
req tenantId afterId
Parâmetros
| Nome | Tipo | Localização | 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

obterEstatisticasPostsFeed 
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

obterReacoesUsuarioPublicas 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Response
Retorna: UserReactsResponse
Example

reagirPostFeedPublico 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: ReactFeedPostResponse
Exemplo

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

atualizarPostFeedPublico 
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: CreateFeedPostResponse
Exemplo

denunciarComentarioPublico 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| largeInternalURLSanitized | string | query | Sim |
Resposta
Retorna: GifGetLargeResponse
Exemplo

buscarGifs 
Parâmetros
| Nome | Tipo | Localização | 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

gifsEmAlta 
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 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreateHashTagResponse
Example

adicionarHashtagsEmLote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Resposta
Returns: BulkCreateHashTagsResponse
Exemplo

excluirHashtag 
Parâmetros
| Name | Type | Location | Obrigatório | Description |
|---|---|---|---|---|
| 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

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

excluirVotoModeracao 
Parameters
| 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 |
Response
Retorna: VoteDeleteResponse
Example

obterComentariosApi 
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
Returns: ModerationAPIGetCommentsResponse
Exemplo

obterStatusExportacaoApi 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| batchJobId | string | query | Não | |
| sso | string | query | Não |
Response
Returns: ModerationExportStatusResponse
Example

obterIdsApi 
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 | |
| afterId | string | query | Não | |
| demo | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: ModerationAPIGetCommentIdsResponse
Exemplo

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

obterStatusBanComentario 
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

obterFilhosComentario 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Resposta
Returns: 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 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Resposta
Retorna: GetBannedUsersCountResponse
Exemplo

obterLogs 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| commentId | string | path | Sim | |
| sso | string | query | Não |
Response
Retorna: ModerationAPIGetLogsResponse
Example

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

obterInsigniasManuaisDoUsuario 
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

obterComentarioModeracao 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Resposta
Retorna: ModerationAPICommentResponse
Exemplo

obterTextoComentarioModeracao 
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

obterResumoPreBan 
Parâmetros
| 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 |
Resposta
Retorna: PreBanSummary
Exemplo

obterResumoBuscaComentarios 
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

obterPaginasBusca 
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: ModerationPageSearchResponse
Exemplo

obterSitesBusca 
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

obterSugestoesBusca 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: ModerationSuggestResponse
Exemplo

obterUsuariosBusca 
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

obterFatorConfianca 
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

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

obterPerfilInternoUsuario 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Resposta
Retorna: GetUserInternalProfileResponse
Exemplo

postAjustarVotosComentario 
Parameters
| 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 |
Response
Retorna: AdjustVotesResponse
Example

postExportarApi 
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

postBanirUsuarioDoComentario 
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

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

postResumoPreBanEmLote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| includeByUserIdAndEmail | boolean | query | Não | |
| includeByIP | boolean | query | Não | |
| includeByEmailDomain | boolean | query | Não | |
| sso | string | query | Não |
Resposta
Retorna: BulkPreBanSummary
Exemplo

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

postDenunciarComentario 
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

postRemoverComentario 
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

postRestaurarComentarioExcluido 
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

postDefinirStatusAprovacaoComentario 
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

postDefinirStatusRevisaoComentario 
Parâmetros
| 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 |
Resposta
Retorna: APIEmptyResponse
Exemplo

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

postDefinirTextoComentario 
Parameters
| 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 |
Response
Retorna: SetCommentTextResponse
Exemplo

postRemoverDenunciaComentario 
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

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

putConcederInsignia 
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: AwardUserBadgeResponse
Exemplo

putFecharThread 
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

putRemoverInsignia 
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

putReabrirThread 
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

definirFatorConfianca 
Parâmetros
| 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 |
Resposta
Retorna: SetUserTrustFactorResponse
Exemplo

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

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

obterModerador 
Parâmetros
| Nome | 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| fromName | string | query | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

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

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

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

obterContagemNotificacao 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Resposta
Retorna: GetNotificationCountResponse
Exemplo

obterNotificacoes 
Parameters
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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 |
Response
Retorna: GetNotificationsResponse
Exemplo

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

criarReacaoPaginaV1 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| title | string | query | Não |
Resposta
Retorna: CreateV1PageReact
Exemplo

criarReacaoPaginaV2 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| id | string | query | Sim | |
| title | string | query | Não |
Resposta
Retorna: CreateV1PageReact
Exemplo

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

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

obterCurtidasPaginaV1 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Resposta
Retorna: GetV1PageLikes
Exemplo

obterReacoesPaginaV2 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim |
Resposta
Retorna: GetV2PageReacts
Exemplo

obterUsuariosReacaoPaginaV2 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| urlId | string | query | Sim | |
| id | string | query | Sim |
Response
Retorna: GetV2PageReactUsersResponse
Exemplo

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

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

obterUsuariosOffline 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.
Parâmetros
| Nome | Tipo | Localização | 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 de cursor: passe nextAfterUserId da resposta anterior. Obrigatório quando afterName for definido para que empates de nome não removam entradas. |
Resposta
Returns: PageUsersOfflineResponse
Exemplo

obterUsuariosOnline 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Visualizadores atualmente online de uma página: pessoas cuja sessão websocket está inscrita na página neste momento.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Retorna anonCount + totalCount (assinantes de toda a sala, incluindo visualizadores anônimos que não enumeramos).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identificador da URL da página (limpo no servidor). |
| afterName | string | query | No | Cursor: passe nextAfterName da resposta anterior. |
| afterUserId | string | query | No | Desempate de cursor: passe nextAfterUserId da resposta anterior. Obrigatório quando afterName está definido para que empates de nome não removam entradas. |
Response
Returns: PageUsersOnlineResponse
Example

obterPaginaPorUrlId 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim |
Resposta
Retorna: GetPageByURLIdAPIResponse
Exemplo

obterPaginas 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Resposta
Retorna: GetPagesAPIResponse
Exemplo

obterPaginasPublicas 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Cursor de paginação opaco retornado como nextCursor de uma solicitação anterior. Vinculado ao mesmo sortBy. |
| limit | integer | query | No | 1..200, padrão 50 |
| q | string | query | No | Filtro opcional de prefixo de título sem distinção entre maiúsculas e minúsculas. |
| sortBy | string | query | No | Ordem de classificação. updatedAt (padrão, mais recentes primeiro), commentCount (mais comentários primeiro), ou title (alfabético). |
| hasComments | boolean | query | No | Se true, retornar apenas páginas com pelo menos um comentário. |
Response
Returns: GetPublicPagesResponse
Example

obterInfoUsuarios 
Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| ids | string | query | Sim | userIds separados por vírgula. |
Resposta
Retorna: PageUsersInfoResponse
Exemplo

patchPagina 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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

obterContagemEventosWebhookPendentes 
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
| 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 | |
| skip | number | query | Não |
Resposta
Retorna: GetPendingWebhookEventsResponse
Exemplo

criarConfigPergunta 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateQuestionConfigResponse
Exemplo

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

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

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

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

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

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

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

obterResultadosPergunta 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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

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

agregarResultadosPergunta 
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 | |
| timeBucket | string | query | Não | |
| startDate | string | query | Não | |
| forceRecalculate | boolean | query | Não |
Resposta
Retorna: AggregateQuestionResultsResponse
Exemplo

agregarResultadosPerguntaEmLote 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| forceRecalculate | boolean | query | Não |
Resposta
Retorna: BulkAggregateQuestionResultsResponse
Exemplo

combinarComentariosComResultadosPergunta 
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

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

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

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

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

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

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

putUsuarioSSO 
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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim |
Resposta
Retorna: CreateSubscriptionAPIResponse
Exemplo

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

obterAssinaturas 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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

obterUsosDiariosInquilino 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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

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

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

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

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

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

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

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

excluirUsuarioInquilino 
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

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

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

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

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

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

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

excluirInquilino 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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 | Sim | |
| id | string | path | Sim |
Resposta
Retorna: APIEmptyResponse
Exemplo

alterarEstadoTicket 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| userId | string | query | Não |
Resposta
Retorna: GetTicketResponse
Exemplo

obterTickets 
Parâmetros
| Nome | Tipo | Localização | 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

obterTraducoes 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| namespace | string | path | Sim | |
| component | string | path | Sim | |
| locale | string | query | Não | |
| useFullTranslationIds | boolean | query | Não |
Resposta
Retorna: GetTranslationsResponse
Exemplo

enviarImagem 
Upload and resize an image
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | path | Sim | |
| sizePreset | string | query | Não | Size preset: "Default" (1000x1000px) ou "CrossPlatform" (cria tamanhos para dispositivos populares) |
| urlId | string | query | Não | ID da página de onde o upload está ocorrendo, para configurar |
Resposta
Returns: UploadImageResponse
Exemplo

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

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

obterListaProgressoInsigniaUsuario 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Resposta
Retorna: APIGetUserBadgeProgressListResponse
Exemplo

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

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

obterInsigniaUsuario 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Retorna: APIGetUserBadgeResponse
Example

obterInsigniasUsuario 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Resposta
Retorna: APIGetUserBadgesResponse
Exemplo

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

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

obterNotificacoesUsuario 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Não | Usado para determinar se a página atual está subscrita. |
| 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

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

resetarNotificacoesUsuario 
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

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

atualizarStatusAssinaturaPaginaNotificacaoUsuario 
Ativa ou desativa notificações para uma página. Quando 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 | Localização | 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

atualizarStatusNotificacaoUsuario 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| notificationId | string | path | Sim | |
| newStatus | string | path | Sim | |
| sso | string | query | Não |
Resposta
Retorna: UpdateUserNotificationStatusResponse
Exemplo

obterStatusPresencaUsuario 
Parâmetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlIdWS | string | query | Sim | |
| userIds | string | query | Sim |
Resposta
Retorna: GetUserPresenceStatusesResponse
Exemplo

buscarUsuarios 
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

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

criarVoto 
Parâmetros
| Nome | Tipo | Localização | Obrigatório | Descrição |
|---|---|---|---|---|
| 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
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| id | string | path | Sim | |
| editKey | string | query | Não |
Resposta
Retorna: VoteDeleteResponse
Exemplo

obterVotos 
Parâmetros
| Nome | Tipo | Local | Obrigatório | Descrição |
|---|---|---|---|---|
| tenantId | string | query | Sim | |
| urlId | string | query | Sim |
Resposta
Retorna: GetVotesResponse
Exemplo

obterVotosDoUsuario 
Parameters
| 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 |
Response
Retorna: GetVotesForUserResponse
Example

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