
Idioma 🇪🇸 Español
Primeros Pasos
Documentación
Referencia de la API
Agregación
Registros de Auditoría
Autenticación
Bloquear desde Comentario
Comprobar Comentarios Bloqueados
Comentarios
Comentarios para Usuario
Configuraciones de Dominio
Plantillas de Correo Electrónico
Registro de Eventos
Publicaciones del Feed
Marcar Comentario
Gifs
Hashtags
Moderación
Moderadores
Conteo de Notificaciones
Notificaciones
Reacciones de Página
Páginas
Eventos de Webhook Pendientes
Configuraciones de Preguntas
Resultados de Preguntas
Agregación de Resultados de Preguntas
Usuarios SSO
Suscripciones
Uso Diario del Inquilino
Paquetes del Inquilino
Usuarios del Inquilino
Inquilinos
Tickets
Traducciones
Subir Imagen
Progreso de Insignias del Usuario
Insignias de Usuario
Notificaciones de Usuario
Estado de Presencia de Usuario
Búsqueda de Usuarios
Usuarios
Votos
SDK Swift de FastComments
Este es el SDK oficial de Swift para FastComments.
SDK oficial de Swift para la API de FastComments
Repositorio
Instalación 
Gestor de paquetes Swift
Agregue lo siguiente a su archivo Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.0.0")
]
O en Xcode:
- Archivo > Añadir paquetes...
- Introduzca la URL del repositorio:
https://github.com/fastcomments/fastcomments-swift.git - Seleccione la versión que desea usar
Requisitos
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Contenido de la Biblioteca 
El SDK de FastComments para Swift consta de varios módulos:
-
Client Module - cliente para las APIs REST de FastComments
- Definiciones completas de tipos para todos los modelos de la API
- Métodos autenticados (
DefaultAPI), públicos (PublicAPI) y de moderación (ModerationAPI) - Compatibilidad completa con async/await
- Consulte client/README.md para documentación detallada de la API
-
SSO Module - Utilidades del lado del servidor para inicio de sesión único (SSO)
- Generación segura de tokens para la autenticación de usuarios
- Soporte tanto para modos SSO simples como seguros
- Firma de tokens basada en HMAC-SHA256 utilizando CryptoKit
Inicio Rápido 
Usando la API pública
import FastCommentsSwift
// Obtener comentarios para una 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 la API autenticada
import FastCommentsSwift
// Configura tu clave API en la configuración compartida (se envía como encabezado x-api-key)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Obtener comentarios usando la 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 la API de moderación
import FastCommentsSwift
// Los métodos de moderación están autorizados con un token `sso` para el moderador actuante
// (genéralo con FastCommentsSSO, consulta la sección SSO arriba).
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 autenticación
SSO seguro (Recomendado para producción)
import FastCommentsSwift
let apiKey = "your-api-key"
// Crear datos de usuario SSO seguros (solo del lado del servidor)
let userData = SecureSSOUserData(
id: "user-123", // ID de usuario
email: "user@example.com", // Correo electrónico
username: "johndoe", // Nombre de usuario
avatar: "https://example.com/avatar.jpg" // URL del avatar
)
// Generar token SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Pasar este token a tu frontend para autenticación
} catch {
print("Error creating SSO token: \(error)")
}
SSO simple (Para desarrollo/pruebas)
import FastCommentsSwift
// Crear datos de usuario SSO simples (no se necesita clave API)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Generar token SSO simple
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 de API 
El SDK de FastComments proporciona tres clientes API:
PublicAPI - Métodos seguros para el cliente
El PublicAPI contiene métodos que son seguros de llamar desde código del lado del cliente (aplicaciones iOS/macOS). Estos métodos:
- No requieren una clave API
- Pueden usar tokens SSO para autenticación
- Tienen limitación de velocidad por usuario/dispositivo
- Son adecuados para aplicaciones dirigidas al usuario final
Caso de uso ejemplo: Obtener y crear comentarios en tu aplicación iOS
DefaultAPI - Métodos del lado del servidor
El DefaultAPI contiene métodos autenticados que requieren una clave API. Estos métodos:
- Requieren tu clave API de FastComments
- DEBEN ser llamados únicamente desde código del lado del servidor
- Proporcionan acceso completo a tus datos de FastComments
- Tienen limitación de velocidad por inquilino
Caso de uso ejemplo: Operaciones administrativas, exportación masiva de datos, gestión de usuarios
ModerationAPI - Métodos del panel de moderación
El ModerationAPI ofrece un conjunto extenso de APIs de moderación en vivo y rápidas. Cada método ModerationAPI acepta un parámetro sso y puede autenticarse vía SSO o una cookie de sesión de FastComments.com.
Caso de uso ejemplo: Construir una experiencia de moderación para los moderadores de tu comunidad
IMPORTANTE: Nunca expongas tu clave API en código del lado del cliente. Las claves API solo deben usarse del lado del servidor.
Realizar llamadas a la API 
El SDK de Swift utiliza la sintaxis moderna async/await para todas las llamadas a la API:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Problemas Comunes 
401 Errores No Autorizados
Si estás recibiendo errores 401 al usar la API autenticada:
- Verifica tu clave API: Asegúrate de estar usando la clave API correcta de tu panel de FastComments
- Verifica el ID del inquilino: Asegúrate de que el ID del inquilino coincida con tu cuenta
- Formato de la clave API: La clave API debe establecerse como el encabezado
x-api-keyen la configuración compartida:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Usando la API incorrecta: Asegúrate de estar usando
DefaultAPI(noPublicAPI) para llamadas autenticadas
Problemas con Tokens SSO
Si los tokens SSO no funcionan:
- Usa modo seguro para producción: Siempre usa
FastCommentsSSO.createSecure()con tu clave API para producción - Solo del lado del servidor: Genera tokens SSO seguros en tu servidor, nunca expongas tu clave API a los clientes
- Verifica los datos del usuario: Asegúrate de que todos los campos requeridos (id, email, nombre de usuario) se proporcionen
- Expiración del token: Los tokens SSO seguros incluyen una marca de tiempo y pueden expirar. Genera tokens nuevos según sea necesario.
Errores SSL/TLS
Si encuentras errores SSL/TLS:
- Asegúrate de que el Info.plist de tu app permita conexiones HTTPS a fastcomments.com
- Verifica que no estés usando excepciones de App Transport Security que puedan bloquear la conexión
Notas 
IDs de transmisión
Verás que debes pasar un broadcastId en algunas llamadas a la API. Cuando recibas eventos, obtendrás este ID de vuelta, de modo que sabrás ignorar el evento si planeas aplicar cambios de forma optimista en el cliente (lo cual probablemente querrás hacer, ya que ofrece la mejor experiencia). Pasa un UUID aquí. El ID debe ser lo suficientemente único para no repetirse en una sesión.
let broadcastId = UUID().uuidString
aggregate 
Agrupa documentos agrupándolos (si se proporciona groupBy) y aplicando múltiples operaciones.
Se admiten diferentes operaciones (p. ej., sum, countDistinct, avg, etc.).
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Respuesta
Devuelve: AggregateResponse
Ejemplo

