
Język 🇵🇱 Polski
Pierwsze kroki
Dokumentacja API
Dokumentacja
Uwierzytelnianie
Agregacja
Dzienniki audytu
Blokada z komentarza
Sprawdź zablokowane komentarze
Komentarze
Konfiguracje domen
Szablony e-mail
Dziennik zdarzeń
Posty
Zgłoś komentarz
Hashtagi
Moderatorzy
Liczba powiadomień
Powiadomienia
Strony
Oczekujące zdarzenia webhook
Konfiguracje pytań
Wyniki pytań
Agregacja wyników pytań
Użytkownicy SSO
Subskrypcje
Dzienne użycie najemcy
Pakiety najemcy
Użytkownicy najemcy
Najemcy
Prześlij obraz
Postęp odznaki użytkownika
Odznaki użytkownika
Powiadomienia użytkownika
Status obecności użytkownika
Wyszukiwanie użytkowników
Użytkownicy
Głosy
FastComments PHP SDK
To jest oficjalne SDK PHP dla FastComments.
Oficjalne SDK PHP dla API FastComments
Repozytorium
Instalacja i użycie 
Wymagania
PHP 7.4 lub nowszy. Powinno również działać z PHP 8.0.
Composer
Aby zainstalować powiązania za pomocą Composer, dodaj do composer.json następujące:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/fastcomments/fastcomments-php.git"
}
],
"require": {
"fastcomments/fastcomments-php": "*@dev"
}
}
Następnie uruchom composer install
Ręczna instalacja
Pobierz pliki i dołącz autoload.php:
<?php
require_once('/path/to/fastcomments/client/vendor/autoload.php');
Pierwsze kroki 
Wykonaj procedurę instalacji, a następnie uruchom poniższe:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Skonfiguruj autoryzację klucza API: api_key
$config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Odkomentuj poniższą linię, aby ustawić prefiks (np. Bearer) dla klucza API, jeśli to konieczne
// $config = FastComments\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');
$apiInstance = new FastComments\Client\Api\DefaultApi(
// Jeśli chcesz użyć niestandardowego klienta HTTP, przekaż klienta, który implementuje `GuzzleHttp\ClientInterface`.
// To jest opcjonalne, domyślnie zostanie użyty `GuzzleHttp\Client`.
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;
}
Punkty końcowe API 
Wszystkie URI są względne względem https://fastcomments.com
| Klasa | Metoda | Żądanie HTTP | Opis |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| 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 | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| 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 | getFeedPosts | GET /api/v1/feed-posts | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| 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 | 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 | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| 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 | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| 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 | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| 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 | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| 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 | getGlobalEventLog | GET /event-log/global/{tenantId} | |
| 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 | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| 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 | |
| --- |
Modele 
- APICreateUserBadgeResponse
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIPage
- APISSOUser
- APIStatus
- APIUserSubscription
- AddDomainConfig200Response
- AddDomainConfig200ResponseAnyOf
- AddDomainConfigParams
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AggregateQuestionResults200Response
- AggregateQuestionResultsResponse
- AggregateTimeBucket
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequestSort
- AggregationResponse
- AggregationResponseStats
- AggregationValue
- BlockFromCommentParams
- BlockFromCommentPublic200Response
- BlockSuccess
- BulkAggregateQuestionItem
- BulkAggregateQuestionResults200Response
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- ChangeCommentPinStatusResponse
- CheckBlockedCommentsResponse
- CheckedCommentsForBlocked200Response
- CombineCommentsWithQuestionResults200Response
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateCommentPublic200Response
- CreateFeedPost200Response
- CreateFeedPostParams
- CreateFeedPostPublic200Response
- CreateFeedPostResponse
- CreateFeedPostsResponse
- CreateSubscriptionAPIResponse
- CreateUserBadge200Response
- CreateUserBadgeParams
- CustomConfigParameters
- DeleteComment200Response
- DeleteCommentAction
- DeleteCommentPublic200Response
- DeleteCommentResult
- DeleteCommentVote200Response
- DeleteDomainConfig200Response
- DeleteFeedPostPublic200Response
- DeleteFeedPostPublic200ResponseAnyOf
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- EventLogEntry
- FComment
- FCommentMeta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagComment200Response
- FlagCommentPublic200Response
- FlagCommentResponse
- GetAuditLogs200Response
- GetAuditLogsResponse
- GetComment200Response
- GetCommentText200Response
- GetCommentVoteUserNames200Response
- GetCommentVoteUserNamesSuccessResponse
- GetComments200Response
- GetCommentsPublic200Response
- GetCommentsResponsePublicComment
- GetCommentsResponseWithPresencePublicComment
- GetDomainConfig200Response
- GetDomainConfigs200Response
- GetDomainConfigs200ResponseAnyOf
- GetDomainConfigs200ResponseAnyOf1
- GetEventLog200Response
- GetEventLogResponse
- GetFeedPosts200Response
- GetFeedPostsPublic200Response
- GetFeedPostsResponse
- GetFeedPostsStats200Response
- GetMyNotificationsResponse
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPublicFeedPostsResponse
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsers200Response
- GetSubscriptionsAPIResponse
- GetUserBadge200Response
- GetUserBadgeProgressById200Response
- GetUserBadgeProgressList200Response
- GetUserBadges200Response
- GetUserNotificationCount200Response
- GetUserNotificationCountResponse
- GetUserNotifications200Response
- GetUserPresenceStatuses200Response
- GetUserPresenceStatusesResponse
- GetUserReactsPublic200Response
- GifRating
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- ImportedAPIStatusFAILED
- ImportedAPIStatusSUCCESS
- LiveEvent
- LiveEventExtraInfo
- LiveEventType
- LockComment200Response
- MediaAsset
- MetaItem
- NotificationAndCount
- NotificationObjectType
- NotificationType
- PatchDomainConfigParams
- PatchPageAPIResponse
- PatchSSOUserAPIResponse
- PickAPICommentUpdatableCommentFields
- PickFCommentAPICommentFieldsKeys
- PickFCommentAPICommentFieldsKeysMeta
- PickFCommentApprovedOrCommentHTML
- PickFCommentIsDeletedOrCommentHTMLOrCommenterNameOrUserId
- PickFCommentPublicCommentFieldsKeys
- PickOmitFCommentDatePublicCommentPubSubFieldsKeys
- PickTenantAuditLogTenantAuditLogKeys
- PinComment200Response
- PubSubComment
- PubSubVote
- PublicAPIDeleteCommentResponse
- PublicAPIGetCommentTextResponse
- PublicAPISetCommentTextResponse
- PublicBlockFromCommentParams
- PublicComment
- PublicFeedPostsResponse
- PutSSOUserAPIResponse
- QueryPredicate
- QueryPredicateValue
- QuestionDatum
- QuestionRenderingType
- QuestionResult
- QuestionResultAggregationOverall
- QuestionSubQuestionVisibility
- QuestionWhenSave
- ReactBodyParams
- ReactFeedPostPublic200Response
- ReactFeedPostResponse
- RecordStringBeforeStringOrNullAfterStringOrNullValue
- RecordStringStringOrNumberValue
- RenderableUserNotification
- ResetUserNotifications200Response
- ResetUserNotificationsResponse
- SORTDIR
- SSOSecurityLevel
- SaveComment200Response
- SaveCommentResponse
- SaveCommentResponseOptimized
- SaveCommentsResponseWithPresence
- SearchUsers200Response
- SearchUsersResponse
- SetCommentText200Response
- SizePreset
- SortDirections
- SpamRule
- UnBlockCommentPublic200Response
- UnBlockFromCommentParams
- UnblockSuccess
- UpdateAPIPageData
- UpdateAPISSOUserData
- UpdateDomainConfigParams
- UpdateFeedPostParams
- UpdateUserBadge200Response
- UpdateUserBadgeParams
- UpdateUserNotificationStatus200Response
- UploadImageResponse
- UserBadge
- UserBadgeProgress
- UserNotification
- UserNotificationWriteResponse
- UserPresenceData
- UserReactsResponse
- UserSearchResult
- UserSessionInfo
- VoteBodyParams
- VoteComment200Response
- VoteDeleteResponse
- VoteDeleteResponseStatus
- VoteResponse
- VoteResponseStatus
- VoteResponseUser
- VoteStyle
Autoryzacja 
Schematy uwierzytelniania zdefiniowane dla API:
api_key
- Typ: API key
- Nazwa parametru klucza API: x-api-key
- Lokalizacja: HTTP header
aggregate 
Agreguje dokumenty, grupując je (jeśli podano groupBy) i stosując wiele operacji. Obsługiwane są różne operacje (np. sum, countDistinct, avg itp.).
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| parentTenantId | string | query | Nie | |
| includeStats | boolean | query | Nie |
Odpowiedź
Zwraca: AggregationResponse
Przykład

