動態訊號 （預覽）
Dynamic Signal 是一個員工溝通和敬業度平台，受到組織的信賴，可以連接、調整和吸引員工。 連接到 Dynamic Signal 以創建和管理您的帖子和用戶。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部 （DoD） |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| Power Automate（自動化服務） | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 連接器中繼資料 | |
|---|---|
| Publisher | 動態信號 |
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 持有人權杖 | securestring | 此 API 的持有人權杖 | 對 |
| 動態訊號網址 | 字串 | 您存取動態訊號的URL。 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 上傳圖片 |
透過二進位上傳上傳影像 |
| 取得使用者標籤 |
取得系統中定義的使用者標籤清單 |
| 取得目標 |
取得社群目標和目標定義的清單 |
| 取得貼文 |
按 ID 獲取特定帖子 |
| 取得貼文標籤 |
取得系統中定義的貼文標籤 |
| 取得除法 |
取得部門清單 |
| 取得類別 |
取得已驗證使用者可見的類別清單 |
| 將文件上傳至貼文 |
透過二進位上傳將文件上傳至貼文 |
| 建立貼文 |
建立貼文。 |
| 更新貼文 |
編輯現有貼文。 |
| 管理貼文 |
允許伺服器驗證呼叫在單一請求中更新多個貼文的屬性 |
| 透過 URL 將圖片新增至貼文 |
透過URL設定貼文圖片。 |
| 透過上傳將圖像新增至貼文 |
透過二進位上傳設定貼文影像。 |
| 透過電子郵件取得使用者 |
依使用者的電子郵件地址擷取使用者 |
| 預先註冊使用者 |
建立處於預先註冊狀態的新使用者 |
上傳圖片
透過二進位上傳上傳影像
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案
|
File | True | binary |
要上傳的檔案 |
|
內容類型，例如 image/jpg、image/pjpeg、image/png、image/x-png、image/gif
|
Content-Type | True | string |
Content-上傳檔案的類型 |
傳回
- response
- uploadImageResponse
取得使用者標籤
取得目標
取得貼文
按 ID 獲取特定帖子
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
帖子 ID.;這是貼文的唯一識別碼。 |
|
使用者識別碼
|
userId | integer |
正在查看帖子的用戶。 如果未指定 ID，則會使用已登入的使用者 |
傳回
貼文
- response
- postResponse
取得貼文標籤
取得除法
取得類別
將文件上傳至貼文
透過二進位上傳將文件上傳至貼文
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
檔案名稱
|
fileName | True | string |
文件的偏好檔案名稱 （附副檔名） |
|
ID
|
id | True | uuid |
貼文 ID |
|
檔案
|
File | True | binary |
要上傳的檔案 |
|
內容類型，例如 image/jpg、image/pjpeg、image/png、image/x-png、image/gif
|
Content-Type | True | string |
Content-上傳檔案的類型 |
傳回
與附件相關的資訊
- response
- documentInfoResponse
建立貼文
建立貼文。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Description
|
description | string |
帖子的簡短描述 |
|
|
標語
|
tagLine | string |
帖子的標語 |
|
|
Content
|
content | string |
帖子正文 |
|
|
創作者評論
|
creatorComments | string |
與貼文相關聯的訊息 |
|
|
永久連結
|
permaLink | string |
貼文所參考的外部URL |
|
|
啟用內部討論
|
internalDiscussionsEnabled | boolean |
是否允許成員在內部執行讚好動作和在貼文上新增評論 |
|
|
Title
|
title | True | string |
帖子的標題 |
|
會員影片網址
|
memberVideoUrl | string |
貼文引用的影片網址 |
|
|
職位類型
|
postType | string |
帖子的基本類型 |
|
|
核准狀態
|
approvalState | string |
貼文的核准狀態。 預設為作者的「審核狀態」設定。 |
|
|
顯示模式
|
displayMode | string |
指示將貼文重新導向至內部或外部位置 |
|
|
可共享
|
sharable | boolean |
VoiceStorm 平台和小部件是否允許分享帖子 |
|
|
開始日期
|
startDate | date-time |
貼文可供檢視的日期 |
|
|
結束日期
|
endDate | date-time |
該帖子將不再可供查看的日期 |
|
|
建議的分享文字
|
suggestedShareText | string |
貼文建議的共用文字 |
|
|
簡短的建議分享文字
|
shortSuggestedShareText | string |
簡訊提供者貼文的建議共用文字 |
|
|
分享積分
|
sharePoints | integer |
使用者分享貼文時獲得的積分 |
|
|
點擊點
|
clickPoints | integer |
當用戶點擊貼文的共享連結時獲得的積分 |
|
|
與圖像分享
|
shareWithImages | boolean |
控制分享至簡訊服務 （例如 Twitter） 的貼文是否共用影像 |
|
|
僅共享圖像
|
shareImagesOnly | boolean |
控制分享至特定服務的貼文是否被視為僅限圖片/相片更新 |
|
|
名稱
|
name | string |
標籤名稱 |
|
|
語言
|
language | string |
貼文內容的語言 |
|
|
Documents
|
documents | array of uuid |
要附加到這篇文章的文件 ID 列表 |
|
|
創作者 ID
|
creatorId | integer |
建立貼文的使用者;此屬性目前僅適用於伺服器鑑別的要求。 所有其他貼文都會自動設定為已驗證的使用者。 |
|
|
顯示創建器
|
displayCreator | boolean |
控制是否要與貼文一起顯示創作者資訊;此屬性目前僅適用於伺服器鑑別的要求。 |
|
|
類別 ID
|
categoryIds | array of integer |
已指派給貼文的類別識別碼清單 |
|
|
目標 ID
|
targetIds | array of integer |
已指派給貼文的目標識別碼清單 |
傳回
貼文
- response
- postResponse
更新貼文
編輯現有貼文。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
貼文 ID |
|
Title
|
title | string |
帖子的標題 |
|
|
Description
|
description | string |
帖子的簡短描述 |
|
|
標語
|
tagLine | string |
帖子的標語 |
|
|
Content
|
content | string |
帖子正文 |
|
|
創作者評論
|
creatorComments | string |
與貼文相關聯的訊息 |
|
|
永久連結
|
permaLink | string |
貼文所參考的外部URL |
|
|
啟用內部討論
|
internalDiscussionsEnabled | boolean |
是否允許成員在內部執行讚好動作和在貼文上新增評論 |
傳回
貼文
- response
- postResponse
管理貼文
允許伺服器驗證呼叫在單一請求中更新多個貼文的屬性
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
貼文 ID
|
postIds | True | array of uuid |
正在修改的帖子 |
|
Tags
|
tags | array of string |
可套用至貼文的標籤名稱集合 |
|
|
部門 ID
|
divisionIds | array of integer |
貼文所屬的部門ID |
|
|
類別 ID
|
categoryIds | array of integer |
貼文所屬的類別 ID |
|
|
目標 ID
|
targetIds | array of integer |
貼文所屬的目標ID |
|
|
核准狀態
|
approvalState | string |
貼文的核准狀態（不受DELETE要求影響） |
傳回
一個簡單的回應，表示該操作已成功執行
- response
- successResponse
透過 URL 將圖片新增至貼文
透過URL設定貼文圖片。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
貼文 ID，必要：true |
|
網址
|
url | True | string |
HTTP 或 HTTPS URL |
傳回
一個簡單的回應，表示該操作已成功執行
- response
- successResponse
透過上傳將圖像新增至貼文
透過二進位上傳設定貼文影像。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
ID
|
id | True | uuid |
貼文 ID |
|
檔案
|
File | True | binary |
要上傳的檔案 |
|
內容類型，例如 image/jpg、image/pjpeg、image/png、image/x-png、image/gif
|
Content-Type | True | string |
Content-上傳檔案的類型 |
傳回
一個簡單的回應，表示該操作已成功執行
- response
- successResponse
透過電子郵件取得使用者
依使用者的電子郵件地址擷取使用者
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Email
|
True | string |
使用者的電子郵件 |
|
|
Include
|
include | array of string |
指定要與使用者一起傳回的選擇性資料。 |
傳回
- response
- userRequestResponse
預先註冊使用者
建立處於預先註冊狀態的新使用者
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Email
|
string |
使用者的電子郵件地址 |
||
|
外部SSO使用者ID
|
externalSsoUserId | string |
SSO 身分識別提供者所管理的外部系統上的使用者 ID |
|
|
處理
|
handle | string |
使用者的句柄 |
|
|
名字
|
firstName | string |
使用者的名字。 |
|
|
姓氏
|
lastName | string |
使用者的姓氏。 |
|
|
部門 ID
|
divisionIds | array of integer |
將指派使用者的部門清單。 |
|
|
目標 ID
|
targetIds | array of integer |
要指派給使用者的目標清單。 |
|
|
名稱
|
name | string |
標籤或屬性名稱 |
|
|
價值觀
|
value | string |
選擇性值 |
|
|
發送邀請電子郵件
|
sendInvitationEmail | boolean |
決定是否要傳送邀請電子郵件給使用者。 |
|
|
邀請訊息
|
invitationMessage | string |
要包含在邀請電子郵件中的可選純文字訊息。 |
|
|
通知預設值
|
notificationsDefault | string |
控制使用者何時開始接收電子郵件通知的設定。 |
|
|
可以分享帖子
|
canSharePosts | boolean |
指出使用者是否有能力共用貼文 |
|
|
可以評論帖子
|
canCommentPosts | boolean |
指出使用者是否有權留言和按讚貼文 |
|
|
可以提交帖子
|
canSubmitPosts | boolean |
指出使用者是否有能力提交貼文 |
|
|
可以管理組織
|
canManageOrganization | boolean |
指出使用者是否有能力與社群內的直接和間接報告進行通訊 |
傳回
- response
- userRequestResponse
定義
success回應
一個簡單的回應，表示該操作已成功執行
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
code | string |
值 “success” 表示作業成功 |
targetDefinitionsInfoResponse
社群的目標定義及相關聯目標清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
definitions
|
definitions | array of targetDefinitionInfoResponse |
targetDefinitionInfo回應
特定目標定義及其相關聯目標的詳細資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
目標定義的 ID |
|
名稱
|
name | string |
目標定義的名稱 |
|
取得使用者確認
|
getUserConfirmation | boolean |
決定是否要求使用者確認/選取其偏好設定 |
|
允許多個選擇
|
allowMultipleSelections | boolean |
決定是否可以選取多個目標 |
|
需要選擇
|
selectionRequired | boolean |
決定是否需要此定義中的選取項目 |
|
目標選擇提示
|
targetSelectionPrompt | string |
提示使用者選擇其偏好的自訂標籤 |
|
child目標
|
childTargets | array of targetInfoResponse |
targetInfo回應
特定目標的詳細資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
目標標識碼 |
|
名稱
|
name | string |
目標的名稱 |
|
Description
|
description | string |
目標描述 |
|
定義 ID
|
definitionId | integer |
目標所屬目標定義的識別碼 |
|
父 ID
|
parentId | integer |
目標父系的 ID （如果有的話） |
|
已訂閱
|
isSubscribed | boolean |
使用者是否訂閱了特定目標 |
|
child目標
|
childTargets | array of targetInfoResponse1 |
managePostTags回應
系統中定義的貼文標籤清單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
tags
|
tags | array of managePostTagResponse |
managePostTag回應
特定貼文標籤的詳細資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
標籤ID |
|
名稱
|
name | string |
標籤名稱 |
|
可供會員使用
|
isAvailableToMembers | boolean |
判斷標籤是否可用於面向會員的貼文提交頁面 （如果已啟用） |
manageUserTags回應
系統中定義的使用者標籤清單
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
tags
|
tags | array of manageUserTagResponse |
manageUserTag回應
特定使用者標籤的詳細資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
標籤ID |
|
名稱
|
name | string |
標籤名稱 |
|
型別
|
type | string | |
|
accepted值
|
acceptedValues | array of string |
categories回應
與類別相關的詳細資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
categories
|
categories | array of categoryResponse | |
|
訂閱提示
|
subscriptionPrompt | string |
提示成員選取類別訂閱的標籤 |
|
啟用類別訂閱
|
enableCategorySubscription | boolean |
是否允許成員修改其類別訂閱 |
|
需要訂閱選擇
|
requireSubscriptionSelection | boolean |
成員在上線期間是否需要選取類別訂閱 |
|
著陸頁面預設類別
|
landingPageDefaultCategory | integer |
載入新聞摘要資訊時要顯示的預設內容 |
category回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
類別 ID |
|
名稱
|
name | string |
類別名稱 |
|
Description
|
description | string |
類別說明 |
|
顯示順序
|
displayOrder | integer |
顯示類別的順序 |
|
已釘選
|
isPinned | boolean |
類別是否已由管理員釘選 |
|
被迫
|
isForced | boolean |
已驗證的使用者是否強制訂閱給定類別 |
|
已訂閱
|
isSubscribed | boolean |
驗證使用者訂閱給定類別 |
|
隱藏
|
isHidden | boolean |
管理員是否隱藏類別 |
|
使用者是否可選取
|
isUserSelectable | boolean |
是否允許使用者為已提交的貼文選取類別 |
|
父類別 ID
|
parentCategoryId | integer |
父類別識別碼 |
|
兒童類別
|
childCategories | array of categoryResponse1 |
post回應
貼文
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
貼文編號
|
postId | uuid |
貼文 ID |
|
貼文來源 ID
|
postSourceId | integer |
來源 ID |
|
Title
|
title | string |
帖子的標題 |
|
Description
|
description | string |
帖子的簡短描述 |
|
標語
|
tagLine | string |
帖子的標語 |
|
Content
|
content | string |
帖子正文 |
|
原始內容
|
rawContent | string |
包含所有 HTML 的貼文內文 （當同時包含 Content 和 RawContent 時） |
|
創作者評論
|
creatorComments | string |
與貼文相關聯的訊息 |
|
|
creatorInfo | userOverviewResponse |
使用者的摘要資訊 |
|
地點
|
location | string |
與貼文相關的地理位置 |
|
屬性
|
properties | object |
帖子的雜項屬性。 並非適用於所有貼文類型 |
|
永久連結
|
permaLink | string |
貼文所參考的外部URL |
|
清理永久鏈接
|
cleanPermaLink | string |
永久連結（不包括有問題的空格和換行符） |
|
postType
|
postType | string | |
|
postSourceType
|
postSourceType | string | |
|
postByline類型
|
postBylineType | string | |
|
Provider
|
provider | string |
貼文來源的社交提供者（例如 Facebook、Twitter）。 |
|
approval狀態
|
approvalState | string | |
|
顯示模式
|
displayMode | string | |
|
狀態
|
status | string | |
|
使用者可編輯
|
userEditable | boolean | |
|
用戶可共享
|
userShareable | boolean |
指出目前使用者是否能夠共用貼文。 如果沒有目前的使用者，則預設為 true。 |
|
用戶可評論
|
userCommentable | boolean |
指出目前使用者是否能夠參與貼文上的討論。 如果沒有目前的使用者，則預設為 false。 |
|
可共享
|
sharable | boolean |
平台和小部件是否允許分享帖子 |
|
廣播
|
broadcasted | boolean |
該貼文是否已播送給用戶分享 |
|
已釘選
|
pinned | boolean |
帖子是否已設置為在流中優先顯示 |
|
發佈日期
|
publishDate | date-time |
對於用戶提交的內容，帖子提交日期;對於從外部來源匯入的內容，根據來源的發佈日期 |
|
開始日期
|
startDate | date-time |
貼文可供檢視的日期 |
|
結束日期
|
endDate | date-time |
該帖子將不再可供查看的日期 |
|
活動開始日期
|
eventStartDate | date-time |
活動開始日期（適用於活動類型貼文） |
|
活動結束日期
|
eventEndDate | date-time |
活動結束日期（適用於活動類型貼文） |
|
提供者時間戳記
|
providerTimeStamp | date-time |
從提供者的角度來看，貼文的日期，即最初發佈在社交提供者上的時間 |
|
已獲得的發佈積分
|
receivedPublishPoints | boolean |
投稿的用戶在貼文發布時是否獲得積分 |
|
建議的分享文字
|
suggestedShareText | string |
貼文建議的共用文字 |
|
簡短的建議分享文字
|
shortSuggestedShareText | string |
簡訊提供者貼文的建議共用文字 |
|
建議分享文字清單
|
suggestedShareTextList | array of string | |
|
short建議分享文字清單
|
shortSuggestedShareTextList | array of string | |
|
分享積分
|
sharePoints | integer |
使用者分享貼文時獲得的積分 |
|
點擊點
|
clickPoints | integer |
當用戶點擊貼文的共享連結時獲得的積分 |
|
提供者貼文 ID
|
providerPostId | string |
提供者網路上貼文的原始 ID |
|
網址 slug
|
urlSlug | string |
要放入帖子的公開鏈接中的 SEO 文本 |
|
Classification
|
classification | string |
提供者網路上的貼文類型。 |
|
與圖像分享
|
shareWithImages | boolean |
控制分享至簡訊服務 （例如 Twitter） 的貼文是否共用影像 |
|
僅共享圖像
|
shareImagesOnly | boolean |
控制分享至特定服務的貼文是否被視為僅限圖片/相片更新 |
|
行動
|
actions | string |
JSON Blob 包含貼文和 URL 的動作專案清單 |
|
提及
|
mentions | string |
提及 （使用者、雜湊標籤等） 儲存為 JSON Blob。 |
|
|
statistics | postStatisticsResponse | |
|
|
userShareInfo | postUserShareInfoResponse | |
|
|
author | postAuthorRequestResponse | |
|
links
|
links | array of postLinkRequestResponse | |
|
tags
|
tags | array of postTagRequestResponse | |
|
媒體
|
media | array of postMediaRequestResponse | |
|
images
|
images | object | |
|
候選圖片
|
candidateImages | array of postCandidateImageResponse | |
|
可見
|
visible | boolean |
貼文目前是否可見 |
|
share披露
|
shareDisclosures | array of postShareDisclosureResponse | |
|
shareComment規則
|
shareCommentRules | array of postShareCommentRulesResponse | |
|
語言
|
language | string |
貼文內容的語言 |
|
使用者隱藏
|
userHidden | boolean |
使用者是否已從一或多個串流中隱藏貼文 |
|
由使用者檢視
|
isViewedByUser | boolean |
該帖子是否已被當前用戶查看。 |
|
討論是否由用戶查看
|
isDiscussionViewedByUser | boolean |
目前使用者是否已檢視貼文討論串 |
|
被用戶喜歡
|
isLikedByUser | boolean |
該帖子是否被當前用戶內部按讚。 |
|
由用戶評論
|
isCommentedByUser | boolean |
該帖子是否已被當前用戶評論。 |
|
由使用者共用
|
isSharedByUser | boolean |
該帖子之前是否被當前用戶分享過 |
|
targets
|
targets | array of targetOverviewResponse | |
|
categories
|
categories | array of categoryOverviewResponse | |
|
當前時間
|
currentTime | date-time |
伺服器上的目前時間。 |
categoryOverview回應
基本類別資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
類別 ID |
|
名稱
|
name | string |
類別名稱 |
|
父類別 ID
|
parentCategoryId | integer |
父類別識別碼 |
targetOverview回應
輕量型目標回應，由目標名稱、ID 及其所屬目標定義的 ID 組成
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
目標名稱 |
|
ID
|
id | integer |
目標ID |
|
定義 ID
|
definitionId | integer |
目標所屬目標定義的識別碼 |
postShareCommentRulesResponse
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
提供者
|
provider | string | |
|
分享最大字元限制
|
shareMaxCharacterLimit | integer |
使用者在此提供者的共用中註解的長度上限。 |
postShareDisclosure回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
提供者
|
provider | string | |
|
提供者顯示名稱
|
providerDisplayName | string |
提供者顯示名稱 |
|
股份披露文字
|
shareDisclosureText | string |
每股所附之披露文字 |
postCandidateImage回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網址
|
url | string |
影像網址 |
|
寬度
|
width | integer |
圖像寬度 |
|
高度
|
height | integer |
圖像高度 |
|
默劇類型
|
mimeType | string |
影像 MIME 類型 |
|
ssl 網址
|
sslUrl | string |
影像安全 URL |
postMediaRequest回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
媒體物件的名稱 |
|
寬度
|
width | integer |
媒體物件的寬度 （以像素為單位） |
|
高度
|
height | integer |
媒體物件的高度 （以像素為單位） |
|
默劇類型
|
mimeType | string |
媒體物件的 MIME 類型 |
|
HTML
|
html | string |
可用來轉譯媒體物件的HTML |
|
網址
|
url | string |
媒體物件的 URL |
|
Origin
|
origin | string |
如果可用，則指定媒體物件的原始位置 |
|
Provider
|
provider | string |
社交提供者名稱 |
|
Role
|
role | string |
媒體類型 （如果已決定） |
|
持續時間
|
duration | integer |
視訊持續時間（以毫秒為單位） |
|
Description
|
description | string |
視訊格式說明 |
|
有視頻網址
|
hasVideoUrl | boolean |
表示此媒體具有必須使用「WatchVideo」 include 簽署的視訊 URL |
postTagRequest回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
名稱
|
name | string |
標籤名稱 |
postLinkRequest回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網址
|
url | string |
貼文網址 |
|
展開的網址
|
expandedUrl | string |
展開的 URL （如果存在） |
|
Title
|
title | string |
帖子標題 |
|
網域
|
domain | string |
連結網域 |
|
網站圖示網址
|
faviconUrl | string |
連結的網站圖示 URL |
|
名稱
|
name | string |
社交提供者指派的連結名稱 |
|
標題
|
caption | string |
連結的簡短標題（即連結下方的文字） |
|
Description
|
description | string |
連結的描述（即標題下方較長的文字） |
|
修改日期
|
modifiedDate | date-time | |
|
建立日期
|
createdDate | date-time |
postAuthorRequest回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
作者
|
author | string |
要顯示為作者的儲存文字。 |
|
個人資料圖片網址
|
profileImageUrl | string |
作者在社交網絡上的個人資料圖片 |
|
提供者使用者 ID
|
providerUserId | string |
社交網絡上的作者 ID |
|
提供者使用者名稱
|
providerUserName | string |
作者在社交網絡上的名字 |
|
個人資料網址
|
profileUrl | string |
作者在社交網絡上的個人資料 URL |
|
貼文來源名稱
|
postSourceName | string |
貼文來源的名稱。 |
|
發布源站點
|
postSourceSite | string |
貼文的來源網站 |
postUserShareInfo回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
獲得的積分
|
pointsEarned | integer |
用戶通過分享獲得的積分 |
|
份額計數
|
shareCount | integer |
使用者共用的次數 |
|
最近分享日期
|
mostRecentShareDate | date-time |
用戶最近分享這篇文章的日期 |
postStatistics回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
應用程式內分享總數
|
totalInAppShareCount | integer |
ShareCount 的同義詞 |
|
追蹤 ID
|
trackingId | string | |
|
份額計數
|
shareCount | integer |
在應用程式中起始且已驗證為成功共用的共用計數 |
|
反應計數
|
reactionCount | integer |
對分享的反應（按讚、轉發等）計數 |
|
曝光次數
|
impressionCount | integer |
分享者、朋友和追蹤者對貼文的潛在瀏覽量 |
|
檢視次數
|
viewedCount | integer |
已登入使用者造訪貼文的次數 |
|
點擊計數
|
clickCount | integer |
分享中貼文連結的點擊次數 |
|
點贊計數
|
likeCount | integer |
貼文內部按讚數 |
|
評論計數
|
commentCount | integer |
貼文的內部留言數 |
|
評論點贊數
|
commentLikeCount | integer |
貼文上所有內部評論的所有點讚數的總和 |
userOverview回應
使用者的摘要資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
使用者識別碼
|
userId | integer |
使用者的 ID |
|
顯示名稱
|
displayName | string |
使用者的顯示名稱 |
|
個人資料圖片圖片
|
profilePictureImages | object | |
|
處於活動狀態
|
isActive | boolean |
使用者是否仍是社群的活躍成員 |
uploadImage回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
影像識別碼
|
imageIdentifier | string |
上傳影像的識別碼 |
userRequest回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
使用者內部 ID |
|
Email
|
string |
使用者電子郵件地址 |
|
|
處理
|
handle | string |
使用者句柄 （「使用者名稱」） |
|
顯示名稱
|
displayName | string |
使用者偏好的顯示名稱 |
|
全名
|
fullName | string |
使用者的名字和姓氏 |
|
名字
|
firstName | string |
使用者名字 |
|
姓氏
|
lastName | string |
使用者姓氏 |
|
displayName格式
|
displayNameFormat | string | |
|
狀態
|
status | string | |
|
個人資料完成
|
profileCompleted | boolean |
使用者設定檔是否在上線期間完成 |
|
上次活動日期
|
lastActivityDate | date-time |
使用者上次與系統互動的時間。 |
|
Title
|
title | string |
使用者標題 |
|
地點
|
location | string |
用戶自我描述的位置（可能不是實際地理位置） |
|
外部 API 使用者 ID
|
externalApiUserId | string |
此 API 呼叫端所管理的外部系統上的使用者 ID |
|
管理員使用者 ID
|
managerUserId | integer |
使用者管理員的識別碼 （適用於組織階層功能） |
|
時區
|
timeZone | string |
使用者時區表示為 IANA 所設定的 tz 資料庫時區名稱。 範例：「美國/Los_Angeles」。 |
|
所選時區
|
selectedTimeZone | string |
使用者選取的時區表示為 IANA 所設定的 tz 資料庫時區名稱。 範例：「美國/Los_Angeles」。 |
|
積分餘額
|
pointBalance | integer |
迄今為止獲得的總積分 |
|
未兌換的積分
|
unredeemedPoints | integer |
目前可兌換的積分 |
|
兌換積分
|
redeemedPoints | integer |
用戶生命週期內兌換的積分數量 |
|
API資訊
|
apiInfo | string |
API 專屬屬性包 |
|
有密碼
|
hasPassword | boolean |
使用者是否有與帳戶相關聯的密碼。 |
|
必須更改密碼
|
mustChangePassword | boolean |
使用者是否必須根據社群設定變更密碼 |
|
帳戶是否經過驗證
|
isAccountVerified | boolean |
指出使用者是否已驗證其電子郵件地址 |
|
|
statistics | postStatisticsResponse | |
|
tags
|
tags | object | |
|
徽章
|
badges | object | |
|
隸屬關係
|
affiliations | array of userAffiliationResponse | |
|
部門
|
divisions | array of divisionResponse | |
|
通道
|
channels | array of userChannelResponse | |
|
個人資料圖片圖片
|
profilePictureImages | object | |
|
語言
|
languages | array of string | |
|
主要語言
|
primaryLanguage | string |
使用者主要介面語言 |
|
|
scheduleSettings | userScheduleSettingsResponse |
使用者排程的共用喜好設定 |
|
是 SSO
|
isSso | boolean |
使用者是否設定為使用 SSO 進行驗證 |
|
|
permissions | userPermissionsResponse |
管理員權限 |
|
|
privileges | userPrivilegesResponse |
使用者權限 |
|
識別碼
|
identifiers | array of allowlistIdentifiersResponse | |
|
targets
|
targets | array of targetOverviewResponse | |
|
|
defaults | userDefaultsRequestResponse |
使用者預設值的集合 |
|
歡迎橫幅被關閉
|
welcomeBannerDismissed | boolean |
使用者是否已關閉歡迎橫幅 |
userDefaultsRequestResponse
使用者預設值的集合
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
預設PostState
|
defaultPostState | string | |
|
預設PostApproval狀態
|
defaultPostApprovalState | string | |
|
預設貼文顯示內部討論
|
defaultPostShowInternalDiscussions | boolean |
建立貼文時，使用者預設的貼文內部討論狀態 |
|
預設後節目創作者資訊
|
defaultPostShowCreatorInfo | boolean |
用戶在創建帖子時關於顯示創作者姓名和照片的默認狀態 |
allowlistIdentifiers回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
允許清單定義ID |
|
價值觀
|
value | string |
指定允許清單定義的使用者回應 |
userPrivileges回應
使用者權限
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
可以提交帖子
|
canSubmitPosts | boolean |
指出使用者是否有權根據其權限和社群設定提交貼文 |
|
可以分享帖子
|
canSharePosts | boolean |
根據使用者的權限和社群設定，指出使用者是否有能力共用貼文 |
|
可以評論帖子
|
canCommentPosts | boolean |
指出使用者是否有權根據其權限和社群設定來留言和按讚貼文 |
|
可以管理社群
|
canManageCommunity | boolean |
根據使用者的權限和社群設定，指出使用者是否是社群內的管理員 |
|
可以管理組織
|
canManageOrganization | boolean |
指出使用者是否能夠根據其權限和社群設定，與社群內的直接和間接報告進行通訊 |
|
可以設置帖子可共享
|
canSetPostShareable | boolean |
使用者是否可以在提交貼文時設定「可分享」狀態 |
userPermissions回應
管理員權限
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
觀看廣播
|
viewBroadcast | boolean |
允許管理員查看廣播 |
|
列表廣播
|
listBroadcast | boolean |
允許管理員檢視廣播清單 |
|
編輯廣播
|
editBroadcast | boolean |
允許管理員建立和編輯廣播 |
|
查看廣播統計數據
|
viewBroadcastStats | boolean |
允許經理查看廣播統計數據 |
|
查看帖子
|
viewPost | boolean |
允許管理員查看帖子 |
|
列表帖子
|
listPost | boolean |
允許管理員檢視貼文清單 |
|
編輯帖子
|
editPost | boolean |
允許管理員建立和編輯貼文 |
|
查看帖子統計
|
viewPostStats | boolean |
允許管理員查看帖子統計數據 |
|
查看調查
|
viewSurvey | boolean |
允許管理員檢視問卷 |
|
名單調查
|
listSurvey | boolean |
允許管理員檢視調查清單 |
|
編輯問卷
|
editSurvey | boolean |
允許管理員建立和編輯問卷 |
|
社群設定
|
communitySettings | boolean |
允許管理員檢視和編輯社群設定 |
userScheduleSettings回應
使用者排程的共用喜好設定
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
日
|
days | string | |
|
倍
|
times | array of string |
userChannel回應
使用者通道。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
使用者頻道ID
|
userChannelId | integer |
內部使用者通道 ID |
|
使用者識別碼
|
userId | integer |
內部使用者 ID |
|
提供者
|
provider | string | |
|
名稱
|
name | string |
社交提供者上的使用者名稱 |
|
顯示名稱
|
displayName | string |
使用者會在社交提供者上顯示名稱 |
|
提供者使用者 ID
|
providerUserId | string |
提供者使用者 ID |
|
狀態
|
status | string | |
|
網址
|
url | string |
頻道的 URL |
|
朋友
|
friends | integer |
用戶在頻道上的好友數量 |
|
Followers
|
followers | integer |
用戶在頻道上擁有的關注者數量 |
|
Following
|
following | integer |
使用者在頻道上追蹤的人數 |
|
張貼
|
posts | integer |
使用者在頻道上發表的貼文數量。 |
|
瀏覽次數
|
views | integer |
使用者在頻道上的觀看次數 |
|
積分餘額
|
pointBalance | integer |
頻道上使用者的點數餘額 |
|
來源顯示名稱
|
sourceDisplayName | string |
使用者頻道作為內容來源時的顯示名稱 |
|
達到
|
reach | integer |
用戶在頻道上到達 |
|
可共享
|
sharable | boolean |
頻道是否支援共用 |
|
共用預設值
|
sharingDefault | boolean |
是否預先選取頻道進行共用 |
|
需要驗證
|
authRequired | boolean |
是否需要更新通道認證 |
|
|
statistics | postStatisticsResponse | |
|
個人資料圖片圖片
|
profilePictureImages | object |
division回應
劃分定義
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
部門識別碼
|
divisionId | integer |
部門識別碼 |
|
名稱
|
name | string |
部門名稱 |
|
父部門 ID
|
parentDivisionId | integer |
此部門父項的識別碼 |
userAffiliationResponse
使用者隸屬關係
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
|
question | affiliationQuestionResponse |
隸屬關係問題 |
|
|
answer | affiliationAnswerResponse |
隸屬關係答案 |
隸屬關係答案回應
隸屬關係答案
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
答案 ID
|
answerId | integer |
答案 ID |
|
回答
|
answer | string |
答案 |
|
Score
|
score | double |
分數 （如果提供） |
|
自由文本
|
freeText | string |
具有 FreeText 問題類型的問題的文字 |
|
拒絕回答
|
declineToAnswer | boolean |
如果設定，則此答案表示使用者拒絕回答問題。 |
|
Position
|
position | integer |
答案排序位置 |
隸屬關係問題回應
隸屬關係問題
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
問題識別碼
|
questionId | integer |
問題 ID |
|
名稱
|
name | string |
問題 |
|
分數位置
|
scorePosition | integer |
問題排序位置 |
|
Description
|
description | string |
問題描述 |
|
問題類型
|
questionType | string | |
|
為必填項目
|
required | boolean |
是否必須回答問題才能註冊 |
|
公開可見
|
isPubliclyVisible | boolean |
documentInfo回應
與附件相關的資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | uuid |
文件 ID |
|
檔案名稱
|
fileName | string |
文件檔名 （副檔名） |
|
Extension
|
extension | string |
文件文件擴展名 |
|
默劇類型
|
mimeType | string |
文件 MIME 類型 |
divisions回應
系統中定義的劃分
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
部門
|
divisions | array of divisionResponse | |
|
Prompt
|
prompt | string |
提示成員選取部門的標籤 |
|
顯示使用者部門選擇
|
showUserDivisionSelection | boolean |
註冊會員是否可以更改自己的部門 |
|
在上線期間顯示使用者部門選擇
|
showUserDivisionSelectionDuringOnboarding | boolean |
新會員在註冊時是否應選擇自己的部門 |
|
需要使用者部門選取
|
requireUserDivisionSelection | boolean |
成員是否必須選擇自己的部門。 |
|
允許多個分割
|
allowMultipleDivisions | boolean |
是否允許成員選擇多個或僅選擇一個部門 |
類別回應1
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
類別 ID |
|
名稱
|
name | string |
類別名稱 |
|
Description
|
description | string |
類別說明 |
|
顯示順序
|
displayOrder | integer |
顯示類別的順序 |
|
已釘選
|
isPinned | boolean |
類別是否已由管理員釘選 |
|
被迫
|
isForced | boolean |
已驗證的使用者是否強制訂閱給定類別 |
|
已訂閱
|
isSubscribed | boolean |
驗證使用者訂閱給定類別 |
|
隱藏
|
isHidden | boolean |
管理員是否隱藏類別 |
|
使用者是否可選取
|
isUserSelectable | boolean |
是否允許使用者為已提交的貼文選取類別 |
|
父類別 ID
|
parentCategoryId | integer |
父類別識別碼 |
targetInfo回應1
特定目標的詳細資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
目標標識碼 |
|
名稱
|
name | string |
目標的名稱 |
|
Description
|
description | string |
目標描述 |
|
定義 ID
|
definitionId | integer |
目標所屬目標定義的識別碼 |
|
父 ID
|
parentId | integer |
目標父系的 ID （如果有的話） |
|
已訂閱
|
isSubscribed | boolean |
使用者是否訂閱了特定目標 |
|
child目標
|
childTargets | array of targetInfoResponse2 |
targetInfo回應2
特定目標的詳細資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
目標標識碼 |
|
名稱
|
name | string |
目標的名稱 |
|
Description
|
description | string |
目標描述 |
|
定義 ID
|
definitionId | integer |
目標所屬目標定義的識別碼 |
|
父 ID
|
parentId | integer |
目標父系的 ID （如果有的話） |
|
已訂閱
|
isSubscribed | boolean |
使用者是否訂閱了特定目標 |
|
child目標
|
childTargets | array of targetInfoResponse3 |
targetInfo回應3
特定目標的詳細資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
目標標識碼 |
|
名稱
|
name | string |
目標的名稱 |
|
Description
|
description | string |
目標描述 |
|
定義 ID
|
definitionId | integer |
目標所屬目標定義的識別碼 |
|
父 ID
|
parentId | integer |
目標父系的 ID （如果有的話） |
|
已訂閱
|
isSubscribed | boolean |
使用者是否訂閱了特定目標 |