
भाषा 🇮🇳 हिन्दी
दस्तावेज़ीकरण
शुरू करें
API संदर्भ
उपयोग
एग्रीगेट
ऑडिट लॉग
प्रमाणीकरण
कमेंट से ब्लॉक
ब्लॉक किए गए कमेंट जांचें
कमेंट्स
उपयोगकर्ता के लिए कमेंट्स
डोमेन कॉन्फ़िग
ईमेल टेम्पलेट
इवेंट लॉग
फ़ीड पोस्ट
कमेंट फ़्लैग करें
GIFs
हैश टैग
मॉडरेशन
मॉडरेटर
सूचना संख्या
सूचनाएं
पेज रिएक्ट
पेज
लंबित वेबहुक इवेंट
प्रश्न कॉन्फ़िग
प्रश्न परिणाम
प्रश्न परिणाम एग्रीगेशन
SSO उपयोगकर्ता
सदस्यताएं
टेनेंट दैनिक उपयोग
टेनेंट पैकेज
टेनेंट उपयोगकर्ता
टेनेंट
टिकट
अनुवाद
छवि अपलोड करें
उपयोगकर्ता बैज प्रगति
उपयोगकर्ता बैज
उपयोगकर्ता सूचनाएं
उपयोगकर्ता उपस्थिति स्थिति
उपयोगकर्ता खोज
उपयोगकर्ता
वोट
FastComments C++ SDK
यह FastComments का आधिकारिक C++ SDK है।
अपने C++ एप्लिकेशन से कमेंट्स, यूज़र्स, SSO और मॉडरेशन को प्रबंधित करें।
रिपॉज़िटरी
AI coding agents 
अपने कोडिंग एजेंट को FastComments का वह संदर्भ दें जिसकी उसे आवश्यकता है - विजेट्स, कॉन्फ़िगरेशन, Secure SSO, REST API, और SDKs:
npx skills add fastcomments/skills
यह Claude Code, Codex, Cursor, Copilot, Gemini, और skills CLI द्वारा समर्थित हर अन्य एजेंट के साथ काम करता है।
Requirements 
- C++17 या बाद का संस्करण
- CMake 3.14 या बाद का संस्करण
- OpenSSL
- C++ REST SDK (cpprestsdk)
- Boost
- Google Test (टेस्टिंग के लिए स्वतः डाउनलोड हो जाता है)
Installation 
डिपेंडेंसीज़ इंस्टॉल करें
sudo apt install libcpprest-dev libboost-all-dev
सोर्स से बिल्ड करना
mkdir build
cd build
cmake ..
make
इंस्टॉल करना
sudo make install
लाइब्रेरी सामग्री
इस लाइब्रेरी में जेनरेट किया गया API क्लाइंट और SSO यूटिलिटीज़ शामिल हैं, जिनसे API के साथ काम करना आसान हो जाता है।
पब्लिक बनाम सिक्योर्ड API
API क्लाइंट में तीन क्लासेस हैं: DefaultApi, PublicApi, और ModerationApi। DefaultApi में वे मेथड्स हैं जिनके लिए आपकी API कुंजी आवश्यक है, और PublicApi में वे मेथड्स हैं जिन्हें बिना प्रमाणीकरण के सीधे ब्राउज़र/मोबाइल डिवाइस/आदि से कॉल किया जा सकता है। ModerationApi लाइव और तेज़ मॉडरेशन API का एक विस्तृत सूट प्रदान करता है। हर ModerationApi मेथड एक sso पैरामीटर स्वीकार करता है और SSO या FastComments.com सेशन कुकी के माध्यम से प्रमाणीकरण कर सकता है।
Quick Start 
प्रमाणित APIs का उपयोग (DefaultAPI)
महत्वपूर्ण:
- आपको बेस URL सेट करना होगा (cpp-restsdk जनरेटर इसे OpenAPI spec से नहीं पढ़ता)
- प्रमाणित अनुरोध करने से पहले आपको ApiClient पर अपनी API key सेट करनी होगी। यदि आप ऐसा नहीं करते, तो अनुरोध 401 त्रुटि के साथ विफल होंगे।
#include <iostream>
#include "FastCommentsClient/api/DefaultApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// आवश्यक: बेस URL सेट करें (अपना region चुनें)
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com")); // US
// या: config->setBaseUrl(utility::conversions::to_string_t("https://eu.fastcomments.com")); // EU
// आवश्यक: अपनी API key सेट करें
config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_API_KEY_HERE"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// अब प्रमाणित API कॉल करें
return 0;
}
सार्वजनिक APIs का उपयोग (PublicAPI)
सार्वजनिक endpoints के लिए प्रमाणीकरण की आवश्यकता नहीं है:
#include <iostream>
#include "FastCommentsClient/api/PublicApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// आवश्यक: बेस URL सेट करें
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::PublicApi publicApi(apiClient);
// सार्वजनिक API कॉल करें
return 0;
}
मॉडरेशन APIs का उपयोग (ModerationApi)
ModerationApi मॉडरेटर डैशबोर्ड को संचालित करता है। हर method एक sso parameter स्वीकार करता है ताकि कॉल एक SSO-प्रमाणित मॉडरेटर की ओर से चले (token बनाने का तरीका नीचे SSO अनुभाग देखें):
#include <iostream>
#include "FastCommentsClient/api/ModerationApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// आवश्यक: बेस URL सेट करें
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::ModerationApi moderationApi(apiClient);
// कॉल को प्रमाणित करने के लिए मॉडरेटर का SSO token पास करें
auto ssoToken = utility::conversions::to_string_t("YOUR_MODERATOR_SSO_TOKEN");
org::openapitools::client::api::GetCountOptions options;
options.sso = ssoToken;
auto response = moderationApi.getCount(options).get();
return 0;
}
सामान्य समस्याएँ
- "URI must contain a hostname" त्रुटि: सुनिश्चित करें कि आपने ApiClient बनाने से पहले
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"))कॉल किया है। cpp-restsdk जनरेटर OpenAPI spec से server URL स्वचालित रूप से नहीं पढ़ता। - 401 "missing-api-key" त्रुटि: सुनिश्चित करें कि आपने DefaultAPI instance बनाने से पहले
config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_KEY"))कॉल किया है। - गलत API class: server-side प्रमाणित अनुरोधों के लिए
DefaultApi, client-side/सार्वजनिक अनुरोधों के लिएPublicApi, और मॉडरेटर डैशबोर्ड अनुरोधों के लिएModerationApi(मॉडरेटर SSO token से प्रमाणित) का उपयोग करें।
Making API Calls: Synchronous vs Asynchronous 
इस SDK के सभी API मेथड्स C++ REST SDK से pplx::task<std::shared_ptr<ResponseType>> रिटर्न करते हैं। इससे आपको API रिस्पॉन्स को हैंडल करने के तरीके में लचीलापन मिलता है।
.get() के साथ सिंक्रोनस कॉल्स
कॉलिंग थ्रेड को ब्लॉक करने और रिज़ल्ट को सिंक्रोनस रूप से प्राप्त करने के लिए .get() का उपयोग करें, जब तक कि रिक्वेस्ट पूरी न हो जाए:
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
utility::conversions::to_string_t("YOUR_API_KEY"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// आवश्यक पैरामीटर पोज़िशनल होते हैं; वैकल्पिक पैरामीटर options स्ट्रक्चर में जाते हैं
org::openapitools::client::api::GetCommentsOptions options;
options.urlId = utility::conversions::to_string_t("your-url-id");
// ब्लॉक करने और रिज़ल्ट को सिंक्रोनस रूप से प्राप्त करने के लिए .get() कॉल करें
auto response = api.getComments(
utility::conversions::to_string_t("your-tenant-id"),
options
).get(); // HTTP रिक्वेस्ट पूरा होने तक ब्लॉक करता है
if (response && response->comments) {
std::cout << "Found " << response->comments->size() << " comments" << std::endl;
}
.then() के साथ एसिंक्रोनस कॉल्स
कॉलबैक के साथ नॉन-ब्लॉकिंग एसिंक्रोनस एक्ज़ीक्यूशन के लिए .then() का उपयोग करें:
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
utility::conversions::to_string_t("YOUR_API_KEY"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// आवश्यक पैरामीटर पोज़िशनल होते हैं; वैकल्पिक पैरामीटर options स्ट्रक्चर में जाते हैं
org::openapitools::client::api::GetCommentsOptions options;
options.urlId = utility::conversions::to_string_t("your-url-id");
// कॉलबैक-आधारित एसिंक्रोनस एक्ज़ीक्यूशन के लिए .then() का उपयोग करें
api.getComments(
utility::conversions::to_string_t("your-tenant-id"),
options
).then([](std::shared_ptr<GetComments_200_response> response) {
// रिक्वेस्ट पूरा होने पर यह एसिंक्रोनस रूप से चलता है
if (response && response->comments) {
std::cout << "Found " << response->comments->size() << " comments" << std::endl;
}
});
// एक्ज़ीक्यूशन बिना ब्लॉक किए तुरंत आगे बढ़ जाता है
std::cout << "Request sent, continuing..." << std::endl;
सिंक्रोनस और एसिंक्रोनस में से चुनाव
चुनाव आपके रनटाइम एनवायरनमेंट और एप्लिकेशन आर्किटेक्चर पर निर्भर करता है:
.get() (सिंक्रोनस ब्लॉकिंग)
- HTTP रिक्वेस्ट पूरा होने तक कॉलिंग थ्रेड को ब्लॉक करता है
- सरल कोड फ्लो, समझने में आसान
- समर्पित वर्कर थ्रेड्स, बैच प्रोसेसिंग, या कमांड-लाइन टूल्स के लिए उपयुक्त
- इवेंट लूप्स, GUI थ्रेड्स, या सिंगल-थ्रेडेड सर्वर के लिए उपयुक्त नहीं
.then() (एसिंक्रोनस नॉन-ब्लॉकिंग)
- तुरंत रिटर्न करता है, रिक्वेस्ट पूरा होने पर कॉलबैक एक्ज़ीक्यूट होता है
- कॉलिंग थ्रेड को ब्लॉक नहीं करता
- इवेंट-ड्रिवन आर्किटेक्चर, GUI एप्लिकेशन, या सिंगल-थ्रेडेड इवेंट लूप्स के लिए आवश्यक
- कई ऑपरेशन्स को चेन करने की अनुमति देता है
- अधिक जटिल कंट्रोल फ्लो
SDK का टेस्ट सूट केवल .get() का उपयोग करता है, लेकिन यह टेस्ट एनवायरनमेंट के लिए उपयुक्त है जहाँ ब्लॉकिंग स्वीकार्य है।
Notes 
ब्रॉडकास्ट आईडी
आप देखेंगे कि कुछ API कॉल में broadcastId पास करना अपेक्षित है। जब आप इवेंट प्राप्त करते हैं, तो आपको यह आईडी वापस मिलेगी, ताकि यदि आप क्लाइंट पर ऑप्टिमिस्टिक रूप से बदलाव लागू करने की योजना बनाते हैं (जो आप शायद करना चाहेंगे क्योंकि यह सबसे अच्छा अनुभव प्रदान करता है), तो आप उस इवेंट को अनदेखा कर सकें। यहाँ एक UUID पास करें। यह आईडी इतनी अद्वितीय होनी चाहिए कि वह एक ब्राउज़र सत्र में दो बार न आए।
SSO (सिंगल साइन-ऑन)
SSO उदाहरणों के लिए, नीचे देखें।
SSO Usage 
सरल SSO
#include <fastcomments/sso/fastcomments_sso.hpp>
#include <iostream>
using namespace fastcomments::sso;
int main() {
SimpleSSOUserData user("user-123", "user@example.com", "https://example.com/avatar.jpg");
FastCommentsSSO sso = FastCommentsSSO::newSimple(user);
std::string token = sso.createToken();
std::cout << "SSO Token: " << token << std::endl;
return 0;
}
सुरक्षित SSO
#include <fastcomments/sso/fastcomments_sso.hpp>
#include <iostream>
using namespace fastcomments::sso;
int main() {
SecureSSOUserData user("user-123", "user@example.com", "johndoe", "https://example.com/avatar.jpg");
std::string apiKey = "your-api-key";
FastCommentsSSO sso = FastCommentsSSO::newSecure(apiKey, user);
std::string token = sso.createToken();
std::cout << "Secure SSO Token: " << token << std::endl;
return 0;
}
Documentation for fastcomments 
Documentation for API Endpoints
All URIs are relative to https://fastcomments.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported. |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | req tenantId afterId |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/mod_api/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/mod_api/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/mod_api/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/mod_api/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/mod_api/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/mod_api/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/mod_api/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/mod_api/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/mod_api/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/mod_api/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/mod_api/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/mod_api/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/mod_api/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/mod_api/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/mod_api/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/mod_api/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/mod_api/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/mod_api/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/mod_api/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/mod_api/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/mod_api/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/mod_api/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/mod_api/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | req tenantId urlId |
| PublicApi | getEventLog | GET /event-log/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | req tenantId afterId |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost. |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate). |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires enableFChat to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access. |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | getUsersInfo | GET /pages/{tenantId}/users/info | Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked). |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | Enable or disable notifications for a specific comment. |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | Upload and resize an image |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Documentation for Models
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBase_meta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponse_anyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequest_sort
- AggregationResponse
- AggregationResponse_stats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchType
- BannedUserMatch_matchedOnValue
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBody_tags_inner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponse_results_inner
- BulkPreBanParams
- BulkPreBanSummary
- ChangeCommentPinStatusResponse
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CommentsByIdsParams
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPostParams
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadgeParams
- CreateV1PageReact
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentResult
- DeleteDomainConfigResponse
- DeleteFeedPostPublicResponse
- DeleteHashTagRequestBody
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FComment_meta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentResponse
- GetAuditLogsResponse
- GetBannedUsersCountResponse
- GetBannedUsersFromCommentResponse
- GetCachedNotificationCountResponse
- GetCommentBanStatusResponse
- GetCommentTextResponse
- GetCommentVoteUserNamesSuccessResponse
- GetCommentsForUserResponse
- GetCommentsResponseWithPresence_PublicComment_
- GetCommentsResponse_PublicComment_
- GetDomainConfigResponse
- GetDomainConfigsResponse
- GetDomainConfigsResponse_anyOf
- GetDomainConfigsResponse_anyOf_1
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplatesResponse
- GetEventLogResponse
- GetFeedPostsResponse
- GetGifsSearchResponse
- GetGifsTrendingResponse
- GetHashTagsResponse
- GetModeratorResponse
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCountResponse
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetPublicPagesResponse
- GetQuestionConfigResponse
- GetQuestionConfigsResponse
- GetQuestionResultResponse
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsersResponse
- GetSubscriptionsAPIResponse
- GetTenantDailyUsagesResponse
- GetTenantManualBadgesResponse
- GetTenantPackageResponse
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUserResponse
- GetTenantUsersResponse
- GetTenantsResponse
- GetTicketResponse
- GetTicketsResponse
- GetTranslationsResponse
- GetUserInternalProfileResponse
- GetUserInternalProfileResponse_profile
- GetUserManualBadgesResponse
- GetUserNotificationCountResponse
- GetUserPresenceStatusesResponse
- GetUserResponse
- GetUserTrustFactorResponse
- GetV1PageLikes
- GetV2PageReactUsersResponse
- GetV2PageReacts
- GetVotesForUserResponse
- GetVotesResponse
- GifGetLargeResponse
- GifRating
- GifSearchInternalError
- GifSearchResponse
- GifSearchResponse_images_inner_inner
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAgentApprovalNotificationFrequency
- ImportedSiteType
- LiveEvent
- LiveEventType
- LiveEvent_extraInfo
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- ModerationAPIChildCommentsResponse
- ModerationAPIComment
- ModerationAPICommentLog
- ModerationAPICommentResponse
- ModerationAPICountCommentsResponse
- ModerationAPIGetCommentIdsResponse
- ModerationAPIGetCommentsResponse
- ModerationAPIGetLogsResponse
- ModerationCommentSearchResponse
- ModerationExportResponse
- ModerationExportStatusResponse
- ModerationFilter
- ModerationPageSearchProjected
- ModerationPageSearchResponse
- ModerationSiteSearchProjected
- ModerationSiteSearchResponse
- ModerationSuggestResponse
- ModerationUserSearchProjected
- ModerationUserSearchResponse
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PageUserEntry
- PageUsersInfoResponse
- PageUsersOfflineResponse
- PageUsersOnlineResponse
- PagesSortBy
- PatchDomainConfigParams
- PatchDomainConfigResponse
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PostRemoveCommentApiResponse
- PreBanSummary
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicPage
- PublicVote
- PutDomainConfigResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicate_value
- QuestionConfig
- QuestionConfig_customOptions_inner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostResponse
- Record_string__before_string_or_null__after_string_or_null___value
- RemoveCommentActionResponse
- RemoveUserBadgeResponse
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotificationsResponse
- SORT_DIR
- SSOSecurityLevel
- SaveCommentResponseOptimized
- SaveCommentsBulkResponse
- SaveCommentsResponseWithPresence
- SearchUsersResponse
- SearchUsersResult
- SearchUsersSectionedResponse
- SetCommentApprovedResponse
- SetCommentTextParams
- SetCommentTextResponse
- SetCommentTextResult
- SetUserTrustFactorResponse
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantBadge
- TenantHashTag
- TenantPackage
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadgeParams
- UpdateUserNotificationCommentSubscriptionStatusResponse
- UpdateUserNotificationPageSubscriptionStatusResponse
- UpdateUserNotificationStatusResponse
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- UsersListLocation
- VoteBodyParams
- VoteDeleteResponse
- VoteResponse
- VoteResponseUser
- VoteStyle
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: x-api-key
- Location: HTTP header
aggregate 
दस्तावेज़ों को समूहित करके (यदि groupBy दिया गया है) एकत्रित करता है और कई ऑपरेशन लागू करता है। विभिन्न ऑपरेशन (जैसे sum, countDistinct, avg, आदि) समर्थित हैं।
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| aggregationRequest | AggregationRequest | हाँ | |
| options | const AggregateOptions& | हाँ |
प्रतिक्रिया
लौटाता है: AggregateResponse
उदाहरण

