
भाषा 🇮🇳 हिन्दी
दस्तावेज़ीकरण
शुरुआत करें
एग्रीगेट
API
ऑडिट लॉग
कमेंट से ब्लॉक
ब्लॉक किए गए कमेंट जाँचें
कमेंट
उपयोगकर्ता के लिए कमेंट
डोमेन कॉन्फ़िग
ईमेल टेम्पलेट
इवेंट लॉग
फ़ीड पोस्ट
कमेंट फ़्लैग करें
GIF
हैश टैग
मॉडरेशन
मॉडरेटर
सूचना संख्या
सूचनाएँ
पेज रिएक्ट
पेज
लंबित वेबहुक इवेंट
प्रश्न कॉन्फ़िग
प्रश्न परिणाम
प्रश्न परिणाम एग्रीगेशन
SSO उपयोगकर्ता
सदस्यताएँ
टेनेंट दैनिक उपयोग
टेनेंट पैकेज
टेनेंट उपयोगकर्ता
टेनेंट
टिकट
अनुवाद
इमेज अपलोड करें
उपयोगकर्ता बैज प्रगति
उपयोगकर्ता बैज
उपयोगकर्ता सूचनाएँ
उपयोगकर्ता उपस्थिति स्थिति
उपयोगकर्ता खोज
उपयोगकर्ता
वोट
FastComments Rust SDK
यह FastComments का आधिकारिक Rust SDK है।
अपने Rust एप्लिकेशन से कमेंट्स, यूज़र्स, SSO और मॉडरेशन मैनेज करें।
रिपॉज़िटरी
AI कोडिंग एजेंट 
अपने कोडिंग एजेंट को FastComments का वह संदर्भ दें जिसकी उसे आवश्यकता है - विजेट्स, कॉन्फ़िगरेशन, Secure SSO, REST API, और SDKs:
npx skills add fastcomments/skills
यह Claude Code, Codex, Cursor, Copilot, Gemini, और skills CLI द्वारा समर्थित हर अन्य एजेंट के साथ काम करता है।
लाइब्रेरी सामग्री 
FastComments Rust SDK कई मॉड्यूल्स से मिलकर बना है:
-
Client Module - FastComments REST APIs के लिए API क्लाइंट
- सभी API मॉडल्स के लिए पूर्ण टाइप परिभाषाएँ
- सभी FastComments मेथड्स को कवर करने वाले तीन API क्लाइंट:
default_api(DefaultApi) - सर्वर-साइड उपयोग के लिए API-की-प्रमाणित मेथड्सpublic_api(PublicApi) - सार्वजनिक, बिना API-की वाले मेथड्स जिन्हें ब्राउज़रों और मोबाइल ऐप्स से कॉल करना सुरक्षित हैmoderation_api(ModerationApi) - लाइव और तेज़ मॉडरेशन APIs का एक विस्तृत सूट। प्रत्येक Moderation मेथड एकssoपैरामीटर स्वीकार करता है और SSO या FastComments.com सेशन कुकी के माध्यम से प्रमाणित हो सकता है।
- tokio के साथ पूर्ण async/await समर्थन
- विस्तृत API दस्तावेज़ीकरण के लिए client/README.md देखें
-
SSO Module - सर्वर-साइड सिंगल साइन-ऑन यूटिलिटीज़
- उपयोगकर्ता प्रमाणीकरण के लिए सुरक्षित टोकन जनरेशन
- सरल और सुरक्षित दोनों SSO मोड्स के लिए समर्थन
- HMAC-SHA256 आधारित टोकन साइनिंग
-
Core Types - साझा टाइप परिभाषाएँ और यूटिलिटीज़
- कमेंट मॉडल्स और मेटाडेटा संरचनाएँ
- उपयोगकर्ता और टेनेंट कॉन्फ़िगरेशन
- सामान्य ऑपरेशनों के लिए हेल्पर फ़ंक्शन
क्विक स्टार्ट 
पब्लिक API का उपयोग करना
use fastcomments_sdk::client::apis::configuration::Configuration;
use fastcomments_sdk::client::apis::public_api;
#[tokio::main]
async fn main() {
// API कॉन्फ़िगरेशन बनाएँ
let config = Configuration::new();
// किसी पेज के लिए कमेंट्स प्राप्त करें
let result = public_api::get_comments_public(
&config,
public_api::GetCommentsPublicParams {
tenant_id: "your-tenant-id".to_string(),
urlid: Some("page-url-id".to_string()),
url: None,
count_only: None,
skip: None,
limit: None,
sort_dir: None,
page: None,
sso_hash: None,
simple_sso_hash: None,
has_no_comment: None,
has_comment: None,
comment_id_filter: None,
child_ids: None,
start_date_time: None,
starts_with: None,
},
)
.await;
match result {
Ok(response) => {
println!("Found {} comments", response.comments.len());
for comment in response.comments {
println!("Comment: {:?}", comment);
}
}
Err(e) => eprintln!("Error fetching comments: {:?}", e),
}
}
ऑथेंटिकेटेड API का उपयोग करना
use fastcomments_sdk::client::apis::configuration::{ApiKey, Configuration};
use fastcomments_sdk::client::apis::default_api;
#[tokio::main]
async fn main() {
// API की के साथ कॉन्फ़िगरेशन बनाएँ
let mut config = Configuration::new();
config.api_key = Some(ApiKey {
prefix: None,
key: "your-api-key".to_string(),
});
// ऑथेंटिकेटेड API का उपयोग करके कमेंट्स प्राप्त करें
let result = default_api::get_comments(
&config,
default_api::GetCommentsParams {
tenant_id: "your-tenant-id".to_string(),
skip: None,
limit: None,
sort_dir: None,
urlid: Some("page-url-id".to_string()),
url: None,
is_spam: None,
user_id: None,
all_comments: None,
for_moderation: None,
parent_id: None,
is_flagged: None,
is_flagged_tag: None,
is_by_verified: None,
is_pinned: None,
asc: None,
include_imported: None,
origin: None,
tags: None,
},
)
.await;
match result {
Ok(response) => {
println!("Total comments: {}", response.count);
for comment in response.comments {
println!("Comment ID: {}, Text: {}", comment.id, comment.comment);
}
}
Err(e) => eprintln!("Error: {:?}", e),
}
}
मॉडरेशन API का उपयोग करना
मॉडरेशन मेथड्स मॉडरेटर डैशबोर्ड को सपोर्ट करते हैं। ये ऑथेंटिकेटेड API की तरह ही API-की वाले Configuration का उपयोग करते हैं, और प्रत्येक मेथड एक वैकल्पिक sso टोकन स्वीकार करता है ताकि कॉल को SSO-ऑथेंटिकेटेड मॉडरेटर की ओर से किया जा सके।
use fastcomments_sdk::client::apis::configuration::{ApiKey, Configuration};
use fastcomments_sdk::client::apis::moderation_api;
#[tokio::main]
async fn main() {
// API की के साथ कॉन्फ़िगरेशन बनाएँ
let mut config = Configuration::new();
config.api_key = Some(ApiKey {
prefix: None,
key: "your-api-key".to_string(),
});
// मॉडरेशन क्यू में प्रतीक्षारत कमेंट्स की गिनती करें
let result = moderation_api::get_count(
&config,
moderation_api::GetCountParams {
text_search: None,
by_ip_from_comment: None,
filter: None,
search_filters: None,
demo: None,
sso: None, // SSO-ऑथेंटिकेटेड मॉडरेटर के रूप में कार्य करने के लिए SSO टोकन पास करें
},
)
.await;
match result {
Ok(response) => println!("Comments to moderate: {}", response.count),
Err(e) => eprintln!("Error: {:?}", e),
}
}
ऑथेंटिकेशन के लिए SSO का उपयोग करना
use fastcomments_sdk::sso::{
fastcomments_sso::FastCommentsSSO,
secure_sso_user_data::SecureSSOUserData,
};
fn main() {
let api_key = "your-api-key".to_string();
// सुरक्षित SSO यूज़र डेटा बनाएँ (केवल सर्वर-साइड!)
let user_data = SecureSSOUserData::new(
"user-123".to_string(), // यूज़र ID
"user@example.com".to_string(), // ईमेल
"John Doe".to_string(), // यूज़रनेम
"https://example.com/avatar.jpg".to_string(), // अवतार URL
);
// SSO टोकन जनरेट करें
let sso = FastCommentsSSO::new_secure(api_key, &user_data).unwrap();
let token = sso.create_token().unwrap();
println!("SSO Token: {}", token);
// ऑथेंटिकेशन के लिए यह टोकन अपने फ्रंटएंड को पास करें
}
सामान्य समस्याएँ 
401 अनधिकृत त्रुटियाँ
यदि आपको प्रमाणित API का उपयोग करते समय 401 त्रुटियाँ मिल रही हैं:
- अपनी API कुंजी जाँचें: सुनिश्चित करें कि आप अपने FastComments डैशबोर्ड से सही API कुंजी का उपयोग कर रहे हैं
- टेनेंट ID सत्यापित करें: सुनिश्चित करें कि टेनेंट ID आपके खाते से मेल खाती है
- API कुंजी प्रारूप: API कुंजी को Configuration में पास किया जाना चाहिए:
let mut config = Configuration::new();
config.api_key = Some(ApiKey {
prefix: None,
key: "YOUR_API_KEY".to_string(),
});
SSO टोकन समस्याएँ
यदि SSO टोकन काम नहीं कर रहे हैं:
- प्रोडक्शन के लिए सुरक्षित मोड का उपयोग करें: प्रोडक्शन के लिए हमेशा अपनी API कुंजी के साथ
FastCommentsSSO::new_secure()का उपयोग करें - केवल सर्वर-साइड: SSO टोकन अपने सर्वर पर जनरेट करें, कभी भी अपनी API कुंजी क्लाइंट्स को उजागर न करें
- उपयोगकर्ता डेटा जाँचें: सुनिश्चित करें कि सभी आवश्यक फ़ील्ड (id, email, username) प्रदान की गई हैं
Async रनटाइम त्रुटियाँ
SDK async संचालन के लिए tokio का उपयोग करता है। सुनिश्चित करें कि आप:
- tokio को अपनी निर्भरताओं में जोड़ें:
[dependencies]
tokio = { version = "1", features = ["full"] }
- tokio रनटाइम का उपयोग करें:
#[tokio::main]
async fn main() {
// आपका async कोड यहाँ
}
नोट्स 
ब्रॉडकास्ट IDs
आप देखेंगे कि कुछ API कॉल में broadcastId पास करना अपेक्षित है। जब आप इवेंट्स प्राप्त करते हैं, तो आपको यह ID वापस मिलेगी, ताकि आप उस इवेंट को अनदेखा कर सकें यदि आप क्लाइंट पर बदलावों को ऑप्टिमिस्टिक रूप से लागू करने की योजना बना रहे हैं
(जो आप शायद करना चाहेंगे क्योंकि यह सबसे अच्छा अनुभव देता है)। यहाँ एक UUID पास करें। ID इतनी अद्वितीय होनी चाहिए कि वह एक ब्राउज़र सेशन में दो बार न आए।
aggregate 
दस्तावेज़ों को समूहित करके (यदि groupBy दिया गया है) एकत्रित करता है और कई ऑपरेशन लागू करता है। विभिन्न ऑपरेशन (जैसे sum, countDistinct, avg, आदि) समर्थित हैं।
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| aggregation_request | models::AggregationRequest | हाँ | |
| parent_tenant_id | String | नहीं | |
| include_stats | bool | नहीं |
प्रतिक्रिया
लौटाता है: AggregateResponse
उदाहरण

