
Γλώσσα 🇬🇷 Ελληνικά
Ξεκινώντας
Τεκμηρίωση
Συγκέντρωση
Αρχεία ελέγχου
Έλεγχος ταυτότητας
Αποκλεισμός από σχόλιο
Έλεγχος αποκλεισμένων σχολίων
Σχόλια
Σχόλια για χρήστη
Ρυθμίσεις τομέα
Πρότυπα email
Αρχείο συμβάντων
Αναρτήσεις ροής
Σήμανση σχολίου
GIFs
Hashtags
Διαχείριση
Διαχειριστές
Πλήθος ειδοποιήσεων
Ειδοποιήσεις
Αντιδράσεις σε σελίδα
Σελίδες
Εκκρεμή γεγονότα webhook
Ρυθμίσεις ερωτήσεων
Αποτελέσματα ερωτήσεων
Συγκέντρωση αποτελεσμάτων ερωτήσεων
Χρήστες SSO
Συνδρομές
Ημερήσια χρήση ενοικιαστή
Πακέτα ενοικιαστή
Χρήστες ενοικιαστή
Ενοικιαστές
Εισιτήρια
Μεταφράσεις
Ανέβασμα εικόνας
Πρόοδος διακριτικού χρήστη
Διακριτικά χρήστη
Ειδοποιήσεις χρήστη
Καταστάσεις παρουσίας χρήστη
Αναζήτηση χρηστών
Χρήστες
Ψηφοφορίες
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 συνημμένο εάν προτιμάτε να εγκαταστήσετε ένα δυαδικό artefact απευθείας.
Περιεχόμενα Βιβλιοθήκης
Αυτή η βιβλιοθήκη περιλαμβάνει δύο modules: τον παραγόμενο πελάτη API και τη βασική βιβλιοθήκη Python που περιέχει χειρογραφούμενα βοηθητικά εργαλεία για να διευκολύνουν τη δουλειά με το API, συμπεριλαμβανομένης της υποστήριξης SSO.
- Τεκμηρίωση Βιβλιοθήκης Πελάτη API
- Τεκμηρίωση Κεντρικής Βιβλιοθήκης, Συμπεριλαμβανομένων Παραδειγμάτων SSO
Δημόσια vs Ασφαλισμένα APIs
Για τον πελάτη API, υπάρχουν τρεις κλάσεις, DefaultApi, PublicApi και ModerationApi. Η DefaultApi περιέχει μεθόδους που απαιτούν το κλειδί API σας, και η PublicApi περιέχει μεθόδους που μπορούν να κληθούν απευθείας από έναν περιηγητή/συσκευή κινητής/κτλ χωρίς έλεγχο ταυτότητας. Η ModerationApi προσφέρει μια εκτενή σειρά ζωντανών και γρήγορων APIs moderation. Κάθε μέθοδος της ModerationApi δέχεται μια παράμετρο sso και μπορεί να πιστοποιηθεί μέσω SSO ή μέσω cookie συνεδρίας FastComments.com.
Γρήγορη εκκίνηση 
Using Authenticated APIs (DefaultApi)
Σημαντικό: Πρέπει να ορίσετε το κλειδί API σας στη Διαμόρφωση (Configuration) πριν κάνετε αυθεντοποιημένα αιτήματα. Εάν δεν το κάνετε, τα αιτήματα θα αποτύχουν με σφάλμα 401.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Create and configure the API client
config = Configuration()
config.host = "https://fastcomments.com"
# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key = {"api_key": "YOUR_API_KEY_HERE"}
# Create the API instance with the configured client
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Now you can make authenticated API calls
try:
# Example: Add an SSO user
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}")
# Common errors:
# - 401: API key is missing or invalid
# - 400: Request validation failed
Using Public APIs (PublicApi)
Public endpoints don't require authentication:
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}")
Using the Moderation Dashboard (ModerationApi)
The ModerationApi powers the moderator dashboard. Methods are called on behalf of a moderator by passing an sso token:
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:
# Count the comments awaiting moderation
response = moderation_api.get_count(GetCountOptions(sso="SSO_TOKEN"))
print(response)
except Exception as e:
print(f"Error: {e}")
Using SSO (Single Sign-On)
The SDK includes utilities for generating secure SSO tokens:
from sso import FastCommentsSSO, SecureSSOUserData
# Create user data (id, email, and username are required)
user_data = SecureSSOUserData(
id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Sign it with your API secret (HMAC-SHA256)
sso = FastCommentsSSO.new_secure("YOUR_API_SECRET", user_data)
# Generate the SSO token to pass to the widget or an API call
sso_token = sso.create_token()
# Use this token in your frontend or pass to API calls
print(f"SSO Token: {sso_token}")
For simple SSO (less secure, for testing):
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()
Common Issues
- 401 "missing-api-key" error: Make sure you set
config.api_key = {"api_key": "YOUR_KEY"}before creating the DefaultApi instance. - Wrong API class: Use
DefaultApifor server-side authenticated requests,PublicApifor client-side/public requests, andModerationApifor moderator dashboard requests. - Import errors: Make sure you're importing from the correct module:
- API client:
from client import ... - SSO utilities:
from sso import ...
- API client:
Σημειώσεις 
Αναγνωριστικά Broadcast
Θα δείτε ότι πρέπει να περάσετε ένα broadcast_id σε κάποιες κλήσεις API. Όταν λαμβάνετε συμβάντα, θα λάβετε αυτό το ID πίσω, ώστε να ξέρετε να αγνοήσετε το συμβάν αν σκοπεύετε να εφαρμόσετε τις αλλαγές οπτιμιστικά στην πλευρά του πελάτη (κάτι που πιθανότατα θα θέλετε να κάνετε καθώς προσφέρει την καλύτερη εμπειρία). Περάστε ένα UUID εδώ. Το ID θα πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές σε μια συνεδρία του προγράμματος περιήγησης.
Απαιτήσεις 
- Python >= 3.8
Η βασική εγκατάσταση είναι pure-stdlib και παρέχει τις βοηθητικές λειτουργίες SSO. Ο παραγόμενος
API client (DefaultApi/PublicApi/ModerationApi) χρειάζεται το client extra,
που φέρνει το 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"
aggregate 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| parentTenantId | string | query | Όχι | |
| includeStats | boolean | query | Όχι |
Response
Επιστρέφει: AggregateResponse
Example

get_audit_logs 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Απάντηση
Επιστρέφει: GetAuditLogsResponse
Παράδειγμα

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

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

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

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

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

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

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

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

delete_comment_vote 
Παράμετροι
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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 |
Απάντηση
Returns: VoteDeleteResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

get_comments_for_user 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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 |
Response
Επιστρέφει: GetCommentsForUserResponse
Example

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

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

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

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

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

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

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

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

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

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

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

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

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

render_email_template 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| locale | string | query | Όχι |
Response
Επιστρέφει: RenderEmailTemplateResponse
Παράδειγμα

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

get_event_log 
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
Παράδειγμα

get_global_event_log 
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
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

get_gifs_trending 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| locale | string | query | No | |
| rating | string | query | No | |
| page | number | query | No |
Response
Επιστρέφει: GetGifsTrendingResponse
Example

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

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

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

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

patch_hash_tag 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| tag | string | path | Ναι |
Response
Returns: UpdateHashTagResponse
Example

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

post_ban_user_from_comment 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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
Παράδειγμα

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

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

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

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

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

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

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

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

post_set_comment_spam_status 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

get_notification_count 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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
Παράδειγμα

get_notifications 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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
Παράδειγμα

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

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

create_v2_page_react 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes | |
| title | string | query | No |
Απόκριση
Επιστρέφει: CreateV1PageReact
Παράδειγμα

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

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

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

get_v2_page_react_users 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Response
Returns: GetV2PageReactUsersResponse
Example

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

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

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

get_offline_users 
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
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Ναι | |
| urlId | string | query | Ναι | Δείκτης URL σελίδας (καθαρισμένο από την πλευρά του εξυπηρετητή). |
| afterName | string | query | Όχι | Δρομέας: περάστε το nextAfterName από την προηγούμενη απάντηση. |
| afterUserId | string | query | Όχι | Δρομέας διακοπής ισοδυναμίας: περάστε το nextAfterUserId από την προηγούμενη απάντηση. Απαιτείται όταν το afterName είναι ορισμένο ώστε τα ισοδύναμα ονόματα να μην αφαιρούν καταχωρήσεις. |
Response
Returns: PageUsersOfflineResponse
Example

get_online_users 
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).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Αναγνωριστικό URL σελίδας (καθαρισμένο στον server). |
| afterName | string | query | No | Δείκτης: περάστε το nextAfterName από την προηγούμενη απάντηση. |
| afterUserId | string | query | No | Δεσμευτικό δρομέα: περάστε το nextAfterUserId από την προηγούμενη απάντηση. Απαιτείται όταν έχει οριστεί afterName ώστε οι ισοδυναμίες ονομάτων να μην απορρίψουν εγγραφές. |
Response
Returns: PageUsersOnlineResponse
Example

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

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

get_pages_public 
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.
Λίστα σελίδων για έναν ενοικιαστή. Χρησιμοποιείται από το desktop client του FChat για την εμφάνιση της λίστας δωματίων.
Απαιτεί enableFChat να είναι true στην επιλυμένη προσαρμοσμένη διαμόρφωση για κάθε σελίδα.
Οι σελίδες που απαιτούν 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 | Αν είναι true, επιστρέφει μόνο σελίδες με τουλάχιστον ένα σχόλιο. |
Response
Returns: GetPublicPagesResponse
Example

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

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

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

get_pending_webhook_event_count 
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| 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
Παράδειγμα

get_pending_webhook_events 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Response
Επιστρέφει: GetPendingWebhookEventsResponse
Example

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

get_user_notifications 
Παράμετροι
| 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 |
Απάντηση
Επιστρέφει: GetMyNotificationsResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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