共用方式為

Envoy （預覽版）

Envoy 連接器，可讓您將 Envoy 帳戶 （我們的 REST API 端點） 連線到任何其他連接器。 例如，在 Envoy 中使用 Microsoft Excel Online 試算表中的詳細資訊建立大量邀請。

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

服務 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）
連絡人​​
名稱 Envoy 支援團隊
URL https://envoy.help/
Email hi@envoy.com
連接器中繼資料
Publisher 特使公司
網站 https://envoy.com/
隱私策略 https://envoy.com/privacypolicy/
類別 商業智能;資料

在 2.0 版中，您也可以使用 Envoy 邀請建立作為觸發器。

先決條件

若要使用此連接器，您需要具有使用者名稱和密碼的 Envoy 帳戶。 若要觸發功能，您也必須安裝 Envoy 整合「Microsoft Flow」。

如何取得認證

若要向 Envoy 進行驗證，您需要 Envoy 使用者名稱和密碼。

若要觸發功能，您需要在 Envoy 中「Microsoft Flow」整合設定的步驟 2 期間提供給您的安裝權杖。

已知問題與限制

目前，唯一可用的觸發器是邀請建立。 我們預計在不久的將來會添加更多觸發器。

正在建立連線

連接器支援下列驗證類型：
預設值 建立連線的參數。 所有區域 不可共享

預設

適用：所有地區

建立連線的參數。

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

名稱 類型 Description 為必填項目
使用者名稱 securestring 此 API 的使用者名稱 對
密碼 securestring 此 API 的密碼 對

節流限制

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

動作

取得公司資訊

檢索公司周圍的資訊 （GET）
取得地點

擷取位置的 GET 要求
取得封鎖清單篩選器

GET 要求來擷取封鎖清單篩選器。
取得流程

GET 請求，以擷取您所在位置的流程相關資訊。
取得邀請

GET 請求，以根據篩選擷取邀請資訊。
建立邀請

這是建立邀請的 POST 要求
新增封鎖清單篩選器

POST 請求以新增封鎖清單過濾器
更新一個邀請

PATCH 要求更新邀請的資訊。
獲取員工名單

GET 要求擷取員工清單
獲得一份邀請

GET 請求以擷取單一邀請的相關資訊。
獲得一次參賽

GET 要求來擷取單一專案的相關資訊。

取得公司資訊

作業識別碼：
getCompanyInfo

檢索公司周圍的資訊 （GET）

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

接受

傳回

名稱 路徑 類型 Description
總計
 meta.total integer

總計
limit
 meta.limit integer

limit
位移
 meta.offset integer

位移
資料
 data array of object

資料
識別碼
 data.id string

識別碼
型別
 data.type string

型別
名稱
 data.attributes.name string

名稱
計劃意圖
 data.attributes.plan-intent string

計劃意圖
購買意圖
 data.attributes.buy-intent boolean

購買意圖
已啟用通話
 data.attributes.call-enabled boolean

已啟用通話
支援 AppleTV
 data.attributes.appletv-enabled boolean

支援 AppleTV
SAML 連線
 data.attributes.saml-connected boolean

SAML 連線
活動中
 data.attributes.active boolean

活動中
員工同步狀態
 data.attributes.employees-sync-state string

員工同步狀態
員工同步提供者
 data.attributes.employees-sync-provider string

員工同步提供者
員工最後同步時間
 data.attributes.employees-last-sync-at string

員工最後同步時間
創建時間
 data.attributes.created-at string

創建時間
更新時間
 data.attributes.updated-at string

更新時間
上線狀態
 data.attributes.onboarding-status string

上線狀態
上線位置計數
 data.attributes.onboarding-locations-count string

上線位置計數
是測試版
 data.attributes.is-beta boolean

是測試版
臨時插件
 data.attributes.adhoc-plugins array of

臨時插件
快取位置數量
 data.attributes.cached-locations-quantity integer

快取位置數量
型別
 data.relationships.subscription.data.type string

型別
識別碼
 data.relationships.subscription.data.id string

識別碼
型別
 data.relationships.deliveries-subscription.data.type string

型別
識別碼
 data.relationships.deliveries-subscription.data.id string

識別碼
資料
 data.relationships.contracts.data array of object

資料
型別
 data.relationships.contracts.data.type string

型別
識別碼
 data.relationships.contracts.data.id string

識別碼
資料
 data.relationships.administrators.data array of object

資料
型別
 data.relationships.administrators.data.type string

型別
識別碼
 data.relationships.administrators.data.id string

識別碼
資料
 data.relationships.locations.data array of object

資料
型別
 data.relationships.locations.data.type string

型別
識別碼
 data.relationships.locations.data.id string

識別碼
型別
 data.relationships.saml.data.type string

