SIGNL4 - 移動警報

SIGNL4 為營運關鍵基礎設施提供關鍵行動警報、事件回應和服務調度。它通過應用程序推送、短信和語音通話（包括跟踪、升級、協作和職責計劃）持續提醒您。

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

服務	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）

連絡人
名稱	德達克有限公司
URL	https://www.signl4.com/feedback-we-love-hear-from-you/
Email	success@signl4.com

連接器中繼資料
Publisher	德達克
網站	https://www.signl4.com
隱私策略	https://www.signl4.com/privacy-policy/
類別	IT運營;傳達

SIGNL4 為營運關鍵基礎設施提供關鍵警報、事件回應和服務調度。它通過應用程序推送、短信和語音通話（包括跟踪、升級、協作和職責計劃）持續提醒您。

您可以將 SIGNL4 整合到您的流程中，以便在需要時發送可靠的團隊警報。

先決條件

您需要一個 SIGNL4 帳戶。如果您還沒有，您可以在以下位置 https://connect.signl4.com/獲得一個。您也可以直接從 Google Play 商店或 Apple App Store 下載行動應用程式。

如何取得認證

若要使用連接器，您需要 SIGNL4 API 金鑰。在 SIGNL4 入口網站中，您可以在整合 -> API 金鑰下取得 API 金鑰。然後，您可以使用 API 金鑰在 Power Automate 中驗證您的 SIGNL4 連接器。

開始使用連接器

您可以在此處找到 SIGNL4 API 函數的詳細說明。將 SIGNL4 連接器新增至 Power Automate 流程之後，您必須取得 SIGNL4 API 金鑰。然後，您可以相應地使用 API 函數。如果您有任何其他問題，請隨時聯繫 SIGNL4 團隊。

最簡單的啟動方式是使用 EventsSend 動作來傳送警示：

首先，從您的 SIGNL4 入口網站取得您的 SIGNL4 團隊秘密/整合秘密。
當您擁有團隊密碼/整合密碼時，您可以在函數 EventsSend 中使用此密碼來觸發可為您的團隊產生警示的事件。您只需輸入任何標題和消息。您可以在傳入Webhook文件頁面上找到其他引數的說明。
就是這樣，您現在觸發事件並在 SIGNL4 中收到警報。

已知問題與限制

Power Automate 的 SIGNL4 連接器封裝了整個 SIGNL4 REST API 2.0。某些功能取決於您的 SIGNL4 計劃。

常見錯誤和補救措施

N/A

FAQ

您可以在此處找到 SIGNL4 常見問題解答和線上說明。此外，還有一個全面的視頻庫可用。

正在建立連線

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


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

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
API 金鑰	securestring	此 API 的 API 金鑰	對

節流限制

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

動作

下載具有特定檔案名稱的值班報告	下載具有特定檔案名稱的值班報告。
依 ID 取得 Webhook	傳回傳遞識別碼所指定的 Webhook 資訊。
依使用者 ID 取得值班狀態	傳回具有職責資訊的物件。
依其識別碼傳回清查指令碼	取得傳遞的指令碼識別碼所指定的指令碼。
依識別碼刪除 Webhook	刪除指定的 Webhook，使其不再收到通知。
依識別碼取得事件來源	依識別碼取得事件來源。
依識別碼取得使用者	傳回使用者物件，其中包含其電子郵件地址和職責資訊等詳細資訊。
依識別碼更新 Webhook	更新指定的 Webhook。
停用 webHook 的能力	停用 webHook 的能力。
停用指定的指令碼執行個體	停用指定的指令碼執行個體。
傳回 SIGNL4 小組的所有指令碼實例	傳回訂閱中的所有指令碼執行個體。
傳回具有指定 ID 的值班表資訊	傳回具有指定 ID 的值班表資訊。
傳回從「異動日誌」分頁的遠端工作	範例要求： `POST /remoteActions/journal/paged?maxResults=100 { "statusCode": "Executed" }`
傳回所有可用的庫存指令碼	傳回所有可新增至 SIGNL4 訂閱的可用庫存指令碼。
傳回所有庫存指令碼	傳回所有庫存指令碼。
傳回所有計劃排程的相關資訊	傳回所有計劃排程的相關資訊。
傳回指定指令碼執行個體的所有相關資訊	取得傳遞的實例識別碼所指定的指令碼實例。
傳回指定訂用帳戶的功能	傳回指定訂用帳戶的功能。
傳回訂閱的頻道價格資訊	傳回訂閱的頻道價格資訊。
傳回遠端動作	範例要求： `GET /RemoteActions/{actionId}`
傳回遠端動作	範例要求： `GET /RemoteActions?externalId=12345`
傳送事件	傳送事件。
儲存多個排程	保存多個時間表。如果您願意，可以覆蓋現有的時間表。
刪除事件來源	刪除事件來源。
刪除事件發佈	刪除事件散發。
刪除使用者帳戶	刪除使用者帳戶。
刪除使用者的連絡人地址	刪除使用者的連絡人地址。
刪除使用者的電話號碼	刪除使用者的電話號碼。
刪除個人使用者映像	刪除個人使用者映像檔。
刪除假日	刪除假日。
刪除指令碼執行個體	取得傳遞的實例識別碼所指定的指令碼實例。
刪除特定職責	刪除特定職責。
刪除特定警示模式	刪除特定的警示模式。
刪除現有類別	範例要求： `DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e`
刪除目前的團隊形象	刪除目前的團隊影像。
刪除範圍內的值班表	刪除範圍內的值班表。
刪除遠端動作	範例要求： `DELETE /eaRemoteActions/{actionId}`
創建或更新給定的值班表	創建/更新給定的值班表。
取得 Webhook	傳回系統中已定義的輸出 Webhook 集合。
取得事件參數	依 ID 取得事件的參數。
取得使用者所屬的所有小組	傳回小組物件的清單，其中包含其名稱等詳細資料。只會傳回使用者所屬的小組。
取得使用者的通知設定檔	獲取用戶的通知配置文件。
取得個人使用者影像	獲取個人用戶形象。
取得分頁的概觀事件	取得概觀事件分頁。如果有更多結果，您也會取得一個延續權杖，您可以將其新增至事件篩選器。
取得可下載警示報告的相關資訊	取得可下載警示報告的相關資訊。
取得多個小組的小組職責設定	取得多個團隊的團隊職責設定。
取得小組的小組隱私權設定	取得小組的小組隱私權設定。
取得所有使用者	傳回使用者物件清單，其中包含其電子郵件地址和職責資訊等詳細資訊。只有您有權存取的使用者才會傳回。
取得所有可用和受管理訂閱的資訊	取得所有可用/受管理訂閱的資訊。
取得所有警示類別影像的名稱	取得所有警示類別影像的名稱。您可以通過轉到 account.signl4.com/images/alerts/categoryImageName.svg 來獲取圖像。
取得所有類別的指標	範例要求： `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics`
取得指定小組的影像	取得指定小組的影像。
取得指定小組的所有使用者	取得指定小組的所有使用者。
取得指定警示的指定附件	取得指定警示的指定附件。
取得概觀事件	依 ID 取得概觀事件。
取得活動的詳細資料	取得活動的詳細資料。
取得特定使用者的設定進度	取得特定使用者的設定進度。
取得特定小組的事件來源	取得特定小組的事件來源。
取得特定小組的設定進度	取得特定小組的設定進度。
取得特定小組的警示設定	取得特定小組的警示設定。
取得特定小組的警示設定	取得特定小組的警示設定。
取得特定訂閱的資訊	取得特定訂用帳戶的資訊。
取得特定類別	範例要求： `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e`
取得特定類別的指標	範例要求： `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics`
取得訂用帳戶中所有小組的公開資訊	取得訂用帳戶中所有小組的公開資訊。
取得訂用帳戶所有小組的資訊	取得訂用帳戶所有小組的資訊。
取得訂用帳戶的使用者授權	取得訂用帳戶的使用者授權。
取得訂閱的所有圖說文字範本	取得訂閱的所有圖說範本。
取得訂閱的目前預付設定	取得訂閱的目前預付費設定。
取得訂閱的目前預付費設定	取得訂閱的目前預付費設定。
取得訂閱的目前預付餘額	取得訂閱的目前預付餘額。
取得訂閱的目前預付餘額	取得訂閱的當前預付餘額。
取得訂閱的語音號碼授權	取得訂閱的語音號碼授權。
取得訂閱的預付交易	取得訂閱的預付交易。
取得訂閱的預付交易	取得訂閱的預付費交易。
取得警示	透過 ID 取得警示。
取得警示分頁	取得警示分頁。
取得警示報告	傳回不同時段內發生的警示量的相關資訊，以及團隊成員回應行為（已確認和未處理警示的數量）的相關資訊。
取得警示時間表項目	依 ID 取得警示的警示時間表專案。
取得警示的詳細資料	取得警示的詳細資料。
取得警示的附件資訊	通過 ID 獲取警報的附件。
取得警示通知	通過警報 ID 獲取所有用戶的通知。
取得類別訂閱	範例要求： `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions { }`
啟用 webHook 的能力	能夠啟用 webHook。
啟用指令碼執行個體	啟用指令碼執行個體。
在 SIGNL4 小組中的中建立新的 Script 實例	建立要求內文中指定的指令碼的新指令碼實例。
多個通知的佇列復原	此方法會嘗試透過佇列復原多個警示的確認。作業會在背景處理。
如果邀請存在，則再次傳送邀請電子郵件	如果存在邀請，則再次傳送邀請電子郵件。
將使用者新增至小組	將使用者新增至小組。
將假期從一個團隊複製到另一個團隊	將假期從一個團隊複製到另一個團隊。
將用戶打卡為管理員	指定的用戶將被打卡到經理的職責中。
將郵件傳送給指定的使用者	傳送郵件給指定的使用者，其中包含使用者團隊所有事件來源的資訊。
已上傳指定使用者的設定檔影像	已上傳指定使用者的設定檔影像。
已上傳指定團隊的個人資料圖片	已上傳指定團隊的設定檔影像。
建立 Webhook	建立新的輸出 Webhook，當某些事件發生時，該 Webhook 會收到通知。
建立事件來源	建立事件來源。
建立新的警示模式	建立新的警示模式。
建立新的遠端動作	範例要求： `POST /remoteActions { "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7", "name": "MyAction", "enabled": true, }`
建立新的遠端工作	範例要求： `POST /remoteActions/{actionId}/jobs { "remoteActionPin" : "1234", "parameters": [ { "name": "Param1", "value": "Value 1" } ] }`
建立新類別	範例要求： `POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7 { "name": "Water", "imageName": "water.svg", "color": "#0000cc", "keywordMatching": "Any", "keywords": [ { "value": "H2O" }, { "value": "Water" } ] }`
從一或多個小組取得事件來源	從一或多個小組取得事件來源。
從使用者取得小組成員資格	從使用者取得小組成員資格。
從團隊中移除使用者或邀請	從團隊中移除使用者或邀請。
從團隊獲取所有警報模式	從團隊獲取所有警報模式。
從異動日誌傳回遠端工作	範例要求： `GET /remoteActions/journal/{jobId}`
從訂用帳戶中刪除現有的圖說文字範本	從您的訂閱中刪除現有的圖說文字範本。
復原警示的確認	這個方法會嘗試復原警示通知。
復原警示的關閉	這個方法會嘗試復原警示關閉。
手動將警示呈報給小組	手動將警示呈報給團隊。
打卡用戶	指定的用戶將被打卡上崗。
打孔用戶	指定的用戶將被打退班。
按團隊獲取團隊成員資格	按團隊獲取團隊成員資格。
撤回多個警示的關閉	此方法會嘗試復原多個警示關閉。作業會在背景處理。
擷取定義	擷取定義。
擷取所有可用的定義	擷取所有可用的定義。
更新事件來源	更新事件來源。
更新使用者的使用者設定檔	更新使用者的使用者設定檔。
更新使用者的地區設定資訊（例如語言、時區）	更新使用者的地區設定資訊（例如語言、時區）。
更新使用者的密碼	更新使用者的密碼。
更新使用者的小組成員資格	更新使用者的小組成員資格。您可以將使用者移至訂閱內的另一個小組，和/或變更使用者的角色。
更新團隊的團隊設定檔	更新團隊的團隊設定檔。
更新團隊的隱私權設定	更新團隊的隱私設定。
更新指定指令碼執行個體的自訂資料，包括其顯示名稱	更新指定的指令碼執行個體。
更新指定的指令碼執行個體	更新指定的指令碼實例，通常用於更新指令碼的組態。
更新現有的警示模式	更新現有的警示模式。
更新現有類別	範例要求： `PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e { "name": "Water-Updated", "imageName": "water.svg", "color": "#0000cc", "keywordMatching": "All", "keywords": [ { "value": "H2O" }, { "value": "Water" }, { "value": "Wet" } ] }`
更新訂閱的現有圖說文字範本	更新訂閱的現有圖說文字範本。
更新訂閱的當前預付費設置	更新訂閱的當前預付費設置。
更新訂閱的目前預付費設定	更新訂閱的當前預付費設置。
更新訂閱設定檔	更新訂閱設定檔。
更新遠端動作	範例要求： `PUT /remoteActions/{actionId} { "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7", "name": "MyAction", "enabled": true, }`
檢查使用者是否具有提供的權限	檢查使用者是否具有提供的權限。
為使用者設定通知設定檔	為用戶設置通知配置文件。
為團隊保存假期	為團隊節省假期。
為團隊保存重複假期	為團隊節省重複的假期。
為團隊提供假期	為團隊安排假期。
為您的訂閱建立新的圖說文字範本	為您的訂閱建立新的圖說文字範本。
獲取團隊的值班助理信息	獲取團隊的值班助理信息。
獲取所有團隊的信息	獲取所有團隊的信息。
獲取所有類別	獲取所有類別。
獲取所有類別	範例要求： `GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7`
獲取特定團隊的信息	獲取特定團隊的信息。
確認多個警示	此方法會確認提供的所有警示。
確認所有可見的警報	此方法會確認特定使用者目前團隊擁有的所有未處理警示。
確認警示	確認警示。
觸發警報	為您的團隊觸發新警報。所有值班團隊成員都會收到警報通知。
設定使用者的位置	設定使用者的位置。
設定使用者的電話號碼	設定使用者的電話號碼。如果儲存了另一個電話號碼，它將被覆蓋。
設定特定小組的警示設定	設定特定團隊的警示設定。
設定類別訂閱	範例要求： `POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions { }`
註釋警報	通過給定的註釋信息註釋警報。
退貨警示報告	傳回警示報告。
邀請使用者加入團隊	邀請使用者加入團隊。
關閉多個警示	此方法會關閉提供的所有警示。
關閉所有已確認的警示	此方法會關閉您的團隊目前擁有的所有已確認警示。
關閉警示	關閉警示。
驗證先前為使用者建立的電話號碼	驗證先前為使用者建立的電話號碼。
驗證型樣的時間段	根據其他型樣的所有現有時隙驗證型樣的時隙。

下載具有特定檔案名稱的值班報告

作業識別碼：: TeamsGetDutyReport

下載具有特定檔案名稱的值班報告。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要下載值班報告的團隊 ID。
檔案名稱	fileName	True	string	要下載的 csv 檔案名稱。

傳回

response: binary

依 ID 取得 Webhook

作業識別碼：: WebhooksGet

傳回傳遞識別碼所指定的 Webhook 資訊。

參數

名稱	機碼	必要	類型	Description
輸出 Webhook ID	webhookId	True	string	要擷取的輸出 Webhook 標識碼。

傳回

身體: WebhookInfo

依使用者 ID 取得值班狀態

作業識別碼：: UsersGetDutyStatus

傳回具有職責資訊的物件。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	要取得的使用者識別碼。使用「我」來取得目前登入使用者的相關資訊。使用 API 金鑰無法做到這一點。也可以是團隊中使用者的電子郵件地址，或根據使用者物件的唯一識別碼。」
團隊識別碼	teamId		array	團隊編號。