get_api_comments 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| page | f64 | नहीं | |
| count | f64 | नहीं | |
| text_search | String | नहीं | |
| by_ip_from_comment | String | नहीं | |
| filters | String | नहीं | |
| search_filters | String | नहीं | |
| sorts | String | नहीं | |
| demo | bool | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ModerationApiGetCommentsResponse
उदाहरण

get_api_export_status 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| batch_job_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ModerationExportStatusResponse
उदाहरण

get_api_ids 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| text_search | String | नहीं | |
| by_ip_from_comment | String | नहीं | |
| filters | String | नहीं | |
| search_filters | String | नहीं | |
| after_id | String | नहीं | |
| demo | bool | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationApiGetCommentIdsResponse
उदाहरण

post_api_export 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| text_search | String | नहीं | |
| by_ip_from_comment | String | नहीं | |
| filters | String | नहीं | |
| search_filters | String | नहीं | |
| sorts | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationExportResponse
उदाहरण

get_audit_logs 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| limit | f64 | नहीं | |
| skip | f64 | नहीं | |
| order | models::SortDir | नहीं | |
| after | f64 | नहीं | |
| before | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetAuditLogsResponse
उदाहरण

block_from_comment_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| public_block_from_comment_params | models::PublicBlockFromCommentParams | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: BlockSuccess
उदाहरण