getAuditLogs 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| limit | number | query | Nie | |
| skip | number | query | Nie | |
| order | string | query | Nie | |
| after | number | query | Nie | |
| before | number | query | Nie |
Odpowiedź
Zwraca: GetAuditLogs200Response
Przykład

blockFromCommentPublic 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: BlockFromCommentPublic200Response
Przykład

unBlockCommentPublic 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UnBlockCommentPublic200Response
Przykład

checkedCommentsForBlocked 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentIds | string | query | Tak | Lista identyfikatorów komentarzy oddzielona przecinkami. |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CheckedCommentsForBlocked200Response
Przykład

blockUserFromComment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: BlockFromCommentPublic200Response
Przykład

createCommentPublic 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| sessionId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateCommentPublic200Response
Przykład

deleteComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Odpowiedź
Zwraca: DeleteComment200Response
Przykład

deleteCommentPublic 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: DeleteCommentPublic200Response
Przykład

deleteCommentVote 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| voteId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: DeleteCommentVote200Response
Przykład

flagComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: FlagComment200Response
Przykład

getComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetComment200Response
Przykład

getComments 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | integer | query | Nie | |
| limit | integer | query | Nie | |
| skip | integer | query | Nie | |
| asTree | boolean | query | Nie | |
| skipChildren | integer | query | Nie | |
| limitChildren | integer | query | Nie | |
| maxTreeDepth | integer | query | Nie | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie | |
| contextUserId | string | query | Nie | |
| hashTag | string | query | Nie | |
| parentId | string | query | Nie | |
| direction | string | query | Nie |
Odpowiedź
Zwraca: GetComments200Response
Przykład

