
भाषा 🇮🇳 हिन्दी
दस्तावेज़ीकरण
शुरुआत करें
API संदर्भ
एजेंट टेनेंट
एग्रीगेट
ऑडिट लॉग
प्रमाणीकरण
बैच जॉब
कमेंट से ब्लॉक
ब्लॉक किए गए कमेंट जाँचें
कमेंट
उपयोगकर्ता के लिए कमेंट
डोमेन कॉन्फ़िग
ईमेल टेम्पलेट
इवेंट लॉग
फ़ीड पोस्ट
कमेंट फ़्लैग करें
GIF
हैश टैग
मैं
मॉडरेशन
मॉडरेटर
नोटिफिकेशन संख्या
नोटिफिकेशन
पेज रिएक्ट
पेज
लंबित वेबहुक इवेंट
पोल वोट
पोल
प्रश्न कॉन्फ़िग
प्रश्न परिणाम
प्रश्न परिणाम एग्रीगेशन
SSO उपयोगकर्ता
सदस्यताएँ
टेनेंट दैनिक उपयोग
टेनेंट पैकेज
टेनेंट उपयोगकर्ता
टेनेंट
टिकट
अनुवाद
इमेज अपलोड करें
उपयोगकर्ता बैज प्रगति
उपयोगकर्ता बैज
उपयोगकर्ता नोटिफिकेशन
उपयोगकर्ता उपस्थिति स्थिति
उपयोगकर्ता खोज
उपयोगकर्ता
वोट
वेबहुक
FastComments Swift SDK
यह FastComments का आधिकारिक Swift SDK है।
अपने Swift एप्लिकेशन से कमेंट्स, यूज़र्स, SSO और मॉडरेशन को प्रबंधित करें।
रिपॉज़िटरी
AI कोडिंग एजेंट 
अपने कोडिंग एजेंट को FastComments का वह संदर्भ दें जिसकी उसे आवश्यकता है - विजेट्स, कॉन्फ़िगरेशन, Secure SSO, REST API, और SDKs:
npx skills add fastcomments/skills
यह Claude Code, Codex, Cursor, Copilot, Gemini, और skills CLI द्वारा समर्थित हर अन्य एजेंट के साथ काम करता है।
इंस्टॉलेशन 
Swift Package Manager
अपनी Package.swift फ़ाइल में निम्नलिखित जोड़ें:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
या Xcode में:
- File > Add Packages...
- रिपॉज़िटरी URL दर्ज करें:
https://github.com/fastcomments/fastcomments-swift.git - वह संस्करण चुनें जिसे आप उपयोग करना चाहते हैं
आवश्यकताएँ
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
लाइब्रेरी सामग्री 
FastComments Swift SDK कई मॉड्यूल्स से मिलकर बना है:
-
Client Module - FastComments REST APIs के लिए API क्लाइंट
- सभी API मॉडल्स के लिए संपूर्ण टाइप परिभाषाएँ
- प्रमाणित (
DefaultAPI), सार्वजनिक (PublicAPI), और मॉडरेशन (ModerationAPI) मेथड्स - पूर्ण async/await समर्थन
- विस्तृत API दस्तावेज़ीकरण के लिए client/README.md देखें
-
SSO Module - सर्वर-साइड Single Sign-On यूटिलिटीज़
- उपयोगकर्ता प्रमाणीकरण के लिए सुरक्षित टोकन जनरेशन
- सरल और सुरक्षित दोनों SSO मोड्स के लिए समर्थन
- CryptoKit का उपयोग करके HMAC-SHA256 आधारित टोकन साइनिंग
क्विक स्टार्ट 
पब्लिक API का उपयोग करना
import FastCommentsSwift
// किसी पेज के लिए कमेंट्स प्राप्त करें
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
ऑथेंटिकेटेड API का उपयोग करना
import FastCommentsSwift
// शेयर्ड कॉन्फ़िगरेशन पर अपनी API key कॉन्फ़िगर करें (x-api-key हेडर के रूप में भेजी जाती है)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// ऑथेंटिकेटेड API का उपयोग करके कमेंट्स प्राप्त करें
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
मॉडरेशन API का उपयोग करना
import FastCommentsSwift
// मॉडरेशन मेथड्स को कार्यरत मॉडरेटर के लिए `sso` टोकन से अधिकृत किया जाता है
// (इसे FastCommentsSSO से जनरेट करें, ऊपर SSO सेक्शन देखें)।
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
ऑथेंटिकेशन के लिए SSO का उपयोग करना
सिक्योर SSO (प्रोडक्शन के लिए अनुशंसित)
import FastCommentsSwift
let apiKey = "your-api-key"
// सिक्योर SSO यूज़र डेटा बनाएं (केवल सर्वर-साइड!)
let userData = SecureSSOUserData(
id: "user-123", // यूज़र ID
email: "user@example.com", // ईमेल
username: "johndoe", // यूज़रनेम
avatar: "https://example.com/avatar.jpg" // अवतार URL
)
// SSO टोकन जनरेट करें
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// ऑथेंटिकेशन के लिए यह टोकन अपने फ्रंटएंड को पास करें
} catch {
print("Error creating SSO token: \(error)")
}
सिंपल SSO (डेवलपमेंट/टेस्टिंग के लिए)
import FastCommentsSwift
// सिंपल SSO यूज़र डेटा बनाएं (API key की आवश्यकता नहीं)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// सिंपल SSO टोकन जनरेट करें
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
API क्लाइंट 
FastComments SDK तीन API क्लाइंट प्रदान करता है:
PublicAPI - क्लाइंट-सुरक्षित मेथड्स
PublicAPI में ऐसे मेथड्स शामिल हैं जिन्हें क्लाइंट-साइड कोड (iOS/macOS ऐप्स) से कॉल करना सुरक्षित है। ये मेथड्स:
- API की की आवश्यकता नहीं रखते
- प्रमाणीकरण के लिए SSO टोकन का उपयोग कर सकते हैं
- प्रति उपयोगकर्ता/डिवाइस रेट-लिमिटेड होते हैं
- अंतिम उपयोगकर्ता-केंद्रित एप्लिकेशन के लिए उपयुक्त होते हैं
उदाहरण उपयोग का मामला: अपने iOS ऐप में कमेंट्स प्राप्त करना और बनाना
DefaultAPI - सर्वर-साइड मेथड्स
DefaultAPI में प्रमाणित मेथड्स शामिल हैं जिन्हें API की की आवश्यकता होती है। ये मेथड्स:
- आपकी FastComments API की की आवश्यकता रखते हैं
- केवल सर्वर-साइड कोड से ही कॉल किए जाने चाहिए
- आपके FastComments डेटा तक पूर्ण पहुँच प्रदान करते हैं
- प्रति टेनेंट रेट-लिमिटेड होते हैं
उदाहरण उपयोग का मामला: प्रशासनिक कार्य, बल्क डेटा एक्सपोर्ट, उपयोगकर्ता प्रबंधन
ModerationAPI - मॉडरेटर डैशबोर्ड मेथड्स
ModerationAPI लाइव और तेज़ मॉडरेशन APIs का एक विस्तृत सूट प्रदान करता है। हर ModerationAPI मेथड एक sso पैरामीटर स्वीकार करता है और SSO या FastComments.com सेशन कुकी के माध्यम से प्रमाणित हो सकता है।
उदाहरण उपयोग का मामला: अपने समुदाय के मॉडरेटर्स के लिए एक मॉडरेशन अनुभव बनाना
महत्वपूर्ण: कभी भी अपनी API की को क्लाइंट-साइड कोड में एक्सपोज़ न करें। API कीज़ का उपयोग केवल सर्वर-साइड पर ही किया जाना चाहिए।
API कॉल करना 
Swift SDK सभी API कॉल के लिए आधुनिक async/await सिंटैक्स का उपयोग करता है:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
सामान्य समस्याएँ 
401 अनधिकृत त्रुटियाँ
यदि आपको प्रमाणित API का उपयोग करते समय 401 त्रुटियाँ मिल रही हैं:
- अपनी API कुंजी जाँचें: सुनिश्चित करें कि आप अपने FastComments डैशबोर्ड से सही API कुंजी का उपयोग कर रहे हैं
- टेनेंट ID सत्यापित करें: सुनिश्चित करें कि टेनेंट ID आपके खाते से मेल खाती है
- API कुंजी प्रारूप: API कुंजी को साझा कॉन्फ़िगरेशन पर
x-api-keyहेडर के रूप में सेट किया जाना चाहिए:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- गलत API का उपयोग: प्रमाणित कॉल के लिए सुनिश्चित करें कि आप
DefaultAPI(न किPublicAPI) का उपयोग कर रहे हैं
SSO टोकन समस्याएँ
यदि SSO टोकन काम नहीं कर रहे हैं:
- प्रोडक्शन के लिए सुरक्षित मोड का उपयोग करें: प्रोडक्शन के लिए हमेशा अपनी API कुंजी के साथ
FastCommentsSSO.createSecure()का उपयोग करें - केवल सर्वर-साइड: अपने सर्वर पर सुरक्षित SSO टोकन जनरेट करें, अपनी API कुंजी कभी क्लाइंट्स को न दिखाएँ
- उपयोगकर्ता डेटा जाँचें: सुनिश्चित करें कि सभी आवश्यक फ़ील्ड (id, email, username) प्रदान की गई हैं
- टोकन समाप्ति: सुरक्षित SSO टोकन में टाइमस्टैम्प होता है और वे समाप्त हो सकते हैं। आवश्यकतानुसार नए टोकन जनरेट करें।
SSL/TLS त्रुटियाँ
यदि आप SSL/TLS त्रुटियों का सामना करते हैं:
- सुनिश्चित करें कि आपके ऐप की Info.plist fastcomments.com से HTTPS कनेक्शन की अनुमति देती है
- जाँचें कि आप ऐसे App Transport Security अपवादों का उपयोग नहीं कर रहे हैं जो कनेक्शन को अवरुद्ध कर सकते हैं
नोट्स 
ब्रॉडकास्ट IDs
आप देखेंगे कि कुछ API कॉल्स में broadcastId पास करना अपेक्षित है। जब आप इवेंट्स प्राप्त करते हैं, तो आपको यह ID वापस मिलेगी, ताकि यदि आप क्लाइंट पर बदलावों को optimistically लागू करने की योजना बनाते हैं (जो आप शायद करना चाहेंगे क्योंकि यह सबसे अच्छा अनुभव देता है), तो आप उस इवेंट को अनदेखा कर सकें। यहाँ एक UUID पास करें। यह ID इतनी अद्वितीय होनी चाहिए कि एक सेशन में दो बार न आए।
let broadcastId = UUID().uuidString
createAgentTenant 
बिना मानवीय साइनअप के AI एजेंट के लिए एक नया ट्रायल अकाउंट बनाता है। इसे कॉल करने के लिए किसी API key की आवश्यकता नहीं है।
रिस्पॉन्स में tenant id, एक API key शामिल है जो REST API और MCP server के विरुद्ध तुरंत काम करती है, और एक claim URL। Claim URL उस व्यक्ति को दें जिसके लिए आप काम कर रहे हैं: FastComments में लॉग इन होने के दौरान इसे खोलने पर अकाउंट उससे जुड़ जाता है। बिना claimed अकाउंट, और उनकी keys, बनाए जाने के 72 घंटे बाद डिलीट कर दिए जाते हैं। Claim होने तक, अकाउंट पर मानक ट्रायल सीमाएँ लागू रहती हैं।
Response
Returns: CreateAgentTenantResponse
Example