型別
識別碼
 data.relationships.saml.data.id string

識別碼
自我
 links.self string

自我
先
 links.first string

先
last
 links.last string

last

取得地點

作業識別碼：
getLocationInfo

擷取位置的 GET 要求

參數

名稱 機碼 必要 類型 Description
接受
 Accept string

接受

傳回

名稱 路徑 類型 Description
資料
 data array of object

資料
識別碼
 data.id string

識別碼
型別
 data.type string

型別
自我
 data.links.self string

自我
address
 data.attributes.address string

address
地址行一
 data.attributes.address-line-one string

地址行一
地址行二
 data.attributes.address-line-two string

地址行二
午夜自動登出
 data.attributes.auto-sign-out-at-midnight boolean

午夜自動登出
自動登出分鐘數
 data.attributes.auto-sign-out-minutes string

自動登出分鐘數
city
 data.attributes.city string

city
公司名稱覆寫
 data.attributes.company-name-override string

公司名稱覆寫
停用
 data.attributes.disabled boolean

停用
員工-csv-上傳狀態
 data.attributes.employees-csv-upload-status string

員工-csv-上傳狀態
員工同步訊息
 data.attributes.employees-sync-message string

員工同步訊息
已啟用後援通知
 data.attributes.fallback-notifications-enabled boolean

已啟用後援通知
預先註冊 - 已啟用
 data.attributes.pre-registration-required-enabled boolean

預先註冊 - 已啟用
緯度
 data.attributes.latitude float

緯度
地區設定
 data.attributes.locale string

地區設定
標誌小網址
 data.attributes.logo-small-url string

標誌小網址
標誌拇指網址
 data.attributes.logo-thumb-url string

標誌拇指網址
標誌網址
 data.attributes.logo-url string

標誌網址
經度
 data.attributes.longitude float

經度
名稱
 data.attributes.name string

名稱
已啟用印表機通知
 data.attributes.printer-notifications-enabled boolean

已啟用印表機通知
啟用多種語言
 data.attributes.multiple-languages-enabled boolean

啟用多種語言
啟用地區設定
 data.attributes.enabled-locales array of

啟用地區設定
狀態
 data.attributes.state string

狀態
timezone
 data.attributes.timezone string

timezone
壓縮檔
 data.attributes.zip string

壓縮檔
平均每月訪客
 data.attributes.average-monthly-visitors float

平均每月訪客
創建時間
 data.attributes.created-at string

創建時間
最後進入時間
 data.attributes.last-entry-at string

最後進入時間
更新時間
 data.attributes.updated-at string

更新時間
自我
 data.relationships.company.links.self string

自我
相關
 data.relationships.company.links.related string

相關
自我
 data.relationships.device-config.links.self string

自我
相關
 data.relationships.device-config.links.related string

相關
自我
 data.relationships.gdpr-configuration.links.self string

自我
相關
 data.relationships.gdpr-configuration.links.related string

相關
自我
 data.relationships.printer.links.self string

自我
相關
 data.relationships.printer.links.related string

相關
自我
 data.relationships.devices.links.self string

自我
相關
 data.relationships.devices.links.related string

相關
自我
 data.relationships.employees.links.self string

自我
相關
 data.relationships.employees.links.related string

相關
自我
 data.relationships.fallback-contacts.links.self string

自我
相關
 data.relationships.fallback-contacts.links.related string

相關
自我
 data.relationships.flows.links.self string

自我
相關
 data.relationships.flows.links.related string

相關
自我
 data.relationships.locations-setup-guide-steps.links.self string

自我
相關
 data.relationships.locations-setup-guide-steps.links.related string

相關
自我
 data.relationships.printers.links.self string

自我
相關
 data.relationships.printers.links.related string

相關
自我
 data.relationships.printer-contacts.links.self string

自我
相關
 data.relationships.printer-contacts.links.related string

相關
總計
 meta.total integer

總計
先
 links.first string

先
last
 links.last string

last

取得封鎖清單篩選器

作業識別碼：
getblockListFilters

GET 要求來擷取封鎖清單篩選器。

參數

名稱 機碼 必要 類型 Description
過濾器[公司]
 filter[company] integer

過濾器[公司]
內容-類型
 Content-Type string

內容-類型

傳回

名稱 路徑 類型 Description
資料
 data array of object

資料
識別碼
 data.id string

識別碼
型別
 data.type string

型別
自我
 data.links.self string

自我
別名
 data.attributes.aliases array of

別名
描述
 data.attributes.description string

描述
電子郵件
 data.attributes.emails array of string

電子郵件
全名
 data.attributes.full-name string

全名
關鍵字
 data.attributes.keyword string

關鍵字
其他關鍵字
 data.attributes.other-keywords array of string

