
語言 🇹🇼 繁體中文
快速入門
文件
使用方式
彙總
稽核日誌
評論封鎖
檢查被封鎖的評論
評論
網域設定
電子郵件範本
事件日誌
動態文章
檢舉評論
標籤
管理員
通知計數
通知
頁面
待處理的 Webhook 事件
問題設定
問題結果
問題結果彙整
SSO 使用者
訂閱
租戶每日使用量
租戶方案
租戶使用者
租戶
上傳圖片
使用者徽章進度
使用者徽章
使用者通知
使用者在線狀態
使用者搜尋
使用者
投票
FastComments Ruby SDK
這是 FastComments 的官方 Ruby SDK。
FastComments API 的官方 Ruby SDK
儲存庫
安裝 
將這一行加入您應用程式的 Gemfile:
gem 'fastcomments'
然後執行:
bundle install
或使用下列指令自行安裝:
gem install fastcomments
函式庫內容
此函式庫包含已產生的 API 用戶端與 SSO 工具,能使使用 API 更加簡便。
公開與受保護的 API
對於 API 用戶端,有兩個類別,DefaultApi 與 PublicApi。DefaultApi 包含需要您的 API 金鑰的方法,而 PublicApi 包含可直接從瀏覽器/行動裝置等
在不需驗證的情況下呼叫的 API。
快速開始 
使用已驗證的 API (DefaultApi)
重要: 您必須在發出已驗證請求之前,在 ApiClient 上設定您的 API 金鑰。如果未設定,請求會以 401 錯誤失敗。
require 'fastcomments-client'
# 建立並配置 API 用戶端
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# 必須:在此設定您的 API 金鑰(從 FastComments 儀表板取得)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# 使用已配置的用戶端建立 API 實例
api = FastCommentsClient::DefaultApi.new(api_client)
# 現在您可以進行已驗證的 API 呼叫
begin
# 範例:新增 SSO 使用者
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# 常見錯誤:
# - 401:API 金鑰遺失或無效
# - 400:請求驗證失敗
end
使用公開 API (PublicApi)
公開端點不需要驗證:
require 'fastcomments-client'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
tenant_id: 'YOUR_TENANT_ID',
url_id: 'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
常見問題
- 401 "missing-api-key" error:請在建立
DefaultApi實例之前確認已設定config.api_key['x-api-key'] = 'YOUR_KEY'。 - Wrong API class:伺服器端的已驗證請求請使用
DefaultApi,用於客戶端/公開請求請使用PublicApi。 - Null API key:若 API 金鑰為 null,SDK 會靜默跳過驗證,導致 401 錯誤。
注意事項 
廣播 ID
你會看到在某些 API 呼叫中需要傳入 broadcastId。當你收到事件時,會收到這個 ID 作為回傳,因此如果你打算在客戶端樂觀地套用變更,可以用它來判斷是否忽略該事件
(你很可能會想這麼做,因為它提供最佳的體驗)。在此傳入一個 UUID。該 ID 應足夠唯一,不會在同一瀏覽器會話中出現兩次。
SSO (單一登入)
有關 SSO 的範例,請參閱下方。
SSO 使用 
簡易 SSO
require 'fastcomments'
require 'fastcomments-client'
# 建立簡易 SSO 令牌
user = FastComments::SSO::SimpleSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
avatar: 'https://example.com/avatar.jpg'
)
sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token
puts "SSO Token: #{token}"
# 使用 SSO 令牌來進行已驗證的 API 呼叫
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
安全 SSO
require 'fastcomments'
require 'fastcomments-client'
# 建立安全 SSO 令牌
user = FastComments::SSO::SecureSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
username: 'johndoe',
avatar: 'https://example.com/avatar.jpg'
)
api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token
puts "Secure SSO Token: #{token}"
# 使用 SSO 令牌來進行已驗證的 API 呼叫
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
彙總 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations. Different operations (e.g. sum, countDistinct, avg, etc.) are supported.
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
回應
Returns: AggregationResponse
範例

取得稽核日誌 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| limit | number | query | 否 | |
| skip | number | query | 否 | |
| order | string | query | 否 | |
| after | number | query | 否 | |
| before | number | query | 否 |
回應
範例

封鎖公開評論 
參數
| 名稱 | 型別 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| commentId | string | path | 是 | |
| sso | string | query | 否 |
回應
回傳: BlockFromCommentPublic200Response
範例