傳回

身體: MultiTeamResult-2-UserDutyInfo-V2.DutyError-

依其識別碼傳回清查指令碼

作業識別碼：: ScriptsGet

取得傳遞的指令碼識別碼所指定的指令碼。

參數

名稱	機碼	必要	類型	Description
指令碼ID	scriptId	True	string	要傳回的指令碼 ID。
語言	language		string	語言

傳回

身體: ScriptInstanceDetails

依識別碼刪除 Webhook

作業識別碼：: WebhooksDelete

刪除指定的 Webhook，使其不再收到通知。

參數

名稱	機碼	必要	類型	Description
輸出 Webhook ID	webhookId	True	string	將刪除之輸出 Webhook 的識別碼。

依識別碼取得事件來源

作業識別碼：: EventSourcesGetById

依識別碼取得事件來源。

參數

名稱	機碼	必要	類型	Description
事件來源識別碼	eventSourceId	True	string	事件來源的識別碼。
語言	language		integer	0 = 英文 1 = 德國

名稱

機碼

必要

類型

Description

事件來源識別碼

eventSourceId

True

string

事件來源的識別碼。

語言

language

integer

0 = 英文
1 = 德國

傳回

身體: EventSourceEndpointInfo

依識別碼取得使用者

作業識別碼：: UsersGet

傳回使用者物件，其中包含其電子郵件地址和職責資訊等詳細資訊。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	要取得的使用者識別碼。使用「我」來取得目前登入使用者的相關資訊。使用 API 金鑰無法做到這一點。也可以是團隊中使用者的電子郵件地址，或根據使用者物件的唯一識別碼。」

傳回

身體: V2.UserDetails

依識別碼更新 Webhook

作業識別碼：: WebhooksUpdate

更新指定的 Webhook。

參數

名稱	機碼	必要	類型	Description
輸出 Webhook ID	webhookId	True	string	要更新之輸出 Webhook 的識別碼。
描述	description		string
ext網址	extUrl	True	string
名稱	name	True	string
團隊識別碼	teamId		string

傳回

身體: WebhookInfo

停用 webHook 的能力

作業識別碼：: WebhooksEnable

停用 webHook 的能力。

參數

名稱	機碼	必要	類型	Description
Webhook ID	webhookId	True	string	Webhook 識別碼（Webhook ID）應啟用。

傳回

身體: WebhookInfo

停用指定的指令碼執行個體

作業識別碼：: ScriptsDisable

停用指定的指令碼執行個體。

參數

名稱	機碼	必要	類型	Description
指令碼執行個體識別碼	instanceId	True	string	要停用之執行個體的 ID。

傳回

身體: ScriptInstanceDetails

傳回 SIGNL4 小組的所有指令碼實例

作業識別碼：: ScriptsGetAll

傳回訂閱中的所有指令碼執行個體。

參數

名稱	機碼	必要	類型	Description
團隊 ID	teamId		array	團隊 ID。
修改時間	modifiedSince		date-time	修改後。

傳回

response: array of ScriptInstanceInfo

傳回具有指定 ID 的值班表資訊

作業識別碼：: DutiesGetInfo

傳回具有指定 ID 的值班表資訊。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	職責所屬小組的 Id
值班表 ID	scheduleId	True	string	所要求值班表的 ID。

傳回

身體: ScheduleInfo

傳回從「異動日誌」分頁的遠端工作

作業識別碼：: RemoteActionsGetJobsPaged

範例要求：

POST /remoteActions/journal/paged?maxResults=100
{
    "statusCode": "Executed"
}

參數

名稱	機碼	類型	Description
最大結果	maxResults	integer	最大結果
語言	language	integer	0 = 英文 1 = 德國
actionId	actionId	string
continuationToken	continuationToken	string
最大建立日期	maxCreationDate	date-time
minCreationDate	minCreationDate	date-time
修改自	modifiedSince	date-time
statusCodes	statusCodes	integer	0 = 無 1 = 擱置中 2 = 就緒 4 = 跑步 8 = 已執行 16 = 錯誤

傳回

身體: PagedResultsPublic-1-V2.RemoteJob-

傳回所有可用的庫存指令碼

作業識別碼：: ScriptsGetAvailable

傳回所有可新增至 SIGNL4 訂閱的可用庫存指令碼。

傳回

response: array of InventoryScriptInfo

傳回所有庫存指令碼

作業識別碼：: ScriptsGetAll76

傳回所有庫存指令碼。

參數

名稱	機碼	必要	類型	Description
語言	language		string	語言

傳回

response: array of InventoryScriptInfo

傳回所有計劃排程的相關資訊

作業識別碼：: SchedulesGetPlanned

傳回所有計劃排程的相關資訊。

參數

名稱	機碼	類型
limit	limit	integer
最小日期	minDate	date-time
團隊標識碼	teamIds	array of string
userId	userId	string

傳回

response: array of V2.ScheduleDetails

傳回指定指令碼執行個體的所有相關資訊

作業識別碼：: ScriptsGetInfo

取得傳遞的實例識別碼所指定的指令碼實例。

參數

名稱	機碼	必要	類型	Description
指令碼執行個體識別碼	instanceId	True	string	要傳回的指令碼執行個體的執行個體識別碼。

傳回

身體: ScriptInstanceDetails

傳回指定訂用帳戶的功能

作業識別碼：: SubscriptionsGetFeatures

傳回指定訂用帳戶的功能。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	需要從中擷取功能的訂用帳戶識別碼。

傳回

response: array of SubscriptionFeature

傳回訂閱的頻道價格資訊

作業識別碼：: SubscriptionsGetChannelPriceInfo

傳回訂閱的頻道價格資訊。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	需要擷取之訂用帳戶的識別碼。

傳回

身體: ChannelPriceInfo

傳回遠端動作

作業識別碼：: RemoteActionsGet

範例要求：

GET /RemoteActions/{actionId}

參數

名稱	機碼	必要	類型	Description
作ID	actionId	True	string	要傳回的動作識別碼
語言	language		integer	0 = 英文 1 = 德國

名稱

機碼

必要

類型

Description

作ID

actionId

True

string

要傳回的動作識別碼

語言

language

integer

0 = 英文
1 = 德國

傳回

身體: V2.RemoteActionDetails

傳回遠端動作

作業識別碼：: RemoteActionsGetActions

範例要求：

GET /RemoteActions?externalId=12345

參數

名稱	機碼	類型	Description
團隊識別碼	teamId	string	團隊識別碼
外部 ID	externalId	string	外部 ID 的選用篩選器
類型	type	integer	0 = 未知 1 = 腳本 2 = 企業警示 3 = Webhook
執行者服務	executorService	string	執行者服務
語言	language	integer	0 = 英文 1 = 德國

傳回

response: array of V2.RemoteActionInfo

傳送事件

作業識別碼：: EventsSend

傳送事件。

參數

名稱	機碼	必要	類型	Description
團隊秘密	teamSecret	True	string	團隊秘密。
Title	Title	True	string
Message	Message	True	string
X-S4-Service	X-S4-Service		string	X-S4-Service：：將 Signl 指派給具有指定名稱的服務/系統類別。
X-S4-Location	X-S4-Location		string	X-S4-位置：與您的活動一起傳輸位置信息（緯度、經度）並在移動應用程序中顯示地圖。
X-S4-AlertingScenario	X-S4-AlertingScenario		string	X-S4-AlertingScenario：如果此事件觸發 Signl，則允許控制 SIGNL4 通知團隊的方式。支援的值為：single_ack、multi_ack、緊急。
X-S4-ExternalID	X-S4-ExternalID		string	X-S4-ExternalID：如果事件源自第三方系統中的記錄，請使用此參數來傳遞該記錄的唯一 ID。該 ID 將在來自 SIGNL4 的出站 Webhook 通知中傳達，這對於將該記錄與 Signl 關聯/同步非常有用。
X-S4-Status	X-S4-Status		string	X-S4-Status：如果您想要透過外部 ID （X-S4-ExternalID來解析現有的 Signl，您可以新增此狀態參數。它有三個可能的值：new、acknowledged、resolved。
X-S4-Filtering	X-S4-Filtering		boolean	X-S4-篩選：指定布林值 true 或 false，以套用此事件的事件篩選。如果設定為 true，則只有當事件包含來自其中一個服務和系統類別的關鍵字（即已列入白名單）時，事件才會觸發通知給團隊。
外部 ID 參數	ExtIdParam		string	外部 ID 參數。
外部狀態參數	ExtStatusParam		string	外部狀態參數。
新狀態	NewStatus		string	新狀態。
已解析狀態參數	ResolvedStatus		string	已解決狀態參數。
Ack 狀態	AckStatus		string	確認狀態。

傳回

身體: OverviewEvent

儲存多個排程

作業識別碼：: DutiesSaveMultiple

保存多個時間表。如果您願意，可以覆蓋現有的時間表。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	要設定的團隊 ID
覆寫	overrideExisting		boolean	如果設定為 true，則覆寫或剪切現有排程。
結束	end		date-time
識別碼	id		string
options	options		integer
start	start		date-time
userId	userId		string

傳回

response: array of ScheduleInfo

刪除事件來源

作業識別碼：: EventSourcesDelete

刪除事件來源。

參數

名稱	機碼	必要	類型	Description
事件來源識別碼	eventSourceId	True	string	事件來源的識別碼

刪除事件發佈

作業識別碼：: EventDistributionDelete

刪除事件散發。

參數

名稱	機碼	必要	類型	Description
事件來源識別碼	distributionId	True	string	事件來源的識別碼

刪除使用者帳戶

作業識別碼：: UsersDelete

刪除使用者帳戶。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	要刪除的使用者 ID。

刪除使用者的連絡人地址

作業識別碼：: UsersDeleteContactAddress

刪除使用者的連絡人地址。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	要從中刪除地址的用戶 ID
地址 ID	addressId	True	string	聯絡地址的 ID

刪除使用者的電話號碼

作業識別碼：: UsersDeletePhoneNumber

刪除使用者的電話號碼。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	使用者 ID

刪除個人使用者映像

作業識別碼：: UsersDeleteImage

刪除個人使用者映像檔。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	使用者 ID 或我

刪除假日

作業識別碼：: TeamsDeleteHolidays

刪除假日。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要從中刪除假日的團隊 ID
天	day		integer
個月	month		integer	0 = 未設定 1 = 一月 2 = 二月 3 = 三月 4 = 四月 5 = 五月 6 = 六月 7 = 七月 8 = 八月 9 = 九月 10 = 十月 11 = 十一月 12 = 十二月
年	year		integer

刪除指令碼執行個體

作業識別碼：: ScriptsDelete

取得傳遞的實例識別碼所指定的指令碼實例。

參數

名稱	機碼	必要	類型	Description
指令碼執行個體識別碼	instanceId	True	string	要傳回的指令碼執行個體的執行個體識別碼。

刪除特定職責

作業識別碼：: DutiesDelete

刪除特定職責。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	職責所屬團隊的 ID。
值班表 ID	dutyId	True	string	要刪除的責任的 ID。

刪除特定警示模式

作業識別碼：: TeamsDeleteAlertPattern

刪除特定的警示模式。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要存取的小組的小組ID
模式識別碼	patternId	True	string	您要存取之型樣的型樣 ID

刪除現有類別

作業識別碼：: CategoriesDelete

範例要求：

DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	類別所屬小組的識別碼
類別標識碼	categoryId	True	string	要刪除的類別識別碼

刪除目前的團隊形象

作業識別碼：: TeamsDeleteImage

刪除目前的團隊影像。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要從中刪除團隊映像的團隊識別碼。

刪除範圍內的值班表

作業識別碼：: DutiesDeleteInRange

刪除範圍內的值班表。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要刪除的團隊 ID
從	from		date-time
至	to		date-time

傳回

response: array of ScheduleInfo

刪除遠端動作

作業識別碼：: RemoteActionsDelete

範例要求：

DELETE /eaRemoteActions/{actionId}

參數

名稱	機碼	必要	類型	Description
作ID	actionId	True	string	要刪除的動作 ID

創建或更新給定的值班表

作業識別碼：: DutiesCreateOrUpdate

創建/更新給定的值班表。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	職責分配給的團隊的 ID。
結束	end		date-time
識別碼	id		string
options	options		integer
start	start		date-time
userId	userId		string

傳回

身體: ScheduleInfo

取得 Webhook

作業識別碼：: WebhooksGetAll

傳回系統中已定義的輸出 Webhook 集合。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId		string	團隊 ID。

傳回

response: array of WebhookInfo

取得事件參數

作業識別碼：: EventsGetParameters

依 ID 取得事件的參數。

參數

名稱	機碼	必要	類型	Description
事件識別碼	eventId	True	string	所要求警示的事件識別碼。

傳回

response: array of EventParameterInfo

取得使用者所屬的所有小組

作業識別碼：: UsersGetAllTeams

傳回小組物件的清單，其中包含其名稱等詳細資料。只會傳回使用者所屬的小組。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	userId	True	string	團隊 ID。

傳回

response: array of TeamInfo

取得使用者的通知設定檔

作業識別碼：: UsersGetNotificationProfile

獲取用戶的通知配置文件。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	您要從中取得通知設定檔的使用者識別碼。

傳回

response: array of V2.NotificationProfileDetails

取得個人使用者影像

作業識別碼：: UsersGetImage

獲取個人用戶形象。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	使用者 ID。」
影像高度	height		integer	圖像高度。
影像寬度	width		integer	圖像寬度。

傳回

身體: UserImage

取得分頁的概觀事件

作業識別碼：: EventsGetOverviewPaged

取得概觀事件分頁。如果有更多結果，您也會取得一個延續權杖，您可以將其新增至事件篩選器。

參數

名稱	機碼	類型	Description
限制	maxResults	integer	定義每個要求擷取的警示詳細資料限制。每個請求允許 1 到 100 個。如果過濾，警示數目可能會較少，但至少為 1 個。
nextPartitionKey	nextPartitionKey	string
nextRowKey	nextRowKey	string
nextTableName	nextTableName	string
eventSourceId	eventSourceId	string
事件狀態代碼	eventStatusCode	integer	0 = 無 1 = 處理中 2 = 已簽名 3 = 已過濾 4 = 已解決 5 = 已丟棄 6 = 已確認 7 = 隱藏 8 = 無規則已套用 9 = MultipleTarget狀態 1000 = 錯誤
最大建立日期	maxCreationDate	date-time
minCreationDate	minCreationDate	date-time
修改自	modifiedSince	date-time
團隊ID	teamid	string
textToSearch	textToSearch	string

傳回

身體: PagedResultsPublic-1-OverviewEvent-

取得可下載警示報告的相關資訊

作業識別碼：: TeamsGetAlertReportsInfo

取得可下載警示報告的相關資訊。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要從中下載報表的小組識別碼。

傳回

response: array of AlertAuditReportFileInfo

取得多個小組的小組職責設定

作業識別碼：: TeamsGetDutySettings

取得多個團隊的團隊職責設定。

參數

名稱	機碼	必要	類型	Description
團隊 ID	teamId		array	團隊 ID。

傳回

身體: MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

取得小組的小組隱私權設定

作業識別碼：: TeamsGetPrivacySettings

取得小組的小組隱私權設定。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	團隊的團隊ID

傳回

身體: V2.TeamPrivacySettingsDetails

取得所有使用者

作業識別碼：: UsersGettAll

傳回使用者物件清單，其中包含其電子郵件地址和職責資訊等詳細資訊。只有您有權存取的使用者才會傳回。

傳回

response: array of V2.UserDetails

取得所有可用和受管理訂閱的資訊

作業識別碼：: SubscriptionsGetAll

取得所有可用/受管理訂閱的資訊。

傳回

response: array of SubscriptionInfo

取得所有警示類別影像的名稱

作業識別碼：: CategoriesGetImageNames

