
भाषा 🇮🇳 हिन्दी
दस्तावेज़ीकरण
शुरुआत करें
एग्रीगेट
ऑडिट लॉग
प्रमाणीकरण
कमेंट से ब्लॉक
ब्लॉक किए गए कमेंट जाँचें
कमेंट
उपयोगकर्ता के लिए कमेंट
डोमेन कॉन्फ़िग
ईमेल टेम्पलेट
इवेंट लॉग
फ़ीड पोस्ट
कमेंट फ़्लैग करें
GIF
हैश टैग
मॉडरेशन
मॉडरेटर
सूचना संख्या
सूचनाएँ
पेज रिएक्ट
पेज
लंबित वेबहुक इवेंट
प्रश्न कॉन्फ़िग
प्रश्न परिणाम
प्रश्न परिणाम एग्रीगेशन
SSO उपयोगकर्ता
सदस्यताएँ
टेनेंट दैनिक उपयोग
टेनेंट पैकेज
टेनेंट उपयोगकर्ता
टेनेंट
टिकट
अनुवाद
इमेज अपलोड करें
उपयोगकर्ता बैज प्रगति
उपयोगकर्ता बैज
उपयोगकर्ता सूचनाएँ
उपयोगकर्ता उपस्थिति स्थिति
उपयोगकर्ता खोज
उपयोगकर्ता
वोट
FastComments Python SDK
यह FastComments का आधिकारिक Python SDK है।
अपने Python एप्लिकेशन से कमेंट्स, यूज़र्स, SSO और मॉडरेशन का प्रबंधन करें।
रिपॉज़िटरी
AI कोडिंग एजेंट 
अपने कोडिंग एजेंट को FastComments का वह संदर्भ दें जिसकी उसे आवश्यकता है - विजेट्स, कॉन्फ़िगरेशन, Secure SSO, REST API, और SDKs:
npx skills add fastcomments/skills
यह Claude Code, Codex, Cursor, Copilot, Gemini, और skills CLI द्वारा समर्थित हर अन्य एजेंट के साथ काम करता है।
इंस्टॉलेशन 
GitHub से इंस्टॉल करें
सीधे एक रिलीज़ टैग से इंस्टॉल करें (अनुशंसित, पूरी तरह पुनरुत्पादन योग्य):
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0
ब्रांच के बजाय टैग को पिन करें ताकि बिल्ड नियत (deterministic) रहें। वही रूप requirements.txt में भी काम करता है:
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0
प्रत्येक टैग किए गए GitHub Release में एक बनी हुई wheel भी संलग्न होती है, यदि आप बाइनरी आर्टिफैक्ट सीधे इंस्टॉल करना पसंद करते हैं।
लाइब्रेरी की सामग्री
इस लाइब्रेरी में दो मॉड्यूल हैं: जनरेट किया गया API क्लाइंट और कोर Python लाइब्रेरी, जिसमें हाथ से लिखे गए यूटिलिटीज़ हैं जो API के साथ काम करना आसान बनाते हैं, जिसमें SSO सपोर्ट शामिल है।
पब्लिक बनाम सिक्योर्ड APIs
API क्लाइंट में तीन क्लासेस हैं: DefaultApi, PublicApi, और ModerationApi। DefaultApi में वे मेथड हैं जिनके लिए आपकी API key आवश्यक है, और PublicApi में वे मेथड हैं जिन्हें बिना प्रमाणीकरण के सीधे ब्राउज़र/मोबाइल डिवाइस/आदि से कॉल किया जा सकता है। ModerationApi लाइव और तेज़ मॉडरेशन APIs का एक व्यापक सूट प्रदान करता है। हर ModerationApi मेथड एक sso पैरामीटर स्वीकार करता है और SSO या FastComments.com सेशन कुकी के माध्यम से प्रमाणित हो सकता है।
क्विक स्टार्ट 
प्रमाणित APIs (DefaultApi) का उपयोग करना
महत्वपूर्ण: प्रमाणित अनुरोध करने से पहले आपको Configuration पर अपनी API key सेट करनी होगी। यदि आप ऐसा नहीं करते, तो अनुरोध 401 त्रुटि के साथ विफल हो जाएंगे।
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# API क्लाइंट बनाएं और कॉन्फ़िगर करें
config = Configuration()
config.host = "https://fastcomments.com"
# आवश्यक: अपनी API key सेट करें (यह अपने FastComments डैशबोर्ड से प्राप्त करें)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}
# कॉन्फ़िगर किए गए क्लाइंट के साथ API इंस्टेंस बनाएं
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# अब आप प्रमाणित API कॉल कर सकते हैं
try:
# उदाहरण: एक SSO उपयोगकर्ता जोड़ें
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}")
# सामान्य त्रुटियाँ:
# - 401: API key गायब या अमान्य है
# - 400: अनुरोध सत्यापन विफल रहा
सार्वजनिक APIs (PublicApi) का उपयोग करना
सार्वजनिक एंडपॉइंट्स को प्रमाणीकरण की आवश्यकता नहीं होती:
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}")
मॉडरेशन डैशबोर्ड (ModerationApi) का उपयोग करना
ModerationApi मॉडरेटर डैशबोर्ड को संचालित करता है। मेथड्स को एक sso टोकन पास करके मॉडरेटर की ओर से कॉल किया जाता है:
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:
# मॉडरेशन के लिए प्रतीक्षारत टिप्पणियों की गिनती करें
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
SSO (Single Sign-On) का उपयोग करना
SDK में सुरक्षित SSO टोकन जेनरेट करने के लिए यूटिलिटीज़ शामिल हैं:
from sso import FastCommentsSSO, SecureSSOUserData
# उपयोगकर्ता डेटा बनाएं (id, email, और username आवश्यक हैं)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# इसे अपनी API secret (HMAC-SHA256) के साथ साइन करें
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# विजेट या API कॉल को पास करने के लिए SSO टोकन जेनरेट करें
sso_token = sso.create_token()
# इस टोकन का उपयोग अपने फ्रंटएंड में करें या API कॉल को पास करें
print(f"SSO Token: {sso_token}")
सरल SSO के लिए (कम सुरक्षित, परीक्षण के लिए):
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()
लाइव सब्सक्रिप्शन (PubSub)
pubsub मॉड्यूल आपको WebSocket के माध्यम से रीयल-टाइम टिप्पणी घटनाओं (नई टिप्पणियाँ, वोट, संपादन, सूचनाएँ आदि) की सदस्यता लेने की सुविधा देता है, जो FastComments Java SDK के LiveEventSubscriber को दर्शाता है। इसे pubsub एक्स्ट्रा की आवश्यकता होती है, जो जेनरेट किए गए API क्लाइंट के ऊपर एक WebSocket क्लाइंट जोड़ता है:
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", # जैसे इस सत्र के लिए एक UUID
handle_live_event=handle_live_event,
on_connection_status_change=lambda connected, last_event_time: print(
f"connected={connected}"
),
region=None, # EU क्षेत्र के लिए "eu" सेट करें
)
# ...बाद में, जब आप अपडेट नहीं चाहते:
result.close()
सब्सक्राइबर कनेक्शन को एक बैकग्राउंड डेमन थ्रेड पर चलाता है, जिटर के साथ पारदर्शी रूप से पुनः कनेक्ट होता है, और पुनः कनेक्ट होने पर डिस्कनेक्ट के दौरान छूटी हुई घटनाओं को event-log एंडपॉइंट से प्राप्त करता है। उन टिप्पणियों की घटनाओं को फ़िल्टर करने के लिए एक वैकल्पिक can_see_comments कॉलबैक (List[str] -> Dict[str, str], जो वे ids लौटाता है जिन्हें उपयोगकर्ता नहीं देख सकता) पास करें जिन्हें देखने की उपयोगकर्ता को अनुमति नहीं है। subscribe_to_changes को एक no-op बनाने के लिए जो None लौटाए, disable_live_commenting=True सेट करें।
सामान्य समस्याएँ
- 401 "missing-api-key" त्रुटि: सुनिश्चित करें कि आपने DefaultApi इंस्टेंस बनाने से पहले
config.api_key = {"api_key": "YOUR_KEY"}सेट किया है। - गलत API क्लास: सर्वर-साइड प्रमाणित अनुरोधों के लिए
DefaultApi, क्लाइंट-साइड/सार्वजनिक अनुरोधों के लिएPublicApi, और मॉडरेटर डैशबोर्ड अनुरोधों के लिएModerationApiका उपयोग करें। - इंपोर्ट त्रुटियाँ: सुनिश्चित करें कि आप सही मॉड्यूल से इंपोर्ट कर रहे हैं:
- API क्लाइंट:
from client import ... - SSO यूटिलिटीज़:
from sso import ... - लाइव सब्सक्रिप्शन:
from pubsub import ...(pubsubएक्स्ट्रा की आवश्यकता है)
- API क्लाइंट:
नोट्स 
ब्रॉडकास्ट IDs
आप देखेंगे कि कुछ API कॉल में broadcast_id पास करना अपेक्षित है। जब आप इवेंट्स प्राप्त करते हैं, तो आपको यह ID वापस मिलेगी, ताकि यदि आप क्लाइंट पर बदलावों को optimistically लागू करने की योजना बनाते हैं (जो आप शायद करना चाहेंगे क्योंकि यह सर्वश्रेष्ठ अनुभव देता है), तो आप उस इवेंट को अनदेखा कर सकें। यहाँ एक UUID पास करें। यह ID इतनी अद्वितीय होनी चाहिए कि वह एक ब्राउज़र सेशन में दो बार न आए।
आवश्यकताएँ 
- Python >= 3.8
बेस इंस्टॉल प्योर-stdlib है और SSO यूटिलिटीज़ प्रदान करता है। जनरेटेड
API क्लाइंट (DefaultApi/PublicApi/ModerationApi) को client एक्स्ट्रा की आवश्यकता होती है,
जो urllib3 >= 1.25.3, python-dateutil >= 2.8.2,
pydantic >= 2.0.0, और typing-extensions >= 4.0.0 इंस्टॉल करता है:
pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.1.0"
aggregate 
दस्तावेज़ों को समूहित करके (यदि groupBy दिया गया हो) और कई ऑपरेशन लागू करके एकत्रित करता है। विभिन्न ऑपरेशन (जैसे sum, countDistinct, avg, आदि) समर्थित हैं।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| parentTenantId | string | query | नहीं | |
| includeStats | boolean | query | नहीं |
प्रतिक्रिया
लौटाता है: AggregateResponse
उदाहरण