取消封鎖公開評論 
參數
| 名稱 | 類型 | 位置 | 必要 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| commentId | string | path | 是 | |
| sso | string | query | 否 |
回應
回傳: UnBlockCommentPublic200Response
範例

檢查被封鎖的評論 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| commentIds | string | query | 是 | 以逗號分隔的留言 ID 列表。 |
| sso | string | query | 否 |
回應
回傳:CheckedCommentsForBlocked200Response
範例

封鎖使用者(評論) 
參數
| 名稱 | 型別 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| userId | string | query | 否 | |
| anonUserId | string | query | 否 |
回應
回傳: BlockFromCommentPublic200Response
範例

建立公開評論 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| urlId | string | query | 是 | |
| broadcastId | string | query | 是 | |
| sessionId | string | query | 否 | |
| sso | string | query | 否 |
回應
回傳: CreateCommentPublic200Response
範例

刪除評論 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| contextUserId | string | query | 否 | |
| isLive | boolean | query | 否 |
回應
範例

刪除公開評論 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| broadcastId | string | query | 是 | |
| editKey | string | query | 否 | |
| sso | string | query | 否 |
回應
回傳: DeleteCommentPublic200Response
範例

刪除評論投票 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| voteId | string | path | 是 | |
| urlId | string | query | 是 | |
| broadcastId | string | query | 是 | |
| editKey | string | query | 否 | |
| sso | string | query | 否 |
回應
回傳: DeleteCommentVote200Response
範例

檢舉評論 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| userId | string | query | 否 | |
| anonUserId | string | query | 否 |
回應
範例

取得評論 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
範例

取得評論內容 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| editKey | string | query | 否 | |
| sso | string | query | 否 |
回應
範例

取得評論投票者名稱 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| dir | integer | query | 是 | |
| sso | string | query | 否 |
回應
回傳: GetCommentVoteUserNames200Response
範例

取得評論列表 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| page | integer | query | 否 | |
| limit | integer | query | 否 | |
| skip | integer | query | 否 | |
| asTree | boolean | query | 否 | |
| skipChildren | integer | query | 否 | |
| limitChildren | integer | query | 否 | |
| maxTreeDepth | integer | query | 否 | |
| urlId | string | query | 否 | |
| userId | string | query | 否 | |
| anonUserId | string | query | 否 | |
| contextUserId | string | query | 否 | |
| hashTag | string | query | 否 | |
| parentId | string | query | 否 | |
| direction | string | query | 否 |
回應
範例

取得公開評論 
req tenantId urlId
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| urlId | string | query | 是 | |
| page | integer | query | 否 | |
| direction | string | query | 否 | |
| sso | string | query | 否 | |
| skip | integer | query | 否 | |
| skipChildren | integer | query | 否 | |
| limit | integer | query | 否 | |
| limitChildren | integer | query | 否 | |
| countChildren | boolean | query | 否 | |
| fetchPageForCommentId | string | query | 否 | |
| includeConfig | boolean | query | 否 | |
| countAll | boolean | query | 否 | |
| includei10n | boolean | query | 否 | |
| locale | string | query | 否 | |
| modules | string | query | 否 | |
| isCrawler | boolean | query | 否 | |
| includeNotificationCount | boolean | query | 否 | |
| asTree | boolean | query | 否 | |
| maxTreeDepth | integer | query | 否 | |
| useFullTranslationIds | boolean | query | 否 | |
| parentId | string | query | 否 | |
| searchText | string | query | 否 | |
| hashTags | array | query | 否 | |
| userId | string | query | 否 | |
| customConfigStr | string | query | 否 | |
| afterCommentId | string | query | 否 | |
| beforeCommentId | string | query | 否 |
回應
回傳: GetCommentsPublic200Response
範例

鎖定評論 
參數
| 名稱 | 型別 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| broadcastId | string | query | 是 | |
| sso | string | query | 否 |
回應
範例

置頂評論 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| broadcastId | string | query | 是 | |
| sso | string | query | 否 |
回應
範例

儲存評論 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| isLive | boolean | query | 否 | |
| doSpamCheck | boolean | query | 否 | |
| sendEmails | boolean | query | 否 | |
| populateNotifications | boolean | query | 否 |
回應
範例

批次儲存評論 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| isLive | boolean | query | 否 | |
| doSpamCheck | boolean | query | 否 | |
| sendEmails | boolean | query | 否 | |
| populateNotifications | boolean | query | 否 |
回應
回傳: Array<SaveComment200Response>
範例