un_block_comment_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| public_block_from_comment_params | models::PublicBlockFromCommentParams | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: UnblockSuccess
उदाहरण

checked_comments_for_blocked 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_ids | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: CheckBlockedCommentsResponse
उदाहरण

block_user_from_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| block_from_comment_params | models::BlockFromCommentParams | हाँ | |
| user_id | String | नहीं | |
| anon_user_id | String | नहीं |
प्रतिक्रिया
लौटाता है: BlockSuccess
उदाहरण

create_comment_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| broadcast_id | String | हाँ | |
| comment_data | models::CommentData | हाँ | |
| session_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: SaveCommentsResponseWithPresence
उदाहरण

delete_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| context_user_id | String | नहीं | |
| is_live | bool | नहीं |
प्रतिक्रिया
लौटाता है: DeleteCommentResult
उदाहरण

delete_comment_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | हाँ | |
| edit_key | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: PublicApiDeleteCommentResponse
उदाहरण

delete_comment_vote 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| vote_id | String | हाँ | |
| url_id | String | हाँ | |
| broadcast_id | String | हाँ | |
| edit_key | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न: VoteDeleteResponse
उदाहरण

flag_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| user_id | String | नहीं | |
| anon_user_id | String | नहीं |
प्रतिक्रिया
रिटर्न: FlagCommentResponse
उदाहरण

get_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
लौटाता है: ApiGetCommentResponse
उदाहरण

get_comment_text 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| edit_key | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: PublicApiGetCommentTextResponse
उदाहरण

get_comment_vote_user_names 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| dir | i32 | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: GetCommentVoteUserNamesSuccessResponse
उदाहरण

get_comments 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| page | i32 | नहीं | |
| limit | i32 | नहीं | |
| skip | i32 | नहीं | |
| as_tree | bool | नहीं | |
| skip_children | i32 | नहीं | |
| limit_children | i32 | नहीं | |
| max_tree_depth | i32 | नहीं | |
| url_id | String | नहीं | |
| user_id | String | नहीं | |
| anon_user_id | String | नहीं | |
| context_user_id | String | नहीं | |
| hash_tag | String | नहीं | |
| parent_id | String | नहीं | |
| direction | models::SortDirections | नहीं | |
| from_date | i64 | नहीं | |
| to_date | i64 | नहीं |
प्रतिक्रिया
रिटर्न: ApiGetCommentsResponse
उदाहरण

get_comments_public 
req tenantId urlId
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| page | i32 | नहीं | |
| direction | models::SortDirections | नहीं | |
| sso | String | नहीं | |
| skip | i32 | नहीं | |
| skip_children | i32 | नहीं | |
| limit | i32 | नहीं | |
| limit_children | i32 | नहीं | |
| count_children | bool | नहीं | |
| fetch_page_for_comment_id | String | नहीं | |
| include_config | bool | नहीं | |
| count_all | bool | नहीं | |
| includei10n | bool | नहीं | |
| locale | String | नहीं | |
| modules | String | नहीं | |
| is_crawler | bool | नहीं | |
| include_notification_count | bool | नहीं | |
| as_tree | bool | नहीं | |
| max_tree_depth | i32 | नहीं | |
| use_full_translation_ids | bool | नहीं | |
| parent_id | String | नहीं | |
| search_text | String | नहीं | |
| hash_tags | Vec | नहीं | |
| user_id | String | नहीं | |
| custom_config_str | String | नहीं | |
| after_comment_id | String | नहीं | |
| before_comment_id | String | नहीं |
प्रतिक्रिया
लौटाता है: GetCommentsResponseWithPresencePublicComment
उदाहरण

lock_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

pin_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ChangeCommentPinStatusResponse
उदाहरण