其他關鍵字
電話號碼
 data.attributes.phone-numbers array of

電話號碼
源語言
 data.attributes.photo.original string

源語言
大拇指
 data.attributes.photo.thumb string

大拇指
reason
 data.attributes.reason string

reason
圖像網址
 data.attributes.image-url string

圖像網址
外部 ID
 data.attributes.external-id string

外部 ID
建立者
 data.attributes.created-by string

建立者
自我
 data.relationships.location.links.self string

自我
相關
 data.relationships.location.links.related string

相關
自我
 data.relationships.user.links.self string

自我
相關
 data.relationships.user.links.related string

相關
總計
 meta.total integer

總計

取得流程

作業識別碼：
getFlowsInfo

GET 請求，以擷取您所在位置的流程相關資訊。

參數

名稱 機碼 必要 類型 Description
filter[位置]
 filter[location] integer

filter[位置]

傳回

名稱 路徑 類型 Description
資料
 data array of object

資料
識別碼
 data.id string

識別碼
型別
 data.type string

型別
自我
 data.links.self string

自我
額外來賓
 data.attributes.additional-guests boolean

額外來賓
自動登出分鐘數
 data.attributes.auto-sign-out-minutes string

自動登出分鐘數
午夜自動登出
 data.attributes.auto-sign-out-at-midnight boolean

午夜自動登出
已啟用徽章
 data.attributes.badge-enabled boolean

已啟用徽章
enabled
 data.attributes.enabled boolean

enabled
身分證檢查
 data.attributes.id-check boolean

身分證檢查
ipad 本地化名稱
 data.attributes.ipad-localized-names array of object

ipad 本地化名稱
語言代碼
 data.attributes.ipad-localized-names.language-code string

語言代碼
區域代碼
 data.attributes.ipad-localized-names.region-code string

區域代碼
顯示名稱
 data.attributes.ipad-localized-names.display-name string

顯示名稱
名稱
 data.attributes.name string

名稱
位置
 data.attributes.position integer

位置
使用現有照片
 data.attributes.use-existing-photo boolean

使用現有照片
創建時間
 data.attributes.created-at string

創建時間
更新時間
 data.attributes.updated-at string

更新時間
自我
 data.relationships.agreement-page.links.self string

自我
相關
 data.relationships.agreement-page.links.related string

相關
自我
 data.relationships.badge.links.self string

自我
相關
 data.relationships.badge.links.related string

相關
自我
 data.relationships.location.links.self string

自我
相關
 data.relationships.location.links.related string

相關
自我
 data.relationships.photo-page.links.self string

自我
相關
 data.relationships.photo-page.links.related string

相關
自我
 data.relationships.sign-in-field-page.links.self string

自我
相關
 data.relationships.sign-in-field-page.links.related string

相關
自我
 data.relationships.summary-page.links.self string

自我
相關
 data.relationships.summary-page.links.related string

相關
總計
 meta.total integer

總計
先
 links.first string

先
last
 links.last string

last

取得邀請

作業識別碼：
getInviteInfo

GET 請求，以根據篩選擷取邀請資訊。

參數

名稱 機碼 必要 類型 Description
filter[位置]
 filter[location] integer

filter[位置]
篩選[日期]
 filter[date] string

篩選[日期]
接受
 Accept string

接受

傳回

名稱 路徑 類型 Description
資料
 data array of object

資料
識別碼
 data.id string

識別碼
型別
 data.type string

型別
自我
 data.links.self string

自我
額外來賓
 data.attributes.additional-guests integer

額外來賓
狀態
 data.attributes.approval-status.status string

狀態
auto_approved
 data.attributes.approval-status.auto_approved boolean

auto_approved
報告
 data.attributes.approval-status.report array of object

報告
結果
 data.attributes.approval-status.report.result string

結果
來源
 data.attributes.approval-status.report.source string

來源
blacklistReportUUID
 data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUUID
reason
 data.attributes.approval-status.report.reason string

reason
收發簡訊
 data.attributes.approval-status.report.messages.failure.text string

收發簡訊
標頭
 data.attributes.approval-status.report.messages.failure.header string

標頭
reviewer_id
 data.attributes.approval-status.reviewer_id string

reviewer_id
reviewer_name
 data.attributes.approval-status.reviewer_name string

reviewer_name
review_note
 data.attributes.approval-status.review_note string

review_note
reviewed_at
 data.attributes.approval-status.reviewed_at string

reviewed_at
電子郵件
 data.attributes.email string

電子郵件
預計到達時間
 data.attributes.expected-arrival-time string

預計到達時間
預計出發時間
 data.attributes.expected-departure-time string

預計出發時間
全名
 data.attributes.full-name string