getCommentsPublic 
req tenantId urlId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Odpowiedź
Zwraca: GetCommentsPublic200Response
Przykład

getCommentText 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetCommentText200Response
Przykład

getCommentVoteUserNames 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| dir | integer | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetCommentVoteUserNames200Response
Przykład

lockComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: LockComment200Response
Przykład

pinComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: PinComment200Response
Przykład

saveComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| sendEmails | boolean | query | Nie | |
| populateNotifications | boolean | query | Nie |
Odpowiedź
Zwraca: SaveComment200Response
Przykład

saveCommentsBulk 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| sendEmails | boolean | query | Nie | |
| populateNotifications | boolean | query | Nie |
Odpowiedź
Zwraca: SaveComment200Response
Przykład

setCommentText 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| broadcastId | string | query | Tak | |
| editKey | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SetCommentText200Response
Przykład

unBlockUserFromComment 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: UnBlockCommentPublic200Response
Przykład

unFlagComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: FlagComment200Response
Przykład

unLockComment 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| commentId | string | ścieżka | Tak | |
| broadcastId | string | zapytanie | Tak | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: LockComment200Response
Przykład

unPinComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| commentId | string | ścieżka | Tak | |
| broadcastId | string | zapytanie | Tak | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: PinComment200Response
Przykład

updateComment 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

voteComment 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| commentId | string | path | Tak | |
| urlId | string | query | Tak | |
| broadcastId | string | query | Tak | |
| sessionId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: VoteComment200Response
Przykład

addDomainConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: AddDomainConfig200Response
Przykład

deleteDomainConfig 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Odpowiedź
Zwraca: DeleteDomainConfig200Response
Przykład

getDomainConfig 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domain | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

getDomainConfigs 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetDomainConfigs200Response
Przykład

patchDomainConfig 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domainToUpdate | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

putDomainConfig 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| domainToUpdate | string | path | Tak |
Odpowiedź
Zwraca: GetDomainConfig200Response
Przykład

createEmailTemplate 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: CreateEmailTemplate200Response
Przykład

deleteEmailTemplate 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

deleteEmailTemplateRenderError 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| errorId | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getEmailTemplate 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetEmailTemplate200Response
Przykład

getEmailTemplateDefinitions 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetEmailTemplateDefinitions200Response
Przykład

getEmailTemplateRenderErrors 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetEmailTemplateRenderErrors200Response
Przykład

getEmailTemplates 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetEmailTemplates200Response
Przykład

