
Γλώσσα 🇬🇷 Ελληνικά
Τεκμηρίωση
Ξεκινώντας
Αναφορά API
Ενοικιαστές πρακτόρων
Συγκέντρωση
Αρχεία ελέγχου
Αυθεντικοποίηση
Παρτίδες εργασιών
Αποκλεισμός από σχόλιο
Έλεγχος αποκλεισμένων σχολίων
Σχόλια
Σχόλια για χρήστη
Ρυθμίσεις τομέα
Πρότυπα email
Αρχείο συμβάντων
Δημοσιεύσεις ροής
Σημείωση σχολίου
GIFs
Ετικέτες
Εγώ
Συντονισμός
Συντονιστές
Αριθμός ειδοποιήσεων
Ειδοποιήσεις
Αντιδράσεις σε σελίδα
Σελίδες
Εκκρεμή συμβάντα webhook
Ψήφοι δημοσκόπησης
Δημοσκοπήσεις
Ρυθμίσεις ερωτήσεων
Αποτελέσματα ερωτήσεων
Συγκέντρωση αποτελεσμάτων ερωτήσεων
Χρήστες SSO
Συνδρομές
Καθημερινή χρήση ενοικιαστή
Πακέτα ενοικιαστή
Χρήστες ενοικιαστή
Ενοικιαστές
Αιτήματα
Μεταφράσεις
Ανέβασμα εικόνας
Πρόοδος σήματος χρήστη
Σήματα χρήστη
Ειδοποιήσεις χρήστη
Κατάσταση παρουσίας χρήστη
Αναζήτηση χρηστών
Χρήστες
Ψήφοι
Webhooks
FastComments Swift SDK
Αυτό είναι το επίσημο Swift SDK για το FastComments.
Επίσημο Swift SDK για το API του FastComments
Αποθετήριο
Πράκτορες κώδικα AI 
Δώστε στον πράκτορα κώδικα σας το πλαίσιο FastComments που χρειάζεται - widgets, ρυθμίσεις, Secure SSO, το REST API και τα SDKs:
npx skills add fastcomments/skills
Λειτουργεί με Claude Code, Codex, Cursor, Copilot, Gemini και κάθε άλλο πράκτορα που υποστηρίζει το skills CLI supports.
Εγκατάσταση 
Swift Package Manager
Προσθέστε τα εξής στο αρχείο Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "3.1.2")
]
Ή στο Xcode:
- File > Add Packages...
- Εισάγετε το URL του repository:
https://github.com/fastcomments/fastcomments-swift.git - Επιλέξτε την έκδοση που θέλετε να χρησιμοποιήσετε
Απαιτήσεις
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Περιεχόμενα βιβλιοθήκης 
Το FastComments Swift SDK αποτελείται από αρκετές μονάδες:
-
Client Module - Πελάτης API για τα FastComments REST APIs
- Πλήρεις ορισμοί τύπων για όλα τα μοντέλα API
- Αυθεντικοποιημένες (
DefaultAPI), δημόσιες (PublicAPI) και μεθόδους συντονισμού (ModerationAPI) - Πλήρης υποστήριξη async/await
- Δείτε το client/README.md για λεπτομερή τεκμηρίωση API
-
SSO Module - Εργαλεία Single Sign-On από την πλευρά του διακομιστή
- Ασφαλής δημιουργία token για την αυθεντικοποίηση χρηστών
- Υποστήριξη τόσο των απλών όσο και των ασφαλών λειτουργιών SSO
- Υπογραφή token βάσει HMAC-SHA256 χρησιμοποιώντας CryptoKit
Γρήγορη εκκίνηση 
Χρήση του Δημόσιου API
import FastCommentsSwift
// Ανάκτηση σχολίων για μια σελίδα
do {
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Χρήση του Πιστοποιημένου API
import FastCommentsSwift
// Διαμόρφωση του κλειδιού API στη κοινή διαμόρφωση (αποστέλλεται ως κεφαλίδα x-api-key)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Ανάκτηση σχολίων χρησιμοποιώντας το πιστοποιημένο API
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(urlId: "page-url-id")
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Χρήση του Moderation API
import FastCommentsSwift
// Οι μέθοδοι διαχείρισης εξουσιοδοτούνται με ένα διακριτικό `sso` για τον ενεργό συντονιστή
// (δημιουργήστε το με FastCommentsSSO, ανατρέξτε στην ενότητα SSO παραπάνω).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Χρήση του SSO για Έλεγχο Ταυτότητας
Ασφαλές SSO (Προτείνεται για Παραγωγή)
import FastCommentsSwift
let apiKey = "your-api-key"
// Δημιουργία ασφαλών δεδομένων χρήστη SSO (μόνο στο διακομιστή!)
let userData = SecureSSOUserData(
id: "user-123", // Αναγνωριστικό χρήστη
email: "user@example.com", // Email
username: "johndoe", // Όνομα χρήστη
avatar: "https://example.com/avatar.jpg" // URL Αφικής Εικόνας
)
// Δημιουργία διακριτικού SSO
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Περνάτε αυτό το διακριτικό στο frontend σας για έλεγχο ταυτότητας
} catch {
print("Error creating SSO token: \(error)")
}
Απλό SSO (Για Ανάπτυξη/Δοκιμή)
import FastCommentsSwift
// Δημιουργία απλών δεδομένων χρήστη SSO (δεν απαιτείται κλειδί API)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Δημιουργία απλού διακριτικού SSO
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
Πελάτες API 
Το FastComments SDK παρέχει τρεις API clients:
PublicAPI - Μέθοδοι Ασφαλείς για Client
Το PublicAPI περιέχει μεθόδους που είναι ασφαλείς για κλήση από κώδικα client-side (εφαρμογές iOS/macOS). Αυτές οι μέθοδοι:
- Δεν απαιτούν API key
- Μπορούν να χρησιμοποιήσουν SSO tokens για αυθεντικοποίηση
- Έχουν όριο ρυθμού ανά χρήστη/συσκευή
- Είναι κατάλληλες για εφαρμογές που απευθύνονται σε τελικούς χρήστες
Παράδειγμα χρήσης: Ανάκτηση και δημιουργία σχολίων στην εφαρμογή iOS σας
DefaultAPI - Μέθοδοι Server-Side
Το DefaultAPI περιέχει μεθόδους με αυθεντικοποίηση που απαιτούν API key. Αυτές οι μέθοδοι:
- Απαιτούν το API key του FastComments σας
- Πρέπει να καλούνται ΜΟΝΟ από κώδικα server-side
- Παρέχουν πλήρη πρόσβαση στα δεδομένα FastComments σας
- Έχουν όριο ρυθμού ανά tenant
Παράδειγμα χρήσης: Διαχειριστικές λειτουργίες, μαζική εξαγωγή δεδομένων, διαχείριση χρηστών
ModerationAPI - Μέθοδοι Πίνακα Ελέγχου Συντονιστή
Το ModerationAPI παρέχει ένα εκτεταμένο σύνολο live και γρήγορων APIs συντονισμού. Κάθε μέθοδος του ModerationAPI δέχεται μια παράμετρο sso και μπορεί να αυθεντικοποιηθεί μέσω SSO ή ενός session cookie του FastComments.com.
Παράδειγμα χρήσης: Δημιουργία εμπειρίας συντονισμού για τους συντονιστές της κοινότητάς σας
ΣΗΜΑΝΤΙΚΟ: Ποτέ μην εκθέτετε το API key σας σε κώδικα client-side. Τα API keys πρέπει να χρησιμοποιούνται μόνο server-side.
Δημιουργία κλήσεων API 
Το Swift SDK χρησιμοποιεί σύγχρονη σύνταξη async/await για όλες τις κλήσεις API:
let response = try await PublicAPI.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Κοινά προβλήματα 
Σφάλματα 401 Unauthorized
Εάν λαμβάνετε σφάλματα 401 κατά τη χρήση του πιστοποιημένου API:
- Ελέγξτε το API key σας: Βεβαιωθείτε ότι χρησιμοποιείτε το σωστό API key από το dashboard του FastComments
- Επαληθεύστε το tenant ID: Βεβαιωθείτε ότι το tenant ID ταιριάζει με τον λογαριασμό σας
- Μορφή API key: Το API key πρέπει να οριστεί ως κεφαλίδα
x-api-keyστην κοινή διαμόρφωση:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Χρήση λάθος API: Βεβαιωθείτε ότι χρησιμοποιείτε το
DefaultAPI(όχι τοPublicAPI) για πιστοποιημένες κλήσεις
Προβλήματα SSO Token
Εάν τα SSO tokens δεν λειτουργούν:
- Χρησιμοποιήστε secure mode για παραγωγή: Χρησιμοποιείτε πάντα το
FastCommentsSSO.createSecure()με το API key σας για παραγωγή - Μόνο από τον server: Δημιουργήστε secure SSO tokens στον server σας, μην εκθέτετε ποτέ το API key σας σε clients
- Ελέγξτε τα δεδομένα χρήστη: Βεβαιωθείτε ότι παρέχονται όλα τα απαιτούμενα πεδία (id, email, username)
- Λήξη token: Τα secure SSO tokens περιλαμβάνουν χρονική σήμανση και ενδέχεται να λήξουν. Δημιουργήστε νέα tokens όπως χρειάζεται.
Σφάλματα SSL/TLS
Εάν αντιμετωπίζετε σφάλματα SSL/TLS:
- Βεβαιωθείτε ότι το Info.plist της εφαρμογής σας επιτρέπει συνδέσεις HTTPS προς το fastcomments.com
- Ελέγξτε ότι δεν χρησιμοποιείτε εξαιρέσεις App Transport Security που ενδέχεται να μπλοκάρουν τη σύνδεση
Σημειώσεις 
Αναγνωριστικά μετάδοσης
Θα δείτε ότι πρέπει να περάσετε ένα broadcastId σε ορισμένες κλήσεις API. Όταν λαμβάνετε γεγονότα, θα λάβετε πίσω αυτό το ID, ώστε να γνωρίζετε να αγνοήσετε το γεγονός αν σκοπεύετε να εφαρμόσετε τις αλλαγές στον πελάτη με αισιόδοξο τρόπο (κάτι που πιθανότατα θα θέλετε να κάνετε καθώς προσφέρει την καλύτερη εμπειρία). Περάστε εδώ ένα UUID. Το ID θα πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές σε μια συνεδρία.
let broadcastId = UUID().uuidString
createAgentTenant 
Δημιουργεί έναν νέο λογαριασμό δοκιμής για έναν AI πράκτορα χωρίς ανθρώπινη εγγραφή. Δεν απαιτείται κλειδί API για την κλήση αυτού.
Η απάντηση περιέχει το tenant id, ένα κλειδί API που λειτουργεί αμέσως εναντίον του REST API και του διακομιστή MCP, καθώς και ένα URL αξίωσης. Δώστε το URL αξίωσης στο άτομο για το οποίο εργάζεστε: το άνοιγμα του ενώ είστε συνδεδεμένοι στο FastComments συνδέει τον λογαριασμό με αυτόν. Οι μη αξιόχρεοι λογαριασμοί, και τα κλειδιά τους, διαγράφονται 72 ώρες μετά τη δημιουργία. Μέχρι να αξιωθεί, ο λογαριασμός έχει τα τυπικά όρια δοκιμής.
Response
Returns: CreateAgentTenantResponse
Example