getAuditLogs 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetAuditLogsOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetAuditLogsResponse
उदाहरण

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

blockFromCommentPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
लौटाता है: BlockSuccess
उदाहरण

unBlockCommentPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
लौटाता है: UnblockSuccess
उदाहरण

checkedCommentsForBlocked 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentIds | string | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
लौटाता है: CheckBlockedCommentsResponse
उदाहरण

blockUserFromComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| blockFromCommentParams | BlockFromCommentParams | हाँ | |
| options | const BlockUserFromCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: BlockSuccess
उदाहरण

createCommentPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| urlId | string | हाँ | |
| broadcastId | string | हाँ | |
| commentData | CommentData | हाँ | |
| options | const CreateCommentPublicOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: SaveCommentsResponseWithPresence
उदाहरण

deleteComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| options | const DeleteCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: DeleteCommentResult
उदाहरण

deleteCommentPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| broadcastId | string | हाँ | |
| options | const DeleteCommentPublicOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: PublicAPIDeleteCommentResponse
उदाहरण

deleteCommentVote 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| voteId | string | हाँ | |
| urlId | string | हाँ | |
| broadcastId | string | हाँ | |
| options | const DeleteCommentVoteOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: VoteDeleteResponse
उदाहरण

flagComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| options | const FlagCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: FlagCommentResponse
उदाहरण

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

