
Γλώσσα 🇨🇾 Ελληνικά (Κύπρος)
Τεκμηρίωση
Ξεκινώντας
Αναφορά API
Χρήση
Συγκεντρωτικά
Καταγραφές ελέγχου
Αυθεντικοποίηση
Αποκλεισμός από σχόλιο
Έλεγχος αποκλεισμένων σχολίων
Σχόλια
Σχόλια για χρήστη
Ρυθμίσεις τομέα
Πρότυπα email
Καταγραφή συμβάντων
Αναρτήσεις
Σήμανση σχολίου
GIFs
Hashtags
Διαχείριση
Διαχειριστές
Πλήθος ειδοποιήσεων
Ειδοποιήσεις
Αντιδράσεις σε σελίδα
Σελίδες
Εκκρεμή γεγονότα webhook
Ρυθμίσεις ερωτήσεων
Αποτελέσματα ερωτήσεων
Συγκέντρωση αποτελεσμάτων ερωτήσεων
Χρήστες SSO
Συνδρομές
Ημερήσια χρήση tenant
Πακέτα tenant
Χρήστες tenant
Tenants
Εισιτήρια
Μεταφράσεις
Μεταφόρτωση εικόνας
Πρόοδος επιβράβευσης χρήστη
Διακριτικά χρήστη
Ειδοποιήσεις χρήστη
Καταστάσεις παρουσίας χρήστη
Αναζήτηση χρηστών
Χρήστες
Ψήφοι
FastComments SDK για Nim
Αυτό είναι το επίσημο Nim SDK για το FastComments.
Επίσημο Nim SDK για το API του FastComments
Αποθετήριο
Εγκατάσταση 
Χρήση Nimble
nimble install fastcomments
Κατασκευή από Πηγαίο Κώδικα
nimble build
Περιεχόμενα Βιβλιοθήκης
Αυτή η βιβλιοθήκη περιέχει τον παραγμένο πελάτη API και τα βοηθητικά SSO που κάνουν τη χρήση του API ευκολότερη.
Δημόσια έναντι προστατευόμενων API
Για τον πελάτη API, υπάρχουν τρία modules API, api_default, api_public, και api_moderation. Το api_default περιέχει μεθόδους που απαιτούν το API key σας, και το api_public περιέχει κλήσεις API που μπορούν να γίνουν απευθείας από ένα πρόγραμμα περιήγησης/κινητή συσκευή/κ.λπ. χωρίς αυθεντικοποίηση. Το module api_moderation περιέχει μεθόδους για τον πίνακα ελέγχου του moderator.
Οι μέθοδοι του api_moderation καλύπτουν τη δημιουργία λιστών, τη μέτρηση, την αναζήτηση και την εξαγωγή σχολίων και των αρχείων καταγραφής τους; ενέργειες μετριασμού όπως αφαίρεση/επανόρθωση σχολίων, σηματοδότηση, ορισμός κατάστασης για ανασκόπηση/spam/έγκριση, προσαρμογή ψήφων και επανάνοιγμα/κλείσιμο νημάτων; απαγορεύσεις (απαγόρευση χρήστη από ένα σχόλιο, αναίρεση απαγόρευσης, προ-συνοπτικές αναφορές πριν την απαγόρευση, κατάσταση και προτιμήσεις απαγόρευσης, και πλήθος απαγορευμένων χρηστών); και διακριτικά & αξιοπιστία (απονομή/αφαίρεση διακριτικού, λίστα χειροκίνητων διακριτικών, ανάκτηση/ρύθμιση του παράγοντα εμπιστοσύνης ενός χρήστη, και λήψη του εσωτερικού προφίλ ενός χρήστη). Κάθε μέθοδος του api_moderation δέχεται μία παράμετρο sso ώστε η κλήση να είναι αυθεντικοποιημένη ως συντονιστής μέσω SSO.
Γρήγορη εκκίνηση 
Χρήση Αυθεντικοποιημένων API (DefaultAPI)
Σημαντικό: Τα αυθεντικοποιημένα endpoints απαιτούν το API key σας να οριστεί στην κεφαλίδα x-api-key.
import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
# Κάντε αυθεντικοποιημένες κλήσεις API
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
page = 0,
limit = 0,
skip = 0,
asTree = false,
skipChildren = 0,
limitChildren = 0,
maxTreeDepth = 0,
urlId = "your-url-id",
userId = "",
anonUserId = "",
contextUserId = "",
hashTag = "",
parentId = "",
direction = SortDirections.DESC
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Χρήση Δημόσιων API (PublicAPI)
Τα δημόσια endpoints δεν απαιτούν αυθεντικοποίηση:
import httpclient
import fastcomments
import fastcomments/apis/api_public
let client = newHttpClient()
# Κάντε δημόσιες κλήσεις API
let (response, httpResponse) = getCommentsPublic(
httpClient = client,
tenantId = "your-tenant-id",
urlId = "your-url-id",
page = 0,
direction = SortDirections.DESC,
sso = "",
skip = 0,
skipChildren = 0,
limit = 0,
limitChildren = 0,
countChildren = false,
fetchPageForCommentId = "",
includeConfig = false,
countAll = false,
includei10n = false,
locale = "",
modules = "",
isCrawler = false,
includeNotificationCount = false,
asTree = false,
maxTreeDepth = 0,
useFullTranslationIds = false,
parentId = "",
searchText = "",
hashTags = @[],
userId = "",
customConfigStr = "",
afterCommentId = "",
beforeCommentId = ""
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Χρήση API Εποπτείας (ModerationAPI)
Τα endpoints εποπτείας τροφοδοτούν τον πίνακα ελέγχου των συντονιστών και αυθεντικοποιούνται με ένα SSO token για τον συντονιστή που ενεργεί:
import httpclient
import fastcomments
import fastcomments/apis/api_moderation
let client = newHttpClient()
# Λίστα σχολίων στον πίνακα ελέγχου εποπτείας
let (response, httpResponse) = getApiComments(
httpClient = client,
page = 0,
count = 30,
textSearch = "",
byIPFromComment = "",
filters = "",
searchFilters = "",
sorts = "",
demo = false,
sso = "your-sso-token"
)
if response.isSome:
let resp = response.get()
echo "Found ", resp.comments.len, " comments"
Συνηθισμένα Προβλήματα
- 401 authentication error: Βεβαιωθείτε ότι έχετε ορίσει την κεφαλίδα
x-api-keyστο HttpClient σας πριν κάνετε κλήσεις στην DefaultAPI:client.headers["x-api-key"] = "your-api-key" - Wrong API class: Χρησιμοποιήστε
api_defaultγια server-side αυθεντικοποιημένες αιτήσεις,api_publicγια client-side/δημόσιες αιτήσεις, καιapi_moderationγια αιτήσεις του πίνακα ελέγχου των συντονιστών.
Κλήσεις API 
Όλες οι μέθοδοι API σε αυτό το SDK επιστρέφουν πλειάδες (Option[ResponseType], Response). Το πρώτο στοιχείο περιέχει την αναλυμένη απάντηση σε περίπτωση επιτυχίας, και το δεύτερο στοιχείο είναι η ακατέργαστη HTTP απάντηση.
Παράδειγμα: Ανάκτηση Σχολίων
import httpclient
import options
import fastcomments
import fastcomments/apis/api_default
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
page = 0,
limit = 0,
skip = 0,
asTree = false,
skipChildren = 0,
limitChildren = 0,
maxTreeDepth = 0,
urlId = "your-url-id",
userId = "",
anonUserId = "",
contextUserId = "",
hashTag = "",
parentId = "",
direction = SortDirections.DESC
)
if httpResponse.code == Http200:
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Σημειώσεις 
Αναγνωριστικά Broadcast
Θα δείτε ότι πρέπει να περάσετε ένα broadcastId σε κάποιες κλήσεις API. Όταν λαμβάνετε events, θα πάρετε αυτό το ID πίσω, ώστε να ξέρετε να αγνοήσετε το event εάν σκοπεύετε να εφαρμόσετε αλλαγές στον πελάτη με αισιοδοξία (κάτι που πιθανότατα θα θελήσετε να κάνετε αφού προσφέρει την καλύτερη εμπειρία). Περνάτε ένα UUID εδώ. Το ID πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές σε μία συνεδρία προγράμματος περιήγησης.
SSO (Ενιαία Σύνδεση)
Για παραδείγματα SSO, δείτε παρακάτω.
Χρήση SSO 
Απλό SSO
import fastcomments/sso
let user = newSimpleSSOUserData(
userId = "user-123",
email = "user@example.com",
avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()
echo "SSO Token: ", token
Ασφαλές SSO
import fastcomments/sso
let user = newSecureSSOUserData(
userId = "user-123",
email = "user@example.com",
username = "johndoe",
avatar = "https://example.com/avatar.jpg"
)
let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()
echo "Secure SSO Token: ", token
Τεκμηρίωση για fastcomments 
Τεκμηρίωση για τα API Endpoints
Όλα τα URI είναι σχετικά με https://fastcomments.com
| Κλάση | Μέθοδος | HTTP αίτημα | Περιγραφή |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | Συγκεντρώνει έγγραφα ομαδοποιώντας τα (εάν παρέχεται το groupBy) και εφαρμόζοντας πολλαπλές λειτουργίες. Υποστηρίζονται διάφορες λειτουργίες (π.χ. sum, countDistinct, avg, κ.λπ.). |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | απαιτεί tenantId afterId |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/set-trust-factor | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | απαιτεί tenantId urlId |
| PublicApi | getEventLog | GET /event-log/{tenantId} | απαιτεί tenantId urlId userIdWS |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | απαιτεί tenantId afterId |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | απαιτεί tenantId urlId userIdWS |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | Χρήστες που έχουν σχολιάσει στη σελίδα στο παρελθόν αλλά ΔΕΝ είναι αυτή τη στιγμή online. Ταξινομημένοι με βάση το displayName. Χρησιμοποιήστε το μετά τη χρήση του /users/online για να εμφανίσετε ενότητα "Μέλη". Υποστήριξη cursor pagination στο commenterName: το σύστημα περιηγείται στο μερικό index {tenantId, urlId, commenterName} από το afterName και εμπρός μέσω $gt, χωρίς κόστος $skip. |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | Οι χρήστες που παρακολουθούν αυτή τη στιγμή τη σελίδα: άτομα των οποίων το websocket session είναι εγγεγραμμένο στη σελίδα τώρα. Επιστρέφει anonCount + totalCount (συνολικοί συνδρομητές, συμπεριλαμβανομένων ανώνυμων που δεν απαριθμούνται). |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | Λίστα σελίδων για έναν tenant. Χρησιμοποιείται από τον FChat desktop client για να γεμίσει τη λίστα των δωματίων του. Απαιτείται enableFChat να είναι true στη ρυθμισμένη custom config για κάθε σελίδα. Σελίδες που απαιτούν SSO φιλτράρονται με βάση την πρόσβαση ομάδας του χρήστη που κάνει το αίτημα. |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | getUsersInfo | GET /pages/{tenantId}/users/info | Μαζική πληροφορία χρηστών για έναν tenant. Δίνονται τα userIds, επιστρέφει πληροφορίες προβολής από User / SSOUser. Χρησιμοποιείται από το comment widget για να εμπλουτίσει χρήστες που μόλις εμφανίστηκαν μέσω presence event. Χωρίς συγκείμενο σελίδας: η ιδιωτικότητα εφαρμόζεται ομοιόμορφα (προφίλ που είναι ιδιωτικά κρύβονται). |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | Ενεργοποίηση ή απενεργοποίηση ειδοποιήσεων για ένα συγκεκριμένο σχόλιο. |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | Ενεργοποίηση ή απενεργοποίηση ειδοποιήσεων για μια σελίδα. Όταν οι χρήστες είναι εγγεγραμμένοι σε μια σελίδα, δημιουργούνται ειδοποιήσεις για νέα βασικά σχόλια, καθώς και |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | Μεταφόρτωση και αλλαγή μεγέθους εικόνας |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Τεκμηρίωση για τα Μοντέλα
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBase_meta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponse_anyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequest_sort
- AggregationResponse
- AggregationResponse_stats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchType
- BannedUserMatch_matchedOnValue
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBody_tags_inner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponse_results_inner
- BulkPreBanParams
- BulkPreBanSummary
- ChangeCommentPinStatusResponse
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CommentsByIdsParams
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPostParams
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadgeParams
- CreateV1PageReact
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentResult
- DeleteDomainConfigResponse
- DeleteFeedPostPublicResponse
aggregate 
Συγκεντρώνει έγγραφα ομαδοποιώντας τα (αν παρέχεται groupBy) και εφαρμόζοντας πολλαπλές λειτουργίες. Υποστηρίζονται διάφορες λειτουργίες (π.χ. sum, countDistinct, avg, κ.λπ.).
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| aggregationRequest | AggregationRequest | Όχι | |
| parentTenantId | string | Όχι | |
| includeStats | bool | Όχι |
Απόκριση
Επιστρέφει: Option[AggregateResponse]
Παράδειγμα

getAuditLogs 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| limit | float64 | Όχι | |
| skip | float64 | Όχι | |
| order | SORTDIR | Όχι | |
| after | float64 | Όχι | |
| before | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetAuditLogsResponse]
Παράδειγμα

