
Dil 🇹🇷 Türkçe
Dokümantasyon
Başlarken
Toplam
Denetim Kayıtları
Kimlik Doğrulama
Yorumlardan Engelle
Engellenen Yorumları Kontrol Et
Yorumlar
Yorumlar Kullanıcı İçin
Alan Yapılandırmaları
E-posta Şablonları
Olay Günlüğü
Akış Gönderileri
Yorumu İşaretle
Gif'ler
Etiketler
Moderasyon
Moderatörler
Bildirim Sayısı
Bildirimler
Sayfa Tepkileri
Sayfalar
Bekleyen Webhook Olayları
Soru Yapılandırmaları
Soru Sonuçları
Soru Sonuçları Toplamı
SSO Kullanıcıları
Abonelikler
Kiracı Günlük Kullanımı
Kiracı Paketleri
Kiracı Kullanıcıları
Kiracılar
Destek Biletleri
Çeviriler
Resim Yükle
Kullanıcı Rozet İlerlemesi
Kullanıcı Rozetleri
Kullanıcı Bildirimleri
Kullanıcı Durumu
Kullanıcı Ara
Kullanıcılar
Oylar
FastComments Python SDK
Bu, FastComments için resmi Python SDK'sıdır.
FastComments API'si için resmi Python SDK
Depo
AI coding agents 
Kodlama ajanınıza FastComments bağlamını sağlayın - widget'lar, yapılandırma, Güvenli SSO, REST API ve SDK'lar:
npx skills add fastcomments/skills
Claude Code, Codex, Cursor, Copilot, Gemini ve skills CLI tarafından desteklenen diğer tüm ajanlarla çalışır.
Installation 
GitHub'dan Kurulum
Bir sürüm etiketinden doğrudan kurun (önerilir, tamamen tekrarlanabilir):
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0
Yapıların deterministik olmasını sağlamak için bir dal yerine etiketi sabitleyin. Aynı biçim requirements.txt içinde de çalışır:
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0
Her etiketli GitHub Release ayrıca doğrudan bir ikili artefakt kurmayı tercih ederseniz eklenmiş bir wheel içerir.
Kütüphane İçeriği
Bu kütüphane iki modül içerir: oluşturulan API istemcisi ve API ile çalışmayı, SSO desteği dahil, kolaylaştıran el yazısı yardımcı programları içeren çekirdek Python kütüphanesi.
Genel vs Güvenli API'ler
API istemcisi için üç sınıf vardır: DefaultApi, PublicApi ve ModerationApi. DefaultApi, API anahtarınızı gerektiren yöntemleri içerirken, PublicApi kimlik doğrulama gerektirmeden doğrudan bir tarayıcı/mobil cihaz vb. üzerinden yapılabilen yöntemleri içerir. ModerationApi, canlı ve hızlı denetleme API'lerinin kapsamlı bir paketini sağlar. Her ModerationApi yöntemi bir sso parametresi kabul eder ve SSO veya bir FastComments.com oturum çerezi aracılığıyla kimlik doğrulaması yapabilir.
Quick Start 
Kimlik Doğrulamalı API'leri Kullanma (DefaultApi)
Önemli: Kimlik doğrulamalı istekler yapmadan önce API anahtarınızı Configuration üzerinde ayarlamalısınız. Bunu yapmazsanız, istekler 401 hatasıyla başarısız olur.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# API istemcisini oluştur ve yapılandır
config = Configuration()
config.host = "https://fastcomments.com"
# GEREKLİ: API anahtarınızı ayarlayın (bunu FastComments kontrol panelinizden alın)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}
# Yapılandırılmış istemciyle API örneğini oluştur
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Artık kimlik doğrulamalı API çağrıları yapabilirsiniz
try:
# Örnek: Bir SSO kullanıcısı ekle
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user("YOUR_TENANT_ID", user_data)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Yaygın hatalar:
# - 401: API anahtarı eksik veya geçersiz
# - 400: İstek doğrulaması başarısız
Genel API'leri Kullanma (PublicApi)
Genel uç noktalar kimlik doğrulama gerektirmez:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
print(response)
except Exception as e:
print(f"Error: {e}")
Moderasyon Panosunu Kullanma (ModerationApi)
ModerationApi, moderatör panosunu çalıştırır. Yöntemler, bir sso token'ı geçirerek moderatör adına çağrılır:
from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)
try:
# Moderasyon bekleyen yorumları say
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
SSO (Tek Oturum Açma) Kullanımı
SDK, güvenli SSO token'ları oluşturmak için yardımcı programlar içerir:
from sso import FastCommentsSSO, SecureSSOUserData
# Kullanıcı verilerini oluştur (id, email ve kullanıcı adı gereklidir)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Bunu API gizli anahtarınızla imzalayın (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# Widget'a veya bir API çağrısına geçirmek için SSO token'ı oluştur
sso_token = sso.create_token()
# Bu token'ı ön uçta kullanın veya API çağrılarına geçirin
print(f"SSO Token: {sso_token}")
Basit SSO için (daha az güvenli, test amaçlı):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
username="johndoe",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Canlı Abonelikler (PubSub)
pubsub modülü, WebSocket üzerinden gerçek zamanlı yorum olaylarına (yeni yorumlar, oylar, düzenlemeler, bildirimler vb.) abone olmanızı sağlar ve FastComments Java SDK'sının LiveEventSubscriberını yansıtır. Bu, oluşturulan API istemcisinin üzerine bir WebSocket istemcisi ekleyen pubsub ekstra paketini gerektirir:
pip install "fastcomments[pubsub] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0"from pubsub import LiveEventSubscriber
subscriber = LiveEventSubscriber()
def handle_live_event(event):
print(f"Live event: {event.type}")
if event.comment:
print(f" comment: {event.comment.comment}")
result = subscriber.subscribe_to_changes(
tenant_id_ws="YOUR_TENANT_ID",
url_id="page-url-id",
url_id_ws="page-url-id",
user_id_ws="a-unique-presence-id", # örn. bu oturum için bir UUID
handle_live_event=handle_live_event,
on_connection_status_change=lambda connected, last_event_time: print(
f"connected={connected}"
),
region=None, # EU bölgesi için "eu" olarak ayarlayın
)
# ...daha sonra, güncellemeleri artık istemediğinizde:
result.close()
Abone, bağlantıyı arka plan daemon iş parçacığında çalıştırır, jitter ile şeffaf bir şekilde yeniden bağlanır ve yeniden bağlanma sırasında event-log uç noktasından kaçırılan olayları alır. Kullanıcının göremeyeceği yorumların kimliklerini döndüren isteğe bağlı bir can_see_comments geri çağırma fonksiyonu (List[str] -> Dict[str, str]) sağlayarak, kullanıcının görüntüleyemeyeceği yorum olaylarını filtreleyebilirsiniz. disable_live_commenting=True ayarını yaparak subscribe_to_changes işlevini hiçbir şey yapmayan ve None döndüren bir işlev haline getirebilirsiniz.
Yaygın Sorunlar
- 401 "missing-api-key" hatası:
DefaultApiörneğini oluşturmadan önceconfig.api_key = {"api_key": "YOUR_KEY"}ayarladığınızdan emin olun. - Yanlış API sınıfı: Sunucu tarafı kimlik doğrulamalı istekler için
DefaultApi, istemci tarafı/genel istekler içinPublicApive moderatör panosu istekleri içinModerationApikullanın. - İçe aktarma hataları: Doğru modülden içe aktardığınızdan emin olun:
- API istemcisi:
from client import ... - SSO yardımcı programları:
from sso import ... - Canlı abonelikler:
from pubsub import ...(pubsubekstra paketi gerekir)
- API istemcisi:
Notes 
Yayın Kimlikleri
Bazı API çağrılarında bir broadcast_id geçirmeniz gerektiğini göreceksiniz. Olayları aldığınızda bu kimliği geri alırsınız; böylece istemcide değişiklikleri iyimser şekilde uygulamayı planlıyorsanız (muhtemelen en iyi deneyimi sunduğu için yapmak isteyeceksiniz), olayı yok saymanız gerektiğini bilirsiniz. Buraya bir UUID geçirin. Bu kimlik, bir tarayıcı oturumu içinde iki kez ortaya çıkmayacak kadar benzersiz olmalıdır.
Requirements 
- Python >= 3.8
Temel kurulum pure-stdlib'dir ve SSO yardımcı programlarını sağlar. Oluşturulan
API istemcisi (DefaultApi/PublicApi/ModerationApi) client ekstra paketine ihtiyaç duyar; bu paket urllib3 >= 1.25.3, python-dateutil >= 2.8.2,
pydantic >= 2.0.0 ve typing-extensions >= 4.0.0 çeker:
pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0"
aggregate 
Aggregates belgeleri (groupBy sağlanırsa) gruplayarak ve birden fazla işlem uygulayarak toplar.
Farklı işlemler (örn. sum, countDistinct, avg, vb.) desteklenir.
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| parentTenantId | string | query | Hayır | |
| includeStats | boolean | query | Hayır |
Yanıt
Returns: AggregateResponse
Örnek