getComments 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetCommentsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIGetCommentsResponse
उदाहरण

getCommentsPublic 
req tenantId urlId
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| urlId | string | हाँ | |
| options | const GetCommentsPublicOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetCommentsResponseWithPresence_PublicComment_
उदाहरण

getCommentText 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const GetCommentTextOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: PublicAPIGetCommentTextResponse
उदाहरण

getCommentVoteUserNames 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| dir | int32_t | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
लौटाता है: GetCommentVoteUserNamesSuccessResponse
उदाहरण

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

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

saveComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createCommentParams | CreateCommentParams | हाँ | |
| options | const SaveCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: APISaveCommentResponse
उदाहरण

setCommentText 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| broadcastId | string | हाँ | |
| commentTextUpdateRequest | CommentTextUpdateRequest | हाँ | |
| options | const SetCommentTextOptions& | हाँ |
प्रतिक्रिया
लौटाता है: PublicAPISetCommentTextResponse
उदाहरण

unBlockUserFromComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| unBlockFromCommentParams | UnBlockFromCommentParams | हाँ | |
| options | const UnBlockUserFromCommentOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: UnblockSuccess
उदाहरण

unFlagComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| options | const UnFlagCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: FlagCommentResponse
उदाहरण

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

unPinComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| broadcastId | string | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
लौटाता है: ChangeCommentPinStatusResponse
उदाहरण

updateComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updatableCommentParams | UpdatableCommentParams | हाँ | |
| options | const UpdateCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

voteComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| urlId | string | हाँ | |
| broadcastId | string | हाँ | |
| voteBodyParams | VoteBodyParams | हाँ | |
| options | const VoteCommentOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: VoteResponse
उदाहरण

getCommentsForUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| options | const GetCommentsForUserOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetCommentsForUserResponse
उदाहरण

addDomainConfig 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| addDomainConfigParams | AddDomainConfigParams | हाँ |
प्रतिक्रिया
रिटर्न करता है: AddDomainConfigResponse
उदाहरण

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

getDomainConfig 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| domain | string | हाँ |
प्रतिक्रिया
लौटाता है: GetDomainConfigResponse
उदाहरण

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

patchDomainConfig 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| domainToUpdate | string | हाँ | |
| patchDomainConfigParams | PatchDomainConfigParams | हाँ |
प्रतिक्रिया
लौटाता है: PatchDomainConfigResponse
उदाहरण

putDomainConfig 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| domainToUpdate | string | हाँ | |
| updateDomainConfigParams | UpdateDomainConfigParams | हाँ |
प्रतिक्रिया
लौटाता है: PutDomainConfigResponse
उदाहरण

createEmailTemplate 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createEmailTemplateBody | CreateEmailTemplateBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateEmailTemplateResponse
उदाहरण

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

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

