
Γλώσσα 🇬🇷 Ελληνικά
Ξεκινώντας
Αναφορά API
Τεκμηρίωση
Αυθεντικοποίηση
Συγκεντρωτικά
Αρχεία ελέγχου
Αποκλεισμός από σχόλιο
Έλεγχος αποκλεισμένων σχολίων
Σχόλια
Σχόλια για χρήστη
Ρυθμίσεις τομέα
Πρότυπα Email
Καταγραφή συμβάντων
Αναρτήσεις ροής
Σήμανση σχολίου
GIFs
Hashtags
Διαχείριση
Διαχειριστές
Πλήθος ειδοποιήσεων
Ειδοποιήσεις
Αντιδράσεις σελίδας
Σελίδες
Εκκρεμή συμβάντα webhook
Εκκρεπή συμβάντα webhook
Ρυθμίσεις ερωτήσεων
Αποτελέσματα ερωτήσεων
Συσσώρευση αποτελεσμάτων ερωτήσεων
Χρήστες SSO
Συνδρομές
Ημερήσια χρήση μισθωτή
Πακέτα μισθωτή
Χρήστες μισθωτή
Μισθωτές
Εισιτήρια
Μεταφράσεις
Ανέβασμα εικόνας
Πρόοδος σήματος χρήστη
Σήματα χρήστη
Ειδοποιήσεις χρήστη
Καταστάσεις παρουσίας χρήστη
Αναζήτηση χρηστών
Χρήστες
Ψηφοφορίες
Ψηφοφορίες για χρήστη
FastComments PHP SDK
Αυτό είναι το επίσημο PHP SDK για το FastComments.
Επίσημο PHP SDK για το FastComments API
Αποθετήριο
Εγκατάσταση & Χρήση 
Απαιτήσεις
PHP 7.4 και νεότερες εκδόσεις. Θα πρέπει επίσης να λειτουργεί με PHP 8.0.
Composer
Για να εγκαταστήσετε τις βιβλιοθήκες (bindings) μέσω του Composer, προσθέστε τα ακόλουθα στο composer.json:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}
Στη συνέχεια εκτελέστε composer install
Μη αυτόματη εγκατάσταση
Κατεβάστε τα αρχεία και συμπεριλάβετε το autoload.php:
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');
Ξεκινώντας 
Παρακαλώ ακολουθήστε τη διαδικασία εγκατάστασης και στη συνέχεια εκτελέστε τα παρακάτω:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$tenant_id = 'tenant_id_example'; // string
$add_domain_config_params = new \FastComments\Client\Model\AddDomainConfigParams(); // \FastComments\Client\Model\AddDomainConfigParams
try {
$result = $apiInstance->addDomainConfig($tenant_id, $add_domain_config_params);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->addDomainConfig: ', $e->getMessage(), PHP_EOL;
}
API Clients 
Το SDK εκθέτει τρεις κλάσεις πελάτη API:
DefaultApi- Μέθοδοι με αυθεντικοποίηση μέσω κλειδιού API για χρήση στην πλευρά του διακομιστή. Διαμορφώστε ένα κλειδί API όπως φαίνεται στην ενότητα Getting Started.PublicApi- Δημόσιες μέθοδοι που δεν απαιτούν κλειδί API, ασφαλείς για κλήση από προγράμματα περιήγησης και κινητές εφαρμογές.ModerationApi- Ένα εκτενές σύνολο ζωντανών και γρήγορων API μετριασμού. Κάθε μέθοδοςModerationApiδέχεται μια παράμετρο$ssoκαι μπορεί να αυθεντοποιηθεί μέσω SSO ή ενός cookie συνεδρίας FastComments.com.
Χρήση του PublicApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Οι δημόσιες μέθοδοι δεν απαιτούν κλειδί API.
$apiInstance = new FastComments\Client\Api\PublicApi(
new GuzzleHttp\Client()
);
$tenant_id = 'tenant_id_example'; // string
$url_id = 'url_id_example'; // string
try {
$result = $apiInstance->getCommentsPublic($tenant_id, $url_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling PublicApi->getCommentsPublic: ', $e->getMessage(), PHP_EOL;
}
Χρήση του ModerationApi
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new FastComments\Client\Api\ModerationApi(
new GuzzleHttp\Client()
);
$sso = 'sso_example'; // string - Φορτίο SSO που αυθεντικοποιεί τον συντονιστή
try {
$result = $apiInstance->getCount([
'sso' => $sso,
]);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ModerationApi->getCount: ', $e->getMessage(), PHP_EOL;
}
API Methods 
Όλα τα URI είναι σχετικά με https://fastcomments.com
| Κλάση | Μέθοδος | HTTP αίτημα | Περιγραφή |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| ModerationApi | deleteModerationVote | DELETE /auth/my-account/moderate-comments/vote/{commentId}/{voteId} | |
| ModerationApi | getApiComments | GET /auth/my-account/moderate-comments/api/comments | |
| ModerationApi | getApiExportStatus | GET /auth/my-account/moderate-comments/api/export/status | |
| ModerationApi | getApiIds | GET /auth/my-account/moderate-comments/api/ids | |
| ModerationApi | getBanUsersFromComment | GET /auth/my-account/moderate-comments/ban-users/from-comment/{commentId} | |
| ModerationApi | getCommentBanStatus | GET /auth/my-account/moderate-comments/get-comment-ban-status/{commentId} | |
| ModerationApi | getCommentChildren | GET /auth/my-account/moderate-comments/comment-children/{commentId} | |
| ModerationApi | getCount | GET /auth/my-account/moderate-comments/count | |
| ModerationApi | getCounts | GET /auth/my-account/moderate-comments/banned-users/counts | |
| ModerationApi | getLogs | GET /auth/my-account/moderate-comments/logs/{commentId} | |
| ModerationApi | getManualBadges | GET /auth/my-account/moderate-comments/get-manual-badges | |
| ModerationApi | getManualBadgesForUser | GET /auth/my-account/moderate-comments/get-manual-badges-for-user | |
| ModerationApi | getModerationComment | GET /auth/my-account/moderate-comments/comment/{commentId} | |
| ModerationApi | getModerationCommentText | GET /auth/my-account/moderate-comments/get-comment-text/{commentId} | |
| ModerationApi | getPreBanSummary | GET /auth/my-account/moderate-comments/pre-ban-summary/{commentId} | |
| ModerationApi | getSearchCommentsSummary | GET /auth/my-account/moderate-comments/search/comments/summary | |
| ModerationApi | getSearchPages | GET /auth/my-account/moderate-comments/search/pages | |
| ModerationApi | getSearchSites | GET /auth/my-account/moderate-comments/search/sites | |
| ModerationApi | getSearchSuggest | GET /auth/my-account/moderate-comments/search/suggest | |
| ModerationApi | getSearchUsers | GET /auth/my-account/moderate-comments/search/users | |
| ModerationApi | getTrustFactor | GET /auth/my-account/moderate-comments/get-trust-factor | |
| ModerationApi | getUserBanPreference | GET /auth/my-account/moderate-comments/user-ban-preference | |
| ModerationApi | getUserInternalProfile | GET /auth/my-account/moderate-comments/get-user-internal-profile | |
| ModerationApi | postAdjustCommentVotes | POST /auth/my-account/moderate-comments/adjust-comment-votes/{commentId} | |
| ModerationApi | postApiExport | POST /auth/my-account/moderate-comments/api/export | |
| ModerationApi | postBanUserFromComment | POST /auth/my-account/moderate-comments/ban-user/from-comment/{commentId} | |
| ModerationApi | postBanUserUndo | POST /auth/my-account/moderate-comments/ban-user/undo | |
| ModerationApi | postBulkPreBanSummary | POST /auth/my-account/moderate-comments/bulk-pre-ban-summary | |
| ModerationApi | postCommentsByIds | POST /auth/my-account/moderate-comments/comments-by-ids | |
| ModerationApi | postFlagComment | POST /auth/my-account/moderate-comments/flag-comment/{commentId} | |
| ModerationApi | postRemoveComment | POST /auth/my-account/moderate-comments/remove-comment/{commentId} | |
| ModerationApi | postRestoreDeletedComment | POST /auth/my-account/moderate-comments/restore-deleted-comment/{commentId} | |
| ModerationApi | postSetCommentApprovalStatus | POST /auth/my-account/moderate-comments/set-comment-approval-status/{commentId} | |
| ModerationApi | postSetCommentReviewStatus | POST /auth/my-account/moderate-comments/set-comment-review-status/{commentId} | |
| ModerationApi | postSetCommentSpamStatus | POST /auth/my-account/moderate-comments/set-comment-spam-status/{commentId} | |
| ModerationApi | postSetCommentText | POST /auth/my-account/moderate-comments/set-comment-text/{commentId} | |
| ModerationApi | postUnFlagComment | POST /auth/my-account/moderate-comments/un-flag-comment/{commentId} | |
| ModerationApi | postVote | POST /auth/my-account/moderate-comments/vote/{commentId} | |
| ModerationApi | putAwardBadge | PUT /auth/my-account/moderate-comments/award-badge | |
| ModerationApi | putCloseThread | PUT /auth/my-account/moderate-comments/close-thread | |
| ModerationApi | putRemoveBadge | PUT /auth/my-account/moderate-comments/remove-badge | |
| ModerationApi | putReopenThread | PUT /auth/my-account/moderate-comments/reopen-thread | |
| ModerationApi | setTrustFactor | PUT /auth/my-account/moderate-comments/set-trust-factor | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | createV1PageReact | POST /page-reacts/v1/likes/{tenantId} | |
| PublicApi | createV2PageReact | POST /page-reacts/v2/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | deleteV1PageReact | DELETE /page-reacts/v1/likes/{tenantId} | |
| PublicApi | deleteV2PageReact | DELETE /page-reacts/v2/{tenantId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsForUser | GET /comments-for-user | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | |
| PublicApi | getEventLog | GET /event-log/{tenantId} | |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGifLarge | GET /gifs/get-large/{tenantId} | |
| PublicApi | getGifsSearch | GET /gifs/search/{tenantId} | |
| PublicApi | getGifsTrending | GET /gifs/trending/{tenantId} | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| PublicApi | getOfflineUsers | GET /pages/{tenantId}/users/offline | |
| PublicApi | getOnlineUsers | GET /pages/{tenantId}/users/online | |
| PublicApi | getPagesPublic | GET /pages/{tenantId} | |
| PublicApi | getTranslations | GET /translations/{namespace}/{component} | |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | getUsersInfo | GET /pages/{tenantId}/users/info | |
| PublicApi | getV1PageLikes | GET /page-reacts/v1/likes/{tenantId} | |
| PublicApi | getV2PageReactUsers | GET /page-reacts/v2/{tenantId}/list | |
| PublicApi | getV2PageReacts | GET /page-reacts/v2/{tenantId} | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | logoutPublic | PUT /auth/logout | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Models 
- APIAuditLog
- APIBanUserChangeLog
- APIBanUserChangedValues
- APIBannedUser
- APIBannedUserWithMultiMatchInfo
- APIComment
- APICommentBase
- APICommentBaseMeta
- APICommentCommonBannedUser
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIModerateGetUserBanPreferencesResponse
- APIModerateUserBanPreferences
- APIPage
- APISSOUser
- APISaveCommentResponse
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfigResponse
- AddDomainConfigResponseAnyOf
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AdjustCommentVotesParams
- AdjustVotesResponse
- AggregateQuestionResultsResponse
- AggregateResponse
- AggregateTimeBucket
- AggregationAPIError
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- AwardUserBadgeResponse
- BanUserFromCommentResult
- BanUserUndoParams
- BannedUserMatch
- BannedUserMatchMatchedOnValue
- BannedUserMatchType
- BillingInfo
- BlockFromCommentParams
- BlockSuccess
- BuildModerationFilterParams
- BuildModerationFilterResponse
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkCreateHashTagsBody
- BulkCreateHashTagsBodyTagsInner
- BulkCreateHashTagsResponse
- BulkCreateHashTagsResponseResultsInner
- BulkPreBanParams
- BulkPreBanSummary
- ChangeCommentPinStatusResponse
- ChangeTicketStateBody
- ChangeTicketStateResponse
- CheckBlockedCommentsResponse
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CommentsByIdsParams
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateFeedPostParams
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTicketBody
- CreateTicketResponse
- CreateUserBadgeParams
- CreateV1PageReact
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentResult
- DeleteDomainConfigResponse
- DeleteFeedPostPublicResponse
- DeleteHashTagRequestBody
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentResponse
- GetAuditLogsResponse
- GetBannedUsersCountResponse
- GetBannedUsersFromCommentResponse
- GetCachedNotificationCountResponse
- GetCommentBanStatusResponse
- GetCommentTextResponse
- GetCommentVoteUserNamesSuccessResponse
- GetCommentsForUserResponse
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfigResponse
- GetDomainConfigsResponse
- GetDomainConfigsResponseAnyOf
- GetDomainConfigsResponseAnyOf1
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateResponse
- GetEmailTemplatesResponse
- GetEventLogResponse
- GetFeedPostsResponse
- GetGifsSearchResponse
- GetGifsTrendingResponse
- GetHashTagsResponse
- GetModeratorResponse
- GetModeratorsResponse
- GetMyNotificationsResponse
- GetNotificationCountResponse
- GetNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEventsResponse
- GetPublicFeedPostsResponse
- GetPublicPagesResponse
- GetQuestionConfigResponse
- GetQuestionConfigsResponse
- GetQuestionResultResponse
- GetQuestionResultsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsersResponse
- GetSubscriptionsAPIResponse
- GetTenantDailyUsagesResponse
- GetTenantManualBadgesResponse
- GetTenantPackageResponse
- GetTenantPackagesResponse
- GetTenantResponse
- GetTenantUserResponse
- GetTenantUsersResponse
- GetTenantsResponse
- GetTicketResponse
- GetTicketsResponse
- GetTranslationsResponse
- GetUserInternalProfileResponse
- GetUserInternalProfileResponseProfile
- GetUserManualBadgesResponse
- GetUserNotificationCountResponse
- GetUserPresenceStatusesResponse
- GetUserResponse
- GetUserTrustFactorResponse
- GetV1PageLikes
- GetV2PageReactUsersResponse
- GetV2PageReacts
- GetVotesForUserResponse
- GetVotesResponse
- GifGetLargeResponse
- GifRating
- GifSearchInternalError
- GifSearchResponse
- GifSearchResponseImagesInnerInner
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAgentApprovalNotificationFrequency
- ImportedSiteType
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- MediaAsset
- MentionAutoCompleteMode
- MetaItem
- ModerationAPIChildCommentsResponse
- ModerationAPIComment
- ModerationAPICommentLog
- ModerationAPICommentResponse
- ModerationAPICountCommentsResponse
- ModerationAPIGetCommentIdsResponse
- ModerationAPIGetCommentsResponse
- ModerationAPIGetLogsResponse
- ModerationCommentSearchResponse
- ModerationExportResponse
- ModerationExportStatusResponse
- ModerationFilter
- ModerationPageSearchProjected
- ModerationPageSearchResponse
- ModerationSiteSearchProjected
- ModerationSiteSearchResponse
- ModerationSuggestResponse
- ModerationUserSearchProjected
- ModerationUserSearchResponse
- Moderator
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PageUserEntry
- PageUsersInfoResponse
- PageUsersOfflineResponse
- PageUsersOnlineResponse
- PagesSortBy
- PatchDomainConfigParams
- PatchDomainConfigResponse
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PendingCommentToSyncOutbound
- PostRemoveCommentResponse
- PreBanSummary
- PubSubComment
- PubSubCommentBase
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicCommentBase
- PublicFeedPostsResponse
- PublicPage
- PublicVote
- PutDomainConfigResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionConfig
- QuestionConfigCustomOptionsInner
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RemoveCommentActionResponse
- RemoveUserBadgeResponse
- RenderEmailTemplateBody
- RenderEmailTemplateResponse
- RenderableUserNotification
- RepeatCommentCheckIgnoredReason
- RepeatCommentHandlingAction
- ReplaceTenantPackageBody
- ReplaceTenantUserBody
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveCommentResponseOptimized
- SaveCommentsBulkResponse
- SaveCommentsResponseWithPresence
- SearchUsersResponse
- SearchUsersResult
- SearchUsersSectionedResponse
- SetCommentApprovedResponse
- SetCommentTextParams
- SetCommentTextResponse
- SetCommentTextResult
- SetUserTrustFactorResponse
- SizePreset
- SortDirections
- SpamRule
- TOSConfig
- TenantBadge
- TenantHashTag
- TenantPackage
- UnBlockFromCommentParams
- UnblockSuccess
- UpdatableCommentParams
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateAPIUserSubscriptionData
- UpdateDomainConfigParams
- UpdateEmailTemplateBody
- UpdateFeedPostParams
- UpdateHashTagBody
- UpdateHashTagResponse
- UpdateModeratorBody
- UpdateNotificationBody
- UpdateQuestionConfigBody
- UpdateQuestionResultBody
- UpdateSubscriptionAPIResponse
- UpdateTenantBody
- UpdateTenantPackageBody
- UpdateTenantUserBody
- UpdateUserBadgeParams
- UpdateUserNotificationCommentSubscriptionStatusResponse
- UpdateUserNotificationPageSubscriptionStatusResponse
- UpdateUserNotificationStatusResponse
- UploadImageResponse
- User
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationCount
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSearchSection
- UserSearchSectionResult
- UserSessionInfo
- UsersListLocation
- VoteBodyParams
- VoteDeleteResponse
- VoteResponse
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
Authorization 
Σχήματα αυθεντικοποίησης που ορίζονται για το API:
api_key
- Τύπος: API key
- Όνομα παραμέτρου API key: x-api-key
- Τοποθεσία: HTTP header
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
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| parentTenantId | string | query | Όχι | |
| includeStats | boolean | query | Όχι |
Response
Επιστρέφει: AggregateResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

getCommentsPublic 
αίτηση
tenantId
urlId
Παράμετροι
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Απόκριση
Επιστρέφει: GetCommentsResponseWithPresencePublicComment
Παράδειγμα

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

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

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

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

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

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

setCommentText 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Response
Επιστρέφει: PublicAPISetCommentTextResponse
Example

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

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

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

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

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

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

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

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

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

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

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

patchDomainConfig 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Response
Επιστρέφει: PatchDomainConfigResponse
Example

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

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

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

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

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

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

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

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

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

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

getEventLog 
req tenantId urlId userIdWS
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | No |
Απάντηση
Επιστρέφει: GetEventLogResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

flagCommentPublic 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Response
Επιστρέφει: APIEmptyResponse
Example

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

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

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

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

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

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

getHashTags 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| page | number | query | Όχι |
Απόκριση
Returns: GetHashTagsResponse
Παράδειγμα

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

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

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

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

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

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

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

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

getCount 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Response
Returns: ModerationAPICountCommentsResponse
Example

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

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

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

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

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

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

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

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

getSearchPages 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
Επιστρέφει: ModerationPageSearchResponse
Example

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

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

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

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

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

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

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

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

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

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

postBulkPreBanSummary 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sno | string | query | No |
Απάντηση
Επιστρέφει: BulkPreBanSummary
Παράδειγμα

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

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

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

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

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

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

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

postSetCommentText 
Parameters
| Όνομα | Τύπος | Θέση | Απαιτούμενο | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Επιστρέφει: SetCommentTextResponse
Example

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

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

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

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

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

putReopenThread 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| sso | string | query | No |
Response
Returns: APIEmptyResponse
Example

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

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

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

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

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

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

updateModerator 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Returns: APIEmptyResponse
Example

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getOnlineUsers 
Συνεχώς σε απευθείας σύνδεση θεατές μιας σελίδας: άτομα των οποίων η συνεδρία websocket είναι εγγεγραμμένη στη σελίδα αυτή τη στιγμή.
Επιστρέφει anonCount + totalCount (συνδρομητές σε ολόκληρο το δωμάτιο, συμπεριλαμβανομένων των ανώνυχων θεατών που δεν απαριθμούμε).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Αναγνωριστικό URL σελίδας (καθαρισμένο στη διακομιστή). |
| afterName | string | query | No | Κέρσορας: περάστε το nextAfterName από την προηγούμενη απάντηση. |
| afterUserId | string | query | No | Διαχωριστικό κέρσορα: περάστε το nextAfterUserId από την προηγούμενη απάντηση. Απαιτείται όταν έχει οριστεί afterName ώστε οι ισοδύναμες ονομασίες να μην αφαιρούν εγγραφές. |
Response
Returns: PageUsersOnlineResponse
Example

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

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

getPagesPublic 
List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.
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
Επιστρέφει: GetPublicPagesResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

aggregateQuestionResults 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Response
Επιστρέφει: AggregateQuestionResultsResponse
Example

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

combineCommentsWithQuestionResults 
Παράμετροι
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| questionId | string | query | Όχι | |
| questionIds | array | query | Όχι | |
| urlId | string | query | Όχι | |
| startDate | string | query | Όχι | |
| forceRecalculate | boolean | query | Όχι | |
| minValue | number | query | Όχι | |
| maxValue | number | query | Όχι | |
| limit | number | query | Όχι |
Απάντηση
Επιστρέφει: CombineQuestionResultsWithCommentsResponse
Παράδειγμα

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

deleteSSOUser 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Ναι | |
| id | string | path | Ναι | |
| deleteComments | boolean | query | Όχι | |
| commentDeleteMode | string | query | Όχι |
Response
Επιστρέφει: DeleteSSOUserAPIResponse
Example

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

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

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

patchSSOUser 
Parameters
| Όνομα | Τύπος | Τοποθεσία | Απαιτείται | Περιγραφή |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Response
Επιστρέφει: PatchSSOUserAPIResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

updateUserNotificationCommentSubscriptionStatus 
Enable or disable notifications for a specific comment.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Response
Returns: UpdateUserNotificationCommentSubscriptionStatusResponse
Παράδειγμα

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

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

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

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

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

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

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

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

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

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