Envoy (プレビュー)
Envoy アカウント (REST API エンドポイント) を他のコネクタに接続できる Envoy コネクタ。 たとえば、Microsoft Excel Online スプレッドシートの詳細を含む一括招待を Envoy で作成します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Envoy サポート チーム |
| URL | https://envoy.help/ |
| hi@envoy.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Envoy, Inc. |
| Website | https://envoy.com/ |
| プライバシー ポリシー | https://envoy.com/privacypolicy/ |
| カテゴリ | ビジネス インテリジェンス。データ |
バージョン 2.0 では、Envoy Invite の作成をトリガーとして使用することもできます。
[前提条件]
このコネクタを使用するには、ユーザー名とパスワードを持つ Envoy アカウントが必要です。 機能をトリガーするには、Envoy 統合 "Microsoft Flow" をインストールする必要もあります。
資格情報を取得する方法
Envoy に対して認証するには、Envoy のユーザー名とパスワードが必要です。
機能をトリガーするには、Envoy 内の "Microsoft Flow" 統合セットアップの手順 2 で提供されるインストール トークンが必要です。
既知の問題と制限事項
現時点では、使用可能なトリガーは招待の作成のみです。 近い将来、さらにトリガーを追加する予定です。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| ユーザー名 | securestring | この API のユーザー名 | 正しい |
| パスワード | securestring | この API のパスワード | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 1 つのエントリを取得する |
1 つのエントリに関する情報を取得するための GET 要求。 |
| 1 つの招待を更新する |
招待の情報を更新するための PATCH 要求。 |
| フローを取得する |
場所のフローに関する情報を取得するための GET 要求。 |
| ブロックリスト フィルターを取得する |
ブロック リスト フィルターを取得する GET 要求。 |
| ブロックリスト フィルターを追加する |
ブロックリスト フィルターを追加するための POST 要求 |
| 会社情報を取得する |
会社に関する情報を取得する (GET) |
| 場所を取得する |
場所を取得するための GET 要求 |
| 従業員の一覧を取得する |
従業員リストを取得するための GET 要求 |
| 招待の作成 |
これは、招待を作成するための POST 要求です |
| 招待を 1 つ取得する |
1 つの招待に関する情報を取得するための GET 要求。 |
| 招待を取得する |
フィルター処理に基づいて招待情報を取得する GET 要求。 |
1 つのエントリを取得する
1 つのエントリに関する情報を取得するための GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
entry_id
|
entry_id | True | string |
entry_id |
|
filter[location]
|
filter[location] | integer |
filter[location] |
|
|
Accept
|
Accept | string |
Accept |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
メール
|
data.attributes.email | string |
メール |
|
ホスティング
|
data.attributes.host | string |
ホスティング |
|
host-email
|
data.attributes.host-email | string |
host-email |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
signed-in-at
|
data.attributes.signed-in-at | string |
signed-in-at |
|
device-session-uuid
|
data.attributes.device-session-uuid | string |
device-session-uuid |
|
signed-in-via
|
data.attributes.signed-in-via | string |
signed-in-via |
|
signed-in-by
|
data.attributes.signed-in-by | string |
signed-in-by |
|
signed-out-via
|
data.attributes.signed-out-via | string |
signed-out-via |
|
signed-out-by
|
data.attributes.signed-out-by | string |
signed-out-by |
|
大きい
|
data.attributes.thumbnails.large | string |
大きい |
|
小さい
|
data.attributes.thumbnails.small | string |
小さい |
|
flow-name
|
data.attributes.flow-name | string |
flow-name |
|
original-nda-sign-date
|
data.attributes.original-nda-sign-date | string |
original-nda-sign-date |
|
id-check-status
|
data.attributes.id-check-status | string |
id-check-status |
|
is-delivery
|
data.attributes.is-delivery | boolean |
is-delivery |
|
agreement-refused
|
data.attributes.agreement-refused | boolean |
agreement-refused |
|
pov-key
|
data.attributes.pov-key | string |
pov-key |
|
user-data
|
data.attributes.user-data | array of object |
user-data |
|
フィールド
|
data.attributes.user-data.field | string |
フィールド |
|
value
|
data.attributes.user-data.value | string |
value |
|
sms-status
|
data.attributes.sms-status | string |
sms-status |
|
approval-status
|
data.attributes.approval-status | string |
approval-status |
|
push-status
|
data.attributes.push-status | string |
push-status |
|
email-status
|
data.attributes.email-status | string |
email-status |
|
slack-status
|
data.attributes.slack-status | string |
slack-status |
|
hipchat-status
|
data.attributes.hipchat-status | string |
hipchat-status |
|
型
|
data.relationships.location.data.type | string |
型 |
|
id
|
data.relationships.location.data.id | string |
id |
|
型
|
data.relationships.employee.data.type | string |
型 |
|
id
|
data.relationships.employee.data.id | string |
id |
|
型
|
data.relationships.invite.data.type | string |
型 |
|
id
|
data.relationships.invite.data.id | string |
id |
|
型
|
data.relationships.flow.data.type | string |
型 |
|
id
|
data.relationships.flow.data.id | string |
id |
|
関連
|
data.relationships.previous-entries.links.related | string |
関連 |
|
関連
|
data.relationships.platform-jobs.links.related | string |
関連 |
|
self
|
links.self | string |
self |
1 つの招待を更新する
招待の情報を更新するための PATCH 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
invite_id
|
invite_id | True | string |
invite_id |
|
コンテンツタイプ
|
Content-Type | string |
コンテンツタイプ |
|
|
id
|
id | string |
id |
|
|
full-name
|
full-name | string |
full-name |
|
|
メール
|
string |
メール |
||
|
inviter-name
|
inviter-name | string |
inviter-name |
|
|
expected-arrival-time
|
expected-arrival-time | string |
expected-arrival-time (Expected Format: 2019-03-24T21:15:00.000Z) |
|
|
recurring-rule
|
recurring-rule | string |
recurring-rule |
|
|
rrule-until
|
rrule-until | string |
rrule-until |
|
|
private-notes
|
private-notes | string |
private-notes |
|
|
been-here-before
|
been-here-before | boolean |
been-here-before |
|
|
additional-guests
|
additional-guests | integer |
additional-guests |
|
|
skip-guest-notification
|
skip-guest-notification | boolean |
skip-guest-notification |
|
|
nda
|
nda | string |
nda |
|
|
guest-updated-at
|
guest-updated-at | string |
guest-updated-at (書式設定: 2019-03-24T21:15:00.000Z) |
|
|
original-nda-sign-date
|
original-nda-sign-date | string |
original-nda-sign-date |
|
|
nda-available
|
nda-available | boolean |
nda-available |
|
|
flow-name
|
flow-name | string |
flow-name |
|
|
到着
|
arrived | boolean |
到着 |
|
|
approval-status
|
approval-status | string |
approval-status |
|
|
フィールド
|
field | string |
フィールド |
|
|
value
|
value | string |
value |
|
|
型
|
type | string |
型 |
|
|
id
|
id | string |
id |
|
|
型
|
type | string |
型 |
|
|
id
|
id | string |
id (employee) |
|
|
型
|
type | string |
型 |
|
|
id
|
id | string |
id (location) |
|
|
型
|
type | string |
型 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
agreements-status
|
data.attributes.agreements-status | string |
agreements-status |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
メール
|
data.attributes.email | string |
メール |
|
inviter-name
|
data.attributes.inviter-name | string |
inviter-name |
|
inviter-email
|
data.attributes.inviter-email | string |
inviter-email |
|
expected-arrival-time
|
data.attributes.expected-arrival-time | string |
expected-arrival-time |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
到着
|
data.attributes.arrived | boolean |
到着 |
|
been-here-before
|
data.attributes.been-here-before | boolean |
been-here-before |
|
flow-name
|
data.attributes.flow-name | string |
flow-name |
|
flow-id
|
data.attributes.flow-id | integer |
flow-id |
|
user-data
|
data.attributes.user-data | array of object |
user-data |
|
フィールド
|
data.attributes.user-data.field | string |
フィールド |
|
value
|
data.attributes.user-data.value | string |
value |
|
additional-guests
|
data.attributes.additional-guests | integer |
additional-guests |
|
guest-updated-at
|
data.attributes.guest-updated-at | string |
guest-updated-at |
|
nda
|
data.attributes.nda | string |
nda |
|
nda-available
|
data.attributes.nda-available | boolean |
nda-available |
|
original-nda-sign-date
|
data.attributes.original-nda-sign-date | string |
original-nda-sign-date |
|
secret-token
|
data.attributes.secret-token | string |
secret-token |
|
group-name
|
data.attributes.group-name | string |
group-name |
|
photo-url
|
data.attributes.photo-url | string |
photo-url |
|
qr-code
|
data.attributes.qr-code | string |
qr-code |
|
qr-code-sent-at
|
data.attributes.qr-code-sent-at | string |
qr-code-sent-at |
|
preregistration-complete
|
data.attributes.preregistration-complete | string |
preregistration-complete |
|
状態
|
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 |
|
理由
|
data.attributes.approval-status.report.reason | string |
理由 |
|
SMS 送信
|
data.attributes.approval-status.report.messages.failure.text | string |
SMS 送信 |
|
ヘッダー
|
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.relationships.entry.data.type | string |
型 |
|
id
|
data.relationships.entry.data.id | string |
id |
|
id
|
data.relationships.location.data.id | string |
id |
|
型
|
data.relationships.location.data.type | string |
型 |
|
型
|
data.relationships.flow.data.type | string |
型 |
|
id
|
data.relationships.flow.data.id | string |
id |
|
型
|
data.relationships.employee.data.type | string |
型 |
|
id
|
data.relationships.employee.data.id | string |
id |
|
型
|
data.relationships.creator.data.type | string |
型 |
|
id
|
data.relationships.creator.data.id | string |
id |
|
関連
|
data.relationships.platform-jobs.links.related | string |
関連 |
|
含ま
|
included | array of object |
含ま |
|
id
|
included.id | string |
id |
|
型
|
included.type | string |
型 |
|
名前
|
included.attributes.name | string |
名前 |
|
self
|
links.self | string |
self |
フローを取得する
場所のフローに関する情報を取得するための GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
filter[location]
|
filter[location] | integer |
filter[location] |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of object |
データ |
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
self
|
data.links.self | string |
self |
|
additional-guests
|
data.attributes.additional-guests | boolean |
additional-guests |
|
auto-sign-out-minutes
|
data.attributes.auto-sign-out-minutes | string |
auto-sign-out-minutes |
|
auto-sign-out-at-midnight
|
data.attributes.auto-sign-out-at-midnight | boolean |
auto-sign-out-at-midnight |
|
badge-enabled
|
data.attributes.badge-enabled | boolean |
badge-enabled |
|
enabled
|
data.attributes.enabled | boolean |
enabled |
|
id-check
|
data.attributes.id-check | boolean |
id-check |
|
ipad-localized-names
|
data.attributes.ipad-localized-names | array of object |
ipad-localized-names |
|
language-code
|
data.attributes.ipad-localized-names.language-code | string |
language-code |
|
region-code
|
data.attributes.ipad-localized-names.region-code | string |
region-code |
|
display-name
|
data.attributes.ipad-localized-names.display-name | string |
display-name |
|
名前
|
data.attributes.name | string |
名前 |
|
立場
|
data.attributes.position | integer |
立場 |
|
use-existing-photo
|
data.attributes.use-existing-photo | boolean |
use-existing-photo |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
updated-at
|
data.attributes.updated-at | string |
updated-at |
|
self
|
data.relationships.agreement-page.links.self | string |
self |
|
関連
|
data.relationships.agreement-page.links.related | string |
関連 |
|
self
|
data.relationships.badge.links.self | string |
self |
|
関連
|
data.relationships.badge.links.related | string |
関連 |
|
self
|
data.relationships.location.links.self | string |
self |
|
関連
|
data.relationships.location.links.related | string |
関連 |
|
self
|
data.relationships.photo-page.links.self | string |
self |
|
関連
|
data.relationships.photo-page.links.related | string |
関連 |
|
self
|
data.relationships.sign-in-field-page.links.self | string |
self |
|
関連
|
data.relationships.sign-in-field-page.links.related | string |
関連 |
|
self
|
data.relationships.summary-page.links.self | string |
self |
|
関連
|
data.relationships.summary-page.links.related | string |
関連 |
|
トータル
|
meta.total | integer |
トータル |
|
first
|
links.first | string |
first |
|
last
|
links.last | string |
last |
ブロックリスト フィルターを取得する
ブロック リスト フィルターを取得する GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
filter[company]
|
filter[company] | integer |
filter[company] |
|
|
コンテンツタイプ
|
Content-Type | string |
コンテンツタイプ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of object |
データ |
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
self
|
data.links.self | string |
self |
|
aliases
|
data.attributes.aliases | array of |
aliases |
|
説明
|
data.attributes.description | string |
説明 |
|
メール
|
data.attributes.emails | array of string |
メール |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
キーワード
|
data.attributes.keyword | string |
キーワード |
|
other-keywords
|
data.attributes.other-keywords | array of string |
other-keywords |
|
phone-numbers
|
data.attributes.phone-numbers | array of |
phone-numbers |
|
翻訳元
|
data.attributes.photo.original | string |
翻訳元 |
|
親指
|
data.attributes.photo.thumb | string |
親指 |
|
理由
|
data.attributes.reason | string |
理由 |
|
image-url
|
data.attributes.image-url | string |
image-url |
|
external-id
|
data.attributes.external-id | string |
external-id |
|
created-by
|
data.attributes.created-by | string |
created-by |
|
self
|
data.relationships.location.links.self | string |
self |
|
関連
|
data.relationships.location.links.related | string |
関連 |
|
self
|
data.relationships.user.links.self | string |
self |
|
関連
|
data.relationships.user.links.related | string |
関連 |
|
トータル
|
meta.total | integer |
トータル |
ブロックリスト フィルターを追加する
ブロックリスト フィルターを追加するための POST 要求
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
aliases
|
aliases | array of |
aliases |
|
|
説明
|
description | string |
説明 |
|
|
メール
|
emails | array of string |
メール |
|
|
full-name
|
full-name | string |
full-name |
|
|
キーワード
|
keyword | string |
キーワード |
|
|
other-keywords
|
other-keywords | array of |
other-keywords |
|
|
理由
|
reason | string |
理由 |
|
|
phone-numbers
|
phone-numbers | array of |
phone-numbers |
|
|
型
|
type | string |
型 |
|
|
id
|
id | string |
id (location) |
|
|
型
|
type | string |
型 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
self
|
data.links.self | string |
self |
|
aliases
|
data.attributes.aliases | array of |
aliases |
|
説明
|
data.attributes.description | string |
説明 |
|
メール
|
data.attributes.emails | array of string |
メール |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
キーワード
|
data.attributes.keyword | string |
キーワード |
|
other-keywords
|
data.attributes.other-keywords | array of |
other-keywords |
|
phone-numbers
|
data.attributes.phone-numbers | array of |
phone-numbers |
|
翻訳元
|
data.attributes.photo.original | string |
翻訳元 |
|
親指
|
data.attributes.photo.thumb | string |
親指 |
|
理由
|
data.attributes.reason | string |
理由 |
|
created-by
|
data.attributes.created-by | string |
created-by |
|
self
|
data.relationships.location.links.self | string |
self |
|
関連
|
data.relationships.location.links.related | string |
関連 |
|
self
|
data.relationships.user.links.self | string |
self |
|
関連
|
data.relationships.user.links.related | string |
関連 |
会社情報を取得する
会社に関する情報を取得する (GET)
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Accept
|
Accept | string |
Accept |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
トータル
|
meta.total | integer |
トータル |
|
limit
|
meta.limit | integer |
limit |
|
オフセット
|
meta.offset | integer |
オフセット |
|
データ
|
data | array of object |
データ |
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
名前
|
data.attributes.name | string |
名前 |
|
plan-intent
|
data.attributes.plan-intent | string |
plan-intent |
|
buy-intent
|
data.attributes.buy-intent | boolean |
buy-intent |
|
call-enabled
|
data.attributes.call-enabled | boolean |
call-enabled |
|
appletv 対応
|
data.attributes.appletv-enabled | boolean |
appletv 対応 |
|
saml-connected
|
data.attributes.saml-connected | boolean |
saml-connected |
|
活動中
|
data.attributes.active | boolean |
活動中 |
|
employees-sync-state
|
data.attributes.employees-sync-state | string |
employees-sync-state |
|
employees-sync-provider
|
data.attributes.employees-sync-provider | string |
employees-sync-provider |
|
employees-last-sync-at
|
data.attributes.employees-last-sync-at | string |
employees-last-sync-at |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
updated-at
|
data.attributes.updated-at | string |
updated-at |
|
onboarding-status
|
data.attributes.onboarding-status | string |
onboarding-status |
|
onboarding-locations-count
|
data.attributes.onboarding-locations-count | string |
onboarding-locations-count |
|
is-beta
|
data.attributes.is-beta | boolean |
is-beta |
|
adhoc-plugins
|
data.attributes.adhoc-plugins | array of |
adhoc-plugins |
|
cached-locations-quantity
|
data.attributes.cached-locations-quantity | integer |
cached-locations-quantity |
|
型
|
data.relationships.subscription.data.type | string |
型 |
|
id
|
data.relationships.subscription.data.id | string |
id |
|
型
|
data.relationships.deliveries-subscription.data.type | string |
型 |
|
id
|
data.relationships.deliveries-subscription.data.id | string |
id |
|
データ
|
data.relationships.contracts.data | array of object |
データ |
|
型
|
data.relationships.contracts.data.type | string |
型 |
|
id
|
data.relationships.contracts.data.id | string |
id |
|
データ
|
data.relationships.administrators.data | array of object |
データ |
|
型
|
data.relationships.administrators.data.type | string |
型 |
|
id
|
data.relationships.administrators.data.id | string |
id |
|
データ
|
data.relationships.locations.data | array of object |
データ |
|
型
|
data.relationships.locations.data.type | string |
型 |
|
id
|
data.relationships.locations.data.id | string |
id |
|
型
|
data.relationships.saml.data.type | string |
型 |
|
id
|
data.relationships.saml.data.id | string |
id |
|
self
|
links.self | string |
self |
|
first
|
links.first | string |
first |
|
last
|
links.last | string |
last |
場所を取得する
場所を取得するための GET 要求
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Accept
|
Accept | string |
Accept |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of object |
データ |
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
self
|
data.links.self | string |
self |
|
address
|
data.attributes.address | string |
address |
|
address-line-one
|
data.attributes.address-line-one | string |
address-line-one |
|
address-line-two
|
data.attributes.address-line-two | string |
address-line-two |
|
auto-sign-out-at-midnight
|
data.attributes.auto-sign-out-at-midnight | boolean |
auto-sign-out-at-midnight |
|
auto-sign-out-minutes
|
data.attributes.auto-sign-out-minutes | string |
auto-sign-out-minutes |
|
city
|
data.attributes.city | string |
city |
|
company-name-override
|
data.attributes.company-name-override | string |
company-name-override |
|
無効
|
data.attributes.disabled | boolean |
無効 |
|
employees-csv-upload-status
|
data.attributes.employees-csv-upload-status | string |
employees-csv-upload-status |
|
employees-sync-message
|
data.attributes.employees-sync-message | string |
employees-sync-message |
|
fallback-notifications-enabled
|
data.attributes.fallback-notifications-enabled | boolean |
fallback-notifications-enabled |
|
pre-registration-required-enabled
|
data.attributes.pre-registration-required-enabled | boolean |
pre-registration-required-enabled |
|
緯度 (latitude)
|
data.attributes.latitude | float |
緯度 (latitude) |
|
ロケール
|
data.attributes.locale | string |
ロケール |
|
logo-small-url
|
data.attributes.logo-small-url | string |
logo-small-url |
|
logo-thumb-url
|
data.attributes.logo-thumb-url | string |
logo-thumb-url |
|
logo-url
|
data.attributes.logo-url | string |
logo-url |
|
経度 (longitude)
|
data.attributes.longitude | float |
経度 (longitude) |
|
名前
|
data.attributes.name | string |
名前 |
|
printer-notifications-enabled
|
data.attributes.printer-notifications-enabled | boolean |
printer-notifications-enabled |
|
複数言語対応
|
data.attributes.multiple-languages-enabled | boolean |
複数言語対応 |
|
enabled-locales
|
data.attributes.enabled-locales | array of |
enabled-locales |
|
状態
|
data.attributes.state | string |
状態 |
|
timezone
|
data.attributes.timezone | string |
timezone |
|
ジップ
|
data.attributes.zip | string |
ジップ |
|
average-monthly-visitors
|
data.attributes.average-monthly-visitors | float |
average-monthly-visitors |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
last-entry-at
|
data.attributes.last-entry-at | string |
last-entry-at |
|
updated-at
|
data.attributes.updated-at | string |
updated-at |
|
self
|
data.relationships.company.links.self | string |
self |
|
関連
|
data.relationships.company.links.related | string |
関連 |
|
self
|
data.relationships.device-config.links.self | string |
self |
|
関連
|
data.relationships.device-config.links.related | string |
関連 |
|
self
|
data.relationships.gdpr-configuration.links.self | string |
self |
|
関連
|
data.relationships.gdpr-configuration.links.related | string |
関連 |
|
self
|
data.relationships.printer.links.self | string |
self |
|
関連
|
data.relationships.printer.links.related | string |
関連 |
|
self
|
data.relationships.devices.links.self | string |
self |
|
関連
|
data.relationships.devices.links.related | string |
関連 |
|
self
|
data.relationships.employees.links.self | string |
self |
|
関連
|
data.relationships.employees.links.related | string |
関連 |
|
self
|
data.relationships.fallback-contacts.links.self | string |
self |
|
関連
|
data.relationships.fallback-contacts.links.related | string |
関連 |
|
self
|
data.relationships.flows.links.self | string |
self |
|
関連
|
data.relationships.flows.links.related | string |
関連 |
|
self
|
data.relationships.locations-setup-guide-steps.links.self | string |
self |
|
関連
|
data.relationships.locations-setup-guide-steps.links.related | string |
関連 |
|
self
|
data.relationships.printers.links.self | string |
self |
|
関連
|
data.relationships.printers.links.related | string |
関連 |
|
self
|
data.relationships.printer-contacts.links.self | string |
self |
|
関連
|
data.relationships.printer-contacts.links.related | string |
関連 |
|
トータル
|
meta.total | integer |
トータル |
|
first
|
links.first | string |
first |
|
last
|
links.last | string |
last |
従業員の一覧を取得する
従業員リストを取得するための GET 要求
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of object |
データ |
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
self
|
data.links.self | string |
self |
|
cc-employee
|
data.attributes.cc-employee | boolean |
cc-employee |
|
company-id
|
data.attributes.company-id | integer |
company-id |
|
削除されました
|
data.attributes.deleted | boolean |
削除されました |
|
do-not-sync
|
data.attributes.do-not-sync | boolean |
do-not-sync |
|
メール
|
data.attributes.email | string |
メール |
|
hide-from-host-list
|
data.attributes.hide-from-host-list | boolean |
hide-from-host-list |
|
手動で追加
|
data.attributes.manually-added | boolean |
手動で追加 |
|
manually-added-location-present
|
data.attributes.manually-added-location-present | boolean |
manually-added-location-present |
|
名前
|
data.attributes.name | string |
名前 |
|
phone-number
|
data.attributes.phone-number | string |
phone-number |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
deleted-at
|
data.attributes.deleted-at | string |
deleted-at |
|
updated-at
|
data.attributes.updated-at | string |
updated-at |
|
self
|
data.relationships.company.links.self | string |
self |
|
関連
|
data.relationships.company.links.related | string |
関連 |
|
self
|
data.relationships.user.links.self | string |
self |
|
関連
|
data.relationships.user.links.related | string |
関連 |
|
self
|
data.relationships.assistants.links.self | string |
self |
|
関連
|
data.relationships.assistants.links.related | string |
関連 |
|
self
|
data.relationships.bosses.links.self | string |
self |
|
関連
|
data.relationships.bosses.links.related | string |
関連 |
|
self
|
data.relationships.employee-locations.links.self | string |
self |
|
関連
|
data.relationships.employee-locations.links.related | string |
関連 |
|
self
|
data.relationships.locations.links.self | string |
self |
|
関連
|
data.relationships.locations.links.related | string |
関連 |
|
トータル
|
meta.total | integer |
トータル |
|
first
|
links.first | string |
first |
|
last
|
links.last | string |
last |
招待の作成
これは、招待を作成するための POST 要求です
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテンツタイプ
|
Content-Type | string |
コンテンツタイプ |
|
|
full-name
|
full-name | string |
full-name |
|
|
メール
|
string |
メール |
||
|
inviter-name
|
inviter-name | string |
inviter-name |
|
|
expected-arrival-time
|
expected-arrival-time | string |
expected-arrival-time |
|
|
recurring-rule
|
recurring-rule | string |
recurring-rule |
|
|
rrule-until
|
rrule-until | string |
rrule-until |
|
|
private-notes
|
private-notes | string |
private-notes |
|
|
been-here-before
|
been-here-before | boolean |
been-here-before |
|
|
additional-guests
|
additional-guests | integer |
additional-guests |
|
|
skip-guest-notification
|
skip-guest-notification | boolean |
skip-guest-notification |
|
|
agreements-status
|
agreements-status | string |
agreements-status |
|
|
place-id
|
place-id | string |
place-id |
|
|
flow-name
|
flow-name | string |
flow-name |
|
|
group-name
|
group-name | string |
group-name |
|
|
到着
|
arrived | boolean |
到着 |
|
|
approval-status
|
approval-status | string |
approval-status |
|
|
フィールド
|
field | string |
フィールド |
|
|
value
|
value | string |
value |
|
|
型
|
type | string |
型 |
|
|
id
|
id | string |
id (employee) |
|
|
型
|
type | string |
型 |
|
|
id
|
id | string |
id (location) |
|
|
型
|
type | string |
型 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
self
|
data.links.self | string |
self |
|
additional-guests
|
data.attributes.additional-guests | integer |
additional-guests |
|
状態
|
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 |
|
理由
|
data.attributes.approval-status.report.reason | string |
理由 |
|
SMS 送信
|
data.attributes.approval-status.report.messages.failure.text | string |
SMS 送信 |
|
ヘッダー
|
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 |
メール |
|
expected-arrival-time
|
data.attributes.expected-arrival-time | string |
expected-arrival-time |
|
出発予定時刻
|
data.attributes.expected-departure-time | string |
出発予定時刻 |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
guest-updated-at
|
data.attributes.guest-updated-at | string |
guest-updated-at |
|
is-presigned
|
data.attributes.is-presigned | boolean |
is-presigned |
|
address
|
data.attributes.location-info.address | string |
address |
|
id
|
data.attributes.location-info.id | integer |
id |
|
名前
|
data.attributes.location-info.name | string |
名前 |
|
logo_url
|
data.attributes.location-info.logo_url | string |
logo_url |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
user-data
|
data.attributes.user-data | array of object |
user-data |
|
|
data.attributes.user-data.field | string |
フィールド |
|
|
data.attributes.user-data.value | string |
value |
|
notify-visitor
|
data.attributes.notify-visitor | boolean |
notify-visitor |
|
created-from
|
data.attributes.created-from | string |
created-from |
|
到着
|
data.attributes.arrived | boolean |
到着 |
|
touchless-sign-in-available-time
|
data.attributes.touchless-sign-in-available-time | string |
touchless-sign-in-available-time |
|
touchless-sign-in-presence-required
|
data.attributes.touchless-sign-in-presence-required | boolean |
touchless-sign-in-presence-required |
|
entry-signed-out-at
|
data.attributes.entry-signed-out-at | string |
entry-signed-out-at |
|
preregistration-link
|
data.attributes.preregistration-link | string |
preregistration-link |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
updated-at
|
data.attributes.updated-at | string |
updated-at |
|
self
|
data.relationships.attendee.links.self | string |
self |
|
関連
|
data.relationships.attendee.links.related | string |
関連 |
|
self
|
data.relationships.creator.links.self | string |
self |
|
関連
|
data.relationships.creator.links.related | string |
関連 |
|
self
|
data.relationships.employee.links.self | string |
self |
|
関連
|
data.relationships.employee.links.related | string |
関連 |
|
型
|
data.relationships.employee.data.type | string |
型 |
|
id
|
data.relationships.employee.data.id | string |
id |
|
self
|
data.relationships.entry.links.self | string |
self |
|
関連
|
data.relationships.entry.links.related | string |
関連 |
|
型
|
data.relationships.entry.data.type | object |
型 |
|
id
|
data.relationships.entry.data.id | string |
id |
|
self
|
data.relationships.flow.links.self | string |
self |
|
関連
|
data.relationships.flow.links.related | string |
関連 |
|
型
|
data.relationships.flow.data.type | string |
型 |
|
id
|
data.relationships.flow.data.id | string |
id |
|
self
|
data.relationships.location.links.self | string |
self |
|
関連
|
data.relationships.location.links.related | string |
関連 |
|
型
|
data.relationships.location.data.type | string |
型 |
|
id
|
data.relationships.location.data.id | string |
id |
|
self
|
data.relationships.platform-jobs.links.self | string |
self |
|
関連
|
data.relationships.platform-jobs.links.related | string |
関連 |
招待を 1 つ取得する
1 つの招待に関する情報を取得するための GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
invite_id
|
invite_id | True | string |
invite_id |
|
Accept
|
Accept | string |
Accept |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
メール
|
data.attributes.email | string |
メール |
|
inviter-name
|
data.attributes.inviter-name | string |
inviter-name |
|
expected-arrival-time
|
data.attributes.expected-arrival-time | string |
expected-arrival-time |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
到着
|
data.attributes.arrived | boolean |
到着 |
|
been-here-before
|
data.attributes.been-here-before | boolean |
been-here-before |
|
flow-name
|
data.attributes.flow-name | string |
flow-name |
|
flow-id
|
data.attributes.flow-id | integer |
flow-id |
|
user-data
|
data.attributes.user-data | array of object |
user-data |
|
フィールド
|
data.attributes.user-data.field | string |
フィールド |
|
value
|
data.attributes.user-data.value | string |
value |
|
additional-guests
|
data.attributes.additional-guests | integer |
additional-guests |
|
guest-updated-at
|
data.attributes.guest-updated-at | string |
guest-updated-at |
|
nda
|
data.attributes.nda | string |
nda |
|
nda-available
|
data.attributes.nda-available | boolean |
nda-available |
|
original-nda-sign-date
|
data.attributes.original-nda-sign-date | string |
original-nda-sign-date |
|
secret-token
|
data.attributes.secret-token | string |
secret-token |
|
approval-status
|
data.attributes.approval-status | string |
approval-status |
|
型
|
data.relationships.entry.data.type | string |
型 |
|
id
|
data.relationships.entry.data.id | string |
id |
|
id
|
data.relationships.location.data.id | string |
id |
|
型
|
data.relationships.location.data.type | string |
型 |
|
型
|
data.relationships.flow.data.type | string |
型 |
|
id
|
data.relationships.flow.data.id | string |
id |
|
型
|
data.relationships.employee.data.type | string |
型 |
|
id
|
data.relationships.employee.data.id | string |
id |
|
型
|
data.relationships.creator.data.type | string |
型 |
|
id
|
data.relationships.creator.data.id | string |
id |
|
含ま
|
included | array of object |
含ま |
|
id
|
included.id | string |
id |
|
型
|
included.type | string |
型 |
|
full-name
|
included.attributes.full-name | string |
full-name |
|
メール
|
included.attributes.email | string |
メール |
|
phone-number
|
included.attributes.phone-number | string |
phone-number |
|
アバター
|
included.attributes.avatar | string |
アバター |
|
created-at
|
included.attributes.created-at | string |
created-at |
|
email-enabled
|
included.attributes.email-enabled | boolean |
email-enabled |
|
sms-enabled
|
included.attributes.sms-enabled | boolean |
sms-enabled |
|
call-enabled
|
included.attributes.call-enabled | string |
call-enabled |
|
slack 対応
|
included.attributes.slack-enabled | boolean |
slack 対応 |
|
hipchat 対応
|
included.attributes.hipchat-enabled | boolean |
hipchat 対応 |
|
push-enabled
|
included.attributes.push-enabled | boolean |
push-enabled |
|
invite-push-enabled
|
included.attributes.invite-push-enabled | boolean |
invite-push-enabled |
|
has-profile
|
included.attributes.has-profile | boolean |
has-profile |
|
intercom-identity-hash
|
included.attributes.intercom-identity-hash | string |
intercom-identity-hash |
|
関連
|
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 |
型 |
|
id
|
included.relationships.emails.data.id | string |
id |
|
self
|
links.self | string |
self |
招待を取得する
フィルター処理に基づいて招待情報を取得する GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
filter[location]
|
filter[location] | integer |
filter[location] |
|
|
filter[date]
|
filter[date] | string |
filter[date] |
|
|
Accept
|
Accept | string |
Accept |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
データ
|
data | array of object |
データ |
|
id
|
data.id | string |
id |
|
型
|
data.type | string |
型 |
|
self
|
data.links.self | string |
self |
|
additional-guests
|
data.attributes.additional-guests | integer |
additional-guests |
|
状態
|
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 |
|
理由
|
data.attributes.approval-status.report.reason | string |
理由 |
|
SMS 送信
|
data.attributes.approval-status.report.messages.failure.text | string |
SMS 送信 |
|
ヘッダー
|
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 |
メール |
|
expected-arrival-time
|
data.attributes.expected-arrival-time | string |
expected-arrival-time |
|
出発予定時刻
|
data.attributes.expected-departure-time | string |
出発予定時刻 |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
guest-updated-at
|
data.attributes.guest-updated-at | string |
guest-updated-at |
|
is-presigned
|
data.attributes.is-presigned | boolean |
is-presigned |
|
address
|
data.attributes.location-info.address | string |
address |
|
id
|
data.attributes.location-info.id | integer |
id |
|
名前
|
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 |
|
private-notes
|
data.attributes.private-notes | string |
private-notes |
|
user-data
|
data.attributes.user-data | array of object |
user-data |
|
フィールド
|
data.attributes.user-data.field | string |
フィールド |
|
value
|
data.attributes.user-data.value | string |
value |
|
notify-visitor
|
data.attributes.notify-visitor | boolean |
notify-visitor |
|
created-from
|
data.attributes.created-from | string |
created-from |
|
place_id
|
data.attributes.locality.place_id | string |
place_id |
|
place-id
|
data.attributes.locality.place-id | string |
place-id |
|
到着
|
data.attributes.arrived | boolean |
到着 |
|
touchless-sign-in-available-time
|
data.attributes.touchless-sign-in-available-time | string |
touchless-sign-in-available-time |
|
touchless-sign-in-presence-required
|
data.attributes.touchless-sign-in-presence-required | boolean |
touchless-sign-in-presence-required |
|
entry-signed-out-at
|
data.attributes.entry-signed-out-at | string |
entry-signed-out-at |
|
証明
|
data.attributes.attested | string |
証明 |
|
phone
|
data.attributes.phone | string |
phone |
|
preregistration-link
|
data.attributes.preregistration-link | string |
preregistration-link |
|
preregistration-status-link
|
data.attributes.preregistration-status-link | string |
preregistration-status-link |
|
reminder-sent-at
|
data.attributes.reminder-sent-at | string |
reminder-sent-at |
|
created-at
|
data.attributes.created-at | string |
created-at |
|
updated-at
|
data.attributes.updated-at | string |
updated-at |
|
self
|
data.relationships.attendee.links.self | string |
self |
|
関連
|
data.relationships.attendee.links.related | string |
関連 |
|
self
|
data.relationships.creator.links.self | string |
self |
|
関連
|
data.relationships.creator.links.related | string |
関連 |
|
self
|
data.relationships.employee.links.self | string |
self |
|
関連
|
data.relationships.employee.links.related | string |
関連 |
|
型
|
data.relationships.employee.data.type | string |
型 |
|
id
|
data.relationships.employee.data.id | string |
id |
|
self
|
data.relationships.entry.links.self | string |
self |
|
関連
|
data.relationships.entry.links.related | string |
関連 |
|
型
|
data.relationships.entry.data.type | string |
型 |
|
id
|
data.relationships.entry.data.id | string |
id |
|
self
|
data.relationships.flow.links.self | string |
self |
|
関連
|
data.relationships.flow.links.related | string |
関連 |
|
型
|
data.relationships.flow.data.type | string |
型 |
|
id
|
data.relationships.flow.data.id | string |
id |
|
self
|
data.relationships.location.links.self | string |
self |
|
関連
|
data.relationships.location.links.related | string |
関連 |
|
型
|
data.relationships.location.data.type | string |
型 |
|
id
|
data.relationships.location.data.id | string |
id |
|
self
|
data.relationships.platform-jobs.links.self | string |
self |
|
関連
|
data.relationships.platform-jobs.links.related | string |
関連 |
|
トータル
|
meta.total | integer |
トータル |
|
first
|
links.first | string |
first |
|
次に
|
links.next | string |
次に |
|
last
|
links.last | string |
last |
トリガー
| Invite-Created トリガー |
エンボイ招待が作成されたときに MS Flow でアクションをトリガーします。 |
Invite-Created トリガー
エンボイ招待が作成されたときに MS Flow でアクションをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トークン
|
token | string |
トークン |