save_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_comment_params | models::CreateCommentParams | हाँ | |
| is_live | bool | नहीं | |
| do_spam_check | bool | नहीं | |
| send_emails | bool | नहीं | |
| populate_notifications | bool | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiSaveCommentResponse
उदाहरण

save_comments_bulk 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_comment_params | Vecmodels::CreateCommentParams | हाँ | |
| is_live | bool | नहीं | |
| do_spam_check | bool | नहीं | |
| send_emails | bool | नहीं | |
| populate_notifications | bool | नहीं |
प्रतिक्रिया
रिटर्न: Vec<models::SaveCommentsBulkResponse>
उदाहरण

set_comment_text 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | हाँ | |
| comment_text_update_request | models::CommentTextUpdateRequest | हाँ | |
| edit_key | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: PublicApiSetCommentTextResponse
उदाहरण

un_block_user_from_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| un_block_from_comment_params | models::UnBlockFromCommentParams | हाँ | |
| user_id | String | नहीं | |
| anon_user_id | String | नहीं |
प्रतिक्रिया
लौटाता है: UnblockSuccess
उदाहरण

un_flag_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| user_id | String | नहीं | |
| anon_user_id | String | नहीं |
प्रतिक्रिया
रिटर्न: FlagCommentResponse
उदाहरण

un_lock_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न: ApiEmptyResponse
उदाहरण

un_pin_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ChangeCommentPinStatusResponse
उदाहरण

update_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| updatable_comment_params | models::UpdatableCommentParams | हाँ | |
| context_user_id | String | नहीं | |
| do_spam_check | bool | नहीं | |
| is_live | bool | नहीं |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

vote_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| url_id | String | हाँ | |
| broadcast_id | String | हाँ | |
| vote_body_params | models::VoteBodyParams | हाँ | |
| session_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: VoteResponse
उदाहरण

get_comments_for_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| user_id | String | नहीं | |
| direction | models::SortDirections | नहीं | |
| replies_to_user_id | String | नहीं | |
| page | f64 | नहीं | |
| includei10n | bool | नहीं | |
| locale | String | नहीं | |
| is_crawler | bool | नहीं |
प्रतिक्रिया
लौटाता है: GetCommentsForUserResponse
उदाहरण

add_domain_config 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| add_domain_config_params | models::AddDomainConfigParams | हाँ |
प्रतिक्रिया
लौटाता है: AddDomainConfigResponse
उदाहरण

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

get_domain_config 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| domain | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetDomainConfigResponse
उदाहरण

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

patch_domain_config 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| domain_to_update | String | हाँ | |
| patch_domain_config_params | models::PatchDomainConfigParams | हाँ |
प्रतिक्रिया
लौटाता है: PatchDomainConfigResponse
उदाहरण

put_domain_config 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| domain_to_update | String | हाँ | |
| update_domain_config_params | models::UpdateDomainConfigParams | हाँ |
प्रतिक्रिया
लौटाता है: PutDomainConfigResponse
उदाहरण

create_email_template 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_email_template_body | models::CreateEmailTemplateBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateEmailTemplateResponse
उदाहरण

delete_email_template 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

delete_email_template_render_error 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| error_id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

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

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

get_email_template_render_errors 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| skip | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetEmailTemplateRenderErrorsResponse
उदाहरण

get_email_templates 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| skip | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetEmailTemplatesResponse
उदाहरण

render_email_template 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| render_email_template_body | models::RenderEmailTemplateBody | हाँ | |
| locale | String | नहीं |
प्रतिक्रिया
लौटाता है: RenderEmailTemplateResponse
उदाहरण

update_email_template 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_email_template_body | models::UpdateEmailTemplateBody | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

get_event_log 
req tenantId urlId userIdWS
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| user_id_ws | String | हाँ | |
| start_time | i64 | हाँ | |
| end_time | i64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetEventLogResponse
उदाहरण

get_global_event_log 
req tenantId urlId userIdWS
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| user_id_ws | String | हाँ | |
| start_time | i64 | हाँ | |
| end_time | i64 | नहीं |
प्रतिक्रिया
लौटाता है: GetEventLogResponse
उदाहरण

create_feed_post 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_feed_post_params | models::CreateFeedPostParams | हाँ | |
| broadcast_id | String | नहीं | |
| is_live | bool | नहीं | |
| do_spam_check | bool | नहीं | |
| skip_dup_check | bool | नहीं |
प्रतिक्रिया
लौटाता है: CreateFeedPostsResponse
उदाहरण

create_feed_post_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_feed_post_params | models::CreateFeedPostParams | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: CreateFeedPostResponse
उदाहरण

delete_feed_post_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| post_id | String | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: DeleteFeedPostPublicResponse
उदाहरण

get_feed_posts 
req tenantId afterId
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| after_id | String | नहीं | |
| limit | i32 | नहीं | |
| tags | Vec | नहीं |
प्रतिक्रिया
लौटाता है: GetFeedPostsResponse
उदाहरण

get_feed_posts_public 
req tenantId afterId
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| after_id | String | नहीं | |
| limit | i32 | नहीं | |
| tags | Vec | नहीं | |
| sso | String | नहीं | |
| is_crawler | bool | नहीं | |
| include_user_info | bool | नहीं |
प्रतिक्रिया
रिटर्न करता है: PublicFeedPostsResponse
उदाहरण

get_feed_posts_stats 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| post_ids | Vec | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: FeedPostsStatsResponse
उदाहरण

get_user_reacts_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| post_ids | Vec | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: UserReactsResponse
उदाहरण

react_feed_post_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| post_id | String | हाँ | |
| react_body_params | models::ReactBodyParams | हाँ | |
| is_undo | bool | नहीं | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ReactFeedPostResponse
उदाहरण

