
Γλώσσα 🇨🇾 Ελληνικά (Κύπρος)
Εισαγωγή
Τεκμηρίωση
Συγκεντρωτικά
Καταγραφές ελέγχου
Αυθεντικοποίηση
Αποκλεισμός από σχόλιο
Έλεγχος αποκλεισμένων σχολίων
Σχόλια
Σχόλια για χρήστη
Ρυθμίσεις domain
Πρότυπα email
Αρχείο συμβάντων
Αναρτήσεις ροής
Σήμανση σχολίου
GIFs
Hashtags
Επιμέλεια
Διαχειριστές
Αριθμός ειδοποιήσεων
Ειδοποιήσεις
Αντιδράσεις σε σελίδα
Σελίδες
Εκκρεμή γεγονότα webhook
Ρυθμίσεις ερωτήσεων
Αποτελέσματα ερωτήσεων
Συγκέντρωση αποτελεσμάτων ερωτήσεων
Χρήστες SSO
Συνδρομές
Ημερήσια χρήση tenant
Πακέτα tenant
Χρήστες tenant
Tenants
Εισιτήρια
Μεταφράσεις
Μεταφόρτωση εικόνας
Πρόοδος διακριτικού χρήστη
Διακριτικά χρήστη
Ειδοποιήσεις χρήστη
Κατάσταση παρουσίας χρήστη
Αναζήτηση χρηστών
Χρήστες
Ψήφοι
FastComments SDK για Python
Αυτό είναι το επίσημο Python SDK για το FastComments.
Επίσημο Python SDK για το API του FastComments
Αποθετήριο
Εγκατάσταση 
Εγκατάσταση από το GitHub
Εγκατάσταση άμεσα από μια ετικέτα έκδοσης (συνιστάται, πλήρως επαναλήψιμη):
pip install git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Καρφιτρώστε την ετικέτα αντί για ένα κλάδο ώστε οι κατασκευές να είναι ντετερμινιστικές. Η ίδια μορφή λειτουργεί στο requirements.txt:
fastcomments @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0
Κάθε ετικετοποιημένη GitHub Release διαθέτει επίσης ένα κατασκευασμένο wheel συνημμένο εάν προτιμάτε να εγκαταστήσετε ένα δυαδικό τεχνητό απευθείας.
Περιεχόμενα Βιβλιοθήκης
Αυτή η βιβλιοθήκη περιέχει δύο modules: τον δημιουργημένο πελάτη API και τη βασική βιβλιοθήκη Python που περιλαμβάνει χειροκίνητες βοηθητικές λειτουργίες για να διευκολύνει τη χρήση του API, συμπεριλαμβανομένης της υποστήριξης SSO.
Δημόσια vs Ασφαλείς API
Για τον πελάτη API, υπάρχουν τρεις κλάσεις, DefaultApi, PublicApi και ModerationApi. Η DefaultApi περιέχει μεθόδους που απαιτούν το κλειδί API σας, και η PublicApi περιέχει μεθόδους που μπορούν να κληθούν απευθείας από έναν περιηγητή/συσκευή κινητής κ.λπ. χωρίς έλεγχο ταυτότητας. Η ModerationApi παρέχει μια εκτενή σειρά από ζωντανά και γρήγορα API διαmoderation. Κάθε μέθοδος της ModerationApi δέχεται μια παράμετρο sso και μπορεί να πιστοποιηθεί μέσω SSO ή ενός cookie συνεδρίας FastComments.com.
Γρήγορη εκκίνηση 
Χρήση Πιστοποιημένων API (DefaultApi)
Σημαντικό: Πρέπει να ορίσετε το κλειδί API σας στη Configuration πριν κάνετε πιστοποιημένα αιτήματα. Αν δεν το κάνετε, τα αιτήματα θα αποτύχουν με σφάλμα 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Δημιουργία και διαμόρφωση του πελάτη API
config = Configuration()
config.host = "https://fastcomments.com"
# ΑΠΑΙΤΟΥΜΕΝΟ: Ορίστε το κλειδί API σας (λάβετε το από τον πίνακα ελέγχου FastComments)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}
# Δημιουργία της παρουσίασης API με τον διαμορφωμένο πελάτη
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Τώρα μπορείτε να κάνετε πιστοποιημένες κλήσεις API
try:
# Παράδειγμα: Προσθήκη χρήστη SSO
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user("YOUR_TENANT_ID", user_data)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Συχνά σφάλματα:
# - 401: Το κλειδί API λείπει ή δεν είναι έγκυρο
# - 400: Η έγκριση του αιτήματος απέτυχε
Χρήση Δημόσιων API (PublicApi)
Τα δημόσια σημεία τέλους δεν απαιτούν πιστοποίηση:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public("YOUR_TENANT_ID", "page-url-id")
print(response)
except Exception as e:
print(f"Error: {e}")
Χρήση του Πίνακα Διαχείρισης Εποπτείας (ModerationApi)
Το ModerationApi τροφοδοτεί τον πίνακα ελεγκτή. Οι μέθοδοι καλούνται εκ μέρους ενός ελεγκτή περνώντας ένα διακριτικό sso:
from client import ApiClient, Configuration, ModerationApi
from client.api.moderation_api import GetCountOptions
config = Configuration()
config.host = "https://fastcomments.com"
api_client = ApiClient(configuration=config)
moderation_api = ModerationApi(api_client)
try:
# Καταμέτρηση των σχολίων που περιμένουν εποπτεία
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
Χρήση SSO (Μονή Σύνδεση)
Το SDK περιλαμβάνει βοηθητικά εργαλεία για τη δημιουργία ασφαλών διακριτικών SSO:
from sso import FastCommentsSSO, SecureSSOUserData
# Δημιουργία δεδομένων χρήστη (απαιτούνται id, email και username)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Υπογράψτε το με το μυστικό API σας (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# Δημιουργήστε το διακριτικό SSO για να το περάσετε στο widget ή σε κλήση API
sso_token = sso.create_token()
# Χρησιμοποιήστε αυτό το διακριτικό στο frontend ή περάστε το σε κλήσεις API
print(f"SSO Token: {sso_token}")
Για απλό SSO (λιγότερο ασφαλές, για δοκιμές):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
username="johndoe",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Συχνά Προβλήματα
- Σφάλμα 401 "missing-api-key": Βεβαιωθείτε ότι έχετε ορίσει
config.api_key = {"api_key": "YOUR_KEY"}πριν δημιουργήσετε την παρουσία DefaultApi. - Λάθος κλάση API: Χρησιμοποιήστε
DefaultApiγια αιτήματα πιστοποιημένα στο διακομιστή,PublicApiγια αιτήματα πελάτη/δημόσια, καιModerationApiγια αιτήματα πίνακα ελεγκτή. - Σφάλματα εισαγωγής: Βεβαιωθείτε ότι εισάγετε από το σωστό μοντέλο:
- Πελάτης API:
from client import ... - Βοηθητικά SSO:
from sso import ...
- Πελάτης API:
Σημειώσεις 
Αναγνωριστικά Broadcast
Θα δείτε ότι πρέπει να περάσετε ένα broadcast_id σε ορισμένες κλήσεις API. Όταν λαμβάνετε συμβάντα, θα λάβετε αυτό το ID πίσω, οπότε θα ξέρετε να αγνοήσετε το συμβάν εάν σκοπεύετε να εφαρμόσετε αλλαγές οπτιμιστικά στην πλευρά του πελάτη (κάτι που μάλλον θα θέλετε να κάνετε καθώς προσφέρει την καλύτερη εμπειρία). Περάστε εδώ ένα UUID. Το ID πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές σε μία συνεδρία προγράμματος περιήγησης.
Απαιτήσεις 
- Python >= 3.8
Η βασική εγκατάσταση είναι pure-stdlib και παρέχει τις βοηθητικές λειτουργίες SSO. Ο παραγόμενο πελάτης API (DefaultApi/PublicApi/ModerationApi) χρειάζεται το πρόσθετο client, το οποίο ενσωματώνει τα urllib3 >= 1.25.3, python-dateutil >= 2.8.2,
pydantic >= 2.0.0, και typing-extensions >= 4.0.0:
pip install "fastcomments[client] @ git+https://github.com/fastcomments/fastcomments-python.git@v3.0.0"
Συγκεντρωτικά 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| parentTenantId | string | query | Όχι | |
| includeStats | boolean | query | Όχι |
Response
Επιστρέφει: AggregateResponse
Example

