Plumsail 服務台

該 API 允許與 Plumsail HelpDesk 票務系統進行交互。訪問以 https://plumsail.com/docs/help-desk-o365/v1.x/API/ms-flow.html 獲取更多信息。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	標準	除下列區域外的所有 Power Automate 區域： - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
邏輯應用程式	標準	所有 Logic Apps 區域，但下列區域除外： - Azure 中國區域 - 美國國防部（DoD）
Power Apps	標準	除下列區域外的所有 Power Apps 區域： - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）
Power Automate（自動化服務）	標準	除下列區域外的所有 Power Automate 區域： - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部（DoD）

連絡人
名稱	梅帆
URL	https://plumsail.com/sharepoint-helpdesk
Email	support@plumsail.com

連接器中繼資料
Publisher	普拉姆賽爾公司
網站	https://plumsail.com
隱私策略	https://plumsail.com/privacy-policy/
類別	通敵;企業管理

此連接器可協助您在 Power Automate 的協助下操作技術支援台中的資料。

訪問以 https://plumsail.com/helpdesk 獲取更多信息。

先決條件

要開始使用它，您需要完成以下先決條件：

然後，建立 API 金鑰後，您就可以建立第一個流程了。

只需在 Flow 中搜索“Plumsail HelpDesk”並添加適當的操作：

HelpDesk 動作清單

當您第一次新增動作時，系統會要求您和 Connection Name for Access Key。您可以鍵入連線的任何名稱。例如： Plumsail HelpDesk 。

然後貼上第一步建立的API金鑰進行 Access Key 輸入。

建立流程連線

Power Automate （Microsoft Flow）動作

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	可共用

預設

適用：所有地區

建立連線的參數。

這是可共享的連接。如果 Power App 與其他使用者共用，也會共用連線。如需詳細資訊，請參閱畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件

名稱	類型	Description	為必填項目
API 金鑰	securestring	此 API 的 API 金鑰	對
資料中心區域	字串		對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

下載附件	依名稱傳回特定票證的附件檔，或傳回錯誤碼
依標題刪除組織	依標題刪除組織
依標題取得單一組織	依標題取得組織並傳回它。
依標題更新組織	依標題取得組織並更新它。傳回更新的組織。
刪除票證	依 ID 刪除票證。
刪除組織	依 ID 刪除組織。
刪除聯絡人	按 ID 刪除聯繫人
取得單一組織	依 ID 取得組織並傳回
取得單一評論	依 ID 取得註解並傳回。
取得票證的所有評論	取得具有指定 ID 之票證的所有註解。
取得組織	取得組織清單
取得聯絡人	取得連絡人清單
建立票證	建立新票證並傳回已建立的票證。
建立組織	在組織清單中建立新項目並傳回
建立聯絡人	建立新的連絡人並傳回它。
建立註解	為具有指定 ID 的票證建立新註解並傳回。
更新票證	透過 ID 取得票證並更新它。傳回更新的票證。
更新組織	依 Id 取得組織並傳回它。
更新聯絡人	按 ID 查找聯繫人並更新它。傳回更新的聯絡人。
獲取門票	傳回 TicketRead 物件的清單，每個 TicketRead 物件都有下列欄位：Category、Created、TicketID、Status、Requester 等。請檢查 TicketRead 物件定義以取得更多詳細資料
獲得一張票	透過 ID 取得票證並傳回票證
透過電子郵件更新聯絡人	透過電子郵件尋找聯絡人並更新它。傳回更新的聯絡人。
通過 ID 獲取單個聯繫人	通過 Id 獲取聯繫並回复它。
通過電子郵件獲取單個聯繫人	透過電子郵件取得連絡人並傳回。

下載附件

作業識別碼：: _flowV4TicketsByIdAttachmentsByFilenameGet

依名稱傳回特定票證的附件檔，或傳回錯誤碼

參數

名稱	機碼	必要	類型	Description
票證 ID	id	True	integer	票證 ID
附件檔名	filename	True	string	附件檔名

傳回

結果檔案: binary

依標題刪除組織

作業識別碼：: _flowV4OrganizationsByTitleByTitleDelete