συγκέντρωση 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| parentTenantId | string | query | Όχι | |
| includeStats | boolean | query | Όχι |
Response
Επιστρέφει: AggregateResponse
Example

getAuditLogs 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | Ο ενοικιαστής για τον οποίο διαβάζονται τα αρχεία ελέγχου. |
| limit | integer | query | No | Πόσα αρχεία ελέγχου να επιστραφούν. Μέγιστο 10000, προεπιλογή 1000. |
| skip | integer | query | No | Πόσα αρχεία ελέγχου να παραληφθούν, για σελιδοποίηση. |
| order | string | query | No | Κατεύθυνση ταξινόμησης με βάση το χρόνο του γεγονότος. Προεπιλογή DESC (πρώτα τα πιο πρόσφατα). |
| after | integer | query | No | |
| before | integer | query | No | |
| username | string | query | No | Να επιστραφούν μόνο τα γεγονότα που εκτελέστηκαν από αυτό το όνομα χρήστη. |
| ip | string | query | No | Να επιστραφούν μόνο τα γεγονότα από αυτή τη διεύθυνση IP. |
| crudType | string | query | No | Να επιστραφούν μόνο τα γεγονότα αυτού του τύπου: c, r, u, d ή login. |
| resourceName | string | query | No | Να επιστραφούν μόνο τα γεγονότα για αυτόν τον πόρο, π.χ. User ή Moderator. |
| targetId | string | query | No | Να επιστραφούν μόνο τα γεγονότα των οποίων το αντικείμενο-στόχος έχει αυτό το αναγνωριστικό. |
| target | string | query | No | Αναζήτηση υποσυμβολοσειράς χωρίς διάκριση πεζών-κεφαλαίων στο ετικέτα του αντικειμένου-στόχου, π.χ. όνομα χρήστη ή email. |
| includeManagedTenants | boolean | query | No | Να επιστραφούν επίσης γεγονότα από ενοικιαστές που διαχειρίζεται αυτός ο ενοικιαστής. |
Απάντηση
Επιστρέφει: GetAuditLogsResponse
Παράδειγμα

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