取得所有警示類別影像的名稱。您可以通過轉到 account.signl4.com/images/alerts/categoryImageName.svg 來獲取圖像。

傳回

名稱	路徑	類型	Description
		array of string

取得所有類別的指標

作業識別碼：: CategoriesGetAllMetrics

範例要求：

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	類別所屬小組的識別碼

傳回

response: array of CategoryMetrics

取得指定小組的影像

作業識別碼：: TeamsGetImage

取得指定小組的影像。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要從中取得映像的小組識別碼。
影像高度	height		integer	選擇性參數，定義擷取之圖片所需的高度。
影像寬度	width		integer	選擇性參數，定義擷取之圖片所需的寬度。

傳回

身體: V2.TeamImageDetails

取得指定小組的所有使用者

作業識別碼：: TeamsGetAllUsers

取得指定小組的所有使用者。

參數

名稱	機碼	必要	類型	Description
團隊 ID	teamId		array	要請求的團隊 ID。如果為空，您會取得您有權存取之所有小組的所有使用者。

傳回

身體: MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

取得指定警示的指定附件

作業識別碼：: AlertsGetAttachment

取得指定警示的指定附件。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	包含所需附件之警示的識別碼。
附件 ID	attachmentId	True	string	您要擷取的附件的 ID。
影像寬度	width		integer	選擇性參數，定義擷取之圖片所需的寬度。
影像高度	height		integer	選擇性參數，定義擷取之圖片所需的高度。
Scale	scale		boolean	選擇性參數，定義是否要縮放擷取的影像。預設值設定為 true。

傳回

response: binary

取得概觀事件

作業識別碼：: EventsGetOverview

依 ID 取得概觀事件。

參數

名稱	機碼	必要	類型	Description
事件識別碼	eventId	True	string	要取得的事件標識碼。

傳回

身體: OverviewEvent

取得活動的詳細資料

作業識別碼：: EventsGetDetails

取得活動的詳細資料。

參數

名稱	機碼	必要	類型	Description
事件識別碼	eventId	True	string	您要取得之事件的事件識別碼

傳回

身體: V2.EventDetails

取得特定使用者的設定進度

作業識別碼：: UsersGetSetupProgress

取得特定使用者的設定進度。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	應擷取進度的使用者識別碼。

傳回

身體: UserSetupProgress

取得特定小組的事件來源

作業識別碼：: TeamsGetEventSources

取得特定小組的事件來源。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	應檢索來源的團隊 ID。

傳回

response: array of EventSourceEndpointInfo

取得特定小組的設定進度

作業識別碼：: TeamsGetSetupProgress

取得特定小組的設定進度。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	應擷取進度的小組識別碼。

傳回

身體: TeamSetupProgress

取得特定小組的警示設定

作業識別碼：: TeamsGetAlertSettings

取得特定小組的警示設定。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId		array	小組的標識碼。

傳回

身體: MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

取得特定小組的警示設定

作業識別碼：: TeamsGetAlertSettings99

取得特定小組的警示設定。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	應擷取設定的小組識別碼。

傳回

身體: AlertSettings

取得特定訂閱的資訊

作業識別碼：: SubscriptionsGetInfo

取得特定訂用帳戶的資訊。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	要擷取之訂用帳戶的識別碼。

傳回

身體: SubscriptionInfo

取得特定類別

作業識別碼：: CategoriesGet

範例要求：

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	類別所屬小組的識別碼
類別標識碼	categoryId	True	string	要取得的類別識別碼

傳回

身體: CategoryInfo

取得特定類別的指標

作業識別碼：: CategoriesGetMetrics

範例要求：

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	類別所屬小組的識別碼
類別標識碼	categoryId	True	string	要取得的類別識別碼

傳回

身體: CategoryMetrics

取得訂用帳戶中所有小組的公開資訊

作業識別碼：: TeamsGetAllPublicInformation

取得訂用帳戶中所有小組的公開資訊。

傳回

response: array of V2.TeamPublicDetails

取得訂用帳戶所有小組的資訊

作業識別碼：: SubscriptionsGetAllTeamsInfo

取得訂用帳戶所有小組的資訊。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	要更新之訂用帳戶的識別碼

傳回

response: array of TeamInfo

取得訂用帳戶的使用者授權

作業識別碼：: SubscriptionsGetUserLicenses

取得訂用帳戶的使用者授權。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	訂用帳戶的識別碼

傳回

身體: UserLicenseInfo

取得訂閱的所有圖說文字範本

作業識別碼：: CalloutsGetTemplates

取得訂閱的所有圖說範本。

傳回

response: array of V2.CalloutTemplateDetails

取得訂閱的目前預付設定

作業識別碼：: PrepaidGetSettings

取得訂閱的目前預付費設定。

傳回

身體: PrepaidSettingsInfo

取得訂閱的目前預付費設定

作業識別碼：: PrepaidGetSettings84

取得訂閱的目前預付費設定。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	訂用帳戶的識別碼

傳回

身體: PrepaidSettingsInfo

取得訂閱的目前預付餘額

作業識別碼：: SubscriptionsGetPrepaidBalance

取得訂閱的目前預付餘額。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	訂用帳戶的識別碼

傳回

身體: PrepaidBalanceInfo

取得訂閱的目前預付餘額

作業識別碼：: PrepaidGetBalance

取得訂閱的當前預付餘額。

傳回

身體: PrepaidBalanceInfo

取得訂閱的語音號碼授權

作業識別碼：: SubscriptionsGetVoiceNumberLicense

取得訂閱的語音號碼授權。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	訂用帳戶的識別碼

傳回

身體: UserLicenseInfo

取得訂閱的預付交易

作業識別碼：: SubscriptionsGetPrepaidTransactions

取得訂閱的預付交易。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	要取得交易的訂用帳戶識別碼

傳回

response: array of PrepaidTransactionInfo

取得訂閱的預付交易

作業識別碼：: PrepaidGetTransactions

取得訂閱的預付費交易。

傳回

response: array of PrepaidTransactionInfo

取得警示

作業識別碼：: AlertsGet

透過 ID 取得警示。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	所要求警示的識別碼。
使用者識別碼	userId		string	使用者識別碼。

傳回

身體: V2.AlertInfo

取得警示分頁

作業識別碼：: AlertsGetPaged

取得警示分頁。

參數

名稱	機碼	類型	Description
使用者識別碼	userId	string	您要接收警示之使用者的使用者識別碼。
警示限制	maxResults	integer	定義每個要求擷取的警示詳細資料限制。每個請求允許 1 到 100 個。如果過濾，警示數目可能會較少，但至少為 1 個。
afterId	afterId	string
alertIds	alertIds	array of string
alertStatus代碼	alertStatusCodes	integer	0 = 無 1 = 打開 2 = 已確認 4 = 已關閉 8 = 不回覆 16 = 失敗 32 = 錯誤
類別標識符	categoryIds	array of string
nextPartitionKey	nextPartitionKey	string
nextRowKey	nextRowKey	string
nextTableName	nextTableName	string
externalId（外部識別碼）	externalId	string
最大創建	maxCreated	date-time
最小已建立	minCreated	date-time
修改自	modifiedSince	date-time
顯示個人隱藏類別	showPersonalHiddenCategories	boolean
團隊標識碼	teamIds	array of string
textToSearch	textToSearch	string

傳回

身體: PagedResultsPublic-1-V2.AlertInfo-

取得警示報告

作業識別碼：: AlertsGetReport

傳回不同時段內發生的警示量的相關資訊，以及團隊成員回應行為（已確認和未處理警示的數量）的相關資訊。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId		string	您要為其提供報告的使用者的使用者 ID。
團隊 ID	teamId		array	您要為其提供報告的團隊的團隊 ID。如果您未設定團隊 ID，您將取得您有權存取的所有團隊的所有資源。

傳回

身體: MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

取得警示時間表項目

作業識別碼：: AlertsGetTimeline

依 ID 取得警示的警示時間表專案。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	所要求警示的識別碼。
使用者識別碼	userId		string	使用者識別碼。

傳回

名稱	路徑	類型	Description
		array of

取得警示的詳細資料

作業識別碼：: AlertsGetDetails

取得警示的詳細資料。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	您想要獲得的警報。
使用者識別碼	userId		string	呼叫 API 行為的使用者 ID。它用於過濾有關警報的目的。

傳回

身體: V2.AlertDetails

取得警示的附件資訊

作業識別碼：: AlertsGetAttachmentInfo

通過 ID 獲取警報的附件。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	所要求警示的識別碼。

傳回

response: array of V2.AlertAttachmentInfo

取得警示通知

作業識別碼：: AlertsGetNotifications

通過警報 ID 獲取所有用戶的通知。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	所要求警示的識別碼。

傳回

response: array of AlertNotificationInfo

取得類別訂閱

作業識別碼：: CategoriesGetSubscription

範例要求：

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	類別所屬小組的識別碼
類別標識碼	categoryId	True	string	要取得訂閱的類別

傳回

response: array of CategorySubscriptionInfo

啟用 webHook 的能力

作業識別碼：: WebhooksDisable

能夠啟用 webHook。

參數

名稱	機碼	必要	類型	Description
Webhook ID	webhookId	True	string	Webhook ID 適用於應停用的 Webhook。

傳回

身體: WebhookInfo

啟用指令碼執行個體

作業識別碼：: ScriptsEnable

啟用指令碼執行個體。

參數

名稱	機碼	必要	類型	Description
指令碼執行個體識別碼	instanceId	True	string	要啟用之執行個體的 ID。

傳回

身體: ScriptInstanceDetails

在 SIGNL4 小組中的中建立新的 Script 實例

作業識別碼：: ScriptsCreate

建立要求內文中指定的指令碼的新指令碼實例。

參數

名稱	機碼	類型
config	config
customScript說明	customScriptDescription	string
自訂腳本名稱	customScriptName	string
enabled	enabled	boolean
instanceId	instanceId	string
scriptId	scriptId	string
scriptName	scriptName	string
共用團隊	sharedTeams	array of string
團隊識別碼	teamId	string

傳回

身體: ScriptInstanceDetails

多個通知的佇列復原

作業識別碼：: AlertsUndoAcknowledgeMultiple

此方法會嘗試透過佇列復原多個警示的確認。作業會在背景處理。

參數

名稱	機碼	必要	類型
alertIds	alertIds	True	array of string
描述	descr		string
uid	uid	True	string

如果邀請存在，則再次傳送邀請電子郵件

作業識別碼：: TeamsResendInvite

如果存在邀請，則再次傳送邀請電子郵件。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	具有受邀使用者的小組 ID。
inviterId	inviterId		string
使用者郵件	userMail	True	string

傳回

response: string

將使用者新增至小組

作業識別碼：: TeamsAddUser

將使用者新增至小組。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	應邀請使用者加入的小組識別碼。
使用者識別碼	userId	True	string	您要新增至小組的使用者識別碼。
角色ID	roleId		string
setUserOnDuty	setUserOnDuty		boolean

傳回

身體: V2.TeamMembershipDetails

將假期從一個團隊複製到另一個團隊

作業識別碼：: TeamsCopyHolidays

將假期從一個團隊複製到另一個團隊。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要將假日複製到的團隊的團隊 ID
年	year	True	integer	您要複製的年份
團隊識別碼	sourceTeamId	True	string	您要從中複製假日的團隊 ID

傳回

身體: V2.TeamHolidayDetails

將用戶打卡為管理員

作業識別碼：: DutiesUserPunchInAsManager

指定的用戶將被打卡到經理的職責中。

參數

名稱	機碼	必要	類型	Description
團隊標識碼	teamIds		array of string
userId	userId	True	string

傳回

身體: MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

將郵件傳送給指定的使用者

作業識別碼：: UsersSendEventSourceInfoEmail

傳送郵件給指定的使用者，其中包含使用者團隊所有事件來源的資訊。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	使用者 ID。
團隊識別碼	teamId		string	使用者應從中取得端點資訊的小組識別碼。

已上傳指定使用者的設定檔影像

作業識別碼：: UsersUploadImage

已上傳指定使用者的設定檔影像。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	使用者的識別碼。

已上傳指定團隊的個人資料圖片

作業識別碼：: TeamsUploadImage

已上傳指定團隊的設定檔影像。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	團隊 ID 設定團隊映像的位置。

建立 Webhook

作業識別碼：: WebhooksCreate

建立新的輸出 Webhook，當某些事件發生時，該 Webhook 會收到通知。

參數

名稱	機碼	必要	類型
描述	description		string
ext網址	extUrl	True	string
名稱	name	True	string
團隊識別碼	teamId		string

傳回

response: string

建立事件來源

作業識別碼：: EventSourcesCreate

建立事件來源。

參數

名稱	機碼	類型	Description
描述	description	string
停用	disabled	boolean
語言	language	integer	0 = 英文 1 = 德國
名稱	name	string
共用團隊	sharedTeams	array of string
團隊識別碼	teamId	string
型別	type	integer	0 = 無 1 = 電子郵件 2 = Webhook

傳回

身體: EventSourceEndpointInfo

建立新的警示模式

作業識別碼：: TeamsCreateAlertPattern

建立新的警示模式。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要為其建立模式的小組ID
categories	categories		array of string
enabled	enabled		boolean
mode	mode		integer	0 = 經理 1 = 團隊
參考標識符	referenceId		string
識別碼	id		string
名稱	name		string
通道	channel		integer	0 = 無 1 = 推 2 = 語音 3 = 簡訊
delay（以分鐘為單位）	delayInMinutes		integer
enabled	enabled		boolean
overrideEscalationSettings	overrideEscalationSettings		boolean
overrideNotificationProfiles	overrideNotificationProfiles		boolean
overrideResponseSettings	overrideResponseSettings		boolean
回應模式	responseMode		integer	2 = 單一確認 4 = 多重確認
回應時間	responseTime		integer
抑制簽名	suppressSignl		boolean
小時	hour		integer
紀要	minutes		integer
平日	weekday		integer	0 = 假日 1 = 星期一 2 = 星期二 3 = 星期三 4 = 星期四 5 = 星期五 6 = 星期六 7 = 星期日
識別碼	id		string

傳回

身體: V2.AlertingPatternDetails

建立新的遠端動作

作業識別碼：: RemoteActionsCreate

範例要求：

POST /remoteActions
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

參數

名稱	機碼	必要	類型	Description
語言	language		integer	0 = 英文 1 = 德國
名稱	name	True	string
value	value		string
可以編輯	canEdit		boolean
可以執行	canExecute		boolean
團隊識別碼	teamId		string
定義Id	definitionId		string
描述	description		string
enabled	enabled		boolean
名稱	name		string
團隊識別碼	teamId		string

傳回

身體: V2.RemoteActionDetails

建立新的遠端工作

作業識別碼：: RemoteActionsCreateJob

範例要求：

POST /remoteActions/{actionId}/jobs
{
    "remoteActionPin" : "1234",
    "parameters": [
        {
            "name": "Param1",
            "value": "Value 1"
        }
    ]
}

參數

名稱	機碼	必要	類型	Description
作ID	actionId	True	string	作ID
名稱	name	True	string
value	value		string
alertId	alertId		string
options	options		integer	0 = 無
remoteActionPin	remoteActionPin		string

傳回

身體: V2.RemoteJob

建立新類別

作業識別碼：: CategoriesCreate

範例要求：

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	類別所屬小組的識別碼
enabled	enabled		boolean
識別碼	id		string
名稱	name		string
型別	type	True	integer	0 = 參數 1 = 主語 2 = 文字 3 = 位置
value	value		string
color	color	True	string
識別碼	id		string
名稱	name		string
型別	type	True	integer	0 = 參數 1 = 超連結
value	value		string
識別碼	id		string
圖像名稱	imageName	True	string
isDefault	isDefault		boolean
關鍵字比對	keywordMatching	True	integer	0 = 任何 1 = 全部
關鍵字	keywords	True	array of string
關鍵字排除	keywordsExcluded		array of string
名稱	name	True	string
options	options		integer	0 = 無 1 = 隱藏 2 = 拒絕刪除 4 = 隱藏選擇退出 8 = 隱藏關鍵字
順序	order		integer
團隊識別碼	teamId		string