全名
訪客更新
 data.attributes.guest-updated-at string

訪客更新
是預先簽署
 data.attributes.is-presigned boolean

是預先簽署
address
 data.attributes.location-info.address string

address
識別碼
 data.attributes.location-info.id integer

識別碼
名稱
 data.attributes.location-info.name string

名稱
logo_url
 data.attributes.location-info.logo_url string

logo_url
company_name
 data.attributes.location-info.company_name string

company_name
timezone
 data.attributes.location-info.timezone string

timezone
私人筆記
 data.attributes.private-notes string

私人筆記
使用者資料
 data.attributes.user-data array of object

使用者資料
欄位
 data.attributes.user-data.field string

欄位
value
 data.attributes.user-data.value string

value
通知訪客
 data.attributes.notify-visitor boolean

通知訪客
建立來源
 data.attributes.created-from string

建立來源
place_id
 data.attributes.locality.place_id string

place_id
地點識別碼
 data.attributes.locality.place-id string

地點識別碼
到達
 data.attributes.arrived boolean

到達
非接觸式登入可用時間
 data.attributes.touchless-sign-in-available-time string

非接觸式登入可用時間
需要非接觸式登入
 data.attributes.touchless-sign-in-presence-required boolean

需要非接觸式登入
入口-登出-at
 data.attributes.entry-signed-out-at string

入口-登出-at
經證實
 data.attributes.attested string

經證實
phone
 data.attributes.phone string

phone
預先註冊連結
 data.attributes.preregistration-link string

預先註冊連結
預先註冊狀態連結
 data.attributes.preregistration-status-link string

預先註冊狀態連結
提醒發送時間
 data.attributes.reminder-sent-at string

提醒發送時間
創建時間
 data.attributes.created-at string

創建時間
更新時間
 data.attributes.updated-at string

更新時間
自我
 data.relationships.attendee.links.self string

自我
相關
 data.relationships.attendee.links.related string

相關
自我
 data.relationships.creator.links.self string

自我
相關
 data.relationships.creator.links.related string

相關
自我
 data.relationships.employee.links.self string

自我
相關
 data.relationships.employee.links.related string

相關
型別
 data.relationships.employee.data.type string

型別
識別碼
 data.relationships.employee.data.id string

識別碼
自我
 data.relationships.entry.links.self string

自我
相關
 data.relationships.entry.links.related string

相關
型別
 data.relationships.entry.data.type string

型別
識別碼
 data.relationships.entry.data.id string

識別碼
自我
 data.relationships.flow.links.self string

自我
相關
 data.relationships.flow.links.related string

相關
型別
 data.relationships.flow.data.type string

型別
識別碼
 data.relationships.flow.data.id string

識別碼
自我
 data.relationships.location.links.self string

自我
相關
 data.relationships.location.links.related string

相關
型別
 data.relationships.location.data.type string

型別
識別碼
 data.relationships.location.data.id string

識別碼
自我
 data.relationships.platform-jobs.links.self string

自我
相關
 data.relationships.platform-jobs.links.related string

相關
總計
 meta.total integer

總計
先
 links.first string

先
next
 links.next string

next
last
 links.last string

last

建立邀請

作業識別碼：
addInvite

這是建立邀請的 POST 要求

參數

名稱 機碼 必要 類型 Description
內容-類型
 Content-Type string

內容-類型
全名
 full-name string

全名
電子郵件
 email string

電子郵件
邀請者名稱
 inviter-name string

邀請者名稱
預計到達時間
 expected-arrival-time string

預計到達時間
週期性規則
 recurring-rule string

週期性規則
rrule-直到
 rrule-until string

rrule-直到
私人筆記
 private-notes string

私人筆記
曾經在這裡
 been-here-before boolean

曾經在這裡
額外來賓
 additional-guests integer

額外來賓
略過訪客通知
 skip-guest-notification boolean

略過訪客通知
協議狀態
 agreements-status string

協議狀態
地點識別碼
 place-id string

地點識別碼
流程名稱
 flow-name string

流程名稱
群組名稱
 group-name string

群組名稱
到達
 arrived boolean

到達
核准狀態
 approval-status string

核准狀態
欄位
 field string

欄位
value
 value string

value
型別
 type string

型別
識別碼
 id string

id （員工）
型別
 type string

型別
識別碼
 id string

id （位置）
型別
 type string

型別

傳回

名稱 路徑 類型 Description
識別碼
 data.id string

識別碼
型別
 data.type string

型別
自我
 data.links.self string

自我
額外來賓
 data.attributes.additional-guests integer

額外來賓
狀態
 data.attributes.approval-status.status string

狀態
auto_approved
 data.attributes.approval-status.auto_approved boolean

auto_approved
報告
 data.attributes.approval-status.report array of object