get_audit_logs 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| limit | number | query | नहीं | |
| skip | number | query | नहीं | |
| order | string | query | नहीं | |
| after | number | query | नहीं | |
| before | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetAuditLogsResponse
उदाहरण

logout_public 
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

block_from_comment_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: BlockSuccess
उदाहरण

un_block_comment_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: UnblockSuccess
उदाहरण

checked_comments_for_blocked 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentIds | string | query | हाँ | कमेंट आईडी की कॉमा से अलग की गई सूची। |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: CheckBlockedCommentsResponse
उदाहरण

block_user_from_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| userId | string | query | नहीं | |
| anonUserId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: BlockSuccess
उदाहरण

create_comment_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| broadcastId | string | query | हाँ | |
| sessionId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: SaveCommentsResponseWithPresence
उदाहरण

delete_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| contextUserId | string | query | नहीं | |
| isLive | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: DeleteCommentResult
उदाहरण

delete_comment_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | हाँ | |
| editKey | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: PublicAPIDeleteCommentResponse
उदाहरण

delete_comment_vote 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| voteId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| broadcastId | string | query | हाँ | |
| editKey | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: VoteDeleteResponse
उदाहरण

flag_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| userId | string | query | नहीं | |
| anonUserId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: FlagCommentResponse
उदाहरण