Λήψη καταγραφών ελέγχου 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| limit | number | query | Όχι | |
| skip | number | query | Όχι | |
| order | string | query | Όχι | |
| after | number | query | Όχι | |
| before | number | query | Όχι |
Απάντηση
Επιστρέφει: GetAuditLogsResponse
Παράδειγμα

Αποσύνδεση (δημόσιο) 
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

Λήψη σχολίου 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: APIGetCommentResponse
Παράδειγμα

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

Λήψη ονομάτων χρηστών που ψήφισαν σχόλιο 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| commentId | string | path | Ναι | |
| dir | integer | query | Ναι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: GetCommentVoteUserNamesSuccessResponse
Παράδειγμα

Λήψη σχολίων 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No | |
| fromDate | integer | query | No | |
| toDate | integer | query | No |
Απάντηση
Επιστρέφει: APIGetCommentsResponse
Παράδειγμα

Λήψη δημόσιων σχολίων 
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 |
Απάντηση
Επιστρέφει: GetCommentsResponseWithPresencePublicComment
Παράδειγμα

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

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

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

Μαζική αποθήκευση σχολίων 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Response
Επιστρέφει: SaveCommentsBulkResponse
Example

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

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

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

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

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

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

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

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

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

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

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

Λήψη ρυθμίσεων domain 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: GetDomainConfigsResponse
Παράδειγμα

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

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

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

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

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

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

