
Γλώσσα 🇬🇷 Ελληνικά
Τεκμηρίωση
Ξεκινώντας
Ενοικιαστές Πράκτορα
Συγκέντρωση
Αρχεία Ελέγχου
Αυθεντικοποίηση
Παρτίδες Εργασιών
Αποκλεισμός από Σχόλιο
Έλεγχος Αποκλεισμένων Σχολίων
Σχόλια
Σχόλια για Χρήστη
Ρυθμίσεις Τομέα
Πρότυπα Email
Αρχείο Συμβάντων
Αναρτήσεις Ροής
Σημείωση Σχολίου
GIFs
Ετικέτες
Εγώ
Συντονισμός
Συντονιστές
Αριθμός Ειδοποιήσεων
Ειδοποιήσεις
Αντιδράσεις Σελίδας
Σελίδες
Εκκρεμείς Συμβάντα Webhook
Ψήφοι Δημοσκόπησης
Δημοσκοπήσεις
Ρυθμίσεις Ερωτήσεων
Αποτελέσματα Ερωτήσεων
Συγκέντρωση Αποτελεσμάτων Ερωτήσεων
Χρήστες SSO
Συνδρομές
Καθημερινή Χρήση Ενοικιαστή
Πακέτα Ενοικιαστή
Χρήστες Ενοικιαστή
Ενοικιαστές
Αιτήματα
Μεταφράσεις
Ανέβασμα Εικόνας
Πρόοδος Σήματος Χρήστη
Σήματα Χρήστη
Ειδοποιήσεις Χρήστη
Κατάσταση Παρουσίας Χρήστη
Αναζήτηση Χρήστη
Χρήστες
Ψήφοι
Webhooks
FastComments Java SDK
Αυτό είναι το επίσημο Java SDK για το FastComments.
Επίσημο Java SDK για το API του FastComments
Αποθετήριο
AI coding agents 
Δώστε στον πράκτορα κώδικά σας το πλαίσιο FastComments που χρειάζεται - widgets, ρυθμίσεις, Secure SSO, το REST API και τα SDKs:
npx skills add fastcomments/skills
Λειτουργεί με το Claude Code, το Codex, το Cursor, το Copilot, το Gemini και κάθε άλλο πράκτορα που υποστηρίζει το skills CLI.
Installation 
Maven
Προσθέστε το repository του Repsy στο POM του project σας:
<repositories>
<repository>
<id>repsy</id>
<name>FastComments Maven Repository on Repsy</name>
<url>https://repo.repsy.io/mvn/winrid/fastcomments</url>
</repository>
</repositories>
Στη συνέχεια, προσθέστε τις εξαρτήσεις που χρειάζεστε:
<dependencies>
<!-- API Client -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>client</artifactId>
<version>3.1.1</version>
</dependency>
<!-- Core Library (περιλαμβάνει SSO) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>core</artifactId>
<version>3.1.1</version>
</dependency>
<!-- PubSub Library (για live events) -->
<dependency>
<groupId>com.fastcomments</groupId>
<artifactId>pubsub</artifactId>
<version>3.1.1</version>
</dependency>
</dependencies>
Gradle
Προσθέστε το repository του Repsy στο αρχείο build.gradle σας:
repositories {
mavenCentral()
maven {
url "https://repo.repsy.io/mvn/winrid/fastcomments"
}
}
dependencies {
// API Client
implementation "com.fastcomments:client:3.1.1"
// Core Library (περιλαμβάνει SSO)
implementation "com.fastcomments:core:3.1.1"
// PubSub Library (για live events)
implementation "com.fastcomments:pubsub:3.1.1"
}
Περιεχόμενα της Βιβλιοθήκης
Αυτή η βιβλιοθήκη περιέχει τρία modules. Το generated API client, τη βασική βιβλιοθήκη Java που περιέχει utilities γραμμένα στο χέρι
για να διευκολύνεται η εργασία με το API, και το module pubsub που είναι μια βιβλιοθήκη για συνδρομή σε change feeds.
- Τεκμηρίωση της Βιβλιοθήκης API Client
- Τεκμηρίωση της Core Βιβλιοθήκης, με Παραδείγματα SSO
- Τεκμηρίωση της Βιβλιοθήκης PubSub
Δημόσια vs Ασφαλισμένα APIs
Για το API client, υπάρχουν τρεις κλάσεις, DefaultApi, PublicApi, και ModerationApi. Το DefaultApi περιέχει μεθόδους που απαιτούν το API key σας, και το PublicApi περιέχει μεθόδους
που μπορούν να κληθούν απευθείας από browser/κινητή συσκευή/κ.λπ. χωρίς αυθεντικοποίηση.
Το ModerationApi παρέχει ένα εκτεταμένο σύνολο live και γρήγορων APIs για συντονισμό. Κάθε μέθοδος του ModerationApi δέχεται μια παράμετρο sso και μπορεί να αυθεντικοποιηθεί μέσω SSO ή μέσω session cookie του FastComments.com.
Quick Start 
Χρήση Αυθεντικοποιημένων API (DefaultApi)
Σημαντικό: Πρέπει να ορίσετε το API key σας στον ApiClient πριν κάνετε αιτήματα που απαιτούν αυθεντικοποίηση. Εάν δεν το κάνετε, τα αιτήματα θα αποτύχουν με σφάλμα 401.
import com.fastcomments.invoker.ApiClient;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.api.DefaultApi;
import com.fastcomments.model.*;
public class Example {
public static void main(String[] args) {
// Δημιουργήστε και διαμορφώστε τον API client
ApiClient apiClient = new ApiClient();
// ΑΠΑΙΤΕΙΤΑΙ: Ορίστε το API key σας (λάβετε το από το dashboard του FastComments)
apiClient.setApiKey("YOUR_API_KEY_HERE");
// Δημιουργήστε το API instance με τον διαμορφωμένο client
DefaultApi api = new DefaultApi(apiClient);
// Τώρα μπορείτε να κάνετε αιτήματα API με αυθεντικοποίηση
try {
// Παράδειγμα: Προσθήκη χρήστη SSO
CreateAPISSOUserData userData = new CreateAPISSOUserData();
userData.setId("user-123");
userData.setEmail("user@example.com");
userData.setDisplayName("John Doe");
AddSSOUserAPIResponse response = api.addSSOUser("YOUR_TENANT_ID", userData)
.execute();
System.out.println("User created: " + response);
} catch (ApiException e) {
System.err.println("Error: " + e.getResponseBody());
// Συνηθισμένα σφάλματα:
// - 401: Το API key λείπει ή είναι άκυρο
// - 400: Η επικύρωση του αιτήματος απέτυχε
}
}
}
Χρήση Δημόσιων API (PublicApi)
Τα δημόσια endpoints δεν απαιτούν αυθεντικοποίηση:
import com.fastcomments.api.PublicApi;
import com.fastcomments.invoker.ApiException;
PublicApi publicApi = new PublicApi();
try {
var response = publicApi.getCommentsPublic("YOUR_TENANT_ID", "page-url-id")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
Χρήση API Εποπτείας (ModerationApi)
Το ModerationApi χειρίζεται τον πίνακα ελέγχου του συντονιστή. Κάθε μέθοδος δέχεται μια παράμετρο sso που προσδιορίζει τον συντονιστή αυθεντικοποιημένο μέσω SSO για λογαριασμό του οποίου γίνεται το αίτημα:
import com.fastcomments.api.ModerationApi;
import com.fastcomments.invoker.ApiException;
import com.fastcomments.model.*;
ModerationApi moderationApi = new ModerationApi();
try {
// Λίστα σχολίων που περιμένουν έλεγχο/εποπτεία
ModerationAPIGetCommentsResponse response = moderationApi.getApiComments()
.sso("YOUR_SSO_TOKEN")
.execute();
System.out.println(response);
} catch (ApiException e) {
e.printStackTrace();
}
Συνήθη Προβλήματα
- 401 "missing-api-key" error: Βεβαιωθείτε ότι καλείτε
apiClient.setApiKey("YOUR_KEY")πριν δημιουργήσετε το instance του DefaultApi. - Wrong API class: Χρησιμοποιήστε
DefaultApiγια αιτήματα διακομιστή με αυθεντικοποίηση,PublicApiγια client-side/δημόσια αιτήματα. - Μηδενικό API key (null): Το SDK θα παραλείψει σιωπηλά την αυθεντικοποίηση αν το API key είναι null, οδηγώντας σε σφάλματα 401.
Notes 
Αναγνωριστικά μετάδοσης
Θα δείτε ότι πρέπει να περάσετε ένα broadcastId σε μερικές κλήσεις API. Όταν λαμβάνετε συμβάντα, θα λάβετε αυτό το ID πίσω, ώστε να γνωρίζετε να αγνοήσετε το συμβάν αν σκοπεύετε να εφαρμόσετε τις αλλαγές αισιόδοξα στον πελάτη
(που πιθανότατα θα θελήσετε να κάνετε καθώς προσφέρει την καλύτερη εμπειρία). Περάστε εδώ ένα UUID. Το ID θα πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανίζεται δύο φορές σε μια συνεδρία περιηγητή.
createAgentTenant 
Δημιουργεί έναν νέο δοκιμαστικό λογαριασμό για έναν πράκτορα AI χωρίς ανθρώπινη εγγραφή. Δεν απαιτείται κλειδί API για την κλήση αυτού.
Η απάντηση περιέχει το tenant id, ένα κλειδί API που λειτουργεί αμέσως με το REST API και τον διακομιστή MCP, καθώς και ένα URL διεκδίκησης. Δώστε το URL διεκδίκησης στον άνθρωπο για τον οποίο εργάζεστε: το άνοιγμά του ενώ είναι συνδεδεμένος στο FastComments συνδέει τον λογαριασμό με αυτόν. Οι μη διεκδικημένοι λογαριασμοί, και τα κλειδιά τους, διαγράφονται 72 ώρες μετά τη δημιουργία. Μέχρι να διεκδικηθεί, ο λογαριασμός έχει τα τυπικά όρια δοκιμαστικής περιόδου.
Απάντηση
Επιστρέφει: CreateAgentTenantResponse
Παράδειγμα

aggregate 
Συγκεντρώνει έγγραφα ομαδοποιώντας τα (εάν παρέχεται το groupBy) και εφαρμόζοντας πολλαπλές λειτουργίες. Υποστηρίζονται διαφορετικές λειτουργίες (π.χ. sum, countDistinct, avg, κ.λπ.).
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| parentTenantId | string | query | Όχι | |
| includeStats | boolean | query | Όχι |
Απόκριση
Επιστρέφει: AggregateResponse
Παράδειγμα

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 | Επιστρέφει μόνο τα συμβάντα για αυτόν τον πόρο, π.χ. Χρήστη ή Συντονιστή. |
| targetId | string | query | No | Επιστρέφει μόνο τα συμβάντα του αντικειμένου που επηρεάζεται με αυτό το αναγνωριστικό. |
| target | string | query | No | Ανίχνευση υποσυμβολοσειράς χωρίς διάκριση πεζών-κεφαλαίων στην ετικέτα του επηρεαζόμενου αντικειμένου, π.χ. όνομα χρήστη ή email. |
| includeManagedTenants | boolean | query | No | Επιστρέφει επίσης συμβάντα από ενοικιαστές που διαχειρίζεται αυτός ο ενοικιαστής. |
Απάντηση
Επιστρέφει: GetAuditLogsResponse
Παράδειγμα

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

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

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

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

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

checkedCommentsForBlocked 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentIds | string | query | Ναι | Μια λίστα comment ids χωρισμένη με κόμμα. |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: CheckBlockedCommentsResponse
Παράδειγμα

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

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 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| contextUserId | string | query | Όχι | |
| isLive | boolean | query | Όχι |
Απόκριση
Επιστρέφει: DeleteCommentResult
Παράδειγμα

deleteCommentPublic 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Ναι | |
| id | string | path | Ναι | |
| userId | string | query | Όχι | |
| anonUserId | string | query | Όχι |
Απόκριση
Επιστρέφει: 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 | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No | |
| questionId | string | query | No | |
| questionValue | integer | query | No |
Απόκριση
Επιστρέφει: GetCommentsResponseWithPresencePublicComment
Παράδειγμα

getCommentText 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

updateComment 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| contextUserId | string | query | Όχι | |
| doSpamCheck | boolean | query | Όχι | |
| isLive | boolean | query | Όχι |
Απόκριση
Returns: APIEmptyResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

getEmailTemplateRenderErrors 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
Απόκριση
Επιστρέφει: 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
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| userIdWS | string | query | Ναι | |
| startTime | integer | query | Ναι | |
| endTime | integer | query | Όχι |
Απόκριση
Επιστρέφει: GetEventLogResponse
Παράδειγμα

getGlobalEventLog 
req tenantId urlId userIdWS
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| userIdWS | string | query | Ναι | |
| startTime | integer | query | Ναι | |
| endTime | integer | query | Όχι |
Απόκριση
Επιστρέφει: GetEventLogResponse
Παράδειγμα

createFeedPost 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Απόκριση
Επιστρέφει: CreateFeedPostsResponse
Παράδειγμα

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

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

getFeedPosts 
req tenantId afterId
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| afterId | string | query | Όχι | |
| limit | integer | query | Όχι | |
| tags | array | query | Όχι |
Απόκριση
Επιστρέφει: GetFeedPostsResponse
Παράδειγμα

getFeedPostsPublic 
req tenantId afterId
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| afterId | string | query | Όχι | |
| limit | integer | query | Όχι | |
| tags | array | query | Όχι | |
| sso | string | query | Όχι | |
| isCrawler | boolean | query | Όχι | |
| includeUserInfo | boolean | query | Όχι |
Απόκριση
Επιστρέφει: PublicFeedPostsResponse
Παράδειγμα

getFeedPostsStats 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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 | Ναι | |
| postId | string | path | Ναι | |
| isUndo | boolean | query | Όχι | |
| broadcastId | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: ReactFeedPostResponse
Παράδειγμα

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

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

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

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

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

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

addHashTag 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Response
Returns: CreateHashTagResponse
Example

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

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

getHashTags 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No |
Response
Επιστρέφει: GetHashTagsResponse
Παράδειγμα

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

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

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

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

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

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

getCommentChildren 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| sso | string | query | Όχι |
Απόκριση
Returns: 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 | Ναι | |
| commentId | string | path | Ναι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: ModerationAPIGetLogsResponse
Παράδειγμα

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

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

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

getModerationCommentText 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: 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 | Yes | |
| value | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: ModerationCommentSearchResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

postBanUserFromComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| banEmail | boolean | query | Όχι | |
| banEmailDomain | boolean | query | Όχι | |
| banIP | boolean | query | Όχι | |
| deleteAllUsersComments | boolean | query | Όχι | |
| bannedUntil | string | query | Όχι | |
| isShadowBan | boolean | query | Όχι | |
| updateId | string | query | Όχι | |
| banReason | string | query | Όχι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: BanUserFromCommentResult
Example

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

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

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

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

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

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

postSetCommentApprovalStatus 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: 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 | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: SetCommentTextResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getNotificationCount 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| userId | string | query | Όχι | |
| urlId | string | query | Όχι | |
| fromCommentId | string | query | Όχι | |
| viewed | boolean | query | Όχι | |
| type | string | query | Όχι |
Απόκριση
Επιστρέφει: GetNotificationCountResponse
Παράδειγμα

getNotifications 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| userId | string | query | Όχι | |
| urlId | string | query | Όχι | |
| fromCommentId | string | query | Όχι | |
| viewed | boolean | query | Όχι | |
| type | string | query | Όχι | |
| skip | number | query | Όχι |
Απόκριση
Επιστρέφει: GetNotificationsResponse
Παράδειγμα

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

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

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

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

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

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

getV2PageReacts 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No | |
| includeUserInfo | string | query | No | Όταν οριστεί, επιστρέφει τους χρήστες για κάθε react id (εικονίδια και ονόματα χρηστών). Μόνο το "public" γίνεται αποδεκτό, το οποίο παραλείπει τα ιδιωτικά προφίλ. |
Απάντηση
Επιστρέφει: 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 
Προηγούμενοι σχολιαστές στη σελίδα που ΔΕΝ είναι αυτή τη στιγμή online. Ταξινομημένο κατά displayName. Χρησιμοποιήστε το αφού εξαντλήσετε το /users/online για να αποδώσετε μια ενότητα "Μέλη". Σελιδοποίηση cursor με βάση το commenterName: ο server περπατάει τον μερικό {tenantId, urlId, commenterName} index από afterName προς τα εμπρός μέσω $gt, χωρίς κόστος $skip.
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Αναγνωριστικό URL σελίδας (καθαρίζεται στην πλευρά του διακομιστή). |
| afterName | string | query | No | Δείκτης (cursor): περάστε το nextAfterName από την προηγούμενη απάντηση. |
| afterUserId | string | query | No | Επίλυση ισοβαθμίας δείκτη: περάστε το nextAfterUserId από την προηγούμενη απάντηση. Απαιτείται όταν έχει οριστεί το afterName ώστε οι εγγραφές με ίδια ονόματα να μην παραλείπονται. |
Απόκριση
Επιστρέφει: PageUsersOfflineResponse
Παράδειγμα

getOnlineUsers 
Τρέχοντες συνδεδεμένοι θεατές μιας σελίδας: άτομα των οποίων η websocket συνεδρία είναι εγγεγραμμένη στη σελίδα αυτή τώρα. Επιστρέφει anonCount + totalCount (συνδρομητές σε επίπεδο δωματίου, συμπεριλαμβανομένων ανώνυμων θεατών που δεν απαριθμούμε).
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Αναγνωριστικό διεύθυνσης URL της σελίδας (καθαρίζεται από τον διακομιστή). |
| afterName | string | query | No | Δείκτης: περάστε το nextAfterName από την προηγούμενη απόκριση. |
| afterUserId | string | query | No | Διαχωριστής ισοβαθμίας του δείκτη: περάστε το 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 counts για μια σελίδα, προαιρετικά με τους χρήστες που έκαναν react.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| urlId | string | query | Ναι | |
| includeUserInfo | string | query | Όχι | Το "public" παραλείπει χρήστες με ιδιωτικά προφίλ, το "include-private" τους συμπεριλαμβάνει. |
Απάντηση
Επιστρέφει: GetPageReactsAPIResponse
Παράδειγμα

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

getPagesPublic 
Καταχώρηση σελίδων για έναν tenant. Χρησιμοποιείται από τον desktop client του FChat για να συμπληρώσει τη λίστα δωματίων του.
Απαιτείται το enableFChat να είναι true στην επιλυμένη προσαρμοσμένη ρύθμιση (custom config) για κάθε σελίδα.
Οι σελίδες που απαιτούν SSO φιλτράρονται με βάση την πρόσβαση ομάδας του χρήστη που κάνει το αίτημα.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| cursor | string | query | Όχι | Αδιαφανής δείκτης σελιδοποίησης που επιστρέφεται ως 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. Χωρίς page context: η ιδιωτικότητα εφαρμόζεται ομοιόμορφα (ιδιωτικά προφίλ αποκρύπτονται).
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds διαχωρισμένα με κόμμα. |
Response
Επιστρέφει: 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 ημέρες. Οι εγγραφές που άλλαξαν μετά τη μετανάστευση δεν επηρεάζονται, ώστε μια μεταγενέστερη επεξεργασία να μην αντικαθίσταται ποτέ. Ελέγχετε το GET /api/v1/batch-jobs/{batchJobId} για τα πλήθη επαναφοράς/παράλειψης.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| undoId | string | path | Ναι |
Απάντηση
Επιστρέφει: QueuePageMigrationJobAPIResponse
Παράδειγμα

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

getPendingWebhookEventCount 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | query | Όχι | |
| externalId | string | query | Όχι | |
| eventType | string | query | Όχι | |
| type | string | query | Όχι | |
| domain | string | query | Όχι | |
| attemptCountGT | number | query | Όχι |
Απόκριση
Επιστρέφει: GetPendingWebhookEventCountResponse
Παράδειγμα

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

createPollVote 
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.
This obeys the site's poll settings: if voting is set to logged-in users only, a vote with just an anonUserId is rejected, and anonymous votes are rate limited per IP per poll.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Απόκριση
Επιστρέφει: CreatePollVoteResponse
Παράδειγμα

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

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

getPollVotes 
Οι μεμονωμένες ψήφοι πίσω από τα σύνολα μιας ψηφοφορίας, ξεκινώντας από τις παλαιότερες.
Μια ψηφοφορία ανήκει σε ένα σχόλιο, οπότε οι ψήφοι διαβάζονται πάντα μία ψηφοφορία τη φορά - το commentId είναι υποχρεωτικό. Αυτό διατηρεί κάθε ερώτημα στα ευρετήρια που έχει ήδη η συλλογή.
Τηρεί την ιδιωτικότητα της ψηφοφορίας: οι ψήφοι μιας ανώνυμης ψηφοφορίας δεν μπορούν να διαβαστούν (poll-anonymous), ούτε εδώ ούτε μέσω id.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | query | Ναι | |
| voterId | string | query | Όχι | |
| optionId | string | query | Όχι | |
| skip | integer | query | Όχι |
Απόκριση
Επιστρέφει: GetPollVotesResponse
Παράδειγμα

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

getPoll 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι |
Απόκριση
Επιστρέφει: 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 
Επεξεργασία δημοσκόπησης επιτόπου, διατηρώντας τους υπολογισμούς της: αλλάξτε την ερώτηση, μετονομάστε μια επιλογή, κλείστε ή ανοίξτε ξανά τη δημοσκόπηση, ή αλλάξτε ποιοι μπορούν να δουν τους ψηφοφόρους. Οι επιλογές προσδιορίζονται με id - για να προσθέσετε, να αφαιρέσετε ή να αναδιατάξετε επιλογές, στείλτε PUT με την πλήρη λίστα.
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαραίτητο | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι |
Απάντηση
Επιστρέφει: SavePollResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

getQuestionResults 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| urlId | string | query | Όχι | |
| userId | string | query | Όχι | |
| startDate | string | query | Όχι | |
| questionId | string | query | Όχι | |
| questionIds | string | query | Όχι | |
| skip | number | query | Όχι |
Απόκριση
Επιστρέφει: 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 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| questionId | string | query | Όχι | |
| questionIds | array | query | Όχι | |
| urlId | string | query | Όχι | |
| startDate | string | query | Όχι | |
| forceRecalculate | boolean | query | Όχι | |
| minValue | number | query | Όχι | |
| maxValue | number | query | Όχι | |
| limit | number | query | Όχι |
Απάντηση
Επιστρέφει: CombineQuestionResultsWithCommentsResponse
Παράδειγμα

addSSOUser 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Response
Επιστρέφει: 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 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Απόκριση
Επιστρέφει: PatchSSOUserAPIResponse
Παράδειγμα

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

createSubscription 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Response
Επιστρέφει: CreateSubscriptionAPIResponse
Παράδειγμα

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

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

updateSubscription 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: CreateTenantPackageResponse
Παράδειγμα

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

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

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

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

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

createTenantUser 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| updateComments | string | query | Όχι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

sendLoginLink 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| sure | string | query | Όχι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

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

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

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

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

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

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

getTranslations 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| namespace | string | path | Ναι | |
| component | string | path | Ναι | |
| locale | string | query | Όχι | |
| useFullTranslationIds | boolean | query | Όχι |
Απόκριση
Επιστρέφει: GetTranslationsResponse
Παράδειγμα

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

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

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

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

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

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

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

getUserBadges 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| userId | string | query | Όχι | |
| badgeId | string | query | Όχι | |
| type | number | query | Όχι | |
| displayedOnComments | boolean | query | Όχι | |
| limit | number | query | Όχι | |
| skip | number | query | Όχι |
Απάντηση
Επιστρέφει: APIGetUserBadgesResponse
Παράδειγμα

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

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

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

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

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

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

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

updateUserNotificationStatus 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | query | Ναι | |
| direction | string | query | Ναι | |
| userId | string | query | Όχι | |
| anonUserId | string | query | Όχι |
Απόκριση
Επιστρέφει: VoteResponse
Παράδειγμα

deleteVote 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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). Η εγγραφή της ίδιας διεύθυνσης URL στο ίδιο γεγονός και τομέα ξανά επιστρέφει την υπάρχουσα συνδρομή. Οι παραδόσεις είναι υπογεγραμμένες με HMAC, δείτε τον οδηγό webhooks· η παλιά κεφαλίδα token δεν αποστέλλεται ποτέ στις συνδρομές API.
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: CreateWebhookResponse
Παράδειγμα

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

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

getWebhookSamplePayloads 
Recent comments in exactly the shape webhook deliveries use, for building integrations (for example Zapier
sample data). Every event delivers the same comment object, so event only has to be valid.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| event | string | query | No | |
| limit | number | query | No |
Response
Επιστρέφει: GetWebhookSamplePayloadsResponse
Παράδειγμα

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