Envoy (プレビュー)
Envoy アカウント (REST API エンドポイント) を他のコネクタに接続できるようにする Envoy コネクタ。 例として、Microsoft Excel Online スプレッドシートの詳細を使用して Envoy で一括招待を作成する場合があります。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Envoy サポートチーム |
| [URL] | https://envoy.help/ |
| メール | hi@envoy.com |
| Connector Metadata | |
|---|---|
| 発行者 | Envoy, Inc. |
| Web サイト | https://envoy.com/ |
| プライバシー ポリシー | https://envoy.com/privacypolicy/ |
| カテゴリ | ビジネスインテリジェンス ; データ |
バージョン 2.0 では、Envoy Invite の作成をトリガーとして使用することもできます。
前提条件
このコネクタを使用するには、ユーザー名とパスワードが記載された Envoy アカウントが必要です。 機能をトリガーするには、Envoy Integration の「Microsoft Flow」をインストールする必要もあります。
資格情報の入手方法
Envoy に対して認証するには、Envoy のユーザー名とパスワードが必要です。
機能をトリガーするには、Envoy 内の「Microsoft Flow」統合セットアップのステップ 2 で提供されたインストール トークンが必要です。
既知の問題と制限事項
現時点で利用可能なトリガーは、招待作成のみです。 近い将来、さらにトリガーを追加する予定です。
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| ユーザー名 | securestring | この API のユーザー名 | 真 |
| パスワード | securestring | この API のパスワード | 真 |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| 1 つのエントリを取得します |
単一のエントリに関する情報を取得するための GET 要求。 |
| 1 つの招待を更新する |
招待の情報を更新するための PATCH 要求。 |
| フローの取得 |
現在地のフローに関する情報を取得するための GET 要求。 |
| ブロックリスト フィルターを取得する |
ブロックリスト フィルターを取得するための GET 要求。 |
| ブロックリスト フィルターを追加する |
ブロックリスト フィルターを追加する POST リクエスト |
| 会社情報を取得する |
会社周辺の情報を取得する (GET) |
| 場所の取得 |
場所を取得するための GET 要求 |
| 従業員のリストを取得する |
従業員リストを取得するための GET 要求 |
| 招待状を 1 つ取得 |
単一の招待状に関する情報を取得するための GET 要求。 |
| 招待状を作成する |
これは招待状を作成するための POST リクエストです |
| 招待状を受け取る |
フィルタリングに基づいて招待情報を取得するための GET 要求。 |
1 つのエントリを取得します
単一のエントリに関する情報を取得するための GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
entry_id
|
entry_id | True | string |
entry_id |
|
フィルター [場所]
|
filter[location] | integer |
フィルター [場所] |
|
|
承認
|
Accept | string |
承認 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
data.id | string |
ID |
|
種類
|
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 |
非公開メモ |
|
次でサインイン
|
data.attributes.signed-in-at | string |
次でサインイン |
|
デバイス セッション uuid
|
data.attributes.device-session-uuid | string |
デバイス セッション uuid |
|
次を介してサインイン
|
data.attributes.signed-in-via | string |
次を介してサインイン |
|
次によるサインイン
|
data.attributes.signed-in-by | string |
次によるサインイン |
|
次を介してサインアウト
|
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 署名の日付
|
data.attributes.original-nda-sign-date | string |
オリジナルの NDA 署名の日付 |
|
ID 検査の状態
|
data.attributes.id-check-status | string |
ID 検査の状態 |
|
配送である
|
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 |
フィールド |
|
値
|
data.attributes.user-data.value | string |
値 |
|
SMS 状態
|
data.attributes.sms-status | string |
SMS 状態 |
|
承認状態
|
data.attributes.approval-status | string |
承認状態 |
|
プッシュ状態
|
data.attributes.push-status | string |
プッシュ状態 |
|
メールの状態
|
data.attributes.email-status | string |
メールの状態 |
|
Slack の状態
|
data.attributes.slack-status | string |
Slack の状態 |
|
HipChat の状態
|
data.attributes.hipchat-status | string |
HipChat の状態 |
|
種類
|
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 |
関連 |
|
セルフ
|
links.self | string |
セルフ |
1 つの招待を更新する
招待の情報を更新するための PATCH 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
招待状 ID
|
invite_id | True | string |
招待状 ID |
|
コンテンツ タイプ
|
Content-Type | string |
コンテンツ タイプ |
|
|
ID
|
id | string |
ID |
|
|
氏名
|
full-name | string |
氏名 |
|
|
電子メール
|
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
|
nda | string |
NDA |
|
|
ゲスト更新時刻
|
guest-updated-at | string |
ゲスト更新時刻 (形式 : 2019-03-24T21:15:00.000Z) |
|
|
オリジナルの NDA 署名の日付
|
original-nda-sign-date | string |
オリジナルの NDA 署名の日付 |
|
|
NDA あり
|
nda-available | boolean |
NDA あり |
|
|
フロー名
|
flow-name | string |
フロー名 |
|
|
到着
|
arrived | boolean |
到着 |
|
|
承認状態
|
approval-status | string |
承認状態 |
|
|
フィールド
|
field | string |
フィールド |
|
|
価値
|
value | string |
価値 |
|
|
タイプ
|
type | string |
タイプ |
|
|
id
|
id | string |
id |
|
|
タイプ
|
type | string |
タイプ |
|
|
id
|
id | string |
ID (従業員) |
|
|
タイプ
|
type | string |
タイプ |
|
|
id
|
id | string |
ID (場所) |
|
|
タイプ
|
type | string |
タイプ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
data.id | string |
ID |
|
種類
|
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 |
フィールド |
|
値
|
data.attributes.user-data.value | string |
値 |
|
追加ゲスト
|
data.attributes.additional-guests | integer |
追加ゲスト |
|
ゲスト更新時刻
|
data.attributes.guest-updated-at | string |
ゲスト更新時刻 |
|
NDA
|
data.attributes.nda | string |
NDA |
|
NDA あり
|
data.attributes.nda-available | boolean |
NDA あり |
|
オリジナルの NDA 署名の日付
|
data.attributes.original-nda-sign-date | string |
オリジナルの NDA 署名の日付 |
|
シークレット トークン
|
data.attributes.secret-token | string |
シークレット トークン |
|
グループ名
|
data.attributes.group-name | string |
グループ名 |
|
写真の URL
|
data.attributes.photo-url | string |
写真の URL |
|
QRコード
|
data.attributes.qr-code | string |
QRコード |
|
QRコードを次に送る
|
data.attributes.qr-code-sent-at | string |
QRコードを次に送る |
|
事前登録の完了
|
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 |
|
理由
|
data.attributes.approval-status.report.reason | string |
理由 |
|
テキスト
|
data.attributes.approval-status.report.messages.failure.text | string |
テキスト |
|
ヘッダー
|
data.attributes.approval-status.report.messages.failure.header | string |
ヘッダー |
|
レビュアーの ID
|
data.attributes.approval-status.reviewer-id | string |
レビュアーの ID |
|
レビュアーの名前
|
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 |
タイプ |
|
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 |
名前 |
|
セルフ
|
links.self | string |
セルフ |
フローの取得
現在地のフローに関する情報を取得するための GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィルター [場所]
|
filter[location] | integer |
フィルター [場所] |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
ID
|
data.id | string |
ID |
|
種類
|
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 |
バッジ対応 |
|
有効
|
data.attributes.enabled | boolean |
有効 |
|
ID の検査
|
data.attributes.id-check | boolean |
ID の検査 |
|
iPad のローカライズされた名前
|
data.attributes.ipad-localized-names | array of object |
iPad のローカライズされた名前 |
|
language-code
|
data.attributes.ipad-localized-names.language-code | string |
language-code |
|
リージョン コード
|
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 |
最初 |
|
最後
|
links.last | string |
最後 |
ブロックリスト フィルターを取得する
ブロックリスト フィルターを取得するための GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィルター [会社]
|
filter[company] | integer |
フィルター [会社] |
|
|
コンテンツ タイプ
|
Content-Type | string |
コンテンツ タイプ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
ID
|
data.id | string |
ID |
|
種類
|
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 |
親指 |
|
理由
|
data.attributes.reason | string |
理由 |
|
画像 URL
|
data.attributes.image-url | string |
画像 URL |
|
外部 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 |
合計 |
ブロックリスト フィルターを追加する
ブロックリスト フィルターを追加する POST リクエスト
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
エイリアス
|
aliases | array of |
エイリアス |
|
|
description
|
description | string |
description |
|
|
メール
|
emails | array of string |
メール |
|
|
氏名
|
full-name | string |
氏名 |
|
|
keyword
|
keyword | string |
keyword |
|
|
その他のキーワード
|
other-keywords | array of |
その他のキーワード |
|
|
reason
|
reason | string |
reason |
|
|
電話番号
|
phone-numbers | array of |
電話番号 |
|
|
タイプ
|
type | string |
タイプ |
|
|
id
|
id | string |
ID (場所) |
|
|
タイプ
|
type | string |
タイプ |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
タイプ
|
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 |
親指 |
|
理由
|
data.attributes.reason | string |
理由 |
|
作成者
|
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 |
関連 |
会社情報を取得する
会社周辺の情報を取得する (GET)
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
承認
|
Accept | string |
承認 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
合計
|
meta.total | integer |
合計 |
|
リミット
|
meta.limit | integer |
リミット |
|
オフセット
|
meta.offset | integer |
オフセット |
|
data
|
data | array of object |
data |
|
ID
|
data.id | string |
ID |
|
種類
|
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 |
種類 |
|
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
|
data.relationships.contracts.data | array of object |
data |
|
種類
|
data.relationships.contracts.data.type | string |
種類 |
|
ID
|
data.relationships.contracts.data.id | string |
ID |
|
data
|
data.relationships.administrators.data | array of object |
data |
|
種類
|
data.relationships.administrators.data.type | string |
種類 |
|
ID
|
data.relationships.administrators.data.id | string |
ID |
|
data
|
data.relationships.locations.data | array of object |
data |
|
種類
|
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 |
|
セルフ
|
links.self | string |
セルフ |
|
最初
|
links.first | string |
最初 |
|
最後
|
links.last | string |
最後 |
場所の取得
場所を取得するための GET 要求
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
承認
|
Accept | string |
承認 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
ID
|
data.id | string |
ID |
|
種類
|
data.type | string |
種類 |
|
セルフ
|
data.links.self | string |
セルフ |
|
アドレス
|
data.attributes.address | string |
アドレス |
|
住所 1
|
data.attributes.address-line-one | string |
住所 1 |
|
住所 2
|
data.attributes.address-line-two | string |
住所 2 |
|
深夜の自動サインアウト
|
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 |
事前登録制の有効化 |
|
latitude
|
data.attributes.latitude | float |
latitude |
|
ロケール
|
data.attributes.locale | string |
ロケール |
|
ロゴ スモール URL
|
data.attributes.logo-small-url | string |
ロゴ スモール URL |
|
ロゴ親指 URL
|
data.attributes.logo-thumb-url | string |
ロゴ親指 URL |
|
ロゴ URL
|
data.attributes.logo-url | string |
ロゴ URL |
|
longitude
|
data.attributes.longitude | float |
longitude |
|
名前
|
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 |
状態 |
|
タイムゾーン
|
data.attributes.timezone | string |
タイムゾーン |
|
zip
|
data.attributes.zip | string |
zip |
|
月別平均訪問者
|
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 |
最初 |
|
最後
|
links.last | string |
最後 |
従業員のリストを取得する
従業員リストを取得するための GET 要求
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
ID
|
data.id | string |
ID |
|
種類
|
data.type | string |
種類 |
|
セルフ
|
data.links.self | string |
セルフ |
|
cc - 従業員
|
data.attributes.cc-employee | boolean |
cc - 従業員 |
|
会社 ID
|
data.attributes.company-id | integer |
会社 ID |
|
削除済み
|
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 |
最初 |
|
最後
|
links.last | string |
最後 |
招待状を 1 つ取得
単一の招待状に関する情報を取得するための GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
招待状 ID
|
invite_id | True | string |
招待状 ID |
|
承認
|
Accept | string |
承認 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
data.id | string |
ID |
|
種類
|
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 |
フィールド |
|
値
|
data.attributes.user-data.value | string |
値 |
|
追加ゲスト
|
data.attributes.additional-guests | integer |
追加ゲスト |
|
ゲスト更新時刻
|
data.attributes.guest-updated-at | string |
ゲスト更新時刻 |
|
NDA
|
data.attributes.nda | string |
NDA |
|
NDA あり
|
data.attributes.nda-available | boolean |
NDA あり |
|
オリジナルの NDA 署名の日付
|
data.attributes.original-nda-sign-date | string |
オリジナルの NDA 署名の日付 |
|
シークレット トークン
|
data.attributes.secret-token | string |
シークレット トークン |
|
承認状態
|
data.attributes.approval-status | string |
承認状態 |
|
タイプ
|
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
|
included | array of object |
含む |
|
ID
|
included.id | string |
ID |
|
種類
|
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 |
メールが有効 |
|
SMS が有効
|
included.attributes.sms-enabled | boolean |
SMS が有効 |
|
呼び出しが有効
|
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 |
招待プッシュが有効 |
|
プロファイルがある
|
included.attributes.has-profile | boolean |
プロファイルがある |
|
インターコムの ID ハッシュ
|
included.attributes.intercom-identity-hash | string |
インターコムの ID ハッシュ |
|
関連
|
included.relationships.location-roles.links.related | string |
関連 |
|
関連
|
included.relationships.company-roles.links.related | string |
関連 |
|
data
|
included.relationships.emails.data | array of object |
data |
|
種類
|
included.relationships.emails.data.type | string |
種類 |
|
ID
|
included.relationships.emails.data.id | string |
ID |
|
セルフ
|
links.self | string |
セルフ |
招待状を作成する
これは招待状を作成するための POST リクエストです
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
コンテンツ タイプ
|
Content-Type | string |
コンテンツ タイプ |
|
|
氏名
|
full-name | string |
氏名 |
|
|
電子メール
|
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 |
契約の状態 |
|
|
場所 ID
|
place-id | string |
場所 ID |
|
|
フロー名
|
flow-name | string |
フロー名 |
|
|
グループ名
|
group-name | string |
グループ名 |
|
|
到着
|
arrived | boolean |
到着 |
|
|
承認状態
|
approval-status | string |
承認状態 |
|
|
フィールド
|
field | string |
フィールド |
|
|
値
|
value | string |
値 |
|
|
種類
|
type | string |
種類 |
|
|
ID
|
id | string |
ID (従業員) |
|
|
種類
|
type | string |
種類 |
|
|
ID
|
id | string |
ID (場所) |
|
|
種類
|
type | string |
種類 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
data.id | string |
ID |
|
種類
|
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 |
|
理由
|
data.attributes.approval-status.report.reason | string |
理由 |
|
テキスト
|
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 |
事前サイン済み |
|
アドレス
|
data.attributes.location-info.address | string |
アドレス |
|
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 |
|
非公開メモ
|
data.attributes.private-notes | string |
非公開メモ |
|
ユーザー データ
|
data.attributes.user-data | array of object |
ユーザー データ |
|
|
data.attributes.user-data.field | string |
フィールド |
|
|
data.attributes.user-data.value | string |
値 |
|
訪問者通知
|
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 |
タッチレス サインイン存在必須 |
|
エントリ サインアウト時刻
|
data.attributes.entry-signed-out-at | string |
エントリ サインアウト時刻 |
|
登録前リンク
|
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 |
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 |
|
セルフ
|
data.relationships.platform-jobs.links.self | string |
セルフ |
|
関連
|
data.relationships.platform-jobs.links.related | string |
関連 |
招待状を受け取る
フィルタリングに基づいて招待情報を取得するための GET 要求。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィルター [場所]
|
filter[location] | integer |
フィルター [場所] |
|
|
フィルター [データ]
|
filter[date] | string |
フィルター [データ] |
|
|
承認
|
Accept | string |
承認 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
ID
|
data.id | string |
ID |
|
種類
|
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 |
|
理由
|
data.attributes.approval-status.report.reason | string |
理由 |
|
テキスト
|
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 |
事前サイン済み |
|
アドレス
|
data.attributes.location-info.address | string |
アドレス |
|
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 |
|
タイムゾーン
|
data.attributes.location-info.timezone | string |
タイムゾーン |
|
非公開メモ
|
data.attributes.private-notes | string |
非公開メモ |
|
ユーザー データ
|
data.attributes.user-data | array of object |
ユーザー データ |
|
フィールド
|
data.attributes.user-data.field | string |
フィールド |
|
価値
|
data.attributes.user-data.value | string |
価値 |
|
訪問者通知
|
data.attributes.notify-visitor | boolean |
訪問者通知 |
|
作成元
|
data.attributes.created-from | string |
作成元 |
|
place_id
|
data.attributes.locality.place_id | string |
place_id |
|
場所 ID
|
data.attributes.locality.place-id | string |
場所 ID |
|
到着
|
data.attributes.arrived | boolean |
到着 |
|
タッチレス サインイン使用可能時刻
|
data.attributes.touchless-sign-in-available-time | string |
タッチレス サインイン使用可能時刻 |
|
タッチレス サインイン存在必須
|
data.attributes.touchless-sign-in-presence-required | boolean |
タッチレス サインイン存在必須 |
|
エントリ サインアウト時刻
|
data.attributes.entry-signed-out-at | string |
エントリ サインアウト時刻 |
|
証明済み
|
data.attributes.attested | string |
証明済み |
|
電話
|
data.attributes.phone | string |
電話 |
|
登録前リンク
|
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 |
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 |
|
セルフ
|
data.relationships.platform-jobs.links.self | string |
セルフ |
|
関連
|
data.relationships.platform-jobs.links.related | string |
関連 |
|
合計
|
meta.total | integer |
合計 |
|
最初
|
links.first | string |
最初 |
|
次へ
|
links.next | string |
次へ |
|
最後
|
links.last | string |
最後 |
トリガー
| 招待状で作成されたトリガー |
Envoy 招待が作成されたときに、MS Flow でアクションをトリガーします。 |
招待状で作成されたトリガー
Envoy 招待が作成されたときに、MS Flow でアクションをトリガーします。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
トークン
|
token | string |
トークン |