依標題刪除組織

參數

名稱	機碼	必要	類型	Description
組織名稱	title	True	string	組織名稱

依標題取得單一組織

作業識別碼：: _flowV4OrganizationsByTitleByTitleGet

依標題取得組織並傳回它。

參數

名稱	機碼	必要	類型	Description
組織名稱	title	True	string	組織名稱
$select	$select		string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。
$expand	$expand		string	ODATA $expand查詢選項，可指定要求傳回查閱值。

傳回

身體: OrganizationRead

依標題更新組織

作業識別碼：: _flowV4OrganizationsByTitleByTitlePut

依標題取得組織並更新它。傳回更新的組織。

參數

名稱	機碼	必要	類型	Description
組織名稱	title	True	string	組織名稱
組織自訂欄位	customFields		object	包含自訂欄位值的 JSON 字串
組織名稱	title	True	string

傳回

身體: OrganizationRead

刪除票證

作業識別碼：: _flowV4TicketsByIdDelete

依 ID 刪除票證。

參數

名稱	機碼	必要	類型	Description
票證 ID	id	True	integer	票證 ID

刪除組織

作業識別碼：: _flowV4OrganizationsByIdDelete

依 ID 刪除組織。

參數

名稱	機碼	必要	類型	Description
組織識別碼	id	True	integer	組織識別碼

刪除聯絡人

作業識別碼：: _flowV4ContactsByIdDelete

按 ID 刪除聯繫人

參數

名稱	機碼	必要	類型	Description
聯絡人 ID	id	True	integer	聯絡人 ID

取得單一組織

作業識別碼：: _flowV4OrganizationsByIdGet

依 ID 取得組織並傳回

參數

名稱	機碼	必要	類型	Description
組織識別碼	id	True	integer	組織識別碼
$select	$select		string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。
$expand	$expand		string	ODATA $expand查詢選項，可指定要求傳回查閱值。

傳回

身體: OrganizationRead

取得單一評論

作業識別碼：: _flowV4TicketsByTicketIdCommentsByIdGet

依 ID 取得註解並傳回。

參數

名稱	機碼	必要	類型	Description
票證 ID	ticketId	True	integer	票證 ID
註解 ID	id	True	integer	註解 ID
$select	$select		string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。
$expand	$expand		string	ODATA $expand查詢選項，可指定要求傳回查閱值。

傳回

身體: CommentRead

取得票證的所有評論

作業識別碼：: _flowV4TicketsByTicketIdCommentsGet

取得具有指定 ID 之票證的所有註解。

參數

名稱	機碼	必要	類型	Description
票證 ID	ticketId	True	integer	票證 ID
$select	$select		string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。
$expand	$expand		string	ODATA $expand查詢選項，可指定要求傳回查閱值。
$過濾器	$filter		string	ODATA $filter查詢選項，以限制傳回的專案
$orderBy	$orderBy		string	ODATA $orderBy查詢選項，用於指定項目的順序。

傳回

response: array of CommentRead

取得組織

作業識別碼：: _flowV4OrganizationsGet

取得組織清單

參數

名稱	機碼	類型	Description
$select	$select	string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。
$expand	$expand	string	ODATA $expand查詢選項，可指定要求傳回查閱值。
$過濾器	$filter	string	ODATA $filter查詢選項，以限制傳回的專案
$orderBy	$orderBy	string	ODATA $orderBy查詢選項，用於指定項目的順序。
$top	$top	integer	ODATA $top查詢選項，用於選取傳回集的前 n 個項目以傳回（預設值 = 50，上限 = 100）。
$skiptoken	$skiptoken	string	ODATA $skiptoken查詢選項，可略過專案，直到到達指定的專案為止，並傳回其餘專案。

傳回

response: array of OrganizationRead

取得聯絡人

作業識別碼：: _flowV4ContactsGet

取得連絡人清單

參數