renderEmailTemplate 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| locale | string | query | Nie |
Odpowiedź
Zwraca: RenderEmailTemplate200Response
Przykład

updateEmailTemplate 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getEventLog 
req tenantId urlId userIdWS
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| userIdWS | string | query | Tak | |
| startTime | integer | query | Tak | |
| endTime | integer | query | Tak |
Odpowiedź
Zwraca: GetEventLog200Response
Przykład

getGlobalEventLog 
req tenantId urlId userIdWS
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| userIdWS | string | query | Tak | |
| startTime | integer | query | Tak | |
| endTime | integer | query | Tak |
Odpowiedź
Zwraca: GetEventLog200Response
Przykład

createFeedPost 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| broadcastId | string | query | Nie | |
| isLive | boolean | query | Nie | |
| doSpamCheck | boolean | query | Nie | |
| skipDupCheck | boolean | query | Nie |
Odpowiedź
Zwraca: CreateFeedPost200Response
Przykład

createFeedPostPublic 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostPublic200Response
Przykład

deleteFeedPostPublic 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: DeleteFeedPostPublic200Response
Przykład

getFeedPosts 
req tenantId afterId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie |
Odpowiedź
Zwraca: GetFeedPosts200Response
Przykład

getFeedPostsPublic 
req tenantId afterId
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| afterId | string | query | Nie | |
| limit | integer | query | Nie | |
| tags | array | query | Nie | |
| sso | string | query | Nie | |
| isCrawler | boolean | query | Nie | |
| includeUserInfo | boolean | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsPublic200Response
Przykład

getFeedPostsStats 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postIds | array | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetFeedPostsStats200Response
Przykład

getUserReactsPublic 
Parametry
| Name | Type | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | ścieżka | Tak | |
| postIds | array | zapytanie | Nie | |
| sso | string | zapytanie | Nie |
Odpowiedź
Zwraca: GetUserReactsPublic200Response
Przykład

reactFeedPostPublic 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Odpowiedź
Zwraca: ReactFeedPostPublic200Response
Przykład

updateFeedPost 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

updateFeedPostPublic 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| postId | string | path | Tak | |
| broadcastId | string | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: CreateFeedPostPublic200Response
Przykład

flagCommentPublic 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | path | Tak | |
| isFlagged | boolean | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

addHashTag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: AddHashTag200Response
Przykład

addHashTagsBulk 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: AddHashTagsBulk200Response
Przykład

deleteHashTag 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Tak | |
| tenantId | string | query | Nie |
Response
Zwraca: FlagCommentPublic200Response
Przykład

getHashTags 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| page | number | query | Nie |
Odpowiedź
Zwraca: GetHashTags200Response
Przykład

patchHashTag 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tag | string | path | Tak | |
| tenantId | string | query | Nie |
Odpowiedź
Zwraca: PatchHashTag200Response
Przykład

createModerator 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateModerator200Response
Przykład

deleteModerator 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sendEmail | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getModerator 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Zwraca: GetModerator200Response
Przykład

getModerators 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetModerators200Response
Przykład

sendInvite 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak | |
| fromName | string | zapytanie | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

updateModerator 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

deleteNotificationCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getCachedNotificationCount 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetCachedNotificationCount200Response
Przykład

getNotificationCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| urlId | string | query | Nie | |
| fromCommentId | string | query | Nie | |
| viewed | boolean | query | Nie | |
| type | string | query | Nie |
Odpowiedź
Zwraca: GetNotificationCount200Response
Przykład

getNotifications 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| urlId | string | query | Nie | |
| fromCommentId | string | query | Nie | |
| viewed | boolean | query | Nie | |
| type | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetNotifications200Response
Przykład

updateNotification 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

addPage 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: AddPageAPIResponse
Przykład

deletePage 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: DeletePageAPIResponse
Przykład

getPageByURLId 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetPageByURLIdAPIResponse
Przykład

getPages 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: GetPagesAPIResponse
Przykład

patchPage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: PatchPageAPIResponse
Przykład

deletePendingWebhookEvent 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getPendingWebhookEventCount 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEventCount200Response
Przykład

getPendingWebhookEvents 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Nie | |
| externalId | string | query | Nie | |
| eventType | string | query | Nie | |
| type | string | query | Nie | |
| domain | string | query | Nie | |
| attemptCountGT | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetPendingWebhookEvents200Response
Przykład