getAuditLogs 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Respuesta
Devuelve: GetAuditLogsResponse
Ejemplo

logoutPublic 
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

blockFromCommentPublic 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: BlockSuccess
Ejemplo

unBlockCommentPublic 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UnblockSuccess
Ejemplo

checkedCommentsForBlocked 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentIds | string | query | Sí | Una lista separada por comas de identificadores de comentarios. |
| sso | string | query | No |
Respuesta
Devuelve: CheckBlockedCommentsResponse
Ejemplo

blockUserFromComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: BlockSuccess
Ejemplo

createCommentPublic 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: SaveCommentsResponseWithPresence
Ejemplo

deleteComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Respuesta
Devuelve: DeleteCommentResult
Ejemplo

deleteCommentPublic 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: PublicAPIDeleteCommentResponse
Ejemplo

deleteCommentVote 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| voteId | string | path | Sí | |
| urlId | string | query | Sí | |
| broadcastId | string | query | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: VoteDeleteResponse
Ejemplo

flagComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: FlagCommentResponse
Ejemplo

getComment 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIGetCommentResponse
Ejemplo

getComments 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Respuesta
Devuelve: APIGetCommentsResponse
Ejemplo

getCommentsPublic 
req tenantId urlId
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Respuesta
Devuelve: GetCommentsResponseWithPresencePublicComment
Ejemplo

