
Idioma 🇪🇸 Español
Primeros pasos
Documentación
Agregación
Registros de auditoría
Bloquear desde comentario
Comprobar comentarios bloqueados
Comentarios
Configuraciones de dominio
Plantillas de correo electrónico
Registro de eventos
Publicaciones del feed
Marcar comentario
Hashtags
Moderadores
Recuento de notificaciones
Notificaciones
Páginas
Eventos 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
Subir imagen
Progreso de insignias de usuario
Insignias de usuario
Notificaciones del usuario
Estado de presencia del usuario
Búsqueda de usuarios
Usuarios
Votos
FastComments Python SDK
Este es el SDK oficial de Python para FastComments.
SDK oficial de Python para la API de FastComments
Repositorio
Instalación 
PyPI
pip install fastcomments
Contenido de la biblioteca
Esta biblioteca contiene dos módulos: el cliente de API generado y la biblioteca principal de Python que contiene utilidades escritas a mano para facilitar el trabajo con la API, incluido el soporte SSO.
- Documentación de la biblioteca del cliente de la API
- Documentación de la biblioteca principal, incluidos ejemplos de SSO
APIs públicas vs seguras
Para el cliente de la API, hay dos clases, DefaultApi y PublicApi. La DefaultApi contiene métodos que requieren tu clave de API, y la PublicApi contiene llamadas a la API que se pueden realizar directamente desde un navegador, dispositivo móvil, etc., sin autenticación.
Inicio rápido 
Uso de APIs autenticadas (DefaultApi)
Importante: Debes establecer tu clave de API en la Configuration antes de realizar solicitudes autenticadas. Si no lo haces, las solicitudes fallarán con un error 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Crear y configurar el cliente de API
config = Configuration()
config.host = "https://fastcomments.com/api"
# OBLIGATORIO: Establece tu clave de API (obténla desde tu panel de FastComments)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}
# Crea la instancia de la API con el cliente configurado
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Ahora puedes hacer llamadas de API autenticadas
try:
# Ejemplo: Agregar un usuario SSO
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user(
tenant_id="YOUR_TENANT_ID",
create_apisso_user_data=user_data
)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# 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:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com/api"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public(
tenant_id="YOUR_TENANT_ID",
url_id="page-url-id"
)
print(response)
except Exception as e:
print(f"Error: {e}")
Uso de SSO (Inicio de sesión único)
El SDK incluye utilidades para generar tokens SSO seguros:
from sso import FastCommentsSSO, SecureSSOUserData
# Crear datos del usuario
user_data = SecureSSOUserData(
user_id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Crear instancia SSO con tu secreto de API
sso = FastCommentsSSO.new_secure(
api_secret="YOUR_API_SECRET",
user_data=user_data
)
# Generar el token SSO
sso_token = sso.create_token()
# Usa este token en tu frontend o pásalo a llamadas a la API
print(f"SSO Token: {sso_token}")
Para SSO simple (menos seguro, para pruebas):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
user_id="user-123",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Problemas comunes
- Error 401 "missing-api-key": Asegúrate de establecer
config.api_key = {"ApiKeyAuth": "YOUR_KEY"}antes de crear la instancia DefaultApi. - Clase de API incorrecta: Usa
DefaultApipara solicitudes autenticadas del lado del servidor,PublicApipara solicitudes del lado del cliente/públicas. - Errores de importación: Asegúrate de importar desde el módulo correcto:
- Cliente de API:
from client import ... - Utilidades SSO:
from sso import ...
- Cliente de API:
Notas 
IDs de transmisión
Verás que se supone que debes pasar un broadcast_id en algunas llamadas a la API. Cuando recibas eventos, obtendrás este ID de vuelta, por lo que sabrás ignorar el evento si planeas aplicar cambios de forma optimista en el cliente (lo que probablemente querrás hacer porque 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.
Requisitos 
- Python >= 3.8
- urllib3 >= 1.25.3
- python-dateutil >= 2.8.2
- pydantic >= 2.0.0
- typing-extensions >= 4.0.0
Agregación 
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 | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Respuesta
Devuelve: AggregationResponse
Ejemplo

Obtener registros de auditoría 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Respuesta
Devuelve: GetAuditLogs200Response
Ejemplo

Bloquear desde comentario público 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: BlockFromCommentPublic200Response
Ejemplo

Desbloquear comentario público 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UnBlockCommentPublic200Response
Ejemplo

Comprobar comentarios bloqueados 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentIds | string | query | Sí | Una lista separada por comas de identificadores de comentarios. |
| sso | string | query | No |
Respuesta
Devuelve: CheckedCommentsForBlocked200Response
Ejemplo

Bloquear usuario desde comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: BlockFromCommentPublic200Response
Ejemplo

Crear comentario público 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| broadcastId | string | query | Sí | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateCommentPublic200Response
Ejemplo

Eliminar comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Respuesta
Devuelve: DeleteComment200Response
Ejemplo

Eliminar comentario público 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: DeleteCommentPublic200Response
Ejemplo

Eliminar voto de comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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: DeleteCommentVote200Response
Ejemplo

Marcar comentario 
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: FlagComment200Response
Ejemplo

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

Obtener texto del comentario 
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: GetCommentText200Response
Ejemplo

Obtener nombres de usuario que votaron el comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| dir | integer | query | Sí | |
| sso | string | query | No |
Response
Devuelve: GetCommentVoteUserNames200Response
Ejemplo

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

Obtener comentarios públicos 
req tenantId urlId
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| 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: GetCommentsPublic200Response
Ejemplo

Bloquear comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | ruta | Sí | |
| commentId | string | ruta | Sí | |
| broadcastId | string | consulta | Sí | |
| sso | string | consulta | No |
Respuesta
Devuelve: LockComment200Response
Ejemplo

Fijar comentario 
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: PinComment200Response
Ejemplo

Guardar comentario 
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: SaveComment200Response
Ejemplo

Guardar comentarios en lote 
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: SaveComment200Response
Ejemplo

Establecer texto del comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: SetCommentText200Response
Ejemplo

Desbloquear usuario desde comentario 
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: UnBlockCommentPublic200Response
Ejemplo

Desmarcar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: FlagComment200Response
Ejemplo

Desbloquear comentario 
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: LockComment200Response
Ejemplo

Desfijar comentario 
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: PinComment200Response
Ejemplo

Actualizar comentario 
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
Devuelve: FlagCommentPublic200Response
Ejemplo

Votar comentario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| 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: VoteComment200Response
Ejemplo

Agregar configuración de dominio 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddDomainConfig200Response
Ejemplo

Eliminar configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domain | string | path | Sí |
Respuesta
Devuelve: DeleteDomainConfig200Response
Ejemplo

Obtener configuración de dominio 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domain | string | path | Sí |
Respuesta
Devuelve: GetDomainConfig200Response
Ejemplo

Obtener configuraciones de dominio 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetDomainConfigs200Response
Ejemplo

Modificar parcialmente configuración de dominio 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domainToUpdate | string | path | Sí |
Respuesta
Devuelve: GetDomainConfig200Response
Ejemplo

Reemplazar configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domainToUpdate | string | path | Sí |
Respuesta
Devuelve: GetDomainConfig200Response
Ejemplo

Crear plantilla de correo electrónico 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respuesta
Devuelve: CreateEmailTemplate200Response
Ejemplo

Eliminar plantilla de correo electrónico 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Eliminar error de renderizado de plantilla de correo electrónico 
Parámetros
| Name | Type | Location | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| errorId | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener plantilla de correo electrónico 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetEmailTemplate200Response
Ejemplo

Obtener definiciones de plantillas de correo electrónico 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetEmailTemplateDefinitions200Response
Ejemplo

Obtener errores de renderizado de plantillas de correo electrónico 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetEmailTemplateRenderErrors200Response
Ejemplo

Obtener plantillas de correo electrónico 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetEmailTemplates200Response
Ejemplo

Renderizar plantilla de correo electrónico 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| locale | string | query | No |
Respuesta
Devuelve: RenderEmailTemplate200Response
Ejemplo

Actualizar plantilla de correo electrónico 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener registro de eventos 
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 | Sí |
Respuesta
Devuelve: GetEventLog200Response
Ejemplo

Obtener registro de eventos global 
req tenantId urlId userIdWS
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | Yes |
Respuesta
Devuelve: GetEventLog200Response
Ejemplo

Crear publicación del feed 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Respuesta
Devuelve: CreateFeedPost200Response
Ejemplo

Crear publicación del feed pública 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateFeedPostPublic200Response
Ejemplo

Eliminar publicación del feed pública 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: DeleteFeedPostPublic200Response
Ejemplo

Obtener publicaciones del feed 
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: GetFeedPosts200Response
Ejemplo

Obtener publicaciones del feed públicas 
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: GetFeedPostsPublic200Response
Ejemplo

Obtener estadísticas de publicaciones del feed 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postIds | array | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetFeedPostsStats200Response
Ejemplo

Obtener reacciones de usuario públicas 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postIds | array | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserReactsPublic200Response
Ejemplo

Reaccionar a publicación del feed pública 
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: ReactFeedPostPublic200Response
Ejemplo

Actualizar publicación del feed 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Actualizar publicación del feed pública 
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: CreateFeedPostPublic200Response
Ejemplo

Marcar comentario público 
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: FlagCommentPublic200Response
Ejemplo

Agregar hashtag 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | No |
Respuesta
Devuelve: AddHashTag200Response
Ejemplo

Agregar hashtags en lote 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | No |
Respuesta
Devuelve: AddHashTagsBulk200Response
Ejemplo

Eliminar hashtag 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Yes | |
| tenantId | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener hashtags 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| page | number | query | No |
Respuesta
Devuelve: GetHashTags200Response
Ejemplo

Modificar parcialmente hashtag 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Yes | |
| tenantId | string | query | No |
Respuesta
Devuelve: PatchHashTag200Response
Ejemplo

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

Eliminar moderador 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| sendEmail | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener moderador 
Parámetros
| Name | Type | Location | Required | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: GetModerator200Response
Ejemplo

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

Enviar invitación 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| fromName | string | query | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

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

Eliminar recuento de notificaciones 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener recuento de notificaciones en caché 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetCachedNotificationCount200Response
Ejemplo

Obtener recuento de notificaciones 
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 |
Respuesta
Devuelve: GetNotificationCount200Response
Ejemplo

Obtener notificaciones 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | 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: GetNotifications200Response
Ejemplo

Actualizar notificación 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Agregar página 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddPageAPIResponse
Ejemplo

Eliminar página 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: DeletePageAPIResponse
Ejemplo

Obtener página por URL ID 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí |
Respuesta
Devuelve: GetPageByURLIdAPIResponse
Ejemplo

Obtener páginas 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetPagesAPIResponse
Ejemplo

Modificar parcialmente página 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: PatchPageAPIResponse
Ejemplo

Eliminar evento webhook pendiente 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener recuento de eventos webhook pendientes 
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 |
Respuesta
Devuelve: GetPendingWebhookEventCount200Response
Ejemplo

Obtener eventos webhook pendientes 
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: GetPendingWebhookEvents200Response
Ejemplo

Crear configuración de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateQuestionConfig200Response
Ejemplo

Eliminar configuración de pregunta 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener configuración de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetQuestionConfig200Response
Ejemplo

Obtener configuraciones de preguntas 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetQuestionConfigs200Response
Ejemplo

Actualizar configuración de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Crear resultado de pregunta 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateQuestionResult200Response
Ejemplo

Eliminar resultado de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener resultado de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: GetQuestionResult200Response
Ejemplo

Obtener resultados de preguntas 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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: GetQuestionResults200Response
Ejemplo

Actualizar resultado de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Agregación de resultados de preguntas 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| 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: AggregateQuestionResults200Response
Ejemplo

Agregación de resultados de preguntas en lote 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| forceRecalculate | boolean | query | No |
Respuesta
Devuelve: BulkAggregateQuestionResults200Response
Ejemplo

Combinar comentarios con resultados de preguntas 
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: CombineCommentsWithQuestionResults200Response
Ejemplo

Agregar usuario SSO 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddSSOUserAPIResponse
Ejemplo

Eliminar usuario SSO 
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

Obtener usuario SSO por correo electrónico 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| string | path | Sí |
Respuesta
Devuelve: GetSSOUserByEmailAPIResponse
Ejemplo

Obtener usuario SSO por ID 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetSSOUserByIdAPIResponse
Ejemplo

Obtener usuarios SSO 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | integer | query | No |
Respuesta
Devuelve: GetSSOUsers200Response
Ejemplo

Modificar parcialmente usuario SSO 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | boolean | query | No |
Respuesta
Devuelve: PatchSSOUserAPIResponse
Ejemplo

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

Crear suscripción 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateSubscriptionAPIResponse
Ejemplo

Eliminar suscripción 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Response
Devuelve: DeleteSubscriptionAPIResponse
Ejemplo

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

Obtener usos diarios del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantDailyUsages200Response
Ejemplo

Crear paquete del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respuesta
Devuelve: CreateTenantPackage200Response
Ejemplo

Eliminar paquete del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener paquete del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenantPackage200Response
Ejemplo

Obtener paquetes del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantPackages200Response
Ejemplo

Reemplazar paquete del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Actualizar paquete del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Crear usuario del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenantUser200Response
Ejemplo

Eliminar usuario del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Obtener usuario del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenantUser200Response
Ejemplo

Obtener usuarios del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantUsers200Response
Ejemplo

Reemplazar usuario del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Enviar enlace de acceso 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| redirectURL | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Actualizar usuario del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

Crear inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenant200Response
Ejemplo

Eliminar inquilino 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| sure | string | query | No |
Response
Devuelve: FlagCommentPublic200Response
Ejemplo

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

Obtener inquilinos 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| meta | string | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenants200Response
Ejemplo

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

Subir imagen 
Subir y redimensionar una imagen
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| sizePreset | string | query | No | Preajuste de tamaño: "Default" (1000x1000px) or "CrossPlatform" (creates sizes for popular devices) |
| urlId | string | query | No | ID de página desde la cual se realiza la subida, para configurar |
Respuesta
Devuelve: UploadImageResponse
Ejemplo

Obtener progreso de insignia por ID 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: GetUserBadgeProgressById200Response
Ejemplo

Obtener progreso de insignia por ID de usuario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | path | Sí |
Respuesta
Devuelve: GetUserBadgeProgressById200Response
Ejemplo

Obtener lista de progreso de insignias de usuario 
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: GetUserBadgeProgressList200Response
Ejemplo

Crear insignia de usuario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateUserBadge200Response
Ejemplo

Eliminar insignia de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: UpdateUserBadge200Response
Ejemplo

Obtener insignia de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetUserBadge200Response
Ejemplo

Obtener insignias de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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: GetUserBadges200Response
Ejemplo

Actualizar insignia de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: UpdateUserBadge200Response
Ejemplo

Obtener recuento de notificaciones del usuario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | consulta | Sí | |
| sso | string | consulta | No |
Respuesta
Devuelve: GetUserNotificationCount200Response
Ejemplo

Obtener notificaciones del usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| 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 | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserNotifications200Response
Ejemplo

Restablecer recuento de notificaciones del usuario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: ResetUserNotifications200Response
Ejemplo

Restablecer notificaciones del usuario 
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: ResetUserNotifications200Response
Ejemplo

Actualizar estado de suscripción de comentarios del usuario 
Habilitar o deshabilitar las notificaciones para un comentario específico.
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationStatus200Response
Ejemplo

Actualizar estado de suscripción de página del usuario 
Habilita o deshabilita 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
| 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: UpdateUserNotificationStatus200Response
Ejemplo

Actualizar estado de notificación del usuario 
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: UpdateUserNotificationStatus200Response
Ejemplo

Obtener estados de presencia de usuarios 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlIdWS | string | query | Sí | |
| userIds | string | query | Sí |
Respuesta
Devuelve: GetUserPresenceStatuses200Response
Ejemplo

Buscar usuarios 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| usernameStartsWith | string | query | Sí | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: SearchUsers200Response
Ejemplo

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

Crear voto 
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: VoteComment200Response
Ejemplo

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

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

Obtener votos para usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: GetVotesForUser200Response
Ejemplo

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