
Γλώσσα 🇨🇾 Ελληνικά (Κύπρος)
Ξεκινώντας
Τεκμηρίωση
Χρήση
Συγκέντρωση
Αρχεία ελέγχου
Αυθεντικοποίηση
Αποκλεισμός από σχόλιο
Έλεγχος μπλοκαρισμένων σχολίων
Σχόλια
Σχόλια χρήστη
Ρυθμίσεις τομέα
Πρότυπα ηλεκτρονικού ταχυδρομείου
Καταγραφή συμβάντων
Αναρτήσεις ροής
Σήμανση σχολίου
GIFs
Hashtags
Διαχείριση
Διαχειριστές
Καταμέτρηση ειδοποιήσεων
Ειδοποιήσεις
Αντιδράσεις σε σελίδα
Σελίδες
Εκκρεμή συμβάντα webhook
Ρυθμίσεις ερωτήσεων
Αποτελέσματα ερωτήσεων
Συγκέντρωση αποτελεσμάτων ερωτήσεων
Χρήστες SSO
Συνδρομές
Ημερήσια χρήση ενοικιαστή
Πακέτα ενοικιαστή
Χρήστες ενοικιαστή
Ενοικιαστές
Εισιτήρια
Μεταφράσεις
Μεταφόρτωση εικόνας
Πρόοδος σήματος χρήστη
Σήματα χρήστη
Ειδοποιήσεις χρήστη
Κατάσταση παρουσίας χρήστη
Αναζήτηση χρηστών
Χρήστες
Ψήφοι
FastComments SDK για Ruby
Αυτό είναι το επίσημο Ruby SDK για το FastComments.
Επίσημο Ruby SDK για το API του FastComments
Αποθετήριο
Installation 
Add this line to your application's Gemfile:
gem 'fastcomments'
And then execute:
bundle install
Or install it yourself as:
gem install fastcomments
Library Contents
Αυτή η βιβλιοθήκη περιέχει τον παραγόμενο πελάτη API και τα εργαλεία SSO για να διευκολύνουν τη χρήση του API.
Public vs Secured APIs
Για τον πελάτη API, υπάρχουν τρεις κλάσεις, DefaultApi, PublicApi και ModerationApi. Η DefaultApi περιέχει μεθόδους που απαιτούν το κλειδί API σας, η PublicApi περιλαμβάνει κλήσεις API που μπορούν να γίνουν απευθείας από πρόγραμμα περιήγησης/συσκευή κινητής κ.λπ. χωρίς έλεγχο ταυτότητας. Η ModerationApi περιέχει τις μεθόδους που τροφοδοτούν τον πίνακα ελέγχου του συντονιστή.
Η ModerationApi προσφέρει ένα εκτενές σύνολο ζωντανών και γρήγορων API συντονισμού. Κάθε μέθοδος ModerationApi δέχεται ένα παράμετρο sso και μπορεί να πιστοποιηθεί μέσω SSO ή ενός cookie συνεδρίας FastComments.com.
Quick Start 
Χρήση Πιστοποιημένων API (DefaultApi)
Σημαντικό: Πρέπει να ορίσετε το κλειδί API σας στο ApiClient πριν κάνετε αιτήματα με πιστοποίηση. Εάν δεν το κάνετε, τα αιτήματα θα αποτύχουν με σφάλμα 401.
require 'fastcomments'
# Create and configure the API client
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# Create the API instance with the configured client
api = FastCommentsClient::DefaultApi.new(api_client)
# Now you can make authenticated API calls
begin
# Example: Add an SSO user
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# Common errors:
# - 401: API key is missing or invalid
# - 400: Request validation failed
end
Χρήση Δημόσιων API (PublicApi)
Τα δημόσια σημεία άκρης δεν απαιτούν πιστοποίηση:
require 'fastcomments'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
'YOUR_TENANT_ID',
'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Χρήση APIs Μετριασμού (ModerationApi)
Οι μέθοδοι μετριασμού τροφοδοτούν τον πίνακα ελέγχου του συντονιστή. Περνάτε ένα διακριτικό sso ώστε το αίτημα να γίνει εκ μέρους ενός συντονιστή πιστοποιημένου μέσω SSO:
require 'fastcomments'
moderation_api = FastCommentsClient::ModerationApi.new
begin
# Example: List comments in the moderation queue
response = moderation_api.get_api_comments(
sso: 'YOUR_MODERATOR_SSO_TOKEN'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Κοινά Προβλήματα
- 401 "missing-api-key" error: Βεβαιωθείτε ότι έχετε ορίσει
config.api_key['x-api-key'] = 'YOUR_KEY'πριν δημιουργήσετε την παρουσία DefaultApi. - Wrong API class: Χρησιμοποιήστε
DefaultApiγια αιτήματα διακομιστή με πιστοποίηση,PublicApiγια αιτήματα πελάτη/δημόσια, καιModerationApiγια αιτήματα πίνακα ελέγχου συντονιστή. - Null API key: Το SDK θα παραλείψει σιωπηλά την πιστοποίηση αν το κλειδί API είναι κενό, οδηγώντας σε σφάλματα 401.
Notes 
Αναγνωριστικά Broadcast
Θα δείτε ότι πρέπει να περάσετε ένα broadcastId σε ορισμένες κλήσεις API. Όταν λαμβάνετε συμβάντα, θα λάβετε αυτό το ID πίσω, οπότε θα γνωρίζετε να αγνοήσετε το συμβάν αν σκοπεύετε να εφαρμόσετε αλλαγές "optimistically" στον πελάτη (κάτι που πιθανότατα θα θέλετε να κάνετε, καθώς προσφέρει την καλύτερη εμπειρία). Περάστε ένα UUID εδώ. Το ID θα πρέπει να είναι αρκετά μοναδικό ώστε να μην εμφανιστεί δύο φορές σε μια συνεδρία προγράμματος περιήγησης.
SSO (Ενιαία Σύνδεση)
Για παραδείγματα SSO, δείτε παρακάτω.
SSO Usage 
Απλό SSO
require 'fastcomments'
# Δημιουργία διακριτικού Simple SSO
user = FastComments::SSO::SimpleSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
avatar: 'https://example.com/avatar.jpg'
)
sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token
puts "SSO Token: #{token}"
# Χρήση του διακριτικού SSO για να κάνετε μια αυθεντικοποιημένη κλήση API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
'your-tenant-id',
'your-page-url-id',
sso: token
)
puts "Status: #{response}"
Ασφαλές SSO
require 'fastcomments'
# Δημιουργία διακριτικού Secure SSO
user = FastComments::SSO::SecureSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
username: 'johndoe',
avatar: 'https://example.com/avatar.jpg'
)
api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token
puts "Secure SSO Token: #{token}"
# Χρήση του διακριτικού SSO για να κάνετε μια αυθεντικοποιημένη κλήση API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
'your-tenant-id',
'your-page-url-id',
sso: token
)
puts "Status: #{response}"
aggregate 
Συγκεντρώνει έγγραφα ομαδοποιώντας τα (αν παρέχεται το groupBy) και εφαρμόζοντας πολλαπλές λειτουργίες. Υποστηρίζονται διαφορετικές λειτουργίες (π.χ. sum, countDistinct, avg, κ.λπ.).
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| parentTenantId | string | query | Όχι | |
| includeStats | boolean | query | Όχι |
Απόκριση
Επιστρέφει: AggregateResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