get_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIGetCommentResponse
उदाहरण

get_comment_text 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| editKey | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: PublicAPIGetCommentTextResponse
उदाहरण

get_comment_vote_user_names 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| dir | integer | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetCommentVoteUserNamesSuccessResponse
उदाहरण

get_comments 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| page | integer | query | नहीं | |
| limit | integer | query | नहीं | |
| skip | integer | query | नहीं | |
| asTree | boolean | query | नहीं | |
| skipChildren | integer | query | नहीं | |
| limitChildren | integer | query | नहीं | |
| maxTreeDepth | integer | query | नहीं | |
| urlId | string | query | नहीं | |
| userId | string | query | नहीं | |
| anonUserId | string | query | नहीं | |
| contextUserId | string | query | नहीं | |
| hashTag | string | query | नहीं | |
| parentId | string | query | नहीं | |
| direction | string | query | नहीं | |
| fromDate | integer | query | नहीं | |
| toDate | integer | query | नहीं |
प्रतिक्रिया
रिटर्न: APIGetCommentsResponse
उदाहरण

get_comments_public 
req tenantId urlId
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| page | integer | query | नहीं | |
| direction | string | query | नहीं | |
| sso | string | query | नहीं | |
| skip | integer | query | नहीं | |
| skipChildren | integer | query | नहीं | |
| limit | integer | query | नहीं | |
| limitChildren | integer | query | नहीं | |
| countChildren | boolean | query | नहीं | |
| fetchPageForCommentId | string | query | नहीं | |
| includeConfig | boolean | query | नहीं | |
| countAll | boolean | query | नहीं | |
| includei10n | boolean | query | नहीं | |
| locale | string | query | नहीं | |
| modules | string | query | नहीं | |
| isCrawler | boolean | query | नहीं | |
| includeNotificationCount | boolean | query | नहीं | |
| asTree | boolean | query | नहीं | |
| maxTreeDepth | integer | query | नहीं | |
| useFullTranslationIds | boolean | query | नहीं | |
| parentId | string | query | नहीं | |
| searchText | string | query | नहीं | |
| hashTags | array | query | नहीं | |
| userId | string | query | नहीं | |
| customConfigStr | string | query | नहीं | |
| afterCommentId | string | query | नहीं | |
| beforeCommentId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetCommentsResponseWithPresencePublicComment
उदाहरण

lock_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

pin_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ChangeCommentPinStatusResponse
उदाहरण

save_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| isLive | boolean | query | नहीं | |
| doSpamCheck | boolean | query | नहीं | |
| sendEmails | boolean | query | नहीं | |
| populateNotifications | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APISaveCommentResponse
उदाहरण

save_comments_bulk 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| isLive | boolean | query | नहीं | |
| doSpamCheck | boolean | query | नहीं | |
| sendEmails | boolean | query | नहीं | |
| populateNotifications | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: SaveCommentsBulkResponse
उदाहरण

set_comment_text 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | हाँ | |
| editKey | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: PublicAPISetCommentTextResponse
उदाहरण

un_block_user_from_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| userId | string | query | नहीं | |
| anonUserId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: UnblockSuccess
उदाहरण

un_flag_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| userId | string | query | नहीं | |
| anonUserId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: FlagCommentResponse
उदाहरण

un_lock_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

un_pin_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ChangeCommentPinStatusResponse
उदाहरण

update_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| contextUserId | string | query | नहीं | |
| doSpamCheck | boolean | query | नहीं | |
| isLive | boolean | query | नहीं |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

vote_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| broadcastId | string | query | हाँ | |
| sessionId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न: VoteResponse
उदाहरण

get_comments_for_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| userId | string | query | नहीं | |
| direction | string | query | नहीं | |
| repliesToUserId | string | query | नहीं | |
| page | number | query | नहीं | |
| includei10n | boolean | query | नहीं | |
| locale | string | query | नहीं | |
| isCrawler | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetCommentsForUserResponse
उदाहरण

