
भाषा 🇮🇳 हिन्दी
दस्तावेज़ीकरण
शुरुआत करें
उपयोग
एग्रीगेट
ऑडिट लॉग
प्रमाणीकरण
कमेंट से ब्लॉक
ब्लॉक किए गए कमेंट जांचें
कमेंट
उपयोगकर्ता के लिए कमेंट
डोमेन कॉन्फ़िग
ईमेल टेम्पलेट
इवेंट लॉग
फ़ीड पोस्ट
कमेंट फ़्लैग करें
GIF
हैश टैग
मॉडरेशन
मॉडरेटर
नोटिफिकेशन संख्या
नोटिफिकेशन
पेज रिएक्ट
पेज
लंबित वेबहुक इवेंट
प्रश्न कॉन्फ़िग
प्रश्न परिणाम
प्रश्न परिणाम एग्रीगेशन
SSO उपयोगकर्ता
सदस्यताएँ
टेनेंट दैनिक उपयोग
टेनेंट पैकेज
टेनेंट उपयोगकर्ता
टेनेंट
टिकट
अनुवाद
इमेज अपलोड करें
उपयोगकर्ता बैज प्रगति
उपयोगकर्ता बैज
उपयोगकर्ता नोटिफिकेशन
उपयोगकर्ता उपस्थिति स्थिति
उपयोगकर्ता खोज
उपयोगकर्ता
वोट
FastComments Go SDK
यह FastComments का आधिकारिक Go SDK है।
अपने Go एप्लिकेशन से कमेंट्स, यूज़र्स, SSO और मॉडरेशन को प्रबंधित करें।
रिपॉज़िटरी
AI कोडिंग एजेंट 
अपने कोडिंग एजेंट को FastComments का वह संदर्भ दें जिसकी उसे आवश्यकता है - विजेट्स, कॉन्फ़िगरेशन, Secure SSO, REST API, और SDKs:
npx skills add fastcomments/skills
यह Claude Code, Codex, Cursor, Copilot, Gemini, और skills CLI द्वारा समर्थित हर अन्य एजेंट के साथ काम करता है।
इंस्टॉलेशन 
go get github.com/fastcomments/fastcomments-go
API क्लाइंट का उपयोग करना
Public API (बिना प्रमाणीकरण)
PublicAPI सार्वजनिक एंडपॉइंट्स तक बिना प्रमाणीकरण के एक्सेस की अनुमति देता है:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// PublicAPI का उपयोग करके कमेंट्स प्राप्त करें
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Default API (API Key आवश्यक)
DefaultAPI आपकी API key का उपयोग करके प्रमाणीकरण की आवश्यकता रखता है:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// API key के साथ प्रमाणित context बनाएं
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// प्रमाणित DefaultAPI का उपयोग करके कमेंट्स प्राप्त करें
response, httpResp, err := apiClient.DefaultAPI.GetComments(auth).
TenantId("your-tenant-id").
UrlId("your-page-url-id").
Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Moderation API (मॉडरेटर डैशबोर्ड)
ModerationAPI लाइव और तेज़ मॉडरेशन APIs का एक विस्तृत सूट प्रदान करता है। सभी मॉडरेशन मेथड्स एक sso पैरामीटर स्वीकार करते हैं और SSO या FastComments.com सेशन कुकी के माध्यम से प्रमाणीकरण कर सकते हैं:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// ModerationAPI का उपयोग करके मॉडरेशन के लिए कमेंट्स सूचीबद्ध करें
response, httpResp, err := apiClient.ModerationAPI.GetApiComments(
context.Background(),
).Sso("your-sso-token").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
उपयोग 
सरल SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// सरल SSO टोकन बनाएँ
user := &sso.SimpleSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Avatar: "https://example.com/avatar.jpg",
}
ssoInstance := sso.NewSimple(user)
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("SSO Token:", token)
// प्रमाणित API कॉल करने के लिए SSO टोकन का उपयोग करें
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
सुरक्षित SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// सुरक्षित SSO टोकन बनाएँ
user := &sso.SecureSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Username: "johndoe",
Avatar: "https://example.com/avatar.jpg",
}
apiKey := "your-api-key"
ssoInstance, err := sso.NewSecure(apiKey, user)
if err != nil {
panic(err)
}
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("Secure SSO Token:", token)
// प्रमाणित API कॉल करने के लिए SSO टोकन का उपयोग करें
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Aggregate 
groupBy दिए जाने पर दस्तावेज़ों को समूहित करके (grouping) और अनेक ऑपरेशन लागू करके उन्हें एकत्रित (aggregate) करता है। विभिन्न ऑपरेशन (जैसे sum, countDistinct, avg, आदि) समर्थित हैं।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | query | हाँ | |
| parentTenantId | string | query | नहीं | |
| includeStats | boolean | query | नहीं |
प्रतिक्रिया
लौटाता है: AggregateResponse
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GetPagesPublic 
किसी टेनेंट के लिए पेजों की सूची लौटाता है। FChat डेस्कटॉप क्लाइंट द्वारा अपनी रूम सूची भरने के लिए उपयोग किया जाता है।
प्रत्येक पेज के लिए 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) करने के लिए उपयोग किया जाता है जो presence इवेंट के माध्यम से अभी दिखाई दिए। कोई पेज संदर्भ नहीं: गोपनीयता समान रूप से लागू की जाती है (प्राइवेट प्रोफाइल मास्क कर दी जाती हैं)।
पैरामीटर
| नाम | प्रकार | स्थान | आवश्यक | विवरण |
|---|---|---|---|---|
| tenantId | string | path | हाँ | |
| ids | string | query | हाँ | कॉमा से अलग किए गए userIds। |
प्रतिक्रिया
लौटाता है: PageUsersInfoResponse
उदाहरण

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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