getBatchJob 
Κατάσταση, πρόοδος και, όταν ολοκληρωθεί, το αποτέλεσμα μιας παρτίδας εργασίας.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απάντηση
Επιστρέφει: GetBatchJobAPIResponse
Παράδειγμα

getBatchJobs 
The tenant's batch jobs (imports, exports, page migrations...), newest first.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| type | string | query | No | Μόνο εργασίες αυτού του τύπου, για παράδειγμα migrate-pages. |
| status | string | query | No | Μόνο εργασίες σε αυτήν την κατάσταση: requested, running, success ή failed. |
| skip | integer | query | No | Πόσες εργασίες να παραλειφθούν, για σελιδοποίηση. |
Απόκριση
Επιστρέφει: GetBatchJobsAPIResponse
Παράδειγμα

blockFromCommentPublic 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτούμενο | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: BlockSuccess
Παράδειγμα

unBlockCommentPublic 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαραίτητο | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: UnblockSuccess
Παράδειγμα

checkedCommentsForBlocked 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentIds | string | query | Ναι | Λίστα αναγνωριστικών σχολίων διαχωρισμένων με κόμμα. |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: CheckBlockedCommentsResponse
Παράδειγμα

blockUserFromComment 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Επιστρέφει: BlockSuccess
Example

createCommentPublic 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No | |
| locale | string | query | No |
Απάντηση
Επιστρέφει: SaveCommentsResponseWithPresence
Παράδειγμα

deleteComment 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| contextUserId | string | query | Όχι | |
| isLive | boolean | query | Όχι |
Απόκριση
Επιστρέφει: DeleteCommentResult
Παράδειγμα

deleteCommentPublic 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| commentId | string | path | Ναι | |
| broadcastId | string | query | Ναι | |
| editKey | string | query | Όχι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: PublicAPIDeleteCommentResponse
Παράδειγμα

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

flagComment 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Απόκριση
Επιστρέφει: FlagCommentResponse
Παράδειγμα

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

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

getCommentsPublic 
req tenantId urlId
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| page | integer | query | Όχι | |
| direction | string | query | Όχι | |
| sso | string | query | Όχι | |
| skip | integer | query | Όχι | |
| skipChildren | integer | query | Όχι | |
| limit | integer | query | Όχι | |
| limitChildren | integer | query | Όχι | |
| countChildren | boolean | query | Όχι | |
| fetchPageForCommentId | string | query | Όχι | |
| includeConfig | boolean | query | Όχι | |
| countAll | boolean | query | Όχι | |
| includei10n | boolean | query | Όχι | |
| locale | string | query | Όχι | |
| modules | string | query | Όχι | |
| isCrawler | boolean | query | Όχι | |
| includeNotificationCount | boolean | query | Όχι | |
| asTree | boolean | query | Όχι | |
| maxTreeDepth | integer | query | Όχι | |
| useFullTranslationIds | boolean | query | Όχι | |
| parentId | string | query | Όχι | |
| searchText | string | query | Όχι | |
| hashTags | array | query | Όχι | |
| userId | string | query | Όχι | |
| customConfigStr | string | query | Όχι | |
| afterCommentId | string | query | Όχι | |
| beforeCommentId | string | query | Όχι | |
| questionId | string | query | Όχι | |
| questionValue | integer | query | Όχι |
Απάντηση
Επιστρέφει: GetCommentsResponseWithPresencePublicComment
Παράδειγμα

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

getCommentVoteUserNames 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| commentId | string | path | Ναι | |
| dir | integer | query | Ναι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: GetCommentVoteUserNamesSuccessResponse
Παράδειγμα

lockComment 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| commentId | string | path | Ναι | |
| broadcastId | string | query | Ναι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

saveComment 
Παράμετροι
| Όνομα | Τύπος | Location | Required | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| isLive | boolean | query | Όχι | |
| doSpamCheck | boolean | query | Όχι | |
| sendEmails | boolean | query | Όχι | |
| populateNotifications | boolean | query | Όχι |
Απόκριση
Επιστρέφει: APISaveCommentResponse
Παράδειγμα

saveCommentsBulk 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| isLive | boolean | query | Όχι | |
| doSpamCheck | boolean | query | Όχι | |
| sendEmails | boolean | query | Όχι | |
| populateNotifications | boolean | query | Όχι |
Απόκριση
Επιστρέφει: [SaveCommentsBulkResponse]
Παράδειγμα