add_domain_config 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: AddDomainConfigResponse
उदाहरण

delete_domain_config 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| domain | string | path | हाँ |
प्रतिक्रिया
लौटाता है: DeleteDomainConfigResponse
उदाहरण

get_domain_config 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| domain | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetDomainConfigResponse
उदाहरण

get_domain_configs 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
लौटाता है: GetDomainConfigsResponse
उदाहरण

patch_domain_config 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| domainToUpdate | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: PatchDomainConfigResponse
उदाहरण

put_domain_config 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| domainToUpdate | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: PutDomainConfigResponse
उदाहरण

create_email_template 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
लौटाता है: CreateEmailTemplateResponse
उदाहरण

delete_email_template 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

delete_email_template_render_error 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| errorId | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

get_email_template 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetEmailTemplateResponse
उदाहरण

get_email_template_definitions 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetEmailTemplateDefinitionsResponse
उदाहरण

get_email_template_render_errors 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetEmailTemplateRenderErrorsResponse
उदाहरण

get_email_templates 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetEmailTemplatesResponse
उदाहरण

render_email_template 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| locale | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: RenderEmailTemplateResponse
उदाहरण

update_email_template 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

get_event_log 
req tenantId urlId userIdWS
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| userIdWS | string | query | हाँ | |
| startTime | integer | query | हाँ | |
| endTime | integer | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetEventLogResponse
उदाहरण

get_global_event_log 
req tenantId urlId userIdWS
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| userIdWS | string | query | हाँ | |
| startTime | integer | query | हाँ | |
| endTime | integer | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetEventLogResponse
उदाहरण

create_feed_post 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| broadcastId | string | query | नहीं | |
| isLive | boolean | query | नहीं | |
| doSpamCheck | boolean | query | नहीं | |
| skipDupCheck | boolean | query | नहीं |
प्रतिक्रिया
लौटाता है: CreateFeedPostsResponse
उदाहरण

create_feed_post_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: CreateFeedPostResponse
उदाहरण

delete_feed_post_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| postId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: DeleteFeedPostPublicResponse
उदाहरण

get_feed_posts 
req tenantId afterId
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| afterId | string | query | नहीं | |
| limit | integer | query | नहीं | |
| tags | array | query | नहीं |
प्रतिक्रिया
रिटर्न: GetFeedPostsResponse
उदाहरण

get_feed_posts_public 
req tenantId afterId
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| afterId | string | query | नहीं | |
| limit | integer | query | नहीं | |
| tags | array | query | नहीं | |
| sso | string | query | नहीं | |
| isCrawler | boolean | query | नहीं | |
| includeUserInfo | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: PublicFeedPostsResponse
उदाहरण

get_feed_posts_stats 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| postIds | array | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: FeedPostsStatsResponse
उदाहरण

get_user_reacts_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| postIds | array | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: UserReactsResponse
उदाहरण

react_feed_post_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| postId | string | path | हाँ | |
| isUndo | boolean | query | नहीं | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ReactFeedPostResponse
उदाहरण

update_feed_post 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

update_feed_post_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| postId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: CreateFeedPostResponse
उदाहरण

flag_comment_public 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| isFlagged | boolean | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

get_gif_large 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| largeInternalURLSanitized | string | query | हाँ |
प्रतिक्रिया
लौटाता है: GifGetLargeResponse
उदाहरण

get_gifs_search 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| search | string | query | हाँ | |
| locale | string | query | नहीं | |
| rating | string | query | नहीं | |
| page | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetGifsSearchResponse
उदाहरण

get_gifs_trending 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| locale | string | query | नहीं | |
| rating | string | query | नहीं | |
| page | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetGifsTrendingResponse
उदाहरण

add_hash_tag 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateHashTagResponse
उदाहरण

add_hash_tags_bulk 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: BulkCreateHashTagsResponse
उदाहरण

delete_hash_tag 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| tag | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

get_hash_tags 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| page | number | query | नहीं |
प्रतिक्रिया
लौटाता है: GetHashTagsResponse
उदाहरण

patch_hash_tag 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| tag | string | path | हाँ |
प्रतिक्रिया
लौटाता है: UpdateHashTagResponse
उदाहरण

delete_moderation_vote 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| voteId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
लौटाता है: VoteDeleteResponse
उदाहरण

get_api_comments 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| page | number | query | नहीं | |
| count | number | query | नहीं | |
| text-search | string | query | नहीं | |
| byIPFromComment | string | query | नहीं | |
| filters | string | query | नहीं | |
| searchFilters | string | query | नहीं | |
| sorts | string | query | नहीं | |
| demo | boolean | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
लौटाता है: ModerationAPIGetCommentsResponse
उदाहरण

get_api_export_status 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| batchJobId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
लौटाता है: ModerationExportStatusResponse
उदाहरण

get_api_ids 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| text-search | string | query | नहीं | |
| byIPFromComment | string | query | नहीं | |
| filters | string | query | नहीं | |
| searchFilters | string | query | नहीं | |
| afterId | string | query | नहीं | |
| demo | boolean | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationAPIGetCommentIdsResponse
उदाहरण

get_ban_users_from_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetBannedUsersFromCommentResponse
उदाहरण