get_audit_logs 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Response
Döndürür: GetAuditLogsResponse
Örnek

logout_public 
Yanıt
Döndürür: APIEmptyResponse
Örnek

block_from_comment_public 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: BlockSuccess
Örnek

un_block_comment_public 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: UnblockSuccess
Örnek

checked_comments_for_blocked 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentIds | string | query | Evet | Virgülle ayrılmış yorum kimlikleri listesi. |
| sso | string | query | Hayır |
Yanıt
Döndürür: CheckBlockedCommentsResponse
Örnek

block_user_from_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Yanıt
Döndürür: BlockSuccess
Örnek

create_comment_public 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: SaveCommentsResponseWithPresence
Örnek

delete_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| contextUserId | string | query | Hayır | |
| isLive | boolean | query | Hayır |
Yanıt
Döndürür: DeleteCommentResult
Örnek

delete_comment_public 
Parameters
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Döndürür: PublicAPIDeleteCommentResponse
Example

delete_comment_vote 
Parametreler
| Ad | Tür | Yer | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: VoteDeleteResponse
Örnek

flag_comment 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Response
Döner: FlagCommentResponse
Örnek

get_comment 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIGetCommentResponse
Örnek

get_comment_text 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: PublicAPIGetCommentTextResponse
Örnek

get_comment_vote_user_names 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| dir | integer | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetCommentVoteUserNamesSuccessResponse
Örnek

