
Γλώσσα 🇨🇾 Ελληνικά (Κύπρος)
Τεκμηρίωση
Έναρξη
Αναφορά API
Χρήση
Συγκέντρωση
Αρχεία ελέγχου
Έλεγχος ταυτότητας
Αποκλεισμός από σχόλιο
Έλεγχος αποκλεισμένων σχολίων
Σχόλια
Σχόλια για χρήστη
Διαμορφώσεις τομέα
Πρότυπα email
Αρχείο συμβάντων
Αναρτήσεις feed
Σήμανση σχολίου
GIFs
Hashtags
Διαχείριση
Διαχειριστές
Αριθμός ειδοποιήσεων
Ειδοποιήσεις
Αντιδράσεις σε σελίδα
Σελίδες
Εκκρεμή συμβάντα webhook
Ρυθμίσεις ερωτήσεων
Αποτελέσματα ερωτήσεων
Συγκέντρωση αποτελεσμάτων ερωτήσεων
Χρήστες SSO
Συνδρομές
Ημερήσια χρήση ενοικιαστή
Πακέτα ενοικιαστή
Χρήστες ενοικιαστή
Ενοικιαστές
Εισιτήρια
Μεταφράσεις
Μεταφόρτωση εικόνας
Πρόοδος σήματος χρήστη
Σήματα χρήστη
Ειδοποιήσεις χρήστη
Καταστάσεις παρουσίας χρήστη
Αναζήτηση χρηστών
Χρήστες
Ψηφοφορίες
FastComments C++ SDK
Αυτό είναι το επίσημο SDK C++ για το FastComments.
Επίσημο SDK C++ για το API του FastComments
Αποθετήριο
Απαιτήσεις 
- C++17 ή μεταγενέστερη
- CMake 3.14 ή μεταγενέστερη
- OpenSSL
- C++ REST SDK (cpprestsdk)
- Boost
- Google Test (θα ληφθεί αυτόματα για τις δοκιμές)
Εγκατάσταση 
Εγκατάσταση Εξαρτήσεων
sudo apt install libcpprest-dev libboost-all-dev
Δόμηση από Πηγή
mkdir build
cd build
cmake ..
make
Εγκατάσταση
sudo make install
Περιεχόμενα Βιβλιοθήκης
Αυτή η βιβλιοθήκη περιλαμβάνει τον παραγόμενο πελάτη API και τα εργαλεία SSO για να κάνουν τη δουλειά με το API πιο εύκολη.
Δημόσια vs Ασφαλισμένα API
Για τον πελάτη API, υπάρχουν τρεις κλάσεις, DefaultApi, PublicApi και ModerationApi. Η DefaultApi περιέχει μεθόδους που απαιτούν το κλειδί API σας, και η PublicApi περιέχει μεθόδους που μπορούν να κληθούν απευθείας από έναν φυλλομετρητή/συσκευή κινητού κ.λπ. χωρίς εξακρίβωση. Η ModerationApi παρέχει μια εκτενή σειρά από ζωντανά και γρήγορα API μέτρησης. Κάθε μέθοδος της ModerationApi δέχεται μια παράμετρο sso και μπορεί να ταυτοποιηθεί μέσω SSO ή cookie συνεδρίας FastComments.com.
Γρήγορη εκκίνηση 
Χρήση Επικυρωμένων API (DefaultAPI)
Σημαντικό:
- Πρέπει να ορίσετε τη βασική URL (ο δημιουργός cpp-restsdk δεν την διαβάζει από το OpenAPI spec)
- Πρέπει να ορίσετε το κλειδί API στο ApiClient πριν κάνετε επικυρωμένα αιτήματα. Αν δεν το κάνετε, τα αιτήματα θα αποτύχουν με σφάλμα 401.
#include <iostream>
#include "FastCommentsClient/api/DefaultApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// ΑΠΑΙΤΟΥΜΕΝΟ: Ορίστε τη βασική URL (επιλέξτε την περιοχή σας)
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com")); // US
// Ή: config->setBaseUrl(utility::conversions::to_string_t("https://eu.fastcomments.com")); // EU
// ΑΠΑΙΤΟΥΜΕΝΟ: Ορίστε το κλειδί API σας
config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_API_KEY_HERE"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// Τώρα κάντε επικυρωμένες κλήσεις API
return 0;
}
Χρήση Δημόσιων API (PublicAPI)
Τα δημόσια endpoints δεν απαιτούν αυθεντικοποίηση:
#include <iostream>
#include "FastCommentsClient/api/PublicApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// ΑΠΑΙΤΟΥΜΕΝΟ: Ορίστε τη βασική URL
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::PublicApi publicApi(apiClient);
// Κάντε δημόσιες κλήσεις API
return 0;
}
Χρήση API Συντονισμού (ModerationApi)
Το ModerationApi τροφοδοτεί τον πίνακα ελέγχου των συντονιστών. Κάθε μέθοδος δέχεται μια παράμετρο sso ώστε η κλήση να εκτελείται εκ μέρους ενός συντονιστή που έχει επικυρωθεί μέσω SSO (δείτε την ενότητα SSO παρακάτω για το πώς να δημιουργήσετε ένα token):
#include <iostream>
#include "FastCommentsClient/api/ModerationApi.h"
#include "FastCommentsClient/ApiClient.h"
#include "FastCommentsClient/ApiConfiguration.h"
int main() {
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
// ΑΠΑΙΤΟΥΜΕΝΟ: Ορίστε τη βασική URL
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::ModerationApi moderationApi(apiClient);
// Δώστε το SSO token του συντονιστή για να επικυρώσετε την κλήση
auto ssoToken = utility::conversions::to_string_t("YOUR_MODERATOR_SSO_TOKEN");
org::openapitools::client::api::GetCountOptions options;
options.sso = ssoToken;
auto response = moderationApi.getCount(options).get();
return 0;
}
Συνηθισμένα Προβλήματα
- Σφάλμα "URI must contain a hostname": Βεβαιωθείτε ότι καλείτε
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"))πριν δημιουργήσετε το ApiClient. Ο δημιουργός cpp-restsdk δεν διαβάζει αυτόματα τη διεύθυνση του διακομιστή από το OpenAPI spec. - Σφάλμα 401 "missing-api-key": Βεβαιωθείτε ότι καλείτε
config->setApiKey(utility::conversions::to_string_t("api_key"), utility::conversions::to_string_t("YOUR_KEY"))πριν δημιουργήσετε την παρουσία DefaultAPI. - Λάθος κλάση API: Χρησιμοποιήστε
DefaultApiγια αιτήματα επικυρωμένα από τον διακομιστή,PublicApiγια αιτήματα από την πλευρά του πελάτη/δημόσια, καιModerationApiγια αιτήματα του πίνακα ελέγχου συντονιστών (επικυρωμένα με token SSO συντονιστή).
Κλήσεις API: Συγχρονικές έναντι Ασυγχρονικών 
Όλες οι μέθοδοι API σε αυτό το SDK επιστρέφουν pplx::task<std::shared_ptr<ResponseType>> από το C++ REST SDK. Αυτό σας δίνει ευελιξία στον τρόπο που χειρίζεστε τις αποκρίσεις API.
Σύνθετες κλήσεις με .get()
Χρησιμοποιήστε το .get() για να μπλοκάρετε το νήμα που καλεί τη μέθοδο μέχρι να ολοκληρωθεί το αίτημα και να λάβετε το αποτέλεσμα συγχρονισμένα:
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
utility::conversions::to_string_t("YOUR_API_KEY"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// Οι απαιτούμενες παράμετροι είναι θέσεων· οι προαιρετικές πηγαίνουν στη δομή επιλογών
org::openapitools::client::api::GetCommentsOptions options;
options.urlId = utility::conversions::to_string_t("your-url-id");
// Κλήση .get() για να μπλοκάρει και να λάβει το αποτέλεσμα συγχρονισμένα
auto response = api.getComments(
utility::conversions::to_string_t("your-tenant-id"),
options
).get(); // Μπλοκάρει μέχρι να ολοκληρωθεί το HTTP αίτημα
if (response && response->comments) {
std::cout << "Found " << response->comments->size() << " comments" << std::endl;
}
Ασύγχρονες κλήσεις με .then()
Χρησιμοποιήστε το .then() για μη‑μπλοκαριστική ασύγχρονη εκτέλεση με callbacks:
auto config = std::make_shared<org::openapitools::client::api::ApiConfiguration>();
config->setBaseUrl(utility::conversions::to_string_t("https://fastcomments.com"));
config->setApiKey(utility::conversions::to_string_t("api_key"),
utility::conversions::to_string_t("YOUR_API_KEY"));
auto apiClient = std::make_shared<org::openapitools::client::api::ApiClient>(config);
org::openapitools::client::api::DefaultApi api(apiClient);
// Οι απαιτούμενες παράμετροι είναι θέσεων· οι προαιρετικές πηγαίνουν στη δομή επιλογών
org::openapitools::client::api::GetCommentsOptions options;
options.urlId = utility::conversions::to_string_t("your-url-id");
// Χρησιμοποιήστε .then() για εκτέλεση με βάση callbacks
api.getComments(
utility::conversions::to_string_t("your-tenant-id"),
options
).then([](std::shared_ptr<GetComments_200_response> response) {
// Αυτό εκτελείται ασύγχρονα όταν ολοκληρωθεί το αίτημα
if (response && response->comments) {
std::cout << "Found " << response->comments->size() << " comments" << std::endl;
}
});
// Η εκτέλεση συνεχίζεται άμεσα χωρίς μπλοκάρισμα
std::cout << "Request sent, continuing..." << std::endl;
Επιλογή μεταξύ Συγχρονικής και Ασύγχρονης
Η επιλογή εξαρτάται από το περιβάλλον εκτέλεσής σας και την αρχιτεκτονική της εφαρμογής:
.get() (Συγχρονικό μπλοκάρισμα)
- Μπλοκάρει το νήμα που καλεί τη μέθοδο μέχρι να ολοκληρωθεί το HTTP αίτημα
- Πιο απλή ροή κώδικα, πιο εύκολο στην κατανόηση
- Κατάλληλο για αποκλειστικά νήματα εργατών, batch επεξεργασία ή εργαλεία γραμμής εντολών
- Μη κατάλληλο για βρόχους συμβάντων, νήματα GUI ή μονονηματικούς διακομιστές
.then() (Ασύγχρονο μη‑μπλοκάρισμα)
- Επιστρέφει αμέσως, το callback εκτελείται όταν ολοκληρωθεί το αίτημα
- Δεν μπλοκάρει το νήμα που καλεί τη μέθοδο
- Απαιτείται για αρχιτεκτονικές γεγονότων, GUI εφαρμογές ή μονονηματικούς βρόχους συμβάντων
- Επιτρέπει αλυσίδωση πολλαπλών λειτουργιών
- Πιο πολύπλοκη ροή ελέγχου
Η ομάδα δοκιμών του SDK χρησιμοποιεί αποκλειστικά .get(), αλλά αυτό είναι κατάλληλο για το περιβάλλον δοκιμών όπου το μπλοκάρισμα είναι αποδεκτό.
Σημειώσεις 
Αναγνωριστικά Broadcast
Θα δείτε ότι πρέπει να περάσετε ένα broadcastId σε κάποιες κλήσεις API. Όταν λάβετε συμβάντα, θα λάβετε πίσω αυτό το ID, οπότε θα ξέρετε να αγνοήσετε το συμβάν αν σκοπεύετε να εφαρμόσετε αλλαγές στον πελάτη με αισιοδοξία (κάτι που πιθανότατα θα θέλετε να κάνετε αφού προσφέρει την καλύτερη εμπειρία). Περνάτε εδώ ένα UUID. Το ID θα πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές σε μια συνεδρία προγράμματος περιήγησης.
SSO (Ενιαία Σύνδεση)
Για παραδείγματα SSO, δείτε παρακάτω.
Χρήση SSO 
Απλό SSO
#include <fastcomments/sso/fastcomments_sso.hpp>
#include <iostream>
using namespace fastcomments::sso;
int main() {
SimpleSSOUserData user("user-123", "user@example.com", "https://example.com/avatar.jpg");
FastCommentsSSO sso = FastCommentsSSO::newSimple(user);
std::string token = sso.createToken();
std::cout << "SSO Token: " << token << std::endl;
return 0;
}
Ασφαλές SSO
#include <fastcomments/sso/fastcomments_sso.hpp>
#include <iostream>
using namespace fastcomments::sso;
int main() {
SecureSSOUserData user("user-123", "user@example.com", "johndoe", "https://example.com/avatar.jpg");
std::string apiKey = "your-api-key";
FastCommentsSSO sso = FastCommentsSSO::newSecure(apiKey, user);
std::string token = sso.createToken();
std::cout << "Secure SSO Token: " << token << std::endl;
return 0;
}
Τεκμηρίωση για το fastcomments 
Τεκμηρίωση για τα API Endpoints
All URIs are relative to https://fastcomments.com
| Κατηγορία | Μέθοδος | Αίτημα HTTP | Περιγραφή |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | Συγκεντρώνει έγγραφα ομαδοποιώντας τα (εάν παρέχεται το groupBy) και εφαρμόζοντας πολλαπλές λειτουργίες. Υποστηρίζονται διαφορετικές λειτουργίες (π.χ. άθροισμα, countDistinct, μέσος όρος, κλπ.). |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | req tenantId afterId |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/mod_api/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/mod_api/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/mod_api/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/mod_api/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/mod_api/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/mod_api/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/mod_api/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/mod_api/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/mod_api/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/mod_api/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/mod_api/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/mod_api/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/mod_api/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/mod_api/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/mod_api/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/mod_api/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/mod_api/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/mod_api/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/mod_api/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/mod_api/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/mod_api/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/mod_api/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/mod_api/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/mod_api/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/mod_api/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/mod_api/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/mod_api/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/mod_api/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/mod_api/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/mod_api/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/mod_api/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/mod_api/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/mod_api/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/mod_api/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/mod_api/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/mod_api/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/mod_api/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/mod_api/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/mod_api/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/mod_api/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/mod_api/set-trust-factor | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | req tenantId urlId |
| PublicApi | getEventLog | GET /event-log/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | req tenantId afterId |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | Παλιότεροι σχολιαστές στη σελίδα που ΔΕΝ είναι επί του παρόντος συνδεδεμένοι. Ταξινομημένα κατά displayName. Χρησιμοποιήστε το μετά την εξάντληση του /users/online για να αποδώσετε μια ενότητα "Members". Σελιδοποίηση κατά commenterName: ο διακομιστής διασχίζει το μερικό ευρετήριο {tenantId, urlId, commenterName} από afterName προς τα εμπρός μέσω $gt, χωρίς κόστος $skip. |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | Τρέχοντες online θεατές μιας σελίδας: άτομα των οποίων η συνδρομή WebSocket είναι εγγεγραμμένη στη σελίδα αυτή τη στιγμή. Επιστρέφει anonCount + totalCount (συνδρομητές σε ολόκληρο το δωμάτιο, συμπεριλαμβανομένων των ανώνυμων θεατών που δεν απαριθμούμε). |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | Λίστα σελίδων για έναν ενοικιαστή. Χρησιμοποιείται από τον πελάτη desktop FChat για να γεμίσει τη λίστα δωματίων του. Απαιτεί το enableFChat να είναι true στην επιλυμένη προσαρμοσμένη ρύθμιση για κάθε σελίδα. Σελίδες που απαιτούν SSO φιλτράρονται βάσει της προσπέλασης ομάδας του χρήστη που κάνει το αίτημα. |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | getUsersInfo | GET /pages/{tenantId}/users/info | Συγκεντρωτικές πληροφορίες χρηστών για έναν ενοικιαστή. Δίνοντας userIds, επιστρέφει πληροφορίες εμφάνισης από User / SSOUser. Χρησιμοποιείται από το widget σχολίων για να εμπλουτίσει χρήστες που μόλις εμφανίστηκαν μέσω συμβάντος παρουσίας. Χωρίς περιβάλλον σελίδας: η ιδιωτικότητα επιβάλλεται ομοιόμορφα (ιδιωτικά προφίλ καλύπτονται). |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | Ενεργοποίηση ή απενεργοποίηση ειδοποιήσεων για ένα συγκεκριμένο σχόλιο. |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | Ενεργοποίηση ή απενεργοποίηση ειδοποιήσεων για μια σελίδα. Όταν οι χρήστες είναι εγγεγραμμένοι σε μια σελίδα, δημιουργούνται ειδοποιήσεις για νέα root σχόλια, και επίσης |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | Ανεβάστε και αλλάξτε το μέγεθος μιας εικόνας |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Τεκμηρίωση για τα Μοντέλα
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBase_meta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponse_anyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequest_sort
- AggregationResponse
- AggregationResponse_stats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchType
- BannedUserMatch_matchedOnValue
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- [BulkAggregateQuestionResultsRequest](https://github.com/FastComments/fastcomments-cpp/blob/master/docs/Models/Bulk
aggregate 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| aggregationRequest | AggregationRequest | Ναι | |
| options | const AggregateOptions& | Ναι |
Απάντηση
Επιστρέφει: AggregateResponse
Παράδειγμα

getAuditLogs 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetAuditLogsOptions& | Yes |
Απόκριση
Επιστρέφει: GetAuditLogsResponse
Παράδειγμα

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

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

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

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

blockUserFromComment 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Ναι | |
| blockFromCommentParams | BlockFromCommentParams | Ναι | |
| options | const BlockUserFromCommentOptions& | Ναι |
Απάντηση
Επιστρέφει: BlockSuccess
Παράδειγμα

createCommentPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| broadcastId | string | Ναι | |
| commentData | CommentData | Ναι | |
| options | const CreateCommentPublicOptions& | Ναι |
Απόκριση
Επιστρέφει: SaveCommentsResponseWithPresence
Παράδειγμα

deleteComment 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Ναι | |
| options | const DeleteCommentOptions& | Ναι |
Response
Επιστρέφει: DeleteCommentResult
Example

deleteCommentPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | Yes | |
| options | const DeleteCommentPublicOptions& | Yes |
Απόκριση
Επιστρέφει: PublicAPIDeleteCommentResponse
Παράδειγμα

deleteCommentVote 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| voteId | string | Yes | |
| urlId | string | Yes | |
| broadcastId | string | Yes | |
| options | const DeleteCommentVoteOptions& | Yes |
Απάντηση
Επιστρέφει: VoteDeleteResponse
Παράδειγμα

flagComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Ναι | |
| options | const FlagCommentOptions& | Ναι |
Απάντηση
Επιστρέφει: FlagCommentResponse
Παράδειγμα

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

getComments 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetCommentsOptions& | Yes |
Απόκριση
Επιστρέφει: APIGetCommentsResponse
Παράδειγμα

getCommentsPublic 
req tenantId urlId
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| options | const GetCommentsPublicOptions& | Ναι |
Απόκριση
Επιστρέφει: GetCommentsResponseWithPresence_PublicComment_
Παράδειγμα

getCommentText 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const GetCommentTextOptions& | Yes |
Απόκριση
Επιστρέφει: PublicAPIGetCommentTextResponse
Παράδειγμα

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

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

pinComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| broadcastId | string | Yes | |
| sso | string | No |
Απόκριση
Returns: ChangeCommentPinStatusResponse
Παράδειγμα

saveComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createCommentParams | CreateCommentParams | Ναι | |
| options | const SaveCommentOptions& | Ναι |
Απάντηση
Επιστρέφει: APISaveCommentResponse
Παράδειγμα

setCommentText 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| broadcastId | string | Ναι | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Ναι | |
| options | const SetCommentTextOptions& | Ναι |
Απόκριση
Επιστρέφει: PublicAPISetCommentTextResponse
Παράδειγμα

unBlockUserFromComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Yes | |
| options | const UnBlockUserFromCommentOptions& | Yes |
Απόκριση
Επιστρέφει: UnblockSuccess
Παράδειγμα

unFlagComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| options | const UnFlagCommentOptions& | Yes |
Απόκριση
Επιστρέφει: FlagCommentResponse
Παράδειγμα

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

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

updateComment 
Παράμετροι
| Name | Type | Απαιτείται | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Ναι | |
| updatableCommentParams | UpdatableCommentParams | Ναι | |
| options | const UpdateCommentOptions& | Ναι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

voteComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| urlId | string | Ναι | |
| broadcastId | string | Ναι | |
| voteBodyParams | VoteBodyParams | Ναι | |
| options | const VoteCommentOptions& | Ναι |
Απόκριση
Επιστρέφει: VoteResponse
Παράδειγμα

getCommentsForUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| options | const GetCommentsForUserOptions& | Yes |
Απάντηση
Επιστρέφει: GetCommentsForUserResponse
Παράδειγμα

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

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

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

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

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

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

createEmailTemplate 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| createEmailTemplateBody | CreateEmailTemplateBody | Yes |
Response
Επιστρέφει: CreateEmailTemplateResponse
Example

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

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

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

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

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

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

renderEmailTemplate 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Yes | |
| locale | string | No |
Response
Επιστρέφει: RenderEmailTemplateResponse
Example

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

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

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

createFeedPost 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| createFeedPostParams | CreateFeedPostParams | Yes | |
| options | const CreateFeedPostOptions& | Yes |
Απάντηση
Επιστρέφει: CreateFeedPostsResponse
Παράδειγμα

createFeedPostPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| createFeedPostParams | CreateFeedPostParams | Yes | |
| options | const CreateFeedPostPublicOptions& | Yes |
Απάντηση
Επιστρέφει: CreateFeedPostResponse
Παράδειγμα

deleteFeedPostPublic 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| postId | string | Ναι | |
| options | const DeleteFeedPostPublicOptions& | Ναι |
Response
Επιστρέφει: DeleteFeedPostPublicResponse
Παράδειγμα

getFeedPosts 
req tenantId afterId
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetFeedPostsOptions& | Yes |
Απόκριση
Επιστρέφει: GetFeedPostsResponse
Παράδειγμα

getFeedPostsPublic 
αίτηση
tenantId
afterId
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetFeedPostsPublicOptions& | Yes |
Απόκριση
Επιστρέφει: PublicFeedPostsResponse
Παράδειγμα

getFeedPostsStats 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| postIds | vector<string | Yes | |
| sso | string | No |
Απόκριση
Επιστρέφει: FeedPostsStatsResponse
Παράδειγμα

getUserReactsPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetUserReactsPublicOptions& | Ναι |
Απάντηση
Επιστρέφει: UserReactsResponse
Παράδειγμα

reactFeedPostPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| postId | string | Yes | |
| reactBodyParams | ReactBodyParams | Yes | |
| options | const ReactFeedPostPublicOptions& | Yes |
Απάντηση
Επιστρέφει: ReactFeedPostResponse
Παράδειγμα

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

updateFeedPostPublic 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| postId | string | Yes | |
| updateFeedPostParams | UpdateFeedPostParams | Yes | |
| options | const UpdateFeedPostPublicOptions& | Yes |
Απόκριση
Επιστρέφει: CreateFeedPostResponse
Παράδειγμα

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

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

getGifsSearch 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| search | string | Yes | |
| options | const GetGifsSearchOptions& | Yes |
Response
Επιστρέφει: GetGifsSearchResponse
Example

getGifsTrending 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetGifsTrendingOptions& | Yes |
Απόκριση
Επιστρέφει: GetGifsTrendingResponse
Παράδειγμα

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

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

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

getHashTags 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| page | double | No |
Απάντηση
Επιστρέφει: GetHashTagsResponse
Παράδειγμα

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

deleteModerationVote 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| voteId | string | Yes | |
| options | const DeleteModerationVoteOptions& | Yes |
Απάντηση
Επιστρέφει: VoteDeleteResponse
Παράδειγμα

getApiComments 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetApiCommentsOptions& | Yes |
Απόκριση
Επιστρέφει: ModerationAPIGetCommentsResponse
Παράδειγμα

getApiExportStatus 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetApiExportStatusOptions& | Ναι |
Απάντηση
Επιστρέφει: ModerationExportStatusResponse
Παράδειγμα

getApiIds 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetApiIdsOptions& | Yes |
Απάντηση
Επιστρέφει: ModerationAPIGetCommentIdsResponse
Παράδειγμα

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

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

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

getCount 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetCountOptions& | Ναι |
Απάντηση
Επιστρέφει: ModerationAPICountCommentsResponse
Παράδειγμα

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

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

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

getManualBadgesForUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetManualBadgesForUserOptions& | Ναι |
Απόκριση
Επιστρέφει: GetUserManualBadgesResponse
Παράδειγμα

getModerationComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const GetModerationCommentOptions& | Yes |
Απάντηση
Επιστρέφει: ModerationAPICommentResponse
Παράδειγμα

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

getPreBanSummary 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| options | const GetPreBanSummaryOptions& | Ναι |
Απάντηση
Επιστρέφει: PreBanSummary
Παράδειγμα

getSearchCommentsSummary 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetSearchCommentsSummaryOptions& | Yes |
Απόκριση
Επιστρέφει: ModerationCommentSearchResponse
Παράδειγμα

getSearchPages 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetSearchPagesOptions& | Ναι |
Απόκριση
Επιστρέφει: ModerationPageSearchResponse
Παράδειγμα

getSearchSites 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetSearchSitesOptions& | Yes |
Απάντηση
Επιστρέφει: ModerationSiteSearchResponse
Παράδειγμα

getSearchSuggest 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetSearchSuggestOptions& | Yes |
Response
Επιστρέφει: ModerationSuggestResponse
Παράδειγμα

getSearchUsers 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetSearchUsersOptions& | Ναι |
Response
Επιστρέφει: ModerationUserSearchResponse
Example

getTrustFactor 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetTrustFactorOptions& | Yes |
Απάντηση
Επιστρέφει: GetUserTrustFactorResponse
Παράδειγμα

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

getUserInternalProfile 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetUserInternalProfileOptions& | Ναι |
Απόκριση
Επιστρέφει: GetUserInternalProfileResponse
Παράδειγμα

postAdjustCommentVotes 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| adjustCommentVotesParams | AdjustCommentVotesParams | Yes | |
| options | const PostAdjustCommentVotesOptions& | Yes |
Απάντηση
Επιστρέφει: AdjustVotesResponse
Παράδειγμα

postApiExport 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const PostApiExportOptions& | Ναι |
Απάντηση
Επιστρέφει: ModerationExportResponse
Παράδειγμα

postBanUserFromComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| options | const PostBanUserFromCommentOptions& | Ναι |
Απόκριση
Επιστρέφει: BanUserFromCommentResult
Παράδειγμα

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

postBulkPreBanSummary 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| bulkPreBanParams | BulkPreBanParams | Yes | |
| options | const PostBulkPreBanSummaryOptions& | Yes |
Απόκριση
Returns: BulkPreBanSummary
Παράδειγμα

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

postFlagComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostFlagCommentOptions& | Yes |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postRemoveComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostRemoveCommentOptions& | Yes |
Απάντηση
Επιστρέφει: PostRemoveCommentApiResponse
Παράδειγμα

postRestoreDeletedComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| options | const PostRestoreDeletedCommentOptions& | Ναι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postSetCommentApprovalStatus 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostSetCommentApprovalStatusOptions& | Yes |
Απόκριση
Returns: SetCommentApprovedResponse
Παράδειγμα

postSetCommentReviewStatus 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| options | const PostSetCommentReviewStatusOptions& | Ναι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postSetCommentSpamStatus 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostSetCommentSpamStatusOptions& | Yes |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postSetCommentText 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| setCommentTextParams | SetCommentTextParams | Yes | |
| options | const PostSetCommentTextOptions& | Yes |
Απόκριση
Επιστρέφει: SetCommentTextResponse
Παράδειγμα

postUnFlagComment 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| commentId | string | Ναι | |
| options | const PostUnFlagCommentOptions& | Ναι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

postVote 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| options | const PostVoteOptions& | Yes |
Απόκριση
Επιστρέφει: VoteResponse
Παράδειγμα

putAwardBadge 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| badgeId | string | Yes | |
| options | const PutAwardBadgeOptions& | Yes |
Απάντηση
Επιστρέφει: AwardUserBadgeResponse
Παράδειγμα

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

putRemoveBadge 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| badgeId | string | Ναι | |
| options | const PutRemoveBadgeOptions& | Ναι |
Απόκριση
Επιστρέφει: RemoveUserBadgeResponse
Παράδειγμα

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

setTrustFactor 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const SetTrustFactorOptions& | Ναι |
Απόκριση
Επιστρέφει: SetUserTrustFactorResponse
Παράδειγμα

createModerator 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| createModeratorBody | CreateModeratorBody | Yes |
Απάντηση
Returns: CreateModeratorResponse
Παράδειγμα

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

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

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

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

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

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

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

getNotificationCount 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetNotificationCountOptions& | Yes |
Απάντηση
Επιστρέφει: GetNotificationCountResponse
Παράδειγμα

getNotifications 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetNotificationsOptions& | Ναι |
Απάντηση
Επιστρέφει: GetNotificationsResponse
Παράδειγμα

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

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

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

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

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

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

getV2PageReacts 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι |
Response
Returns: GetV2PageReacts
Example

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

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

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

getOfflineUsers 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Χρησιμοποιήστε το αυτό μετά την κλήση /users/online για να αποδώσετε μια ενότητα "Members".
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Σελιδοποίηση με δείκτη στο commenterName: ο διακομιστής προχωρά το μερικό {tenantId, urlId, commenterName} δείκτη από afterName προς τα εμπρός μέσω $gt, χωρίς κόστος $skip.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| options | const GetOfflineUsersOptions& | Yes |
Response
Returns: PageUsersOfflineResponse
Example

getOnlineUsers 
Τρέχοντες online θεατές μιας σελίδας: άτομα των οποίων η συνεδρία websocket είναι εγγεγραμμένη στη σελίδα αυτή τη στιγμή.
Επιστρέφει anonCount + totalCount (συνδρομητές σε όλο το δωμάτιο, συμπεριλαμβανομένων των ανώνυμων θεατών που δεν καταχωρούμε).
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| options | const GetOnlineUsersOptions& | Yes |
Response
Επιστρέφει: PageUsersOnlineResponse
Παράδειγμα

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

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

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetPagesPublicOptions& | Yes |
Απάντηση
Επιστρέφει: GetPublicPagesResponse
Παράδειγμα

getUsersInfo 
Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| ids | string | Yes |
Απάντηση
Επιστρέφει: PageUsersInfoResponse
Παράδειγμα

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

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

getPendingWebhookEventCount 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetPendingWebhookEventCountOptions& | Ναι |
Απάντηση
Επιστρέφει: GetPendingWebhookEventCountResponse
Example

getPendingWebhookEvents 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetPendingWebhookEventsOptions& | Ναι |
Απόκριση
Επιστρέφει: GetPendingWebhookEventsResponse
Παράδειγμα

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

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

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

getQuestionConfigs 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| skip | double | Όχι |
Response
Επιστρέφει: GetQuestionConfigsResponse
Παράδειγμα

updateQuestionConfig 
Παράμετροι
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Yes |
Απάντηση
Returns: APIEmptyResponse
Παράδειγμα

createQuestionResult 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createQuestionResultBody | CreateQuestionResultBody | Ναι |
Response
Επιστρέφει: CreateQuestionResultResponse
Example

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

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

getQuestionResults 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetQuestionResultsOptions& | Ναι |
Απάντηση
Επιστρέφει: GetQuestionResultsResponse
Παράδειγμα

updateQuestionResult 
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| updateQuestionResultBody | UpdateQuestionResultBody | Yes |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

aggregateQuestionResults 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const AggregateQuestionResultsOptions& | Ναι |
Απόκριση
Επιστρέφει: AggregateQuestionResultsResponse
Παράδειγμα

bulkAggregateQuestionResults 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Yes | |
| forceRecalculate | bool | No |
Απάντηση
Επιστρέφει: BulkAggregateQuestionResultsResponse
Παράδειγμα

combineCommentsWithQuestionResults 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const CombineCommentsWithQuestionResultsOptions& | Ναι |
Απάντηση
Επιστρέφει: CombineQuestionResultsWithCommentsResponse
Παράδειγμα

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

deleteSSOUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| id | string | Ναι | |
| options | const DeleteSSOUserOptions& | Ναι |
Απόκριση
Επιστρέφει: DeleteSSOUserAPIResponse
Παράδειγμα

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

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

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

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

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

createSubscription 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | Ναι |
Απάντηση
Returns: CreateSubscriptionAPIResponse
Παράδειγμα

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

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

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

getTenantDailyUsages 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetTenantDailyUsagesOptions& | Yes |
Απόκριση
Επιστρέφει: GetTenantDailyUsagesResponse
Παράδειγμα

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

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

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

getTenantPackages 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| skip | double | No |
Απάντηση
Επιστρέφει: GetTenantPackagesResponse
Παράδειγμα

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

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

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

deleteTenantUser 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| options | const DeleteTenantUserOptions& | Yes |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

getTenantUsers 
Παράμετροι
| Όνομα | Τύπος | Υποχρεωτικό | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| skip | double | Όχι |
Απάντηση
Επιστρέφει: GetTenantUsersResponse
Παράδειγμα

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

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

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

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

deleteTenant 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| sure | string | No |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

getTenants 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetTenantsOptions& | Yes |
Απόκριση
Επιστρέφει: GetTenantsResponse
Παράδειγμα

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

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

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

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

getTickets 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetTicketsOptions& | Ναι |
Απάντηση
Επιστρέφει: GetTicketsResponse
Παράδειγμα

getTranslations 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| r_namespace | string | Ναι | |
| component | string | Ναι | |
| options | const GetTranslationsOptions& | Ναι |
Απόκριση
Επιστρέφει: GetTranslationsResponse
Παράδειγμα

uploadImage 
Μεταφόρτωση και αλλαγή μεγέθους εικόνας
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| file | HttpContent | Ναι | |
| options | const UploadImageOptions& | Ναι |
Response
Επιστρέφει: UploadImageResponse
Example

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

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

getUserBadgeProgressList 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetUserBadgeProgressListOptions& | Ναι |
Απάντηση
Επιστρέφει: APIGetUserBadgeProgressListResponse
Παράδειγμα

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

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

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

getUserBadges 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const GetUserBadgesOptions& | Ναι |
Απάντηση
Επιστρέφει: APIGetUserBadgesResponse
Παράδειγμα

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

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

getUserNotifications 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| options | const GetUserNotificationsOptions& | Yes |
Απόκριση
Επιστρέφει: GetMyNotificationsResponse
Παράδειγμα

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

resetUserNotifications 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| options | const ResetUserNotificationsOptions& | Ναι |
Απάντηση
Επιστρέφει: ResetUserNotificationsResponse
Παράδειγμα

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

updateUserNotificationPageSubscriptionStatus 
Enable ή απενεργοποίηση ειδοποιήσεων για μια σελίδα. Όταν οι χρήστες είναι εγγεγραμμένοι σε μια σελίδα, δημιουργούνται ειδοποιήσεις για νέα βασικά σχόλια, και επίσης
Parameters
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| url | string | Yes | |
| pageTitle | string | Yes | |
| subscribedOrUnsubscribed | string | Yes | |
| sso | string | No |
Response
Returns: UpdateUserNotificationPageSubscriptionStatusResponse
Example

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

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

searchUsers 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Ναι | |
| urlId | string | Ναι | |
| options | const SearchUsersOptions& | Ναι |
Απάντηση
Επιστρέφει: SearchUsersResult
Παράδειγμα

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

createVote 
Παράμετροι
| Όνομα | Τύπος | Απαιτείται | Περιγραφή |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| direction | string | Yes | |
| options | const CreateVoteOptions& | Yes |
Απάντηση
Επιστρέφει: VoteResponse
Παράδειγμα

deleteVote 
Παράμετροι
| Όνομα | Τύπος | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | Yes | |
| editKey | string | No |
Response
Επιστρέφει: VoteDeleteResponse
Παράδειγμα

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

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

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