get_comment_ban_status 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetCommentBanStatusResponse
उदाहरण

get_comment_children 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationAPIChildCommentsResponse
उदाहरण

get_count 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| text-search | string | query | नहीं | |
| byIPFromComment | string | query | नहीं | |
| filter | string | query | नहीं | |
| searchFilters | string | query | नहीं | |
| demo | boolean | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationAPICountCommentsResponse
उदाहरण

get_counts 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetBannedUsersCountResponse
उदाहरण

get_logs 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationAPIGetLogsResponse
उदाहरण

get_manual_badges 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTenantManualBadgesResponse
उदाहरण

get_manual_badges_for_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| badgesUserId | string | query | नहीं | |
| commentId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न: GetUserManualBadgesResponse
उदाहरण

get_moderation_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| includeEmail | boolean | query | नहीं | |
| includeIP | boolean | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationAPICommentResponse
उदाहरण

get_moderation_comment_text 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetCommentTextResponse
उदाहरण

get_pre_ban_summary 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| includeByUserIdAndEmail | boolean | query | नहीं | |
| includeByIP | boolean | query | नहीं | |
| includeByEmailDomain | boolean | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: PreBanSummary
उदाहरण

get_search_comments_summary 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| value | string | query | नहीं | |
| filters | string | query | नहीं | |
| searchFilters | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
लौटाता है: ModerationCommentSearchResponse
उदाहरण

get_search_pages 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| value | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationPageSearchResponse
उदाहरण

get_search_sites 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| value | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationSiteSearchResponse
उदाहरण

get_search_suggest 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| text-search | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationSuggestResponse
उदाहरण

get_search_users 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| value | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationUserSearchResponse
उदाहरण

get_trust_factor 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetUserTrustFactorResponse
उदाहरण

get_user_ban_preference 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIModerateGetUserBanPreferencesResponse
उदाहरण

get_user_internal_profile 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetUserInternalProfileResponse
उदाहरण

post_adjust_comment_votes 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: AdjustVotesResponse
उदाहरण

post_api_export 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| text-search | string | query | नहीं | |
| byIPFromComment | string | query | नहीं | |
| filters | string | query | नहीं | |
| searchFilters | string | query | नहीं | |
| sorts | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
लौटाता है: ModerationExportResponse
उदाहरण

post_ban_user_from_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| banEmail | boolean | query | नहीं | |
| banEmailDomain | boolean | query | नहीं | |
| banIP | boolean | query | नहीं | |
| deleteAllUsersComments | boolean | query | नहीं | |
| bannedUntil | string | query | नहीं | |
| isShadowBan | boolean | query | नहीं | |
| updateId | string | query | नहीं | |
| banReason | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: BanUserFromCommentResult
उदाहरण

post_ban_user_undo 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

post_bulk_pre_ban_summary 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| includeByUserIdAndEmail | boolean | query | नहीं | |
| includeByIP | boolean | query | नहीं | |
| includeByEmailDomain | boolean | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: BulkPreBanSummary
उदाहरण

post_comments_by_ids 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationAPIChildCommentsResponse
उदाहरण

post_flag_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

post_remove_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: PostRemoveCommentApiResponse
उदाहरण

post_restore_deleted_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

post_set_comment_approval_status 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| approved | boolean | query | नहीं | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न: SetCommentApprovedResponse
उदाहरण

post_set_comment_review_status 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| reviewed | boolean | query | नहीं | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

post_set_comment_spam_status 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| spam | boolean | query | नहीं | |
| permNotSpam | boolean | query | नहीं | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

post_set_comment_text 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: SetCommentTextResponse
उदाहरण

post_un_flag_comment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न: APIEmptyResponse
उदाहरण

post_vote 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| direction | string | query | नहीं | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
लौटाता है: VoteResponse
उदाहरण

put_award_badge 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| badgeId | string | query | हाँ | |
| userId | string | query | नहीं | |
| commentId | string | query | नहीं | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: AwardUserBadgeResponse
उदाहरण

put_close_thread 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

put_remove_badge 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| badgeId | string | query | हाँ | |
| userId | string | query | नहीं | |
| commentId | string | query | नहीं | |
| broadcastId | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: RemoveUserBadgeResponse
उदाहरण

put_reopen_thread 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

set_trust_factor 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | नहीं | |
| trustFactor | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: SetUserTrustFactorResponse
उदाहरण

create_moderator 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateModeratorResponse
उदाहरण

delete_moderator 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| sendEmail | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

get_moderator 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: GetModeratorResponse
उदाहरण

get_moderators 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetModeratorsResponse
उदाहरण

send_invite 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| fromName | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

update_moderator 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

delete_notification_count 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

get_cached_notification_count 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: GetCachedNotificationCountResponse
उदाहरण

get_notification_count 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | नहीं | |
| urlId | string | query | नहीं | |
| fromCommentId | string | query | नहीं | |
| viewed | boolean | query | नहीं | |
| type | string | query | नहीं |
प्रतिक्रिया
लौटाता है: GetNotificationCountResponse
उदाहरण

get_notifications 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | नहीं | |
| urlId | string | query | नहीं | |
| fromCommentId | string | query | नहीं | |
| viewed | boolean | query | नहीं | |
| type | string | query | नहीं | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न: GetNotificationsResponse
उदाहरण

