
Dil 🇹🇷 Türkçe
Başlarken
Belgeler
Kullanım
Toplama
Denetim Kayıtları
Kimlik Doğrulama
Yorumdan Engelleme
Engellenen Yorumları Kontrol Et
Yorumlar
Kullanıcı İçin Yorumlar
Alan Adı Yapılandırmaları
E-posta Şablonları
Olay Günlüğü
Akış Gönderileri
Yorumu İşaretle
GIF'ler
Hashtagler
Moderasyon
Moderatörler
Bildirim Sayısı
Bildirimler
Sayfa Tepkileri
Sayfalar
Bekleyen Webhook Olayları
Soru Yapılandırmaları
Soru Sonuçları
Soru Sonuçları Toplama
SSO Kullanıcıları
Abonelikler
Kiracı Günlük Kullanımı
Kiracı Paketleri
Kiracı Kullanıcıları
Kiracılar
Biletler
Çeviriler
Görsel Yükle
Kullanıcı Rozet İlerlemesi
Kullanıcı Rozetleri
Kullanıcı Bildirimleri
Kullanıcı Varlık Durumu
Kullanıcı Arama
Kullanıcılar
Oylar
FastComments Ruby SDK
Bu, FastComments için resmi Ruby SDK'sıdır.
FastComments API'sı için resmi Ruby SDK'sı
Depo
Kurulum 
Add this line to your application's Gemfile:
gem 'fastcomments'
And then execute:
bundle install
Or install it yourself as:
gem install fastcomments
Kütüphane İçeriği
Bu kütüphane, API ile çalışmayı kolaylaştıran oluşturulmuş API istemcisi ve SSO yardımcı programlarını içerir.
Genel ve 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ılabilecek API çağrılarını içerir. ModerationApi ise moderatör kontrol panelini güçlendiren yöntemleri barındırır.
ModerationApi, canlı ve hızlı moderasyon API'lerinden oluşan kapsamlı bir set sunar. Her ModerationApi yöntemi bir sso parametresi kabul eder ve SSO ya da bir FastComments.com oturum çerezi aracılığıyla kimlik doğrulaması yapabilir.
Hızlı Başlangıç 
Using Authenticated APIs (DefaultApi)
Önemli: Kimliği doğrulanmış istekler yapmadan önce API anahtarını ApiClient üzerine ayarlamalısınız. Bunu yapmazsanız istekler 401 hatasıyla başarısız olur.
require 'fastcomments'
# API istemcisini oluştur ve yapılandır
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# GEREKLİ: API anahtarınızı ayarlayın (FastComments kontrol panelinizden alın)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# Yapılandırılmış istemciyle API örneğini oluştur
api = FastCommentsClient::DefaultApi.new(api_client)
# Artık kimliği doğrulanmış API çağrıları yapabilirsiniz
begin
# Örnek: Bir SSO kullanıcısı ekle
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# Yaygın hatalar:
# - 401: API anahtarı eksik veya geçersiz
# - 400: İstek doğrulaması başarısız oldu
end
Using Public APIs (PublicApi)
Public uç noktalar kimlik doğrulama gerektirmez:
require 'fastcomments'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
'YOUR_TENANT_ID',
'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Using Moderation APIs (ModerationApi)
Moderasyon yöntemleri moderatör kontrol panelini güçlendirir. İsteğin bir SSO‑kimliği doğrulanmış moderatör adına yapılması için bir sso belirteci gönderin:
require 'fastcomments'
moderation_api = FastCommentsClient::ModerationApi.new
begin
# Örnek: Moderasyon kuyruğundaki yorumları listele
response = moderation_api.get_api_comments(
sso: 'YOUR_MODERATOR_SSO_TOKEN'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Common Issues
- 401 "missing-api-key" hatası:
DefaultApiörneğini oluşturmadan önceconfig.api_key['x-api-key'] = 'YOUR_KEY'ayarladığınızdan emin olun. - Yanlış API sınıfı: Sunucu tarafı kimliği doğrulanmış istekler için
DefaultApi, istemci/halka açık istekler içinPublicApive moderatör kontrol paneli istekleri içinModerationApikullanın. - Null API anahtarı: SDK, API anahtarı null olduğunda kimlik doğrulamayı sessizce atlar ve bu da 401 hatalarına yol açar.
Notlar 
Yayın Kimlikleri
Bazı API çağrılarında bir broadcastId geçirmeniz gerektiğini göreceksiniz. Olayları aldığınızda bu ID size geri verilir, böylece istemcide değişiklikleri iyimserce uygulamayı planlıyorsanız olayı yok saymanız gerektiğini bilirsiniz (ki muhtemelen en iyi deneyimi sunduğu için bunu yapmak isteyeceksiniz). Buraya bir UUID geçirin. ID, bir tarayıcı oturumu içinde iki kez oluşmayacak kadar benzersiz olmalıdır.
SSO (Tek Oturum Açma)
SSO örnekleri için aşağıya bakın.
SSO Kullanımı 
Basit SSO
require 'fastcomments'
# Simple SSO belirteci oluştur
user = FastComments::SSO::SimpleSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
avatar: 'https://example.com/avatar.jpg'
)
sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token
puts "SSO Token: #{token}"
# Kimlik doğrulanmış bir API çağrısı yapmak için SSO belirtecini kullan
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
'your-tenant-id',
'your-page-url-id',
sso: token
)
puts "Status: #{response}"
Güvenli SSO
require 'fastcomments'
# Güvenli SSO belirteci oluştur
user = FastComments::SSO::SecureSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
username: 'johndoe',
avatar: 'https://example.com/avatar.jpg'
)
api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token
puts "Secure SSO Token: #{token}"
# Kimlik doğrulanmış bir API çağrısı yapmak için SSO belirtecini kullan
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
'your-tenant-id',
'your-page-url-id',
sso: token
)
puts "Status: #{response}"
aggregate 
Belgeleri, (groupBy sağlanmışsa) gruplayarak ve birden fazla işlem uygulayarak toplar. Farklı işlemler (ör. sum, countDistinct, avg vb.) desteklenir.
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| parentTenantId | string | query | Hayır | |
| includeStats | boolean | query | Hayır |
Yanıt
Döndürür: AggregateResponse
Örnek

