
Idioma 🇪🇸 Español
Documentación
Primeros pasos
Inquilinos de agente
Agregado
Registros de auditoría
Autenticación
Trabajos por lotes
Bloquear desde comentario
Verificar comentarios bloqueados
Comentarios
Comentarios para usuario
Configuraciones de dominio
Plantillas de correo electrónico
Registro de eventos
Publicaciones de feed
Marcar comentario
GIFs
Etiquetas hash
Yo
Moderación
Moderadores
Recuento de notificaciones
Notificaciones
Reacciones de página
Páginas
Eventos de webhook pendientes
Votos de encuesta
Encuestas
Configuraciones de preguntas
Resultados de preguntas
Agregación de resultados de preguntas
Usuarios SSO
Suscripciones
Uso diario del inquilino
Paquetes de inquilino
Usuarios de inquilino
Inquilinos
Tickets
Traducciones
Subir imagen
Progreso de insignias de usuario
Insignias de usuario
Notificaciones de usuario
Estado de presencia del usuario
Búsqueda de usuarios
Usuarios
Votos
Webhooks
FastComments SDK de Java
Esto es el SDK oficial de Java para FastComments.
SDK oficial de Java para la API de FastComments
Repositorio
Agentes de codificación IA 
Proporcione a su agente de codificación el contexto de FastComments que necesita - widgets, configuración, SSO seguro, la API REST y los SDK:
npx skills add fastcomments/skills
Funciona con Claude Code, Codex, Cursor, Copilot, Gemini y cualquier otro agente que soporte la skills CLI.
Instalación 
Maven
Agrega el repositorio Repsy al POM de tu proyecto:
<repositories>
<repository>
<id>repsy</id>
<name>FastComments Maven Repository on Repsy</name>
<url>https://repo.repsy.io/mvn/winrid/fastcomments</url>
</repository>
</repositories>
Luego agrega las dependencias que necesites:
<dependencies>
<!-- Cliente API -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>client</artifactId>
<version>3.1.1</version>
</dependency>
<!-- Biblioteca Core (incluye SSO) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>core</artifactId>
<version>3.1.1</version>
</dependency>
<!-- Biblioteca PubSub (para eventos en vivo) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>pubsub</artifactId>
<version>3.1.1</version>
</dependency>
</dependencies>
Gradle
Agrega el repositorio Repsy a tu archivo build.gradle:
repositories {
mavenCentral()
maven {
url "https://repo.repsy.io/mvn/winrid/fastcomments"
}
}
dependencies {
// Cliente API
implementation "com.fastcomments:client:3.1.1"
// Biblioteca Core (incluye SSO)
implementation "com.fastcomments:core:3.1.1"
// Biblioteca PubSub (para eventos en vivo)
implementation "com.fastcomments:pubsub:3.1.1"
}
Contenido de la Biblioteca
Esta biblioteca contiene tres módulos: el cliente API generado, la biblioteca Java core que incluye utilidades escritas a mano para facilitar el trabajo con la API, y el módulo pubsub, que es una biblioteca para suscribirse a flujos de cambios.
- Documentación de la Biblioteca Cliente API
- Documentación de la Biblioteca Core, Incluyendo Ejemplos SSO
- Documentación de la Biblioteca PubSub
APIs Públicas vs Seguras
Para el cliente API, existen tres clases: DefaultApi, PublicApi y ModerationApi. La DefaultApi contiene métodos que requieren tu clave API, y la PublicApi contiene métodos que pueden invocarse directamente desde un navegador/dispositivo móvil/etc. sin autenticación.
La ModerationApi ofrece una amplia gama de APIs de moderación en tiempo real y rápidas. Cada método de ModerationApi acepta un parámetro sso y puede autenticarse mediante SSO o una cookie de sesión de FastComments.com.
Inicio rápido 
Uso de APIs autenticadas (DefaultApi)
Importante: Debes establecer tu clave API en el ApiClient antes de realizar solicitudes autenticadas. Si no lo haces, las solicitudes fallarán con un error 401.
import com.fastcomments.invoker.ApiClient;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.api.DefaultApi;
import com.fastcomments.model.*;
public class Example {
public static void main(String[] args) {
// Crear y configurar el cliente de API
ApiClient apiClient = new ApiClient();
// OBLIGATORIO: Establece tu clave API (consíguela desde el panel de FastComments)
apiClient.setApiKey("YOUR_API_KEY_HERE");
// Crea la instancia de la API con el cliente configurado
DefaultApi api = new DefaultApi(apiClient);
// Ahora puedes hacer llamadas a la API autenticadas
try {
// Ejemplo: Agregar un usuario SSO
CreateAPISSOUserData userData = new CreateAPISSOUserData();
userData.setId("user-123");
userData.setEmail("user@example.com");
userData.setDisplayName("John Doe");
AddSSOUserAPIResponse response = api.addSSOUser("YOUR_TENANT_ID", userData)
.execute();
System.out.println("User created: " + response);
} catch (ApiException e) {
System.err.println("Error: " + e.getResponseBody());
// Errores comunes:
// - 401: La clave API falta o no es válida
// - 400: La validación de la solicitud falló
}
}
}
Uso de APIs públicas (PublicApi)
Los endpoints públicos no requieren autenticación:
import com.fastcomments.api.PublicApi;
import com.fastcomments.invoker.ApiException;
PublicApi publicApi = new PublicApi();
try {
var response = publicApi.getCommentsPublic("YOUR_TENANT_ID", "page-url-id")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
Uso de las APIs de moderación (ModerationApi)
La ModerationApi alimenta el panel de moderación. Cada método acepta un parámetro sso que identifica al moderador autenticado por SSO en cuyo nombre se realiza la solicitud:
import com.fastcomments.api.ModerationApi;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.model.*;
ModerationApi moderationApi = new ModerationApi();
try {
// Listar comentarios en espera de moderación
ModerationAPIGetCommentsResponse response = moderationApi.getApiComments()
.sso("YOUR_SSO_TOKEN")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
Problemas comunes
- 401 "missing-api-key" error: Asegúrate de llamar a
apiClient.setApiKey("YOUR_KEY")antes de crear la instancia de DefaultApi. - Clase API equivocada: Usa
DefaultApipara solicitudes autenticadas en el servidor,PublicApipara solicitudes del lado del cliente/públicas. - Clave API nula: El SDK omitirá silenciosamente la autenticación si la clave API es nula, lo que provocará errores 401.
Notas 
IDs de Broadcast
Verás que se supone que debes pasar un broadcastId en algunas llamadas a la API. Cuando recibas eventos, obtendrás este ID de vuelta, así 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 como para no ocurrir dos veces en una sesión del navegador.
createAgentTenant 
Crea una nueva cuenta de prueba para un agente de IA sin que un humano se registre. No se necesita una clave API para llamar a este.
La respuesta contiene el ID del inquilino, una clave API que funciona inmediatamente contra la API REST y el servidor MCP, y una URL de reclamación. Proporcione la URL de reclamación a la persona para la que está trabajando: abrirla mientras está conectado a FastComments asocia la cuenta a ella. Las cuentas no reclamadas, y sus claves, se eliminan 72 horas después de su creación. Hasta que se reclamen, la cuenta tiene los límites de prueba estándar.
Response
Returns: CreateAgentTenantResponse
Example

agregar 
Agrega documentos agrupándolos (si se proporciona groupBy) y aplicando múltiples operaciones. Se admiten diferentes operaciones (p. ej. sum, countDistinct, avg, etc.).
Parámetros
| Nombre | Type | Location | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Respuesta
Devuelve: AggregateResponse
Ejemplo

getAuditLogs 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | El inquilino del que leer los registros de auditoría. |
| limit | integer | query | No | Cuántos registros devolver. Máximo 10000, por defecto 1000. |
| skip | integer | query | No | Cuántos registros omitir, para paginación. |
| order | string | query | No | Dirección de ordenación sobre la hora del evento. Por defecto DESC (más reciente primero). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | Sólo devolver eventos realizados por este nombre de usuario. |
| ip | string | query | No | Sólo devolver eventos de esta dirección IP. |
| crudType | string | query | No | Sólo devolver eventos de este tipo: c, r, u, d, o login. |
| resourceName | string | query | No | Sólo devolver eventos para este recurso, p. ej. User o Moderator. |
| targetId | string | query | No | Sólo devolver eventos cuyo objeto afectado tenga este id. |
| target | string | query | No | Coincidencia de subcadena sin distinción de mayúsculas/minúsculas en la etiqueta del objeto afectado, p. ej. un nombre de usuario o correo electrónico. |
| includeManagedTenants | boolean | query | No | También devolver eventos de los inquilinos que este inquilino gestiona. |
Respuesta
Devuelve: GetAuditLogsResponse
Ejemplo

logoutPublic 
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getBatchJob 
Estado, progreso y, una vez terminado, el resultado de un trabajo por lotes.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetBatchJobAPIResponse
Ejemplo

getBatchJobs 
Los trabajos por lotes del inquilino (importaciones, exportaciones, migraciones de páginas...), más recientes primero.
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| type | string | query | No | Sólo trabajos de este tipo, por ejemplo migrate-pages. |
| status | string | query | No | Sólo trabajos en este estado: requested, running, success o failed. |
| skip | integer | query | No | Cuántos trabajos omitir, para paginación. |
Respuesta
Devuelve: GetBatchJobsAPIResponse
Ejemplo

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

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

checkedCommentsForBlocked 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentIds | string | query | Sí | Una lista separada por comas de IDs de comentarios. |
| sso | string | query | No |
Respuesta
Devuelve: CheckBlockedCommentsResponse
Ejemplo

blockUserFromComment 
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: 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 | |
| locale | string | query | No |
Respuesta
Devuelve: SaveCommentsResponseWithPresence
Ejemplo

deleteComment 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| 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 | Obligatorio | 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 | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIGetCommentResponse
Ejemplo

getComments 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| 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
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| 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 | |
| questionId | string | query | No | |
| questionValue | integer | query | No |
Respuesta
Devuelve: GetCommentsResponseWithPresencePublicComment
Ejemplo

getCommentText 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | 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
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| 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 | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

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

saveComment 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Sí | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respuesta
Devuelve: SaveCommentsBulkResponse
Ejemplo

setCommentText 
Parámetros
| Nombre | Tipo | Location | 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: PublicAPISetCommentTextResponse
Ejemplo

translateComments 
Traduce los comentarios dados al idioma del widget. Solo disponible cuando la regla de personalización del widget correspondiente tiene Comment Translation configurado en Automatic o Manual.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| sso | string | query | No | |
| locale | string | query | No |
Respuesta
Devuelve: CommentTranslationsResponse
Ejemplo

unBlockUserFromComment 
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: UnblockSuccess
Ejemplo

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

unLockComment 
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 |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

unPinComment 
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 |
Respuesta
Devuelve: ChangeCommentPinStatusResponse
Ejemplo

updateComment 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

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

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

deleteDomainConfig 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateEmailTemplateResponse
Ejemplo

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

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

getEmailTemplateRenderErrors 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Respuesta
Devuelve: GetEmailTemplateRenderErrorsResponse
Ejemplo

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

renderEmailTemplate 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| locale | string | query | No |
Respuesta
Devuelve: RenderEmailTemplateResponse
Ejemplo

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

getEventLog 
req tenantId urlId userIdWS
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | ruta | Sí | |
| urlId | string | consulta | Sí | |
| userIdWS | string | consulta | Sí | |
| startTime | integer | consulta | Sí | |
| endTime | integer | consulta | No |
Respuesta
Devuelve: GetEventLogResponse
Ejemplo

getGlobalEventLog 
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

createFeedPost 
Parámetros
| Name | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| 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
Devuelve: DeleteFeedPostPublicResponse
Ejemplo

getFeedPosts 
req tenantId afterId
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| 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 | Sí | |
| 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
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postIds | array | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: FeedPostsStatsResponse
Ejemplo

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

reactFeedPostPublic 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postId | string | path | Sí | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ReactFeedPostResponse
Ejemplo

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

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

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

getGifLarge 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| largeInternalURLSanitized | string | query | Sí |
Respuesta
Devuelve: GifGetLargeResponse
Ejemplo

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

getGifsTrending 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Respuesta
Devuelve: GetGifsTrendingResponse
Ejemplo

addHashTag 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreateHashTagResponse
Example

addHashTagsBulk 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes |
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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

getMe 
Identifica la credencial en uso: el inquilino al que pertenece y, para tokens OAuth, el usuario que la autorizó.
Las integraciones usan esto para probar una conexión y etiquetarla.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetMeResponse
Ejemplo

deleteModerationVote 
Parameters
| 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 | Obligatorio | 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
Devuelve: ModerationExportStatusResponse
Ejemplo

getApiIds 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationAPIGetCommentIdsResponse
Ejemplo

getBanUsersFromComment 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| 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 | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationAPIChildCommentsResponse
Ejemplo

getCount 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| 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 
Parameters
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Returns: GetBannedUsersCountResponse
Example

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

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

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

getModerationComment 
Parameters
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Response
Devuelve: ModerationAPICommentResponse
Example

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

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

getSearchCommentsSummary 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: 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 | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| value | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationSiteSearchResponse
Ejemplo

getSearchSuggest 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationSuggestResponse
Ejemplo

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

getTrustFactor 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | 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 | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: AdjustVotesResponse
Ejemplo

postApiExport 
Parámetros
| 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 | |
| sorts | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationExportResponse
Ejemplo

postBanUserFromComment 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | 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 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

postBulkPreBanSummary 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| 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 | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: ModerationAPIChildCommentsResponse
Ejemplo

postFlagComment 
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: APIEmptyResponse
Ejemplo

postRemoveComment 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | 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 | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| 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 | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

postSetCommentText 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| 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 | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: 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 | Obligatorio | 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 | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

putRemoveBadge 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | 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 | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

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

createModerator 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Requerido | 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
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| fromName | string | query | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

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

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

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

getNotificationCount 
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 |
Respuesta
Devuelve: GetNotificationCountResponse
Ejemplo

getNotifications 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

createV1PageReact 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| title | string | query | No | |
| sso | 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 | |
| sso | string | query | No |
Respuesta
Devuelve: CreateV1PageReact
Ejemplo

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

deleteV2PageReact 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| sso | string | query | No |
Respuesta
Returns: CreateV1PageReact
Ejemplo

getV1PageLikes 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Cuando se establece, devuelve los usuarios que le dieron "me gusta" a la página (avatares y nombres de usuario). Sólo se acepta "public", lo que omite los perfiles privados. |
Respuesta
Devuelve: GetV1PageLikes
Ejemplo

getV2PageReacts 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Cuando se establece, devuelve los usuarios para cada id de reacción (avatares y nombres de usuario). Sólo "public" es aceptado, lo que omite los perfiles privados. |
Respuesta
Devuelve: GetV2PageReacts
Ejemplo

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

addPage 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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. Úselo después de agotar /users/online para mostrar una sección 'Miembros'. Paginación por cursor en commenterName: el servidor recorre el índice parcial {tenantId, urlId, commenterName} desde afterName hacia adelante mediante $gt, sin costo de $skip.
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | Identificador de la URL de la página (limpiado en el servidor). |
| afterName | string | query | No | Cursor: pase nextAfterName de la respuesta anterior. |
| afterUserId | string | query | No | Desempate de cursor: pase nextAfterUserId de la respuesta anterior. Requerido cuando afterName esté establecido para que los empates por nombre no omitan entradas. |
Respuesta
Devuelve: PageUsersOfflineResponse
Ejemplo

getOnlineUsers 
Espectadores 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 la sala en general, incluyendo espectadores anónimos que no enumeramos).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | Identificador de URL de la página (limpiado en el servidor). |
| afterName | string | query | No | Cursor: pase nextAfterName de la respuesta anterior. |
| afterUserId | string | query | No | Desempate de cursor: pase nextAfterUserId de la respuesta anterior. Requerido cuando afterName está establecido para que los empates por nombre no omitan entradas. |
Response
Devuelve: PageUsersOnlineResponse
Example

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

getPageLikes 
Recuento de "me gusta" de una página, opcionalmente con los usuarios que le dieron "me gusta".
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| includeUserInfo | string | query | No | "public" omite los usuarios con perfiles privados, "include-private" los incluye. |
Respuesta
Devuelve: GetPageLikesAPIResponse
Ejemplo

getPageReacts 
Recuentos de reacciones personalizados para una página, opcionalmente con los usuarios que reaccionaron.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| includeUserInfo | string | query | No | "public" omite los usuarios con perfiles privados, "include-private" los incluye. |
Respuesta
Devuelve: GetPageReactsAPIResponse
Ejemplo

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

getPagesPublic 
Lista páginas para un tenant. Usado por el cliente de escritorio FChat para poblar su lista de salas. Requiere enableFChat sea true en la configuración personalizada resuelta para cada página. Las páginas que requieren SSO se filtran según el acceso de grupo del usuario solicitante.
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Cursor de paginación opaco devuelto como nextCursor de una solicitud anterior. Vinculado al mismo sortBy. |
| limit | integer | query | No | 1..200, por defecto 50 |
| q | string | query | No | Filtro opcional por prefijo de título, sin distinguir mayúsculas/minúsculas. |
| sortBy | string | query | No | Orden. updatedAt (por defecto, recientes primero), commentCount (más comentarios primero) o title (alfabético). |
| hasComments | boolean | query | No | Si es true, devuelve solo páginas con al menos un comentario. |
Respuesta
Devuelve: GetPublicPagesResponse
Ejemplo

getUsersInfo 
Información masiva de usuarios para un tenant. Dados los userIds, devuelve información para mostrar de User / SSOUser. Usado por el widget de comentarios para enriquecer a usuarios que acaban de aparecer mediante 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 | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | ruta | Sí | |
| ids | string | consulta | Sí | userIds delimitados por comas. |
Respuesta
Devuelve: PageUsersInfoResponse
Ejemplo

migratePages 
Pone en cola un trabajo por lotes que mueve comentarios, páginas y registros relacionados de un urlId o dominio a otro. Las migraciones por "urlId" solo coinciden con el urlId exacto. Las migraciones por "domain" buscan/reemplazan el valor dentro de cada urlId y url. Consulte GET /api/v1/batch-jobs/{batchJobId}: una vez completado, contiene los resultados de cada migración y un undoId.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: QueuePageMigrationJobAPIResponse
Ejemplo

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

undoPageMigrations 
Encola un trabajo por lotes que revierte cada migración de un trabajo migrate‑pages, de la más reciente a la más antigua. Disponible durante 90 días.
Los registros modificados desde la migración se dejan sin cambios, de modo que una edición posterior nunca se sobrescribe.
Realice una solicitud GET a /api/v1/batch-jobs/{batchJobId} para obtener los recuentos de restaurados/omitidos.
Parameters
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| undoId | string | path | Sí |
Response
Devuelve: QueuePageMigrationJobAPIResponse
Example

deletePendingWebhookEvent 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| 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 | 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 |
Respuesta
Devuelve: GetPendingWebhookEventCountResponse
Ejemplo

getPendingWebhookEvents 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

createPollVote 
Registra un voto en una encuesta, o mueve uno existente a una opción diferente. Un votante tiene como máximo un voto por encuesta, por lo que llamar a esto de nuevo para el mismo votante mueve su voto en lugar de añadir uno.
Esto respeta la configuración de encuestas del sitio: si la votación está configurada solo para usuarios conectados, un voto con solo un anonUserId es rechazado, y los votos anónimos tienen límites de frecuencia por IP por encuesta.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreatePollVoteResponse
Ejemplo

deletePollVote 
Revocar un voto. La opción en la que se emitió devuelve su recuento.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: DeletePollVoteResponse
Ejemplo

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

getPollVotes 
Los votos individuales detrás de los totales de una encuesta, del más antiguo al más reciente.
Una encuesta pertenece a un comentario, por lo que los votos siempre se leen de una encuesta a la vez - commentId es obligatorio. Esto mantiene cada consulta en los índices que la colección ya tiene.
Respeta la privacidad de la encuesta: los votos de una encuesta anónima no se pueden leer (poll-anonymous), ni aquí ni por id.
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | query | Sí | |
| voterId | string | query | No | |
| optionId | string | query | No | |
| skip | integer | query | No |
Respuesta
Devuelve: GetPollVotesResponse
Ejemplo

deletePoll 
Elimina la encuesta de su comentario, junto con todos los votos emitidos en ella. El comentario en sí queda intacto.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getPoll 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Respuesta
Devuelve: GetPollResponse
Ejemplo

getPollVoters 
Quién votó por cada opción. Las encuestas anónimas nunca responden, las encuestas solo para administradores responden solo para un administrador o moderador.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetPollVoterNamesSuccessResponse
Ejemplo

patchPoll 
Edita una encuesta en el lugar, manteniendo sus recuentos: cambia la pregunta, vuelve a etiquetar una opción, ciérrala o reábrela, o cambia quién puede ver a los votantes. Las opciones se abordan por id; para agregar, eliminar o reordenarlas, haz un PUT de la lista completa.
Parameters
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Response
Devuelve: SavePollResponse
Example

putPoll 
Adjunte una encuesta a un comentario, o establezca el estado completo de la encuesta que ya tiene.
Las opciones se emparejan por id: una opción enviada con el id de una opción existente conserva sus votos (y toma la nueva etiqueta y posición), una opción enviada sin id se agrega, y las opciones existentes que se omiten de la lista se eliminan junto con los votos emitidos sobre ellas.
Mantener ningún id de opción existente en una encuesta que tiene votos elimina todas ellas, por lo que se necesita replaceVotes=true.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| replaceVotes | boolean | query | No |
Respuesta
Devuelve: SavePollResponse
Ejemplo

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

createQuestionConfig 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| 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 | Sí | |
| 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
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

aggregateQuestionResults 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| 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
Devuelve: 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddSSOUserAPIResponse
Ejemplo

deleteSSOUser 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Respuesta
Devuelve: DeleteSSOUserAPIResponse
Ejemplo

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

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

getSSOUsers 
Parámetros
| Name | Type | Location | Required | 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateSubscriptionAPIResponse
Ejemplo

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

getSubscriptions 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: GetSubscriptionsAPIResponse
Ejemplo

updateSubscription 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenantPackageResponse
Ejemplo

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

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

getTenantPackages 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
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 | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| 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
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | string | query | No |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

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

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

createTenant 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respuesta
Devuelve: CreateTenantResponse
Ejemplo

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

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

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

updateTenant 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes |
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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Sí | |
| component | string | path | Sí | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Respuesta
Devuelve: GetTranslationsResponse
Ejemplo

uploadImage 
Subir y redimensionar una imagen
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| 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 se realiza la subida, para configurar |
Respuesta
Devuelve: UploadImageResponse
Ejemplo

getUserBadgeProgressById 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: APIGetUserBadgeProgressListResponse
Ejemplo

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

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

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

getUserBadges 
Parámetros
| Nombre | Type | Location | 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
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserNotificationCountResponse
Ejemplo

getUserNotifications 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | No | Se utiliza 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: ResetUserNotificationsResponse
Ejemplo

resetUserNotifications 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | 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 | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| 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 nuevos comentarios raíz, y también
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| notificationId | string | path | Sí | |
| newStatus | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationStatusResponse
Ejemplo

getUserPresenceStatuses 
Parameters
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlIdWS | string | query | Sí | |
| userIds | string | query | Sí |
Respuesta
Devuelve: GetUserPresenceStatusesResponse
Ejemplo

searchUsers 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | 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 | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | query | Sí | |
| direction | string | query | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: VoteResponse
Ejemplo

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

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

getVotesForUser 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: GetVotesForUserResponse
Ejemplo

createWebhook 
Suscribe una URL a un evento de comentario (suscripción de REST hook). Si se suscribe la misma URL al mismo evento y dominio de nuevo, se devuelve la suscripción existente. Las entregas están firmadas con HMAC, consulte la guía de webhooks; el encabezado heredado token nunca se envía a las suscripciones de la API.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateWebhookResponse
Ejemplo

deleteWebhook 
Cancelaciones (desuscripción de webhook REST). Sólo las suscripciones creadas a través de esta API pueden eliminarse aquí; los webhooks gestionados desde el panel se editan en el panel.
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: APIEmptyResponse
Ejemplo

getWebhooks 
Enumera los webhooks configurados para el inquilino, tanto las filas gestionadas desde el panel como las suscripciones API.
Parameters
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| event | string | query | No | |
| domain | string | query | No | |
| source | string | query | No | |
| skip | number | query | No |
Response
Returns: GetWebhooksResponse
Example

getWebhookSamplePayloads 
Recent comments in exactly the shape webhook deliveries use, for building integrations (for example Zapier
sample data). Every event delivers the same comment object, so event only has to be valid.
Parameters
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| event | string | query | No | |
| limit | number | query | No |
Response
Devuelve: GetWebhookSamplePayloadsResponse
Ejemplo

¿Necesita ayuda?
Si encuentra algún problema o tiene preguntas sobre el SDK de Java, por favor:
Contribuciones
¡Las contribuciones son bienvenidas! Por favor visite el repositorio de GitHub para las pautas de contribución.