logoutPublic 
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

blockFromCommentPublic 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[BlockSuccess]
Παράδειγμα

unBlockCommentPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[UnblockSuccess]
Παράδειγμα

checkedCommentsForBlocked 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentIds | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[CheckBlockedCommentsResponse]
Παράδειγμα

blockUserFromComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| blockFromCommentParams | BlockFromCommentParams | Όχι | |
| userId | string | Όχι | |
| anonUserId | string | Όχι |
Απόκριση
Επιστρέφει: Option[BlockSuccess]
Παράδειγμα

createCommentPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| broadcastId | string | Όχι | |
| commentData | CommentData | Όχι | |
| sessionId | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[SaveCommentsResponseWithPresence]
Παράδειγμα

deleteComment 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| contextUserId | string | Όχι | |
| isLive | bool | Όχι |
Απόκριση
Επιστρέφει: Option[DeleteCommentResult]
Παράδειγμα

deleteCommentPublic 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| broadcastId | string | Όχι | |
| editKey | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[PublicAPIDeleteCommentResponse]
Παράδειγμα

deleteCommentVote 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| voteId | string | Όχι | |
| urlId | string | Ναι | |
| broadcastId | string | Όχι | |
| editKey | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[VoteDeleteResponse]
Παράδειγμα

flagComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| userId | string | Όχι | |
| anonUserId | string | Όχι |
Απάντηση
Επιστρέφει: Option[FlagCommentResponse]
Παράδειγμα

getComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIGetCommentResponse]
Παράδειγμα

getComments 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| page | int | Όχι | |
| limit | int | Όχι | |
| skip | int | Όχι | |
| asTree | bool | Όχι | |
| skipChildren | int | Όχι | |
| limitChildren | int | Όχι | |
| maxTreeDepth | int | Όχι | |
| urlId | string | Ναι | |
| userId | string | Όχι | |
| anonUserId | string | Όχι | |
| contextUserId | string | Όχι | |
| hashTag | string | Όχι | |
| parentId | string | Όχι | |
| direction | SortDirections | Όχι | |
| fromDate | int64 | Όχι | |
| toDate | int64 | Όχι |
Απόκριση
Επιστρέφει: Option[APIGetCommentsResponse]
Παράδειγμα

getCommentsPublic 
Απαιτούμενα tenantId urlId
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| page | int | Όχι | |
| direction | SortDirections | Όχι | |
| sso | string | Όχι | |
| skip | int | Όχι | |
| skipChildren | int | Όχι | |
| limit | int | Όχι | |
| limitChildren | int | Όχι | |
| countChildren | bool | Όχι | |
| fetchPageForCommentId | string | Όχι | |
| includeConfig | bool | Όχι | |
| countAll | bool | Όχι | |
| includei10n | bool | Όχι | |
| locale | string | Όχι | |
| modules | string | Όχι | |
| isCrawler | bool | Όχι | |
| includeNotificationCount | bool | Όχι | |
| asTree | bool | Όχι | |
| maxTreeDepth | int | Όχι | |
| useFullTranslationIds | bool | Όχι | |
| parentId | string | Όχι | |
| searchText | string | Όχι | |
| hashTags | seq[string] | Όχι | |
| userId | string | Όχι | |
| customConfigStr | string | Όχι | |
| afterCommentId | string | Όχι | |
| beforeCommentId | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetCommentsResponseWithPresencePublicComment]
Παράδειγμα

getCommentText 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| editKey | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[PublicAPIGetCommentTextResponse]
Παράδειγμα

getCommentVoteUserNames 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| dir | int | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[GetCommentVoteUserNamesSuccessResponse]
Παράδειγμα

lockComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| broadcastId | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

pinComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| broadcastId | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ChangeCommentPinStatusResponse]
Παράδειγμα

saveComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createCommentParams | CreateCommentParams | Όχι | |
| isLive | bool | Όχι | |
| doSpamCheck | bool | Όχι | |
| sendEmails | bool | Όχι | |
| populateNotifications | bool | Όχι |
Απόκριση
Επιστρέφει: Option[APISaveCommentResponse]
Παράδειγμα

saveCommentsBulk 
Παράμετροι
| Name | Type | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createCommentParams | seq[CreateCommentParams] | Όχι | |
| isLive | bool | Όχι | |
| doSpamCheck | bool | Όχι | |
| sendEmails | bool | Όχι | |
| populateNotifications | bool): (Option[seq[SaveCommentsBulkResponse]] | Όχι | |
| id | string | Όχι | |
| fromName | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

setCommentText 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| broadcastId | string | Όχι | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Όχι | |
| editKey | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[PublicAPISetCommentTextResponse]
Παράδειγμα

unBlockUserFromComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Όχι | |
| userId | string | Όχι | |
| anonUserId | string | Όχι |
Απάντηση
Επιστρέφει: Option[UnblockSuccess]
Παράδειγμα

unFlagComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| userId | string | Όχι | |
| anonUserId | string | Όχι |
Απόκριση
Επιστρέφει: Option[FlagCommentResponse]
Παράδειγμα

unLockComment 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| broadcastId | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

unPinComment 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | No | |
| sso | string | No |
Απόκριση
Επιστρέφει: Option[ChangeCommentPinStatusResponse]
Παράδειγμα

updateComment 
Παράμετροι
| Name | Type | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updatableCommentParams | UpdatableCommentParams | Όχι | |
| contextUserId | string | Όχι | |
| doSpamCheck | bool | Όχι | |
| isLive | bool | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

voteComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| urlId | string | Ναι | |
| broadcastId | string | Όχι | |
| voteBodyParams | VoteBodyParams | Όχι | |
| sessionId | string | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[VoteResponse]
Παράδειγμα

getCommentsForUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| userId | string | Όχι | |
| direction | SortDirections | Όχι | |
| repliesToUserId | string | Όχι | |
| page | float64 | Όχι | |
| includei10n | bool | Όχι | |
| locale | string | Όχι | |
| isCrawler | bool | Όχι |
Απόκριση
Επιστρέφει: Option[GetCommentsForUserResponse]
Παράδειγμα

addDomainConfig 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| addDomainConfigParams | AddDomainConfigParams | Όχι |
Απόκριση
Επιστρέφει: Option[AddDomainConfigResponse]
Παράδειγμα

deleteDomainConfig 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| domain | string | Όχι |
Απόκριση
Επιστρέφει: Option[DeleteDomainConfigResponse]
Παράδειγμα

getDomainConfig 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| domain | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetDomainConfigResponse]
Παράδειγμα