Λήψη ορισμών προτύπων email 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Απάντηση
Επιστρέφει: GetEmailTemplateDefinitionsResponse
Παράδειγμα

Λήψη σφαλμάτων απόδοσης προτύπων email 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| skip | number | query | Όχι |
Απόκριση
Επιστρέφει: GetEmailTemplateRenderErrorsResponse
Παράδειγμα

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

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

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

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

Λήψη παγκόσμιου αρχείου συμβάντων 
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
Παράδειγμα

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

Δημιουργία δημόσιας ανάρτησης ροής 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: CreateFeedPostResponse
Example

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

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

Λήψη δημόσιων αναρτήσεων ροής 
req tenantId afterId
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Απάντηση
Επιστρέφει: PublicFeedPostsResponse
Παράδειγμα

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

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

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

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

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

Σήμανση σχολίου (δημόσιο) 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | path | Ναι | |
| isFlagged | boolean | query | Ναι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

Λήψη μεγάλου GIF 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| largeInternalURLSanitized | string | query | Ναι |
Απόκριση
Επιστρέφει: GifGetLargeResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

Λήψη αναγνωριστικών API 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| text-search | string | query | Όχι | |
| byIPFromComment | string | query | Όχι | |
| filters | string | query | Όχι | |
| searchFilters | string | query | Όχι | |
| afterId | string | query | Όχι | |
| demo | boolean | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: ModerationAPIGetCommentIdsResponse
Παράδειγμα

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

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

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

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

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

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

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

Λήψη χειροκίνητων διακριτικών για χρήστη 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| badgesUserId | string | query | Όχι | |
| commentId | string | query | Όχι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: GetUserManualBadgesResponse
Example

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

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

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

Λήψη περίληψης αναζήτησης σχολίων 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| value | string | query | Όχι | |
| filters | string | query | Όχι | |
| searchFilters | string | query | Όχι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: ModerationCommentSearchResponse
Example

Λήψη σελίδων αναζήτησης 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Απόκριση
Returns: ModerationPageSearchResponse
Παράδειγμα

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

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