update_feed_post 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| feed_post | models::FeedPost | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

update_feed_post_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| post_id | String | हाँ | |
| update_feed_post_params | models::UpdateFeedPostParams | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: CreateFeedPostResponse
उदाहरण

flag_comment_public 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| is_flagged | bool | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

get_gif_large 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| large_internal_url_sanitized | String | हाँ |
प्रतिक्रिया
लौटाता है: GifGetLargeResponse
उदाहरण

get_gifs_search 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| search | String | हाँ | |
| locale | String | नहीं | |
| rating | String | नहीं | |
| page | f64 | नहीं |
प्रतिक्रिया
लौटाता है: GetGifsSearchResponse
उदाहरण

get_gifs_trending 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| locale | String | नहीं | |
| rating | String | नहीं | |
| page | f64 | नहीं |
प्रतिक्रिया
लौटाता है: GetGifsTrendingResponse
उदाहरण

add_hash_tag 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_hash_tag_body | models::CreateHashTagBody | नहीं |
प्रतिक्रिया
लौटाता है: CreateHashTagResponse
उदाहरण

add_hash_tags_bulk 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| bulk_create_hash_tags_body | models::BulkCreateHashTagsBody | नहीं |
प्रतिक्रिया
लौटाता है: BulkCreateHashTagsResponse
उदाहरण

delete_hash_tag 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| tag | String | हाँ | |
| delete_hash_tag_request_body | models::DeleteHashTagRequestBody | नहीं |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

get_hash_tags 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| page | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetHashTagsResponse
उदाहरण

patch_hash_tag 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| tag | String | हाँ | |
| update_hash_tag_body | models::UpdateHashTagBody | नहीं |
प्रतिक्रिया
लौटाता है: UpdateHashTagResponse
उदाहरण

delete_moderation_vote 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| vote_id | String | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: VoteDeleteResponse
उदाहरण

get_ban_users_from_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetBannedUsersFromCommentResponse
उदाहरण

get_comment_ban_status 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न: GetCommentBanStatusResponse
उदाहरण

get_comment_children 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ModerationApiChildCommentsResponse
उदाहरण

get_count 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| text_search | String | नहीं | |
| by_ip_from_comment | String | नहीं | |
| filter | String | नहीं | |
| search_filters | String | नहीं | |
| demo | bool | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationApiCountCommentsResponse
उदाहरण

get_counts 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: GetBannedUsersCountResponse
उदाहरण

get_logs 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationApiGetLogsResponse
उदाहरण

get_manual_badges 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: GetTenantManualBadgesResponse
उदाहरण

get_manual_badges_for_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| badges_user_id | String | नहीं | |
| comment_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetUserManualBadgesResponse
उदाहरण

get_moderation_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| include_email | bool | नहीं | |
| include_ip | bool | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न: ModerationApiCommentResponse
उदाहरण

get_moderation_comment_text 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetCommentTextResponse
उदाहरण

get_pre_ban_summary 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| include_by_user_id_and_email | bool | नहीं | |
| include_by_ip | bool | नहीं | |
| include_by_email_domain | bool | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: PreBanSummary
उदाहरण

get_search_comments_summary 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| value | String | नहीं | |
| filters | String | नहीं | |
| search_filters | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ModerationCommentSearchResponse
उदाहरण

get_search_pages 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| value | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ModerationPageSearchResponse
उदाहरण

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

get_search_suggest 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| text_search | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ModerationSuggestResponse
उदाहरण

get_search_users 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| value | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ModerationUserSearchResponse
उदाहरण

get_trust_factor 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न: GetUserTrustFactorResponse
उदाहरण

get_user_ban_preference 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ApiModerateGetUserBanPreferencesResponse
उदाहरण

get_user_internal_profile 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: GetUserInternalProfileResponse
उदाहरण

post_adjust_comment_votes 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| adjust_comment_votes_params | models::AdjustCommentVotesParams | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: AdjustVotesResponse
उदाहरण

post_ban_user_from_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| ban_email | bool | नहीं | |
| ban_email_domain | bool | नहीं | |
| ban_ip | bool | नहीं | |
| delete_all_users_comments | bool | नहीं | |
| banned_until | String | नहीं | |
| is_shadow_ban | bool | नहीं | |
| update_id | String | नहीं | |
| ban_reason | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: BanUserFromCommentResult
उदाहरण

post_ban_user_undo 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| ban_user_undo_params | models::BanUserUndoParams | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

post_bulk_pre_ban_summary 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| bulk_pre_ban_params | models::BulkPreBanParams | हाँ | |
| include_by_user_id_and_email | bool | नहीं | |
| include_by_ip | bool | नहीं | |
| include_by_email_domain | bool | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: BulkPreBanSummary
उदाहरण

post_comments_by_ids 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comments_by_ids_params | models::CommentsByIdsParams | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ModerationApiChildCommentsResponse
उदाहरण

post_flag_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

post_remove_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: PostRemoveCommentApiResponse
उदाहरण

post_restore_deleted_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

post_set_comment_approval_status 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| approved | bool | नहीं | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: SetCommentApprovedResponse
उदाहरण

post_set_comment_review_status 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| reviewed | bool | नहीं | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

post_set_comment_spam_status 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| spam | bool | नहीं | |
| perm_not_spam | bool | नहीं | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

post_set_comment_text 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| set_comment_text_params | models::SetCommentTextParams | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: SetCommentTextResponse
उदाहरण

post_un_flag_comment 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न: ApiEmptyResponse
उदाहरण

post_vote 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| direction | String | नहीं | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: VoteResponse
उदाहरण