名稱	機碼	類型	Description
$select	$select	string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。使用 $select=PhoneNumber，Title，Email，ID 來包含電話號碼。
$expand	$expand	string	ODATA $expand查詢選項，可指定要求傳回查閱值。
$過濾器	$filter	string	使用 ODATA $filter選項來尋找所需的聯絡人。例如，使用 $filter=Title eq 'Bill Gates' 按全名查找人員。使用 $filter=substringof（'@DOMAIN'， Email）尋找來自網域（DOMAIN）的電子郵件人員
$orderBy	$orderBy	string	ODATA $orderBy查詢選項，用於指定項目的順序。
$top	$top	integer	ODATA $top查詢選項，用於選取傳回集的前 n 個項目以傳回（預設值 = 50，上限 = 100）。
$skiptoken	$skiptoken	string	ODATA $skiptoken查詢選項，可略過專案，直到到達指定的專案為止，並傳回其餘專案。

傳回

response: array of ContactRead

建立票證

作業識別碼：: _flowV4TicketsPost

建立新票證並傳回已建立的票證。

參數

名稱	機碼	必要	類型	Description
票證受指派人電子郵件或 SharePoint 群組名稱	assignedToEmail		string
附件內容	AttachmentContent	True	binary	檔案內容
附件檔名	Name	True	string
票本	body	True	string
票務類別	category		string
票證抄送電子郵件	ccEmails		array of string
票證自訂欄位	customFields		object	包含自訂欄位值的 JSON 字串
門票到期日	dueDate		date-time
門票優先權	priority		string
票證請求者電子郵件	requesterEmail	True	string
票務狀態	status		string
票務主題	subject	True	string
票務支持頻道	supportChannel		string
票證標籤標題	tagTitles		array of string

傳回

身體: TicketRead

建立組織

作業識別碼：: _flowV4OrganizationsPost

在組織清單中建立新項目並傳回

參數

名稱	機碼	必要	類型	Description
組織自訂欄位	customFields		object	包含自訂欄位值的 JSON 字串
組織名稱	title	True	string

傳回

身體: OrganizationRead

建立聯絡人

作業識別碼：: _flowV4ContactsPost

建立新的連絡人並傳回它。

參數

名稱	機碼	必要	類型	Description
聯絡人自訂欄位	customFields		object	包含自訂欄位值的 JSON 字串
聯絡電子郵件	email	True	string
聯絡人備用電子郵件	emailAlternate		string
聯絡人角色	role		string
聯繫 SPUserId	spUserId		integer
連絡人姓名	title	True	string
更新連絡人（如果存在）	updateIfExists		boolean	更新聯絡人（如果已存在）

傳回

身體: ContactRead

建立註解

作業識別碼：: _flowV4TicketsByTicketIdCommentsPost

為具有指定 ID 的票證建立新註解並傳回。

參數

名稱	機碼	必要	類型	Description
附件內容	AttachmentContent	True	binary	檔案內容
附件檔名	Name	True	string
註解內文	body	True	string
註解自訂欄位	customFields		object	包含自訂欄位值的 JSON 字串
評論作者電子郵件	fromEmail	True	string
註解 MessageId	messageId		string
票證 ID	ticketId	True	integer	票證 ID

傳回

身體: CommentRead

更新票證

作業識別碼：: _flowV4TicketsByIdPut

透過 ID 取得票證並更新它。傳回更新的票證。

參數

名稱	機碼	必要	類型	Description
票證 ID	id	True	integer	票證 ID
票證受指派人電子郵件或 SharePoint 群組名稱	assignedToEmail		string
附件內容	AttachmentContent	True	binary	檔案內容
附件檔名	Name	True	string
票本	body	True	string
票務類別	category		string
票證抄送電子郵件	ccEmails		array of string
票證自訂欄位	customFields		object	包含自訂欄位值的 JSON 字串
門票到期日	dueDate		date-time
門票優先權	priority		string
票證請求者電子郵件	requesterEmail	True	string
票務狀態	status		string
票務主題	subject	True	string
票務支持頻道	supportChannel		string
票證標籤標題	tagTitles		array of string

傳回

身體: TicketRead

更新組織

作業識別碼：: _flowV4OrganizationsByIdPut

依 Id 取得組織並傳回它。

參數