aggregate 
दस्तावेज़ों को समूहित करके (यदि groupBy दिया गया हो) और कई ऑपरेशन लागू करके एकत्रित करता है। विभिन्न ऑपरेशन (जैसे sum, countDistinct, avg, आदि) समर्थित हैं।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| parentTenantId | string | query | नहीं | |
| includeStats | boolean | query | नहीं |
प्रतिक्रिया
लौटाता है: AggregateResponse
उदाहरण

getAuditLogs 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | वह टेनेंट जिसके लिए ऑडिट लॉग पढ़ने हैं। |
| limit | integer | query | नहीं | कितने लॉग लौटाने हैं। अधिकतम 10000, डिफ़ॉल्ट 1000। |
| skip | integer | query | नहीं | पेजिंग के लिए कितने लॉग छोड़ने हैं। |
| order | string | query | नहीं | इवेंट समय पर सॉर्ट दिशा। डिफ़ॉल्ट DESC (नवीनतम पहले)। |
| after | integer | query | नहीं | |
| before | integer | query | नहीं | |
| username | string | query | नहीं | केवल इस यूज़रनेम द्वारा किए गए इवेंट लौटाएँ। |
| ip | string | query | नहीं | केवल इस IP पते से इवेंट लौटाएँ। |
| crudType | string | query | नहीं | केवल इस प्रकार के इवेंट लौटाएँ: c, r, u, d, या login। |
| resourceName | string | query | नहीं | केवल इस रिसोर्स के लिए इवेंट लौटाएँ, जैसे User या Moderator। |
| targetId | string | query | नहीं | केवल वे इवेंट लौटाएँ जिनकी प्रभावित वस्तु की यह id है। |
| target | string | query | नहीं | प्रभावित वस्तु के लेबल पर केस-असंवेदनशील सबस्ट्रिंग मैच, जैसे यूज़रनेम या ईमेल। |
| includeManagedTenants | boolean | query | नहीं | उन टेनेंट के इवेंट भी लौटाएँ जिन्हें यह टेनेंट प्रबंधित करता है। |
प्रतिक्रिया
लौटाता है: GetAuditLogsResponse
उदाहरण

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

