
שפה 🇮🇱 עברית
תיעוד
התחלה
התייחסות API
שוכרי סוכנים
אגרגציה
יומני ביקורת
אימות
משימות אצווה
חסימה מהתגובה
בדיקת תגובות חסומות
תגובות
תגובות למשתמש
תצורות דומיין
תבניות אימייל
יומן אירועים
פוסטים בפיד
סימון תגובה
גיפים
תגיות
אודותיי
מודרציה
מנחים
ספירת התראות
התראות
תגובות עמוד
דפים
אירועי ווב-הוק ממתינים
הצבעות סקר
סקרים
תצורות שאלה
תוצאות שאלה
אגרגציית תוצאות שאלה
משתמשי SSO
מנויים
שימוש יומי של שוכר
חבילות שוכר
משתמשי שוכר
שוכרים
כרטיסים
תרגומים
העלאת תמונה
התקדמות תג משתמש
תגי משתמש
התראות משתמש
מצב נוכחות משתמש
חיפוש משתמשים
משתמשים
הצבעות
ווב-הוקים
FastComments ערכת פיתוח Swift
זהו ה‑SDK הרשמי של Swift עבור FastComments.
ה‑SDK הרשמי של Swift עבור ה‑API של FastComments
מאגר
סוכני קידוד AI 
תן לסוכן הקידוד שלך את ההקשר של FastComments שהוא צריך - וידג'טים, תצורה, Secure SSO, ה‑REST API, וה‑SDKs:
npx skills add fastcomments/skills
עובד עם Claude Code, Codex, Cursor, Copilot, Gemini, וכל סוכן אחר שה-skills CLI תומך בו.
התקנה 
Swift Package Manager
הוסיפו את הבא לקובץ Package.swift שלכם:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
או ב-Xcode:
- File > Add Packages...
- הזינו את כתובת ה-URL של המאגר:
https://github.com/fastcomments/fastcomments-swift.git - בחרו את הגרסה שבה ברצונכם להשתמש
דרישות
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
תוכן הספרייה 
ה‑FastComments Swift SDK מורכב ממספר מודולים:
-
Client Module - לקוח 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
createAgentTenant 
יוצר חשבון ניסיון חדש עבור סוכן AI ללא הרשמה של אדם. אין צורך במפתח API כדי לקרוא לזה.
התגובה מכילה את מזהה השוכר, מפתח API הפועל מיידית נגד ה-REST API ושרת ה-MCP, וכן כתובת URL לתביעת החשבון. יש לתת את כתובת ה-URL לתביעה לאדם שאתה עובד עבורו: פתיחת הקישור בזמן שאתה מחובר ל-FastComments מחברת את החשבון אליו. חשבונות שלא נדרשו, והמפתחות שלהם, נמחקים 72 שעות לאחר היצירה. עד לתביעה, לחשבון יש את מגבלות הניסיון הסטנדרטיות.
Response
Returns: CreateAgentTenantResponse
Example