get_audit_logs 
Parametreler
| 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 |
Yanıt
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
| 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: 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 | Location | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Yanıt
Döndürür: BlockSuccess
Örnek

create_comment_public 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| broadcastId | string | query | Evet | |
| sessionId | string | query | Hayır | |
| sso | string | query | Hayır |
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 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| broadcastId | string | query | Evet | |
| editKey | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: PublicAPIDeleteCommentResponse
Örnek

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

flag_comment 
Parametreler
| 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 |
Yanıt
Döndürür: FlagCommentResponse
Örnek

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

get_comment_text 
Parametreler
| Name | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| commentId | string | path | Evet | |
| editKey | string | query | Hayır | |
| sso | string | query | Hayır |
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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Döndürür: GetCommentsResponseWithPresencePublicComment
Örnek

lock_comment 
Parametreler
| Ad | Tür | Konum | Zorunlu | 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
| 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: ChangeCommentPinStatusResponse
Örnek

save_comment 
Parametreler
| Ad | Tür | Location | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| isLive | boolean | query | Hayır | |
| doSpamCheck | boolean | query | Hayır | |
| sendEmails | boolean | query | Hayır | |
| populateNotifications | boolean | query | Hayır |
Yanıt
Döndürür: APISaveCommentResponse
Örnek

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

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

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

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

un_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önen değer: APIEmptyResponse
Örnek

un_pin_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: ChangeCommentPinStatusResponse
Örnek

update_comment 
Parameters
| Ad | Tür | 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 |
Response
Dönüş: APIEmptyResponse
Example

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

get_comments_for_user 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| userId | string | query | Hayır | |
| direction | string | query | Hayır | |
| repliesToUserId | string | query | Hayır | |
| page | number | query | Hayır | |
| includei10n | boolean | query | Hayır | |
| locale | string | query | Hayır | |
| isCrawler | boolean | query | Hayır |
Yanıt
Döndürür: 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 | Konum | 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
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| domainToUpdate | string | path | Evet |
Yanıt
Döndürür: PatchDomainConfigResponse
Örnek

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

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

delete_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

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 
Parametreler
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetEmailTemplatesResponse
Örnek

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

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

get_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

get_global_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

create_feed_post 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| broadcastId | string | query | Hayır | |
| isLive | boolean | query | Hayır | |
| doSpamCheck | boolean | query | Hayır | |
| skipDupCheck | boolean | query | Hayır |
Yanıt
Döndürür: CreateFeedPostsResponse
Örnek

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