報告
結果
 data.attributes.approval-status.report.result string

結果
來源
 data.attributes.approval-status.report.source string

來源
blacklistReportUUID
 data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUUID
reason
 data.attributes.approval-status.report.reason string

reason
收發簡訊
 data.attributes.approval-status.report.messages.failure.text string

收發簡訊
標頭
 data.attributes.approval-status.report.messages.failure.header string

標頭
reviewer_id
 data.attributes.approval-status.reviewer_id string

reviewer_id
reviewer_name
 data.attributes.approval-status.reviewer_name string

reviewer_name
review_note
 data.attributes.approval-status.review_note string

review_note
reviewed_at
 data.attributes.approval-status.reviewed_at string

reviewed_at
電子郵件
 data.attributes.email string

電子郵件
預計到達時間
 data.attributes.expected-arrival-time string

預計到達時間
預計出發時間
 data.attributes.expected-departure-time string

預計出發時間
全名
 data.attributes.full-name string

全名
訪客更新
 data.attributes.guest-updated-at string

訪客更新
是預先簽署
 data.attributes.is-presigned boolean

是預先簽署
address
 data.attributes.location-info.address string

address
識別碼
 data.attributes.location-info.id integer

識別碼
名稱
 data.attributes.location-info.name string

名稱
logo_url
 data.attributes.location-info.logo_url string

logo_url
私人筆記
 data.attributes.private-notes string

私人筆記
使用者資料
 data.attributes.user-data array of object

使用者資料
data.attributes.user-data.field string

欄位
data.attributes.user-data.value string

value
通知訪客
 data.attributes.notify-visitor boolean

通知訪客
建立來源
 data.attributes.created-from string

建立來源
到達
 data.attributes.arrived boolean

到達
非接觸式登入可用時間
 data.attributes.touchless-sign-in-available-time string

非接觸式登入可用時間
需要非接觸式登入
 data.attributes.touchless-sign-in-presence-required boolean

需要非接觸式登入
入口-登出-at
 data.attributes.entry-signed-out-at string

入口-登出-at
預先註冊連結
 data.attributes.preregistration-link string

預先註冊連結
創建時間
 data.attributes.created-at string

創建時間
更新時間
 data.attributes.updated-at string

更新時間
自我
 data.relationships.attendee.links.self string

自我
相關
 data.relationships.attendee.links.related string

相關
自我
 data.relationships.creator.links.self string

自我
相關
 data.relationships.creator.links.related string

相關
自我
 data.relationships.employee.links.self string

自我
相關
 data.relationships.employee.links.related string

相關
型別
 data.relationships.employee.data.type string

型別
識別碼
 data.relationships.employee.data.id string

識別碼
自我
 data.relationships.entry.links.self string

自我
相關
 data.relationships.entry.links.related string

相關
型別
 data.relationships.entry.data.type object

型別
識別碼
 data.relationships.entry.data.id string

識別碼
自我
 data.relationships.flow.links.self string

自我
相關
 data.relationships.flow.links.related string

相關
型別
 data.relationships.flow.data.type string

型別
識別碼
 data.relationships.flow.data.id string

識別碼
自我
 data.relationships.location.links.self string

自我
相關
 data.relationships.location.links.related string

相關
型別
 data.relationships.location.data.type string

型別
識別碼
 data.relationships.location.data.id string

識別碼
自我
 data.relationships.platform-jobs.links.self string

自我
相關
 data.relationships.platform-jobs.links.related string

相關

新增封鎖清單篩選器

作業識別碼：
addBlockListFilter

POST 請求以新增封鎖清單過濾器

參數

名稱 機碼 必要 類型 Description
別名
 aliases array of

別名
描述
 description string

描述
電子郵件
 emails array of string

電子郵件
全名
 full-name string

全名
關鍵字
 keyword string

關鍵字
其他關鍵字
 other-keywords array of

其他關鍵字
reason
 reason string

reason
電話號碼
 phone-numbers array of

電話號碼
型別
 type string

型別
識別碼
 id string

id （位置）
型別
 type string

型別

傳回

名稱 路徑 類型 Description
識別碼
 data.id string

識別碼
型別
 data.type string

型別
自我
 data.links.self string

自我
別名
 data.attributes.aliases array of

別名
描述
 data.attributes.description string

描述
電子郵件
 data.attributes.emails array of string

電子郵件
全名
 data.attributes.full-name string

全名
關鍵字
 data.attributes.keyword string

關鍵字
其他關鍵字
 data.attributes.other-keywords array of

其他關鍵字
電話號碼
 data.attributes.phone-numbers array of

電話號碼
源語言
 data.attributes.photo.original string

源語言
大拇指
 data.attributes.photo.thumb string