getBatchJob 
एक बैच जॉब की स्थिति, प्रगति और, पूरा होने पर, परिणाम।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetBatchJobAPIResponse
उदाहरण

getBatchJobs 
टेनेंट की बैच जॉब्स (imports, exports, page migrations...), नवीनतम पहले।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| type | string | query | नहीं | केवल इस प्रकार की जॉब्स, उदाहरण के लिए migrate-pages। |
| status | string | query | नहीं | केवल इस स्थिति में जॉब्स: requested, running, success या failed। |
| skip | integer | query | नहीं | पेजिंग के लिए कितनी जॉब्स छोड़नी हैं। |
प्रतिक्रिया
रिटर्न करता है: GetBatchJobsAPIResponse
उदाहरण

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 | नहीं | |
| locale | 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 | नहीं | |
| questionId | string | query | नहीं | |
| questionValue | integer | 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
उदाहरण

translateComments 
दिए गए कमेंट्स को विजेट लोकेल में अनुवादित करता है। केवल तब उपलब्ध जब संबंधित विजेट कस्टमाइज़ेशन नियम में Comment Translation Automatic या Manual पर सेट हो।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| sso | string | query | नहीं | |
| locale | string | query | नहीं |
प्रतिक्रिया
रिटर्न: CommentTranslationsResponse
उदाहरण

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