getDomainConfigs 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι |
Απόκριση
Επιστρέφει: Option[GetDomainConfigsResponse]
Παράδειγμα

patchDomainConfig 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| domainToUpdate | string | Όχι | |
| patchDomainConfigParams | PatchDomainConfigParams | Όχι |
Απάντηση
Επιστρέφει: Option[PatchDomainConfigResponse]
Παράδειγμα

putDomainConfig 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| domainToUpdate | string | Όχι | |
| updateDomainConfigParams | UpdateDomainConfigParams | Όχι |
Απόκριση
Επιστρέφει: Option[PutDomainConfigResponse]
Παράδειγμα

createEmailTemplate 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| createEmailTemplateBody | CreateEmailTemplateBody | No |
Απόκριση
Επιστρέφει: Option[CreateEmailTemplateResponse]
Παράδειγμα

deleteEmailTemplate 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

deleteEmailTemplateRenderError 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| errorId | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getEmailTemplate 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetEmailTemplateResponse]
Παράδειγμα

getEmailTemplateDefinitions 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι |
Απάντηση
Επιστρέφει: Option[GetEmailTemplateDefinitionsResponse]
Παράδειγμα

getEmailTemplateRenderErrors 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetEmailTemplateRenderErrorsResponse]
Παράδειγμα

getEmailTemplates 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetEmailTemplatesResponse]
Παράδειγμα

renderEmailTemplate 
Παράμετροι
| Όνομα | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Όχι | |
| locale | string | Όχι |
Απάντηση
Επιστρέφει: Option[RenderEmailTemplateResponse]
Παράδειγμα

updateEmailTemplate 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getEventLog 
req tenantId urlId userIdWS
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| userIdWS | string | Όχι | |
| startTime | int64 | Όχι | |
| endTime | int64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetEventLogResponse]
Παράδειγμα

getGlobalEventLog 
req tenantId urlId userIdWS
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| userIdWS | string | Όχι | |
| startTime | int64 | Όχι | |
| endTime | int64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetEventLogResponse]
Παράδειγμα

createFeedPost 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createFeedPostParams | CreateFeedPostParams | Όχι | |
| broadcastId | string | Όχι | |
| isLive | bool | Όχι | |
| doSpamCheck | bool | Όχι | |
| skipDupCheck | bool | Όχι |
Απάντηση
Επιστρέφει: Option[CreateFeedPostsResponse]
Παράδειγμα

createFeedPostPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createFeedPostParams | CreateFeedPostParams | Όχι | |
| broadcastId | string | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[CreateFeedPostResponse]
Παράδειγμα

deleteFeedPostPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| postId | string | Όχι | |
| broadcastId | string | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[DeleteFeedPostPublicResponse]
Παράδειγμα

getFeedPosts 
req tenantId afterId
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| afterId | string | Όχι | |
| limit | int | Όχι | |
| tags | seq[string] | Όχι |
Απόκριση
Επιστρέφει: Option[GetFeedPostsResponse]
Παράδειγμα

getFeedPostsPublic 
Αίτηση tenantId afterId
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| afterId | string | Όχι | |
| limit | int | Όχι | |
| tags | seq[string] | Όχι | |
| sso | string | Όχι | |
| isCrawler | bool | Όχι | |
| includeUserInfo | bool | Όχι |
Απόκριση
Επιστρέφει: Option[PublicFeedPostsResponse]
Παράδειγμα

getFeedPostsStats 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| postIds | seq[string] | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[FeedPostsStatsResponse]
Παράδειγμα

getUserReactsPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| postIds | seq[string] | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[UserReactsResponse]
Παράδειγμα

reactFeedPostPublic 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| postId | string | Όχι | |
| reactBodyParams | ReactBodyParams | Όχι | |
| isUndo | bool | Όχι | |
| broadcastId | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ReactFeedPostResponse]
Παράδειγμα

updateFeedPost 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| feedPost | FeedPost | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

updateFeedPostPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| postId | string | Όχι | |
| updateFeedPostParams | UpdateFeedPostParams | Όχι | |
| broadcastId | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[CreateFeedPostResponse]
Παράδειγμα

flagCommentPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| isFlagged | bool | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getGifLarge 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| largeInternalURLSanitized | string | Όχι |
Απόκριση
Επιστρέφει: Option[GifGetLargeResponse]
Παράδειγμα

getGifsSearch 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| search | string | Όχι | |
| locale | string | Όχι | |
| rating | string | Όχι | |
| page | float64 | Όχι |
Απάντηση
Επιστρέφει: Option[GetGifsSearchResponse]
Παράδειγμα

getGifsTrending 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| locale | string | Όχι | |
| rating | string | Όχι | |
| page | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetGifsTrendingResponse]
Παράδειγμα

addHashTag 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| createHashTagBody | CreateHashTagBody | Όχι |
Απόκριση
Επιστρέφει: Option[CreateHashTagResponse]
Παράδειγμα

addHashTagsBulk 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | Όχι |
Απόκριση
Επιστρέφει: Option[BulkCreateHashTagsResponse]
Παράδειγμα

deleteHashTag 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tag | string | Όχι | |
| tenantId | string | Ναι | |
| deleteHashTagRequestBody | DeleteHashTagRequestBody | Όχι |
Απάντηση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getHashTags 
Παράμετροι
| Όνομα | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| page | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetHashTagsResponse]
Παράδειγμα