Λήψη χρηστών αναζήτησης 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| value | string | query | Όχι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: ModerationUserSearchResponse
Παράδειγμα

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

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

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

Προσαρμογή ψήφων σχολίων 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | Ερώτημα | Ναι | |
| commentId | string | Διαδρομή | Ναι | |
| broadcastId | string | Ερώτημα | Όχι | |
| sso | string | Ερώτημα | Όχι |
Response
Επιστρέφει: AdjustVotesResponse
Παράδειγμα

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

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

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

Μαζική προ-αποκλειστική περίληψη 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Απόκριση
Επιστρέφει: BulkPreBanSummary
Παράδειγμα

Λήψη σχολίων με αναγνωριστικά (POST) 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: ModerationAPIChildCommentsResponse
Example

Σήμανση σχολίου (POST) 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

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

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

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

Ορισμός κατάστασης spam σχολίου 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Επιστρέφει: APIEmptyResponse
Example

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

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

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

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

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

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

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

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

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

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

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

Λήψη διαχειριστών 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| skip | number | query | Όχι |
Απάντηση
Επιστρέφει: GetModeratorsResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

Διαγραφή αντίδρασης σε σελίδα v1 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Απόκριση
Επιστρέφει: CreateV1PageReact
Παράδειγμα

Διαγραφή αντίδρασης σε σελίδα v2 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | |
| id | string | query | Ναι |
Απάντηση
Επιστρέφει: CreateV1PageReact
Παράδειγμα

Λήψη likes σε σελίδα v1 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι |
Απάντηση
Επιστρέφει: GetV1PageLikes
Παράδειγμα

Λήψη χρηστών αντιδράσεων σε σελίδα v2 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Απόκριση
Επιστρέφει: GetV2PageReactUsersResponse
Παράδειγμα

Λήψη αντιδράσεων σε σελίδα v2 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι |
Απόκριση
Επιστρέφει: GetV2PageReacts
Παράδειγμα

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

Διαγραφή σελίδας 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Απόκριση
Επιστρέφει: DeletePageAPIResponse
Παράδειγμα

Λήψη εκτός σύνδεσης χρηστών 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a "Members" section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Αναγνωριστικό URL σελίδας (καθαρισμένο από τον διακομιστή). |
| afterName | string | query | No | Κέρσορας: περάστε το nextAfterName από την προηγούμενη απόκριση. |
| afterUserId | string | query | No | Διαχωριστικό κέρσορα: περάστε το nextAfterUserId από την προηγούμενη απόκριση. Απαιτείται όταν afterName έχει οριστεί ώστε τα ισοδύναμα ονόματα να μην αφαιρεθούν. |
Response
Returns: PageUsersOfflineResponse
Example

Λήψη σε σύνδεση χρηστών 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Αναγνωριστικό URL σελίδας (καθαρισμένο στον διακομιστή). |
| afterName | string | query | No | Κέρσορας: περάστε το nextAfterName από την προηγούμενη απάντηση. |
| afterUserId | string | query | No | Διαχωριστικό κέρσορα: περάστε το nextAfterUserId από την προηγούμενη απάντηση. Απαιτείται όταν έχει οριστεί το afterName ώστε τα σημεία ισοδυναμίας ονομάτων να μην αφαιρούν εγγραφές. |
Απόκριση
Returns: PageUsersOnlineResponse
Παράδειγμα

Λήψη σελίδας κατά URL ID 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| urlId | string | query | Ναι |
Απόκριση
Επιστρέφει: GetPageByURLIdAPIResponse
Παράδειγμα

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