setCommentText 
Παράμετροι
| 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 |
Απόκριση
Returns: PublicAPISetCommentTextResponse
Παράδειγμα

translateComments 
Μεταφράζει τα δεδομένα σχόλια στη γλώσσα του widget. Διατίθεται μόνο όταν ο αντίστοιχος κανόνας προσαρμογής του widget έχει τη Μετάφραση Σχολίων ορισμένη σε Αυτόματη ή Χειροκίνητη.
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| locale | string | query | No |
Απάντηση
Επιστρέφει: CommentTranslationsResponse
Παράδειγμα

unBlockUserFromComment 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Απόκριση
Επιστρέφει: UnblockSuccess
Παράδειγμα

unFlagComment 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Απόκριση
Επιστρέφει: FlagCommentResponse
Παράδειγμα

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

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

updateComment 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

voteComment 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| commentId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| broadcastId | string | query | Ναι | |
| sessionId | string | query | Όχι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: VoteResponse
Example

getCommentsForUser 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| userId | string | query | Όχι | |
| direction | string | query | Όχι | |
| repliesToUserId | string | query | Όχι | |
| page | number | query | Όχι | |
| includei10n | boolean | query | Όχι | |
| locale | string | query | Όχι | |
| isCrawler | boolean | query | Όχι |
Απάντηση
Επιστρέφει: GetCommentsForUserResponse
Παράδειγμα

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

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

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

getDomainConfigs 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: GetDomainConfigsResponse
Παράδειγμα

patchDomainConfig 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| domainToUpdate | string | path | Ναι |
Απόκριση
Επιστρέφει: PatchDomainConfigResponse
Παράδειγμα

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

createEmailTemplate 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: CreateEmailTemplateResponse
Παράδειγμα

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

deleteEmailTemplateRenderError 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| errorId | string | path | Ναι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

getEmailTemplate 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Απάντηση
Επιστρέφει: GetEmailTemplateResponse
Παράδειγμα

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

getEmailTemplateRenderErrors 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| skip | number | query | Όχι |
Απόκριση
Επιστρέφει: GetEmailTemplateRenderErrorsResponse
Παράδειγμα

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

renderEmailTemplate 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| locale | string | query | Όχι |
Απόκριση
Επιστρέφει: RenderEmailTemplateResponse
Παράδειγμα

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

getEventLog 
req tenantId urlId userIdWS
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| userIdWS | string | query | Ναι | |
| startTime | integer | query | Ναι | |
| endTime | integer | query | Όχι |
Απάντηση
Επιστρέφει: GetEventLogResponse
Παράδειγμα

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

createFeedPost 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Απάντηση
Επιστρέφει: CreateFeedPostsResponse
Παράδειγμα

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

deleteFeedPostPublic 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| postId | string | path | Ναι | |
| broadcastId | string | query | Όχι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: DeleteFeedPostPublicResponse
Example

getFeedPosts 
req tenantId afterId
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Απάντηση
Επιστρέφει: GetFeedPostsResponse
Παράδειγμα

getFeedPostsPublic 
req tenantId afterId
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| afterId | string | query | Όχι | |
| limit | integer | query | Όχι | |
| tags | array | query | Όχι | |
| sso | string | query | Όχι | |
| isCrawler | boolean | query | Όχι | |
| includeUserInfo | boolean | query | Όχι |
Απάντηση
Επιστρέφει: PublicFeedPostsResponse
Παράδειγμα

getFeedPostsStats 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | Yes | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: FeedPostsStatsResponse
Παράδειγμα

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

reactFeedPostPublic 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: ReactFeedPostResponse
Παράδειγμα

updateFeedPost 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

updateFeedPostPublic 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: CreateFeedPostResponse
Παράδειγμα

flagCommentPublic 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| isFlagged | boolean | query | Ναι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

getGifLarge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| largeInternalURLSanitized | string | query | Ναι |
Response
Επιστρέφει: GifGetLargeResponse
Example

getGifsSearch 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| search | string | query | Ναι | |
| locale | string | query | Όχι | |
| rating | string | query | Όχι | |
| page | number | query | Όχι |
Response
Επιστρέφει: GetGifsSearchResponse
Παράδειγμα

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

addHashTag 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Απόκριση
Επιστρέφει: CreateHashTagResponse
Παράδειγμα

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

deleteHashTag 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Response
Επιστρέφει: APIEmptyResponse
Example

getHashTags 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| page | number | query | Όχι |
Απόκριση
Επιστρέφει: GetHashTagsResponse
Παράδειγμα

patchHashTag 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| tag | string | path | Ναι |
Απόκριση
Επιστρέφει: UpdateHashTagResponse
Παράδειγμα

getMe 
Αναγνωρίζει το διαπιστευτήριο σε χρήση: το μισθωτή στο οποίο ανήκει και, για διακριτικά OAuth, τον χρήστη που το εξουσιοδότησε.
Οι ενσωματώσεις το χρησιμοποιούν για να δοκιμάσουν μια σύνδεση και να την ετικετοποιήσουν.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: GetMeResponse
Παράδειγμα

deleteModerationVote 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: VoteDeleteResponse
Παράδειγμα

getApiComments 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: ModerationAPIGetCommentsResponse
Παράδειγμα

getApiExportStatus 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| batchJobId | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: ModerationExportStatusResponse
Παράδειγμα

getApiIds 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: ModerationAPIGetCommentIdsResponse
Παράδειγμα

getBanUsersFromComment 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Επιστρέφει: GetBannedUsersFromCommentResponse
Example

getCommentBanStatus 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: GetCommentBanStatusResponse
Example

getCommentChildren 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: ModerationAPIChildCommentsResponse
Παράδειγμα

getCount 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filter | string | query | No | |
| searchFilters | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: ModerationAPICountCommentsResponse
Παράδειγμα

getCounts 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαραίτητο | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: GetBannedUsersCountResponse
Παράδειγμα

getLogs 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: ModerationAPIGetLogsResponse
Παράδειγμα

getManualBadges 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: GetTenantManualBadgesResponse
Παράδειγμα