名稱	機碼	必要	類型	Description
組織識別碼	id	True	integer	組織識別碼
組織自訂欄位	customFields		object	包含自訂欄位值的 JSON 字串
組織名稱	title	True	string

傳回

身體: OrganizationRead

更新聯絡人

作業識別碼：: _flowV4ContactsByIdPut

按 ID 查找聯繫人並更新它。傳回更新的聯絡人。

參數

名稱	機碼	必要	類型	Description
聯絡人 ID	id	True	integer	聯絡人 ID
聯絡人自訂欄位	customFields		object	包含自訂欄位值的 JSON 字串
聯絡電子郵件	email	True	string
聯絡人備用電子郵件	emailAlternate		string
聯絡人角色	role		string
聯繫 SPUserId	spUserId		integer
連絡人姓名	title	True	string

傳回

身體: ContactRead

獲取門票

作業識別碼：: _flowV4TicketsGet

傳回 TicketRead 物件的清單，每個 TicketRead 物件都有下列欄位：Category、Created、TicketID、Status、Requester 等。請檢查 TicketRead 物件定義以取得更多詳細資料

參數

名稱	機碼	類型	Description
$select	$select	string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。
$expand	$expand	string	ODATA $expand查詢選項，可指定要求傳回查閱值。
$過濾器	$filter	string	ODATA $filter查詢選項。例如，使用 $filter=Status/Title eq STATUS 或 $filter=Status/Title ne STATUS（STATUS 可能是“待處理”、“新”、“進行中”、“已解決”等）獲取具有特定狀態的票證，或 $filter=Status/Title ne Solved 獲取活動票證，或 $filter=Created gt '2023-08-18' 獲取在特定日期之後創建的票證。使用 Category 欄位依類別篩選，使用 AssignedTo/Email 依受指派人電子郵件篩選，使用 AssignedTo/Title 依受指派人名稱篩選。使用 $filter=substringof（'@DOMAIN'， Requester/Email）來尋找來自網域（DOMAIN）的電子郵件人員。逾期門票僅是到期日期低於今天的有效門票。
$orderBy	$orderBy	string	ODATA $orderBy查詢選項，用於指定項目的順序。
$top	$top	integer	ODATA $top查詢選項，用於選取傳回集的前 n 個項目以傳回（預設值 = 50，上限 = 100）。
$skiptoken	$skiptoken	string	ODATA $skiptoken查詢選項，可略過專案，直到到達指定的專案為止，並傳回其餘專案。

傳回

response: array of TicketRead

獲得一張票

作業識別碼：: _flowV4TicketsByIdGet

透過 ID 取得票證並傳回票證

參數

名稱	機碼	必要	類型	Description
票證 ID	id	True	integer	票證 ID
$select	$select		string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。
$expand	$expand		string	ODATA $expand查詢選項，可指定要求傳回查閱值。

傳回

身體: TicketRead

透過電子郵件更新聯絡人

作業識別碼：: _flowV4ContactsByEmailByEmailPut

透過電子郵件尋找聯絡人並更新它。傳回更新的聯絡人。

參數

名稱	機碼	必要	類型	Description
聯絡電子郵件	email	True	string	連絡電子郵件
聯絡人自訂欄位	customFields		object	包含自訂欄位值的 JSON 字串
聯絡電子郵件	email	True	string
聯絡人備用電子郵件	emailAlternate		string
聯絡人角色	role		string
聯繫 SPUserId	spUserId		integer
連絡人姓名	title	True	string

傳回

身體: ContactRead

通過 ID 獲取單個聯繫人

作業識別碼：: _flowV4ContactsByIdGet

通過 Id 獲取聯繫並回复它。

參數

名稱	機碼	必要	類型	Description
聯絡人 ID	id	True	integer	聯絡人 ID
$select	$select		string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。
$expand	$expand		string	ODATA $expand查詢選項，可指定要求傳回查閱值。

傳回

身體: ContactRead

通過電子郵件獲取單個聯繫人

作業識別碼：: _flowV4ContactsByEmailByEmailGet

透過電子郵件取得連絡人並傳回。

參數