delete_feed_post_public 
Parametreler
| Ad | 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: DeleteFeedPostPublicResponse
Örnek

get_feed_posts 
istek tenantId afterId
Parametreler
| Ad | Tip | 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
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| postIds | array | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: UserReactsResponse
Örnek

react_feed_post_public 
Parametreler
| Ad | 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
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

update_feed_post_public 
Parametreler
| Ad | 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 | Gerekli | 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| largeInternalURLSanitized | string | query | Evet |
Yanıt
Döndürür: GifGetLargeResponse
Örnek

get_gifs_search 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Yanıt
Döndürür: GetGifsTrendingResponse
Örnek

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

add_hash_tags_bulk 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Yes | |
| tag | string | path | Yes |
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 | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: ModerationAPIGetCommentsResponse
Örnek

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

get_api_ids 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Response
Döndürür: 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
Döndürür: GetBannedUsersFromCommentResponse
Örnek

get_comment_ban_status 
Parametreler
| İsim | 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: GetCommentBanStatusResponse
Örnek

get_comment_children 
Parametreler
| Ad | Tür | Konum | Zorunlu | 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
| Ad | 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 
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: ModerationAPIGetLogsResponse
Örnek

get_manual_badges 
Parametreler
| Ad | Tip | 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
Döndürür: ModerationAPICommentResponse
Örnek

get_moderation_comment_text 
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: GetCommentTextResponse
Örnek

get_pre_ban_summary 
Parameters
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| includeByUserIdAndEmail | boolean | query | Hayır | |
| includeByIP | boolean | query | Hayır | |
| includeByEmailDomain | boolean | query | Hayır | |
| sso | string | query | Hayır |
Response
Döndürür: PreBanSummary
Örnek

get_search_comments_summary 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| value | string | query | Hayır | |
| filters | string | query | Hayır | |
| searchFilters | string | query | Hayır | |
| sso | string | query | Hayır |
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 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| text-search | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationSuggestResponse
Örnek

get_search_users 
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: 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 | Tür | 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 | Evet | |
| 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 | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ModerationExportResponse
Örnek

post_ban_user_from_comment 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| banEmail | boolean | query | Hayır | |
| banEmailDomain | boolean | query | Hayır | |
| banIP | boolean | query | Hayır | |
| deleteAllUsersComments | boolean | query | Hayır | |
| bannedUntil | string | query | Hayır | |
| isShadowBan | boolean | query | Hayır | |
| updateId | string | query | Hayır | |
| banReason | string | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: BanUserFromCommentResult
Örnek

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

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

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

post_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ülür: APIEmptyResponse
Örnek

post_remove_comment 
Parametreler
| Ad | Tür | Konum | Gereklidir | 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: PostRemoveCommentApiResponse
Örnek

post_restore_deleted_comment 
Parametreler
| Ad | Tür | Yer | 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_set_comment_approval_status 
Parametreler
| Ad | Tip | 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
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| commentId | string | path | Evet | |
| reviewed | 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_spam_status 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Yanıt
Döndürür: APIEmptyResponse
Örnek

post_set_comment_text 
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
Returns: SetCommentTextResponse
Örnek

post_un_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_vote 
Parametreler
| İsim | 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 | Tür | 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 
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: RemoveUserBadgeResponse
Örnek

put_reopen_thread 
Parameters
| İsim | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Response
Döndürür: APIEmptyResponse
Example

set_trust_factor 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| trustFactor | string | query | Hayır | |
| sso | string | query | Hayır |
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
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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öndürür: GetModeratorResponse
Örnek

get_moderators 
Parametreler
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Yanıt
Döndürür: GetModeratorsResponse
Örnek

send_invite 
Parametreler
| Ad | Type | Location | 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 | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

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

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

get_notification_count 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Yanıt
Döndürür: GetNotificationCountResponse
Örnek

get_notifications 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| urlId | string | query | Hayır | |
| fromCommentId | string | query | Hayır | |
| viewed | boolean | query | Hayır | |
| type | string | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetNotificationsResponse
Örnek

update_notification 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| title | string | query | Hayır |
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 | Yes | |
| urlId | string | query | Yes |
Yanıt
Döndürür: CreateV1PageReact
Örnek

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

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

get_v2_page_react_users 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| id | string | query | Evet |
Yanıt
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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: AddPageAPIResponse
Örnek

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

