
שפה 🇮🇱 עברית
התחלה מהירה
תיעוד
מדריך API
אגגרגציה
יומני ביקורת
אימות
חסימה מתגובה
בדיקת תגובות חסומות
תגובות
תגובות עבור משתמש
תצורות דומיין
תבניות אימייל
יומן אירוע
פוסטים
דיווח על תגובה
GIFים
האשטגים
מודרציה
מודרטורים
ספירת התראות
התראות
תגובות לדף
דפים
אירועי webhook ממתינים
הגדרות שאלון
תוצאות שאלון
אגרגציית תוצאות שאלון
משתמשי SSO
מנויים
שימוש יומי של טננט
חבילות טננט
משתמשי טננט
טננטים
טיקטים
תרגומים
העלאת תמונה
התקדמות תג משתמש
תגי משתמש
התראות משתמש
מצבי נוכחות משתמש
חיפוש משתמשים
משתמשים
הצבעות
FastComments SDK ל‑Swift
זהו ה‑SDK הרשמי של Swift עבור FastComments.
ה‑SDK הרשמי של Swift עבור ה‑API של FastComments
מאגר
התקנה 
מנהל חבילות Swift
הוסף את הבא לקובץ Package.swift שלך:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.0.0")
]
או ב‑Xcode:
- קובץ > הוסף חבילות...
- הזן את כתובת ה‑URL של המאגרים:
https://github.com/fastcomments/fastcomments-swift.git - בחר את הגרסה שברצונך להשתמש
דרישות
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
תכולת הספרייה 
ה‑FastComments Swift SDK מורכב ממספר מודולים:
-
Client Module - לקוח API עבור REST APIs של FastComments
- הגדרות טיפוסים מלאות לכל מודלי ה‑API
- שיטות מאומתות (
DefaultAPI), ציבוריות (PublicAPI), ושיטות למודרציה (ModerationAPI) - תמיכה מלאה ב‑async/await
- ראה client/README.md לתיעוד מפורט של ה‑API
-
SSO Module - כלים ל‑Single Sign‑On בצד השרת
- יצירת אסימונים מאובטחת לאימות משתמשים
- תמיכה בשני מצבי SSO — פשוט ומאובטח
- חתימת אסימונים מבוססת HMAC-SHA256 באמצעות CryptoKit
התחלה מהירה 
שימוש ב‑API ציבורי
import FastCommentsSwift
// הפקת תגובות עבור עמוד
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
שימוש ב‑API מאומת
import FastCommentsSwift
// הגדר את מפתח ה‑API שלך בתצורה המשותפת (נשלח ככותרת x-api-key header)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// הפקת תגובות באמצעות API מאומת
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
שימוש ב‑API מודרציה
import FastCommentsSwift
// שיטות מודרציה מאושרות בעזרת אסימון `sso` עבור המנחה הפועל
// (צור אותו עם FastCommentsSSO, ראה את סעיף ה‑SSO למעלה).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
שימוש ב‑SSO לאימות
SSO מאובטח (מומלץ לייצור)
import FastCommentsSwift
let apiKey = "your-api-key"
// צור נתוני משתמש SSO מאובטח (רק בשרת!)
let userData = SecureSSOUserData(
id: "user-123", // User ID
email: "user@example.com", // Email
username: "johndoe", // Username
avatar: "https://example.com/avatar.jpg" // Avatar URL
)
// צור אסימון SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// העבר אסימון זה לממשק הקדמי שלך לאימות
} catch {
print("Error creating SSO token: \(error)")
}
SSO פשוט (לפיתוח/בדיקה)
import FastCommentsSwift
// צור נתוני משתמש SSO פשוטים (אין צורך במפתח API)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// צור אסימון SSO פשוט
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
לקוחות API 
ה‑SDK של FastComments מספק שלושה לקוחות API:
PublicAPI - שיטות בטוחות ללקוח
ה‑PublicAPI מכילה שיטות בטוחות לקריאה מקוד בצד הלקוח (אפליקציות iOS/macOS). שיטות אלו:
- אינן דורשות מפתח API
- יכולות להשתמש באסימוני SSO לאימות
- מוגבלות בקצב לכל משתמש/מכשיר
- מתאימות ליישומים המיועדים למשתמש הקצה
דוגמה לשימוש: קבלת והוספת תגובות באפליקציית iOS שלך
DefaultAPI - שיטות בצד השרת
ה‑DefaultAPI מכילה שיטות מאומתות הדורשות מפתח API. שיטות אלו:
- דורשות את מפתח ה‑API של FastComments שלך
- צריך לקרוא להן רק מקוד בצד השרת
- מספקות גישה מלאה לנתוני FastComments שלך
- מוגבלות בקצב לכל שוכר
דוגמה לשימוש: פעולות ניהוליות, ייצוא נתונים בכמויות גדולות, ניהול משתמשים
ModerationAPI - שיטות ללוח המחוונים של המפקח
ה‑ModerationAPI מספקת חבילה נרחבת של API לשיפור מודרציה בזמן אמת ומהירה. כל שיטת ModerationAPI מקבלת פרמטר sso ויכולה לאמת באמצעות SSO או קובץ עוגייה של FastComments.com.
דוגמה לשימוש: בניית חוויית מודרציה למפקחים בקהילה שלך
חשוב: לעולם אל תחשוף את מפתח ה‑API שלך בקוד בצד הלקוח. מפתחות API צריכים לשמש רק בצד השרת.
ביצוע קריאות API 
ה‑SDK של Swift משתמש בתחביר async/await מודרני לכל קריאות ה‑API:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
בעיות נפוצות 
שגיאות 401 לא מורשות
אם אתה מקבל שגיאות 401 כאשר אתה משתמש ב‑API המאומת:
- בדוק את מפתח ה‑API שלך: וודא שאתה משתמש במפתח ה‑API הנכון מלוח הבקרה של FastComments
- ודא את מזהה השוכרת: ודא שמזהה השוכרת תואם לחשבון שלך
- פורמט מפתח ה‑API: מפתח ה‑API צריך להיות מוגדר ככותרת
x-api-keyבתצורה המשותפת:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- שימוש ב‑API הלא נכון: ודא שאתה משתמש ב‑
DefaultAPI(ולא ב‑PublicAPI) עבור קריאות מאומתות
בעיות אסימון SSO
אם אסימוני SSO אינם פועלים:
- השתמש במצב מאובטח עבור ייצור: תמיד השתמש ב‑
FastCommentsSSO.createSecure()עם מפתח ה‑API שלך עבור ייצור - צד השרת בלבד: צור אסימוני SSO מאובטחים על השרת שלך, לעולם אל תחשוף את מפתח ה‑API ללקוחות
- בדוק נתוני משתמש: ודא שכל השדות הדרושים (id, email, username) סופקו
- תפוגת אסימון: אסימוני SSO מאובטחים כוללים חותמת זמן ויכולים לפוג. צור אסימונים חדשים לפי הצורך.
שגיאות SSL/TLS
אם אתה נתקל בשגיאות SSL/TLS:
- וודא שקובץ Info.plist של האפליקציה מאפשר חיבורים HTTPS אל fastcomments.com
- בדוק שאינך משתמש בחריגות של App Transport Security שעשויות לחסום את החיבור
הערות 
מזהי שידור
תראה שעליך להעביר broadcastId בקריאות API מסוימות. כאשר תקבל אירועים, תקבל חזרה את ה-ID הזה, כך שתדע להתעלם מהאירוע אם אתה מתכנן להחיל שינויים בצורה אופטימיסטית בצד הלקוח (שככל הנראה תרצה לעשות זאת מכיוון שזה מספק את חוויית המשתמש הטובה ביותר). העבר כאן UUID. ה-ID צריך להיות ייחודי מספיק כדי שלא יופיע פעמיים באותו סשן.
let broadcastId = UUID().uuidString
אגרגציה 
מאגד מסמכים על ידי קיבוץ שלהם (אם groupBy סופק) ויישום של מספר פעולות. תומכות פעולות שונות (למשל sum, countDistinct, avg וכו').
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
תגובה
מחזיר: AggregateResponse
דוגמה

קבל יומני ביקורת 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| limit | number | query | לא | |
| skip | number | query | לא | |
| order | string | query | לא | |
| after | number | query | לא | |
| before | number | query | לא |
תגובה
מחזיר: GetAuditLogsResponse
דוגמה

התנתקות (ציבורי) 
תגובה
מחזיר: APIEmptyResponse
דוגמה

חסום מתוך תגובה (ציבורי) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: BlockSuccess
דוגמה

בטל חסימת תגובה (ציבורי) 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
תשובה
מחזיר: UnblockSuccess
דוגמה

בדוק תגובות לחסימה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | רשימת מזהי תגובות מופרדת בפסיקים. |
| sso | string | query | No |
תגובה
מחזיר: CheckBlockedCommentsResponse
דוגמה

חסום משתמש מתגובה 
פרמטרים
| שם | סוג | מיקום | דרוש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: BlockSuccess
דוגמה

צור תגובה (ציבורי) 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Response
מחזירים: SaveCommentsResponseWithPresence
Example

מחק תגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
תגובה
מחזיר: DeleteCommentResult
דוגמה

מחק תגובה (ציבורי) 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: PublicAPIDeleteCommentResponse
דוגמה

מחק הצבעת תגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: VoteDeleteResponse
דוגמה

דווח על תגובה 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזירה: FlagCommentResponse
דוגמה

קבל תגובה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIGetCommentResponse
דוגמה

קבל תגובות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
תגובה
מחזיר: APIGetCommentsResponse
דוגמה

קבל תגובות (ציבורי) 
בקשה
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
דוגמה

קבל טקסט תגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| editKey | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: PublicAPIGetCommentTextResponse
דוגמה

קבל שמות משתמשים שהצביעו על תגובה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| dir | integer | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetCommentVoteUserNamesSuccessResponse
דוגמה

נעל תגובה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
תגובה
מחזיר: APIEmptyResponse
דוגמה

נעץ תגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: ChangeCommentPinStatusResponse
דוגמה

שמור תגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
תגובה
מחזיר: APISaveCommentResponse
דוגמה

שמור תגובות בכמות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
תגובה
מחזיר: [SaveCommentsBulkResponse]
דוגמה

הגדר טקסט תגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
תשובה
מחזיר: PublicAPISetCommentTextResponse
דוגמה

בטל חסימת משתמש מתגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
תגובה
Returns: UnblockSuccess
דוגמה

בטל דיווח על תגובה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
תגובה
מחזיר: FlagCommentResponse
דוגמה

בטל נעילת תגובה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה

בטל נעיצת תגובה 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: ChangeCommentPinStatusResponse
דוגמה

עדכן תגובה 
Parameters
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Response
מחזיר: APIEmptyResponse
Example

הצביע עבור תגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: VoteResponse
דוגמה

קבל תגובות עבור משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| userId | string | query | לא | |
| direction | string | query | לא | |
| repliesToUserId | string | query | לא | |
| page | number | query | לא | |
| includei10n | boolean | query | לא | |
| locale | string | query | לא | |
| isCrawler | boolean | query | לא |
תגובה
מחזיר: GetCommentsForUserResponse
דוגמה

הוסף תצורת דומיין 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: AddDomainConfigResponse
דוגמה

מחק תצורת דומיין 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domain | string | path | כן |
תגובה
מחזיר: DeleteDomainConfigResponse
דוגמה

קבל תצורת דומיין 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domain | string | path | כן |
תגובה
מחזיר: GetDomainConfigResponse
דוגמה

קבל תצורות דומיין 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
תגובה
מחזיר: GetDomainConfigsResponse
דוגמה

עדכן חלקית תצורת דומיין 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domainToUpdate | string | path | כן |
תגובה
מחזיר: PatchDomainConfigResponse
דוגמה

החלף תצורת דומיין 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| domainToUpdate | string | path | כן |
תגובה
מחזיר: PutDomainConfigResponse
דוגמה

צור תבנית אימייל 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateEmailTemplateResponse
דוגמה

מחק תבנית אימייל 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

מחק שגיאת הרצת תבנית אימייל 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| errorId | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל תבנית אימייל 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetEmailTemplateResponse
דוגמה

קבל הגדרות תבניות אימייל 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: GetEmailTemplateDefinitionsResponse
דוגמה

קבל שגיאות הרצת תבנית אימייל 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetEmailTemplateRenderErrorsResponse
דוגמה

קבל תבניות אימייל 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetEmailTemplatesResponse
דוגמה

הרץ תבנית אימייל 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| locale | string | query | לא |
תגובה
מחזיר: RenderEmailTemplateResponse
דוגמה

עדכן תבנית אימייל 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל יומן אירוע 
req tenantId urlId userIdWS
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| userIdWS | string | query | כן | |
| startTime | integer | query | כן | |
| endTime | integer | query | לא |
תגובה
מחזיר: GetEventLogResponse
דוגמה

קבל יומן אירועים גלובלי 
req tenantId urlId userIdWS
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| userIdWS | string | query | כן | |
| startTime | integer | query | כן | |
| endTime | integer | query | לא |
תגובה
מחזיר: GetEventLogResponse
דוגמה

צור פוסט פיד 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
תגובה
מחזיר: CreateFeedPostsResponse
דוגמה

צור פוסט פיד (ציבורי) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: CreateFeedPostResponse
דוגמה

מחק פוסט פיד (ציבורי) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תשובה
מחזיר: DeleteFeedPostPublicResponse
דוגמה

קבל פוסטים 
req tenantId afterId
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| afterId | string | query | לא | |
| limit | integer | query | לא | |
| tags | array | query | לא |
תגובה
מחזיר: GetFeedPostsResponse
דוגמה

קבל פוסטים (ציבורי) 
req tenantId afterId
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| afterId | string | query | לא | |
| limit | integer | query | לא | |
| tags | array | query | לא | |
| sso | string | query | לא | |
| isCrawler | boolean | query | לא | |
| includeUserInfo | boolean | query | לא |
תגובה
Returns: PublicFeedPostsResponse
דוגמה

קבל סטטיסטיקות פוסטים 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postIds | array | query | כן | |
| sso | string | query | לא |
תשובה
מחזיר: FeedPostsStatsResponse
דוגמה

קבל תגובות משתמשים ציבוריות 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postIds | array | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: UserReactsResponse
דוגמה

הגב לפוסט (ציבורי) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postId | string | path | כן | |
| isUndo | boolean | query | לא | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
Returns: ReactFeedPostResponse
דוגמה

עדכן פוסט 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
תגובה
מחזיר: APIEmptyResponse
דוגמה

עדכון פוסט (ציבורי) 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: CreateFeedPostResponse
דוגמה

דווח על תגובה (ציבורי) 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| isFlagged | boolean | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל GIF גדול 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| largeInternalURLSanitized | string | query | Yes |
תגובה
מחזיר: GifGetLargeResponse
דוגמה

חפש GIFים 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| search | string | query | כן | |
| locale | string | query | לא | |
| rating | string | query | לא | |
| page | number | query | לא |
תגובה
מחזיר: GetGifsSearchResponse
דוגמה

קבל GIFים פופולריים 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
תגובה
מחזיר: GetGifsTrendingResponse
דוגמה

הוסף האשטאג 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
תגובה
מחזיר: CreateHashTagResponse
דוגמה

הוסף האשטגים בכמות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
Returns: BulkCreateHashTagsResponse
דוגמה

מחק האשטאג 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| tag | string | נתיב | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל האשטגים 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| page | number | query | לא |
תגובה
מחזיר: GetHashTagsResponse
דוגמה

עדכן האשטאג חלקית 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| tag | string | path | כן |
תגובה
מחזיר: UpdateHashTagResponse
דוגמה

מחק הצבעת מודרציה 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: VoteDeleteResponse
דוגמה

קבל תגובות דרך API 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| 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 | לא |
Response
מחזירה: ModerationAPIGetCommentsResponse
Example

קבל סטטוס יצוא API 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationExportStatusResponse
דוגמה

קבל מזהי API 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationAPIGetCommentIdsResponse
דוגמה

קבל משתמשים שאובנו מתגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetBannedUsersFromCommentResponse
דוגמה

קבל סטטוס חסימת תגובה 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
תגובה
מחזיר: GetCommentBanStatusResponse
דוגמה

קבל ילדים של תגובה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
תגובה
מחזיר: ModerationAPIChildCommentsResponse
דוגמה

קבל ספירה 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| text-search | string | query | לא | |
| byIPFromComment | string | query | לא | |
| filter | string | query | לא | |
| searchFilters | string | query | לא | |
| demo | boolean | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ModerationAPICountCommentsResponse
דוגמה

קבל ספירות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
תגובה
מחזיר: GetBannedUsersCountResponse
דוגמה

קבל לוגים 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
Response
מחזיר: ModerationAPIGetLogsResponse
דוגמה

קבל תגי ידניים 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תשובה
מחזיר: GetTenantManualBadgesResponse
דוגמה

קבל תגי ידניים עבור משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: GetUserManualBadgesResponse
דוגמה

קבל תגובת מודרציה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| includeEmail | boolean | query | לא | |
| includeIP | boolean | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ModerationAPICommentResponse
דוגמה

קבל טקסט תגובת מודרציה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: GetCommentTextResponse
דוגמה

קבל סיכום לפני חסימה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
תגובה
מחזיר: PreBanSummary
דוגמה

קבל סיכום חיפוש תגובות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationCommentSearchResponse
דוגמה

קבל דפי חיפוש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| value | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ModerationPageSearchResponse
דוגמה

קבל אתרי חיפוש 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| value | string | query | לא | |
| sso | string | query | לא |
Response
מחזיר: ModerationSiteSearchResponse
דוגמה

קבל הצעות חיפוש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| text-search | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ModerationSuggestResponse
דוגמה

קבל משתמשים בחיפוש 
פרמטרים
| שם | סוג | מיקום | דרוש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: ModerationUserSearchResponse
דוגמה

קבל גורם אמון 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: GetUserTrustFactorResponse
דוגמה

קבל העדפת חסימת משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תגובה
Returns: APIModerateGetUserBanPreferencesResponse
דוגמה

קבל פרופיל פנימי של משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: GetUserInternalProfileResponse
דוגמה

התאם הצבעות תגובות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: AdjustVotesResponse
דוגמה

בצע יצוא API 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| text-search | string | query | לא | |
| byIPFromComment | string | query | לא | |
| filters | string | query | לא | |
| searchFilters | string | query | לא | |
| sorts | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ModerationExportResponse
דוגמה

חסום משתמש מתגובה (POST) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| 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
דוגמה

בטל חסימת משתמש (POST) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
תגובה
Returns: APIEmptyResponse
דוגמה

בצע אגרגציה מרוכזת לפני חסימה 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| includeByUserIdAndEmail | boolean | query | לא | |
| includeByIP | boolean | query | לא | |
| includeByEmailDomain | boolean | query | לא | |
| sso | string | query | לא |
Response
מחזיר: BulkPreBanSummary
דוגמה

קבל תגובות לפי מזהים 
Parameters
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
תגובה
מחזיר: ModerationAPIChildCommentsResponse
דוגמה

דווח על תגובה (POST) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזירה: APIEmptyResponse
דוגמה

הסר תגובה (POST) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: PostRemoveCommentApiResponse
דוגמה

שחזר תגובה שנמחקה (POST) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תשובה
מחזיר: APIEmptyResponse
דוגמה

הגדר מצב אישור תגובה (POST) 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| approved | boolean | query | לא | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: SetCommentApprovedResponse
דוגמה

הגדר מצב סקירת תגובה (POST) 
Parameters
| שם | סוג | מיקום | הכרחי | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
מחזיר: APIEmptyResponse
Example

הגדר סטטוס ספאם לתגובה (POST) 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
מחזיר: APIEmptyResponse
Example

הגדר טקסט תגובה (POST) 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: SetCommentTextResponse
דוגמה

בטל דיווח על תגובה (POST) 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | path | כן | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה

שלח הצבעה (POST) 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: VoteResponse
דוגמה

הענק תג פרס 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: AwardUserBadgeResponse
דוגמה

סגור שרשור 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
תגובה
מחזיר: APIEmptyResponse
דוגמה

הסר תג פרס 
פרמטרים
| שם | סוג | מיקום | דרוש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| badgeId | string | query | כן | |
| userId | string | query | לא | |
| commentId | string | query | לא | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: RemoveUserBadgeResponse
דוגמה

פתח מחדש שרשור 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
תגובה
מחזיר: APIEmptyResponse
דוגמה

הגדר גורם אמון 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| trustFactor | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: SetUserTrustFactorResponse
דוגמה

צור מודרטור 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateModeratorResponse
דוגמה

מחק מודרטור 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| sendEmail | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל מודרטור 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetModeratorResponse
דוגמה

קבל מודרטורים 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetModeratorsResponse
דוגמה

שלח הזמנה 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| fromName | string | query | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

עדכן מודרטור 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

מחק ספירת התראות 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל ספירת התראות מטמון 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetCachedNotificationCountResponse
דוגמה

קבל ספירת התראות 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| urlId | string | query | לא | |
| fromCommentId | string | query | לא | |
| viewed | boolean | query | לא | |
| type | string | query | לא |
Response
מחזיר: GetNotificationCountResponse
Example

קבל התראות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
תשובה
Returns: GetNotificationsResponse
דוגמה

עדכן התראה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תשובה
מחזיר: APIEmptyResponse
דוגמה

צור תגובת דף V1 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| title | string | query | לא |
תגובה
מחזיר: CreateV1PageReact
דוגמה

צור תגובת דף V2 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| id | string | query | כן | |
| title | string | query | לא |
תגובה
מחזיר: CreateV1PageReact
דוגמה

מחק תגובת דף V1 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: CreateV1PageReact
דוגמה

מחק תגובת דף V2 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| id | string | query | כן |
תגובה
מחזיר: CreateV1PageReact
דוגמה

קבל לייקים לדף V1 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: GetV1PageLikes
דוגמה

קבל תגובות לדף V2 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: GetV2PageReacts
דוגמה

קבל משתמשי תגובות לדף V2 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
תגובה
מחזיר: GetV2PageReactUsersResponse
דוגמה

הוסף דף 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: AddPageAPIResponse
דוגמה

מחק דף 
פרמטרים
| שם | סוג | Location | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: DeletePageAPIResponse
דוגמה

קבל משתמשים לא מקוונים 
Past commenters on the page who are NOT currently online. Sorted by displayName.
המתגדים הקודמים בדף שאינם מחוברים כרגע. ממוין לפי displayName.
Use this after exhausting /users/online to render a "Members" section.
השתמש בזה לאחר שחילצת את /users/online כדי להציג את חלקת "Members".
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
דפדוף בעזרת курсור על commenterName: השרת מעביר את האינדקס החלקי {tenantId, urlId, commenterName} מ‑afterName קדימה באמצעות $gt, ללא עלות $skip.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | מזהה URL של העמוד (נוקה בצד השרת). |
| afterName | string | query | No | קרסור: העבר את nextAfterName מהתגובה הקודמת. (אופציונלי) |
| afterUserId | string | query | No | קישור קרסור למתי תקלות: העבר את nextAfterUserId מהתגובה הקודמת. נדרש כאשר afterName מוגדר כדי שמקרים של שמות זהים לא יפלו מהתוצאה. (אופציונלי) |
Response
מחזיר: PageUsersOfflineResponse
Example

קבל משתמשים מקוונים 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | מזהה URL של הדף (מנוקה בצד השרת). |
| afterName | string | query | No | סמן: העבר nextAfterName מהתגובה הקודמת. |
| afterUserId | string | query | No | מחלקת קישוריות של סמן: העבר nextAfterUserId מהתגובה הקודמת. נדרש כאשר afterName מוגדר כדי שהקשרים על שם לא יפספסו ערכים. |
Response
Returns: PageUsersOnlineResponse
Example

קבל דף לפי מזהה URL 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: GetPageByURLIdAPIResponse
דוגמה

קבל דפים 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: GetPagesAPIResponse
דוגמה

קבל דפים (ציבורי) 
רשימת דפים עבור דייר. משמש את לקוח השולחן העבודה של FChat למלא את רשימת החדרים שלו.
דורש ש-enableFChat יהיה true בתצורה המותאמת המוגדרת לכל דף.
דפים הדורשים SSO מסוננים על פי הגישה לקבוצת המשתמש שמבצע את הבקשה.
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | סמן דפדוף בלתי ניראה שמוחזר כ-nextCursor מבקשה קודמת. מקושר לאותו sortBy. |
| limit | integer | query | No | 1..200, ברירת מחדל 50 |
| q | string | query | No | מסנן קידומת כותרת רגישות לאותיות, אופציונלי. |
| sortBy | string | query | No | סדר מיון. updatedAt (ברירת מחדל, החדש ביותר ראשון), commentCount (התגובות הרבות ראשון), או title (בסדר אלפביתי). |
| hasComments | boolean | query | No | אם אמת, תחזיר רק דפים שיש להם לפחות תגובה אחת. |
תגובה
מחזיר: GetPublicPagesResponse
דוגמה

קבל מידע על משתמשים 
מידע מרוכז על משתמשים עבור שוכר. בהינתן userIds, מחזיר מידע תצוגה מ-User / SSOUser. מנוצל על ידי וידג'ט התגובות להעשיר משתמשים שהופיעו זה עתה דרך אירוע נוכחות. אין הקשר של דף: פרטיות נאכפת באופן אחיד (פרופילים פרטיים מוסתרים).
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| ids | string | query | כן | רשימת userIds מופרדת בפסיקים. |
תגובה
מחזיר: PageUsersInfoResponse
דוגמה

עדכן דף חלקית 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: PatchPageAPIResponse
דוגמה

מחק אירוע webhook ממתין 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל ספירת אירועי webhook ממתינים 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | לא | |
| externalId | string | query | לא | |
| eventType | string | query | לא | |
| type | string | query | לא | |
| domain | string | query | לא | |
| attemptCountGT | number | query | לא |
תגובה
מחזיר: GetPendingWebhookEventCountResponse
דוגמה

קבל אירועי webhook ממתינים 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| 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
דוגמה

צור תצורת שאלון 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateQuestionConfigResponse
דוגמה

מחק תצורת שאלון 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל תצורת שאלון 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetQuestionConfigResponse
דוגמה

קבל תצורות שאלון 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetQuestionConfigsResponse
דוגמה

עדכן תצורת שאלון 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

צור תוצאת שאלון 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateQuestionResultResponse
דוגמה

מחק תוצאת שאלון 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל תוצאת שאלון 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetQuestionResultResponse
דוגמה

קבל תוצאות שאלון 
Parameters
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
תגובה
Returns: GetQuestionResultsResponse
דוגמה

עדכן תוצאת שאלון 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

אגגרציית תוצאות שאלון 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| questionId | string | query | לא | |
| questionIds | array | query | לא | |
| urlId | string | query | לא | |
| timeBucket | string | query | לא | |
| startDate | string | query | לא | |
| forceRecalculate | boolean | query | לא |
Response
מחזיר: AggregateQuestionResultsResponse
דוגמה

אגגרציית תוצאות שאלון בכמות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| forceRecalculate | boolean | query | לא |
תגובה
מחזיר: BulkAggregateQuestionResultsResponse
דוגמה

שילוב תגובות עם תוצאות שאלון 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
תגובה
מחזיר: CombineQuestionResultsWithCommentsResponse
דוגמה

הוסף משתמש SSO 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: AddSSOUserAPIResponse
Example

מחק משתמש SSO 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
תגובה
מחזיר: DeleteSSOUserAPIResponse
דוגמה

קבל משתמש SSO לפי אימייל 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| string | path | כן |
תגובה
מחזיר: GetSSOUserByEmailAPIResponse
דוגמה

קבל משתמש SSO לפי מזהה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetSSOUserByIdAPIResponse
דוגמה

קבל משתמשי SSO 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | integer | query | לא |
תגובה
מחזיר: GetSSOUsersResponse
דוגמה

עדכן משתמש SSO חלקית 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | boolean | query | לא |
תגובה
מחזיר: PatchSSOUserAPIResponse
דוגמה

החלף משתמש SSO 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | boolean | query | לא |
תגובה
מחזיר: PutSSOUserAPIResponse
דוגמה

צור מנוי 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateSubscriptionAPIResponse
דוגמה

מחק מנוי 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: DeleteSubscriptionAPIResponse
דוגמה

קבל מנויים 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No |
תגובה
מחזיר: GetSubscriptionsAPIResponse
דוגמה

עדכן מנוי 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: UpdateSubscriptionAPIResponse
דוגמה

קבל שימוש יומי של טננט 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
תגובה
מחזיר: GetTenantDailyUsagesResponse
דוגמה

צור חבילת טננט 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateTenantPackageResponse
דוגמה

מחק חבילת טננט 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל חבילת טננט 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetTenantPackageResponse
דוגמה

קבל חבילות טננט 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetTenantPackagesResponse
דוגמה

החלף חבילת טננט 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

עדכן חבילת טננט 
פרמטרים
| שם | סוג | מיקום | דרוש | תיאור |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

צור משתמש טננט 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateTenantUserResponse
דוגמה

מחק משתמש טננט 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| deleteComments | string | query | לא | |
| commentDeleteMode | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל משתמש טננט 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetTenantUserResponse
דוגמה

קבל משתמשי טננט 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| skip | number | query | לא |
תגובה
מחזיר: GetTenantUsersResponse
דוגמה

החלף משתמש טננט 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה

שלח קישור התחברות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
תגובה
מחזיר: APIEmptyResponse
דוגמה

עדכן משתמש טננט 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| updateComments | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה

צור טננט 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateTenantResponse
דוגמה

מחק טננט 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| sure | string | query | לא |
תגובה
מחזיר: APIEmptyResponse
דוגמה

קבל טננט 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetTenantResponse
דוגמה

קבל טננטים 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | מחרוזת | שאילתא | כן | |
| meta | מחרוזת | שאילתא | לא | |
| skip | מספר | שאילתא | לא |
Response
מחזיר: GetTenantsResponse
דוגמה

עדכן טננט 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

שנה מצב כרטיס 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: ChangeTicketStateResponse
דוגמה

צור כרטיס 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | כן |
תגובה
מחזיר: CreateTicketResponse
דוגמה

קבל כרטיס 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| userId | string | query | לא |
תגובה
מחזיר: GetTicketResponse
דוגמה

קבל כרטיסים 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| state | number | query | לא | |
| skip | number | query | לא | |
| limit | number | query | לא |
תגובה
מחזיר: GetTicketsResponse
דוגמה

קבל תרגומים 
פרמטרים
| שם | סוג | מקום | נדרש | תיאור |
|---|---|---|---|---|
| namespace | string | path | כן | |
| component | string | path | כן | |
| locale | string | query | לא | |
| useFullTranslationIds | boolean | query | לא |
תגובה
מחזיר: GetTranslationsResponse
דוגמה

העלה תמונה 
העלאת תמונה ושינוי גודלה
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | פרמטר גודל: "Default" (1000x1000px) או "CrossPlatform" (יוצר גדלים למכשירים פופולריים) |
| urlId | string | query | No | מזהה דף שממ ממנו מתבצע ההעלאה, לתצורה |
תגובה
Returns: UploadImageResponse
דוגמה

קבל התקדמות תג משתמש לפי מזהה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIGetUserBadgeProgressResponse
דוגמה

קבל התקדמות תג משתמש לפי מזהה משתמש 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | path | כן |
תגובה
מחזיר: APIGetUserBadgeProgressResponse
דוגמה

קבל רשימת התקדמות תג משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| limit | number | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: APIGetUserBadgeProgressListResponse
דוגמה

צור תג משתמש 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: APICreateUserBadgeResponse
דוגמה

מחק תג משתמש 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
תגובה
מחזיר: APIEmptySuccessResponse
דוגמה

קבל תג משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIGetUserBadgeResponse
דוגמה

קבל תגי משתמש 
Parameters
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Response
Returns: APIGetUserBadgesResponse
Example

עדכן תג משתמש 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
תגובה
מחזיר: APIEmptySuccessResponse
דוגמה

קבל ספירת התראות משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תשובה
מחזיר: GetUserNotificationCountResponse
דוגמה

קבל התראות משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | משמש לקביעת האם הדף הנוכחי מנוי. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sno | string | query | No |
תגובה
Returns: GetMyNotificationsResponse
דוגמה

אפס ספירת התראות משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: ResetUserNotificationsResponse
דוגמה

אפס התראות משתמש 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Response
מחזיר: ResetUserNotificationsResponse
דוגמה

עדכן סטטוס מנוי תגובה להתראות משתמש 
הפעל או השבת התראות עבור תגובה ספציפית.
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| notificationId | string | path | כן | |
| optedInOrOut | string | path | כן | |
| commentId | string | query | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UpdateUserNotificationCommentSubscriptionStatusResponse
דוגמה

עדכן סטטוס מנוי דף להתראות משתמש 
הפעל או השבת התראות עבור עמוד. כאשר משתמשים מנויים לעמוד, נוצרות התראות להערות שורש חדשות, וגם
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן | |
| url | string | query | כן | |
| pageTitle | string | query | כן | |
| subscribedOrUnsubscribed | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UpdateUserNotificationPageSubscriptionStatusResponse
דוגמה

עדכן סטטוס התראה משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| notificationId | string | path | כן | |
| newStatus | string | path | כן | |
| sso | string | query | לא |
תגובה
מחזיר: UpdateUserNotificationStatusResponse
דוגמה

קבל מצבי נוכחות משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlIdWS | string | query | כן | |
| userIds | string | query | כן |
תגובה
מחזיר: GetUserPresenceStatusesResponse
דוגמה

חפש משתמשים 
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Response
מחזיר: SearchUsersResult
Example

קבל משתמש 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetUserResponse
דוגמה

צור הצבעה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
תגובה
Returns: VoteResponse
דוגמה

מחק הצבעה 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן | |
| editKey | string | query | לא |
תגובה
מחזיר: VoteDeleteResponse
דוגמה

קבל הצבעות 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן |
תגובה
מחזיר: GetVotesResponse
דוגמה

קבל הצבעות עבור משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
תגובה
מחזירה: GetVotesForUserResponse
דוגמה

זקוק לעזרה?
אם נתקלת בבעיות או יש לך שאלות לגבי ה‑Swift SDK, אנא:
תרומות
תרומות מתקבלות בברכה! אנא בקר במאגר GitHub לקבלת הנחיות לתרומה.