Λήψη δημόσιων σελίδων 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Απαιτείται το enableFChat να είναι αληθές στη λύση του προσαρμοσμένου config για κάθε σελίδα.
Οι σελίδες που απαιτούν SSO φιλτράρονται βάσει της πρόσβασης της ομάδας του χρήστη που κάνει το αίτημα.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Αδιαφανής κέρσορ σελιδοποίησης που επιστρέφεται ως nextCursor από προηγούμενο αίτημα. Συνδεδεμένο με το ίδιο sortBy. |
| limit | integer | query | No | 1..200, προεπιλογή 50 |
| q | string | query | No | Προαιρετικό φιλτράρισμα τίτλου κατά πρόθεμα, χωρίς διάκριση πεζών-κεφαλαίων. |
| sortBy | string | query | No | Σειρά ταξινόμησης. updatedAt (προεπιλογή, νεότερα πρώτα), commentCount (πρώτες οι πολλές σχολιάσεις), ή title (αλφαβητική). |
| hasComments | boolean | query | No | Εάν είναι αληθές, επιστρέφει μόνο σελίδες με τουλάχιστον ένα σχόλιο. |
Response
Returns: GetPublicPagesResponse
Παράδειγμα

Λήψη πληροφοριών χρηστών 
Μαζικές πληροφορίες χρηστών για έναν tenant. Δεδομένων των userIds, επιστρέφει πληροφορίες εμφάνισης από User / SSOUser. Χρησιμοποιείται από το comment widget για να εμπλουτίσει χρήστες που μόλις εμφανίστηκαν μέσω ενός presence event. Χωρίς page context: η ιδιωτικότητα εφαρμόζεται ομοιόμορφα (τα ιδιωτικά προφίλ αποκρύπτονται).
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | userIds διαχωρισμένα με κόμμα. |
Απόκριση
Επιστρέφει: PageUsersInfoResponse
Παράδειγμα

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

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

Λήψη πλήθους εκκρεμών συμβάντων webhook 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Απάντηση
Επιστρέφει: GetPendingWebhookEventCountResponse
Παράδειγμα

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

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

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

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

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

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

Δημιουργία αποτελέσματος ερώτησης 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: CreateQuestionResultResponse
Παράδειγμα

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

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

Λήψη αποτελεσμάτων ερωτήσεων 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| urlId | string | query | Όχι | |
| userId | string | query | Όχι | |
| startDate | string | query | Όχι | |
| questionId | string | query | Όχι | |
| questionIds | string | query | Όχι | |
| skip | number | query | Όχι |
Απάντηση
Returns: GetQuestionResultsResponse
Παράδειγμα

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

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

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

Συνδυασμός σχολίων με αποτελέσματα ερωτήσεων 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Response
Επιστρέφει: CombineQuestionResultsWithCommentsResponse
Παράδειγμα

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

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

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

Λήψη χρήστη SSO με αναγνωριστικό 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι |
Απόκριση
Επιστρέφει: GetSSOUserByIdAPIResponse
Παράδειγμα

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

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

Αντικατάσταση/προσθήκη χρήστη SSO (PUT) 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| updateComments | boolean | query | Όχι |
Απόκριση
Επιστρέφει: PutSSOUserAPIResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

Δημιουργία χρήστη tenant 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι |
Απόκριση
Επιστρέφει: CreateTenantUserResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Λήψη προόδου διακριτικού χρήστη κατά αναγνωριστικό χρήστη 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | path | Yes |
Απάντηση
Επιστρέφει: APIGetUserBadgeProgressResponse
Παράδειγμα

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

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

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

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

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

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

Λήψη αριθμού ειδοποιήσεων χρήστη 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: GetUserNotificationCountResponse
Παράδειγμα

Λήψη ειδοποιήσεων χρήστη 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Χρησιμοποιείται για να προσδιορίσει εάν η τρέχουσα σελίδα είναι εγγεγραμμένη. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Response
Επιστρέφει: GetMyNotificationsResponse
Παράδειγμα

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

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

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

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

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

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

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

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

Δημιουργία ψήφου 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| commentId | string | query | Ναι | |
| direction | string | query | Ναι | |
| userId | string | query | Όχι | |
| anonUserId | string | query | Όχι |
Response
Επιστρέφει: VoteResponse
Example

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

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

Λήψη ψήφων για χρήστη 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Απάντηση
Επιστρέφει: GetVotesForUserResponse
Παράδειγμα

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