createQuestionConfig 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionConfig200Response
Przykład

deleteQuestionConfig 
Parametry
| Nazwa | Typ | Miejsce | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getQuestionConfig 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetQuestionConfig200Response
Przykład

getQuestionConfigs 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionConfigs200Response
Przykład

updateQuestionConfig 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

createQuestionResult 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateQuestionResult200Response
Przykład

deleteQuestionResult 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getQuestionResult 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: GetQuestionResult200Response
Przykład

getQuestionResults 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Nie | |
| userId | string | query | Nie | |
| startDate | string | query | Nie | |
| questionId | string | query | Nie | |
| questionIds | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetQuestionResults200Response
Przykład

updateQuestionResult 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

aggregateQuestionResults 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| questionId | string | query | Nie | |
| questionIds | array | query | Nie | |
| urlId | string | query | Nie | |
| timeBucket | string | query | Nie | |
| startDate | string | query | Nie | |
| forceRecalculate | boolean | query | Nie |
Odpowiedź
Zwraca: AggregateQuestionResults200Response
Przykład

bulkAggregateQuestionResults 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| forceRecalculate | boolean | query | No |
Odpowiedź
Zwraca: BulkAggregateQuestionResults200Response
Przykład

combineCommentsWithQuestionResults 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Odpowiedź
Zwraca: CombineCommentsWithQuestionResults200Response
Przykład

addSSOUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: AddSSOUserAPIResponse
Przykład

deleteSSOUser 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | boolean | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: DeleteSSOUserAPIResponse
Przykład

getSSOUserByEmail 
Parametry
| Nazwa | Typ | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| string | path | Tak |
Odpowiedź
Zwraca: GetSSOUserByEmailAPIResponse
Przykład

getSSOUserById 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetSSOUserByIdAPIResponse
Przykład

getSSOUsers 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | integer | query | Nie |
Odpowiedź
Zwraca: GetSSOUsers200Response
Przykład

patchSSOUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PatchSSOUserAPIResponse
Przykład

putSSOUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | boolean | query | Nie |
Odpowiedź
Zwraca: PutSSOUserAPIResponse
Przykład

createSubscription 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Odpowiedź
Zwraca: CreateSubscriptionAPIResponse
Przykład

deleteSubscription 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| userId | string | query | Nie |
Odpowiedź
Zwraca: DeleteSubscriptionAPIResponse
Przykład

getSubscriptions 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No |
Odpowiedź
Zwraca: GetSubscriptionsAPIResponse
Przykład

getTenantDailyUsages 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| yearNumber | number | query | Nie | |
| monthNumber | number | query | Nie | |
| dayNumber | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantDailyUsages200Response
Przykład

createTenantPackage 
Parametry
| Name | Type | Location | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenantPackage200Response
Przykład

deleteTenantPackage 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getTenantPackage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantPackage200Response
Przykład

getTenantPackages 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantPackages200Response
Przykład

replaceTenantPackage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

updateTenantPackage 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

createTenantUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak |
Odpowiedź
Zwraca: CreateTenantUser200Response
Przykład

deleteTenantUser 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| deleteComments | string | query | Nie | |
| commentDeleteMode | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getTenantUser 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetTenantUser200Response
Przykład

getTenantUsers 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenantUsers200Response
Przykład

replaceTenantUser 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Response
Zwraca: FlagCommentPublic200Response
Przykład

sendLoginLink 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| redirectURL | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

updateTenantUser 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| updateComments | string | query | Nie |
Response
Zwraca: FlagCommentPublic200Response
Przykład

createTenant 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateTenant200Response
Przykład

deleteTenant 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| sure | string | query | Nie |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

getTenant 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Odpowiedź
Zwraca: GetTenant200Response
Przykład

getTenants 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| meta | string | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetTenants200Response
Przykład

updateTenant 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: FlagCommentPublic200Response
Przykład

uploadImage 
Prześlij i zmień rozmiar obrazu
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| sizePreset | string | query | Nie | Predefiniowany rozmiar: "Default" (1000x1000px) lub "CrossPlatform" (tworzy rozmiary dla popularnych urządzeń) |
| urlId | string | query | Nie | Id strony, z której odbywa się przesyłanie, do konfiguracji |
Odpowiedź
Zwraca: UploadImageResponse
Przykład