getManualBadgesForUser 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgesUserId | string | query | No | |
| commentId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: GetUserManualBadgesResponse
Παράδειγμα

getModerationComment 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sgo | string | query | No |
Response
Επιστρέφει: ModerationAPICommentResponse
Παράδειγμα

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

getPreBanSummary 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| includeByUserIdAndEmail | boolean | query | Όχι | |
| includeByIP | boolean | query | Όχι | |
| includeByEmailDomain | boolean | query | Όχι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: PreBanSummary
Παράδειγμα

getSearchCommentsSummary 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| value | string | query | Όχι | |
| filters | string | query | Όχι | |
| searchFilters | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: ModerationCommentSearchResponse
Παράδειγμα

getSearchPages 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| value | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: ModerationPageSearchResponse
Παράδειγμα

getSearchSites 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| value | string | query | Όχι | |
| sso | string | query | Όχι |
Απάντηση
Returns: ModerationSiteSearchResponse
Παράδειγμα

getSearchSuggest 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: ModerationSuggestResponse
Παράδειγμα

getSearchUsers 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: ModerationUserSearchResponse
Παράδειγμα

getTrustFactor 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: GetUserTrustFactorResponse
Παράδειγμα

getUserBanPreference 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: APIModerateGetUserBanPreferencesResponse
Παράδειγμα

getUserInternalProfile 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | query | Όχι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: GetUserInternalProfileResponse
Example

postAdjustCommentVotes 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| broadcastId | string | query | Όχι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: AdjustVotesResponse
Example

postApiExport 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| text-search | string | query | Όχι | |
| byIPFromComment | string | query | Όχι | |
| filters | string | query | Όχι | |
| searchFilters | string | query | Όχι | |
| sorts | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: ModerationExportResponse
Παράδειγμα

postBanUserFromComment 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: BanUserFromCommentResult
Παράδειγμα

postBanUserUndo 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | ερώτημα | Ναι | |
| sso | string | ερώτημα | Όχι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postBulkPreBanSummary 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| includeByUserIdAndEmail | boolean | query | Όχι | |
| includeByIP | boolean | query | Όχι | |
| includeByEmailDomain | boolean | query | Όχι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: BulkPreBanSummary
Παράδειγμα

postCommentsByIds 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: ModerationAPIChildCommentsResponse
Παράδειγμα

postFlagComment 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| broadcastId | string | query | Όχι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postRemoveComment 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: PostRemoveCommentApiResponse
Παράδειγμα

postRestoreDeletedComment 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postSetCommentApprovalStatus 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| approved | boolean | query | Όχι | |
| broadcastId | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: SetCommentApprovedResponse
Παράδειγμα

postSetCommentReviewStatus 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| reviewed | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postSetCommentSpamStatus 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postSetCommentText 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| broadcastId | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: SetCommentTextResponse
Παράδειγμα

postUnFlagComment 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Επιστρέφει: APIEmptyResponse
Example

postVote 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: VoteResponse
Παράδειγμα

putAwardBadge 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | ερώτημα | Ναι | |
| badgeId | string | ερώτημα | Ναι | |
| userId | string | ερώτημα | Όχι | |
| commentId | string | ερώτημα | Όχι | |
| broadcastId | string | ερώτημα | Όχι | |
| sso | string | ερώτημα | Όχι |
Απόκριση
Returns: AwardUserBadgeResponse
Παράδειγμα

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

putRemoveBadge 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: RemoveUserBadgeResponse
Παράδειγμα

putReopenThread 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

setTrustFactor 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| userId | string | query | Όχι | |
| trustFactor | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: SetUserTrustFactorResponse
Παράδειγμα

createModerator 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Επιστρέφει
Returns: CreateModeratorResponse
Παράδειγμα

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

getModerator 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαραίτητο | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: GetModeratorResponse
Παράδειγμα

getModerators 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Απόκριση
Επιστρέφει: GetModeratorsResponse
Παράδειγμα

sendInvite 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| fromName | string | query | Ναι |
Response
Επιστρέφει: APIEmptyResponse
Παράδειγμα

updateModerator 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

deleteNotificationCount 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

getNotificationCount 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Απόκριση
Επιστρέφει: GetNotificationCountResponse
Παράδειγμα

getNotifications 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Απόκριση
Επιστρέφει: GetNotificationsResponse
Παράδειγμα

updateNotification 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| userId | string | query | Όχι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

createV1PageReact 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| title | string | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: CreateV1PageReact
Παράδειγμα

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

deleteV1PageReact 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: CreateV1PageReact
Παράδειγμα

deleteV2PageReact 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| id | string | query | Ναι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: CreateV1PageReact
Παράδειγμα

getV1PageLikes 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| sso | string | query | Όχι | |
| includeUserInfo | string | query | Όχι | Όταν οριστεί, επιστρέφει τους χρήστες που έδωσαν like στη σελίδα (εικονοστοιχεία και ονόματα χρηστών). Μόνο το "public" γίνεται αποδεκτό, το οποίο παραλείπει τα ιδιωτικά προφίλ. |
Απάντηση
Επιστρέφει: GetV1PageLikes
Παράδειγμα

getV2PageReacts 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Όταν οριστεί, επιστρέφει τους χρήστες για κάθε react id (εικονίδια και ονόματα χρηστών). Μόνο το "public" γίνεται αποδεκτό, το οποίο παραλείπει τα ιδιωτικά προφίλ. |
Response
Επιστρέφει: GetV2PageReacts
Παράδειγμα

getV2PageReactUsers 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| id | string | query | Ναι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: GetV2PageReactUsersResponse
Παράδειγμα

addPage 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: AddPageAPIResponse
Παράδειγμα

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