設定評論內容 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| broadcastId | string | query | 是 | |
| editKey | string | query | 否 | |
| sso | string | query | 否 |
回應
範例

取消封鎖評論使用者 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| userId | string | query | 否 | |
| anonUserId | string | query | 否 |
回應
回傳: UnBlockCommentPublic200Response
範例

取消檢舉評論 
參數
| 名稱 | 型別 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| userId | string | query | 否 | |
| anonUserId | string | query | 否 |
回應
範例

解鎖評論 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| broadcastId | string | query | 是 | |
| sso | string | query | 否 |
回應
範例

取消置頂評論 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| broadcastId | string | query | 是 | |
| sso | string | query | 否 |
回應
範例

更新評論 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| contextUserId | string | query | 否 | |
| doSpamCheck | boolean | query | 否 | |
| isLive | boolean | query | 否 |
回應
回傳: FlagCommentPublic200Response
範例

對評論投票 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| commentId | string | path | 是 | |
| urlId | string | query | 是 | |
| broadcastId | string | query | 是 | |
| sessionId | string | query | 否 | |
| sso | string | query | 否 |
回應
範例

新增網域設定 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳: AddDomainConfig200Response
範例

刪除網域設定 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| domain | string | path | 是 |
回應
回傳: DeleteDomainConfig200Response
範例

取得網域設定 
參數
| 名稱 | 型別 | 位置 | 是否必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | 查詢 | 是 | |
| domain | string | 路徑 | 是 |
回應
回傳: GetDomainConfig200Response
範例

取得網域設定列表 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳: GetDomainConfigs200Response
範例

部分更新網域設定 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| domainToUpdate | string | path | 是 |
回應
回傳: GetDomainConfig200Response
範例

替換網域設定 
參數
| 名稱 | 型別 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| domainToUpdate | string | path | 是 |
回應
回傳: GetDomainConfig200Response
範例

建立電子郵件範本 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳: CreateEmailTemplate200Response
範例

刪除電子郵件範本 
參數
| 名稱 | 型別 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: FlagCommentPublic200Response
範例

刪除電子郵件範本渲染錯誤 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| errorId | string | path | 是 |
回應
回傳: FlagCommentPublic200Response
範例

取得電子郵件範本 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: GetEmailTemplate200Response
範例

取得電子郵件範本定義 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳: GetEmailTemplateDefinitions200Response
範例

取得電子郵件範本渲染錯誤 
參數
| 名稱 | 類型 | 位置 | 是否必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| skip | number | query | No |
回應
回傳: GetEmailTemplateRenderErrors200Response
範例

取得電子郵件範本列表 
參數
| 名稱 | 類型 | 位置 | 必需 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
回應
回傳: GetEmailTemplates200Response
範例

渲染電子郵件範本 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| locale | string | query | 否 |
回應
回傳: RenderEmailTemplate200Response
範例

更新電子郵件範本 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: FlagCommentPublic200Response
範例

取得事件日誌 
req tenantId urlId userIdWS
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| urlId | string | query | 是 | |
| userIdWS | string | query | 是 | |
| startTime | integer | query | 是 | |
| endTime | integer | query | 是 |
回應
範例

取得全域事件日誌 
req tenantId urlId userIdWS
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| userIdWS | string | query | Yes | |
| startTime | integer | query | Yes | |
| endTime | integer | query | Yes |
回應
範例

建立動態文章 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| broadcastId | string | query | 否 | |
| isLive | boolean | query | 否 | |
| doSpamCheck | boolean | query | 否 | |
| skipDupCheck | boolean | query | 否 |
回應
範例

建立公開動態文章 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| broadcastId | string | query | 否 | |
| sso | string | query | 否 |
回應
回傳: CreateFeedPostPublic200Response
範例

刪除公開動態文章 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
回應
回傳: DeleteFeedPostPublic200Response
範例

取得動態文章列表 
req tenantId afterId
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| afterId | string | query | 否 | |
| limit | integer | query | 否 | |
| tags | array | query | 否 |
回應
範例

取得公開動態文章 
req tenantId afterId
參數
| 名稱 | 類型 | 位置 | 必要 | 描述 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| afterId | string | query | 否 | |
| limit | integer | query | 否 | |
| tags | array | query | 否 | |
| sso | string | query | 否 | |
| isCrawler | boolean | query | 否 | |
| includeUserInfo | boolean | query | 否 |
回應
回傳: GetFeedPostsPublic200Response
範例