put_award_badge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| badge_id | String | हाँ | |
| user_id | String | नहीं | |
| comment_id | String | नहीं | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: AwardUserBadgeResponse
उदाहरण

put_close_thread 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

put_remove_badge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| badge_id | String | हाँ | |
| user_id | String | नहीं | |
| comment_id | String | नहीं | |
| broadcast_id | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: RemoveUserBadgeResponse
उदाहरण

put_reopen_thread 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

set_trust_factor 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | नहीं | |
| trust_factor | String | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: SetUserTrustFactorResponse
उदाहरण

create_moderator 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_moderator_body | models::CreateModeratorBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateModeratorResponse
उदाहरण

delete_moderator 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| send_email | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

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

get_moderators 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| skip | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetModeratorsResponse
उदाहरण

send_invite 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| from_name | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

update_moderator 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_moderator_body | models::UpdateModeratorBody | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

delete_notification_count 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

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

get_notification_count 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | नहीं | |
| url_id | String | नहीं | |
| from_comment_id | String | नहीं | |
| viewed | bool | नहीं |
प्रतिक्रिया
लौटाता है: GetNotificationCountResponse
उदाहरण

get_notifications 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | नहीं | |
| url_id | String | नहीं | |
| from_comment_id | String | नहीं | |
| viewed | bool | नहीं | |
| skip | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetNotificationsResponse
उदाहरण

update_notification 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_notification_body | models::UpdateNotificationBody | हाँ | |
| user_id | String | नहीं |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

create_v1_page_react 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| title | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: CreateV1PageReact
उदाहरण

create_v2_page_react 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| id | String | हाँ | |
| title | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: CreateV1PageReact
उदाहरण

delete_v1_page_react 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateV1PageReact
उदाहरण

delete_v2_page_react 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateV1PageReact
उदाहरण

get_v1_page_likes 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetV1PageLikes
उदाहरण

get_v2_page_react_users 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetV2PageReactUsersResponse
उदाहरण

get_v2_page_reacts 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetV2PageReacts
उदाहरण

add_page 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_api_page_data | models::CreateApiPageData | हाँ |
प्रतिक्रिया
रिटर्न: AddPageApiResponse
उदाहरण

delete_page 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
लौटाता है: DeletePageApiResponse
उदाहरण

get_offline_users 
पेज पर उन पिछले टिप्पणीकारों का डेटा जो इस समय ऑनलाइन नहीं हैं। displayName के अनुसार क्रमबद्ध। "Members" सेक्शन रेंडर करने के लिए /users/online का उपयोग पूरा करने के बाद इसका उपयोग करें। commenterName पर कर्सर पेजिनेशन: सर्वर afterName से आगे $gt के माध्यम से आंशिक {tenantId, urlId, commenterName} इंडेक्स को ट्रैवर्स करता है, बिना $skip लागत के।
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenant_id | String | Yes | |
| url_id | String | Yes | |
| after_name | String | No | |
| after_user_id | String | No |
Response
रिटर्न करता है: PageUsersOfflineResponse
Example

get_online_users 
किसी पेज के वर्तमान में ऑनलाइन दर्शक: वे लोग जिनका websocket सेशन इस समय पेज की सदस्यता लिए हुए है। anonCount + totalCount लौटाता है (पूरे रूम के सब्सक्राइबर, जिनमें वे अनाम दर्शक भी शामिल हैं जिन्हें हम सूचीबद्ध नहीं करते)।
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| after_name | String | नहीं | |
| after_user_id | String | नहीं |
प्रतिक्रिया
लौटाता है: PageUsersOnlineResponse
उदाहरण

get_page_by_urlid 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ |
प्रतिक्रिया
लौटाता है: GetPageByUrlidApiResponse
उदाहरण

get_pages 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetPagesApiResponse
उदाहरण

get_pages_public 
किसी टेनेंट के लिए पेजों की सूची लाता है। FChat डेस्कटॉप क्लाइंट द्वारा अपनी रूम सूची भरने के लिए उपयोग किया जाता है।
प्रत्येक पेज के लिए रिज़ॉल्व किए गए कस्टम कॉन्फ़िग में enableFChat true होना आवश्यक है।
SSO की आवश्यकता वाले पेज अनुरोध करने वाले उपयोगकर्ता के ग्रुप एक्सेस के आधार पर फ़िल्टर किए जाते हैं।
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| cursor | String | नहीं | |
| limit | i32 | नहीं | |
| q | String | नहीं | |
| sort_by | models::PagesSortBy | नहीं | |
| has_comments | bool | नहीं |
प्रतिक्रिया
लौटाता है: GetPublicPagesResponse
उदाहरण

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

patch_page 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_api_page_data | models::UpdateApiPageData | हाँ |
प्रतिक्रिया
रिटर्न करता है: PatchPageApiResponse
उदाहरण

delete_pending_webhook_event 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

get_pending_webhook_event_count 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | नहीं | |
| external_id | String | नहीं | |
| event_type | String | नहीं | |
| domain | String | नहीं | |
| attempt_count_gt | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetPendingWebhookEventCountResponse
उदाहरण

get_pending_webhook_events 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | नहीं | |
| external_id | String | नहीं | |
| event_type | String | नहीं | |
| domain | String | नहीं | |
| attempt_count_gt | f64 | नहीं | |
| skip | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetPendingWebhookEventsResponse
उदाहरण

create_question_config 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_question_config_body | models::CreateQuestionConfigBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateQuestionConfigResponse
उदाहरण

delete_question_config 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

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

get_question_configs 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| skip | f64 | नहीं |
प्रतिक्रिया
लौटाता है: GetQuestionConfigsResponse
उदाहरण