大拇指
reason
 data.attributes.reason string

reason
建立者
 data.attributes.created-by string

建立者
自我
 data.relationships.location.links.self string

自我
相關
 data.relationships.location.links.related string

相關
自我
 data.relationships.user.links.self string

自我
相關
 data.relationships.user.links.related string

相關

更新一個邀請

作業識別碼：
updateInvite

PATCH 要求更新邀請的資訊。

參數

名稱 機碼 必要 類型 Description
invite_id
 invite_id True string

invite_id
內容-類型
 Content-Type string

內容-類型
識別碼
 id string

識別碼
全名
 full-name string

全名
電子郵件
 email string

電子郵件
邀請者名稱
 inviter-name string

邀請者名稱
預計到達時間
 expected-arrival-time string

預期到達時間 （預期格式：2019-03-24T21：15：00.000Z）
週期性規則
 recurring-rule string

週期性規則
rrule-直到
 rrule-until string

rrule-直到
私人筆記
 private-notes string

私人筆記
曾經在這裡
 been-here-before boolean

曾經在這裡
額外來賓
 additional-guests integer

額外來賓
略過訪客通知
 skip-guest-notification boolean

略過訪客通知
保密協議
 nda string

保密協議
訪客更新
 guest-updated-at string

guest-updated-at （格式：2019-03-24T21：15：00.000Z）
原始 nda-sign-date
 original-nda-sign-date string

原始 nda-sign-date
NDA 可用
 nda-available boolean

NDA 可用
流程名稱
 flow-name string

流程名稱
到達
 arrived boolean

到達
核准狀態
 approval-status string

核准狀態
欄位
 field string

欄位
value
 value string

value
型別
 type string

型別
識別碼
 id string

識別碼
型別
 type string

型別
識別碼
 id string

id （員工）
型別
 type string

型別
識別碼
 id string

id （位置）
型別
 type string

型別

傳回

名稱 路徑 類型 Description
識別碼
 data.id string

識別碼
型別
 data.type string

型別
協議狀態
 data.attributes.agreements-status string

協議狀態
全名
 data.attributes.full-name string

全名
電子郵件
 data.attributes.email string

電子郵件
邀請者名稱
 data.attributes.inviter-name string

邀請者名稱
邀請者電子郵件
 data.attributes.inviter-email string

邀請者電子郵件
預計到達時間
 data.attributes.expected-arrival-time string

預計到達時間
私人筆記
 data.attributes.private-notes string

私人筆記
到達
 data.attributes.arrived boolean

到達
曾經在這裡
 data.attributes.been-here-before boolean

曾經在這裡
流程名稱
 data.attributes.flow-name string

流程名稱
流程 ID
 data.attributes.flow-id integer

流程 ID
使用者資料
 data.attributes.user-data array of object

使用者資料
欄位
 data.attributes.user-data.field string

欄位
value
 data.attributes.user-data.value string

value
額外來賓
 data.attributes.additional-guests integer

額外來賓
訪客更新
 data.attributes.guest-updated-at string

訪客更新
保密協議
 data.attributes.nda string

保密協議
NDA 可用
 data.attributes.nda-available boolean

NDA 可用
原始 nda-sign-date
 data.attributes.original-nda-sign-date string

原始 nda-sign-date
秘密令牌
 data.attributes.secret-token string

秘密令牌
群組名稱
 data.attributes.group-name string

群組名稱
照片網址
 data.attributes.photo-url string

照片網址
二維碼
 data.attributes.qr-code string

二維碼
二維碼發送時間
 data.attributes.qr-code-sent-at string

二維碼發送時間
預先註冊完成
 data.attributes.preregistration-complete string

預先註冊完成
狀態
 data.attributes.approval-status.status string

狀態
自動核准
 data.attributes.approval-status.auto-approved boolean

自動核准
報告
 data.attributes.approval-status.report array of object

報告
結果
 data.attributes.approval-status.report.result string

結果
來源
 data.attributes.approval-status.report.source string

來源
blacklistReportUUID
 data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUUID
reason
 data.attributes.approval-status.report.reason string

reason
收發簡訊
 data.attributes.approval-status.report.messages.failure.text string

收發簡訊
標頭
 data.attributes.approval-status.report.messages.failure.header string

標頭
檢閱者識別碼
 data.attributes.approval-status.reviewer-id string

檢閱者識別碼
檢閱者名稱
 data.attributes.approval-status.reviewer-name string

檢閱者名稱
評論筆記
 data.attributes.approval-status.review-note string

評論筆記
審查於
 data.attributes.approval-status.reviewed-at string

審查於
型別
 data.relationships.entry.data.type string

型別
識別碼
 data.relationships.entry.data.id string