getOfflineUsers 
Προηγούμενοι σχολιαστές της σελίδας που ΔΕΝ είναι αυτή τη στιγμή συνδεδεμένοι. Ταξινομούνται κατά displayName. Χρησιμοποιήστε το αυτό αφού εξαντλήσετε το /users/online για να αποδώσετε μια ενότητα "Members". Σελιδοποίηση με cursor στο commenterName: ο διακομιστής διασχίζει το μερικό ευρετήριο {tenantId, urlId, commenterName} από το afterName και μετά μέσω $gt, χωρίς κόστος $skip.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | Αναγνωριστικό URL της σελίδας (καθαρίζεται από τον διακομιστή). |
| afterName | string | query | Όχι | Cursor: περάστε το nextAfterName από την προηγούμενη απάντηση. |
| afterUserId | string | query | Όχι | Tiebreaker του cursor: περάστε το nextAfterUserId από την προηγούμενη απάντηση. Απαιτείται όταν ορίζεται το afterName ώστε οι ισοβαθμίες ονομάτων να μην απορρίπτουν εγγραφές. |
Απάντηση
Επιστρέφει: PageUsersOfflineResponse
Παράδειγμα

getOnlineUsers 
Τρέχοντες online θεατές μιας σελίδας: άτομα των οποίων η συνεδρία websocket είναι εγγεγραμμένη στη σελίδα αυτή τη στιγμή.
Επιστρέφει anonCount + totalCount (συνδρομητές σε όλο το δωμάτιο, συμπεριλαμβανομένων των ανώνυμων θεατών που δεν απαριθμούμε).
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | Αναγνωριστικό URL σελίδας (καθαρισμένο από τον διακομιστή). |
| afterName | string | query | Όχι | Δρομέας: περάστε το nextAfterName από την προηγούμενη απάντηση. |
| afterUserId | string | query | Όχι | Δρομέας-διακόπτης: περάστε το nextAfterUserId από την προηγούμενη απάντηση. Απαιτείται όταν έχει οριστεί afterName ώστε να μην παραλείπονται εγγραφές λόγω ισοδότησης ονομάτων. |
Απόκριση
Επιστρέφει: PageUsersOnlineResponse
Παράδειγμα

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

getPageLikes 
Αριθμός likes για μια σελίδα, προαιρετικά με τους χρήστες που έκαναν like.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| urlId | string | query | Ναι | |
| includeUserInfo | string | query | Όχι | Το "public" παραλείπει χρήστες με ιδιωτικά προφίλ, το "include-private" τους συμπεριλαμβάνει. |
Απάντηση
Επιστρέφει: GetPageLikesAPIResponse
Παράδειγμα

getPageReacts 
Προσαρμοσμένες μετρήσεις αντιδράσεων react για μια σελίδα, προαιρετικά με τους χρήστες που αντέδρασαν.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| urlId | string | query | Ναι | |
| includeUserInfo | string | query | Όχι | Το "public" παραλείπει χρήστες με ιδιωτικά προφίλ, το "include-private" τους συμπεριλαμβάνει. |
Απάντηση
Επιστρέφει: GetPageReactsAPIResponse
Παράδειγμα

getPages 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: GetPagesAPIResponse
Παράδειγμα

getPagesPublic 
Λίστα σελίδων για έναν tenant. Χρησιμοποιείται από τον FChat desktop client για τη συμπλήρωση της λίστας δωματίων του.
Απαιτεί το enableFChat να είναι true στο resolved custom config για κάθε σελίδα.
Σελίδες που απαιτούν SSO φιλτράρονται με βάση την πρόσβαση ομάδας του χρήστη που κάνει το αίτημα.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαραίτητο | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| cursor | string | query | Όχι | Αδιαφανές pagination cursor που επιστράφηκε ως nextCursor από προηγούμενο αίτημα. Συνδέεται με το ίδιο sortBy. |
| limit | integer | query | Όχι | 1..200, προεπιλογή 50 |
| q | string | query | Όχι | Προαιρετικό φίλτρο προθέματος τίτλου χωρίς διάκριση πεζών/κεφαλαίων. |
| sortBy | string | query | Όχι | Σειρά ταξινόμησης. updatedAt (προεπιλογή, νεότερα πρώτα), commentCount (πρώτα τα περισσότερα σχόλια), ή title (αλφαβητικά). |
| hasComments | boolean | query | Όχι | Αν true, επιστρέφονται μόνο σελίδες με τουλάχιστον ένα σχόλιο. |
Απάντηση
Επιστρέφει: GetPublicPagesResponse
Παράδειγμα

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

migratePages 
Στην ουρά μια εργασία δέσμης που μεταφέρει σχόλια, σελίδες και σχετικά αρχεία από ένα urlId ή domain σε άλλο. Οι μετακινήσεις "urlId" ταιριάζουν μόνο το ακριβές urlId. Οι μετακινήσεις "domain" κάνουν αναζήτηση/αντικατάσταση της τιμής μέσα σε κάθε urlId και url. Κάντε poll στο GET /api/v1/batch-jobs/{batchJobId}: όταν ολοκληρωθεί, περιέχει αποτελέσματα ανά μετακίνηση και ένα undoId.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απάντηση
Επιστρέφει: QueuePageMigrationJobAPIResponse
Παράδειγμα

patchPage 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: PatchPageAPIResponse
Παράδειγμα

undoPageMigrations 
Σειροθετεί μια εργασία δέσμης που αντιστρέφει κάθε μετανάστευση από μία εργασία migrate-pages, από τη νεότερη προς την παλαιότερη. Διαθέσιμη για 90 ημέρες. Οι εγγραφές που άλλαξαν μετά τη μετανάστευση δεν επηρεάζονται, ώστε μια μεταγενέστερη επεξεργασία να μην αντικαθίσταται ποτέ. Κάντε polling στο GET /api/v1/batch-jobs/{batchJobId} για τα πλήθη των επαναφερόμενων/παραλειφθέντων.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| undoId | string | path | Ναι |
Απάντηση
Επιστρέφει: QueuePageMigrationJobAPIResponse
Παράδειγμα

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

getPendingWebhookEventCount 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Response
Επιστρέφει: GetPendingWebhookEventCountResponse
Παράδειγμα

getPendingWebhookEvents 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Απόκριση
Επιστρέφει: GetPendingWebhookEventsResponse
Παράδειγμα