update_notification 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| userId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

create_v1_page_react 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| title | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: CreateV1PageReact
उदाहरण

create_v2_page_react 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| id | string | query | हाँ | |
| title | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: CreateV1PageReact
उदाहरण

delete_v1_page_react 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateV1PageReact
उदाहरण

delete_v2_page_react 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| id | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateV1PageReact
उदाहरण

get_v1_page_likes 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ |
प्रतिक्रिया
रिटर्न: GetV1PageLikes
उदाहरण

get_v2_page_react_users 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| id | string | query | हाँ |
प्रतिक्रिया
रिटर्न: GetV2PageReactUsersResponse
उदाहरण

get_v2_page_reacts 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetV2PageReacts
उदाहरण

add_page 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
लौटाता है: AddPageAPIResponse
उदाहरण

delete_page 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: DeletePageAPIResponse
उदाहरण

get_offline_users 
पेज पर उन पिछले टिप्पणीकारों की सूची जो इस समय ऑनलाइन नहीं हैं। displayName के अनुसार क्रमबद्ध। "Members" सेक्शन रेंडर करने के लिए /users/online समाप्त करने के बाद इसका उपयोग करें। commenterName पर कर्सर पेजिनेशन: सर्वर afterName से आगे $gt के माध्यम से आंशिक {tenantId, urlId, commenterName} इंडेक्स पर चलता है, बिना $skip लागत के।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | पेज URL पहचानकर्ता (सर्वर-साइड पर साफ़ किया गया)। |
| afterName | string | query | नहीं | कर्सर: पिछली प्रतिक्रिया से nextAfterName पास करें। |
| afterUserId | string | query | नहीं | कर्सर टाइब्रेकर: पिछली प्रतिक्रिया से nextAfterUserId पास करें। afterName सेट होने पर आवश्यक ताकि समान नाम वाली प्रविष्टियाँ न छूटें। |
प्रतिक्रिया
रिटर्न करता है: PageUsersOfflineResponse
उदाहरण

get_online_users 
किसी पेज के वर्तमान में ऑनलाइन दर्शक: वे लोग जिनका websocket सत्र इस समय पेज की सदस्यता लिए हुए है। anonCount + totalCount लौटाता है (पूरे रूम के सदस्य, जिनमें वे अनाम दर्शक भी शामिल हैं जिन्हें हम सूचीबद्ध नहीं करते)।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | पेज URL पहचानकर्ता (सर्वर-साइड पर साफ़ किया गया)। |
| afterName | string | query | नहीं | कर्सर: पिछली प्रतिक्रिया से nextAfterName पास करें। |
| afterUserId | string | query | नहीं | कर्सर टाइब्रेकर: पिछली प्रतिक्रिया से nextAfterUserId पास करें। आवश्यक है जब afterName सेट हो ताकि समान नाम वाली प्रविष्टियाँ न छूटें। |
प्रतिक्रिया
लौटाता है: PageUsersOnlineResponse
उदाहरण

get_page_by_urlid 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetPageByURLIdAPIResponse
उदाहरण

get_pages 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
लौटाता है: GetPagesAPIResponse
उदाहरण

get_pages_public 
किसी टेनेंट के लिए पेजों की सूची लौटाता है। FChat डेस्कटॉप क्लाइंट द्वारा अपनी रूम सूची भरने के लिए उपयोग किया जाता है।
प्रत्येक पेज के लिए resolved custom config पर enableFChat true होना आवश्यक है।
SSO की आवश्यकता वाले पेजों को अनुरोध करने वाले उपयोगकर्ता के group access के आधार पर फ़िल्टर किया जाता है।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| cursor | string | query | नहीं | पिछले अनुरोध से nextCursor के रूप में लौटाया गया अपारदर्शी पेजिनेशन कर्सर। उसी sortBy से बंधा हुआ। |
| limit | integer | query | नहीं | 1..200, डिफ़ॉल्ट 50 |
| q | string | query | नहीं | वैकल्पिक, केस-असंवेदनशील शीर्षक प्रीफ़िक्स फ़िल्टर। |
| sortBy | string | query | नहीं | सॉर्ट क्रम। updatedAt (डिफ़ॉल्ट, नवीनतम पहले), commentCount (सर्वाधिक कमेंट पहले), या title (वर्णानुक्रम)। |
| hasComments | boolean | query | नहीं | यदि true है, तो केवल कम से कम एक कमेंट वाले पेज लौटाएँ। |
प्रतिक्रिया
लौटाता है: GetPublicPagesResponse
उदाहरण

get_users_info 
किसी टेनेंट के लिए बल्क यूज़र जानकारी। दिए गए userIds के लिए, User / SSOUser से डिस्प्ले जानकारी लौटाता है। कमेंट विजेट द्वारा उपयोग किया जाता है जो presence इवेंट के माध्यम से अभी दिखाई दिए यूज़र्स को समृद्ध (enrich) करने के लिए है। कोई पेज संदर्भ नहीं: गोपनीयता समान रूप से लागू की जाती है (प्राइवेट प्रोफाइल मास्क कर दिए जाते हैं)।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| ids | string | query | हाँ | कॉमा से अलग किए गए userIds। |
प्रतिक्रिया
लौटाता है: PageUsersInfoResponse
उदाहरण