取得動態文章統計 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| postIds | array | query | 是 | |
| sso | string | query | 否 |
回應
回傳: GetFeedPostsStats200Response
範例

取得使用者公開反應 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | 路徑 | 是 | |
| postIds | array | 查詢 | 否 | |
| sso | string | 查詢 | 否 |
回應
回傳: GetUserReactsPublic200Response
範例

對公開動態文章反應 
參數
| 名稱 | 型別 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| postId | string | path | 是 | |
| isUndo | boolean | query | 否 | |
| broadcastId | string | query | 否 | |
| sso | string | query | 否 |
回應
回傳:ReactFeedPostPublic200Response
範例

更新動態文章 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳:FlagCommentPublic200Response
範例

更新公開動態文章 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| postId | string | path | 是 | |
| broadcastId | string | query | 否 | |
| sso | string | query | 否 |
回應
回傳:CreateFeedPostPublic200Response
範例

檢舉公開評論 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| commentId | string | path | 是 | |
| isFlagged | boolean | query | 是 | |
| sso | string | query | 否 |
回應
回傳:FlagCommentPublic200Response
範例

新增標籤 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | No |
回應
範例

批次新增標籤 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | No |
回應
回傳: AddHashTagsBulk200Response
範例

刪除標籤 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tag | string | path | Yes | |
| tenantId | string | query | No |
回應
回傳:FlagCommentPublic200Response
範例

取得標籤列表 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| page | number | query | 否 |
Response
範例

部分更新標籤 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tag | string | path | 是 | |
| tenantId | string | query | 否 |
回應
範例

建立管理員 
參數
| 名稱 | 型別 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳: CreateModerator200Response
範例

刪除管理員 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| sendEmail | string | query | 否 |
回應
回傳: FlagCommentPublic200Response
範例

取得管理員 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
回應
範例

取得管理員列表 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| skip | number | query | 否 |
回傳
範例

發送邀請 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| fromName | string | query | 是 |
回應
返回:FlagCommentPublic200Response
範例

更新管理員 
參數
| 名稱 | 類型 | 位置 | 是否必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: FlagCommentPublic200Response
範例

刪除通知計數 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
回應
回傳: FlagCommentPublic200Response
範例

取得快取的通知計數 
參數
| 名稱 | 型別 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: GetCachedNotificationCount200Response
範例

取得通知計數 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| userId | string | query | 否 | |
| urlId | string | query | 否 | |
| fromCommentId | string | query | 否 | |
| viewed | boolean | query | 否 | |
| type | string | query | 否 |
回應
回傳: GetNotificationCount200Response
範例

取得通知 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| userId | string | query | 否 | |
| urlId | string | query | 否 | |
| fromCommentId | string | query | 否 | |
| viewed | boolean | query | 否 | |
| type | string | query | 否 | |
| skip | number | query | 否 |
回應
回傳: GetNotifications200Response
範例

更新通知 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
回應
回傳: FlagCommentPublic200Response
範例

新增頁面 
參數
| 名稱 | 類型 | 位置 | 是否必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
範例

刪除頁面 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
範例

以 URL ID 取得頁面 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| urlId | string | query | 是 |
回應
範例

取得頁面列表 
參數
| 名稱 | 型別 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
範例

部分更新頁面 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
範例

刪除待處理的 Webhook 事件 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回傳
回傳: FlagCommentPublic200Response
範例

取得待處理 Webhook 事件數量 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
回應
回傳: GetPendingWebhookEventCount200Response
範例

取得待處理的 Webhook 事件 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| commentId | string | query | 否 | |
| externalId | string | query | 否 | |
| eventType | string | query | 否 | |
| type | string | query | 否 | |
| domain | string | query | 否 | |
| attemptCountGT | number | query | 否 | |
| skip | number | query | 否 |
回應
回傳: GetPendingWebhookEvents200Response
範例

建立問題設定 
參數
| 名稱 | 型別 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳: CreateQuestionConfig200Response
範例

刪除問題設定 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳:FlagCommentPublic200Response
範例

取得問題設定 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
回應
回傳: GetQuestionConfig200Response
範例

取得問題設定列表 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| skip | number | query | 否 |
回應
回傳: GetQuestionConfigs200Response
範例

更新問題設定 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: FlagCommentPublic200Response
範例

建立問題結果 
參數
| 名稱 | 類型 | 位置 | 必要 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳:CreateQuestionResult200Response
範例