flag_comment 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Ναι | |
| commentId | string | path | Ναι | |
| editKey | string | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: PublicAPIGetCommentTextResponse
Παράδειγμα

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

get_comments 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Όχι |
Απόκριση
Επιστρέφει: GetCommentsResponseWithPresencePublicComment
Παράδειγμα

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

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

save_comment 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| isLive | boolean | query | Όχι | |
| doSpamCheck | boolean | query | Όχι | |
| sendEmails | boolean | query | Όχι | |
| populateNotifications | boolean | query | Όχι |
Απόκριση
Επιστρέφει: APISaveCommentResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

get_feed_posts 
req tenantId afterId
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Ναι | |
| postIds | array | query | Όχι | |
| sso | string | query | Όχι |
Απόκριση
Επιστρέφει: UserReactsResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Ναι | |
| commentId | string | path | Ναι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: GetCommentTextResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

post_api_export 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| text-search | string | query | Όχι | |
| byIPFromComment | string | query | Όχι | |
| filters | string | query | Όχι | |
| searchFilters | string | query | Όχι | |
| sorts | string | query | Όχι | |
| sso | string | query | Όχι |
Response
Επιστρέφει: 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 | Ναι | |
| sso | string | query | Όχι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

delete_moderator 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| fromName | string | query | Ναι |
Απάντηση
Επιστρέφει: APIEmptyResponse
Παράδειγμα

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

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

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

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

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

update_notification 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Απόκριση
Επιστρέφει: 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 | Ναι | |
| urlId | string | query | Ναι | |
| id | string | query | Ναι | |
| title | string | query | Όχι |
Απόκριση
Επιστρέφει: CreateV1PageReact
Παράδειγμα

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

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

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

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

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

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

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

get_offline_users 
Προηγούμενοι σχολιαστές στη σελίδα που ΔΕΝ είναι αυτήν τη στιγμή online. Ταξινομημένοι κατά displayName. Χρησιμοποιήστε αυτό αφού εξαντληθεί το /users/online για να εμφανίσετε μια ενότητα «Μέλη». Σελιδοποίηση με δρομέα στο commenterName: ο server διασχίζει τον μερικό δείκτη {tenantId, urlId, commenterName} από afterName προς τα εμπρός μέσω του $gt, χωρίς κόστος $skip.
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: PageUsersOfflineResponse
Example

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

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

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

get_pages_public 
Λίστα σελίδων για έναν tenant. Χρησιμοποιείται από τον επιτραπέζιο πελάτη FChat για να συμπληρώσει τη λίστα δωματίων του.
Απαιτεί enableFChat να είναι true στην επιλυμένη προσαρμοσμένη ρύθμιση (custom config) για κάθε σελίδα.
Οι σελίδες που απαιτούν SSO φιλτράρονται με βάση την πρόσβαση ομάδας του ζητούντος χρήστη.
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Αδιαφανές cursor σελιδοποίησης που επιστρέφεται ως 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, επιστρέφει μόνο σελίδες με τουλάχιστον ένα σχόλιο. |
Απόκριση
Επιστρέφει: GetPublicPagesResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

replace_tenant_package 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 | Ναι |
Απόκριση
Επιστρέφει: GetTenantUserResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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