傳回

身體: CategoryInfo

從一或多個小組取得事件來源

作業識別碼：: EventSourcesGet

從一或多個小組取得事件來源。

參數

名稱

機碼

必要

類型

Description

團隊 ID

teamId

array

Team Ids，以從中取得事件來源。如果您未新增任何小組識別碼，您會從訂用帳戶取得可存取的事件來源。

包括內部

includeInternal

boolean

如果為true，則結果中將包含內部事件來源類型（系統、手動、API）。

語言

language

integer

0 = 英文
1 = 德國

傳回

身體: MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

從使用者取得小組成員資格

作業識別碼：: TeamsGetTeamMemberships

從使用者取得小組成員資格。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	您要存取的使用者 ID。

傳回

response: array of V2.TeamMembershipDetails

從團隊中移除使用者或邀請

作業識別碼：: TeamsRemoveUser

從團隊中移除使用者或邀請。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	應從中刪除使用者的小組識別碼
使用者識別碼	userId	True	string	應刪除之使用者的識別碼
使用者識別碼	requesterUserId		string	使用者的使用者 ID，該使用者將移除其他使用者。

從團隊獲取所有警報模式

作業識別碼：: TeamsGetAllAlertPatterns

從團隊獲取所有警報模式。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要存取的小組 ID

傳回

response: array of V2.AlertingPatternDetails

從異動日誌傳回遠端工作

作業識別碼：: RemoteActionsGetJob

範例要求：

GET /remoteActions/journal/{jobId}

參數

名稱

機碼

必要

類型

Description

作業識別碼

jobId

True

string

要傳回的工作識別碼

語言

language

integer

0 = 英文
1 = 德國

傳回

身體: V2.RemoteJob

從訂用帳戶中刪除現有的圖說文字範本

作業識別碼：: CalloutsDeleteTemplate

從您的訂閱中刪除現有的圖說文字範本。

參數

名稱	機碼	必要	類型	Description
範本識別碼	templateId	True	string	範本 ID。

復原警示的確認

作業識別碼：: AlertsUndoAck

這個方法會嘗試復原警示通知。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	警示識別碼。
描述	descr		string
uid	uid	True	string

傳回

身體: V2.AlertInfo

復原警示的關閉

作業識別碼：: AlertsUndoClose

這個方法會嘗試復原警示關閉。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	警示識別碼。
描述	descr		string
uid	uid	True	string

傳回

身體: V2.AlertInfo

手動將警示呈報給小組

作業識別碼：: AlertsEscalateToTeam

手動將警示呈報給團隊。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	您要呈報的警示 ID 。
targetTeamId	targetTeamId		string
userId	userId		string

傳回

response: string

打卡用戶

作業識別碼：: DutiesUserPunchIn

指定的用戶將被打卡上崗。

參數

名稱	機碼	必要	類型	Description
團隊標識碼	teamIds		array of string
userId	userId	True	string

傳回

身體: MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

打孔用戶

作業識別碼：: DutiesUserPunchOut

指定的用戶將被打退班。

參數

名稱	機碼	必要	類型	Description
團隊標識碼	teamIds		array of string
userId	userId	True	string

傳回

身體: MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

按團隊獲取團隊成員資格

作業識別碼：: TeamsGetMemberships

按團隊獲取團隊成員資格。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要存取的小組的小組 ID。

傳回

response: array of V2.TeamMembershipDetails

撤回多個警示的關閉

作業識別碼：: AlertsUndoCloseMultiple

此方法會嘗試復原多個警示關閉。作業會在背景處理。

參數

名稱	機碼	必要	類型
alertIds	alertIds	True	array of string
描述	descr		string
uid	uid	True	string

擷取定義

作業識別碼：: RemoteActionsGetDefinition

擷取定義。

參數

名稱

機碼

必要

類型

Description

定義 ID

definitionId

True

string

定義的 ID

語言

language

integer

0 = 英文
1 = 德國

傳回

身體: V2.RemoteActionDefinitionDetails

擷取所有可用的定義

作業識別碼：: RemoteActionsGetAvailableDefinitions

擷取所有可用的定義。

參數

名稱

機碼

必要

類型

Description

語言

language

integer

0 = 英文
1 = 德國

傳回

response: array of V2.RemoteActionDefinitionDetails

更新事件來源

作業識別碼：: EventSourcesUpdate

更新事件來源。

參數

名稱	機碼	必要	類型	Description
事件來源識別碼	eventSourceId	True	string	事件來源的識別碼
描述	description		string
停用	disabled		boolean
名稱	name		string
團隊識別碼	teamId		string

傳回

身體: EventSourceEndpointInfo

更新使用者的使用者設定檔

作業識別碼：: UsersUpdateProfile

更新使用者的使用者設定檔。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	要更新的使用者識別碼。
名稱	name		string
timeZone	timeZone		string

傳回

身體: UserInfo

更新使用者的地區設定資訊（例如語言、時區）

作業識別碼：: UsersUpdateLocaleInfo

更新使用者的地區設定資訊（例如語言、時區）。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	使用者 ID、電子郵件或您要更新的使用者的「我」
語言	language		string
timeZone	timeZone		string

傳回

身體: V2.UserLocaleResponseDetails

更新使用者的密碼

作業識別碼：: UsersUpdatePassword

更新使用者的密碼。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	應變更密碼的使用者 ID。
當前密碼	currentPassword		string
新密碼	newPassword		string

更新使用者的小組成員資格

作業識別碼：: TeamsUpdateUserMembership

更新使用者的小組成員資格。您可以將使用者移至訂閱內的另一個小組，和/或變更使用者的角色。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	團隊您要更新的使用者目前所屬。
使用者識別碼	userId	True	string	您要更新的使用者的使用者 ID。
使用者識別碼	requesterUserId		string	您要變更角色的使用者 ID。使用 API 金鑰時必須提供此資訊。此使用者必須具有角色管理員（用於設定管理員角色）或團隊管理員（用於設定權限。
設定值班使用者	setUserOnDuty		boolean	如果使用者移至其他小組，則為使用者設定新的職責狀態。用戶默認值班。
是有效	isValid		boolean
角色ID	roleId		string
團隊識別碼	teamId		string

傳回

身體: UserInfo

更新團隊的團隊設定檔

作業識別碼：: TeamsUpdateProfile

更新團隊的團隊設定檔。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	應更新的團隊的團隊 ID。
名稱	name		string

傳回

身體: TeamInfo

更新團隊的隱私權設定

作業識別碼：: TeamsUpdatePrivacySettings

更新團隊的隱私設定。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	團隊的團隊ID
隱藏聯絡人地址	hideContactAddresses		boolean
隱藏職責數據	hideDutyData		boolean
隱藏升級	hideForEscalation		boolean

傳回

身體: V2.TeamPrivacySettingsDetails

更新指定指令碼執行個體的自訂資料，包括其顯示名稱

作業識別碼：: ScriptsUpdateCustomData

更新指定的指令碼執行個體。

參數

名稱	機碼	必要	類型	Description
指令碼執行個體識別碼	instanceId	True	string	要更新的指令碼的實例識別碼。
customScript說明	customScriptDescription		string
自訂腳本名稱	customScriptName		string
instanceId	instanceId		string
scriptName	scriptName		string

傳回

身體: ScriptInstanceDetails

更新指定的指令碼執行個體

作業識別碼：: ScriptsUpdateConfig

更新指定的指令碼實例，通常用於更新指令碼的組態。

參數

名稱	機碼	必要	類型	Description
指令碼執行個體識別碼	instanceId	True	string	要更新的指令碼的實例識別碼。
config	config
customScript說明	customScriptDescription		string
自訂腳本名稱	customScriptName		string
enabled	enabled		boolean
團隊識別碼	teamId		string

傳回

身體: ScriptInstanceDetails

更新現有的警示模式

作業識別碼：: TeamsUpdateAlertPattern

更新現有的警示模式。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要為其建立模式的小組ID
模式識別碼	patternId	True	string	要更新的模式的模式ID
categories	categories		array of string
enabled	enabled		boolean
mode	mode		integer	0 = 經理 1 = 團隊
參考標識符	referenceId		string
識別碼	id		string
名稱	name		string
通道	channel		integer	0 = 無 1 = 推 2 = 語音 3 = 簡訊
delay（以分鐘為單位）	delayInMinutes		integer
enabled	enabled		boolean
overrideEscalationSettings	overrideEscalationSettings		boolean
overrideNotificationProfiles	overrideNotificationProfiles		boolean
overrideResponseSettings	overrideResponseSettings		boolean
回應模式	responseMode		integer	2 = 單一確認 4 = 多重確認
回應時間	responseTime		integer
抑制簽名	suppressSignl		boolean
小時	hour		integer
紀要	minutes		integer
平日	weekday		integer	0 = 假日 1 = 星期一 2 = 星期二 3 = 星期三 4 = 星期四 5 = 星期五 6 = 星期六 7 = 星期日
識別碼	id		string

傳回

身體: V2.AlertingPatternDetails

更新現有類別

作業識別碼：: CategoriesUpdate

範例要求：

PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
    "name": "Water-Updated",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "All",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        },
        {
            "value": "Wet"
        }
    ]
}

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	類別所屬小組的識別碼
類別標識碼	categoryId	True	string	類別標識碼
enabled	enabled		boolean
識別碼	id		string
名稱	name		string
型別	type	True	integer	0 = 參數 1 = 主語 2 = 文字 3 = 位置
value	value		string
color	color	True	string
識別碼	id		string
名稱	name		string
型別	type	True	integer	0 = 參數 1 = 超連結
value	value		string
識別碼	id		string
圖像名稱	imageName	True	string
isDefault	isDefault		boolean
關鍵字比對	keywordMatching	True	integer	0 = 任何 1 = 全部
關鍵字	keywords	True	array of string
關鍵字排除	keywordsExcluded		array of string
名稱	name	True	string
options	options		integer	0 = 無 1 = 隱藏 2 = 拒絕刪除 4 = 隱藏選擇退出 8 = 隱藏關鍵字
順序	order		integer
團隊識別碼	teamId		string

傳回

身體: CategoryInfo

更新訂閱的現有圖說文字範本

作業識別碼：: CalloutsUpdateTemplate

更新訂閱的現有圖說文字範本。

參數

名稱	機碼	必要	類型	Description
範本識別碼	templateId	True	string	您要更新的範本識別碼
categoryId	categoryId		string
externalId（外部識別碼）	externalId		string
識別碼	id		string
位置	location		string
名稱	name		string
主題	subject		string
目標所有團隊	targetAllTeams		boolean
targetTeamId	targetTeamId		string
收發簡訊	text		string
工作流程類型	workflowType		integer	0 = AsConfiguredInTeam 2 = 團隊廣播 4 = 多重確認 5 = 多重確認緊急情況

傳回

response: array of V2.CalloutTemplateDetails

更新訂閱的當前預付費設置

作業識別碼：: PrepaidUpdateSettings

更新訂閱的當前預付費設置。

參數

名稱	機碼	類型
topUp金額	topUpAmount	integer
topUp啟用	topUpEnabled	boolean
充值限額	topUpLimit	integer

傳回

身體: PrepaidSettingsInfo

更新訂閱的目前預付費設定

作業識別碼：: PrepaidUpdateSettings55

更新訂閱的當前預付費設置。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	訂用帳戶的識別碼
topUp金額	topUpAmount		integer
topUp啟用	topUpEnabled		boolean
充值限額	topUpLimit		integer

傳回

身體: PrepaidSettingsInfo

更新訂閱設定檔

作業識別碼：: SubscriptionsUpdateProfile

更新訂閱設定檔。

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscriptionId	True	string	要更新之訂用帳戶的識別碼
名稱	name		string

傳回

身體: SubscriptionInfo

更新遠端動作

作業識別碼：: RemoteActionsUpdate

範例要求：

PUT /remoteActions/{actionId}
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

參數

名稱	機碼	必要	類型	Description
作ID	actionId	True	string	要更新的遠端動作的識別碼
作ID	language		integer	0 = 英文 1 = 德國
名稱	name	True	string
value	value		string
可以編輯	canEdit		boolean
可以執行	canExecute		boolean
團隊識別碼	teamId		string
定義Id	definitionId		string
描述	description		string
enabled	enabled		boolean
名稱	name		string
團隊識別碼	teamId		string

傳回

身體: V2.RemoteActionDetails

檢查使用者是否具有提供的權限

作業識別碼：: UsersCheckPermissions

檢查使用者是否具有提供的權限。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	要檢查權限的使用者識別碼。
使用權限	permissions		array of string
團隊標識碼	teamIds		array of string

傳回

身體: MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

為使用者設定通知設定檔

作業識別碼：: UsersSetNotificationProfile

為用戶設置通知配置文件。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	您要從中取得通知設定檔的使用者識別碼。
通道	channel		integer	0 = 無 1 = 推 2 = 電子郵件 4 = 機器人 8 = 語音 16 = 簡訊
delay（以分鐘為單位）	delayInMinutes		integer
enabled	enabled		boolean
options	options		integer
persistent	persistent		boolean

傳回

response: array of V2.NotificationProfileDetails

為團隊保存假期

作業識別碼：: TeamsSaveHolidays

為團隊節省假期。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您想要為其保存假期的團隊的團隊 ID
年	year	True	integer	您想保存假期的年份
天	day		integer
個月	month		integer	0 = 未設定 1 = 一月 2 = 二月 3 = 三月 4 = 四月 5 = 五月 6 = 六月 7 = 七月 8 = 八月 9 = 九月 10 = 十月 11 = 十一月 12 = 十二月

傳回

身體: V2.TeamHolidayDetails

為團隊保存重複假期

作業識別碼：: TeamsSaveRepeatingHolidays

為團隊節省重複的假期。

參數

名稱

機碼

必要

類型

Description

團隊識別碼

teamId

True

string

您想要為其保存假期的團隊的團隊 ID

天

day

integer

個月

month

integer

0 = 未設定
1 = 一月
2 = 二月
3 = 三月
4 = 四月
5 = 五月
6 = 六月
7 = 七月
8 = 八月
9 = 九月
10 = 十月
11 = 十一月
12 = 十二月

傳回

身體: V2.TeamHolidayDetails

為團隊提供假期

作業識別碼：: TeamsGetHolidays

為團隊安排假期。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您想要從中取得假日的團隊 ID

傳回

身體: V2.TeamHolidayDetails

為您的訂閱建立新的圖說文字範本

作業識別碼：: CalloutsCreateTemplate

為您的訂閱建立新的圖說文字範本。

參數

名稱	機碼	類型	Description
categoryId	categoryId	string
externalId（外部識別碼）	externalId	string
識別碼	id	string
位置	location	string
名稱	name	string
主題	subject	string
目標所有團隊	targetAllTeams	boolean
targetTeamId	targetTeamId	string
收發簡訊	text	string
工作流程類型	workflowType	integer	0 = AsConfiguredInTeam 2 = 團隊廣播 4 = 多重確認 5 = 多重確認緊急情況

傳回

response: array of V2.CalloutTemplateDetails

獲取團隊的值班助理信息

作業識別碼：: DutiesGetDutyAssistantInfo

獲取團隊的值班助理信息。

參數

名稱	機碼	必要	類型	Description
團隊 ID	teamId		array	要取得摘要的小組 ID。
最後兩項職責	lastTwoDuties		boolean	決定您是否想要所有職責或只想要最後兩項職責。

傳回

身體: MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

獲取所有團隊的信息

作業識別碼：: TeamsGetAllInfo

獲取所有團隊的信息。

參數

名稱	機碼	必要	類型	Description
團隊 ID	teamId		array	團隊 ID