刪除問題結果 
參數
| 名稱 | 類型 | 位置 | 必需 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: FlagCommentPublic200Response
範例

取得問題結果 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
回應
回傳: GetQuestionResult200Response
範例

取得問題結果列表 
參數
| 名稱 | 類型 | 位置 | 是否必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| urlId | string | query | 否 | |
| userId | string | query | 否 | |
| startDate | string | query | 否 | |
| questionId | string | query | 否 | |
| questionIds | string | query | 否 | |
| skip | number | query | 否 |
回應
回傳: GetQuestionResults200Response
範例

更新問題結果 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳:FlagCommentPublic200Response
範例

彙總問題結果 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| questionId | string | query | 否 | |
| questionIds | array | query | 否 | |
| urlId | string | query | 否 | |
| timeBucket | string | query | 否 | |
| startDate | string | query | 否 | |
| forceRecalculate | boolean | query | 否 |
回應
回傳: AggregateQuestionResults200Response
範例

批次彙總問題結果 
參數
| 名稱 | 類型 | Location | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| forceRecalculate | boolean | query | 否 |
回應
回傳: BulkAggregateQuestionResults200Response
範例

將評論與問題結果合併 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| 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 |
回應
回傳: CombineCommentsWithQuestionResults200Response
範例

新增 SSO 使用者 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
回應
範例

刪除 SSO 使用者 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| deleteComments | boolean | query | 否 | |
| commentDeleteMode | string | query | 否 |
回應
範例

以電子郵件取得 SSO 使用者 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
回應
回傳: GetSSOUserByEmailAPIResponse
範例

以 ID 取得 SSO 使用者 
參數
| 名稱 | 型別 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
範例

取得 SSO 使用者列表 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| skip | integer | query | 否 |
回應
範例

部分更新 SSO 使用者 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| updateComments | boolean | query | 否 |
回應
範例

替換 SSO 使用者 
參數
| 名稱 | Type | Location | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| updateComments | boolean | query | 否 |
回應
範例

建立訂閱 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳:CreateSubscriptionAPIResponse
範例

刪除訂閱 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| userId | string | query | 否 |
回應
回傳: DeleteSubscriptionAPIResponse
範例

取得訂閱列表 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| userId | string | query | 否 |
回應
回傳: GetSubscriptionsAPIResponse
範例

取得租戶每日使用量 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| yearNumber | number | query | 否 | |
| monthNumber | number | query | 否 | |
| dayNumber | number | query | 否 | |
| skip | number | query | 否 |
回應
回傳: GetTenantDailyUsages200Response
範例

建立租戶方案 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳: CreateTenantPackage200Response
範例

刪除租戶方案 
參數
| 名稱 | 類型 | 位置 | 必要 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: FlagCommentPublic200Response
範例

取得租戶方案 
參數
| 名稱 | 型別 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | 查詢 | 是 | |
| id | string | 路徑 | 是 |
回應
回傳: GetTenantPackage200Response
範例

取得租戶方案列表 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| skip | number | query | 否 |
回應
回傳:GetTenantPackages200Response
範例

替換租戶方案 
參數
| 名稱 | 型別 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: FlagCommentPublic200Response
範例

更新租戶方案 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: FlagCommentPublic200Response
範例

建立租戶使用者 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
回應
回傳: CreateTenantUser200Response
範例

刪除租戶使用者 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| deleteComments | string | query | 否 | |
| commentDeleteMode | string | query | 否 |
回應
回傳: FlagCommentPublic200Response
範例

取得租戶使用者 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
範例

取得租戶使用者列表 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| skip | number | query | 否 |
回應
範例

替換租戶使用者 
參數
| 名稱 | 型別 | 位於 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| updateComments | string | query | 否 |
回應
回傳:FlagCommentPublic200Response
範例

發送登入連結 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| redirectURL | string | query | 否 |
回應
回傳:FlagCommentPublic200Response
範例

更新租戶使用者 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| updateComments | string | query | 否 |
回應
回傳: FlagCommentPublic200Response
範例

建立租戶 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
範例

刪除租戶 
參數
| 名稱 | 型別 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| sure | string | query | 否 |
回應
回傳: FlagCommentPublic200Response
範例

取得租戶 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
範例

取得租戶列表 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| meta | string | query | No | |
| skip | number | query | No |
回應
範例

更新租戶 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
回應
回傳: FlagCommentPublic200Response
範例