getCommentText 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: PublicAPIGetCommentTextResponse
Ejemplo

getCommentVoteUserNames 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| dir | integer | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetCommentVoteUserNamesSuccessResponse
Ejemplo

lockComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Response
Devuelve: APIEmptyResponse
Ejemplo

pinComment 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: ChangeCommentPinStatusResponse
Ejemplo

saveComment 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respuesta
Devuelve: APISaveCommentResponse
Ejemplo

saveCommentsBulk 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respuesta
Devuelve: [SaveCommentsBulkResponse]
Ejemplo

setCommentText 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Returns: PublicAPISetCommentTextResponse
Ejemplo

unBlockUserFromComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: UnblockSuccess
Ejemplo

unFlagComment 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: FlagCommentResponse
Ejemplo

unLockComment 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

unPinComment 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: ChangeCommentPinStatusResponse
Ejemplo

updateComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Respuesta
Returns: APIEmptyResponse
Ejemplo

voteComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: VoteResponse
Ejemplo

getCommentsForUser 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Respuesta
Devuelve: GetCommentsForUserResponse
Ejemplo

addDomainConfig 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddDomainConfigResponse
Ejemplo

deleteDomainConfig 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domain | string | path | Sí |
Respuesta
Devuelve: DeleteDomainConfigResponse
Ejemplo

getDomainConfig 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domain | string | path | Sí |
Respuesta
Devuelve: GetDomainConfigResponse
Ejemplo

getDomainConfigs 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetDomainConfigsResponse
Ejemplo

patchDomainConfig 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domainToUpdate | string | path | Sí |
Respuesta
Devuelve: PatchDomainConfigResponse
Ejemplo

putDomainConfig 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domainToUpdate | string | path | Sí |
Respuesta
Devuelve: PutDomainConfigResponse
Ejemplo

createEmailTemplate 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateEmailTemplateResponse
Ejemplo

deleteEmailTemplate 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

deleteEmailTemplateRenderError 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| errorId | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getEmailTemplate 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetEmailTemplateResponse
Ejemplo

getEmailTemplateDefinitions 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetEmailTemplateDefinitionsResponse
Ejemplo

getEmailTemplateRenderErrors 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetEmailTemplateRenderErrorsResponse
Ejemplo

getEmailTemplates 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetEmailTemplatesResponse
Ejemplo

renderEmailTemplate 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| locale | string | query | No |
Respuesta
Devuelve: RenderEmailTemplateResponse
Ejemplo

updateEmailTemplate 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getEventLog 
req tenantId urlId userIdWS
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| userIdWS | string | query | Sí | |
| startTime | integer | query | Sí | |
| endTime | integer | query | No |
Respuesta
Devuelve: GetEventLogResponse
Ejemplo

getGlobalEventLog 
req tenantId urlId userIdWS
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| userIdWS | string | query | Sí | |
| startTime | integer | query | Sí | |
| endTime | integer | query | No |
Respuesta
Devuelve: GetEventLogResponse
Ejemplo

createFeedPost 
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 |
Respuesta
Devuelve: CreateFeedPostsResponse
Ejemplo

createFeedPostPublic 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateFeedPostResponse
Ejemplo

deleteFeedPostPublic 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Retorna: DeleteFeedPostPublicResponse
Ejemplo

getFeedPosts 
req tenantId afterId
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Respuesta
Devuelve: GetFeedPostsResponse
Ejemplo

getFeedPostsPublic 
req tenantId afterId
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Respuesta
Devuelve: PublicFeedPostsResponse
Ejemplo

getFeedPostsStats 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postIds | array | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: FeedPostsStatsResponse
Ejemplo