識別碼
識別碼
 data.relationships.location.data.id string

識別碼
型別
 data.relationships.location.data.type string

型別
型別
 data.relationships.flow.data.type string

型別
識別碼
 data.relationships.flow.data.id string

識別碼
型別
 data.relationships.employee.data.type string

型別
識別碼
 data.relationships.employee.data.id string

識別碼
型別
 data.relationships.creator.data.type string

型別
識別碼
 data.relationships.creator.data.id string

識別碼
相關
 data.relationships.platform-jobs.links.related string

相關
包含
 included array of object

包含
識別碼
 included.id string

識別碼
型別
 included.type string

型別
名稱
 included.attributes.name string

名稱
自我
 links.self string

自我

獲取員工名單

作業識別碼：
getEmployee

GET 要求擷取員工清單

傳回

名稱 路徑 類型 Description
資料
 data array of object

資料
識別碼
 data.id string

識別碼
型別
 data.type string

型別
自我
 data.links.self string

自我
CC-員工
 data.attributes.cc-employee boolean

CC-員工
公司識別碼
 data.attributes.company-id integer

公司識別碼
已刪除
 data.attributes.deleted boolean

已刪除
不同步
 data.attributes.do-not-sync boolean

不同步
電子郵件
 data.attributes.email string

電子郵件
從主機清單隱藏
 data.attributes.hide-from-host-list boolean

從主機清單隱藏
手動新增
 data.attributes.manually-added boolean

手動新增
手動新增位置-呈現
 data.attributes.manually-added-location-present boolean

手動新增位置-呈現
名稱
 data.attributes.name string

名稱
電話號碼
 data.attributes.phone-number string

電話號碼
創建時間
 data.attributes.created-at string

創建時間
刪除時間
 data.attributes.deleted-at string

刪除時間
更新時間
 data.attributes.updated-at string

更新時間
自我
 data.relationships.company.links.self string

自我
相關
 data.relationships.company.links.related string

相關
自我
 data.relationships.user.links.self string

自我
相關
 data.relationships.user.links.related string

相關
自我
 data.relationships.assistants.links.self string

自我
相關
 data.relationships.assistants.links.related string

相關
自我
 data.relationships.bosses.links.self string

自我
相關
 data.relationships.bosses.links.related string

相關
自我
 data.relationships.employee-locations.links.self string

自我
相關
 data.relationships.employee-locations.links.related string

相關
自我
 data.relationships.locations.links.self string

自我
相關
 data.relationships.locations.links.related string

相關
總計
 meta.total integer

總計
先
 links.first string

先
last
 links.last string

last

獲得一份邀請

作業識別碼：
getInviteByID

GET 請求以擷取單一邀請的相關資訊。

參數

名稱 機碼 必要 類型 Description
invite_id
 invite_id True string

invite_id
接受
 Accept string

接受

傳回

名稱 路徑 類型 Description
識別碼
 data.id string

識別碼
型別
 data.type string

型別
全名
 data.attributes.full-name string

全名
電子郵件
 data.attributes.email string

電子郵件
邀請者名稱
 data.attributes.inviter-name string

邀請者名稱
預計到達時間
 data.attributes.expected-arrival-time string

預計到達時間
私人筆記
 data.attributes.private-notes string

私人筆記
到達
 data.attributes.arrived boolean

到達
曾經在這裡
 data.attributes.been-here-before boolean

曾經在這裡
流程名稱
 data.attributes.flow-name string

流程名稱
流程 ID
 data.attributes.flow-id integer

流程 ID
使用者資料
 data.attributes.user-data array of object

使用者資料
欄位
 data.attributes.user-data.field string

欄位
value
 data.attributes.user-data.value string

value
額外來賓
 data.attributes.additional-guests integer

額外來賓
訪客更新
 data.attributes.guest-updated-at string

訪客更新
保密協議
 data.attributes.nda string

保密協議
NDA 可用
 data.attributes.nda-available boolean

NDA 可用
原始 nda-sign-date
 data.attributes.original-nda-sign-date string

原始 nda-sign-date
秘密令牌
 data.attributes.secret-token string

秘密令牌
核准狀態
 data.attributes.approval-status string

核准狀態
型別
 data.relationships.entry.data.type string

型別
識別碼
 data.relationships.entry.data.id string

識別碼
識別碼
 data.relationships.location.data.id string

識別碼
型別
 data.relationships.location.data.type string

型別
型別
 data.relationships.flow.data.type string

型別
識別碼
 data.relationships.flow.data.id string

識別碼
型別
 data.relationships.employee.data.type string

型別
識別碼
 data.relationships.employee.data.id string

識別碼
型別
 data.relationships.creator.data.type string

型別
識別碼
 data.relationships.creator.data.id string

