
भाषा 🇮🇳 हिन्दी
दस्तावेज़ीकरण
शुरुआत करें
API संदर्भ
प्रमाणीकरण
एग्रीगेट
ऑडिट लॉग्स
कमेंट से ब्लॉक करें
ब्लॉक किए गए कमेंट जांचें
कमेंट्स
उपयोगकर्ता के लिए कमेंट्स
डोमेन कॉन्फ़िग
ईमेल टेम्पलेट्स
इवेंट लॉग
फ़ीड पोस्ट्स
कमेंट फ़्लैग करें
Gifs
हैश टैग
मॉडरेशन
मॉडरेटर्स
नोटिफिकेशन संख्या
नोटिफिकेशन
पेज रिएक्ट्स
पेजेस
लंबित वेबहुक इवेंट्स
प्रश्न कॉन्फ़िग
प्रश्न परिणाम
प्रश्न परिणाम एग्रीगेशन
SSO उपयोगकर्ता
सब्सक्रिप्शन
टेनेंट दैनिक उपयोग
टेनेंट पैकेज
टेनेंट उपयोगकर्ता
टेनेंट
टिकट
अनुवाद
इमेज अपलोड करें
उपयोगकर्ता बैज प्रगति
उपयोगकर्ता बैज
उपयोगकर्ता नोटिफिकेशन
उपयोगकर्ता उपस्थिति स्थिति
उपयोगकर्ता खोज
उपयोगकर्ता
वोट
FastComments PHP SDK
यह FastComments का आधिकारिक PHP SDK है।
अपने PHP एप्लिकेशन से कमेंट्स, यूज़र्स, SSO और मॉडरेशन प्रबंधित करें।
रिपॉज़िटरी
AI कोडिंग एजेंट 
अपने कोडिंग एजेंट को FastComments का वह संदर्भ दें जिसकी उसे आवश्यकता है - विजेट्स, कॉन्फ़िगरेशन, Secure SSO, REST API, और SDKs:
npx skills add fastcomments/skills
यह Claude Code, Codex, Cursor, Copilot, Gemini, और skills CLI द्वारा समर्थित हर अन्य एजेंट के साथ काम करता है।
इंस्टॉलेशन और उपयोग 
आवश्यकताएँ
PHP 7.4 और बाद के संस्करण। PHP 8.0 के साथ भी काम करना चाहिए।
Composer
Composer के माध्यम से बाइंडिंग्स इंस्टॉल करने के लिए, composer.json में निम्नलिखित जोड़ें:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}
फिर composer install चलाएँ
मैनुअल इंस्टॉलेशन
फ़ाइलें डाउनलोड करें और autoload.php शामिल करें:
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');
शुरुआत करें 
कृपया इंस्टॉलेशन प्रक्रिया का पालन करें और फिर निम्नलिखित चलाएँ:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// API की अधिकृति (api_key) कॉन्फ़िगर करें
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// यदि आवश्यक हो तो API की के लिए प्रीफिक्स (जैसे Bearer) सेटअप करने के लिए नीचे की लाइन अनकमेंट करें
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
// यदि आप कस्टम http क्लाइंट का उपयोग करना चाहते हैं, तो अपना क्लाइंट पास करें जो `GuzzleHttp\ClientInterface` को इम्प्लीमेंट करता है।
// यह वैकल्पिक है, डिफ़ॉल्ट रूप से `GuzzleHttp\Client` का उपयोग किया जाएगा।
new GuzzleHttp\Client(),
$config
);
$tenant_id = 'tenant_id_example'; // string
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
try {
$result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}
API क्लाइंट 
SDK तीन API क्लाइंट क्लासेस उपलब्ध कराता है:
DefaultApi- सर्वर-साइड उपयोग के लिए API-की-प्रमाणित मेथड्स। API की को Getting Started में दिखाए अनुसार कॉन्फ़िगर करें।PublicApi- सार्वजनिक मेथड्स जिन्हें API की की आवश्यकता नहीं है, जो ब्राउज़रों और मोबाइल ऐप्स से कॉल करने के लिए सुरक्षित हैं।ModerationApi- लाइव और तेज़ मॉडरेशन API का एक व्यापक सूट। प्रत्येकModerationApiमेथड एक$ssoपैरामीटर स्वीकार करता है और SSO या FastComments.com सेशन कुकी के माध्यम से प्रमाणित हो सकता है।
PublicApi का उपयोग करना
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Public methods do not require an API key.
$apiInstance = new FastComments\Client\Api\PublicApi(
new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
$result = $apiInstance->getCommentsPublic($tenant_id, $url_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}
ModerationApi का उपयोग करना
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
new GuzzleHttp\Client()
);
$sso = 'sso_example'; // string - मॉडरेटर को प्रमाणित करने वाला SSO पेलोड
try {
$result = $apiInstance->getCount([
'sso' => $sso,
]);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}
API मेथड्स 
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 | |
| 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 | |
| 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/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/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} | |
| PublicApi | getEventLog | GET /event-log/{tenantId} | |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | |
| 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} | |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | |
| 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 | |
| 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} | |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
मॉडल्स 
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBaseMeta
- 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
- AddDomainConfigResponseAnyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchMatchedOnValue
- BannedUserMatchType
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBodyTagsInner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponseResultsInner
- 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
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentResponse
- GetAuditLogsResponse
- GetBannedUsersCountResponse
- GetBannedUsersFromCommentResponse
- GetCachedNotificationCountResponse
- GetCommentBanStatusResponse
- GetCommentTextResponse
- GetCommentVoteUserNamesSuccessResponse
- GetCommentsForUserResponse
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfigResponse
- GetDomainConfigsResponse
- GetDomainConfigsResponseAnyOf
- GetDomainConfigsResponseAnyOf1
- 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
- GetUserInternalProfileResponseProfile
- GetUserManualBadgesResponse
- GetUserNotificationCountResponse
- GetUserPresenceStatusesResponse
- GetUserResponse
- GetUserTrustFactorResponse
- GetV1PageLikes
- GetV2PageReactUsersResponse
- GetV2PageReacts
- GetVotesForUserResponse
- GetVotesResponse
- GifGetLargeResponse
- GifRating
- GifSearchInternalError
- GifSearchResponse
- GifSearchResponseImagesInnerInner
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAgentApprovalNotificationFrequency
- ImportedSiteType
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- 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
- PostRemoveCommentResponse
- PreBanSummary
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicPage
- PublicVote
- PutDomainConfigResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionConfig
- QuestionConfigCustomOptionsInner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RemoveCommentActionResponse
- RemoveUserBadgeResponse
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotificationsResponse
- SORTDIR
- 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
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
प्राधिकरण 
API के लिए परिभाषित प्रमाणीकरण योजनाएँ:
api_key
- प्रकार: API key
- API key पैरामीटर नाम: x-api-key
- स्थान: HTTP header
aggregate 
दस्तावेज़ों को समूहित करके (यदि groupBy दिया गया है) और कई ऑपरेशन लागू करके एकत्रित करता है। विभिन्न ऑपरेशन (जैसे sum, countDistinct, avg, आदि) समर्थित हैं।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| parentTenantId | string | query | नहीं | |
| includeStats | boolean | query | नहीं |
प्रतिक्रिया
लौटाता है: AggregateResponse
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

getComments 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| 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
उदाहरण

getCommentsPublic 
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
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getFeedPostsPublic 
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
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getApiComments 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| 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
उदाहरण

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

getApiIds 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| 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
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

postBanUserFromComment 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| 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
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getOfflineUsers 
पेज पर पिछले टिप्पणीकार जो अभी ऑनलाइन नहीं हैं। 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
उदाहरण

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

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

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

getPagesPublic 
किसी टेनेंट के लिए पेजों की सूची लौटाता है। FChat डेस्कटॉप क्लाइंट द्वारा अपनी रूम सूची भरने के लिए उपयोग किया जाता है।
प्रत्येक पेज के रिज़ॉल्व किए गए कस्टम कॉन्फ़िग पर enableFChat true होना आवश्यक है।
जो पेज SSO की मांग करते हैं, उन्हें अनुरोध करने वाले उपयोगकर्ता के ग्रुप एक्सेस के आधार पर फ़िल्टर किया जाता है।
पैरामीटर्स
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| 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
उदाहरण

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

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

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

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

getPendingWebhookEvents 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| 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
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

combineCommentsWithQuestionResults 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| 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
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getUserNotifications 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| 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
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

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