getUserReactsPublic 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postIds | array | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: UserReactsResponse
Ejemplo

reactFeedPostPublic 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ReactFeedPostResponse
Ejemplo

updateFeedPost 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

updateFeedPostPublic 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateFeedPostResponse
Ejemplo

flagCommentPublic 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| isFlagged | boolean | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getGifLarge 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| largeInternalURLSanitized | string | query | Sí |
Respuesta
Devuelve: GifGetLargeResponse
Ejemplo

getGifsSearch 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| search | string | query | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Respuesta
Devuelve: GetGifsSearchResponse
Ejemplo

getGifsTrending 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Respuesta
Devuelve: GetGifsTrendingResponse
Ejemplo

addHashTag 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateHashTagResponse
Ejemplo

addHashTagsBulk 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: BulkCreateHashTagsResponse
Ejemplo

deleteHashTag 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| tag | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getHashTags 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| page | number | query | No |
Respuesta
Devuelve: GetHashTagsResponse
Ejemplo

patchHashTag 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| tag | string | path | Sí |
Respuesta
Devuelve: UpdateHashTagResponse
Ejemplo

deleteModerationVote 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| voteId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: VoteDeleteResponse
Ejemplo

getApiComments 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| 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 |
Respuesta
Devuelve: ModerationAPIGetCommentsResponse
Ejemplo

getApiExportStatus 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Respuesta
Returns: ModerationExportStatusResponse
Ejemplo

getApiIds 
Parameters
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Response
Devuelve: ModerationAPIGetCommentIdsResponse
Example

getBanUsersFromComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: GetBannedUsersFromCommentResponse
Ejemplo

getCommentBanStatus 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetCommentBanStatusResponse
Ejemplo

getCommentChildren 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationAPIChildCommentsResponse
Ejemplo

getCount 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| 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 |
Respuesta
Devuelve: ModerationAPICountCommentsResponse
Ejemplo

getCounts 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetBannedUsersCountResponse
Ejemplo

getLogs 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Returns: ModerationAPIGetLogsResponse
Ejemplo

getManualBadges 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetTenantManualBadgesResponse
Ejemplo

getManualBadgesForUser 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Response
Devuelve: GetUserManualBadgesResponse
Example

getModerationComment 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationAPICommentResponse
Ejemplo

getModerationCommentText 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: GetCommentTextResponse
Ejemplo

getPreBanSummary 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: PreBanSummary
Ejemplo

getSearchCommentsSummary 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Respuesta
Retorna: ModerationCommentSearchResponse
Ejemplo

getSearchPages 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationPageSearchResponse
Ejemplo

getSearchSites 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| value | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationSiteSearchResponse
Ejemplo

getSearchSuggest 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Response
Returns: ModerationSuggestResponse
Example

getSearchUsers 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| value | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationUserSearchResponse
Ejemplo

getTrustFactor 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserTrustFactorResponse
Ejemplo

getUserBanPreference 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: APIModerateGetUserBanPreferencesResponse
Ejemplo

getUserInternalProfile 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserInternalProfileResponse
Ejemplo

postAdjustCommentVotes 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: AdjustVotesResponse
Ejemplo

postApiExport 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationExportResponse
Ejemplo

postBanUserFromComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: BanUserFromCommentResult
Ejemplo

postBanUserUndo 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Response
Returns: APIEmptyResponse
Example

postBulkPreBanSummary 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: BulkPreBanSummary
Ejemplo

postCommentsByIds 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Returns: ModerationAPIChildCommentsResponse
Ejemplo

postFlagComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Returns: APIEmptyResponse
Ejemplo

postRemoveComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: PostRemoveCommentApiResponse
Ejemplo

postRestoreDeletedComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

postSetCommentApprovalStatus 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: SetCommentApprovedResponse
Ejemplo

postSetCommentReviewStatus 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

postSetCommentSpamStatus 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Returns: APIEmptyResponse
Ejemplo

postSetCommentText 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: SetCommentTextResponse
Ejemplo