get_comments 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| page | integer | query | Hayır | |
| limit | integer | query | Hayır | |
| skip | integer | query | Hayır | |
| asTree | boolean | query | Hayır | |
| skipChildren | integer | query | Hayır | |
| limitChildren | integer | query | Hayır | |
| maxTreeDepth | integer | query | Hayır | |
| urlId | string | query | Hayır | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır | |
| contextUserId | string | query | Hayır | |
| hashTag | string | query | Hayır | |
| parentId | string | query | Hayır | |
| direction | string | query | Hayır | |
| fromDate | integer | query | Hayır | |
| toDate | integer | query | Hayır |
Yanıt
Döndürür: APIGetCommentsResponse
Örnek

get_comments_public 
req tenantId urlId
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| page | integer | query | Hayır | |
| direction | string | query | Hayır | |
| sso | string | query | Hayır | |
| skip | integer | query | Hayır | |
| skipChildren | integer | query | Hayır | |
| limit | integer | query | Hayır | |
| limitChildren | integer | query | Hayır | |
| countChildren | boolean | query | Hayır | |
| fetchPageForCommentId | string | query | Hayır | |
| includeConfig | boolean | query | Hayır | |
| countAll | boolean | query | Hayır | |
| includei10n | boolean | query | Hayır | |
| locale | string | query | Hayır | |
| modules | string | query | Hayır | |
| isCrawler | boolean | query | Hayır | |
| includeNotificationCount | boolean | query | Hayır | |
| asTree | boolean | query | Hayır | |
| maxTreeDepth | integer | query | Hayır | |
| useFullTranslationIds | boolean | query | Hayır | |
| parentId | string | query | Hayır | |
| searchText | string | query | Hayır | |
| hashTags | array | query | Hayır | |
| userId | string | query | Hayır | |
| customConfigStr | string | query | Hayır | |
| afterCommentId | string | query | Hayır | |
| beforeCommentId | string | query | Hayır |
Yanıt
Returns: GetCommentsResponseWithPresencePublicComment
Örnek

lock_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

pin_comment 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ChangeCommentPinStatusResponse
Örnek

save_comment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Response
Returns: APISaveCommentResponse
Example

save_comments_bulk 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Yanıt
Döndürür: SaveCommentsBulkResponse
Örnek

set_comment_text 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: PublicAPISetCommentTextResponse
Örnek

un_block_user_from_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Yanıt
Döndürür: UnblockSuccess
Örnek