識別碼
包含
 included array of object

包含
識別碼
 included.id string

識別碼
型別
 included.type string

型別
全名
 included.attributes.full-name string

全名
電子郵件
 included.attributes.email string

電子郵件
電話號碼
 included.attributes.phone-number string

電話號碼
頭像
 included.attributes.avatar string

頭像
創建時間
 included.attributes.created-at string

創建時間
已啟用電子郵件
 included.attributes.email-enabled boolean

已啟用電子郵件
已啟用簡訊
 included.attributes.sms-enabled boolean

已啟用簡訊
已啟用通話
 included.attributes.call-enabled string

已啟用通話
已啟用 Slack
 included.attributes.slack-enabled boolean

已啟用 Slack
啟用 HipChat
 included.attributes.hipchat-enabled boolean

啟用 HipChat
已啟用推送
 included.attributes.push-enabled boolean

已啟用推送
已啟用邀請推送
 included.attributes.invite-push-enabled boolean

已啟用邀請推送
has-profile
 included.attributes.has-profile boolean

has-profile
對講機身分雜湊
 included.attributes.intercom-identity-hash string

對講機身分雜湊
相關
 included.relationships.location-roles.links.related string

相關
相關
 included.relationships.company-roles.links.related string

相關
資料
 included.relationships.emails.data array of object

資料
型別
 included.relationships.emails.data.type string

型別
識別碼
 included.relationships.emails.data.id string

識別碼
自我
 links.self string

自我

獲得一次參賽

作業識別碼：
getEntryInfoByID

GET 要求來擷取單一專案的相關資訊。

參數

名稱 機碼 必要 類型 Description
entry_id
 entry_id True string

entry_id
filter[位置]
 filter[location] integer

filter[位置]
接受
 Accept string

接受

傳回

名稱 路徑 類型 Description
識別碼
 data.id string

識別碼
型別
 data.type string

型別
全名
 data.attributes.full-name string

全名
電子郵件
 data.attributes.email string

電子郵件
主持人
 data.attributes.host string

主持人
主機電子郵件
 data.attributes.host-email string

主機電子郵件
私人筆記
 data.attributes.private-notes string

私人筆記
已簽署 -in-at
 data.attributes.signed-in-at string

已簽署 -in-at
裝置會話 uuid
 data.attributes.device-session-uuid string

裝置會話 uuid
登入方式
 data.attributes.signed-in-via string

登入方式
已簽署 -in-by
 data.attributes.signed-in-by string

已簽署 -in-by
已登出-通過
 data.attributes.signed-out-via string

已登出-通過
登出者
 data.attributes.signed-out-by string

登出者
大
 data.attributes.thumbnails.large string

大
小
 data.attributes.thumbnails.small string

小
流程名稱
 data.attributes.flow-name string

流程名稱
原始 nda-sign-date
 data.attributes.original-nda-sign-date string

原始 nda-sign-date
身分證件檢查狀態
 data.attributes.id-check-status string

身分證件檢查狀態
是傳遞
 data.attributes.is-delivery boolean

是傳遞
協議被拒絕
 data.attributes.agreement-refused boolean

協議被拒絕
POV 鍵
 data.attributes.pov-key string

POV 鍵
使用者資料
 data.attributes.user-data array of object

使用者資料
欄位
 data.attributes.user-data.field string

欄位
value
 data.attributes.user-data.value string

value
簡訊狀態
 data.attributes.sms-status string

簡訊狀態
核准狀態
 data.attributes.approval-status string

核准狀態
推送狀態
 data.attributes.push-status string

推送狀態
電子郵件狀態
 data.attributes.email-status string

電子郵件狀態
鬆弛狀態
 data.attributes.slack-status string

鬆弛狀態
hipchat-status
 data.attributes.hipchat-status string

hipchat-status
型別
 data.relationships.location.data.type string

型別
識別碼
 data.relationships.location.data.id string

識別碼
型別
 data.relationships.employee.data.type string

型別
識別碼
 data.relationships.employee.data.id string

識別碼
型別
 data.relationships.invite.data.type string

型別
識別碼
 data.relationships.invite.data.id string

識別碼
型別
 data.relationships.flow.data.type string

型別
識別碼
 data.relationships.flow.data.id string

識別碼
相關
 data.relationships.previous-entries.links.related string

相關
相關
 data.relationships.platform-jobs.links.related string

相關
自我
 links.self string

自我

觸發程序

Invite-Created 觸發器

建立 Envoy 邀請時，在 MS Flow 中觸發動作。

Invite-Created 觸發器

作業識別碼：
InviteCreated

建立 Envoy 邀請時，在 MS Flow 中觸發動作。

參數

名稱 機碼 必要 類型 Description
Token
 token string

Token