傳回

response: array of TeamInfo

獲取所有類別

作業識別碼：: CategoriesGetAll

獲取所有類別。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId		array	團隊 ID。

傳回

身體: MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

獲取所有類別

作業識別碼：: CategoriesGetAllOfTeam

範例要求：

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	類別所屬小組的識別碼

傳回

response: array of CategoryInfo

獲取特定團隊的信息

作業識別碼：: TeamsGetInfo

獲取特定團隊的信息。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	應擷取之小組識別碼。

傳回

身體: TeamInfo

確認多個警示

作業識別碼：: AlertsAcknowledgeMultiple

此方法會確認提供的所有警示。

參數

名稱	機碼	必要	類型
alertIds	alertIds	True	array of string
描述	descr		string
uid	uid	True	string

確認所有可見的警報

作業識別碼：: AlertsAcknowledgeAll

此方法會確認特定使用者目前團隊擁有的所有未處理警示。

參數

名稱	機碼	類型	Description
使用者識別碼	userId	string	要用來確認警示的使用者 ID。
類別標識符	categoryIds	array of string
最大日期	maxDate	date-time
最小日期	minDate	date-time
範圍	scope	integer	0 = 預設值 1 = 所有團隊 2 = 特定團隊
團隊標識碼	teamIds	array of string

確認警示

作業識別碼：: AlertsAcknowledge

確認警示。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	ID 以確認警示。
描述	descr		string
uid	uid	True	string

傳回

身體: V2.AlertInfo

觸發警報

作業識別碼：: AlertsTrigger

為您的團隊觸發新警報。所有值班團隊成員都會收到警報通知。

參數

名稱	機碼	必要	類型	Description
名稱	name		string
順序	order		integer
型別	type		integer	0 = 無 1 = 物件 2 = 陣列 3 = 建構函式 4 = 屬性 5 = 註解 6 = 整數 7 = 浮點 8 = 字串 9 = 布林值 10 = 空值 11 = 未定義 12 = 日期 13 = 原始 14 = 位元組 15 = 引導 16 = 烏里 17 = 時間跨度 100 = HTML
value	value		string
內容	content		string
內容類型	contentType		string
編碼	encoding		integer	0 = 無 1 = 基數 64
識別碼	id		string
名稱	name		string
分類	category		string
externalId（外部識別碼）	externalId		string
flags	flags		integer	0 = 無 1 = 有附件 2 = 有註釋 4 = 被破壞 8 = 有位置資訊 16 = 升級至團隊 32 = 升級至管理員 64 = 建立者Escalation
嚴重	severity		integer	0 = 低 1 = 主要 2 = 嚴重
團隊識別碼	teamId	True	string
收發簡訊	text	True	string
title	title	True	string

傳回

身體: V2.AlertDetails

設定使用者的位置

作業識別碼：: UsersSetLocation

設定使用者的位置。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	使用者的 ID。
緯度 (latitude)	latitude		double
經度 (longitude)	longitude		double
時間戳記	timestamp		date-time

傳回

身體: LocationInfo

設定使用者的電話號碼

作業識別碼：: UsersSetPhoneNumber

設定使用者的電話號碼。如果儲存了另一個電話號碼，它將被覆蓋。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	您要新增電話號碼的使用者 ID
countryCode （國家代碼）	countryCode		string
電話號碼	phoneNumber		string
發送驗證代碼	sendValidationCode		boolean
發送驗證代碼通過	sendValidationCodeVia		integer	0 = 無 1 = 簡訊 2 = 語音

傳回

身體: V2.UserPhoneNumberDetails

設定特定小組的警示設定

作業識別碼：: TeamsSetAlertSettings

設定特定團隊的警示設定。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	應為其設定的小組識別碼。
esc啟用	escEnabled		boolean
esc模式	escMode		integer	0 = 經理 1 = 團隊
escRefId	escRefId		string
filterAction	filterAction		integer	0 = 抑制 1 = 隱藏 2 = 靜音
filter模式	filterMode		integer	0 = 關閉 1 = 白名單所有類別
通道	channel		integer	0 = 無 1 = 推 2 = 語音 3 = 簡訊
延遲	delay		integer
enabled	enabled		boolean
選擇退出	optOut		integer	0 = 無 1=停用 2 = 個人
overrideNotificationProfiles	overrideNotificationProfiles		boolean
persNot間隔	persNotInterval		integer
persNot模式	persNotMode		integer	0 = 關閉 1 = 摘要
回應模式	responseMode		integer	2 = 單一確認 4 = 多重確認
回應時間	responseTime		integer

傳回

身體: AlertSettings

設定類別訂閱

作業識別碼：: CategoriesSetSubscription

範例要求：

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	類別所屬小組的識別碼
類別標識碼	categoryId	True	string	待更新的類別
狀態	status	True	integer	0 = 已訂閱 1 = 靜音 2 = 隱藏
userId	userId	True	string

傳回

response: array of CategorySubscriptionInfo

註釋警報

作業識別碼：: AlertsAnnotate

通過給定的註釋信息註釋警報。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	要註釋的警示識別碼。
收發簡訊	text		string
型別	type		integer	0 = 無 1 = 文字 2 = 圖像
userId	userId		string

傳回

身體: V2.AlertAnnotationDetails

退貨警示報告

作業識別碼：: TeamsGetAlertReport

傳回警示報告。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	您要取得值班報告檔案資訊的小組 ID。
檔案名稱	fileName	True	string	您要下載的檔案的檔案名稱。

傳回

response: binary

邀請使用者加入團隊

作業識別碼：: TeamsInviteUser

邀請使用者加入團隊。

參數

名稱	機碼	必要	類型
inviterId	inviterId		string
電子郵件	email		string
角色ID	roleId		string
團隊識別碼	teamId	True	string

傳回

response: array of V2.InvitationResult

關閉多個警示

作業識別碼：: AlertsCloseMultiple

此方法會關閉提供的所有警示。

參數

名稱	機碼	必要	類型
alertIds	alertIds	True	array of string
描述	descr		string
uid	uid	True	string

關閉所有已確認的警示

作業識別碼：: AlertsCloseAll

此方法會關閉您的團隊目前擁有的所有已確認警示。

參數

名稱	機碼	類型	Description
使用者識別碼	userId	string	要用來關閉警示的使用者 ID。
類別標識符	categoryIds	array of string
最大日期	maxDate	date-time
最小日期	minDate	date-time
範圍	scope	integer	0 = 預設值 1 = 所有團隊 2 = 特定團隊
團隊標識碼	teamIds	array of string

關閉警示

作業識別碼：: AlertsClose

關閉警示。

參數

名稱	機碼	必要	類型	Description
警示識別碼	alertId	True	string	ID 以確認警示。
描述	descr		string
uid	uid	True	string

傳回

身體: V2.AlertInfo

驗證先前為使用者建立的電話號碼

作業識別碼：: UsersValidatePhoneNumber

驗證先前為使用者建立的電話號碼。

參數

名稱	機碼	必要	類型	Description
使用者識別碼	userId	True	string	您要驗證先前建立的電話號碼的使用者 ID
電話號碼	phoneNumber		string
驗證代碼	validationCode		string

驗證型樣的時間段

作業識別碼：: TeamsValidateAlertPattern

根據其他型樣的所有現有時隙驗證型樣的時隙。

參數

名稱	機碼	必要	類型	Description
團隊識別碼	teamId	True	string	警示模式的小組識別碼
模式識別碼	patternId		string	您要儲存時段的模式的警示模式 ID。可以是空值
類別 ID	categoryIds		array	您要驗證之模式的類別識別碼。可以是 null。
小時	hour		integer
紀要	minutes		integer
平日	weekday		integer	0 = 假日 1 = 星期一 2 = 星期二 3 = 星期三 4 = 星期四 5 = 星期五 6 = 星期六 7 = 星期日
識別碼	id		string

傳回

response: array of V2.TimeSlotValidationResultDetails

定義

警示稽核報告檔案資訊

名稱	路徑	類型
fileName	fileName	string
檔案大小（位元組）	fileSizeInBytes	integer
最後記錄	lastRecord	date-time
lastUpdated	lastUpdated	date-time
個月	month	integer
年	year	integer

警示升級模式

0 = 經理
1 = 團隊

0 = 經理
1 = 團隊

: integer

警示篩選動作

0 = 抑制
1 = 隱藏
2 = 靜音

0 = 抑制
1 = 隱藏
2 = 靜音

: integer

警示篩選模式

0 = 關閉
1 = 白名單所有類別

0 = 關閉
1 = 白名單所有類別

: integer

警示通知資訊

名稱	路徑	類型	Description
address	address	string
裝置名稱	deviceName	string
最後更新	lastUpdate	date-time
訊息狀態	messageStatus	AlertNotificationInfoMessageStatus	0 = 無 1 = 已拒絕 2 = 失敗 3 = 已排入佇列 4 = 已傳輸 5 = 緩衝 6 = 已交付 7 = 已取消 8 = 受保護 9 = 濫用保護 10 = 延遲
messageStatusErrorCode	messageStatusErrorCode	integer
notificationChannelType	notificationChannelType	AlertNotificationInfoChannelType	0 = 無 1 = 推 2 = 電子郵件 4 = 機器人 8 = 語音 16 = 簡訊
userId	userId	string
使用者狀態	userStatus	AlertNotificationInfoUserStatus	0 = 無 1 = 訊息建立 2 = 不負責 3 = 類別隱藏 4 = 類別靜音 5 = 無通知設定檔 6 = NoMessagesByNotificationProfiles

AlertNotificationInfoChannelType

0 = 無
1 = 推
2 = 電子郵件
4 = 機器人
8 = 語音
16 = 簡訊

0 = 無
1 = 推
2 = 電子郵件
4 = 機器人
8 = 語音
16 = 簡訊

: integer

警示通知資訊訊息狀態

0 = 無
1 = 已拒絕
2 = 失敗
3 = 已排入佇列
4 = 已傳輸
5 = 緩衝
6 = 已交付
7 = 已取消
8 = 受保護
9 = 濫用保護
10 = 延遲

0 = 無
1 = 已拒絕
2 = 失敗
3 = 已排入佇列
4 = 已傳輸
5 = 緩衝
6 = 已交付
7 = 已取消
8 = 受保護
9 = 濫用保護
10 = 延遲

: integer

警示通知資訊使用者狀態

0 = 無
1 = 訊息建立
2 = 不負責
3 = 類別隱藏
4 = 類別靜音
5 = 無通知設定檔
6 = NoMessagesByNotificationProfiles

0 = 無
1 = 訊息建立
2 = 不負責
3 = 類別隱藏
4 = 類別靜音
5 = 無通知設定檔
6 = NoMessagesByNotificationProfiles

: integer

警示回應模式

2 = 單一確認
4 = 多重確認

2 = 單一確認
4 = 多重確認

: integer

警示設定

名稱	路徑	類型	Description
esc啟用	escEnabled	boolean
esc模式	escMode	AlertEscalationModes	0 = 經理 1 = 團隊
escRefId	escRefId	string
filterAction	filterAction	AlertFilterActions	0 = 抑制 1 = 隱藏 2 = 靜音
filter模式	filterMode	AlertFilterModes	0 = 關閉 1 = 白名單所有類別
notificationProfileOverrides	notificationProfileOverrides	array of AlertSettingsNotificationProfile
選擇退出	optOut	TeamCategoryOptOutModes	0 = 無 1=停用 2 = 個人
overrideNotificationProfiles	overrideNotificationProfiles	boolean
persNot間隔	persNotInterval	integer
persNot模式	persNotMode	PersistentNotificationModes	0 = 關閉 1 = 摘要
回應模式	responseMode	AlertResponseModes	2 = 單一確認 4 = 多重確認
回應時間	responseTime	integer

警示設定通道類型

0 = 無
1 = 推
2 = 語音
3 = 簡訊

0 = 無
1 = 推
2 = 語音
3 = 簡訊

: integer

警示設定通知設定檔

名稱

路徑

類型

Description

通道

channel

AlertSettingsChannelType

0 = 無
1 = 推
2 = 語音
3 = 簡訊

延遲

delay

integer

enabled

boolean

類別增強

名稱	路徑	類型	Description
enabled	enabled	boolean
識別碼	id	string
名稱	name	string
型別	type	CategoryAugmentationType	0 = 參數 1 = 主語 2 = 文字 3 = 位置
value	value	string

類別增強類型

0 = 參數
1 = 主語
2 = 文字
3 = 位置

0 = 參數
1 = 主語
2 = 文字
3 = 位置

: integer

類別豐富

名稱	路徑	類型	Description
識別碼	id	string
名稱	name	string
型別	type	CategoryEnrichmentType	0 = 參數 1 = 超連結
value	value	string

類別豐富類型

0 = 參數
1 = 超連結

0 = 參數
1 = 超連結

: integer

類別資訊

名稱	路徑	類型	Description
augmentations	augmentations	array of CategoryAugmentation
color	color	string
擴充	enrichments	array of CategoryEnrichment
識別碼	id	string
圖像名稱	imageName	string
isDefault	isDefault	boolean
關鍵字比對	keywordMatching	KeywordMatchingType	0 = 任何 1 = 全部
關鍵字	keywords	array of string
關鍵字排除	keywordsExcluded	array of string
名稱	name	string
options	options	CategoryInfoOptions	0 = 無 1 = 隱藏 2 = 拒絕刪除 4 = 隱藏選擇退出 8 = 隱藏關鍵字
順序	order	integer
團隊識別碼	teamId	string

CategoryInfo選項

0 = 無
1 = 隱藏
2 = 拒絕刪除
4 = 隱藏選擇退出
8 = 隱藏關鍵字

0 = 無
1 = 隱藏
2 = 拒絕刪除
4 = 隱藏選擇退出
8 = 隱藏關鍵字

: integer

類別指標

名稱	路徑	類型
categoryId	categoryId	string
最後24小時	last24h	integer
最後警報	lastAlert	date-time
訂閱者計數	subscriberCount	integer

類別訂閱資訊

名稱

路徑

類型

Description

狀態

status

CategorySubscriptionStatus

0 = 已訂閱
1 = 靜音
2 = 隱藏

userId

string

類別訂閱狀態

0 = 已訂閱
1 = 靜音
2 = 隱藏

0 = 已訂閱
1 = 靜音
2 = 隱藏

: integer

頻道價格資訊

名稱	路徑	類型	Description
簡訊	sms	integer
每分鐘語音	voicePerMinute	integer

職責摘要資訊

名稱	路徑	類型
職責結束	dutyEnd	date-time
職責識別碼	dutyId	string
職責開始	dutyStart	date-time

事件參數資訊

名稱	路徑	類型	Description
名稱	name	string
順序	order	integer
型別	type	EventParameterTypes	0 = 無 1 = 物件 2 = 陣列 3 = 建構函式 4 = 屬性 5 = 註解 6 = 整數 7 = 浮點 8 = 字串 9 = 布林值 10 = 空值 11 = 未定義 12 = 日期 13 = 原始 14 = 位元組 15 = 引導 16 = 烏里 17 = 時間跨度 100 = HTML
value	value	string

EventParameter類型

0 = 無
1 = 物件
2 = 陣列
3 = 建構函式
4 = 屬性
5 = 註解
6 = 整數
7 = 浮點
8 = 字串
9 = 布林值
10 = 空值
11 = 未定義
12 = 日期
13 = 原始
14 = 位元組
15 = 引導
16 = 烏里
17 = 時間跨度
100 = HTML

0 = 無
1 = 物件
2 = 陣列
3 = 建構函式
4 = 屬性
5 = 註解
6 = 整數
7 = 浮點
8 = 字串
9 = 布林值
10 = 空值
11 = 未定義
12 = 日期
13 = 原始
14 = 位元組
15 = 引導
16 = 烏里
17 = 時間跨度
100 = HTML

: integer

事件嚴重性

0 = 低
1 = 主要
2 = 嚴重