un_flag_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet | |
| userId | string | sorgu | Hayır | |
| anonUserId | string | sorgu | Hayır |
Yanıt
Döndürür: FlagCommentResponse
Örnek

un_lock_comment 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

un_pin_comment 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ChangeCommentPinStatusResponse
Örnek

update_comment 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| contextUserId | string | query | Hayır | |
| doSpamCheck | boolean | query | Hayır | |
| isLive | boolean | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

vote_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: VoteResponse
Örnek

get_comments_for_user 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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 |
Yanıt
Returns: GetCommentsForUserResponse
Örnek

add_domain_config 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: AddDomainConfigResponse
Örnek

delete_domain_config 
Parametreler
| Ad | Tür | Location | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| domain | string | path | Evet |
Yanıt
Döndürür: DeleteDomainConfigResponse
Örnek

get_domain_config 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| domain | string | path | Evet |
Yanıt
Döndürür: GetDomainConfigResponse
Örnek

get_domain_configs 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: GetDomainConfigsResponse
Örnek

patch_domain_config 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Yanıt
Dönüş: PatchDomainConfigResponse
Örnek

put_domain_config 
Parametreler
| Ad | Type | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| domainToUpdate | string | path | Evet |
Yanıt
Döndürür: PutDomainConfigResponse
Örnek

create_email_template 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateEmailTemplateResponse
Örnek

delete_email_template 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

delete_email_template_render_error 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| errorId | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_email_template 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetEmailTemplateResponse
Örnek

get_email_template_definitions 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: GetEmailTemplateDefinitionsResponse
Örnek

get_email_template_render_errors 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetEmailTemplateRenderErrorsResponse
Örnek

get_email_templates 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetEmailTemplatesResponse
Örnek

render_email_template 
Parametreler
| Ad | Tür | Yer | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| locale | string | query | Hayır |
Yanıt
Döndürür: RenderEmailTemplateResponse
Örnek

update_email_template 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_event_log 
req tenantId urlId userIdWS
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| userIdWS | string | query | Evet | |
| startTime | integer | query | Evet | |
| endTime | integer | query | Hayır |
Yanıt
Döndürür: GetEventLogResponse
Örnek

get_global_event_log 
req tenantId urlId userIdWS
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| userIdWS | string | query | Evet | |
| startTime | integer | query | Evet | |
| endTime | integer | query | Hayır |
Yanıt
Döndürür: GetEventLogResponse
Örnek

create_feed_post 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Yanıt
Döndürür: CreateFeedPostsResponse
Örnek

create_feed_post_public 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Response
Döndürür: CreateFeedPostResponse
Örnek

delete_feed_post_public 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: DeleteFeedPostPublicResponse
Example

get_feed_posts 
req tenantId afterId
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| afterId | string | query | Hayır | |
| limit | integer | query | Hayır | |
| tags | array | query | Hayır |
Yanıt
Döndürür: GetFeedPostsResponse
Örnek

get_feed_posts_public 
req
tenantId
afterId
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| afterId | string | query | Hayır | |
| limit | integer | query | Hayır | |
| tags | array | query | Hayır | |
| sso | string | query | Hayır | |
| isCrawler | boolean | query | Hayır | |
| includeUserInfo | boolean | query | Hayır |
Yanıt
Döndürür: PublicFeedPostsResponse
Örnek

get_feed_posts_stats 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| postIds | array | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: FeedPostsStatsResponse
Örnek

get_user_reacts_public 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: UserReactsResponse
Örnek

react_feed_post_public 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| postId | string | path | Evet | |
| isUndo | boolean | query | Hayır | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ReactFeedPostResponse
Örnek

update_feed_post 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Dönüş: APIEmptyResponse
Örnek

update_feed_post_public 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| postId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: CreateFeedPostResponse
Örnek

flag_comment_public 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| isFlagged | boolean | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_gif_large 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| largeInternalURLSanitized | string | query | Evet |
Yanıt
Döndürür: GifGetLargeResponse
Örnek

get_gifs_search 
Parametreler
| İsim | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| search | string | query | Evet | |
| locale | string | query | Hayır | |
| rating | string | query | Hayır | |
| page | number | query | Hayır |
Yanıt
Döndürür: GetGifsSearchResponse
Örnek

get_gifs_trending 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| locale | string | query | Hayır | |
| rating | string | query | Hayır | |
| page | number | query | Hayır |
Yanıt
Döndürür: GetGifsTrendingResponse
Örnek