patchHashTag 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tag | string | Όχι | |
| tenantId | string | Ναι | |
| updateHashTagBody | UpdateHashTagBody | Όχι |
Απόκριση
Επιστρέφει: Option[UpdateHashTagResponse]
Παράδειγμα

deleteModerationVote 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| voteId | string | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[VoteDeleteResponse]
Παράδειγμα

getApiComments 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| page | float64 | Όχι | |
| count | float64 | Όχι | |
| textSearch | string | Όχι | |
| byIPFromComment | string | Όχι | |
| filters | string | Όχι | |
| searchFilters | string | Όχι | |
| sorts | string | Όχι | |
| demo | bool | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[ModerationAPIGetCommentsResponse]
Παράδειγμα

getApiExportStatus 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| batchJobId | string | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[ModerationExportStatusResponse]
Παράδειγμα

getApiIds 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| textSearch | string | Όχι | |
| byIPFromComment | string | Όχι | |
| filters | string | Όχι | |
| searchFilters | string | Όχι | |
| afterId | string | Όχι | |
| demo | bool | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ModerationAPIGetCommentIdsResponse]
Παράδειγμα

getBanUsersFromComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetBannedUsersFromCommentResponse]
Παράδειγμα

getCommentBanStatus 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetCommentBanStatusResponse]
Παράδειγμα

getCommentChildren 
Παράμετροι
| Όνομα | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ModerationAPIChildCommentsResponse]
Παράδειγμα

getCount 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| textSearch | string | Όχι | |
| byIPFromComment | string | Όχι | |
| filter | string | Όχι | |
| searchFilters | string | Όχι | |
| demo | bool | Όχι | |
| sso | string | Όχι |
Response
Επιστρέφει: Option[ModerationAPICountCommentsResponse]
Example

getCounts 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetBannedUsersCountResponse]
Παράδειγμα

getLogs 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ModerationAPIGetLogsResponse]
Παράδειγμα

getManualBadges 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetTenantManualBadgesResponse]
Παράδειγμα

getManualBadgesForUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| badgesUserId | string | Όχι | |
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetUserManualBadgesResponse]
Παράδειγμα

getModerationComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| includeEmail | bool | Όχι | |
| includeIP | bool | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ModerationAPICommentResponse]
Παράδειγμα

getModerationCommentText 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetCommentTextResponse]
Παράδειγμα

getPreBanSummary 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| includeByUserIdAndEmail | bool | Όχι | |
| includeByIP | bool | Όχι | |
| includeByEmailDomain | bool | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[PreBanSummary]
Παράδειγμα

getSearchCommentsSummary 
Παράμετροι
| Όνομα | Type | Απαιτείται | Περιγραφή |
|---|---|---|---|
| value | string | Όχι | |
| filters | string | Όχι | |
| searchFilters | string | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[ModerationCommentSearchResponse]
Παράδειγμα

getSearchPages 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| value | string | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[ModerationPageSearchResponse]
Παράδειγμα

getSearchSites 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| value | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ModerationSiteSearchResponse]
Παράδειγμα

getSearchSuggest 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| textSearch | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ModerationSuggestResponse]
Παράδειγμα

getSearchUsers 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| value | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ModerationUserSearchResponse]
Παράδειγμα

getTrustFactor 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| userId | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetUserTrustFactorResponse]
Παράδειγμα

getUserBanPreference 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIModerateGetUserBanPreferencesResponse]
Παράδειγμα

getUserInternalProfile 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetUserInternalProfileResponse]
Παράδειγμα

postAdjustCommentVotes 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| adjustCommentVotesParams | AdjustCommentVotesParams | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[AdjustVotesResponse]
Παράδειγμα

postApiExport 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| textSearch | string | Όχι | |
| byIPFromComment | string | Όχι | |
| filters | string | Όχι | |
| searchFilters | string | Όχι | |
| sorts | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ModerationExportResponse]
Παράδειγμα

postBanUserFromComment 
Παράμετροι
| Name | Type | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| banEmail | bool | Όχι | |
| banEmailDomain | bool | Όχι | |
| banIP | bool | Όχι | |
| deleteAllUsersComments | bool | Όχι | |
| bannedUntil | string | Όχι | |
| isShadowBan | bool | Όχι | |
| updateId | string | Όχι | |
| banReason | string | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[BanUserFromCommentResult]
Παράδειγμα

postBanUserUndo 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| banUserUndoParams | BanUserUndoParams | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

postBulkPreBanSummary 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| bulkPreBanParams | BulkPreBanParams | Όχι | |
| includeByUserIdAndEmail | bool | Όχι | |
| includeByIP | bool | Όχι | |
| includeByEmailDomain | bool | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[BulkPreBanSummary]
Παράδειγμα

postCommentsByIds 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| commentsByIdsParams | CommentsByIdsParams | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ModerationAPIChildCommentsResponse]
Παράδειγμα

postFlagComment 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

postRemoveComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[PostRemoveCommentResponse]
Παράδειγμα

postRestoreDeletedComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

postSetCommentApprovalStatus 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| approved | bool | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[SetCommentApprovedResponse]
Παράδειγμα

postSetCommentReviewStatus 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| reviewed | bool | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

postSetCommentSpamStatus 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| commentId | string | Ναι | |
| spam | bool | Όχι | |
| permNotSpam | bool | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

postSetCommentText 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| setCommentTextParams | SetCommentTextParams | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[SetCommentTextResponse]
Παράδειγμα

postUnFlagComment 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

postVote 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| commentId | string | Ναι | |
| direction | string | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[VoteResponse]
Παράδειγμα

putAwardBadge 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| badgeId | string | Όχι | |
| userId | string | Όχι | |
| commentId | string | Ναι | |
| broadcastId | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[AwardUserBadgeResponse]
Παράδειγμα

putCloseThread 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| urlId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

putRemoveBadge 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| badgeId | string | Όχι | |
| userId | string | Όχι | |
| commentId | string | Ναι | |
| broadcastId | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[RemoveUserBadgeResponse]
Παράδειγμα

putReopenThread 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| urlId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

setTrustFactor 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| userId | string | Όχι | |
| trustFactor | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[SetUserTrustFactorResponse]
Παράδειγμα