getUserBadgeProgressById 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadgeProgressById200Response
Przykład

getUserBadgeProgressByUserId 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | path | Yes |
Odpowiedź
Zwraca: GetUserBadgeProgressById200Response
Przykład

getUserBadgeProgressList 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetUserBadgeProgressList200Response
Przykład

createUserBadge 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak |
Odpowiedź
Zwraca: CreateUserBadge200Response
Przykład

deleteUserBadge 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Zwraca
Zwraca: UpdateUserBadge200Response
Przykład

getUserBadge 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: GetUserBadge200Response
Przykład

getUserBadges 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| userId | string | query | Nie | |
| badgeId | string | query | Nie | |
| type | number | query | Nie | |
| displayedOnComments | boolean | query | Nie | |
| limit | number | query | Nie | |
| skip | number | query | Nie |
Odpowiedź
Zwraca: GetUserBadges200Response
Przykład

updateUserBadge 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak |
Odpowiedź
Zwraca: UpdateUserBadge200Response
Przykład

getUserNotificationCount 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserNotificationCount200Response
Przykład

getUserNotifications 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| pageSize | integer | query | Nie | |
| afterId | string | query | Nie | |
| includeContext | boolean | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| includeTranslations | boolean | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: GetUserNotifications200Response
Przykład

resetUserNotificationCount 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| sso | string | query | Nie |
Response
Zwraca: ResetUserNotifications200Response
Przykład

resetUserNotifications 
Parameters
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| afterId | string | query | Nie | |
| afterCreatedAt | integer | query | Nie | |
| unreadOnly | boolean | query | Nie | |
| dmOnly | boolean | query | Nie | |
| noDm | boolean | query | Nie | |
| sso | string | query | Nie |
Response
Zwraca: ResetUserNotifications200Response
Przykład

updateUserNotificationCommentSubscriptionStatus 
Włącz lub wyłącz powiadomienia dla konkretnego komentarza.
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| notificationId | string | path | Tak | |
| optedInOrOut | string | path | Tak | |
| commentId | string | query | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

updateUserNotificationPageSubscriptionStatus 
Włącz lub wyłącz powiadomienia dla strony. Gdy użytkownicy są subskrybowani do strony, tworzone są powiadomienia dla nowych komentarzy głównych, a także
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| url | string | query | Tak | |
| pageTitle | string | query | Tak | |
| subscribedOrUnsubscribed | string | path | Tak | |
| sso | string | query | Nie |
Response
Zwraca: UpdateUserNotificationStatus200Response
Example

updateUserNotificationStatus 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| notificationId | string | path | Tak | |
| newStatus | string | path | Tak | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: UpdateUserNotificationStatus200Response
Przykład

getUserPresenceStatuses 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlIdWS | string | query | Tak | |
| userIds | string | query | Tak |
Odpowiedź
Zwraca: GetUserPresenceStatuses200Response
Przykład

searchUsers 
Parametry
| Name | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | path | Tak | |
| urlId | string | query | Tak | |
| usernameStartsWith | string | query | Tak | |
| mentionGroupIds | array | query | Nie | |
| sso | string | query | Nie |
Odpowiedź
Zwraca: SearchUsers200Response
Przykład

getUser 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | zapytanie | Tak | |
| id | string | ścieżka | Tak |
Odpowiedź
Zwraca: GetUser200Response
Przykład

createVote 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| commentId | string | query | Tak | |
| direction | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: VoteComment200Response
Przykład

deleteVote 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| id | string | path | Tak | |
| editKey | string | query | Nie |
Odpowiedź
Zwraca: DeleteCommentVote200Response
Przykład

getVotes 
Parametry
| Nazwa | Typ | Lokalizacja | Wymagane | Opis |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak |
Odpowiedź
Zwraca: GetVotes200Response
Przykład

getVotesForUser 
Parametry
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Tak | |
| urlId | string | query | Tak | |
| userId | string | query | Nie | |
| anonUserId | string | query | Nie |
Odpowiedź
Zwraca: GetVotesForUser200Response
Przykład

Potrzebujesz pomocy?
Jeśli napotkasz jakiekolwiek problemy lub masz pytania dotyczące SDK dla PHP, prosimy:
Współtworzenie
Wkłady są mile widziane! Prosimy odwiedzić repozytorium na GitHubie w celu zapoznania się z wytycznymi dotyczącymi kontrybucji.