getEmailTemplate 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ |
प्रतिक्रिया
लौटाता है: GetEmailTemplateResponse
उदाहरण

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

getEmailTemplateRenderErrors 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| skip | double | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetEmailTemplateRenderErrorsResponse
उदाहरण

getEmailTemplates 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| skip | double | नहीं |
प्रतिक्रिया
लौटाता है: GetEmailTemplatesResponse
उदाहरण

renderEmailTemplate 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| renderEmailTemplateBody | RenderEmailTemplateBody | हाँ | |
| locale | string | नहीं |
प्रतिक्रिया
लौटाता है: RenderEmailTemplateResponse
उदाहरण

updateEmailTemplate 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

getEventLog 
req tenantId urlId userIdWS
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| urlId | string | हाँ | |
| userIdWS | string | हाँ | |
| startTime | int64_t | हाँ | |
| endTime | int64_t | नहीं |
प्रतिक्रिया
लौटाता है: GetEventLogResponse
उदाहरण

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

createFeedPost 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createFeedPostParams | CreateFeedPostParams | हाँ | |
| options | const CreateFeedPostOptions& | हाँ |
प्रतिक्रिया
लौटाता है: CreateFeedPostsResponse
उदाहरण

createFeedPostPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createFeedPostParams | CreateFeedPostParams | हाँ | |
| options | const CreateFeedPostPublicOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateFeedPostResponse
उदाहरण

deleteFeedPostPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| postId | string | हाँ | |
| options | const DeleteFeedPostPublicOptions& | हाँ |
प्रतिक्रिया
लौटाता है: DeleteFeedPostPublicResponse
उदाहरण

getFeedPosts 
req tenantId afterId
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetFeedPostsOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetFeedPostsResponse
उदाहरण

getFeedPostsPublic 
req tenantId afterId
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetFeedPostsPublicOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: PublicFeedPostsResponse
उदाहरण

getFeedPostsStats 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| postIds | vector<string | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
लौटाता है: FeedPostsStatsResponse
उदाहरण

getUserReactsPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetUserReactsPublicOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: UserReactsResponse
उदाहरण

reactFeedPostPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| postId | string | हाँ | |
| reactBodyParams | ReactBodyParams | हाँ | |
| options | const ReactFeedPostPublicOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: ReactFeedPostResponse
उदाहरण

updateFeedPost 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| feedPost | FeedPost | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

updateFeedPostPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| postId | string | हाँ | |
| updateFeedPostParams | UpdateFeedPostParams | हाँ | |
| options | const UpdateFeedPostPublicOptions& | हाँ |
प्रतिक्रिया
लौटाता है: CreateFeedPostResponse
उदाहरण

flagCommentPublic 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| isFlagged | bool | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

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

getGifsSearch 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| search | string | हाँ | |
| options | const GetGifsSearchOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetGifsSearchResponse
उदाहरण

getGifsTrending 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetGifsTrendingOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetGifsTrendingResponse
उदाहरण

addHashTag 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createHashTagBody | CreateHashTagBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateHashTagResponse
उदाहरण

addHashTagsBulk 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: BulkCreateHashTagsResponse
उदाहरण

deleteHashTag 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| tag | string | हाँ | |
| deleteHashTagRequestBody | DeleteHashTagRequestBody | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

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

patchHashTag 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| tag | string | हाँ | |
| updateHashTagBody | UpdateHashTagBody | हाँ |
प्रतिक्रिया
लौटाता है: UpdateHashTagResponse
उदाहरण

deleteModerationVote 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| voteId | string | हाँ | |
| options | const DeleteModerationVoteOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: VoteDeleteResponse
उदाहरण

getApiComments 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetApiCommentsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: ModerationAPIGetCommentsResponse
उदाहरण

getApiExportStatus 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetApiExportStatusOptions& | हाँ |
प्रतिक्रिया
लौटाता है: ModerationExportStatusResponse
उदाहरण

getApiIds 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetApiIdsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: ModerationAPIGetCommentIdsResponse
उदाहरण

getBanUsersFromComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
लौटाता है: GetBannedUsersFromCommentResponse
उदाहरण

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

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

getCount 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetCountOptions& | हाँ |
प्रतिक्रिया
लौटाता है: ModerationAPICountCommentsResponse
उदाहरण

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

getLogs 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
लौटाता है: ModerationAPIGetLogsResponse
उदाहरण

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

getManualBadgesForUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetManualBadgesForUserOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetUserManualBadgesResponse
उदाहरण

getModerationComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const GetModerationCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: ModerationAPICommentResponse
उदाहरण

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

getPreBanSummary 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const GetPreBanSummaryOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: PreBanSummary
उदाहरण

getSearchCommentsSummary 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetSearchCommentsSummaryOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: ModerationCommentSearchResponse
उदाहरण

getSearchPages 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetSearchPagesOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: ModerationPageSearchResponse
उदाहरण

getSearchSites 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetSearchSitesOptions& | हाँ |
प्रतिक्रिया
लौटाता है: ModerationSiteSearchResponse
उदाहरण

getSearchSuggest 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetSearchSuggestOptions& | हाँ |
प्रतिक्रिया
लौटाता है: ModerationSuggestResponse
उदाहरण

getSearchUsers 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetSearchUsersOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: ModerationUserSearchResponse
उदाहरण

getTrustFactor 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetTrustFactorOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetUserTrustFactorResponse
उदाहरण

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

getUserInternalProfile 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetUserInternalProfileOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetUserInternalProfileResponse
उदाहरण

postAdjustCommentVotes 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| adjustCommentVotesParams | AdjustCommentVotesParams | हाँ | |
| options | const PostAdjustCommentVotesOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: AdjustVotesResponse
उदाहरण

postApiExport 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const PostApiExportOptions& | हाँ |
प्रतिक्रिया
लौटाता है: ModerationExportResponse
उदाहरण

postBanUserFromComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const PostBanUserFromCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: BanUserFromCommentResult
उदाहरण

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

postBulkPreBanSummary 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| bulkPreBanParams | BulkPreBanParams | हाँ | |
| options | const PostBulkPreBanSummaryOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: BulkPreBanSummary
उदाहरण

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

postFlagComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const PostFlagCommentOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

postRemoveComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const PostRemoveCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: PostRemoveCommentApiResponse
उदाहरण

postRestoreDeletedComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const PostRestoreDeletedCommentOptions& | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

postSetCommentApprovalStatus 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const PostSetCommentApprovalStatusOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: SetCommentApprovedResponse
उदाहरण

postSetCommentReviewStatus 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const PostSetCommentReviewStatusOptions& | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

postSetCommentSpamStatus 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const PostSetCommentSpamStatusOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

postSetCommentText 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| setCommentTextParams | SetCommentTextParams | हाँ | |
| options | const PostSetCommentTextOptions& | हाँ |
प्रतिक्रिया
लौटाता है: SetCommentTextResponse
उदाहरण

postUnFlagComment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const PostUnFlagCommentOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

postVote 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| options | const PostVoteOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: VoteResponse
उदाहरण

putAwardBadge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| badgeId | string | हाँ | |
| options | const PutAwardBadgeOptions& | हाँ |
प्रतिक्रिया
लौटाता है: AwardUserBadgeResponse
उदाहरण

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

putRemoveBadge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| badgeId | string | हाँ | |
| options | const PutRemoveBadgeOptions& | हाँ |
प्रतिक्रिया
लौटाता है: RemoveUserBadgeResponse
उदाहरण

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