createModerator 
Παράμετροι
| Όνομα | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createModeratorBody | CreateModeratorBody | Όχι |
Απόκριση
Επιστρέφει: Option[CreateModeratorResponse]
Παράδειγμα

deleteModerator 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| sendEmail | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getModerator 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetModeratorResponse]
Παράδειγμα

getModerators 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetModeratorsResponse]
Παράδειγμα

updateModerator 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateModeratorBody | UpdateModeratorBody | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

deleteNotificationCount 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getCachedNotificationCount 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetCachedNotificationCountResponse]
Παράδειγμα

getNotificationCount 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| userId | string | Όχι | |
| urlId | string | Ναι | |
| fromCommentId | string | Όχι | |
| viewed | bool | Όχι |
Απόκριση
Επιστρέφει: Option[GetNotificationCountResponse]
Παράδειγμα

getNotifications 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| userId | string | Όχι | |
| urlId | string | Ναι | |
| fromCommentId | string | Όχι | |
| viewed | bool | Όχι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetNotificationsResponse]
Παράδειγμα

updateNotification 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateNotificationBody | UpdateNotificationBody | Όχι | |
| userId | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

createV1PageReact 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| title | string | Όχι |
Απόκριση
Επιστρέφει: Option[CreateV1PageReact]
Παράδειγμα

createV2PageReact 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| id | string | Όχι | |
| title | string | Όχι |
Απόκριση
Επιστρέφει: Option[CreateV1PageReact]
Παράδειγμα

deleteV1PageReact 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι |
Απάντηση
Επιστρέφει: Option[CreateV1PageReact]
Παράδειγμα

deleteV2PageReact 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[CreateV1PageReact]
Παράδειγμα

getV1PageLikes 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι |
Απόκριση
Επιστρέφει: Option[GetV1PageLikes]
Παράδειγμα

getV2PageReacts 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι |
Απάντηση
Επιστρέφει: Option[GetV2PageReacts]
Παράδειγμα

getV2PageReactUsers 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetV2PageReactUsersResponse]
Παράδειγμα

addPage 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createAPIPageData | CreateAPIPageData | Όχι |
Απόκριση
Επιστρέφει: Option[AddPageAPIResponse]
Παράδειγμα

deletePage 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απάντηση
Επιστρέφει: Option[DeletePageAPIResponse]
Παράδειγμα

getOfflineUsers 
Προηγούμενοι σχολιαστές στη σελίδα που ΔΕΝ είναι αυτήν τη στιγμή online. Ταξινομημένοι κατά displayName. Χρησιμοποιήστε αυτό μετά την εξάντληση του /users/online για να εμφανίσετε μια ενότητα «Μέλη». Σελιδοποίηση με cursor στο commenterName: ο server διατρέχει το μερικό {tenantId, urlId, commenterName} δείκτης από afterName προς τα εμπρός μέσω $gt — χωρίς κόστος $skip.
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| afterName | string | Όχι | |
| afterUserId | string | Όχι |
Απόκριση
Επιστρέφει: Option[PageUsersOfflineResponse]
Παράδειγμα

getOnlineUsers 
Χρήστες που είναι αυτή τη στιγμή online σε μια σελίδα: άτομα των οποίων η websocket συνεδρία είναι εγγεγραμμένη στη σελίδα αυτή αυτή τη στιγμή. Επιστρέφει anonCount + totalCount (συνδρομητές σε όλο το δωμάτιο, συμπεριλαμβανομένων των ανώνυμων θεατών που δεν απαριθμούμε).
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| afterName | string | Όχι | |
| afterUserId | string | Όχι |
Απάντηση
Επιστρέφει: Option[PageUsersOnlineResponse]
Παράδειγμα

getPageByURLId 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes |
Απόκριση
Επιστρέφει: Option[GetPageByURLIdAPIResponse]
Παράδειγμα

getPages 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι |
Απόκριση
Επιστρέφει: Option[GetPagesAPIResponse]
Παράδειγμα

getPagesPublic 
Λίστα σελίδων για έναν tenant. Χρησιμοποιείται από την εφαρμογή επιφάνειας εργασίας του FChat για να συμπληρώσει τη λίστα δωματίων της.
Απαιτείται το enableFChat να είναι true στην επιλυμένη προσαρμοσμένη ρύθμιση για κάθε σελίδα.
Οι σελίδες που απαιτούν SSO φιλτράρονται με βάση την πρόσβαση ομάδας του χρήστη που κάνει το αίτημα.
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| cursor | string | Όχι | |
| limit | int | Όχι | |
| q | string | Όχι | |
| sortBy | PagesSortBy | Όχι | |
| hasComments | bool | Όχι |
Απόκριση
Επιστρέφει: Option[GetPublicPagesResponse]
Παράδειγμα

getUsersInfo 
Μαζικές πληροφορίες χρηστών για έναν tenant. Δεδομένων των userIds, επιστρέφει πληροφορίες εμφάνισης από User / SSOUser. Χρησιμοποιείται από το widget σχολίων για να εμπλουτίσει χρήστες που μόλις εμφανίστηκαν μέσω ενός γεγονότος παρουσίας. Χωρίς πλαίσιο σελίδας: η ιδιωτικότητα εφαρμόζεται ομοιόμορφα (τα ιδιωτικά προφίλ αποκρύπτονται).
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| ids | string | Όχι |
Απόκριση
Επιστρέφει: Option[PageUsersInfoResponse]
Παράδειγμα

patchPage 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateAPIPageData | UpdateAPIPageData | Όχι |
Απάντηση
Επιστρέφει: Option[PatchPageAPIResponse]
Παράδειγμα

deletePendingWebhookEvent 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getPendingWebhookEventCount 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| externalId | string | Όχι | |
| eventType | string | Όχι | |
| domain | string | Όχι | |
| attemptCountGT | float64 | Όχι |
Απάντηση
Επιστρέφει: Option[GetPendingWebhookEventCountResponse]
Παράδειγμα

getPendingWebhookEvents 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| externalId | string | Όχι | |
| eventType | string | Όχι | |
| domain | string | Όχι | |
| attemptCountGT | float64 | Όχι | |
| skip | float64 | Όχι |
Απάντηση
Επιστρέφει: Option[GetPendingWebhookEventsResponse]
Παράδειγμα

createQuestionConfig 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createQuestionConfigBody | CreateQuestionConfigBody | Όχι |
Απόκριση
Επιστρέφει: Option[CreateQuestionConfigResponse]
Παράδειγμα