getMe 
उपयोग में आने वाले क्रेडेंशियल की पहचान करता है: वह टेनेंट जिसका यह हिस्सा है और, OAuth टोकन के लिए, वह उपयोगकर्ता जिसने इसे अधिकृत किया। इंटीग्रेशन इसका उपयोग कनेक्शन का परीक्षण करने और उसे लेबल देने के लिए करते हैं।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
लौटाता है: GetMeResponse
उदाहरण

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 | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: CreateV1PageReact
उदाहरण

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

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

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

getV1PageLikes 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| sso | string | query | नहीं | |
| includeUserInfo | string | query | नहीं | सेट करने पर, पेज को लाइक करने वाले उपयोगकर्ताओं को लौटाता है (अवतार और उपयोगकर्ता नाम)। केवल "public" स्वीकार किया जाता है, जो निजी प्रोफ़ाइलों को छोड़ देता है। |
प्रतिक्रिया
लौटाता है: GetV1PageLikes
उदाहरण

getV2PageReacts 
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| urlId | string | query | हाँ | |
| sso | string | query | नहीं | |
| includeUserInfo | string | query | नहीं | सेट होने पर, प्रत्येक react id के लिए उपयोगकर्ताओं को लौटाता है (अवतार और उपयोगकर्ता नाम)। केवल "public" स्वीकार किया जाता है, जो निजी प्रोफाइल को छोड़ देता है। |
प्रतिक्रिया
लौटाता है: GetV2PageReacts
उदाहरण

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

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

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

getOfflineUsers 
पेज पर उन पिछले टिप्पणीकारों (commenters) की सूची जो इस समय ऑनलाइन नहीं हैं। displayName के अनुसार क्रमबद्ध। "Members" सेक्शन रेंडर करने के लिए /users/online को पूरा करने के बाद इसका उपयोग करें। commenterName पर कर्सर पेजिनेशन: सर्वर आंशिक {tenantId, urlId, commenterName} इंडेक्स को afterName से $gt के माध्यम से आगे बढ़ाता है, कोई $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
उदाहरण