0 = 低
1 = 主要
2 = 嚴重

: integer

EventSourceEndpointInfo

名稱	路徑	類型	Description
address	address	string
描述	description	string
停用	disabled	boolean
groupId	groupId	string
識別碼	id	string
最後事件	lastEvent	date-time
名稱	name	string
子類型	subType	string
subscriptionId	subscriptionId	string
團隊識別碼	teamId	string
型別	type	EventSourceTypes	0 = 無 1 = 電子郵件 2 = WebHook 3 = 指令碼 4 = 系統 5 = 手動 6 = 語音 7 = API

事件來源類型

0 = 無
1 = 電子郵件
2 = WebHook
3 = 指令碼
4 = 系統
5 = 手動
6 = 語音
7 = API

0 = 無
1 = 電子郵件
2 = WebHook
3 = 指令碼
4 = 系統
5 = 手動
6 = 語音
7 = API

: integer

事件狀態代碼

0 = 無
1 = 處理中
2 = 已簽名
3 = 已過濾
4 = 已解決
5 = 已丟棄
6 = 已確認
7 = 隱藏
8 = 無規則已套用
9 = MultipleTarget狀態
1000 = 錯誤

0 = 無
1 = 處理中
2 = 已簽名
3 = 已過濾
4 = 已解決
5 = 已丟棄
6 = 已確認
7 = 隱藏
8 = 無規則已套用
9 = MultipleTarget狀態
1000 = 錯誤

: integer

庫存腳本資訊

名稱	路徑	類型
config	config
資料	data	ScriptDescriptionData
事件模式	eventPattern
本地化細節	localizationDetails	array of ScriptLocalizationDetail
scriptId	scriptId	string
scriptName	scriptName	string
能見度	visibility	string

關鍵字比對類型

0 = 任何
1 = 全部

0 = 任何
1 = 全部

: integer

地點資訊

名稱	路徑	類型
緯度 (latitude)	latitude	double
經度 (longitude)	longitude	double
時間戳記	timestamp	date-time

MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

名稱	路徑	類型	Description
資料	data	array of EventSourceEndpointInfo
錯誤	errors	array of V2.EventSourceEndpointError

MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

名稱	路徑	類型	Description
資料	data	array of TeamDutySummaryInfo
錯誤	errors	array of V2.TeamDutySummaryError

MultiTeamResult-2-UserDutyInfo-V2.DutyError-

名稱	路徑	類型	Description
資料	data	array of UserDutyInfo
錯誤	errors	array of V2.DutyError

MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

名稱	路徑	類型	Description
資料	data	array of V2.AlertCountsDetails
錯誤	errors	array of V2.AlertReportError

MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

名稱	路徑	類型	Description
資料	data	array of V2.AlertSettingsDetails
錯誤	errors	array of V2.AlertSettingsError

MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

名稱	路徑	類型	Description
資料	data	array of V2.CategoryDetails
錯誤	errors	array of V2.CategoryError

MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

名稱	路徑	類型	Description
資料	data	array of V2.TeamDutySettingsDetails
錯誤	errors	array of V2.TeamDutySettingsError

MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

名稱	路徑	類型	Description
資料	data	array of V2.TeamPermissions
錯誤	errors	array of V2.PermissionError

MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

名稱	路徑	類型	Description
資料	data	array of V2.UserDetails
錯誤	errors	array of V2.TeamUserError

MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

名稱	路徑	類型	Description
資料	data	array of V2.UserDutyDetails
錯誤	errors	array of V2.DutyChangeError

概覽活動

名稱	路徑	類型	Description
acknowledged警示	acknowledgedAlerts	array of string
alertId	alertId	string
categoryId	categoryId	string
closed警示	closedAlerts	array of string
創建時間	creationTime	date-time
eventSourceGroupId	eventSourceGroupId	string
eventSourceId	eventSourceId	string
事件來源TeamId	eventSourceTeamId	string
eventSourceType	eventSourceType	EventSourceTypes	0 = 無 1 = 電子郵件 2 = WebHook 3 = 指令碼 4 = 系統 5 = 手動 6 = 語音 7 = API
事件狀態	eventStatus	EventStatusCodes	0 = 無 1 = 處理中 2 = 已簽名 3 = 已過濾 4 = 已解決 5 = 已丟棄 6 = 已確認 7 = 隱藏 8 = 無規則已套用 9 = MultipleTarget狀態 1000 = 錯誤
識別碼	id	string
上次修改	lastModified	date-time
嚴重	severity	EventSeverities	0 = 低 1 = 主要 2 = 嚴重
團隊識別碼	teamId	string
收發簡訊	text	string
title	title	string

PagedResultsPublicContinuationToken

名稱	路徑	類型
nextPartitionKey	nextPartitionKey	string
nextRowKey	nextRowKey	string
nextTableName	nextTableName	string

PagedResultsPublic-1-概觀事件-

名稱	路徑	類型
continuationToken	continuationToken	PagedResultsPublicContinuationToken
有更多	hasMore	boolean
results	results	array of OverviewEvent

PagedResultsPublic-1-V2.AlertInfo-

名稱	路徑	類型
continuationToken	continuationToken	PagedResultsPublicContinuationToken
有更多	hasMore	boolean
results	results	array of V2.AlertInfo

PagedResultsPublic-1-V2.RemoteJob-

名稱	路徑	類型
continuationToken	continuationToken	PagedResultsPublicContinuationToken
有更多	hasMore	boolean
results	results	array of V2.RemoteJob

持續性通知模式

0 = 關閉
1 = 摘要

0 = 關閉
1 = 摘要

: integer

預付餘額資訊

名稱	路徑	類型
餘額	balance	integer
最新充值	latestTopUp	date-time
pendingTransactions	pendingTransactions	boolean

預付費設定資訊

名稱	路徑	類型
topUp金額	topUpAmount	integer
topUp啟用	topUpEnabled	boolean
充值限額	topUpLimit	integer

預付交易資訊

名稱	路徑	類型
金額	amount	integer
autoTopUpId	autoTopUpId	string
創建	created	date-time
由...創建	createdBy	string
貨幣	currency	string
modified	modified	date-time
套件代碼	packageCode	string
狀態	status	string
StatusCode	statusCode	integer
subscriptionId	subscriptionId	string
交易 ID	transactionId	string

時間表資訊

名稱	路徑	類型
結束	end	date-time
識別碼	id	string
options	options	integer
start	start	date-time
userId	userId	string

ScriptDescriptionData

名稱	路徑	類型
描述	description	string
名稱	name	string
scriptType	scriptType	string
簡短描述	shortDescription	string

ScriptInstance詳細資料

名稱	路徑	類型
config	config
customScript說明	customScriptDescription	string
自訂腳本名稱	customScriptName	string
enabled	enabled	boolean
事件模式	eventPattern
eventSourceId	eventSourceId	string
instanceId	instanceId	string
上次修改	lastModified	date-time
運行時信息	runtimeInformation	ScriptInstanceInfoRuntimeInformationModel
scriptId	scriptId	string
scriptName	scriptName	string
subscriptionId	subscriptionId	string
團隊識別碼	teamId	string
webhookUrl	webhookUrl	string

腳本實例資訊

名稱	路徑	類型
customScript說明	customScriptDescription	string
自訂腳本名稱	customScriptName	string
enabled	enabled	boolean
事件模式	eventPattern
eventSourceId	eventSourceId	string
instanceId	instanceId	string
上次修改	lastModified	date-time
運行時信息	runtimeInformation	ScriptInstanceInfoRuntimeInformationModel
scriptId	scriptId	string
scriptName	scriptName	string
subscriptionId	subscriptionId	string
團隊識別碼	teamId	string

ScriptInstanceInfoRuntimeInformationModel

名稱

路徑

類型

Description

執行階段狀態

runtimeStatus

ScriptInstanceInfoRuntimeStatus

0 = 未知
1 = 起始
2 = 確定
3 = 停止
4 = 已停止
-1 = 錯誤

runtimeStatus訊息

runtimeStatusMessage

string

ScriptInstanceInfoRuntime狀態

0 = 未知
1 = 起始
2 = 確定
3 = 停止
4 = 已停止
-1 = 錯誤

0 = 未知
1 = 起始
2 = 確定
3 = 停止
4 = 已停止
-1 = 錯誤

: integer

腳本本地化詳細資料

名稱	路徑	類型
config	config
資料	data	ScriptDescriptionData
語言	language	string

訂閱功能

名稱	路徑	類型
名稱	name	string
型別	type	integer
value	value	string

訂閱資訊

名稱	路徑	類型
branchId	branchId	string
country	country	string
貨幣	currency	string
externalAccountId	externalAccountId	string
識別碼	id	string
名稱	name	string
下一個計費	nextBilling	date-time
擁有者ID	ownerId	string
計劃代碼	planCode	string
plan狀態	planState	integer
referral已啟用	referralEnabled	boolean
狀態	status	integer

團隊類別選擇退出模式

0 = 無
1=停用
2 = 個人

0 = 無
1=停用
2 = 個人

: integer

TeamDuty總結資訊

名稱	路徑	類型
dutyAssist啟用	dutyAssistEnabled	boolean
職責摘要	dutySummaries	array of DutySummaryInfo
團隊識別碼	teamId	string

團隊資訊

名稱	路徑	類型
識別碼	id	string
影像最後修改	imageLastModified	date-time
成員標識碼	memberIds	array of string
名稱	name	string
setupProgress已啟用	setupProgressEnabled	boolean
subscriptionId	subscriptionId	string
timezone	timezone	string

團隊設定進度

名稱	路徑	類型
completed步驟	completedSteps	array of string
團隊識別碼	teamId	string
時間戳記	timestamp	date-time

用戶職責資訊

名稱	路徑	類型
last變更	lastChange	date-time
值班	onDuty	boolean
onManagerDuty	onManagerDuty	boolean
遲到的	overdue	boolean
團隊識別碼	teamId	string
userId	userId	string

使用者影像

名稱	路徑	類型
內容	content	byte
內容Dispostion	contentDispostion	string
content編碼	contentEncoding	string
內容類型	contentType	string
上次修改	lastModified	date-time
名稱	name	string

UserInfo

名稱	路徑	類型
顏色索引	colorIndex	integer
聯絡地址	contactAddresses	array of
職責資訊	dutyInfos	UserDutyInfo
externalAuthProvider	externalAuthProvider	string
識別碼	id	string
已停用	isDeactivated	boolean
是邀請	isInvite	boolean
isRemoteActionPinSet	isRemoteActionPinSet	boolean
最後看到	lastSeen	date-time
郵件	mail	string
名稱	name	string
角色ID	roleId	string
subscriptionId	subscriptionId	string
timeZone	timeZone	string
userImageLastModified	userImageLastModified	date-time

使用者授權資訊

名稱	路徑	類型
currentUsers	currentUsers	integer
是免費的	isFree	boolean
是審判	isTrial	boolean
授權使用者	licensedUsers	integer
計劃代碼	planCode	string

使用者權限

名稱	路徑	類型	Description
允許	allowed	boolean
使用權限	permission	string

使用者設定進度

名稱	路徑	類型
completed步驟	completedSteps	array of string
時間戳記	timestamp	date-time
userId	userId	string

V2 中。AlertAnnotation詳細資料

名稱	路徑	類型	Description
識別碼	id	string
團隊識別碼	teamId	string
收發簡訊	text	string
時間戳記	timestamp	date-time
型別	type	V2.AlertAnnotationTypes	0 = 無 1 = 文字 2 = 圖像
userId	userId	string

V2 中。AlertAnnotation類型

0 = 無
1 = 文字
2 = 圖像

0 = 無
1 = 文字
2 = 圖像

: integer

V2 中。警示附件資訊

名稱	路徑	類型
內容類型	contentType	string
識別碼	id	string
名稱	name	string

V2 中。AlertCategoryCounts詳細資料

名稱	路徑	類型
已確認	acknowledged	integer
categoryId	categoryId	string
關閉	closed	integer
未處理	unhandled	integer

V2 中。警示計數類型

1 = 團隊當前職責
2 = 團隊最後責任
3 = UserLastDuty變更
4 = 最後 24 小時

1 = 團隊當前職責
2 = 團隊最後責任
3 = UserLastDuty變更
4 = 最後 24 小時

: integer

V2 中。警示計數詳細資料

名稱	路徑	類型	Description
已確認	acknowledged	integer
類別計數	categoryCounts	array of V2.AlertCategoryCountsDetails
關閉	closed	integer
結束	end	date-time
上次修改	lastModified	date-time
start	start	date-time
subscriptionId	subscriptionId	string
團隊識別碼	teamId	string
型別	type	V2.AlertCountTypes	1 = 團隊當前職責 2 = 團隊最後責任 3 = UserLastDuty變更 4 = 最後 24 小時
類型字串	typeString	string
未處理	unhandled	integer
userId	userId	string

V2 中。AlertDeliveryStatusCodes

0 = 無
1 = 打開
2 = 失敗
4 = 已傳輸
6 = 已交付
8 = 受保護
9 = 濫用保護
22 = 部分失敗
24 = 部分傳輸
26 = 部分已交付
30 = 無一值班
31 = 無通知

0 = 無
1 = 打開
2 = 失敗
4 = 已傳輸
6 = 已交付
8 = 受保護
9 = 濫用保護
22 = 部分失敗
24 = 部分傳輸
26 = 部分已交付
30 = 無一值班
31 = 無通知

: integer

V2 中。AlertDeliveryStatus詳細資料

名稱

路徑

類型

Description

alertId

string

StatusCode

statusCode

V2.AlertDeliveryStatusCodes

0 = 無
1 = 打開
2 = 失敗
4 = 已傳輸
6 = 已交付
8 = 受保護
9 = 濫用保護
22 = 部分失敗
24 = 部分傳輸
26 = 部分已交付
30 = 無一值班
31 = 無通知

使用者交付狀態

userDeliveryStatus

array of V2.UserDeliveryStatus

V2 中。警示詳細資料

名稱	路徑	類型	Description
parameters	parameters	array of V2.EventParameterDetails
attachments	attachments	array of V2.AlertAttachmentInfo
categoryId	categoryId	string
升級	escalations	array of V2.AlertEscalationDetails
eventId	eventId	string
externalId（外部識別碼）	externalId	string
flags	flags	V2.AlertFlags	0 = 無 1 = 有附件 2 = 有註釋 4 = 被破壞 8 = 有位置資訊 16 = 升級至團隊 32 = 升級至管理員 64 = 建立者Escalation
歷程	history	V2.AlertHistoryInfo
識別碼	id	string
上次修改	lastModified	date-time
required致謝	requiredAcknowledgements	integer
嚴重	severity	V2.AlertSeverities	0 = 低 1 = 主要 2 = 嚴重
狀態	status	V2.AlertStatusDetails
subscriptionId	subscriptionId	string
團隊識別碼	teamId	string
收發簡訊	text	string
timeline條目	timelineEntries	array of
title	title	string
工作流程類型	workflowType	V2.AlertWorkflowTypes	0 = 無 1 = 使用者 2 = 團隊廣播 3 = 團隊升級 4 = 多重確認 5 = 多重確認緊急情況

V2 中。警示升級詳細資料

名稱	路徑	類型	Description
alertId	alertId	string
alert狀態	alertStatus	V2.AlertStatusCodes	0 = 無 1 = 打開 2 = 已確認 4 = 已關閉 8 = 不回覆 16 = 失敗 32 = 錯誤
esc類型	escType	V2.AlertEscalationType	0 = 無 1 = 經理 2 = 團隊
狀態	status	V2.AlertEscalationStatus	0 = 確定 1 = 進行中 2 = 目標無效 3 = 目標私人 4 = 已過濾 5 = 隱藏
團隊識別碼	teamId	string
團隊名稱	teamName	string
時間戳記	timestamp	date-time

V2 中。警示升級狀態

0 = 確定
1 = 進行中
2 = 目標無效
3 = 目標私人
4 = 已過濾
5 = 隱藏