上傳圖片 
上傳並調整圖片大小
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| sizePreset | string | query | 否 | 大小預設: "Default" (1000x1000px) 或 "CrossPlatform" (為熱門裝置建立尺寸) |
| urlId | string | query | 否 | 上傳所屬的頁面 ID,用於設定 |
回應
範例

以 ID 取得使用者徽章進度 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | 查詢參數 | 是 | |
| id | string | 路徑參數 | 是 |
回應
回傳: GetUserBadgeProgressById200Response
範例

以使用者 ID 取得徽章進度 
參數
| 名稱 | 類型 | Location | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| userId | string | path | 是 |
回應
回傳: GetUserBadgeProgressById200Response
範例

取得使用者徽章進度列表 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
回應
回傳: GetUserBadgeProgressList200Response
範例

建立使用者徽章 
參數
| 名稱 | 型別 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 |
回應
回傳: CreateUserBadge200Response
範例

刪除使用者徽章 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: UpdateUserBadge200Response
範例

取得使用者徽章 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
範例

取得使用者徽章列表 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| userId | string | query | 否 | |
| badgeId | string | query | 否 | |
| type | number | query | 否 | |
| displayedOnComments | boolean | query | 否 | |
| limit | number | query | 否 | |
| skip | number | query | 否 |
回應
範例

更新使用者徽章 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
回傳: UpdateUserBadge200Response
範例

取得使用者通知計數 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| sso | string | query | 否 |
回應
回傳: GetUserNotificationCount200Response
範例

取得使用者通知 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| pageSize | integer | query | 否 | |
| afterId | string | query | 否 | |
| includeContext | boolean | query | 否 | |
| afterCreatedAt | integer | query | 否 | |
| unreadOnly | boolean | query | 否 | |
| dmOnly | boolean | query | 否 | |
| noDm | boolean | query | 否 | |
| includeTranslations | boolean | query | 否 | |
| sso | string | query | 否 |
回應
回傳: GetUserNotifications200Response
範例

重設使用者通知計數 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| sso | string | query | 否 |
回應
回傳: ResetUserNotifications200Response
範例

重設使用者通知 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| afterId | string | query | 否 | |
| afterCreatedAt | integer | query | 否 | |
| unreadOnly | boolean | query | 否 | |
| dmOnly | boolean | query | 否 | |
| noDm | boolean | query | 否 | |
| sso | string | query | 否 |
回應
回傳: ResetUserNotifications200Response
範例

更新使用者評論通知訂閱狀態 
啟用或停用特定留言的通知。
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| notificationId | string | path | 是 | |
| optedInOrOut | string | path | 是 | |
| commentId | string | query | 是 | |
| sso | string | query | 否 |
回應
回傳:UpdateUserNotificationStatus200Response
範例

更新使用者頁面通知訂閱狀態 
啟用或停用頁面通知。當使用者訂閱某頁面時,系統會為新的頂層留言建立通知,並且還會
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Response
回傳: UpdateUserNotificationStatus200Response
Example

更新使用者通知狀態 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| notificationId | string | path | 是 | |
| newStatus | string | path | 是 | |
| sso | string | query | 否 |
回應
回傳: UpdateUserNotificationStatus200Response
範例

取得使用者在線狀態 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| urlIdWS | string | query | 是 | |
| userIds | string | query | 是 |
回應
回傳:GetUserPresenceStatuses200Response
範例

搜尋使用者 
參數
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | 是 | |
| urlId | string | query | 是 | |
| usernameStartsWith | string | query | 是 | |
| mentionGroupIds | array | query | 否 | |
| sso | string | query | 否 |
回傳
範例

取得使用者 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 |
回應
範例

建立投票 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| commentId | string | query | 是 | |
| direction | string | query | 是 | |
| userId | string | query | 否 | |
| anonUserId | string | query | 否 |
回應
範例

刪除投票 
參數
| 名稱 | 類型 | 位置 | 必填 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | 是 | |
| id | string | path | 是 | |
| editKey | string | query | 否 |
回應
回傳: DeleteCommentVote200Response
範例

取得投票列表 
參數
| 名稱 | 類型 | 位置 | 必填 | 描述 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
回應
範例

取得使用者的投票 
參數
| 名稱 | Type | 位置 | 必要 | 說明 |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
回應
回傳: GetVotesForUser200Response
範例

需要幫助?
如果您在使用 Ruby SDK 遇到任何問題或有任何疑問,請:
貢獻
歡迎您提交貢獻!請造訪 GitHub 儲存庫 以查看貢獻指南。