getPageLikes 
किसी पेज के लाइक की संख्या, वैकल्पिक रूप से उन उपयोगकर्ताओं के साथ जिन्होंने इसे लाइक किया।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | हाँ | |
| includeUserInfo | string | query | नहीं | "public" निजी प्रोफ़ाइल वाले उपयोगकर्ताओं को छोड़ देता है, "include-private" उन्हें शामिल करता है। |
प्रतिक्रिया
रिटर्न करता है: GetPageLikesAPIResponse
उदाहरण

getPageReacts 
किसी पेज के लिए कस्टम रिएक्ट काउंट्स, वैकल्पिक रूप से रिएक्ट करने वाले उपयोगकर्ताओं के साथ।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| urlId | string | query | हाँ | |
| includeUserInfo | string | query | नहीं | "public" प्राइवेट प्रोफ़ाइल वाले उपयोगकर्ताओं को छोड़ देता है, "include-private" उन्हें शामिल करता है। |
प्रतिक्रिया
रिटर्न करता है: GetPageReactsAPIResponse
उदाहरण

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

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

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

migratePages 
एक urlId या domain से दूसरे में कमेंट्स, पेज और संबंधित रिकॉर्ड्स को स्थानांतरित करने वाली बैच जॉब कतार में डालता है। "urlId" माइग्रेशन केवल सटीक urlId से मेल खाते हैं। "domain" माइग्रेशन हर urlId और url के भीतर मान को खोजते/बदलते हैं। GET /api/v1/batch-jobs/{batchJobId} को पोल करें: एक बार पूरा होने पर इसमें प्रति-माइग्रेशन परिणाम और एक undoId होता है।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न: QueuePageMigrationJobAPIResponse
उदाहरण

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

undoPageMigrations 
एक बैच जॉब कतार में जोड़ता है जो एक migrate-pages जॉब के हर माइग्रेशन को उल्टा कर देता है, नवीनतम पहले। 90 दिनों तक उपलब्ध। माइग्रेशन के बाद बदले गए रिकॉर्ड को नहीं छेड़ा जाता, इसलिए बाद का कोई संपादन कभी अधिलेखित नहीं होता। पुनर्स्थापित/छोड़े गए की गिनती के लिए GET /api/v1/batch-jobs/{batchJobId} को पोल करें।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| undoId | string | path | हाँ |
प्रतिक्रिया
रिटर्न: QueuePageMigrationJobAPIResponse
उदाहरण

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

createPollVote 
किसी पोल पर वोट दर्ज करें, या मौजूदा वोट को किसी अन्य विकल्प पर स्थानांतरित करें। एक वोटर के पास प्रति पोल अधिकतम एक वोट होता है, इसलिए उसी वोटर के लिए इसे दोबारा कॉल करने पर नया वोट जोड़ने के बजाय उनका वोट स्थानांतरित हो जाता है।
यह साइट की पोल सेटिंग्स का पालन करता है: यदि वोटिंग केवल लॉग-इन उपयोगकर्ताओं के लिए सेट है, तो केवल anonUserId वाला वोट अस्वीकार कर दिया जाता है, और गुमनाम वोट प्रति IP प्रति पोल दर सीमित (rate limited) होते हैं।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न: CreatePollVoteResponse
उदाहरण

deletePollVote 
वोट वापस लें। जिस विकल्प पर वोट दिया गया था, वह अपनी गिनती वापस प्राप्त करता है।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न करता है: DeletePollVoteResponse
उदाहरण

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

getPollVotes 
एक पोल की गिनती के पीछे के व्यक्तिगत वोट, सबसे पुराने पहले।
एक पोल एक कमेंट से संबंधित होता है, इसलिए वोट हमेशा एक बार में एक पोल के लिए पढ़े जाते हैं - commentId आवश्यक है। इससे हर क्वेरी उन इंडेक्स पर ही रहती है जो कलेक्शन में पहले से मौजूद हैं।
पोल की प्राइवेसी का पालन करता है: एक अनाम पोल के वोट नहीं पढ़े जा सकते (poll-anonymous), यहाँ या id द्वारा।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | query | हाँ | |
| voterId | string | query | नहीं | |
| optionId | string | query | नहीं | |
| skip | integer | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetPollVotesResponse
उदाहरण