postUnFlagComment 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Returns: APIEmptyResponse
Ejemplo

postVote 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: VoteResponse
Ejemplo

putAwardBadge 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| badgeId | string | query | Sí | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: AwardUserBadgeResponse
Ejemplo

putCloseThread 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

putRemoveBadge 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| badgeId | string | query | Sí | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: RemoveUserBadgeResponse
Ejemplo

putReopenThread 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

setTrustFactor 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: SetUserTrustFactorResponse
Ejemplo

createModerator 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateModeratorResponse
Ejemplo

deleteModerator 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| sendEmail | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getModerator 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetModeratorResponse
Ejemplo

getModerators 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetModeratorsResponse
Ejemplo

sendInvite 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| fromName | string | query | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

updateModerator 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

deleteNotificationCount 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getCachedNotificationCount 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetCachedNotificationCountResponse
Ejemplo

getNotificationCount 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Respuesta
Devuelve: GetNotificationCountResponse
Ejemplo

getNotifications 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetNotificationsResponse
Ejemplo

updateNotification 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

createV1PageReact 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| title | string | query | No |
Respuesta
Devuelve: CreateV1PageReact
Ejemplo

createV2PageReact 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| id | string | query | Sí | |
| title | string | query | No |
Respuesta
Devuelve: CreateV1PageReact
Ejemplo

deleteV1PageReact 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí |
Respuesta
Devuelve: CreateV1PageReact
Ejemplo

deleteV2PageReact 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| id | string | query | Sí |
Respuesta
Devuelve: CreateV1PageReact
Ejemplo

getV1PageLikes 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí |
Respuesta
Devuelve: GetV1PageLikes
Ejemplo

getV2PageReacts 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí |
Respuesta
Devuelve: GetV2PageReacts
Ejemplo

getV2PageReactUsers 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| id | string | query | Sí |
Respuesta
Devuelve: GetV2PageReactUsersResponse
Ejemplo

addPage 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddPageAPIResponse
Ejemplo

deletePage 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: DeletePageAPIResponse
Ejemplo

getOfflineUsers 
Comentadores anteriores en la página que NO están actualmente en línea. Ordenados por displayName.
Utilízalo después de agotar /users/online para renderizar una sección "Members".
Paginación por cursor en commenterName: el servidor recorre el parcial {tenantId, urlId, commenterName} index desde afterName hacia adelante mediante $gt, sin costo de $skip.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Identificador de URL de la página (limpiado en el servidor). |
| afterName | string | query | No | Cursor: pasa nextAfterName de la respuesta anterior. |
| afterUserId | string | query | No | Desempate de cursor: pasa nextAfterUserId de la respuesta anterior. Requerido cuando afterName está establecido para que los empates de nombre no eliminen entradas. |
Response
Devuelve: PageUsersOfflineResponse
Example

getOnlineUsers 
Visores actualmente en línea de una página: personas cuya sesión websocket está suscrita a la página en este momento.
Devuelve anonCount + totalCount (suscriptores de toda la sala, incluidos los espectadores anónimos que no enumeramos).
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | Identificador de URL de la página (limpiado del lado del servidor). |
| afterName | string | query | No | Cursor: pasar nextAfterName de la respuesta anterior. |
| afterUserId | string | query | No | Desempate de cursor: pasar nextAfterUserId de la respuesta anterior. Requerido cuando afterName está definido para que los empates de nombre no eliminen entradas. |
Respuesta
Returns: PageUsersOnlineResponse
Ejemplo

getPageByURLId 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí |
Respuesta
Devuelve: GetPageByURLIdAPIResponse
Ejemplo

getPages 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetPagesAPIResponse
Ejemplo

getPagesPublic 
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 opaco de paginación devuelto como nextCursor de una solicitud anterior. Vinculado al mismo sortBy. |
| limit | integer | query | No | 1..200, predeterminado 50 |
| q | string | query | No | Filtro opcional de prefijo de título que no distingue entre mayúsculas y minúsculas. |
| sortBy | string | query | No | Orden de clasificación. updatedAt (predeterminado, más reciente primero), commentCount (más comentarios primero), o title (alfabético). |
| hasComments | boolean | query | No | Si es verdadero, solo devuelve páginas con al menos un comentario. |
Response
Returns: GetPublicPagesResponse
Example