setTrustFactor 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const SetTrustFactorOptions& | हाँ |
प्रतिक्रिया
लौटाता है: SetUserTrustFactorResponse
उदाहरण

createModerator 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createModeratorBody | CreateModeratorBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateModeratorResponse
उदाहरण

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

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

getModerators 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| skip | double | नहीं |
प्रतिक्रिया
लौटाता है: GetModeratorsResponse
उदाहरण

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

updateModerator 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateModeratorBody | UpdateModeratorBody | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

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

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

getNotificationCount 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetNotificationCountOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetNotificationCountResponse
उदाहरण

getNotifications 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetNotificationsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetNotificationsResponse
उदाहरण

updateNotification 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateNotificationBody | UpdateNotificationBody | हाँ | |
| userId | string | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

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

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

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

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

getV1PageLikes 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| urlId | string | हाँ |
प्रतिक्रिया
लौटाता है: GetV1PageLikes
उदाहरण

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

getV2PageReactUsers 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| urlId | string | हाँ | |
| id | string | हाँ |
प्रतिक्रिया
लौटाता है: GetV2PageReactUsersResponse
उदाहरण

addPage 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createAPIPageData | CreateAPIPageData | हाँ |
प्रतिक्रिया
रिटर्न करता है: AddPageAPIResponse
उदाहरण

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

getOfflineUsers 
पेज पर उन पिछले टिप्पणीकारों को जो अभी ऑनलाइन नहीं हैं। displayName के अनुसार क्रमबद्ध। "Members" सेक्शन रेंडर करने के लिए /users/online को पूरा करने के बाद इसका उपयोग करें। commenterName पर कर्सर पेजिनेशन: सर्वर afterName से आगे $gt के माध्यम से आंशिक {tenantId, urlId, commenterName} इंडेक्स को ट्रैवर्स करता है, बिना $skip लागत के।
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| urlId | string | हाँ | |
| options | const GetOfflineUsersOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: PageUsersOfflineResponse
उदाहरण

getOnlineUsers 
किसी पेज के वर्तमान में ऑनलाइन दर्शक: वे लोग जिनका websocket सत्र इस समय पेज के लिए सब्सक्राइब है। anonCount + totalCount लौटाता है (पूरे रूम के सब्सक्राइबर, जिनमें वे अनाम दर्शक भी शामिल हैं जिन्हें हम एन्यूमरेट नहीं करते)।
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| urlId | string | हाँ | |
| options | const GetOnlineUsersOptions& | हाँ |
प्रतिक्रिया
लौटाता है: PageUsersOnlineResponse
उदाहरण

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

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

getPagesPublic 
किसी टेनेंट के लिए पेजों की सूची लौटाता है। FChat डेस्कटॉप क्लाइंट द्वारा अपनी रूम सूची भरने के लिए उपयोग किया जाता है।
प्रत्येक पेज के लिए रिज़ॉल्व किए गए कस्टम कॉन्फ़िग पर enableFChat true होना आवश्यक है।
SSO की आवश्यकता वाले पेजों को अनुरोध करने वाले उपयोगकर्ता के ग्रुप एक्सेस के आधार पर फ़िल्टर किया जाता है।
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetPagesPublicOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetPublicPagesResponse
उदाहरण

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

patchPage 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateAPIPageData | UpdateAPIPageData | हाँ |
प्रतिक्रिया
रिटर्न करता है: PatchPageAPIResponse
उदाहरण

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

getPendingWebhookEventCount 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetPendingWebhookEventCountOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetPendingWebhookEventCountResponse
उदाहरण

getPendingWebhookEvents 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetPendingWebhookEventsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetPendingWebhookEventsResponse
उदाहरण

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

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

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

getQuestionConfigs 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| skip | double | नहीं |
प्रतिक्रिया
लौटाता है: GetQuestionConfigsResponse
उदाहरण

updateQuestionConfig 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

createQuestionResult 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createQuestionResultBody | CreateQuestionResultBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateQuestionResultResponse
उदाहरण

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

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

getQuestionResults 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetQuestionResultsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetQuestionResultsResponse
उदाहरण

updateQuestionResult 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateQuestionResultBody | UpdateQuestionResultBody | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

aggregateQuestionResults 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const AggregateQuestionResultsOptions& | हाँ |
प्रतिक्रिया
लौटाता है: AggregateQuestionResultsResponse
उदाहरण

bulkAggregateQuestionResults 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | हाँ | |
| forceRecalculate | bool | नहीं |
प्रतिक्रिया
लौटाता है: BulkAggregateQuestionResultsResponse
उदाहरण

combineCommentsWithQuestionResults 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const CombineCommentsWithQuestionResultsOptions& | हाँ |
प्रतिक्रिया
लौटाता है: CombineQuestionResultsWithCommentsResponse
उदाहरण

addSSOUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createAPISSOUserData | CreateAPISSOUserData | हाँ |
प्रतिक्रिया
लौटाता है: AddSSOUserAPIResponse
उदाहरण

deleteSSOUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| options | const DeleteSSOUserOptions& | हाँ |
प्रतिक्रिया
लौटाता है: DeleteSSOUserAPIResponse
उदाहरण

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

getSSOUserById 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ |
प्रतिक्रिया
लौटाता है: GetSSOUserByIdAPIResponse
उदाहरण

getSSOUsers 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| skip | int32_t | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetSSOUsersResponse
उदाहरण

patchSSOUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateAPISSOUserData | UpdateAPISSOUserData | हाँ | |
| updateComments | bool | नहीं |
प्रतिक्रिया
लौटाता है: PatchSSOUserAPIResponse
उदाहरण

putSSOUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateAPISSOUserData | UpdateAPISSOUserData | हाँ | |
| updateComments | bool | नहीं |
प्रतिक्रिया
लौटाता है: PutSSOUserAPIResponse
उदाहरण

createSubscription 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateSubscriptionAPIResponse
उदाहरण

deleteSubscription 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| userId | string | नहीं |
प्रतिक्रिया
लौटाता है: DeleteSubscriptionAPIResponse
उदाहरण

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

updateSubscription 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateAPIUserSubscriptionData | UpdateAPIUserSubscriptionData | हाँ | |
| userId | string | नहीं |
प्रतिक्रिया
रिटर्न करता है: UpdateSubscriptionAPIResponse
उदाहरण

getTenantDailyUsages 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetTenantDailyUsagesOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetTenantDailyUsagesResponse
उदाहरण

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

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

getTenantPackage 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetTenantPackageResponse
उदाहरण

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

replaceTenantPackage 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

updateTenantPackage 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateTenantPackageBody | UpdateTenantPackageBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

createTenantUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createTenantUserBody | CreateTenantUserBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateTenantUserResponse
उदाहरण

deleteTenantUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| options | const DeleteTenantUserOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

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

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

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

sendLoginLink 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| redirectURL | string | नहीं |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

updateTenantUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateTenantUserBody | UpdateTenantUserBody | हाँ | |
| updateComments | string | नहीं |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

createTenant 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createTenantBody | CreateTenantBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateTenantResponse
उदाहरण

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

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

getTenants 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetTenantsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetTenantsResponse
उदाहरण

updateTenant 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateTenantBody | UpdateTenantBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptyResponse
उदाहरण

changeTicketState 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| userId | string | हाँ | |
| id | string | हाँ | |
| changeTicketStateBody | ChangeTicketStateBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: ChangeTicketStateResponse
उदाहरण

createTicket 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| userId | string | हाँ | |
| createTicketBody | CreateTicketBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateTicketResponse
उदाहरण

getTicket 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| userId | string | नहीं |
प्रतिक्रिया
लौटाता है: GetTicketResponse
उदाहरण

getTickets 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetTicketsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetTicketsResponse
उदाहरण

getTranslations 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| r_namespace | string | हाँ | |
| component | string | हाँ | |
| options | const GetTranslationsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetTranslationsResponse
उदाहरण

uploadImage 
एक इमेज अपलोड और रिसाइज़ करें
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| file | HttpContent | हाँ | |
| options | const UploadImageOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: UploadImageResponse
उदाहरण

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

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

getUserBadgeProgressList 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetUserBadgeProgressListOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIGetUserBadgeProgressListResponse
उदाहरण

createUserBadge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| createUserBadgeParams | CreateUserBadgeParams | हाँ |
प्रतिक्रिया
लौटाता है: APICreateUserBadgeResponse
उदाहरण

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

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

getUserBadges 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetUserBadgesOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIGetUserBadgesResponse
उदाहरण

updateUserBadge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ | |
| updateUserBadgeParams | UpdateUserBadgeParams | हाँ |
प्रतिक्रिया
रिटर्न करता है: APIEmptySuccessResponse
उदाहरण

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

getUserNotifications 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const GetUserNotificationsOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetMyNotificationsResponse
उदाहरण

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

resetUserNotifications 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| options | const ResetUserNotificationsOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: ResetUserNotificationsResponse
उदाहरण

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

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

updateUserNotificationStatus 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| notificationId | string | हाँ | |
| newStatus | string | हाँ | |
| sso | string | नहीं |
प्रतिक्रिया
लौटाता है: UpdateUserNotificationStatusResponse
उदाहरण

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

searchUsers 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| urlId | string | हाँ | |
| options | const SearchUsersOptions& | हाँ |
प्रतिक्रिया
लौटाता है: SearchUsersResult
उदाहरण

getUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| id | string | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetUserResponse
उदाहरण

createVote 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| commentId | string | हाँ | |
| direction | string | हाँ | |
| options | const CreateVoteOptions& | हाँ |
प्रतिक्रिया
रिटर्न करता है: VoteResponse
उदाहरण

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

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

getVotesForUser 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenantId | string | हाँ | |
| urlId | string | हाँ | |
| options | const GetVotesForUserOptions& | हाँ |
प्रतिक्रिया
लौटाता है: GetVotesForUserResponse
उदाहरण

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