update_question_config 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_question_config_body | models::UpdateQuestionConfigBody | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

create_question_result 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_question_result_body | models::CreateQuestionResultBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateQuestionResultResponse
उदाहरण

delete_question_result 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

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

get_question_results 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | नहीं | |
| user_id | String | नहीं | |
| start_date | String | नहीं | |
| question_id | String | नहीं | |
| question_ids | String | नहीं | |
| skip | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetQuestionResultsResponse
उदाहरण

update_question_result 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_question_result_body | models::UpdateQuestionResultBody | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

aggregate_question_results 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| question_id | String | नहीं | |
| question_ids | Vec | नहीं | |
| url_id | String | नहीं | |
| time_bucket | models::AggregateTimeBucket | नहीं | |
| start_date | chrono::DateTimechrono::FixedOffset | नहीं | |
| force_recalculate | bool | नहीं |
प्रतिक्रिया
रिटर्न: AggregateQuestionResultsResponse
उदाहरण

bulk_aggregate_question_results 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| bulk_aggregate_question_results_request | models::BulkAggregateQuestionResultsRequest | हाँ | |
| force_recalculate | bool | नहीं |
प्रतिक्रिया
लौटाता है: BulkAggregateQuestionResultsResponse
उदाहरण

combine_comments_with_question_results 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| question_id | String | नहीं | |
| question_ids | Vec | नहीं | |
| url_id | String | नहीं | |
| start_date | chrono::DateTimechrono::FixedOffset | नहीं | |
| force_recalculate | bool | नहीं | |
| min_value | f64 | नहीं | |
| max_value | f64 | नहीं | |
| limit | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: CombineQuestionResultsWithCommentsResponse
उदाहरण

add_sso_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_apisso_user_data | models::CreateApissoUserData | हाँ |
प्रतिक्रिया
लौटाता है: AddSsoUserApiResponse
उदाहरण

delete_sso_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| delete_comments | bool | नहीं | |
| comment_delete_mode | String | नहीं |
प्रतिक्रिया
लौटाता है: DeleteSsoUserApiResponse
उदाहरण

get_sso_user_by_email 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| String | हाँ |
प्रतिक्रिया
लौटाता है: GetSsoUserByEmailApiResponse
उदाहरण

get_sso_user_by_id 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetSsoUserByIdApiResponse
उदाहरण

get_sso_users 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| skip | i32 | नहीं |
प्रतिक्रिया
लौटाता है: GetSsoUsersResponse
उदाहरण

patch_sso_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_apisso_user_data | models::UpdateApissoUserData | हाँ | |
| update_comments | bool | नहीं |
प्रतिक्रिया
लौटाता है: PatchSsoUserApiResponse
उदाहरण

put_sso_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_apisso_user_data | models::UpdateApissoUserData | हाँ | |
| update_comments | bool | नहीं |
प्रतिक्रिया
लौटाता है: PutSsoUserApiResponse
उदाहरण

create_subscription 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_api_user_subscription_data | models::CreateApiUserSubscriptionData | हाँ |
प्रतिक्रिया
लौटाता है: CreateSubscriptionApiResponse
उदाहरण

delete_subscription 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| user_id | String | नहीं |
प्रतिक्रिया
लौटाता है: DeleteSubscriptionApiResponse
उदाहरण

get_subscriptions 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | नहीं |
प्रतिक्रिया
लौटाता है: GetSubscriptionsApiResponse
उदाहरण

update_subscription 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_api_user_subscription_data | models::UpdateApiUserSubscriptionData | हाँ | |
| user_id | String | नहीं |
प्रतिक्रिया
लौटाता है: UpdateSubscriptionApiResponse
उदाहरण

get_tenant_daily_usages 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| year_number | f64 | नहीं | |
| month_number | f64 | नहीं | |
| day_number | f64 | नहीं | |
| skip | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTenantDailyUsagesResponse
उदाहरण

create_tenant_package 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_tenant_package_body | models::CreateTenantPackageBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateTenantPackageResponse
उदाहरण

delete_tenant_package 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

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

get_tenant_packages 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| skip | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTenantPackagesResponse
उदाहरण

replace_tenant_package 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| replace_tenant_package_body | models::ReplaceTenantPackageBody | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

update_tenant_package 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_tenant_package_body | models::UpdateTenantPackageBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

create_tenant_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_tenant_user_body | models::CreateTenantUserBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateTenantUserResponse
उदाहरण

delete_tenant_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| delete_comments | String | नहीं | |
| comment_delete_mode | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

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

get_tenant_users 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| skip | f64 | नहीं |
प्रतिक्रिया
लौटाता है: GetTenantUsersResponse
उदाहरण

replace_tenant_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| replace_tenant_user_body | models::ReplaceTenantUserBody | हाँ | |
| update_comments | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiEmptyResponse
उदाहरण

send_login_link 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| redirect_url | String | नहीं |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

update_tenant_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_tenant_user_body | models::UpdateTenantUserBody | हाँ | |
| update_comments | String | नहीं |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

create_tenant 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_tenant_body | models::CreateTenantBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: CreateTenantResponse
उदाहरण

delete_tenant 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| sure | String | नहीं |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

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

get_tenants 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| meta | String | नहीं | |
| skip | f64 | नहीं |
प्रतिक्रिया
लौटाता है: GetTenantsResponse
उदाहरण

update_tenant 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_tenant_body | models::UpdateTenantBody | हाँ |
प्रतिक्रिया
लौटाता है: ApiEmptyResponse
उदाहरण