patch_page 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: PatchPageAPIResponse
उदाहरण

delete_pending_webhook_event 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

get_pending_webhook_event_count 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | query | नहीं | |
| externalId | string | query | नहीं | |
| eventType | string | query | नहीं | |
| type | string | query | नहीं | |
| domain | string | query | नहीं | |
| attemptCountGT | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetPendingWebhookEventCountResponse
उदाहरण

get_pending_webhook_events 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | query | नहीं | |
| externalId | string | query | नहीं | |
| eventType | string | query | नहीं | |
| type | string | query | नहीं | |
| domain | string | query | नहीं | |
| attemptCountGT | number | query | नहीं | |
| skip | number | query | नहीं |
प्रतिक्रिया
लौटाता है: GetPendingWebhookEventsResponse
उदाहरण

create_question_config 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
लौटाता है: CreateQuestionConfigResponse
उदाहरण

delete_question_config 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

get_question_config 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetQuestionConfigResponse
उदाहरण

get_question_configs 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetQuestionConfigsResponse
उदाहरण

update_question_config 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

create_question_result 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateQuestionResultResponse
उदाहरण

delete_question_result 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

get_question_result 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetQuestionResultResponse
उदाहरण

get_question_results 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | नहीं | |
| userId | string | query | नहीं | |
| startDate | string | query | नहीं | |
| questionId | string | query | नहीं | |
| questionIds | string | query | नहीं | |
| skip | number | query | नहीं |
प्रतिक्रिया
लौटाता है: GetQuestionResultsResponse
उदाहरण

update_question_result 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

aggregate_question_results 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| questionId | string | query | नहीं | |
| questionIds | array | query | नहीं | |
| urlId | string | query | नहीं | |
| timeBucket | string | query | नहीं | |
| startDate | string | query | नहीं | |
| forceRecalculate | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: AggregateQuestionResultsResponse
उदाहरण

bulk_aggregate_question_results 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| forceRecalculate | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: BulkAggregateQuestionResultsResponse
उदाहरण

combine_comments_with_question_results 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| questionId | string | query | नहीं | |
| questionIds | array | query | नहीं | |
| urlId | string | query | नहीं | |
| startDate | string | query | नहीं | |
| forceRecalculate | boolean | query | नहीं | |
| minValue | number | query | नहीं | |
| maxValue | number | query | नहीं | |
| limit | number | query | नहीं |
प्रतिक्रिया
रिटर्न: CombineQuestionResultsWithCommentsResponse
उदाहरण

add_sso_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: AddSSOUserAPIResponse
उदाहरण

delete_sso_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| deleteComments | boolean | query | नहीं | |
| commentDeleteMode | string | query | नहीं |
प्रतिक्रिया
लौटाता है: DeleteSSOUserAPIResponse
उदाहरण

get_sso_user_by_email 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetSSOUserByEmailAPIResponse
उदाहरण

get_sso_user_by_id 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetSSOUserByIdAPIResponse
उदाहरण

get_sso_users 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| skip | integer | query | नहीं |
प्रतिक्रिया
लौटाता है: GetSSOUsersResponse
उदाहरण

patch_sso_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| updateComments | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: PatchSSOUserAPIResponse
उदाहरण

put_sso_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| updateComments | boolean | query | नहीं |
प्रतिक्रिया
लौटाता है: PutSSOUserAPIResponse
उदाहरण

create_subscription 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateSubscriptionAPIResponse
उदाहरण

delete_subscription 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| userId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: DeleteSubscriptionAPIResponse
उदाहरण

get_subscriptions 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetSubscriptionsAPIResponse
उदाहरण

update_subscription 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| userId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: UpdateSubscriptionAPIResponse
उदाहरण

get_tenant_daily_usages 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| yearNumber | number | query | नहीं | |
| monthNumber | number | query | नहीं | |
| dayNumber | number | query | नहीं | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTenantDailyUsagesResponse
उदाहरण

create_tenant_package 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
लौटाता है: CreateTenantPackageResponse
उदाहरण

delete_tenant_package 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

get_tenant_package 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: GetTenantPackageResponse
उदाहरण

get_tenant_packages 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTenantPackagesResponse
उदाहरण

replace_tenant_package 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

update_tenant_package 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

create_tenant_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateTenantUserResponse
उदाहरण

delete_tenant_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| deleteComments | string | query | नहीं | |
| commentDeleteMode | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

get_tenant_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetTenantUserResponse
उदाहरण

get_tenant_users 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| skip | number | query | नहीं |
प्रतिक्रिया
लौटाता है: GetTenantUsersResponse
उदाहरण

replace_tenant_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| updateComments | string | query | नहीं |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

send_login_link 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| redirectURL | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

update_tenant_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| updateComments | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

create_tenant 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
लौटाता है: CreateTenantResponse
उदाहरण

delete_tenant 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| sure | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

get_tenant 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetTenantResponse
उदाहरण

get_tenants 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| meta | string | query | नहीं | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTenantsResponse
उदाहरण

update_tenant 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

change_ticket_state 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: ChangeTicketStateResponse
उदाहरण

create_ticket 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateTicketResponse
उदाहरण

get_ticket 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| userId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTicketResponse
उदाहरण