deletePoll 
पोल को उसके कमेंट से हटाएँ, साथ ही उस पर डाले गए हर वोट को भी। कमेंट स्वयं अछूता रहता है।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ |
प्रतिक्रिया
लौटाता है: APIEmptyResponse
उदाहरण

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

getPollVoters 
किस विकल्प पर किसने वोट दिया। गुमनाम पोल कभी जवाब नहीं देते, केवल-एडमिन पोल केवल एडमिन या मॉडरेटर के लिए जवाब देते हैं।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| commentId | string | path | हाँ | |
| urlId | string | query | नहीं | |
| page | integer | query | नहीं | |
| search | string | query | नहीं | |
| sso | string | query | नहीं |
प्रतिक्रिया
रिटर्न: GetPollVoterNamesSuccessResponse
उदाहरण

patchPoll 
पोल को उसकी गिनती बनाए रखते हुए उसी स्थान पर संपादित करें: प्रश्न बदलें, किसी विकल्प का लेबल बदलें, उसे बंद या फिर से खोलें, या बदलें कि मतदाताओं को कौन देख सकता है। विकल्प id द्वारा संबोधित किए जाते हैं - उन्हें जोड़ने, हटाने या पुनर्व्यवस्थित करने के लिए, पूरी सूची PUT करें।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ |
प्रतिक्रिया
रिटर्न: SavePollResponse
उदाहरण

putPoll 
किसी कमेंट से एक पोल जोड़ें, या उसके पास पहले से मौजूद पोल की पूरी स्थिति सेट करें।
विकल्प id द्वारा मैच किए जाते हैं: किसी मौजूदा विकल्प की id के साथ भेजा गया विकल्प अपने वोट बरकरार रखता है (और नया लेबल तथा स्थान ले लेता है), बिना id वाला विकल्प जोड़ दिया जाता है, और सूची से बाहर छूटे मौजूदा विकल्प उन पर डाले गए वोटों सहित हटा दिए जाते हैं।
वोट वाले पोल पर कोई भी मौजूदा विकल्प id न रखने से उन सभी को हटा दिया जाता है, इसलिए इसके लिए replaceVotes=true की आवश्यकता होती है।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| commentId | string | path | हाँ | |
| replaceVotes | boolean | query | नहीं |
प्रतिक्रिया
रिटर्न: SavePollResponse
उदाहरण

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

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

createWebhook 
किसी URL को एक कमेंट इवेंट (REST hook subscribe) के लिए सब्सक्राइब करता है। उसी URL को उसी इवेंट और डोमेन के लिए दोबारा सब्सक्राइब करने पर मौजूदा सब्सक्रिप्शन वापस आती है। डिलीवरी HMAC से साइन की जाती हैं, webhooks गाइड देखें; लेगेसी token हेडर API सब्सक्रिप्शन को कभी नहीं भेजा जाता।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateWebhookResponse
उदाहरण

deleteWebhook 
अनसब्सक्राइब (REST hook unsubscribe)। केवल इस API के माध्यम से बनाई गई सब्सक्रिप्शन यहाँ से डिलीट की जा सकती हैं; डैशबोर्ड-प्रबंधित वेबहुक डैशबोर्ड में एडिट किए जाते हैं।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| id | string | path | हाँ |
प्रतिक्रिया
रिटर्न: APIEmptyResponse
उदाहरण

getWebhooks 
टेनेंट के लिए कॉन्फ़िगर किए गए वेबहुक्स की सूची देता है, जिसमें डैशबोर्ड-प्रबंधित पंक्तियाँ और API सब्सक्रिप्शन दोनों शामिल हैं।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| event | string | query | नहीं | |
| domain | string | query | नहीं | |
| source | string | query | नहीं | |
| skip | number | query | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetWebhooksResponse
उदाहरण

getWebhookSamplePayloads 
वेबहुक डिलीवरी में उपयोग होने वाले बिल्कुल उसी रूप में हालिया कमेंट्स, इंटीग्रेशन बनाने के लिए (उदाहरण के लिए Zapier
सैंपल डेटा)। हर इवेंट एक ही कमेंट ऑब्जेक्ट डिलीवर करता है, इसलिए event को केवल वैध होना ही ज़रूरी है।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| event | string | query | नहीं | |
| limit | number | query | नहीं |
प्रतिक्रिया
लौटाता है: GetWebhookSamplePayloadsResponse
उदाहरण

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