get_offline_users 
Sayfadaki VE şu anda çevrimiçi olmayan önceki yorumcular. displayName'e göre sıralanır. Bir "Members" bölümü oluşturmak için /users/online tükendiğinde bunu kullanın. commenterName üzerinde imleç paginasyonu: sunucu kısmi {tenantId, urlId, commenterName} indeksini afterName'den ileri doğru $gt ile yürütür, $skip maliyeti yok.
Parameters
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | Sayfa URL tanımlayıcısı (sunucu tarafında temizlenir). |
| afterName | string | query | Hayır | İmleç: önceki yanıttan nextAfterName değerini gönderin. |
| afterUserId | string | query | Hayır | Beraberlik durumunu çözen imleç: önceki yanıttan nextAfterUserId değerini gönderin. afterName ayarlandığında, aynı ada sahip kayıtların atlanmaması için gereklidir. |
Response
Döndürür: PageUsersOfflineResponse
Example

get_online_users 
Bir sayfanın şu anda çevrimiçi izleyicileri: websocket oturumu şu anda sayfaya abone olan kişiler. anonCount + totalCount döndürür (oda genelindeki aboneler, saymadığımız anonim izleyiciler dahil).
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | Sayfa URL tanımlayıcısı (sunucu tarafında temizlenir). |
| afterName | string | query | Hayır | İmleç: önceki yanıttan nextAfterName değerini gönderin. |
| afterUserId | string | query | Hayır | Berabere durumunu çözmek için imleç: önceki yanıttan nextAfterUserId değerini gönderin. afterName ayarlandığında, isim eşleşmeleri nedeniyle kayıtların düşmemesi için gereklidir. |
Yanıt
Döndürür: PageUsersOnlineResponse
Örnek

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

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

get_pages_public 
Bir kiracı için sayfaları listeler. FChat masaüstü istemcisi tarafından oda listesini doldurmak için kullanılır.
Her sayfa için çözümlenen özel yapılandırmada enableFChat'in true olması gerekir.
SSO gerektiren sayfalar, istekte bulunan kullanıcının grup erişimine göre filtrelenir.
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| cursor | string | query | Hayır | Önceki bir istekte nextCursor olarak döndürülen opak sayfalama imleci. Aynı sortBy ile ilişkili. |
| limit | integer | query | Hayır | 1..200, varsayılan 50 |
| q | string | query | Hayır | İsteğe bağlı büyük/küçük harf duyarsız başlık önek filtresi. |
| sortBy | string | query | Hayır | Sıralama düzeni. updatedAt (varsayılan, en yeni önce), commentCount (en çok yorum önce) veya title (alfabetik). |
| hasComments | boolean | query | Hayır | true ise, en az bir yorumu olan sayfaları döndürür. |
Yanıt
Döndürür: GetPublicPagesResponse
Örnek

get_users_info 
Bir tenant için toplu kullanıcı bilgisi. Verilen userId'lere göre User / SSOUser'tan görüntüleme bilgilerini döndürür. Yorum bileşeni tarafından, presence olayıyla 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
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| ids | string | query | Evet | Virgülle ayrılmış userId'ler. |
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
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

get_pending_webhook_event_count 
Parametreler
| Ad | Tür | Konum | Gerekli | 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öndürür: GetPendingWebhookEventCountResponse
Örnek

get_pending_webhook_events 
Parametreler
| Ad | Tür | Konum | Gerekli | 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 | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetPendingWebhookEventsResponse
Örnek

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

delete_question_config 
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_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 | sorgu | Evet | |
| skip | number | sorgu | Hayır |
Yanıt
Döndürür: GetQuestionConfigsResponse
Örnek

update_question_config 
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_question_result 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Dönen Değer: CreateQuestionResultResponse
Örnek

delete_question_result 
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_question_result 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet |
Yanıt
Döndürür: GetQuestionResultResponse
Örnek

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

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

aggregate_question_results 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| forceRecalculate | boolean | query | Hayır |
Yanıt
Döndürür: BulkAggregateQuestionResultsResponse
Örnek

combine_comments_with_question_results 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| deleteComments | boolean | query | Hayır | |
| commentDeleteMode | string | query | Hayır |
Response
Döndürür: DeleteSSOUserAPIResponse
Örnek

get_sso_user_by_email 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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 | sorgu | Evet | |
| id | string | yol | Evet |
Yanıt
Döndürür: GetSSOUserByIdAPIResponse
Örnek

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