createPollVote 
Record a vote on a poll, or move an existing one to a different option. A voter has at most one vote per poll, so calling this again for the same voter moves their vote rather than adding one.
Αυτό τηρεί τις ρυθμίσεις δημοσκοπήσεων του ιστότοπου: εάν η ψήφισή είναι περιορισμένη μόνο σε συνδεδεμένους χρήστες, μια ψήφος με μόνο anonUserId απορρίπτεται, και οι ανώνυμες ψήφοι περιορίζονται ανά IP ανά δημοσκόπηση.
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Response
Returns: CreatePollVoteResponse
Example

deletePollVote 
Αναίρεση ψήφου. Η επιλογή στην οποία εκφράστηκε επιστρέφει το σύνολό της.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: DeletePollVoteResponse
Παράδειγμα

getPollVote 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απάντηση
Επιστρέφει: GetPollVoteResponse
Παράδειγμα

getPollVotes 
The individual votes behind one poll's tallies, oldest first.
Μια δημοσκόπηση ανήκει σε ένα σχόλιο, έτσι οι ψήφοι διαβάζονται πάντα μία δημοσκόπηση τη φορά - απαιτείται το commentId. Αυτό διατηρεί κάθε ερώτημα στα ευρετήρια που ήδη έχει η συλλογή.
Τηρεί το απόρρητο της δημοσκόπησης: οι ψήφοι μιας ανώνυμης δημοσκόπησης δεν μπορούν να διαβαστούν (poll-anonymous), εδώ ή με το id.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | query | Ναι | |
| voterId | string | query | Όχι | |
| optionId | string | query | Όχι | |
| skip | integer | query | Όχι |
Response
Returns: GetPollVotesResponse
Example

deletePoll 
Αφαιρέστε μια δημοσκόπηση από το σχόλιό της, μαζί με κάθε ψήφο που έχει κατατεθεί. Το ίδιο το σχόλιο παραμένει αμετάβλητο.
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι |
Response
Επιστρέφει: APIEmptyResponse
Example

getPoll 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Απόκριση
Επιστρέφει: GetPollResponse
Παράδειγμα

getPollVoters 
Who voted for which option. Anonymous polls never answer, admins-only polls answer only for an admin or moderator.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | No | |
| page | integer | query | No | |
| search | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: GetPollVoterNamesSuccessResponse
Παράδειγμα

patchPoll 
Edit a poll in place, keeping its tallies: change the question, relabel an option, close or reopen it, or change who may see the voters. Options are addressed by id - to add, remove or reorder them, PUT the full list.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes |
Απόκριση
Επιστρέφει: SavePollResponse
Παράδειγμα

putPoll 
Συνημμένο μιας δημοσκόπησης σε ένα σχόλιο, ή ορίστε την πλήρη κατάσταση της δημοσκόπησης που ήδη έχει.
Οι επιλογές ταιριάζουν με βάση το id: μια επιλογή που αποστέλλεται με το id μιας υπάρχουσας επιλογής διατηρεί τις ψήφους της (και λαμβάνει τη νέα ετικέτα και θέση), μια επιλογή που αποστέλλεται χωρίς id προστίθεται, και οι υπάρχουσες επιλογές που παραλείπονται από τη λίστα αφαιρούνται μαζί με τις ψήφους που έχουν κατατεθεί σε αυτές.
Η διατήρηση μη υπαρχόντων ids επιλογών σε μια δημοσκόπηση που έχει ψήφους διαγράφει όλες τις επιλογές, επομένως απαιτείται replaceVotes=true.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| replaceVotes | boolean | query | Όχι |
Απάντηση
Επιστρέφει: SavePollResponse
Παράδειγμα

votePoll 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| commentId | string | path | Ναι | |
| urlId | string | query | Όχι | |
| broadcastId | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: VotePollResponse
Παράδειγμα

createQuestionConfig 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Απάντηση
Returns: CreateQuestionConfigResponse
Παράδειγμα

deleteQuestionConfig 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

getQuestionConfig 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: GetQuestionConfigResponse
Παράδειγμα

getQuestionConfigs 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| skip | number | query | Όχι |
Απόκριση
Επιστρέφει: GetQuestionConfigsResponse
Παράδειγμα

updateQuestionConfig 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

createQuestionResult 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Απάντηση
Επιστρέφει: CreateQuestionResultResponse
Παράδειγμα

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

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

getQuestionResults 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Απάντηση
Επιστρέφει: GetQuestionResultsResponse
Παράδειγμα

updateQuestionResult 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

aggregateQuestionResults 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| questionId | string | query | Όχι | |
| questionIds | array | query | Όχι | |
| urlId | string | query | Όχι | |
| timeBucket | string | query | Όχι | |
| startDate | string | query | Όχι | |
| forceRecalculate | boolean | query | Όχι |
Απάντηση
Επιστρέφει: AggregateQuestionResultsResponse
Παράδειγμα

bulkAggregateQuestionResults 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| forceRecalculate | boolean | query | Όχι |
Απόκριση
Επιστρέφει: BulkAggregateQuestionResultsResponse
Παράδειγμα

combineCommentsWithQuestionResults 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Απάντηση
Returns: CombineQuestionResultsWithCommentsResponse
Παράδειγμα

addSSOUser 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: AddSSOUserAPIResponse
Παράδειγμα

deleteSSOUser 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| deleteComments | boolean | query | Όχι | |
| commentDeleteMode | string | query | Όχι |
Απάντηση
Επιστρέφει: DeleteSSOUserAPIResponse
Παράδειγμα

getSSOUserByEmail 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| string | path | Ναι |
Απάντηση
Επιστρέφει: GetSSOUserByEmailAPIResponse
Παράδειγμα

getSSOUserById 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: GetSSOUserByIdAPIResponse
Παράδειγμα

getSSOUsers 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| skip | integer | query | Όχι |
Απόκριση
Επιστρέφει: GetSSOUsersResponse
Παράδειγμα