getUsersInfo 
Información en bloque de usuarios para un tenant. Dado userIds, devuelve información para mostrar desde User / SSOUser. Usado por el widget de comentarios para enriquecer usuarios que acaban de aparecer vía un evento de presencia. Sin contexto de página: la privacidad se aplica de forma uniforme (los perfiles privados están enmascarados).
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| ids | string | query | Sí | userIds delimitados por comas. |
Respuesta
Devuelve: PageUsersInfoResponse
Ejemplo

patchPage 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: PatchPageAPIResponse
Ejemplo

deletePendingWebhookEvent 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getPendingWebhookEventCount 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Respuesta
Devuelve: GetPendingWebhookEventCountResponse
Ejemplo

getPendingWebhookEvents 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetPendingWebhookEventsResponse
Ejemplo

createQuestionConfig 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateQuestionConfigResponse
Ejemplo

deleteQuestionConfig 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getQuestionConfig 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetQuestionConfigResponse
Ejemplo

getQuestionConfigs 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetQuestionConfigsResponse
Ejemplo

updateQuestionConfig 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

createQuestionResult 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateQuestionResultResponse
Ejemplo

deleteQuestionResult 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getQuestionResult 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetQuestionResultResponse
Ejemplo

getQuestionResults 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetQuestionResultsResponse
Ejemplo

updateQuestionResult 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

aggregateQuestionResults 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Respuesta
Returns: AggregateQuestionResultsResponse
Ejemplo

bulkAggregateQuestionResults 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| forceRecalculate | boolean | query | No |
Respuesta
Devuelve: BulkAggregateQuestionResultsResponse
Ejemplo

combineCommentsWithQuestionResults 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Respuesta
Devuelve: CombineQuestionResultsWithCommentsResponse
Ejemplo

addSSOUser 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddSSOUserAPIResponse
Ejemplo

deleteSSOUser 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Respuesta
Devuelve: DeleteSSOUserAPIResponse
Ejemplo

getSSOUserByEmail 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| string | path | Sí |
Respuesta
Devuelve: GetSSOUserByEmailAPIResponse
Ejemplo

getSSOUserById 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetSSOUserByIdAPIResponse
Ejemplo

getSSOUsers 
Parámetros
| Name | Type | Location | Requerido | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | integer | query | No |
Respuesta
Devuelve: GetSSOUsersResponse
Ejemplo

patchSSOUser 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | boolean | query | No |
Respuesta
Devuelve: PatchSSOUserAPIResponse
Ejemplo

putSSOUser 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | boolean | query | No |
Respuesta
Devuelve: PutSSOUserAPIResponse
Ejemplo

createSubscription 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateSubscriptionAPIResponse
Ejemplo

deleteSubscription 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: DeleteSubscriptionAPIResponse
Ejemplo

getSubscriptions 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: GetSubscriptionsAPIResponse
Ejemplo

updateSubscription 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: UpdateSubscriptionAPIResponse
Ejemplo

getTenantDailyUsages 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantDailyUsagesResponse
Ejemplo

createTenantPackage 
Parameters
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenantPackageResponse
Ejemplo

deleteTenantPackage 
Parámetros
| Nombre | Type | Location | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getTenantPackage 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenantPackageResponse
Ejemplo

getTenantPackages 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantPackagesResponse
Ejemplo

replaceTenantPackage 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

updateTenantPackage 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

createTenantUser 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenantUserResponse
Ejemplo

deleteTenantUser 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getTenantUser 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenantUserResponse
Ejemplo

getTenantUsers 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantUsersResponse
Ejemplo

replaceTenantUser 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

sendLoginLink 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| redirectURL | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

updateTenantUser 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

createTenant 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenantResponse
Ejemplo

deleteTenant 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| sure | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getTenant 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenantResponse
Ejemplo

getTenants 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantsResponse
Ejemplo