deleteQuestionConfig 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getQuestionConfig 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Response
Επιστρέφει: Option[GetQuestionConfigResponse]
Παράδειγμα

getQuestionConfigs 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetQuestionConfigsResponse]
Παράδειγμα

updateQuestionConfig 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

createQuestionResult 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createQuestionResultBody | CreateQuestionResultBody | Όχι |
Απόκριση
Επιστρέφει: Option[CreateQuestionResultResponse]
Παράδειγμα

deleteQuestionResult 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getQuestionResult 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetQuestionResultResponse]
Παράδειγμα

getQuestionResults 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| userId | string | Όχι | |
| startDate | string | Όχι | |
| questionId | string | Όχι | |
| questionIds | string | Όχι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetQuestionResultsResponse]
Παράδειγμα

updateQuestionResult 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateQuestionResultBody | UpdateQuestionResultBody | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

aggregateQuestionResults 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| questionId | string | Όχι | |
| questionIds | seq[string] | Όχι | |
| urlId | string | Ναι | |
| timeBucket | AggregateTimeBucket | Όχι | |
| startDate | string | Όχι | |
| forceRecalculate | bool | Όχι |
Απάντηση
Επιστρέφει: Option[AggregateQuestionResultsResponse]
Παράδειγμα

bulkAggregateQuestionResults 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Όχι | |
| forceRecalculate | bool | Όχι |
Απόκριση
Επιστρέφει: Option[BulkAggregateQuestionResultsResponse]
Παράδειγμα

combineCommentsWithQuestionResults 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| questionId | string | No | |
| questionIds | seq[string] | No | |
| urlId | string | Yes | |
| startDate | string | No | |
| forceRecalculate | bool | No | |
| minValue | float64 | No | |
| maxValue | float64 | No | |
| limit | float64 | No |
Απόκριση
Επιστρέφει: Option[CombineQuestionResultsWithCommentsResponse]
Παράδειγμα

addSSOUser 
Parameters
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createAPISSOUserData | CreateAPISSOUserData | Όχι |
Απόκριση
Επιστρέφει: Option[AddSSOUserAPIResponse]
Παράδειγμα

deleteSSOUser 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| deleteComments | bool | Όχι | |
| commentDeleteMode | string | Όχι |
Απόκριση
Επιστρέφει: Option[DeleteSSOUserAPIResponse]
Παράδειγμα

getSSOUserByEmail 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| string | Όχι |
Απάντηση
Επιστρέφει: Option[GetSSOUserByEmailAPIResponse]
Παράδειγμα

getSSOUserById 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetSSOUserByIdAPIResponse]
Παράδειγμα

getSSOUsers 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| skip | int | Όχι |
Απάντηση
Επιστρέφει: Option[GetSSOUsersResponse]
Παράδειγμα

patchSSOUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateAPISSOUserData | UpdateAPISSOUserData | Όχι | |
| updateComments | bool | Όχι |
Απόκριση
Επιστρέφει: Option[PatchSSOUserAPIResponse]
Παράδειγμα

putSSOUser 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateAPISSOUserData | UpdateAPISSOUserData | Όχι | |
| updateComments | bool | Όχι |
Απόκριση
Επιστρέφει: Option[PutSSOUserAPIResponse]
Παράδειγμα

createSubscription 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | Όχι |
Απόκριση
Επιστρέφει: Option[CreateSubscriptionAPIResponse]
Παράδειγμα

deleteSubscription 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| userId | string | Όχι |
Απόκριση
Επιστρέφει: Option[DeleteSubscriptionAPIResponse]
Παράδειγμα

getSubscriptions 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| userId | string | Όχι |
Απάντηση
Επιστρέφει: Option[GetSubscriptionsAPIResponse]
Παράδειγμα

updateSubscription 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateAPIUserSubscriptionData | UpdateAPIUserSubscriptionData | Όχι | |
| userId | string | Όχι |
Απόκριση
Επιστρέφει: Option[UpdateSubscriptionAPIResponse]
Παράδειγμα

getTenantDailyUsages 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| yearNumber | float64 | Όχι | |
| monthNumber | float64 | Όχι | |
| dayNumber | float64 | Όχι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetTenantDailyUsagesResponse]
Παράδειγμα

createTenantPackage 
Παράμετροι
| Όνομα | Τύπος | Απαραίτητο | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createTenantPackageBody | CreateTenantPackageBody | Όχι |
Επιστρέφει
Επιστρέφει: Option[CreateTenantPackageResponse]
Παράδειγμα

deleteTenantPackage 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απάντηση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getTenantPackage 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetTenantPackageResponse]
Παράδειγμα

getTenantPackages 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetTenantPackagesResponse]
Παράδειγμα

replaceTenantPackage 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

updateTenantPackage 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateTenantPackageBody | UpdateTenantPackageBody | Όχι |
Απάντηση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

createTenantUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createTenantUserBody | CreateTenantUserBody | Όχι |
Απάντηση
Επιστρέφει: Option[CreateTenantUserResponse]
Παράδειγμα

deleteTenantUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| deleteComments | string | Όχι | |
| commentDeleteMode | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getTenantUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetTenantUserResponse]
Παράδειγμα

getTenantUsers 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetTenantUsersResponse]
Παράδειγμα

replaceTenantUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| replaceTenantUserBody | ReplaceTenantUserBody | Όχι | |
| updateComments | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

sendLoginLink 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| redirectURL | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

updateTenantUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateTenantUserBody | UpdateTenantUserBody | Όχι | |
| updateComments | string | Όχι |
Απάντηση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

createTenant 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createTenantBody | CreateTenantBody | Όχι |
Απάντηση
Επιστρέφει: Option[CreateTenantResponse]
Παράδειγμα

deleteTenant 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| sure | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

getTenant 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetTenantResponse]
Παράδειγμα

getTenants 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| meta | string | Όχι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetTenantsResponse]
Παράδειγμα

updateTenant 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateTenantBody | UpdateTenantBody | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptyResponse]
Παράδειγμα

changeTicketState 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| userId | string | Όχι | |
| id | string | Όχι | |
| changeTicketStateBody | ChangeTicketStateBody | Όχι |
Response
Επιστρέφει: Option[ChangeTicketStateResponse]
Παράδειγμα