patchSSOUser 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| updateComments | boolean | query | Όχι |
Απόκριση
Επιστρέφει: PatchSSOUserAPIResponse
Παράδειγμα

putSSOUser 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| updateComments | boolean | query | Όχι |
Απάντηση
Επιστρέφει: PutSSOUserAPIResponse
Παράδειγμα

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

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

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

updateSubscription 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| userId | string | query | Όχι |
Απόκριση
Επιστρέφει: UpdateSubscriptionAPIResponse
Παράδειγμα

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

createTenantPackage 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: CreateTenantPackageResponse
Παράδειγμα

deleteTenantPackage 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

getTenantPackage 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: GetTenantPackageResponse
Παράδειγμα

getTenantPackages 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| skip | number | query | Όχι |
Απόκριση
Επιστρέφει: GetTenantPackagesResponse
Παράδειγμα

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

updateTenantPackage 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

createTenantUser 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: CreateTenantUserResponse
Παράδειγμα

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

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

getTenantUsers 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| skip | number | query | Όχι |
Απάντηση
Επιστρέφει: GetTenantUsersResponse
Παράδειγμα

replaceTenantUser 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| updateComments | string | query | Όχι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

updateTenantUser 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| updateComments | string | query | Όχι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

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

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

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

updateTenant 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

changeTicketState 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| userId | string | query | Ναι | |
| id | string | path | Ναι |
Απάντηση
Επιστρέφει: ChangeTicketStateResponse
Παράδειγμα

createTicket 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| userId | string | query | Ναι |
Απόκριση
Επιστρέφει: CreateTicketResponse
Παράδειγμα

getTicket 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Απάντηση
Επιστρέφει: GetTicketResponse
Παράδειγμα

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

getTranslations 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Απάντηση
Επιστρέφει: GetTranslationsResponse
Παράδειγμα

uploadImage 
Ανέβασμα και αλλαγή μεγέθους εικόνας
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Προκαθορισμένο μέγεθος: "Default" (1000x1000px) ή "CrossPlatform" (δημιουργεί μεγεθύνσεις για δημοφιλείς συσκευές) |
| urlId | string | query | No | Αναγνωριστικό σελίδας από το οποίο γίνεται το ανέβασμα, για διαμόρφωση |
Απόκριση
Επιστρέφει: UploadImageResponse
Παράδειγμα

getUserBadgeProgressById 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIGetUserBadgeProgressResponse
Παράδειγμα

getUserBadgeProgressByUserId 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαραίτητο | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| userId | string | path | Ναι |
Απόκριση
Επιστρέφει: APIGetUserBadgeProgressResponse
Παράδειγμα

getUserBadgeProgressList 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Απόκριση
Επιστρέφει: APIGetUserBadgeProgressListResponse
Παράδειγμα

createUserBadge 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: APICreateUserBadgeResponse
Παράδειγμα

deleteUserBadge 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIEmptySuccessResponse
Παράδειγμα

getUserBadge 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIGetUserBadgeResponse
Παράδειγμα

getUserBadges 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Απόκριση
Επιστρέφει: APIGetUserBadgesResponse
Παράδειγμα

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

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

getUserNotifications 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Χρησιμοποιείται για να προσδιοριστεί εάν η τρέχουσα σελίδα είναι εγγεγραμμένη. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Response
Επιστρέφει: GetMyNotificationsResponse
Example

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

resetUserNotifications 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: ResetUserNotificationsResponse
Παράδειγμα

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

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

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

getUserPresenceStatuses 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| urlIdWS | string | query | Ναι | |
| userIds | string | query | Ναι |
Απόκριση
Επιστρέφει: GetUserPresenceStatusesResponse
Παράδειγμα

searchUsers 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| usernameStartsWith | string | query | Όχι | |
| mentionGroupIds | array | query | Όχι | |
| sso | string | query | Όχι | |
| searchSection | string | query | Όχι |
Απόκριση
Επιστρέφει: SearchUsersResult
Παράδειγμα

getUser 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: GetUserResponse
Παράδειγμα

createVote 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | Yes | |
| direction | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Απάντηση
Επιστρέφει: VoteResponse
Παράδειγμα

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

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

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

createWebhook 
Συνδέει ένα URL σε ένα συμβάν σχολίου (REST hook subscribe). Η επανασύνδεση του ίδιου URL στο ίδιο
συμβάν και domain επιστρέφει την υπάρχουσα συνδρομή. Οι παραδόσεις υπογράφονται με HMAC, δείτε τον οδηγό
webhooks· η παλαιά κεφαλίδα token δεν αποστέλλεται ποτέ σε συνδρομές μέσω API.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απάντηση
Επιστρέφει: CreateWebhookResponse
Παράδειγμα

deleteWebhook 
Αποεγγραφές (REST hook unsubscribe). Μόνο οι συνδρομές που δημιουργήθηκαν μέσω αυτού του API μπορούν να διαγραφούν εδώ· οι webhook που διαχειρίζονται από τον πίνακα ελέγχου επεξεργάζονται στον πίνακα ελέγχου.
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

getWebhooks 
Εμφανίζει τα webhooks που έχουν ρυθμιστεί για τον tenant, τόσο τις εγγραφές που διαχειρίζεται το dashboard όσο και τις συνδρομές μέσω API.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| event | string | query | Όχι | |
| domain | string | query | Όχι | |
| source | string | query | Όχι | |
| skip | number | query | Όχι |
Απάντηση
Επιστρέφει: GetWebhooksResponse
Παράδειγμα

getWebhookSamplePayloads 
Πρόσφατα σχόλια ακριβώς στη μορφή που χρησιμοποιούν οι παραδόσεις webhook, για τη δημιουργία ενσωματώσεων (για παράδειγμα δείγματα δεδομένων Zapier). Κάθε συμβάν παραδίδει το ίδιο αντικείμενο σχολίου, έτσι το event πρέπει μόνο να είναι έγκυρο.
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| event | string | query | Όχι | |
| limit | number | query | Όχι |
Response
Επιστρέφει: GetWebhookSamplePayloadsResponse
Example

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