get_tickets 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | नहीं | |
| state | number | query | नहीं | |
| skip | number | query | नहीं | |
| limit | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTicketsResponse
उदाहरण

get_translations 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| namespace | string | path | हाँ | |
| component | string | path | हाँ | |
| locale | string | query | नहीं | |
| useFullTranslationIds | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न: GetTranslationsResponse
उदाहरण

upload_image 
एक इमेज अपलोड और रीसाइज़ करें
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| sizePreset | string | query | नहीं | साइज़ प्रीसेट: "Default" (1000x1000px) या "CrossPlatform" (लोकप्रिय डिवाइसों के लिए साइज़ बनाता है) |
| urlId | string | query | नहीं | वह पेज id जिससे अपलोड हो रहा है, कॉन्फ़िगर करने के लिए |
प्रतिक्रिया
रिटर्न करता है: UploadImageResponse
उदाहरण

get_user_badge_progress_by_id 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIGetUserBadgeProgressResponse
उदाहरण

get_user_badge_progress_by_user_id 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIGetUserBadgeProgressResponse
उदाहरण

get_user_badge_progress_list 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | नहीं | |
| limit | number | query | नहीं | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIGetUserBadgeProgressListResponse
उदाहरण

create_user_badge 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: APICreateUserBadgeResponse
उदाहरण

delete_user_badge 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptySuccessResponse
उदाहरण

get_user_badge 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIGetUserBadgeResponse
उदाहरण

get_user_badges 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| userId | string | query | नहीं | |
| badgeId | string | query | नहीं | |
| type | number | query | नहीं | |
| displayedOnComments | boolean | query | नहीं | |
| limit | number | query | नहीं | |
| skip | number | query | नहीं |
प्रतिक्रिया
लौटाता है: APIGetUserBadgesResponse
उदाहरण

update_user_badge 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptySuccessResponse
उदाहरण

get_user_notification_count 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न: GetUserNotificationCountResponse
उदाहरण

get_user_notifications 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | नहीं | यह निर्धारित करने के लिए उपयोग किया जाता है कि क्या वर्तमान पृष्ठ सब्सक्राइब है। |
| pageSize | integer | query | नहीं | |
| afterId | string | query | नहीं | |
| includeContext | boolean | query | नहीं | |
| afterCreatedAt | integer | query | नहीं | |
| unreadOnly | boolean | query | नहीं | |
| dmOnly | boolean | query | नहीं | |
| noDm | boolean | query | नहीं | |
| includeTranslations | boolean | query | नहीं | |
| includeTenantNotifications | boolean | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न: GetMyNotificationsResponse
उदाहरण

reset_user_notification_count 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: ResetUserNotificationsResponse
उदाहरण

reset_user_notifications 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| afterId | string | query | नहीं | |
| afterCreatedAt | integer | query | नहीं | |
| unreadOnly | boolean | query | नहीं | |
| dmOnly | boolean | query | नहीं | |
| noDm | boolean | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
लौटाता है: ResetUserNotificationsResponse
उदाहरण

update_user_notification_comment_subscription_status 
किसी विशिष्ट कमेंट के लिए नोटिफिकेशन सक्षम या अक्षम करें।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| notificationId | string | path | हाँ | |
| optedInOrOut | string | path | हाँ | |
| commentId | string | query | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: UpdateUserNotificationCommentSubscriptionStatusResponse
उदाहरण

update_user_notification_page_subscription_status 
किसी पेज के लिए नोटिफिकेशन सक्षम या अक्षम करें। जब उपयोगकर्ता किसी पेज की सदस्यता लेते हैं, तो नई रूट कमेंट्स के लिए नोटिफिकेशन बनाए जाते हैं, और साथ ही
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | हाँ | |
| url | string | query | हाँ | |
| pageTitle | string | query | हाँ | |
| subscribedOrUnsubscribed | string | path | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: UpdateUserNotificationPageSubscriptionStatusResponse
उदाहरण

update_user_notification_status 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| notificationId | string | path | हाँ | |
| newStatus | string | path | हाँ | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: UpdateUserNotificationStatusResponse
उदाहरण

get_user_presence_statuses 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlIdWS | string | query | हाँ | |
| userIds | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetUserPresenceStatusesResponse
उदाहरण

search_users 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| usernameStartsWith | string | query | नहीं | |
| mentionGroupIds | array | query | नहीं | |
| sso | string | query | नहीं | |
| searchSection | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: SearchUsersResult
उदाहरण

get_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
लौटाता है: GetUserResponse
उदाहरण

create_vote 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | query | हाँ | |
| direction | string | query | हाँ | |
| userId | string | query | नहीं | |
| anonUserId | string | query | नहीं |
प्रतिक्रिया
रिटर्न: VoteResponse
उदाहरण

delete_vote 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ | |
| editKey | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: VoteDeleteResponse
उदाहरण

get_votes 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetVotesResponse
उदाहरण

get_votes_for_user 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | हाँ | |
| userId | string | query | नहीं | |
| anonUserId | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetVotesForUserResponse
उदाहरण

सहायता चाहिए?
यदि आपको Python SDK के बारे में कोई समस्या आती है या कोई प्रश्न हो, तो कृपया:
योगदान देना
योगदान का स्वागत है! कृपया योगदान दिशानिर्देशों के लिए GitHub रिपॉजिटरी देखें।