change_ticket_state 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | हाँ | |
| id | String | हाँ | |
| change_ticket_state_body | models::ChangeTicketStateBody | हाँ |
प्रतिक्रिया
रिटर्न करता है: ChangeTicketStateResponse
उदाहरण

create_ticket 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | हाँ | |
| create_ticket_body | models::CreateTicketBody | हाँ |
प्रतिक्रिया
लौटाता है: CreateTicketResponse
उदाहरण

get_ticket 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| user_id | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTicketResponse
उदाहरण

get_tickets 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | नहीं | |
| state | f64 | नहीं | |
| skip | f64 | नहीं | |
| limit | f64 | नहीं |
प्रतिक्रिया
लौटाता है: GetTicketsResponse
उदाहरण

get_translations 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| namespace | String | हाँ | |
| component | String | हाँ | |
| locale | String | नहीं | |
| use_full_translation_ids | bool | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetTranslationsResponse
उदाहरण

upload_image 
छवि अपलोड और रिसाइज़ करें
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| file | std::path::PathBuf | हाँ | |
| size_preset | models::SizePreset | नहीं | |
| url_id | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: UploadImageResponse
उदाहरण

get_user_badge_progress_by_id 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: ApiGetUserBadgeProgressResponse
उदाहरण

get_user_badge_progress_by_user_id 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: ApiGetUserBadgeProgressResponse
उदाहरण

get_user_badge_progress_list 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | नहीं | |
| limit | f64 | नहीं | |
| skip | f64 | नहीं |
प्रतिक्रिया
रिटर्न करता है: ApiGetUserBadgeProgressListResponse
उदाहरण

create_user_badge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| create_user_badge_params | models::CreateUserBadgeParams | हाँ |
प्रतिक्रिया
लौटाता है: ApiCreateUserBadgeResponse
उदाहरण

delete_user_badge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: ApiEmptySuccessResponse
उदाहरण

get_user_badge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ |
प्रतिक्रिया
लौटाता है: ApiGetUserBadgeResponse
उदाहरण

get_user_badges 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| user_id | String | नहीं | |
| badge_id | String | नहीं | |
| displayed_on_comments | bool | नहीं | |
| limit | f64 | नहीं | |
| skip | f64 | नहीं |
प्रतिक्रिया
लौटाता है: ApiGetUserBadgesResponse
उदाहरण

update_user_badge 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| update_user_badge_params | models::UpdateUserBadgeParams | हाँ |
प्रतिक्रिया
रिटर्न करता है: ApiEmptySuccessResponse
उदाहरण

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

get_user_notifications 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | नहीं | |
| page_size | i32 | नहीं | |
| after_id | String | नहीं | |
| include_context | bool | नहीं | |
| after_created_at | i64 | नहीं | |
| unread_only | bool | नहीं | |
| dm_only | bool | नहीं | |
| no_dm | bool | नहीं | |
| include_translations | bool | नहीं | |
| include_tenant_notifications | bool | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetMyNotificationsResponse
उदाहरण

reset_user_notification_count 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
लौटाता है: ResetUserNotificationsResponse
उदाहरण

reset_user_notifications 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| after_id | String | नहीं | |
| after_created_at | i64 | नहीं | |
| unread_only | bool | नहीं | |
| dm_only | bool | नहीं | |
| no_dm | bool | नहीं | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: ResetUserNotificationsResponse
उदाहरण

update_user_notification_comment_subscription_status 
किसी विशिष्ट कमेंट के लिए नोटिफिकेशन सक्षम या अक्षम करें।
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| notification_id | String | हाँ | |
| opted_in_or_out | String | हाँ | |
| comment_id | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न: UpdateUserNotificationCommentSubscriptionStatusResponse
उदाहरण

update_user_notification_page_subscription_status 
किसी पेज के लिए सूचनाएँ (notifications) सक्षम या अक्षम करें। जब उपयोगकर्ता किसी पेज की सदस्यता लेते हैं, तो नई रूट टिप्पणियों के लिए सूचनाएँ बनाई जाती हैं, और साथ ही
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| url | String | हाँ | |
| page_title | String | हाँ | |
| subscribed_or_unsubscribed | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न: UpdateUserNotificationPageSubscriptionStatusResponse
उदाहरण

update_user_notification_status 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| notification_id | String | हाँ | |
| new_status | String | हाँ | |
| sso | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: UpdateUserNotificationStatusResponse
उदाहरण

get_user_presence_statuses 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id_ws | String | हाँ | |
| user_ids | String | हाँ |
प्रतिक्रिया
रिटर्न करता है: GetUserPresenceStatusesResponse
उदाहरण

search_users 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| username_starts_with | String | नहीं | |
| mention_group_ids | Vec | नहीं | |
| sso | String | नहीं | |
| search_section | String | नहीं |
प्रतिक्रिया
लौटाता है: SearchUsersResult
उदाहरण

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

create_vote 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| comment_id | String | हाँ | |
| direction | String | हाँ | |
| user_id | String | नहीं | |
| anon_user_id | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: VoteResponse
उदाहरण

delete_vote 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| id | String | हाँ | |
| edit_key | String | नहीं |
प्रतिक्रिया
लौटाता है: VoteDeleteResponse
उदाहरण

get_votes 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ |
प्रतिक्रिया
लौटाता है: GetVotesResponse
उदाहरण

get_votes_for_user 
पैरामीटर
| नाम | प्रकार | आवश्यक | विवरण |
|---|---|---|---|
| tenant_id | String | हाँ | |
| url_id | String | हाँ | |
| user_id | String | नहीं | |
| anon_user_id | String | नहीं |
प्रतिक्रिया
रिटर्न करता है: GetVotesForUserResponse
उदाहरण

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