add_hash_tag 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Yanıt
Döndürür: CreateHashTagResponse
Örnek

add_hash_tags_bulk 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Returns: BulkCreateHashTagsResponse
Örnek

delete_hash_tag 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_hash_tags 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| page | number | query | Hayır |
Yanıt
Döndürür: GetHashTagsResponse
Örnek

patch_hash_tag 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| tag | string | path | Evet |
Yanıt
Döndürür: UpdateHashTagResponse
Örnek

delete_moderation_vote 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: VoteDeleteResponse
Örnek

get_api_comments 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| page | number | query | Hayır | |
| count | number | query | Hayır | |
| text-search | string | query | Hayır | |
| byIPFromComment | string | query | Hayır | |
| filters | string | query | Hayır | |
| searchFilters | string | query | Hayır | |
| sorts | string | query | Hayır | |
| demo | boolean | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationAPIGetCommentsResponse
Örnek

get_api_export_status 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationExportStatusResponse
Örnek

get_api_ids 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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 |
Yanıt
Returns: ModerationAPIGetCommentIdsResponse
Örnek

get_ban_users_from_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Yanıt
Returns: GetBannedUsersFromCommentResponse
Örnek

get_comment_ban_status 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: GetCommentBanStatusResponse
Örnek

get_comment_children 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationAPIChildCommentsResponse
Örnek

get_count 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationAPICountCommentsResponse
Örnek

get_counts 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetBannedUsersCountResponse
Örnek

get_logs 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döner: ModerationAPIGetLogsResponse
Örnek

get_manual_badges 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetTenantManualBadgesResponse
Örnek

get_manual_badges_for_user 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: GetUserManualBadgesResponse
Örnek

get_moderation_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Yanıt
Returns: ModerationAPICommentResponse
Örnek

get_moderation_comment_text 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: GetCommentTextResponse
Örnek

get_pre_ban_summary 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: PreBanSummary
Örnek

get_search_comments_summary 
Parametreler
| Ad | Tip | Konum | Gereklidir | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationCommentSearchResponse
Örnek

get_search_pages 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationPageSearchResponse
Örnek

get_search_sites 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| value | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationSiteSearchResponse
Örnek

get_search_suggest 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationSuggestResponse
Örnek

get_search_users 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| value | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationUserSearchResponse
Örnek

get_trust_factor 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetUserTrustFactorResponse
Örnek

get_user_ban_preference 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIModerateGetUserBanPreferencesResponse
Örnek

get_user_internal_profile 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetUserInternalProfileResponse
Örnek

post_adjust_comment_votes 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Returns: AdjustVotesResponse
Örnek

post_api_export 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationExportResponse
Örnek

post_ban_user_from_comment 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| 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 |
Yanıt
Döndürür: BanUserFromCommentResult
Örnek

post_ban_user_undo 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: APIEmptyResponse
Örnek

post_bulk_pre_ban_summary 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Response
Döndürür: BulkPreBanSummary
Örnek

post_comments_by_ids 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationAPIChildCommentsResponse
Örnek

post_flag_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: APIEmptyResponse
Örnek

post_remove_comment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Response
Döndürür: PostRemoveCommentApiResponse
Example

post_restore_deleted_comment 
Parametreler
| İsim | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Returns: APIEmptyResponse
Örnek

post_set_comment_approval_status 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: SetCommentApprovedResponse
Örnek

post_set_comment_review_status 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: APIEmptyResponse
Örnek

post_set_comment_spam_status 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| spam | boolean | query | Hayır | |
| permNotSpam | boolean | query | Hayır | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

post_set_comment_text 
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Döndürür: SetCommentTextResponse
Örnek

post_un_flag_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

post_vote 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: VoteResponse
Örnek

put_award_badge 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| badgeId | string | query | Evet | |
| userId | string | query | Hayır | |
| commentId | string | query | Hayır | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: AwardUserBadgeResponse
Örnek

put_close_thread 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

put_remove_badge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| badgeId | string | query | Evet | |
| userId | string | query | Hayır | |
| commentId | string | query | Hayır | |
| broadcastId | string | query | Hayır | |
| sso | string | query | Hayır |
Response
Döndürür: RemoveUserBadgeResponse
Example

put_reopen_thread 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Returns: APIEmptyResponse
Örnek