updateTenant 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

changeTicketState 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: ChangeTicketStateResponse
Ejemplo

createTicket 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | Sí |
Respuesta
Devuelve: CreateTicketResponse
Ejemplo

getTicket 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: GetTicketResponse
Ejemplo

getTickets 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Respuesta
Devuelve: GetTicketsResponse
Ejemplo

getTranslations 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Respuesta
Devuelve: GetTranslationsResponse
Ejemplo

uploadImage 
Cargar y redimensionar una imagen
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| sizePreset | string | query | No | Preajuste de tamaño: "Default" (1000x1000px) o "CrossPlatform" (crea tamaños para dispositivos populares) |
| urlId | string | query | No | ID de página desde la que ocurre la carga, para configurar |
Respuesta
Devuelve: UploadImageResponse
Ejemplo

getUserBadgeProgressById 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIGetUserBadgeProgressResponse
Ejemplo

getUserBadgeProgressByUserId 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | path | Sí |
Respuesta
Devuelve: APIGetUserBadgeProgressResponse
Ejemplo

getUserBadgeProgressList 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: APIGetUserBadgeProgressListResponse
Ejemplo

createUserBadge 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: APICreateUserBadgeResponse
Ejemplo

deleteUserBadge 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptySuccessResponse
Ejemplo

getUserBadge 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIGetUserBadgeResponse
Ejemplo

getUserBadges 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: APIGetUserBadgesResponse
Ejemplo

updateUserBadge 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptySuccessResponse
Ejemplo

getUserNotificationCount 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserNotificationCountResponse
Ejemplo

getUserNotifications 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | No | Usado para determinar si la página actual está suscrita. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetMyNotificationsResponse
Ejemplo

resetUserNotificationCount 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: ResetUserNotificationsResponse
Ejemplo

resetUserNotifications 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ResetUserNotificationsResponse
Ejemplo

updateUserNotificationCommentSubscriptionStatus 
Habilitar o deshabilitar notificaciones para un comentario específico.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| notificationId | string | path | Sí | |
| optedInOrOut | string | path | Sí | |
| commentId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationCommentSubscriptionStatusResponse
Ejemplo

updateUserNotificationPageSubscriptionStatus 
Habilitar o deshabilitar las notificaciones para una página. Cuando los usuarios están suscritos a una página, se crean notificaciones para los nuevos comentarios raíz, y también
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| url | string | query | Sí | |
| pageTitle | string | query | Sí | |
| subscribedOrUnsubscribed | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationPageSubscriptionStatusResponse
Ejemplo

updateUserNotificationStatus 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| notificationId | string | path | Sí | |
| newStatus | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationStatusResponse
Ejemplo

getUserPresenceStatuses 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlIdWS | string | query | Yes | |
| userIds | string | query | Yes |
Respuesta
Devuelve: GetUserPresenceStatusesResponse
Ejemplo

searchUsers 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | ruta | Sí | |
| urlId | string | consulta | Sí | |
| usernameStartsWith | string | consulta | No | |
| mentionGroupIds | array | consulta | No | |
| sso | string | consulta | No | |
| searchSection | string | consulta | No |
Respuesta
Devuelve: SearchUsersResult
Ejemplo

getUser 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetUserResponse
Ejemplo

createVote 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | consulta | Sí | |
| commentId | string | consulta | Sí | |
| direction | string | consulta | Sí | |
| userId | string | consulta | No | |
| anonUserId | string | consulta | No |
Respuesta
Devuelve: VoteResponse
Ejemplo

deleteVote 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| editKey | string | query | No |
Respuesta
Devuelve: VoteDeleteResponse
Ejemplo

getVotes 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Respuesta
Devuelve: GetVotesResponse
Ejemplo

getVotesForUser 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Returns: GetVotesForUserResponse
Example

¿Necesitas ayuda?
Si encuentras algún problema o tienes preguntas sobre el SDK de Swift, por favor:
Contribuciones
¡Las contribuciones son bienvenidas! Por favor visita el repositorio de GitHub para las directrices de contribución.