名稱	機碼	必要	類型	Description
聯絡電子郵件	email	True	string	聯絡電子郵件
$select	$select		string	ODATA $select查詢選項，可指定要針對清單項目傳回哪些欄位。您可以使用 * 傳回所有可用欄位。
$expand	$expand		string	ODATA $expand查詢選項，可指定要求傳回查閱值。

傳回

身體: ContactRead

定義

受讓人

名稱	路徑	類型	Description
受指派人自訂欄位	customFields	object	包含自訂欄位值的 JSON 字串
受指派人電子郵件	email	string
受指派人替代電子郵件	emailAlternate	string
受指派人 ID	id	integer
受指派人角色	role	string
受指派人 SPUserId	spUserId	integer
受讓人全名	title	string

副本

名稱	路徑	類型	Description
抄送自訂欄位	customFields	object	包含自訂欄位值的 JSON 字串
抄送電子郵件	email	string
抄送備用電子郵件	emailAlternate	string
抄送編號	id	integer
抄送角色	role	string
抄送 SPUserId	spUserId	integer
抄送全名	title	string

評論閱讀

名稱	路徑	類型	Description
註解內文	body	string
註解建立日期	created	date-time
註解自訂欄位	customFields	object	包含自訂欄位值的 JSON 字串
評論作者電子郵件	fromEmail	string
註解作者姓名	fromName	string
註解 ID	id	integer
註解 MessageId	messageId	string

聯絡閱讀

名稱	路徑	類型	Description
聯絡人自訂欄位	customFields	object	包含自訂欄位值的 JSON 字串
聯絡電子郵件	email	string
聯絡人備用電子郵件	emailAlternate	string
連絡人識別碼	id	integer
聯絡人角色	role	string
聯繫 SPUserId	spUserId	integer
聯絡人全名	title	string

組織閱讀

名稱	路徑	類型	Description
組織自訂欄位	customFields	object	包含自訂欄位值的 JSON 字串
組織識別碼	id	integer
組織名稱	title	string

請求者

名稱	路徑	類型	Description
要求者自訂欄位	customFields	object	包含自訂欄位值的 JSON 字串
請求者電子郵件	email	string
要求者備用電子郵件	emailAlternate	string
要求者識別碼	id	integer
請求者角色	role	string
要求者 SPUserId	spUserId	integer
請求者全名	title	string

標籤讀取

名稱	路徑	類型	Description
標籤自訂欄位	customFields	object	包含自訂欄位值的 JSON 字串
標籤 ID	id	integer
標籤標題	title	string

票讀

名稱	路徑	類型	Description
票證受讓人	assignedTo	Assignee
票證附件	attachments	array of string
票務類別	category	string
票務抄送	cc	array of Cc
票證建立日期	created	date-time
票證自訂欄位	customFields	object	包含自訂欄位值的 JSON 字串
門票到期日	dueDate	date-time
票證 ID	id	integer
門票優先權	priority	string
票證請求者	requester	Requester
票證解決日期	resolutionDate	date-time
票務狀態	status	string
票務主題	subject	string
票證標籤	tags	array of TagRead
自訂票證 ID	ticketID	string

二進位

這是基本數據類型『binary』。

共用方式為

Plumsail 服務台

先決條件

正在建立連線

預設

節流限制

動作

下載附件

參數

傳回

依標題刪除組織

參數

依標題取得單一組織

參數

傳回

依標題更新組織

參數

傳回

刪除票證

參數

刪除組織

參數

刪除聯絡人

參數

取得單一組織

參數

傳回

取得單一評論

參數

傳回

取得票證的所有評論

參數

傳回

取得組織

參數

傳回

取得聯絡人

參數

傳回

建立票證

參數

傳回

建立組織

參數

傳回

建立聯絡人

參數

傳回

建立註解

參數

傳回

更新票證

參數

傳回

更新組織

參數

傳回

更新聯絡人

參數

傳回

獲取門票

參數

傳回

獲得一張票

參數

傳回

透過電子郵件更新聯絡人

參數

傳回

通過 ID 獲取單個聯繫人

參數

傳回

通過電子郵件獲取單個聯繫人

參數

傳回

定義

受讓人

副本

評論閱讀

聯絡閱讀