set_trust_factor 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: SetUserTrustFactorResponse
Örnek

create_moderator 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateModeratorResponse
Örnek

delete_moderator 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| sendEmail | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_moderator 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döner: GetModeratorResponse
Örnek

get_moderators 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetModeratorsResponse
Örnek

send_invite 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| fromName | string | query | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

update_moderator 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Dönen değer: APIEmptyResponse
Örnek

delete_notification_count 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_cached_notification_count 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Dönüş değeri: GetCachedNotificationCountResponse
Örnek

get_notification_count 
Parametreler
| İsim | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Yanıt
Döndürür: GetNotificationCountResponse
Örnek

get_notifications 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Yanıt
Döndürür: GetNotificationsResponse
Örnek

update_notification 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

create_v1_page_react 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No |
Yanıt
Döndürür: CreateV1PageReact
Örnek

create_v2_page_react 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| id | string | query | Evet | |
| title | string | query | Hayır |
Yanıt
Döndürür: CreateV1PageReact
Örnek

delete_v1_page_react 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet |
Yanıt
Döndürür: CreateV1PageReact
Örnek

delete_v2_page_react 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Yanıt
Döndürür: CreateV1PageReact
Örnek

get_v1_page_likes 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Yanıt
Döndürür: GetV1PageLikes
Örnek

get_v2_page_react_users 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| id | string | query | Evet |
Response
Döndürür: GetV2PageReactUsersResponse
Örnek

get_v2_page_reacts 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet |
Yanıt
Döndürür: GetV2PageReacts
Örnek

add_page 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: AddPageAPIResponse
Örnek

delete_page 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: DeletePageAPIResponse
Örnek

get_offline_users 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName}
index from afterName forward via $gt, no $skip cost.
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | Sayfa URL tanımlayıcısı (sunucu tarafında temizlenmiş). |
| afterName | string | query | Hayır | İmleç: önceki yanıttan nextAfterName'i geçin. |
| afterUserId | string | query | Hayır | İmleç bağlama kırıcı: önceki yanıttan nextAfterUserId'i geçin. afterName ayarlandığında gereklidir, böylece isim eşitlikleri girişleri düşürmez. |
Response
Döndürür: PageUsersOfflineResponse
Example

get_online_users 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Sayfa URL tanımlayıcısı (sunucu tarafında temizlenmiş). |
| afterName | string | query | No | İmleç: önceki yanıttan nextAfterName gönderin. |
| afterUserId | string | query | No | İmleç bağlayıcısı: önceki yanıttan nextAfterUserId gönderin. afterName ayarlandığında, isim eşitliklerinin girişleri atlamaması için gereklidir. |
Response
Döndürür: PageUsersOnlineResponse
Örnek

get_page_by_urlid 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet |
Yanıt
Döndürür: GetPageByURLIdAPIResponse
Örnek

get_pages 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: GetPagesAPIResponse
Örnek

get_pages_public 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Önceki bir istekte nextCursor olarak döndürülen opak sayfalama işaretçisi. Aynı sortBy ile ilişkilidir. |
| limit | integer | query | No | 1..200, varsayılan 50 |
| q | string | query | No | İsteğe bağlı büyük/küçük harfe duyarsız başlık önek filtresi. |
| sortBy | string | query | No | Sıralama düzeni. updatedAt (varsayılan, en yeni önce), commentCount (en çok yorum önce), veya title (alfabetik). |
| hasComments | boolean | query | No | True ise, yalnızca en az bir yorumu olan sayfaları döndür. |
Response
Döndürür: GetPublicPagesResponse
Example

get_users_info 
Bir kiracı için toplu kullanıcı bilgisi. Verilen userIds ile User / SSOUser'dan görüntülenebilir bilgileri döndürür. Yorum bileşeni tarafından, bir presence event ile yeni görünen kullanıcıları zenginleştirmek için kullanılır. Sayfa bağlamı yok: gizlilik tutarlı şekilde uygulanır (özel profiller maskelenir).
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| ids | string | query | Evet | Virgülle ayrılmış userIds. |
Yanıt
Döndürür: PageUsersInfoResponse
Örnek

patch_page 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: PatchPageAPIResponse
Örnek

delete_pending_webhook_event 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Dönen değer: APIEmptyResponse
Örnek