aggregate 
מאגד מסמכים על ידי קיבוץ שלהם (אם groupBy סופק) ויישום של מספר פעולות. תומכות פעולות שונות (למשל sum, countDistinct, avg וכו').
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
תגובה
מחזיר: AggregateResponse
דוגמה

getAuditLogs 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | ה‑tenant לקריאת יומני ביקורת. |
| limit | integer | query | No | כמה יומנים להחזיר. מקסימום 10000, ברירת מחדל 1000. |
| skip | integer | query | No | כמה יומנים לדלג, עבור דפדוף. |
| order | string | query | No | כיוון המיון על זמן האירוע. ברירת מחדל DESC (החדש ביותר ראשון). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | להחזיר רק אירועים שבוצעו על ידי שם משתמש זה. |
| ip | string | query | No | להחזיר רק אירועים מכתובת IP זו. |
| crudType | string | query | No | להחזיר רק אירועים מסוג זה: c, r, u, d, או login. |
| resourceName | string | query | No | להחזיר רק אירועים עבור משאב זה, למשל User או Moderator. |
| targetId | string | query | No | להחזיר רק אירועים שהאובייקט המושפע שלהם בעל מזהה זה. |
| target | string | query | No | התאמה של תת‑מחרוזת ללא תלות ברישיות על תווית האובייקט המושפע, למשל שם משתמש או אימייל. |
| includeManagedTenants | boolean | query | No | להחזיר גם אירועים מדיירים שה‑tenant הזה מנהל. |
תגובה
מחזיר: GetAuditLogsResponse
דוגמה

logoutPublic 
תגובה
מחזיר: APIEmptyResponse
דוגמה

getBatchJob 
סטטוס, התקדמות ו, לאחר סיום, התוצאה של משימת אצווה אחת.
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
Response
Returns: GetBatchJobAPIResponse
Example

getBatchJobs 
The tenant's batch jobs (imports, exports, page migrations...), החדשות ביותר ראשונות.
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| type | string | query | No | רק עבודות מהסוג הזה, לדוגמה migrate-pages. |
| status | string | query | No | רק עבודות במצב זה: requested, running, success or failed. |
| skip | integer | query | No | כמה עבודות לדלג, עבור דפדוף. |
תגובה
מחזיר: GetBatchJobsAPIResponse
דוגמה

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

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

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

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

createCommentPublic 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| broadcastId | string | query | כן | |
| sessionId | string | query | לא | |
| sso | string | query | לא | |
| locale | string | query | לא |
תגובה
מחזיר: SaveCommentsResponseWithPresence
דוגמה

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

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

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

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

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

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

getCommentsPublic 
req tenantId urlId
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No | |
| questionId | string | query | No | |
| questionValue | integer | query | No |
תגובה
מחזיר: GetCommentsResponseWithPresencePublicComment
דוגמה

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

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

lockComment 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
תגובה
מחזיר: 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 | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
תשובה
מחזיר: PublicAPISetCommentTextResponse
דוגמה

translateComments 
מתרגם את ההערות הנתונות לשפת הווידג'ט. זמין רק כאשר כלל ההתאמה של הווידג'ט המתאים מוגדר לתרגום הערות אוטומטי או ידני.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| sso | string | query | לא | |
| locale | string | query | לא |
Response
Returns: CommentTranslationsResponse
Example

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

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

unLockComment 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Parameters
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Response
מחזיר: APIEmptyResponse
Example

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getEventLog 
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
דוגמה

getGlobalEventLog 
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
דוגמה

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

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

deleteFeedPostPublic 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
תשובה
מחזיר: 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 | לא |
תגובה
Returns: 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 | לא |
תגובה
Returns: ReactFeedPostResponse
דוגמה

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

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

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

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

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

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

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

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

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

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

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

getMe 
מזהה את פרטי ההתחברות בשימוש: הטננט שאליו הם שייכים ו, עבור אסימוני OAuth, המשתמש שאישר אותם. אינטגרציות משתמשות בכך כדי לבדוק חיבור ולתת לו תווית.
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: GetMeResponse
דוגמה

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

getApiComments 
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

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

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

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

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

getCommentChildren 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
תגובה
מחזיר: 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 | Yes | |
| sso | string | query | No |
תגובה
מחזיר: GetBannedUsersCountResponse
דוגמה

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

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

getManualBadgesForUser 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: 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 | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
תגובה
מחזיר: PreBanSummary
דוגמה

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

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

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

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

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

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

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

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

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

postApiExport 
פרמטרים
| 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
דוגמה

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 | Yes | |
| sso | string | query | No |
תגובה
Returns: APIEmptyResponse
דוגמה

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

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

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

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

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

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

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

postSetCommentSpamStatus 
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

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

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

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

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

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

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

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

deleteModerator 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: GetCachedNotificationCountResponse
דוגמה

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

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

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

createV1PageReact 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| title | string | query | לא | |
| sso | string | query | לא |
Response
Returns: CreateV1PageReact
Example

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

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

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

getV1PageLikes 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| sso | string | query | לא | |
| includeUserInfo | string | query | לא | כאשר מוגדר, מחזיר את המשתמשים שאהבו את העמוד (תמונות פרופיל ושמות משתמש). רק "public" מתקבל, מה שמסיר פרופילים פרטיים. |
תגובה
מחזיר: GetV1PageLikes
דוגמה

getV2PageReacts 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | כאשר מוגדר, מחזיר את המשתמשים עבור כל מזהה תגובה (תמונות פרופיל ושמות משתמש). רק "public" מתקבל, מה שמסיר פרופילים פרטיים. |
תגובה
מחזיר: GetV2PageReacts
דוגמה

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

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

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

getOfflineUsers 
מגיבים בעבר בדף שאינם מחוברים כרגע. ממוינים לפי displayName. השתמשו בזה לאחר אזילת /users/online כדי להציג מקטע "Members". עימוד באמצעות סמן (cursor) על commenterName: השרת ממשיך לאורך האינדקס החלקי {tenantId, urlId, commenterName} מ-afterName קדימה באמצעות $gt, ללא עלות $skip.
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | מזהה כתובת ה-URL של הדף (מנוקה בצד השרת). |
| afterName | string | query | לא | סמן: העבירו את nextAfterName מהתגובה הקודמת. |
| afterUserId | string | query | לא | שובר שוויון לסמן: העבירו את nextAfterUserId מהתגובה הקודמת. נדרש כאשר afterName מוגדר כדי ששמות זהים לא יגרמו להשמטת רשומות. |
תגובה
מחזיר: PageUsersOfflineResponse
דוגמה

getOnlineUsers 
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

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

getPageLikes 
ספירת לייקים לדף, באופן אופציונלי עם המשתמשים שלחצו לייק.
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן | |
| includeUserInfo | string | query | לא | "public" משמיט משתמשים עם פרופילים פרטיים, "include-private" כולל אותם. |
Response
מחזיר: GetPageLikesAPIResponse
Example

getPageReacts 
ספירות תגובות מותאמות אישית של react עבור דף, אופציונלית עם המשתמשים שהגיבו.
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | כן | |
| includeUserInfo | string | query | לא | "public" מדלג על משתמשים עם פרופילים פרטיים, "include-private" כולל אותם. |
תגובה
מחזיר: GetPageReactsAPIResponse
דוגמה

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

getPagesPublic 
רשימת דפים עבור דייר. משמש את לקוח השולחן העבודה של 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
דוגמה

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

migratePages 
מתור עבודת אצווה (batch job) שמעבירה תגובות, דפים ורשומות קשורות מ-urlId או דומיין אחד לאחר. העברות מסוג "urlId" מתאימות רק ל-urlId המדויק. העברות מסוג "domain" מבצעות חיפוש/החלפה של הערך בתוך כל urlId ו-url. יש לבצע Polling ל-GET /api/v1/batch-jobs/{batchJobId}: ברגע שהעבודה מסתיימת, היא כוללת תוצאות לכל העברה ו-undoId.
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תשובה
מחזיר: QueuePageMigrationJobAPIResponse
דוגמה

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

undoPageMigrations 
מכניס לתור משימת אצווה שמבטלת כל הגירה ממשימת migrate-pages אחת, מהחדשה ביותר. זמינה למשך 90 יום.
רשומות שהשתנו מאז ההגירה נותרות ללא שינוי, כך ששינוי מאוחר יותר לעולם לא יידרס.
בצע בקשת GET ל‑/api/v1/batch-jobs/{batchJobId} כדי לקבל את ספירות השחזורים/הדילוגים.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| undoId | string | path | Yes |
Response
Returns: QueuePageMigrationJobAPIResponse
Example

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

getPendingWebhookEventCount 
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
דוגמה

getPendingWebhookEvents 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | לא | |
| externalId | string | query | לא | |
| eventType | string | query | לא | |
| type | string | query | לא | |
| domain | string | query | לא | |
| attemptCountGT | number | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetPendingWebhookEventsResponse
דוגמה

createPollVote 
רשום הצבעה בסקר, או העבר הצבעה קיימת לאופציה אחרת. לכל מצביע יש לכל היותר הצבעה אחת לכל סקר, ולכן קריאה חוזרת לפעולה עבור אותו מצביע מעבירה את הצביעתו במקום להוסיף הצבעה חדשה.
זה מציית להגדרות הסקר של האתר: אם ההצבעה מוגדרת למשתמשים מחוברים בלבד, הצבעה עם רק anonUserId תידחה, והצבעות אנונימיות מוגבלות בקצב לפי IP לכל סקר.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Returns: CreatePollVoteResponse
Example

deletePollVote 
הסרת הצבעה. האפשרות עליה הוצבעה מחזירה את הספירה שלה.
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
Response
מחזיר: DeletePollVoteResponse
Example

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

getPollVotes 
הקולות הבודדים מאחורי ספירות הסקר, מהישן לחדש.
סקר שייך לתגובה, ולכן קולות נקראים תמיד סקר אחד בכל פעם - commentId נדרש. זה מבטיח שכל שאילתה משתמשת באינדקסים שכבר קיימים באוסף.
מכבד את פרטיות הסקר: לא ניתן לקרוא את הקולות של סקר אנונימי (poll-anonymous), כאן או לפי מזהה.
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | כן | |
| voterId | string | query | לא | |
| optionId | string | query | לא | |
| skip | integer | query | לא |
תגובה
מחזיר: GetPollVotesResponse
דוגמה

deletePoll 
הסרת הסקר מהתגובה שלו, יחד עם כל ההצבעות שנערכו בו. התגובה עצמה נשארת ללא שינוי.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Response
מחזיר: APIEmptyResponse
Example

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

getPollVoters 
מי הצביע על איזו אפשרות. סקרים אנונימיים אף פעם לא משיבים, סקרים המיועדים למנהלים בלבד משיבים רק למנהל או למנחה.
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: GetPollVoterNamesSuccessResponse
דוגמה

patchPoll 
ערוך סקר במקום, תוך שמירה על הספירות שלו: שנה את השאלה, שנה תווית של אפשרות, סגור או פתח אותו מחדש, או שנה מי יכול לראות את המצביעים. אפשרויות מזוהות לפי מזהה - כדי להוסיף, להסיר או לסדר מחדש אותן, השתמש ב‑PUT על הרשימה המלאה.
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| commentId | string | נתיב | כן |
Response
Returns: SavePollResponse
Example

putPoll 
צירוף סקר לתגובה, או הגדרת המצב המלא של הסקר שכבר קיים.
האפשרויות מתואמות לפי מזהה: אפשרות שנשלחת עם המזהה של אפשרות קיימת שומרת את הקולות שלה (ולקחת את התווית והמיקום החדשים), אפשרות שנשלחת ללא מזהה מתווספת, והאפשרויות הקיימות שהושמטו מהרשימה מוסרות יחד עם הקולות שהושמעו עליהן.
שמירת אפס מזהי אפשרויות קיימות בסקר שיש לו קולות מוחקת את כולן, ולכן יש צורך ב‑replaceVotes=true.
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| replaceVotes | boolean | query | No |
Response
Returns: SavePollResponse
Example

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

createQuestionConfig 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes |
תגובה
מחזיר: 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 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| id | string | path | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

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

getQuestionResults 
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
דוגמה

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

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

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

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

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

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

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

getSSOUserById 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateSubscriptionAPIResponse
דוגמה

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

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

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

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

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

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

getTenantPackage 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | שאילתה | כן | |
| id | string | נתיב | כן |
תגובה
מחזיר: APIEmptyResponse
דוגמה

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

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

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

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

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

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

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

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

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

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

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

updateTenant 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
תגובה
Returns: APIEmptyResponse
דוגמה

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

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

getTicket 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Yes | |
| sizePreset | string | query | No | פרמטר גודל: "Default" (1000x1000px) או "CrossPlatform" (יוצר גדלים למכשירים פופולריים) |
| urlId | string | query | No | מזהה דף שממ ממנו מתבצע ההעלאה, לתצורה |
תגובה
Returns: UploadImageResponse
דוגמה

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

getUserBadgeProgressByUserId 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Yes | |
| id | string | path | Yes |
תגובה
מחזיר: APIEmptySuccessResponse
דוגמה

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

getUserBadges 
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

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

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

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

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

resetUserNotifications 
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
דוגמה

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

updateUserNotificationPageSubscriptionStatus 
הפעל או השבת התראות עבור עמוד. כאשר משתמשים מנויים לעמוד, נוצרות התראות להערות שורש חדשות, וגם
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| 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 
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

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

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

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

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

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

createWebhook 
מנוי על כתובת URL לאירוע תגובה (מנוי REST hook). מנוי על אותה כתובת URL לאותו אירוע ולדומיין שוב מחזיר את המנוי הקיים. המשלוחים חתומים ב‑HMAC, ראו את מדריך ה‑webhooks; כותרת token הישנה לעולם אינה נשלחת למנויים ב‑API.
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן |
תגובה
מחזיר: CreateWebhookResponse
דוגמה

deleteWebhook 
ביטול מנויים (REST hook unsubscribe). רק מנויים שנוצרו דרך API זה ניתנים למחיקה כאן; וובהוקים שמנוהלים דרך לוח הבקרה נערכים בלוח הבקרה.
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
תגובה
Returns: APIEmptyResponse
דוגמה

getWebhooks 
רשימת ה-webhooks המוגדרים עבור ה-tenant, כולל שורות מנוהלות בלוח המחוונים ומנויים דרך ה-API.
Parameters
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| event | string | query | לא | |
| domain | string | query | לא | |
| source | string | query | לא | |
| skip | number | query | לא |
Response
מחזיר: GetWebhooksResponse
דוגמה

getWebhookSamplePayloads 
התגובות האחרונות בדיוק בצורה שבה משלוחי webhook משתמשים, לבניית אינטגרציות (לדוגמה נתוני דוגמה של Zapier). כל אירוע מספק את אותו אובייקט תגובה, ולכן event צריך להיות תקף בלבד.
Parameters
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| event | string | query | לא | |
| limit | number | query | לא |
Response
מחזיר: GetWebhookSamplePayloadsResponse
Example

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