patch_sso_user 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| id | string | path | Evet | |
| updateComments | boolean | query | 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 | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Yanıt
Döndürür: CreateSubscriptionAPIResponse
Örnek

delete_subscription 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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 |
Yanıt
Döndürür: UpdateSubscriptionAPIResponse
Örnek

get_tenant_daily_usages 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| yearNumber | number | query | Hayır | |
| monthNumber | number | query | Hayır | |
| dayNumber | number | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Döndürür: GetTenantDailyUsagesResponse
Örnek

create_tenant_package 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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 | Evet | |
| id | string | path | Evet |
Yanıt
Döndürür: APIEmptyResponse
Örnek

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

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

replace_tenant_package 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet |
Response
Döndürür: CreateTenantUserResponse
Örnek

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

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

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

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

send_login_link 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | sorgu | Evet | |
| id | string | yol | Evet | |
| updateComments | string | sorgu | Hayır |
Yanıt
Döndürür: APIEmptyResponse
Örnek

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

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

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

get_tenants 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| meta | string | query | Hayır | |
| skip | number | query | Hayır |
Yanıt
Dönüş değeri: GetTenantsResponse
Örnek

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

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

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

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

get_tickets 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| userId | string | query | Hayır | |
| state | number | query | Hayır | |
| skip | number | query | Hayır | |
| limit | number | query | Hayır |
Yanıt
Döndürür: GetTicketsResponse
Örnek

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

upload_image 
Bir resmi yükle ve yeniden boyutlandır
Parametreler
| 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 | Yapılandırmak için yüklemenin gerçekleştiği sayfanın kimliği |
Yanıt
Döndürür: UploadImageResponse
Örnek

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

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

get_user_badge_progress_list 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Yanıt
Döndürür: APIEmptySuccessResponse
Örnek

get_user_notification_count 
Parametreler
| Ad | Tip | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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 | Evet | |
| urlId | string | query | Hayır | Mevcut sayfanın abone olup olmadığını belirlemek için kullanılır. |
| pageSize | integer | query | Hayır | |
| afterId | string | query | Hayır | |
| includeContext | boolean | query | Hayır | |
| afterCreatedAt | integer | query | Hayır | |
| unreadOnly | boolean | query | Hayır | |
| dmOnly | boolean | query | Hayır | |
| noDm | boolean | query | Hayır | |
| includeTranslations | boolean | query | Hayır | |
| includeTenantNotifications | boolean | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: GetMyNotificationsResponse
Örnek

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

reset_user_notifications 
Parametreler
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Evet | |
| afterId | string | query | Hayır | |
| afterCreatedAt | integer | query | Hayır | |
| unreadOnly | boolean | query | Hayır | |
| dmOnly | boolean | query | Hayır | |
| noDm | boolean | query | Hayır | |
| sso | string | query | Hayır |
Yanıt
Döndürür: ResetUserNotificationsResponse
Örnek

update_user_notification_comment_subscription_status 
Belirli bir yorum için bildirimleri etkinleştirir veya devre dışı bırakır.
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 
Bir 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
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| 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ülen: UpdateUserNotificationPageSubscriptionStatusResponse
Örnek

update_user_notification_status 
Parametreler
| Ad | Tür | Konum | Gerekli | Açıklama |
|---|---|---|---|---|
| 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
| Ad | Tür | Konum | Zorunlu | Açıklama |
|---|---|---|---|---|
| tenantId | string | path | Evet | |
| urlId | string | query | Evet | |
| usernameStartsWith | string | query | Hayır | |
| mentionGroupIds | array | query | Hayır | |
| sso | string | query | Hayır | |
| searchSection | string | query | Hayır |
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 | Evet | |
| commentId | string | query | Evet | |
| direction | string | query | Evet | |
| userId | string | query | Hayır | |
| anonUserId | string | query | Hayır |
Yanıt
Döndürür: VoteResponse
Örnek

delete_vote 
Parametreler
| Ad | Tür | Konum | Gerekli | 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 | Zorunlu | 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 | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Yanıt
Döndürür: GetVotesForUserResponse
Örnek

Yardıma mı ihtiyacınız var?
Ruby SDK ile ilgili herhangi bir sorunla karşılaşırsanız veya sorularınız olursa lütfen:
Katkıda Bulunma
Katkılar memnuniyetle kabul edilir! Katkı yönergeleri için lütfen GitHub deposunu ziyaret edin.