get_pending_webhook_event_count 
Parametreler
| Ad | Tip | Konum | Gereklidir | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | query | Hayır | |
| externalId | string | query | Hayır | |
| eventType | string | query | Hayır | |
| type | string | query | Hayır | |
| domain | string | query | Hayır | |
| attemptCountGT | number | query | Hayır |
Yanıt
Döner: GetPendingWebhookEventCountResponse
Örnek

get_pending_webhook_events 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Yanıt
Döndürür: GetPendingWebhookEventsResponse
Örnek

create_question_config 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateQuestionConfigResponse
Örnek

delete_question_config 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_question_config 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetQuestionConfigResponse
Örnek

get_question_configs 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetQuestionConfigsResponse
Örnek

update_question_config 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

create_question_result 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateQuestionResultResponse
Örnek

delete_question_result 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Dönüş
Dönüş: APIEmptyResponse
Örnek

get_question_result 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Döndürür: GetQuestionResultResponse
Örnek

get_question_results 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Yanıt
Döndürür: GetQuestionResultsResponse
Örnek

update_question_result 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Dönüş: APIEmptyResponse
Örnek

aggregate_question_results 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| questionId | string | query | Hayır | |
| questionIds | array | query | Hayır | |
| urlId | string | query | Hayır | |
| timeBucket | string | query | Hayır | |
| startDate | string | query | Hayır | |
| forceRecalculate | boolean | query | Hayır |
Yanıt
Döndürür: AggregateQuestionResultsResponse
Örnek

bulk_aggregate_question_results 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| forceRecalculate | boolean | query | Hayır |
Yanıt
Döndürür: BulkAggregateQuestionResultsResponse
Örnek

combine_comments_with_question_results 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Yanıt
Döndürür: CombineQuestionResultsWithCommentsResponse
Örnek

add_sso_user 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: AddSSOUserAPIResponse
Örnek

delete_sso_user 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Yanıt
Döndürür: DeleteSSOUserAPIResponse
Örnek

get_sso_user_by_email 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| string | path | Evet |
Yanıt
Döndürür: GetSSOUserByEmailAPIResponse
Örnek

get_sso_user_by_id 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Döndürür: GetSSOUserByIdAPIResponse
Örnek

get_sso_users 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | integer | query | Hayır |
Yanıt
Döndürür: GetSSOUsersResponse
Örnek

patch_sso_user 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet | |
| updateComments | boolean | sorgu | Hayır |
Yanıt
Döndürür: PatchSSOUserAPIResponse
Örnek

put_sso_user 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| updateComments | boolean | query | Hayır |
Yanıt
Döndürür: PutSSOUserAPIResponse
Örnek

create_subscription 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateSubscriptionAPIResponse
Örnek

delete_subscription 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır |
Yanıt
Döndürür: DeleteSubscriptionAPIResponse
Örnek

get_subscriptions 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır |
Yanıt
Döndürür: GetSubscriptionsAPIResponse
Örnek

update_subscription 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır |
Response
Döndürür: UpdateSubscriptionAPIResponse
Örnek

get_tenant_daily_usages 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Yanıt
Döndürür: GetTenantDailyUsagesResponse
Örnek

create_tenant_package 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateTenantPackageResponse
Örnek

delete_tenant_package 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_tenant_package 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetTenantPackageResponse
Örnek

get_tenant_packages 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetTenantPackagesResponse
Örnek

replace_tenant_package 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

update_tenant_package 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

create_tenant_user 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet |
Yanıt
Döndürür: CreateTenantUserResponse
Örnek

delete_tenant_user 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_tenant_user 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetTenantUserResponse
Örnek

get_tenant_users 
Parametreler
| Ad | Type | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetTenantUsersResponse
Örnek

replace_tenant_user 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| updateComments | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

send_login_link 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| redirectURL | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

update_tenant_user 
Parametreler
| Ad | Tür | Location | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| updateComments | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

create_tenant 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateTenantResponse
Örnek

delete_tenant 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| sure | string | query | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_tenant 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetTenantResponse
Örnek

get_tenants 
Parametreler
| Ad | Tip | Konum | Gereklidir | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| meta | string | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetTenantsResponse
Örnek

update_tenant 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Dönüş: APIEmptyResponse
Örnek

change_ticket_state 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Evet | |
| id | string | path | Evet |
Response
Döndürür: ChangeTicketStateResponse
Örnek