0 = 確定
1 = 進行中
2 = 目標無效
3 = 目標私人
4 = 已過濾
5 = 隱藏

: integer

V2 中。警示升級類型

0 = 無
1 = 經理
2 = 團隊

0 = 無
1 = 經理
2 = 團隊

: integer

V2 中。警示旗標

0 = 無
1 = 有附件
2 = 有註釋
4 = 被破壞
8 = 有位置資訊
16 = 升級至團隊
32 = 升級至管理員
64 = 建立者Escalation

0 = 無
1 = 有附件
2 = 有註釋
4 = 被破壞
8 = 有位置資訊
16 = 升級至團隊
32 = 升級至管理員
64 = 建立者Escalation

: integer

V2 中。警報歷史資訊

名稱	路徑	類型
確認時間	acknowledgedAt	date-time
鳴謝	acknowledgements	array of string
關閉時間	closedAt	date-time
closedBy	closedBy	string
創建	created	date-time

V2 中。警報資訊

名稱	路徑	類型	Description
categoryId	categoryId	string
eventId	eventId	string
externalId（外部識別碼）	externalId	string
flags	flags	V2.AlertFlags	0 = 無 1 = 有附件 2 = 有註釋 4 = 被破壞 8 = 有位置資訊 16 = 升級至團隊 32 = 升級至管理員 64 = 建立者Escalation
歷程	history	V2.AlertHistoryInfo
識別碼	id	string
上次修改	lastModified	date-time
required致謝	requiredAcknowledgements	integer
嚴重	severity	V2.AlertSeverities	0 = 低 1 = 主要 2 = 嚴重
狀態	status	V2.AlertStatusDetails
subscriptionId	subscriptionId	string
團隊識別碼	teamId	string
收發簡訊	text	string
title	title	string
工作流程類型	workflowType	V2.AlertWorkflowTypes	0 = 無 1 = 使用者 2 = 團隊廣播 3 = 團隊升級 4 = 多重確認 5 = 多重確認緊急情況

V2 中。警示報告錯誤

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
團隊識別碼	teamId	string

V2 中。警示設定通道類型

0 = 無
1 = 推
2 = 語音
3 = 簡訊

0 = 無
1 = 推
2 = 語音
3 = 簡訊

: integer

V2 中。警示設定詳細資料

名稱	路徑	類型	Description
esc啟用	escEnabled	boolean
esc模式	escMode	AlertEscalationModes	0 = 經理 1 = 團隊
escRefId	escRefId	string
filterAction	filterAction	AlertFilterActions	0 = 抑制 1 = 隱藏 2 = 靜音
filter模式	filterMode	AlertFilterModes	0 = 關閉 1 = 白名單所有類別
notificationProfileOverrides	notificationProfileOverrides	array of V2.AlertSettingsNotificationProfileDetails
選擇退出	optOut	TeamCategoryOptOutModes	0 = 無 1=停用 2 = 個人
overrideNotificationProfiles	overrideNotificationProfiles	boolean
persNot間隔	persNotInterval	integer
persNot模式	persNotMode	PersistentNotificationModes	0 = 關閉 1 = 摘要
回應模式	responseMode	AlertResponseModes	2 = 單一確認 4 = 多重確認
回應時間	responseTime	integer
團隊識別碼	teamId	string

V2 中。AlertSettingsError

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
團隊識別碼	teamId	string

V2 中。警示設定通知設定檔詳細資料

名稱

路徑

類型

Description

通道

channel

V2.AlertSettingsChannelType

0 = 無
1 = 推
2 = 語音
3 = 簡訊

delay（以分鐘為單位）

delayInMinutes

integer

enabled

boolean

V2 中。警示嚴重性

0 = 低
1 = 主要
2 = 嚴重

0 = 低
1 = 主要
2 = 嚴重

: integer

V2 中。警示狀態代碼

0 = 無
1 = 打開
2 = 已確認
4 = 已關閉
8 = 不回覆
16 = 失敗
32 = 錯誤

0 = 無
1 = 打開
2 = 已確認
4 = 已關閉
8 = 不回覆
16 = 失敗
32 = 錯誤

: integer

V2 中。警示狀態詳細資料

名稱

路徑

類型

Description

alertDelivery狀態

alertDeliveryStatus

V2.AlertDeliveryStatusDetails

StatusCode

statusCode

V2.AlertStatusCodes

0 = 無
1 = 打開
2 = 已確認
4 = 已關閉
8 = 不回覆
16 = 失敗
32 = 錯誤

V2 中。警示工作流程類型

0 = 無
1 = 使用者
2 = 團隊廣播
3 = 團隊升級
4 = 多重確認
5 = 多重確認緊急情況

0 = 無
1 = 使用者
2 = 團隊廣播
3 = 團隊升級
4 = 多重確認
5 = 多重確認緊急情況

: integer

V2 中。AlertingPatternChannelType

0 = 無
1 = 推
2 = 語音
3 = 簡訊

0 = 無
1 = 推
2 = 語音
3 = 簡訊

: integer

V2 中。警示模式詳細資料

名稱	路徑	類型
categories	categories	array of string
escalation設定	escalationSettings	V2.AlertingPatternEscalationSettings
識別碼	id	string
名稱	name	string
notificationProfileOverrides	notificationProfileOverrides	array of V2.AlertingPatternNotificationProfileDetails
overrideEscalationSettings	overrideEscalationSettings	boolean
overrideNotificationProfiles	overrideNotificationProfiles	boolean
overrideResponseSettings	overrideResponseSettings	boolean
回應設定	responseSettings	V2.AlertingPatternResponseSettings
抑制簽名	suppressSignl	boolean
時間槽	timeSlots	array of V2.TimeSlotDetails

V2 中。AlertingPatternEscalation設定

名稱

路徑

類型

Description

enabled

boolean

mode

AlertEscalationModes

0 = 經理
1 = 團隊

參考標識符

referenceId

string

V2 中。AlertingPatternNotificationProfile詳細資料

名稱

路徑

類型

Description

通道

channel

V2.AlertingPatternChannelType

0 = 無
1 = 推
2 = 語音
3 = 簡訊

delay（以分鐘為單位）

delayInMinutes

integer

enabled

boolean

V2 中。AlertingPatternResponse設定

名稱

路徑

類型

Description

回應模式

responseMode

AlertResponseModes

2 = 單一確認
4 = 多重確認

回應時間

responseTime

integer

V2 中。圖說文字範本詳細資料

名稱	路徑	類型	Description
categoryId	categoryId	string
externalId（外部識別碼）	externalId	string
識別碼	id	string
位置	location	string
名稱	name	string
主題	subject	string
目標所有團隊	targetAllTeams	boolean
targetTeamId	targetTeamId	string
收發簡訊	text	string
工作流程類型	workflowType	V2.CalloutTemplateWorkflowType	0 = AsConfiguredInTeam 2 = 團隊廣播 4 = 多重確認 5 = 多重確認緊急情況

V2 中。圖說文字範本工作流程類型

0 = AsConfiguredInTeam
2 = 團隊廣播
4 = 多重確認
5 = 多重確認緊急情況

0 = AsConfiguredInTeam
2 = 團隊廣播
4 = 多重確認
5 = 多重確認緊急情況

: integer

V2 中。類別增強細節

名稱	路徑	類型	Description
enabled	enabled	boolean
識別碼	id	string
名稱	name	string
型別	type	V2.CategoryAugmentationType	0 = 參數 1 = 主語 2 = 文字 3 = 位置
value	value	string

V2 中。類別增強類型

0 = 參數
1 = 主語
2 = 文字
3 = 位置

0 = 參數
1 = 主語
2 = 文字
3 = 位置

: integer

V2 中。類別詳情

名稱	路徑	類型	Description
augmentations	augmentations	array of V2.CategoryAugmentationDetails
color	color	string
擴充	enrichments	array of V2.CategoryEnrichmentDetails
識別碼	id	string
圖像名稱	imageName	string
isDefault	isDefault	boolean
關鍵字比對	keywordMatching	V2.KeywordMatchingType	0 = 任何 1 = 全部
關鍵字	keywords	array of string
關鍵字排除	keywordsExcluded	array of string
名稱	name	string
options	options	V2.CategoryOptions	0 = 無 1 = 隱藏 2 = 拒絕刪除 4 = 隱藏選擇退出 8 = 隱藏關鍵字
順序	order	integer
團隊識別碼	teamId	string

V2 中。類別豐富細節

名稱	路徑	類型	Description
識別碼	id	string
名稱	name	string
型別	type	V2.CategoryEnrichmentType	0 = 參數 1 = 超連結
value	value	string

V2 中。類別豐富類型

0 = 參數
1 = 超連結

0 = 參數
1 = 超連結

: integer

V2 中。類別錯誤

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
團隊識別碼	teamId	string

V2 中。類別選項

0 = 無
1 = 隱藏
2 = 拒絕刪除
4 = 隱藏選擇退出
8 = 隱藏關鍵字

0 = 無
1 = 隱藏
2 = 拒絕刪除
4 = 隱藏選擇退出
8 = 隱藏關鍵字

: integer

V2 中。通道類型

0 = 無
1 = 推
2 = 電子郵件
4 = 機器人
8 = 語音
16 = 簡訊

0 = 無
1 = 推
2 = 電子郵件
4 = 機器人
8 = 語音
16 = 簡訊

: integer

V2 中。職責變更錯誤

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
團隊識別碼	teamId	string
userId	userId	string

V2 中。職責錯誤

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
團隊識別碼	teamId	string

V2 中。工作模式

0 = 無
1 = 主要
100 = 經理

0 = 無
1 = 主要
100 = 經理

: integer

V2 中。活動詳情

名稱	路徑	類型	Description
parameters	parameters	array of V2.EventParameterDetails
acknowledged警示	acknowledgedAlerts	array of string
closed警示	closedAlerts	array of string
創建時間	creationTime	date-time
eventSourceGroupId	eventSourceGroupId	string
eventSourceId	eventSourceId	string
事件來源TeamId	eventSourceTeamId	string
eventSourceType	eventSourceType	V2.EventSourceTypes	0 = 無 1 = 電子郵件 2 = WebHook 3 = 指令碼 4 = 系統 5 = 手動 6 = 語音 7 = API
事件狀態	eventStatus	V2.EventStatusCodes	0 = 無 1 = 處理中 2 = 已簽名 3 = 已過濾 4 = 已解決 5 = 已丟棄 6 = 已確認 7 = 隱藏 8 = 無規則已套用 9 = MultipleTarget狀態 1000 = 錯誤
externalId（外部識別碼）	externalId	string
從	from	string
識別碼	id	string
上次修改	lastModified	date-time
嚴重	severity	V2.EventSeverities	0 = 低 1 = 主要 2 = 嚴重
targets	targets	array of V2.EventTargetDetails
收發簡訊	text	string
title	title	string

V2 中。EventParameter詳細資料

名稱	路徑	類型	Description
識別碼	id	string
名稱	name	string
options	options	V2.EventParameterOptions	0 = 無 1 = 從分類中排除
順序	order	integer
型別	type	V2.EventParameterTypes	0 = 無 1 = 物件 2 = 陣列 3 = 建構函式 4 = 屬性 5 = 註解 6 = 整數 7 = 浮點 8 = 字串 9 = 布林值 10 = 空值 11 = 未定義 12 = 日期 13 = 原始 14 = 位元組 15 = 引導 16 = 烏里 17 = 時間跨度 100 = HTML
value	value	string

V2 中。事件參數選項

0 = 無
1 = 從分類中排除

0 = 無
1 = 從分類中排除

: integer

V2 中。EventParameter類型

0 = 無
1 = 物件
2 = 陣列
3 = 建構函式
4 = 屬性
5 = 註解
6 = 整數
7 = 浮點
8 = 字串
9 = 布林值
10 = 空值
11 = 未定義
12 = 日期
13 = 原始
14 = 位元組
15 = 引導
16 = 烏里
17 = 時間跨度
100 = HTML

0 = 無
1 = 物件
2 = 陣列
3 = 建構函式
4 = 屬性
5 = 註解
6 = 整數
7 = 浮點
8 = 字串
9 = 布林值
10 = 空值
11 = 未定義
12 = 日期
13 = 原始
14 = 位元組
15 = 引導
16 = 烏里
17 = 時間跨度
100 = HTML

: integer

V2 中。事件嚴重性

0 = 低
1 = 主要
2 = 嚴重

0 = 低
1 = 主要
2 = 嚴重

: integer

V2 中。EventSourceEndpointError

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
團隊識別碼	teamId	string

V2 中。事件來源類型

0 = 無
1 = 電子郵件
2 = WebHook
3 = 指令碼
4 = 系統
5 = 手動
6 = 語音
7 = API

0 = 無
1 = 電子郵件
2 = WebHook
3 = 指令碼
4 = 系統
5 = 手動
6 = 語音
7 = API

: integer

V2 中。事件狀態代碼

0 = 無
1 = 處理中
2 = 已簽名
3 = 已過濾
4 = 已解決
5 = 已丟棄
6 = 已確認
7 = 隱藏
8 = 無規則已套用
9 = MultipleTarget狀態
1000 = 錯誤

0 = 無
1 = 處理中
2 = 已簽名
3 = 已過濾
4 = 已解決
5 = 已丟棄
6 = 已確認
7 = 隱藏
8 = 無規則已套用
9 = MultipleTarget狀態
1000 = 錯誤

: integer

V2 中。事件目標詳細資料

名稱	路徑	類型	Description
alertId	alertId	string
categoryId	categoryId	string
創建時間	creationTime	date-time
distributionId	distributionId	string
eventId	eventId	string
事件目標狀態	eventTargetStatus	V2.EventTargetStatusCode	0 = 無 1 = 處理中 2 = 已簽名 3 = 已過濾 4 = 已解決 5 = 已丟棄 6 = 已確認 7 = 隱藏 1000 = 錯誤
識別碼	id	string
上次修改	lastModified	date-time
團隊識別碼	teamId	string

V2 中。事件目標狀態代碼

0 = 無
1 = 處理中
2 = 已簽名
3 = 已過濾
4 = 已解決
5 = 已丟棄
6 = 已確認
7 = 隱藏
1000 = 錯誤

0 = 無
1 = 處理中
2 = 已簽名
3 = 已過濾
4 = 已解決
5 = 已丟棄
6 = 已確認
7 = 隱藏
1000 = 錯誤

: integer

V2 中。節日詳情

名稱	路徑	類型	Description
天	day	integer
個月	month	V2.Month	0 = 未設定 1 = 一月 2 = 二月 3 = 三月 4 = 四月 5 = 五月 6 = 六月 7 = 七月 8 = 八月 9 = 九月 10 = 十月 11 = 十一月 12 = 十二月
重複	repeating	boolean
年	year	integer

V2 中。邀請結果

名稱	路徑	類型
錯誤代碼	errorCode	integer
errorMessage	errorMessage	string
invited用戶	invitedUser	V2.InvitedUserInfo
勝	success	boolean

V2 中。受邀用戶信息

名稱	路徑	類型	Description
郵件地址	mailAddress	string
角色ID	roleId	string
狀態	status	V2.UserStatus	0 = 無 1 = 已刪除 2 = 受邀 3 = 作用中
userId	userId	string

V2 中。關鍵字比對類型

0 = 任何
1 = 全部

0 = 任何
1 = 全部

: integer

V2 中。月

0 = 未設定
1 = 一月
2 = 二月
3 = 三月
4 = 四月
5 = 五月
6 = 六月
7 = 七月
8 = 八月
9 = 九月
10 = 十月
11 = 十一月
12 = 十二月

0 = 未設定
1 = 一月
2 = 二月
3 = 三月
4 = 四月
5 = 五月
6 = 六月
7 = 七月
8 = 八月
9 = 九月
10 = 十月
11 = 十一月
12 = 十二月

: integer

