
שפה 🇮🇱 עברית
התחלה
תיעוד
שימוש
אגרגציה
יומני ביקורת
חסימה מתוך תגובה
בדיקת תגובות חסומות
תגובות
הגדרות דומיין
תבניות אימייל
יומן אירועים
פוסטים בפיד
דיווח על תגובה
האשטאגים
מודרטורים
ספירת התראות
התראות
דפים
אירועי webhook בהמתנה
הגדרות שאלות
תוצאות שאלות
אגרגציית תוצאות שאלות
משתמשי SSO
מנויים
שימוש יומי של שוכר
חבילות שוכרים
משתמשי שוכר
שוכרים
כרטיסים
העלאת תמונה
התקדמות תג משתמש
תגי משתמש
התראות משתמש
סטטוס נוכחות משתמש
חיפוש משתמשים
משתמשים
הצבעות
FastComments SDK ל‑Ruby
זהו ה-SDK הרשמי של Ruby עבור FastComments.
ה-SDK הרשמי של Ruby עבור ה-API של FastComments
מאגר
התקנה 
הוסף שורה זו ל-Gemfile של היישום שלך:
gem 'fastcomments'
ואז הרץ:
bundle install
או התקן אותו בעצמך כך:
gem install fastcomments
תכולת הספרייה
ספרייה זו מכילה את לקוח ה-API שנוצר ואת כלי ה-SSO כדי להקל על העבודה עם ה-API.
APIs ציבוריים לעומת מאובטחים
עבור לקוח ה-API יש שתי מחלקות, DefaultApi ו-PublicApi. ה-DefaultApi מכילה שיטות שדורשות את מפתח ה-API שלך, ו- PublicApi מכילה קריאות API שניתן לבצע ישירות מדפדפן/מכשיר נייד/וכו' ללא אימות.
התחלה מהירה 
שימוש ב-APIs מאומתים (DefaultApi)
חשוב: עליך להגדיר את מפתח ה-API ב-ApiClient לפני ביצוע בקשות מאומתות. אם לא תעשה זאת, הבקשות יחזרו עם שגיאת 401.
require 'fastcomments-client'
# צור והגדר את לקוח ה-API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# דרוש: הגדר את מפתח ה-API שלך (קבל אותו מדשבורד FastComments שלך)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# צור את מופע ה-API עם הלקוח שהוגדר
api = FastCommentsClient::DefaultApi.new(api_client)
# עכשיו תוכל לבצע קריאות API מאומתות
begin
# דוגמה: הוסף משתמש SSO
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# שגיאות נפוצות:
# - 401: מפתח ה-API חסר או לא תקף
# - 400: אימות הבקשה נכשל
end
שימוש ב-APIs ציבוריים (PublicApi)
נקודות קצה ציבוריות אינן דורשות אימות:
require 'fastcomments-client'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
tenant_id: 'YOUR_TENANT_ID',
url_id: 'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
בעיות נפוצות
- שגיאת 401 "missing-api-key": ודא שאתה מגדיר
config.api_key['x-api-key'] = 'YOUR_KEY'לפני יצירת מופע DefaultApi. - מחלקת API שגויה: השתמש ב-
DefaultApiעבור בקשות מאומתות בצד השרת, וב-PublicApiעבור בקשות בצד הלקוח/ציבוריות. - מפתח API ריק: ה-SDK פשוט ידלג על אימות אם מפתח ה-API הוא null, מה שייגרום לשגיאות 401.
הערות 
מזהי שידור
תראה שעליך להעביר broadcastId בחלק מקריאות ה-API. כשאתה מקבל אירועים, תקבל את המזהה הזה בחזרה, כך תדע להתעלם מהאירוע אם אתה מתכנן להחיל שינויים באופן אופטימי בצד הלקוח
(סביר שתרצה לעשות זאת מכיוון שזה מספק את חוויית המשתמש הטובה ביותר). העבר כאן UUID. המזהה צריך להיות ייחודי מספיק כדי שלא יופיע פעמיים במהלך מושב בדפדפן.
SSO (כניסה אחידה)
לדוגמאות ל-SSO, ראה למטה.
שימוש ב-SSO 
SSO פשוט
require 'fastcomments'
require 'fastcomments-client'
# צור אסימון SSO פשוט
user = FastComments::SSO::SimpleSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
avatar: 'https://example.com/avatar.jpg'
)
sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token
puts "SSO Token: #{token}"
# השתמש באסימון SSO כדי לבצע קריאת API מאומתת
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
SSO מאובטח
require 'fastcomments'
require 'fastcomments-client'
# צור אסימון SSO מאובטח
user = FastComments::SSO::SecureSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
username: 'johndoe',
avatar: 'https://example.com/avatar.jpg'
)
api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token
puts "Secure SSO Token: #{token}"
# השתמש באסימון SSO כדי לבצע קריאת API מאומתת
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
אגרגציה 
מאגד מסמכים על ידי קיבוץ שלהם (אם groupBy נמסר) ויישום מספר פעולות. נתמכות פעולות שונות (למשל sum, countDistinct, avg וכו').
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| parentTenantId | string | query | לא | |
| includeStats | boolean | query | לא |
תגובה
מחזיר: AggregationResponse
דוגמה

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

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

הסרת חסימה מתגובה (ציבורי) 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
תגובה
מחזיר: UnBlockCommentPublic200Response
דוגמה

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

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

יצירת תגובה (ציבורי) 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| broadcastId | string | query | כן | |
| sessionId | string | query | לא | |
| sso | string | query | לא |
Response
מחזיר: CreateCommentPublic200Response
דוגמה

מחיקת תגובה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
תגובה
מחזיר: DeleteComment200Response
דוגמה

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

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

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

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

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

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

קבלת תגובות 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| page | integer | query | לא | |
| limit | integer | query | לא | |
| skip | integer | query | לא | |
| asTree | boolean | query | לא | |
| skipChildren | integer | query | לא | |
| limitChildren | integer | query | לא | |
| maxTreeDepth | integer | query | לא | |
| urlId | string | query | לא | |
| userId | string | query | לא | |
| anonUserId | string | query | לא | |
| contextUserId | string | query | לא | |
| hashTag | string | query | לא | |
| parentId | string | query | לא | |
| direction | string | query | לא |
תגובה
מחזיר: GetComments200Response
דוגמה

קבלת תגובות (ציבורי) 
req tenantId urlId
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | נתיב | כן | |
| urlId | string | שאילתה | כן | |
| page | integer | שאילתה | לא | |
| direction | string | שאילתה | לא | |
| sso | string | שאילתה | לא | |
| skip | integer | שאילתה | לא | |
| skipChildren | integer | שאילתה | לא | |
| limit | integer | שאילתה | לא | |
| limitChildren | integer | שאילתה | לא | |
| countChildren | boolean | שאילתה | לא | |
| fetchPageForCommentId | string | שאילתה | לא | |
| includeConfig | boolean | שאילתה | לא | |
| countAll | boolean | שאילתה | לא | |
| includei10n | boolean | שאילתה | לא | |
| locale | string | שאילתה | לא | |
| modules | string | שאילתה | לא | |
| isCrawler | boolean | שאילתה | לא | |
| includeNotificationCount | boolean | שאילתה | לא | |
| asTree | boolean | שאילתה | לא | |
| maxTreeDepth | integer | שאילתה | לא | |
| useFullTranslationIds | boolean | שאילתה | לא | |
| parentId | string | שאילתה | לא | |
| searchText | string | שאילתה | לא | |
| hashTags | array | שאילתה | לא | |
| userId | string | שאילתה | לא | |
| customConfigStr | string | שאילתה | לא | |
| afterCommentId | string | שאילתה | לא | |
| beforeCommentId | string | שאילתה | לא |
תגובה
מחזיר: GetCommentsPublic200Response
דוגמה

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

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

שמירת תגובה 
פרמטרים
| שם | סוג | מיקום | חובה | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| isLive | boolean | query | לא | |
| doSpamCheck | boolean | query | לא | |
| sendEmails | boolean | query | לא | |
| populateNotifications | boolean | query | לא |
תגובה
מחזיר: SaveComment200Response
דוגמה

שמירת תגובות באצווה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| isLive | boolean | query | לא | |
| doSpamCheck | boolean | query | לא | |
| sendEmails | boolean | query | לא | |
| populateNotifications | boolean | query | לא |
תגובה
מחזיר: Array<SaveComment200Response>
דוגמה

הגדרת טקסט תגובה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
תגובה
מחזיר: SetCommentText200Response
דוגמה

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

קבלת יומן אירועים גלובלי 
req tenantId urlId userIdWS
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| urlId | string | query | כן | |
| userIdWS | string | query | כן | |
| startTime | integer | query | כן | |
| endTime | integer | query | כן |
תגובה
מחזיר: GetEventLog200Response
דוגמה

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

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

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

קבלת פוסטים בפיד 
req tenantId afterId
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| afterId | string | query | לא | |
| limit | integer | query | לא | |
| tags | array | query | לא |
תגובה
מחזיר: GetFeedPosts200Response
דוגמה

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

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

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

הוספת ריאקציה לפוסט בפיד (ציבורי) 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| postId | string | path | כן | |
| isUndo | boolean | query | לא | |
| broadcastId | string | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ReactFeedPostPublic200Response
דוגמה

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

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

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

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

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

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

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

עדכון חלקי של האשטאג 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Yes | |
| tenantId | string | query | No |
תגובה
Returns: PatchHashTag200Response
דוגמה

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

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

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

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

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

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

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

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

קבלת ספירת התראות 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| urlId | string | query | לא | |
| fromCommentId | string | query | לא | |
| viewed | boolean | query | לא | |
| type | string | query | לא |
תגובה
מחזיר: GetNotificationCount200Response
דוגמה

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

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

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

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

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

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

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

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

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

קבלת אירועי 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 | לא |
תגובה
מחזיר: GetPendingWebhookEvents200Response
דוגמה

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

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

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

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

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

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

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

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

קבלת תוצאות שאלות 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| urlId | string | query | לא | |
| userId | string | query | לא | |
| startDate | string | query | לא | |
| questionId | string | query | לא | |
| questionIds | string | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetQuestionResults200Response
דוגמה

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

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

אגרגציה גורפת של תוצאות שאלות 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | שאילתה | כן | |
| forceRecalculate | boolean | שאילתה | לא |
תגובה
מחזיר: BulkAggregateQuestionResults200Response
דוגמה

שילוב תגובות עם תוצאות שאלות 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| questionId | string | query | לא | |
| questionIds | array | query | לא | |
| urlId | string | query | לא | |
| startDate | string | query | לא | |
| forceRecalculate | boolean | query | לא | |
| minValue | number | query | לא | |
| maxValue | number | query | לא | |
| limit | number | query | לא |
תגובה
מחזיר: CombineCommentsWithQuestionResults200Response
דוגמה

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

העלאת תמונה 
העלאה ושינוי גודל תמונה
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | כן | |
| sizePreset | string | query | לא | ערכת גודל: "Default" (1000x1000px) או "CrossPlatform" (יוצר גדלים למכשירים פופולריים) |
| urlId | string | query | לא | מזהה העמוד שממנו מתבצעת ההעלאה, לצורך קונפיגורציה |
תגובה
מחזיר: UploadImageResponse
דוגמה

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

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

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

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

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

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

קבלת תגי משתמש 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| userId | string | query | לא | |
| badgeId | string | query | לא | |
| type | number | query | לא | |
| displayedOnComments | boolean | query | לא | |
| limit | number | query | לא | |
| skip | number | query | לא |
תגובה
מחזיר: GetUserBadges200Response
דוגמה

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

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

קבלת התראות משתמש 
פרמטרים
| שם | סוג | מיקום | נדרש | תיאור |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| pageSize | integer | query | לא | |
| afterId | string | query | לא | |
| includeContext | boolean | query | לא | |
| afterCreatedAt | integer | query | לא | |
| unreadOnly | boolean | query | לא | |
| dmOnly | boolean | query | לא | |
| noDm | boolean | query | לא | |
| includeTranslations | boolean | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: GetUserNotifications200Response
דוגמה

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

איפוס התראות משתמש 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| afterId | string | query | לא | |
| afterCreatedAt | integer | query | לא | |
| unreadOnly | boolean | query | לא | |
| dmOnly | boolean | query | לא | |
| noDm | boolean | query | לא | |
| sso | string | query | לא |
תגובה
מחזיר: ResetUserNotifications200Response
דוגמה

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

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

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

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

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

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

יצירת הצבעה 
פרמטרים
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | כן | |
| commentId | string | query | כן | |
| direction | string | query | כן | |
| userId | string | query | לא | |
| anonUserId | string | query | לא |
תגובה
מחזיר: VoteComment200Response
דוגמה

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

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

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

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