createTicket 
Παράμετροι
| Όνομα | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| userId | string | Όχι | |
| createTicketBody | CreateTicketBody | Όχι |
Απόκριση
Επιστρέφει: Option[CreateTicketResponse]
Παράδειγμα

getTicket 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| userId | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetTicketResponse]
Παράδειγμα

getTickets 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| userId | string | Όχι | |
| state | float64 | Όχι | |
| skip | float64 | Όχι | |
| limit | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[GetTicketsResponse]
Παράδειγμα

getTranslations 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| namespace | string | Όχι | |
| component | string | Όχι | |
| locale | string | Όχι | |
| useFullTranslationIds | bool | Όχι |
Απόκριση
Επιστρέφει: Option[GetTranslationsResponse]
Παράδειγμα

uploadImage 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| file | string | Όχι | |
| sizePreset | SizePreset | Όχι | |
| urlId | string | Ναι |
Απόκριση
Επιστρέφει: Option[UploadImageResponse]
Παράδειγμα

getUserBadgeProgressById 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απάντηση
Επιστρέφει: Option[APIGetUserBadgeProgressResponse]
Παράδειγμα

getUserBadgeProgressByUserId 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| userId | string | string | Όχι |
Απάντηση
Επιστρέφει: Option[APIGetUserBadgeProgressResponse]
Παράδειγμα

getUserBadgeProgressList 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| userId | string | Όχι | |
| limit | float64 | Όχι | |
| skip | float64 | Όχι |
Απόκριση
Επιστρέφει: Option[APIGetUserBadgeProgressListResponse]
Παράδειγμα

createUserBadge 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| createUserBadgeParams | CreateUserBadgeParams | Όχι |
Απόκριση
Επιστρέφει: Option[APICreateUserBadgeResponse]
Παράδειγμα

deleteUserBadge 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptySuccessResponse]
Παράδειγμα

getUserBadge 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Απόκριση
Επιστρέφει: Option[APIGetUserBadgeResponse]
Παράδειγμα

getUserBadges 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| userId | string | Όχι | |
| badgeId | string | Όχι | |
| displayedOnComments | bool | Όχι | |
| limit | float64 | Όχι | |
| skip | float64 | Όχι |
Απάντηση
Επιστρέφει: Option[APIGetUserBadgesResponse]
Παράδειγμα

updateUserBadge 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| updateUserBadgeParams | UpdateUserBadgeParams | Όχι |
Απόκριση
Επιστρέφει: Option[APIEmptySuccessResponse]
Παράδειγμα

getUserNotificationCount 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetUserNotificationCountResponse]
Παράδειγμα

getUserNotifications 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| pageSize | int | Όχι | |
| afterId | string | Όχι | |
| includeContext | bool | Όχι | |
| afterCreatedAt | int64 | Όχι | |
| unreadOnly | bool | Όχι | |
| dmOnly | bool | Όχι | |
| noDm | bool | Όχι | |
| includeTranslations | bool | Όχι | |
| includeTenantNotifications | bool | Όχι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[GetMyNotificationsResponse]
Παράδειγμα

resetUserNotificationCount 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| sso | string | Όχι |
Απάντηση
Επιστρέφει: Option[ResetUserNotificationsResponse]
Παράδειγμα

resetUserNotifications 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| afterId | string | Όχι | |
| afterCreatedAt | int64 | Όχι | |
| unreadOnly | bool | Όχι | |
| dmOnly | bool | Όχι | |
| noDm | bool | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[ResetUserNotificationsResponse]
Παράδειγμα

updateUserNotificationCommentSubscriptionStatus 
Ενεργοποιήστε ή απενεργοποιήστε τις ειδοποιήσεις για ένα συγκεκριμένο σχόλιο.
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| notificationId | string | Όχι | |
| optedInOrOut | string | Όχι | |
| commentId | string | Ναι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[UpdateUserNotificationCommentSubscriptionStatusResponse]
Παράδειγμα

updateUserNotificationPageSubscriptionStatus 
Ενεργοποιήστε ή απενεργοποιήστε τις ειδοποιήσεις για μια σελίδα. Όταν οι χρήστες έχουν εγγραφεί σε μια σελίδα, δημιουργούνται ειδοποιήσεις για νέα κύρια σχόλια, και επίσης
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| url | string | Όχι | |
| pageTitle | string | Όχι | |
| subscribedOrUnsubscribed | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[UpdateUserNotificationPageSubscriptionStatusResponse]
Παράδειγμα

updateUserNotificationStatus 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| notificationId | string | Όχι | |
| newStatus | string | Όχι | |
| sso | string | Όχι |
Απόκριση
Επιστρέφει: Option[UpdateUserNotificationStatusResponse]
Παράδειγμα

getUserPresenceStatuses 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlIdWS | string | Όχι | |
| userIds | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetUserPresenceStatusesResponse]
Παράδειγμα

searchUsers 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| usernameStartsWith | string | Όχι | |
| mentionGroupIds | seq[string] | Όχι | |
| sso | string | Όχι | |
| searchSection | string | Όχι |
Απόκριση
Επιστρέφει: Option[SearchUsersResult]
Παράδειγμα

getUser 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι |
Response
Επιστρέφει: Option[GetUserResponse]
Παράδειγμα

createVote 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| direction | string | Όχι | |
| userId | string | Όχι | |
| anonUserId | string | Όχι |
Απόκριση
Επιστρέφει: Option[VoteResponse]
Παράδειγμα

deleteVote 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Όχι | |
| editKey | string | Όχι |
Απόκριση
Επιστρέφει: Option[VoteDeleteResponse]
Παράδειγμα

getVotes 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι |
Απόκριση
Επιστρέφει: Option[GetVotesResponse]
Παράδειγμα

getVotesForUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| userId | string | Όχι | |
| anonUserId | string | Όχι |
Απόκριση
Επιστρέφει: Option[GetVotesForUserResponse]
Παράδειγμα

Χρειάζεστε βοήθεια?
Εάν αντιμετωπίσετε οποιοδήποτε πρόβλημα ή έχετε ερωτήσεις σχετικά με το Nim SDK, παρακαλούμε:
Συνεισφορά
Οι συνεισφορές είναι ευπρόσδεκτες! Παρακαλούμε επισκεφτείτε το αποθετήριο στο GitHub για οδηγίες συνεισφοράς.