V2 中。NotificationProfile詳細資料

名稱	路徑	類型	Description
通道	channel	V2.ChannelType	0 = 無 1 = 推 2 = 電子郵件 4 = 機器人 8 = 語音 16 = 簡訊
delay（以分鐘為單位）	delayInMinutes	integer
enabled	enabled	boolean
options	options	integer
persistent	persistent	boolean

V2 中。OverlappingTimeSlots詳細資料

名稱	路徑	類型	Description
refId	refId	string
時間槽	timeSlots	array of V2.TimeSlotDetails

V2 中。許可錯誤

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
團隊識別碼	teamId	string

V2 中。電話號碼驗證狀態

0 = 未驗證
1 = 已驗證
2 = 國家/地區不支援

0 = 未驗證
1 = 已驗證
2 = 國家/地區不支援

: integer

V2 中。RemoteAction定義詳細資料

名稱	路徑	類型	Description
parameters	parameters	array of V2.RemoteActionDefinitionParameterDetails
創建於	createdAt	date-time
描述	description	string
executorService	executorService	string
externalId（外部識別碼）	externalId	string
識別碼	id	string
名稱	name	string
StatusCode	statusCode	V2.RemoteActionDefinitionStatus	0 = 已停用 1 = 已啟用 2 = 無效
狀態說明	statusDescription	string
型別	type	V2.RemoteActionTypes	0 = 未知 1 = 腳本 2 = 企業警示 3 = Webhook
版本	version	integer

V2 中。RemoteActionDefinitionParameter詳細資料

名稱	路徑	類型	Description
控制類型	controlType	V2.RemoteActionParameterControlTypes	0 = 文字 1 = 多行文字 2 = 整數 3 = 雙倍 4 = 布爾值 5 = 時間 6 = 日期 7 = 時區 8 = 密碼 9 = 密碼 10 = 單一選擇 11 = 多項選擇 12 = 建議
defaultValue	defaultValue	string
描述	description	string
顯示名稱	displayName	string
名稱	name	string
options	options	V2.RemoteActionParameterOptions	0 = 無 1 = 必要 2 = 鎖定 4 = 加密
順序	order	integer
values	values	array of string

V2 中。RemoteActionDefinition狀態

0 = 已停用
1 = 已啟用
2 = 無效

0 = 已停用
1 = 已啟用
2 = 無效

: integer

V2 中。RemoteAction詳細資料

名稱	路徑	類型	Description
parameters	parameters	array of V2.RemoteActionParameter
訪問	access	array of V2.RemoteActionTeamAccessDetails
創建於	createdAt	date-time
當前校長	currentPrincipal	V2.RemoteActionPrincipalAccessDetails
定義Id	definitionId	string
definitionVersion	definitionVersion	integer
描述	description	string
enabled	enabled	boolean
executorService	executorService	string
externalId（外部識別碼）	externalId	string
識別碼	id	string
名稱	name	string
StatusCode	statusCode	V2.RemoteActionStatus	0 = 已停用 1 = 已啟用 2 = 無效 4 = 提供者已停用
狀態說明	statusDescription	string
subscriptionId	subscriptionId	string
團隊識別碼	teamId	string
型別	type	V2.RemoteActionTypes	0 = 未知 1 = 腳本 2 = 企業警示 3 = Webhook

V2 中。遠端動作資訊

名稱	路徑	類型	Description
訪問	access	array of V2.RemoteActionTeamAccessDetails
創建於	createdAt	date-time
當前校長	currentPrincipal	V2.RemoteActionPrincipalAccessDetails
定義Id	definitionId	string
描述	description	string
enabled	enabled	boolean
識別碼	id	string
名稱	name	string
StatusCode	statusCode	V2.RemoteActionStatus	0 = 已停用 1 = 已啟用 2 = 無效 4 = 提供者已停用
狀態說明	statusDescription	string
subscriptionId	subscriptionId	string
團隊識別碼	teamId	string
型別	type	V2.RemoteActionTypes	0 = 未知 1 = 腳本 2 = 企業警示 3 = Webhook

V2 中。RemoteAction參數

名稱	路徑	類型	Description
控制類型	controlType	V2.RemoteActionParameterControlTypes	0 = 文字 1 = 多行文字 2 = 整數 3 = 雙倍 4 = 布爾值 5 = 時間 6 = 日期 7 = 時區 8 = 密碼 9 = 密碼 10 = 單一選擇 11 = 多項選擇 12 = 建議
顯示名稱	displayName	string
名稱	name	string
options	options	V2.RemoteActionParameterOptions	0 = 無 1 = 必要 2 = 鎖定 4 = 加密
順序	order	integer
value	value	string
values	values	array of string

V2 中。RemoteActionParameterControl類型

0 = 文字
1 = 多行文字
2 = 整數
3 = 雙倍
4 = 布爾值
5 = 時間
6 = 日期
7 = 時區
8 = 密碼
9 = 密碼
10 = 單一選擇
11 = 多項選擇
12 = 建議

0 = 文字
1 = 多行文字
2 = 整數
3 = 雙倍
4 = 布爾值
5 = 時間
6 = 日期
7 = 時區
8 = 密碼
9 = 密碼
10 = 單一選擇
11 = 多項選擇
12 = 建議

: integer

V2 中。RemoteAction參數選項

0 = 無
1 = 必要
2 = 鎖定
4 = 加密

0 = 無
1 = 必要
2 = 鎖定
4 = 加密

: integer

V2 中。RemoteActionPrincipalAccess詳細資料

名稱	路徑	類型	Description
可以編輯	canEdit	boolean
可以執行	canExecute	boolean

V2 中。RemoteAction狀態

0 = 已停用
1 = 已啟用
2 = 無效
4 = 提供者已停用

0 = 已停用
1 = 已啟用
2 = 無效
4 = 提供者已停用

: integer

V2 中。RemoteActionTeamAccess詳細資料

名稱	路徑	類型
可以編輯	canEdit	boolean
可以執行	canExecute	boolean
團隊識別碼	teamId	string

V2 中。RemoteAction類型

0 = 未知
1 = 腳本
2 = 企業警示
3 = Webhook

0 = 未知
1 = 腳本
2 = 企業警示
3 = Webhook

: integer

V2 中。遠程工作

名稱	路徑	類型	Description
parameters	parameters	array of V2.RemoteJobParameter
actionId	actionId	string
activatedAt	activatedAt	date-time
創建於	createdAt	date-time
創作者資訊	creatorInfo	V2.RemoteJobCreatorDetails
定義Id	definitionId	string
externalId（外部識別碼）	externalId	string
識別碼	id	string
最後更新	lastUpdate	date-time
options	options	V2.RemoteJobOptions	0 = 無
開始時間	startedAt	date-time
StatusCode	statusCode	V2.RemoteJobStatusCodes	0 = 無 1 = 擱置中 2 = 就緒 4 = 跑步 8 = 已執行 16 = 錯誤
狀態說明	statusDescription	string
狀態詳情	statusDetails	string
型別	type	V2.RemoteActionTypes	0 = 未知 1 = 腳本 2 = 企業警示 3 = Webhook

V2 中。RemoteJobCreator詳細資料

名稱

路徑

類型

Description

參考標識符

referenceId

string

referenceName

string

型別

type

V2.RemoteJobCreatorType

0 = 無
1 = 使用者
2 = ApiKey
3 = 系統

V2 中。RemoteJobCreatorType

0 = 無
1 = 使用者
2 = ApiKey
3 = 系統

0 = 無
1 = 使用者
2 = ApiKey
3 = 系統

: integer

V2 中。RemoteJob選項

0 = 無

0 = 無

: integer

V2 中。RemoteJob參數

名稱	路徑	類型	Description
名稱	name	string
value	value	string

V2 中。RemoteJobStatus代碼

0 = 無
1 = 擱置中
2 = 就緒
4 = 跑步
8 = 已執行
16 = 錯誤

0 = 無
1 = 擱置中
2 = 就緒
4 = 跑步
8 = 已執行
16 = 錯誤

: integer

V2 中。時間表詳情

名稱	路徑	類型
結束	end	date-time
識別碼	id	string
options	options	integer
start	start	date-time
團隊識別碼	teamId	string
userId	userId	string

V2 中。TeamDuty設定詳細資料

名稱	路徑	類型
自動貼齊已啟用	autosnapEnabled	boolean
dutyAssistant已啟用	dutyAssistantEnabled	boolean
dutyChangeNotifications已啟用	dutyChangeNotificationsEnabled	boolean
職責長度	dutyLength	integer
交接日期	handoverDate	date-time
交接時間	handoverTime	integer
交接工作日	handoverWeekDay	integer
minMemberOnDuty	minMemberOnDuty	integer
scheduling已啟用	schedulingEnabled	boolean
shiftReportCarbonCopy郵件	shiftReportCarbonCopyMail	string
已啟用 shiftReportEnabled	shiftReportEnabled	boolean
團隊識別碼	teamId	string
timezone	timezone	string

V2 中。TeamDutySettingsError

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
團隊識別碼	teamId	string

V2 中。TeamDutySummaryError

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
userId	userId	string

V2 中。TeamHoliday詳情

名稱	路徑	類型	Description
假期	holidays	array of V2.HolidayDetails
團隊識別碼	teamId	string

V2 中。團隊影像詳細資料

名稱	路徑	類型
內容	content	byte
內容Dispostion	contentDispostion	string
content編碼	contentEncoding	string
內容類型	contentType	string
上次修改	lastModified	date-time
名稱	name	string

V2 中。團隊成員資格詳細資料

名稱	路徑	類型	Description
郵件地址	mailAddress	string
成員自	memberSince	date-time
角色ID	roleId	string
狀態	status	V2.UserStatus	0 = 無 1 = 已刪除 2 = 受邀 3 = 作用中
團隊識別碼	teamId	string
userId	userId	string

V2 中。團隊權限

名稱	路徑	類型	Description
使用權限	permissions	array of UserPermission
團隊識別碼	teamId	string

V2 中。Team隱私設定詳細資料

名稱	路徑	類型
隱藏聯絡人地址	hideContactAddresses	boolean
隱藏職責數據	hideDutyData	boolean
隱藏升級	hideForEscalation	boolean
團隊識別碼	teamId	string

V2 中。團隊公開詳情

名稱	路徑	類型
識別碼	id	string
名稱	name	string
隱私設定	privacySettings	V2.TeamPrivacySettingsDetails

V2 中。TeamUser錯誤

名稱	路徑	類型
錯誤代碼	errorCode	integer
錯誤描述	errorDescription	string
團隊識別碼	teamId	string

V2 中。時間時段詳細資料

名稱	路徑	類型
結束	end	V2.WeekTimeDetails
識別碼	id	string
start	start	V2.WeekTimeDetails

V2 中。TimeSlotValidationResultDetails

名稱	路徑	類型
是重疊	isOverlapping	boolean
項目	item	V2.TimeSlotDetails
overlappingTimeSlots	overlappingTimeSlots	array of V2.OverlappingTimeSlotsDetails
有效	valid	boolean

V2 中。使用者傳遞狀態

名稱

路徑

類型

Description

StatusCode

statusCode

V2.UserDeliveryStatusCodes

0 = 無
1 = 打開
2 = 失敗
4 = 已傳輸
6 = 已交付
8 = 受保護
9 = 濫用保護
24 = 部分傳輸
26 = 部分已交付
30 = 不負責
31 = 類別選擇退出
32 = 無訊息已傳送

userId

string

V2 中。UserDeliveryStatusCodes

0 = 無
1 = 打開
2 = 失敗
4 = 已傳輸
6 = 已交付
8 = 受保護
9 = 濫用保護
24 = 部分傳輸
26 = 部分已交付
30 = 不負責
31 = 類別選擇退出
32 = 無訊息已傳送

0 = 無
1 = 打開
2 = 失敗
4 = 已傳輸
6 = 已交付
8 = 受保護
9 = 濫用保護
24 = 部分傳輸
26 = 部分已交付
30 = 不負責
31 = 類別選擇退出
32 = 無訊息已傳送

: integer

V2 中。使用者詳細資料

名稱	路徑	類型
顏色索引	colorIndex	integer
聯絡地址	contactAddresses	array of
職責資訊	dutyInfos	array of V2.UserDutyDetails
externalAuthProvider	externalAuthProvider	string
識別碼	id	string
已停用	isDeactivated	boolean
是邀請	isInvite	boolean
最後看到	lastSeen	date-time
郵件	mail	string
名稱	name	string
remoteActionPinSet	remoteActionPinSet	boolean
subscriptionId	subscriptionId	string
timeZone	timeZone	string
userImageLastModified	userImageLastModified	date-time

V2 中。用戶職責詳情

名稱	路徑	類型	Description
職責模式	dutyMode	V2.DutyModes	0 = 無 1 = 主要 100 = 經理
last變更	lastChange	date-time
值班時間	onDutyTime	integer
遲到的	overdue	boolean
團隊識別碼	teamId	string
userId	userId	string

V2 中。使用者地區設定回應詳細資料

名稱	路徑	類型
識別碼	id	string
語言	language	string
timeZone	timeZone	string

V2 中。使用者電話號碼詳細資料

名稱

路徑

類型

Description

countryCode （國家代碼）

countryCode

string

電話號碼

phoneNumber

string

驗證狀態

validationStatus

V2.PhoneNumberValidationStatus

0 = 未驗證
1 = 已驗證
2 = 國家/地區不支援

V2 中。使用者狀態

0 = 無
1 = 已刪除
2 = 受邀
3 = 作用中

0 = 無
1 = 已刪除
2 = 受邀
3 = 作用中

: integer

V2 中。WeekTime細節

名稱

路徑

類型

Description

小時

hour

integer

紀要

minutes

integer

平日

weekday

V2.Weekday

0 = 假日
1 = 星期一
2 = 星期二
3 = 星期三
4 = 星期四
5 = 星期五
6 = 星期六
7 = 星期日

V2 中。平日

0 = 假日
1 = 星期一
2 = 星期二
3 = 星期三
4 = 星期四
5 = 星期五
6 = 星期六
7 = 星期日

0 = 假日
1 = 星期一
2 = 星期二
3 = 星期三
4 = 星期四
5 = 星期五
6 = 星期六
7 = 星期日

: integer

Webhook資訊

名稱	路徑	類型
描述	description	string
enabled	enabled	boolean
ext網址	extUrl	string
識別碼	id	string
名稱	name	string
subId	subId	string
團隊識別碼	teamId	string

字串

這是基本資料類型「string」。

二進位

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

共用方式為

SIGNL4 - 移動警報

先決條件

如何取得認證

開始使用連接器

已知問題與限制

常見錯誤和補救措施

FAQ

正在建立連線

預設

節流限制

動作

下載具有特定檔案名稱的值班報告

參數

傳回

依 ID 取得 Webhook

參數

傳回

依使用者 ID 取得值班狀態

參數

傳回

依其識別碼傳回清查指令碼

參數

傳回

依識別碼刪除 Webhook

參數

依識別碼取得事件來源

參數

傳回

依識別碼取得使用者

參數

傳回

依識別碼更新 Webhook

參數

傳回

停用 webHook 的能力

參數

傳回

停用指定的指令碼執行個體

參數

傳回

傳回 SIGNL4 小組的所有指令碼實例

參數

傳回

傳回具有指定 ID 的值班表資訊

參數

傳回

傳回從「異動日誌」分頁的遠端工作

參數

傳回

傳回所有可用的庫存指令碼

傳回

傳回所有庫存指令碼

參數

傳回

傳回所有計劃排程的相關資訊

參數

傳回

傳回指定指令碼執行個體的所有相關資訊

參數

傳回

傳回指定訂用帳戶的功能

參數

傳回

傳回訂閱的頻道價格資訊

參數

傳回

傳回遠端動作

參數

傳回

傳回遠端動作

參數

傳回

傳送事件

參數

傳回

儲存多個排程

參數

傳回

刪除事件來源