create_ticket 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Evet |
Yanıt
Döndürür: CreateTicketResponse
Örnek

get_ticket 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır |
Yanıt
Döndürür: GetTicketResponse
Örnek

get_tickets 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Yanıt
Returns: GetTicketsResponse
Örnek

get_translations 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| namespace | string | yol | Evet | |
| component | string | yol | Evet | |
| locale | string | sorgu | Hayır | |
| useFullTranslationIds | boolean | sorgu | Hayır |
Yanıt
Döndürür: GetTranslationsResponse
Örnek

upload_image 
Upload and resize an image
Parameters
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| sizePreset | string | query | Hayır | Boyut ön ayarı: "Default" (1000x1000px) veya "CrossPlatform" (popüler cihazlar için boyutları oluşturur) |
| urlId | string | query | Hayır | Yüklemenin gerçekleştiği sayfanın kimliği, yapılandırmak için |
Response
Döndürür: UploadImageResponse
Example

get_user_badge_progress_by_id 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIGetUserBadgeProgressResponse
Örnek

get_user_badge_progress_by_user_id 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | path | Evet |
Yanıt
Döndürür: APIGetUserBadgeProgressResponse
Örnek

get_user_badge_progress_list 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| limit | number | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: APIGetUserBadgeProgressListResponse
Örnek

create_user_badge 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: APICreateUserBadgeResponse
Örnek

delete_user_badge 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptySuccessResponse
Örnek

get_user_badge 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIGetUserBadgeResponse
Örnek

get_user_badges 
Parametreler
| İsim | Tip | Konum | Gereklidir | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| badgeId | string | query | Hayır | |
| type | number | query | Hayır | |
| displayedOnComments | boolean | query | Hayır | |
| limit | number | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: APIGetUserBadgesResponse
Örnek

update_user_badge 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptySuccessResponse
Örnek

get_user_notification_count 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetUserNotificationCountResponse
Örnek

get_user_notifications 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Mevcut sayfanın abone olup olmadığını belirlemek için kullanılır. |
| 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 |
Yanıt
Returns: GetMyNotificationsResponse
Örnek

reset_user_notification_count 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| sso | string | sorgu | Hayır |
Yanıt
Döndürür: ResetUserNotificationsResponse
Örnek

reset_user_notifications 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ResetUserNotificationsResponse
Örnek

update_user_notification_comment_subscription_status 
Belirli bir yorum için bildirimleri etkinleştirin veya devre dışı bırakın.
Parametreler
| 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 |
Yanıt
Döndürür: UpdateUserNotificationCommentSubscriptionStatusResponse
Örnek

update_user_notification_page_subscription_status 
Sayfa için bildirimleri etkinleştirin veya devre dışı bırakın. Kullanıcılar bir sayfaya abone olduğunda, yeni kök yorumlar için bildirimler oluşturulur ve ayrıca
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet | |
| url | string | query | Evet | |
| pageTitle | string | query | Evet | |
| subscribedOrUnsubscribed | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: UpdateUserNotificationPageSubscriptionStatusResponse
Örnek

update_user_notification_status 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| notificationId | string | path | Evet | |
| newStatus | string | path | Evet | |
| sso | string | query | Hayır |
Yanıt
Döndürür: UpdateUserNotificationStatusResponse
Örnek

get_user_presence_statuses 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlIdWS | string | query | Evet | |
| userIds | string | query | Evet |
Yanıt
Döndürür: GetUserPresenceStatusesResponse
Örnek

search_users 
Parametreler
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Yanıt
Döndürür: SearchUsersResult
Örnek

get_user 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: GetUserResponse
Örnek

create_vote 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Yanıt
Döndürür: VoteResponse
Örnek

delete_vote 
Parametreler
| İsim | Tip | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| editKey | string | query | Hayır |
Yanıt
Döndürür: VoteDeleteResponse
Örnek

get_votes 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet |
Yanıt
Döndürür: GetVotesResponse
Örnek

get_votes_for_user 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| urlId | string | query | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Yanıt
Döndürür: GetVotesForUserResponse
Örnek

Yardımı mı ihtiyacınız var?
Python SDK ile ilgili herhangi bir sorunla karşılaşırsanız veya sorularınız varsa, lütfen:
Katkıda Bulunma
Katkılar memnuniyetle karşılanır! Lütfen katkı yönergeleri için GitHub deposunu ziyaret edin.