VirtualStore
VirtualStore APIで予約・店舗・ホストを管理
トリガー
このノードでフローを開始できるイベントです。トリガーを選択 から追加します。
予約作成
予約が作成されたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば session は $trigger.output.session です。
{
"session": {},
"guests": [
{
"id": "string",
"familyName": "string",
"firstName": "string",
"familyFurigana": "string",
"firstFurigana": "string",
"familyKatakana": "string",
"firstKatakana": "string",
"phoneNumber": "string",
"line": {},
"email": "string",
"hashId": "string",
"visitorId": "string",
"isBooker": false,
"identity": "string",
"fullName": "string",
"externalId": "string",
"webId": "string",
"isSurveyEnabled": false
}
],
"store": {},
"equipment": {},
"hosts": [
{
"id": "string",
"email": "string",
"fullName": "string",
"profile": {},
"displayName": "string"
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
session | オブジェクト | VirtualStoreの予約イベントおよびアンケート回答イベント内のセッション情報 |
session.id | テキスト | セッションID |
session.oid | テキスト | セッションの組織ID |
session.flow | テキスト | 予約フロー |
session.status | テキスト | セッションのステータス |
session.type | テキスト | セッションの種類(例:オンライン、オフライン) |
session.startAt | テキスト | セッション開始日時(ISO 8601) |
session.endAt | テキスト | セッション終了日時(ISO 8601) |
session.createdAt | テキスト | 作成日時(ISO 8601) |
session.updatedAt | テキスト | 更新日時(ISO 8601) |
session.isPrivate | はい / いいえ | セッションがプライベートかどうか |
session.isRestorable | はい / いいえ | 予約を復元できるかどうか |
session.isTest | はい / いいえ | テストセッションかどうか |
session.isChangeable | はい / いいえ | 予約を変更できるかどうか |
session.isHostSelection | はい / いいえ | ホスト選択が有効かどうか |
session.urlType | テキスト | セッション作成時に使用されたURLの種類 |
session.rescheduledAt | テキスト | 日程変更日時(ISO 8601) |
session.originalHostId | テキスト | 日程変更前の元のホストID |
session.isRecorded | はい / いいえ | セッションが録画されるかどうか |
session.duration | オブジェクト | VirtualStoreイベント内の予約セッションの所要時間の詳細 |
session.duration.name | テキスト | 所要時間の名称 |
session.duration.duration | 数値 | 所要時間(分) |
session.duration.description | テキスト | 所要時間の説明 |
session.duration.bufferTime | 数値 | バッファ時間(分) |
session.duration.membership | テキスト | 所要時間に紐づくメンバーシップ |
session.duration.memberMode | テキスト | 所要時間に紐づくメンバーモード |
session.responses[] | リスト | セッションのアンケート結果・回答。最新の回答だけでなく、セッション内のすべてのアンケート回答(全ゲスト分)を含みます。responseId / resourceIdでグループ化してください |
session.responses[].id | テキスト | 回答ID |
session.responses[].surveyId | テキスト | アンケートID |
session.responses[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.responses[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.responses[].responseId | テキスト | 回答ID |
session.responses[].questionId | テキスト | 設問ID |
session.responses[].questionTitle | テキスト | 設問のタイトル |
session.responses[].questionExplanation | テキスト | 設問の説明 |
session.responses[].questionType | テキスト | 設問のフィールド種別 |
session.responses[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.responses[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.responses[].branchCode | テキスト | 回答から解析された支店コード |
session.responses[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.responses[].assets[] | リスト | 回答に添付されたアセット |
session.responses[].assets[].id | テキスト | アセットID |
session.responses[].assets[].name | テキスト | アセット名 |
session.responses[].assets[].url | テキスト | アセットのURL |
session.responses[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.responses[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.responses[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.responses[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.responses[].assets[].status | テキスト | アセットのステータス |
session.answers[] | リスト | セッションのヒアリングフォームの回答 |
session.answers[].id | テキスト | 回答ID |
session.answers[].surveyId | テキスト | アンケートID |
session.answers[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.answers[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.answers[].responseId | テキスト | 回答ID |
session.answers[].questionId | テキスト | 設問ID |
session.answers[].questionTitle | テキスト | 設問のタイトル |
session.answers[].questionExplanation | テキスト | 設問の説明 |
session.answers[].questionType | テキスト | 設問のフィールド種別 |
session.answers[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.answers[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.answers[].branchCode | テキスト | 回答から解析された支店コード |
session.answers[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.answers[].assets[] | リスト | 回答に添付されたアセット |
session.answers[].assets[].id | テキスト | アセットID |
session.answers[].assets[].name | テキスト | アセット名 |
session.answers[].assets[].url | テキスト | アセットのURL |
session.answers[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.answers[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.answers[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.answers[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.answers[].assets[].status | テキスト | アセットのステータス |
session.systemReadiness | オブジェクト | 予約セッションのシステム準備状況チェック |
session.systemReadiness.micro | はい / いいえ | マイクの準備状況 |
session.systemReadiness.camera | はい / いいえ | カメラの準備状況 |
session.systemReadiness.browser | はい / いいえ | ブラウザの準備状況 |
session.systemReadiness.speaker | はい / いいえ | スピーカーの準備状況 |
session.cancelledReason | テキスト | キャンセルの理由 |
session.cancelledBy | テキスト | セッションをキャンセルした人 |
guests[] | リスト | 予約のゲスト |
guests[].id | テキスト | ゲストID |
guests[].familyName | テキスト | ゲストの姓 |
guests[].firstName | テキスト | ゲストの名 |
guests[].familyFurigana | テキスト | 姓(ふりがな) |
guests[].firstFurigana | テキスト | 名(ふりがな) |
guests[].familyKatakana | テキスト | 姓(カタカナ) |
guests[].firstKatakana | テキスト | 名(カタカナ) |
guests[].phoneNumber | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | VirtualStoreイベント内のゲストのLINEプロフィール |
guests[].line.id | テキスト | LINEユーザーID(U接頭辞付き) |
guests[].line.name | テキスト | LINEの表示名 |
guests[].line.avatar | テキスト | LINEのアバターURL |
guests[].line.isFriend | はい / いいえ | ゲストがLINEの友だちかどうか |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].hashId | テキスト | ゲストのハッシュID |
guests[].visitorId | テキスト | 訪問者ID |
guests[].isBooker | はい / いいえ | このゲストが予約者かどうか |
guests[].identity | テキスト | ゲストのアイデンティティ |
guests[].fullName | テキスト | ゲストの氏名 |
guests[].externalId | テキスト | ゲストの外部ID |
guests[].webId | テキスト | ゲストのWeb ID |
guests[].isSurveyEnabled | はい / いいえ | ゲストに対してアンケートが有効かどうか |
store | オブジェクト | VirtualStoreイベント内のストア情報 |
store.id | テキスト | ストアID |
store.name | テキスト | ストア名 |
store.timezone | テキスト | ストアのタイムゾーン |
store.logo | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.logo.id | テキスト | アセットID |
store.logo.name | テキスト | アセット名 |
store.logo.url | テキスト | アセットのURL |
store.logo.createdAt | テキスト | 作成日時(ISO 8601) |
store.logo.mimeType | テキスト | アセットのMIMEタイプ |
store.logo.size | 数値 | アセットのサイズ(バイト) |
store.logo.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.logo.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.logo.status | テキスト | アセットのステータス |
store.image | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.image.id | テキスト | アセットID |
store.image.name | テキスト | アセット名 |
store.image.url | テキスト | アセットのURL |
store.image.createdAt | テキスト | 作成日時(ISO 8601) |
store.image.mimeType | テキスト | アセットのMIMEタイプ |
store.image.size | 数値 | アセットのサイズ(バイト) |
store.image.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.image.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.image.status | テキスト | アセットのステータス |
equipment | オブジェクト | VirtualStoreイベント内のオフライン予約用の機材情報 |
equipment.id | テキスト | 機材ID |
equipment.name | テキスト | 機材名 |
equipment.status | テキスト | 機材のステータス |
equipment.description | テキスト | 機材の説明 |
equipment.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
equipment.avatar.id | テキスト | アセットID |
equipment.avatar.name | テキスト | アセット名 |
equipment.avatar.url | テキスト | アセットのURL |
equipment.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
equipment.avatar.mimeType | テキスト | アセットのMIMEタイプ |
equipment.avatar.size | 数値 | アセットのサイズ(バイト) |
equipment.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
equipment.avatar.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
equipment.avatar.status | テキスト | アセットのステータス |
hosts[] | リスト | 予約のホスト(ホスト未割り当ての場合、要素はnullになります) |
hosts[].id | テキスト | ホストID |
hosts[].email | テキスト | ホストのメールアドレス |
hosts[].fullName | テキスト | ホストの氏名 |
hosts[].profile | オブジェクト | VirtualStoreイベント内のホストプロフィール情報 |
hosts[].profile.introduction | テキスト | ホストの自己紹介 |
hosts[].profile.position | テキスト | ホストの役職 |
hosts[].profile.url | テキスト | ホストのプロフィールURL |
hosts[].profile.twitter | テキスト | ホストのTwitterハンドル |
hosts[].profile.facebook | テキスト | ホストのFacebookプロフィール |
hosts[].profile.instagram | テキスト | ホストのInstagramプロフィール |
hosts[].profile.nickname | テキスト | ホストのニックネーム |
hosts[].profile.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
hosts[].profile.avatar.id | テキスト | アセットID |
hosts[].profile.avatar.name | テキスト | アセット名 |
hosts[].profile.avatar.url | テキスト | アセットのURL |
hosts[].profile.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
hosts[].profile.avatar.mimeType | テキスト | アセットのMIMEタイプ |
hosts[].profile.avatar.size | 数値 | アセットのサイズ(バイト) |
hosts[].profile.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
hosts[].profile.avatar.status | テキスト | アセットのステータス |
hosts[].displayName | テキスト | ホストの表示名 |
予約更新
予約が更新されたとき(終了時を含む)にトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば session は $trigger.output.session です。
{
"session": {},
"guests": [
{
"id": "string",
"familyName": "string",
"firstName": "string",
"familyFurigana": "string",
"firstFurigana": "string",
"familyKatakana": "string",
"firstKatakana": "string",
"phoneNumber": "string",
"line": {},
"email": "string",
"hashId": "string",
"visitorId": "string",
"isBooker": false,
"identity": "string",
"fullName": "string",
"externalId": "string",
"webId": "string",
"isSurveyEnabled": false
}
],
"store": {},
"equipment": {},
"hosts": [
{
"id": "string",
"email": "string",
"fullName": "string",
"profile": {},
"displayName": "string"
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
session | オブジェクト | VirtualStoreの予約イベントおよびアンケート回答イベント内のセッション情報 |
session.id | テキスト | セッションID |
session.oid | テキスト | セッションの組織ID |
session.flow | テキスト | 予約フロー |
session.status | テキスト | セッションのステータス |
session.type | テキスト | セッションの種類(例:オンライン、オフライン) |
session.startAt | テキスト | セッション開始日時(ISO 8601) |
session.endAt | テキスト | セッション終了日時(ISO 8601) |
session.createdAt | テキスト | 作成日時(ISO 8601) |
session.updatedAt | テキスト | 更新日時(ISO 8601) |
session.isPrivate | はい / いいえ | セッションがプライベートかどうか |
session.isRestorable | はい / いいえ | 予約を復元できるかどうか |
session.isTest | はい / いいえ | テストセッションかどうか |
session.isChangeable | はい / いいえ | 予約を変更できるかどうか |
session.isHostSelection | はい / いいえ | ホスト選択が有効かどうか |
session.urlType | テキスト | セッション作成時に使用されたURLの種類 |
session.rescheduledAt | テキスト | 日程変更日時(ISO 8601) |
session.originalHostId | テキスト | 日程変更前の元のホストID |
session.isRecorded | はい / いいえ | セッションが録画されるかどうか |
session.duration | オブジェクト | VirtualStoreイベント内の予約セッションの所要時間の詳細 |
session.duration.name | テキスト | 所要時間の名称 |
session.duration.duration | 数値 | 所要時間(分) |
session.duration.description | テキスト | 所要時間の説明 |
session.duration.bufferTime | 数値 | バッファ時間(分) |
session.duration.membership | テキスト | 所要時間に紐づくメンバーシップ |
session.duration.memberMode | テキスト | 所要時間に紐づくメンバーモード |
session.responses[] | リスト | セッションのアンケート結果・回答。最新の回答だけでなく、セッション内のすべてのアンケート回答(全ゲスト分)を含みます。responseId / resourceIdでグループ化してください |
session.responses[].id | テキスト | 回答ID |
session.responses[].surveyId | テキスト | アンケートID |
session.responses[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.responses[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.responses[].responseId | テキスト | 回答ID |
session.responses[].questionId | テキスト | 設問ID |
session.responses[].questionTitle | テキスト | 設問のタイトル |
session.responses[].questionExplanation | テキスト | 設問の説明 |
session.responses[].questionType | テキスト | 設問のフィールド種別 |
session.responses[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.responses[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.responses[].branchCode | テキスト | 回答から解析された支店コード |
session.responses[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.responses[].assets[] | リスト | 回答に添付されたアセット |
session.responses[].assets[].id | テキスト | アセットID |
session.responses[].assets[].name | テキスト | アセット名 |
session.responses[].assets[].url | テキスト | アセットのURL |
session.responses[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.responses[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.responses[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.responses[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.responses[].assets[].status | テキスト | アセットのステータス |
session.answers[] | リスト | セッションのヒアリングフォームの回答 |
session.answers[].id | テキスト | 回答ID |
session.answers[].surveyId | テキスト | アンケートID |
session.answers[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.answers[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.answers[].responseId | テキスト | 回答ID |
session.answers[].questionId | テキスト | 設問ID |
session.answers[].questionTitle | テキスト | 設問のタイトル |
session.answers[].questionExplanation | テキスト | 設問の説明 |
session.answers[].questionType | テキスト | 設問のフィールド種別 |
session.answers[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.answers[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.answers[].branchCode | テキスト | 回答から解析された支店コード |
session.answers[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.answers[].assets[] | リスト | 回答に添付されたアセット |
session.answers[].assets[].id | テキスト | アセットID |
session.answers[].assets[].name | テキスト | アセット名 |
session.answers[].assets[].url | テキスト | アセットのURL |
session.answers[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.answers[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.answers[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.answers[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.answers[].assets[].status | テキスト | アセットのステータス |
session.systemReadiness | オブジェクト | 予約セッションのシステム準備状況チェック |
session.systemReadiness.micro | はい / いいえ | マイクの準備状況 |
session.systemReadiness.camera | はい / いいえ | カメラの準備状況 |
session.systemReadiness.browser | はい / いいえ | ブラウザの準備状況 |
session.systemReadiness.speaker | はい / いいえ | スピーカーの準備状況 |
session.cancelledReason | テキスト | キャンセルの理由 |
session.cancelledBy | テキスト | セッションをキャンセルした人 |
guests[] | リスト | 予約のゲスト |
guests[].id | テキスト | ゲストID |
guests[].familyName | テキスト | ゲストの姓 |
guests[].firstName | テキスト | ゲストの名 |
guests[].familyFurigana | テキスト | 姓(ふりがな) |
guests[].firstFurigana | テキスト | 名(ふりがな) |
guests[].familyKatakana | テキスト | 姓(カタカナ) |
guests[].firstKatakana | テキスト | 名(カタカナ) |
guests[].phoneNumber | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | VirtualStoreイベント内のゲストのLINEプロフィール |
guests[].line.id | テキスト | LINEユーザーID(U接頭辞付き) |
guests[].line.name | テキスト | LINEの表示名 |
guests[].line.avatar | テキスト | LINEのアバターURL |
guests[].line.isFriend | はい / いいえ | ゲストがLINEの友だちかどうか |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].hashId | テキスト | ゲストのハッシュID |
guests[].visitorId | テキスト | 訪問者ID |
guests[].isBooker | はい / いいえ | このゲストが予約者かどうか |
guests[].identity | テキスト | ゲストのアイデンティティ |
guests[].fullName | テキスト | ゲストの氏名 |
guests[].externalId | テキスト | ゲストの外部ID |
guests[].webId | テキスト | ゲストのWeb ID |
guests[].isSurveyEnabled | はい / いいえ | ゲストに対してアンケートが有効かどうか |
store | オブジェクト | VirtualStoreイベント内のストア情報 |
store.id | テキスト | ストアID |
store.name | テキスト | ストア名 |
store.timezone | テキスト | ストアのタイムゾーン |
store.logo | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.logo.id | テキスト | アセットID |
store.logo.name | テキスト | アセット名 |
store.logo.url | テキスト | アセットのURL |
store.logo.createdAt | テキスト | 作成日時(ISO 8601) |
store.logo.mimeType | テキスト | アセットのMIMEタイプ |
store.logo.size | 数値 | アセットのサイズ(バイト) |
store.logo.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.logo.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.logo.status | テキスト | アセットのステータス |
store.image | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.image.id | テキスト | アセットID |
store.image.name | テキスト | アセット名 |
store.image.url | テキスト | アセットのURL |
store.image.createdAt | テキスト | 作成日時(ISO 8601) |
store.image.mimeType | テキスト | アセットのMIMEタイプ |
store.image.size | 数値 | アセットのサイズ(バイト) |
store.image.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.image.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.image.status | テキスト | アセットのステータス |
equipment | オブジェクト | VirtualStoreイベント内のオフライン予約用の機材情報 |
equipment.id | テキスト | 機材ID |
equipment.name | テキスト | 機材名 |
equipment.status | テキスト | 機材のステータス |
equipment.description | テキスト | 機材の説明 |
equipment.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
equipment.avatar.id | テキスト | アセットID |
equipment.avatar.name | テキスト | アセット名 |
equipment.avatar.url | テキスト | アセットのURL |
equipment.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
equipment.avatar.mimeType | テキスト | アセットのMIMEタイプ |
equipment.avatar.size | 数値 | アセットのサイズ(バイト) |
equipment.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
equipment.avatar.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
equipment.avatar.status | テキスト | アセットのステータス |
hosts[] | リスト | 予約のホスト(ホスト未割り当ての場合、要素はnullになります) |
hosts[].id | テキスト | ホストID |
hosts[].email | テキスト | ホストのメールアドレス |
hosts[].fullName | テキスト | ホストの氏名 |
hosts[].profile | オブジェクト | VirtualStoreイベント内のホストプロフィール情報 |
hosts[].profile.introduction | テキスト | ホストの自己紹介 |
hosts[].profile.position | テキスト | ホストの役職 |
hosts[].profile.url | テキスト | ホストのプロフィールURL |
hosts[].profile.twitter | テキスト | ホストのTwitterハンドル |
hosts[].profile.facebook | テキスト | ホストのFacebookプロフィール |
hosts[].profile.instagram | テキスト | ホストのInstagramプロフィール |
hosts[].profile.nickname | テキスト | ホストのニックネーム |
hosts[].profile.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
hosts[].profile.avatar.id | テキスト | アセットID |
hosts[].profile.avatar.name | テキスト | アセット名 |
hosts[].profile.avatar.url | テキスト | アセットのURL |
hosts[].profile.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
hosts[].profile.avatar.mimeType | テキスト | アセットのMIMEタイプ |
hosts[].profile.avatar.size | 数値 | アセットのサイズ(バイト) |
hosts[].profile.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
hosts[].profile.avatar.status | テキスト | アセットのステータス |
hosts[].displayName | テキスト | ホストの表示名 |
予約キャンセル
予約がキャンセルされたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば session は $trigger.output.session です。
{
"session": {},
"guests": [
{
"id": "string",
"familyName": "string",
"firstName": "string",
"familyFurigana": "string",
"firstFurigana": "string",
"familyKatakana": "string",
"firstKatakana": "string",
"phoneNumber": "string",
"line": {},
"email": "string",
"hashId": "string",
"visitorId": "string",
"isBooker": false,
"identity": "string",
"fullName": "string",
"externalId": "string",
"webId": "string",
"isSurveyEnabled": false
}
],
"store": {},
"equipment": {},
"hosts": [
{
"id": "string",
"email": "string",
"fullName": "string",
"profile": {},
"displayName": "string"
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
session | オブジェクト | VirtualStoreの予約イベントおよびアンケート回答イベント内のセッション情報 |
session.id | テキスト | セッションID |
session.oid | テキスト | セッションの組織ID |
session.flow | テキスト | 予約フロー |
session.status | テキスト | セッションのステータス |
session.type | テキスト | セッションの種類(例:オンライン、オフライン) |
session.startAt | テキスト | セッション開始日時(ISO 8601) |
session.endAt | テキスト | セッション終了日時(ISO 8601) |
session.createdAt | テキスト | 作成日時(ISO 8601) |
session.updatedAt | テキスト | 更新日時(ISO 8601) |
session.isPrivate | はい / いいえ | セッションがプライベートかどうか |
session.isRestorable | はい / いいえ | 予約を復元できるかどうか |
session.isTest | はい / いいえ | テストセッションかどうか |
session.isChangeable | はい / いいえ | 予約を変更できるかどうか |
session.isHostSelection | はい / いいえ | ホスト選択が有効かどうか |
session.urlType | テキスト | セッション作成時に使用されたURLの種類 |
session.rescheduledAt | テキスト | 日程変更日時(ISO 8601) |
session.originalHostId | テキスト | 日程変更前の元のホストID |
session.isRecorded | はい / いいえ | セッションが録画されるかどうか |
session.duration | オブジェクト | VirtualStoreイベント内の予約セッションの所要時間の詳細 |
session.duration.name | テキスト | 所要時間の名称 |
session.duration.duration | 数値 | 所要時間(分) |
session.duration.description | テキスト | 所要時間の説明 |
session.duration.bufferTime | 数値 | バッファ時間(分) |
session.duration.membership | テキスト | 所要時間に紐づくメンバーシップ |
session.duration.memberMode | テキスト | 所要時間に紐づくメンバーモード |
session.responses[] | リスト | セッションのアンケート結果・回答。最新の回答だけでなく、セッション内のすべてのアンケート回答(全ゲスト分)を含みます。responseId / resourceIdでグループ化してください |
session.responses[].id | テキスト | 回答ID |
session.responses[].surveyId | テキスト | アンケートID |
session.responses[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.responses[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.responses[].responseId | テキスト | 回答ID |
session.responses[].questionId | テキスト | 設問ID |
session.responses[].questionTitle | テキスト | 設問のタイトル |
session.responses[].questionExplanation | テキスト | 設問の説明 |
session.responses[].questionType | テキスト | 設問のフィールド種別 |
session.responses[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.responses[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.responses[].branchCode | テキスト | 回答から解析された支店コード |
session.responses[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.responses[].assets[] | リスト | 回答に添付されたアセット |
session.responses[].assets[].id | テキスト | アセットID |
session.responses[].assets[].name | テキスト | アセット名 |
session.responses[].assets[].url | テキスト | アセットのURL |
session.responses[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.responses[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.responses[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.responses[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.responses[].assets[].status | テキスト | アセットのステータス |
session.answers[] | リスト | セッションのヒアリングフォームの回答 |
session.answers[].id | テキスト | 回答ID |
session.answers[].surveyId | テキスト | アンケートID |
session.answers[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.answers[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.answers[].responseId | テキスト | 回答ID |
session.answers[].questionId | テキスト | 設問ID |
session.answers[].questionTitle | テキスト | 設問のタイトル |
session.answers[].questionExplanation | テキスト | 設問の説明 |
session.answers[].questionType | テキスト | 設問のフィールド種別 |
session.answers[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.answers[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.answers[].branchCode | テキスト | 回答から解析された支店コード |
session.answers[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.answers[].assets[] | リスト | 回答に添付されたアセット |
session.answers[].assets[].id | テキスト | アセットID |
session.answers[].assets[].name | テキスト | アセット名 |
session.answers[].assets[].url | テキスト | アセットのURL |
session.answers[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.answers[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.answers[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.answers[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.answers[].assets[].status | テキスト | アセットのステータス |
session.systemReadiness | オブジェクト | 予約セッションのシステム準備状況チェック |
session.systemReadiness.micro | はい / いいえ | マイクの準備状況 |
session.systemReadiness.camera | はい / いいえ | カメラの準備状況 |
session.systemReadiness.browser | はい / いいえ | ブラウザの準備状況 |
session.systemReadiness.speaker | はい / いいえ | スピーカーの準備状況 |
session.cancelledReason | テキスト | キャンセルの理由 |
session.cancelledBy | テキスト | セッションをキャンセルした人 |
guests[] | リスト | 予約のゲスト |
guests[].id | テキスト | ゲストID |
guests[].familyName | テキスト | ゲストの姓 |
guests[].firstName | テキスト | ゲストの名 |
guests[].familyFurigana | テキスト | 姓(ふりがな) |
guests[].firstFurigana | テキスト | 名(ふりがな) |
guests[].familyKatakana | テキスト | 姓(カタカナ) |
guests[].firstKatakana | テキスト | 名(カタカナ) |
guests[].phoneNumber | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | VirtualStoreイベント内のゲストのLINEプロフィール |
guests[].line.id | テキスト | LINEユーザーID(U接頭辞付き) |
guests[].line.name | テキスト | LINEの表示名 |
guests[].line.avatar | テキスト | LINEのアバターURL |
guests[].line.isFriend | はい / いいえ | ゲストがLINEの友だちかどうか |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].hashId | テキスト | ゲストのハッシュID |
guests[].visitorId | テキスト | 訪問者ID |
guests[].isBooker | はい / いいえ | このゲストが予約者かどうか |
guests[].identity | テキスト | ゲストのアイデンティティ |
guests[].fullName | テキスト | ゲストの氏名 |
guests[].externalId | テキスト | ゲストの外部ID |
guests[].webId | テキスト | ゲストのWeb ID |
guests[].isSurveyEnabled | はい / いいえ | ゲストに対してアンケートが有効かどうか |
store | オブジェクト | VirtualStoreイベント内のストア情報 |
store.id | テキスト | ストアID |
store.name | テキスト | ストア名 |
store.timezone | テキスト | ストアのタイムゾーン |
store.logo | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.logo.id | テキスト | アセットID |
store.logo.name | テキスト | アセット名 |
store.logo.url | テキスト | アセットのURL |
store.logo.createdAt | テキスト | 作成日時(ISO 8601) |
store.logo.mimeType | テキスト | アセットのMIMEタイプ |
store.logo.size | 数値 | アセットのサイズ(バイト) |
store.logo.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.logo.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.logo.status | テキスト | アセットのステータス |
store.image | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.image.id | テキスト | アセットID |
store.image.name | テキスト | アセット名 |
store.image.url | テキスト | アセットのURL |
store.image.createdAt | テキスト | 作成日時(ISO 8601) |
store.image.mimeType | テキスト | アセットのMIMEタイプ |
store.image.size | 数値 | アセットのサイズ(バイト) |
store.image.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.image.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.image.status | テキスト | アセットのステータス |
equipment | オブジェクト | VirtualStoreイベント内のオフライン予約用の機材情報 |
equipment.id | テキスト | 機材ID |
equipment.name | テキスト | 機材名 |
equipment.status | テキスト | 機材のステータス |
equipment.description | テキスト | 機材の説明 |
equipment.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
equipment.avatar.id | テキスト | アセットID |
equipment.avatar.name | テキスト | アセット名 |
equipment.avatar.url | テキスト | アセットのURL |
equipment.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
equipment.avatar.mimeType | テキスト | アセットのMIMEタイプ |
equipment.avatar.size | 数値 | アセットのサイズ(バイト) |
equipment.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
equipment.avatar.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
equipment.avatar.status | テキスト | アセットのステータス |
hosts[] | リスト | 予約のホスト(ホスト未割り当ての場合、要素はnullになります) |
hosts[].id | テキスト | ホストID |
hosts[].email | テキスト | ホストのメールアドレス |
hosts[].fullName | テキスト | ホストの氏名 |
hosts[].profile | オブジェクト | VirtualStoreイベント内のホストプロフィール情報 |
hosts[].profile.introduction | テキスト | ホストの自己紹介 |
hosts[].profile.position | テキスト | ホストの役職 |
hosts[].profile.url | テキスト | ホストのプロフィールURL |
hosts[].profile.twitter | テキスト | ホストのTwitterハンドル |
hosts[].profile.facebook | テキスト | ホストのFacebookプロフィール |
hosts[].profile.instagram | テキスト | ホストのInstagramプロフィール |
hosts[].profile.nickname | テキスト | ホストのニックネーム |
hosts[].profile.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
hosts[].profile.avatar.id | テキスト | アセットID |
hosts[].profile.avatar.name | テキスト | アセット名 |
hosts[].profile.avatar.url | テキスト | アセットのURL |
hosts[].profile.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
hosts[].profile.avatar.mimeType | テキスト | アセットのMIMEタイプ |
hosts[].profile.avatar.size | 数値 | アセットのサイズ(バイト) |
hosts[].profile.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
hosts[].profile.avatar.status | テキスト | アセットのステータス |
hosts[].displayName | テキスト | ホストの表示名 |
メモ更新
予約またはダイレクトセッションのメモが更新されたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば memo は $trigger.output.memo です。
{
"memo": "string",
"session": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
memo | テキスト | 最新のメモ内容 |
session | オブジェクト | メモが紐づくセッション |
session.id | テキスト | 予約またはダイレクトセッションのID |
session.type | テキスト | セッションの種類:reservation または directsession |
ダイレクトセッション作成
ダイレクトセッションが作成されたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば session は $trigger.output.session です。
{
"session": {},
"guests": [
{
"id": "string",
"familyName": "string",
"firstName": "string",
"familyFurigana": "string",
"firstFurigana": "string",
"familyKatakana": "string",
"firstKatakana": "string",
"phoneNumber": "string",
"line": {},
"email": "string",
"hashId": "string",
"visitorId": "string",
"isBooker": false,
"identity": "string",
"fullName": "string",
"externalId": "string",
"webId": "string",
"isSurveyEnabled": false
}
],
"store": {},
"hosts": [
{
"id": "string",
"email": "string",
"fullName": "string",
"profile": {},
"displayName": "string"
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
session | オブジェクト | VirtualStoreイベント内のダイレクトセッション情報 |
session.id | テキスト | ダイレクトセッションID |
session.oid | テキスト | ダイレクトセッションの組織ID |
session.status | テキスト | ダイレクトセッションのステータス |
session.type | テキスト | セッションの種類(常にdirectsession) |
session.startAt | テキスト | ダイレクトセッション開始日時(ISO 8601) |
session.endAt | テキスト | ダイレクトセッション終了日時(ISO 8601)。終了するまでは空です |
session.createdAt | テキスト | 作成日時(ISO 8601) |
session.updatedAt | テキスト | 更新日時(ISO 8601) |
session.isPrivate | はい / いいえ | ダイレクトセッションがプライベートかどうか |
session.isTest | はい / いいえ | テスト用のダイレクトセッションかどうか |
session.urlType | テキスト | ダイレクトセッション作成時に使用されたURLの種類 |
session.isRecorded | はい / いいえ | ダイレクトセッションが録画されるかどうか |
session.responses[] | リスト | ダイレクトセッションの全ゲストのアンケート結果。ゲストがアンケートに回答するまでは空です |
session.responses[].id | テキスト | 回答ID |
session.responses[].surveyId | テキスト | アンケートID |
session.responses[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.responses[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.responses[].responseId | テキスト | 回答ID |
session.responses[].questionId | テキスト | 設問ID |
session.responses[].questionTitle | テキスト | 設問のタイトル |
session.responses[].questionExplanation | テキスト | 設問の説明 |
session.responses[].questionType | テキスト | 設問のフィールド種別 |
session.responses[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.responses[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.responses[].branchCode | テキスト | 回答から解析された支店コード |
session.responses[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.responses[].assets[] | リスト | 回答に添付されたアセット |
session.responses[].assets[].id | テキスト | アセットID |
session.responses[].assets[].name | テキスト | アセット名 |
session.responses[].assets[].url | テキスト | アセットのURL |
session.responses[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.responses[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.responses[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.responses[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.responses[].assets[].status | テキスト | アセットのステータス |
session.answers[] | リスト | ダイレクトセッションのヒアリングフォームの回答 |
session.answers[].id | テキスト | 回答ID |
session.answers[].surveyId | テキスト | アンケートID |
session.answers[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.answers[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.answers[].responseId | テキスト | 回答ID |
session.answers[].questionId | テキスト | 設問ID |
session.answers[].questionTitle | テキスト | 設問のタイトル |
session.answers[].questionExplanation | テキスト | 設問の説明 |
session.answers[].questionType | テキスト | 設問のフィールド種別 |
session.answers[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.answers[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.answers[].branchCode | テキスト | 回答から解析された支店コード |
session.answers[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.answers[].assets[] | リスト | 回答に添付されたアセット |
session.answers[].assets[].id | テキスト | アセットID |
session.answers[].assets[].name | テキスト | アセット名 |
session.answers[].assets[].url | テキスト | アセットのURL |
session.answers[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.answers[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.answers[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.answers[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.answers[].assets[].status | テキスト | アセットのステータス |
session.cancelledReason | テキスト | キャンセルの理由 |
session.cancelledBy | テキスト | ダイレクトセッションをキャンセルした人 |
guests[] | リスト | ダイレクトセッションのゲスト |
guests[].id | テキスト | ゲストID |
guests[].familyName | テキスト | ゲストの姓 |
guests[].firstName | テキスト | ゲストの名 |
guests[].familyFurigana | テキスト | 姓(ふりがな) |
guests[].firstFurigana | テキスト | 名(ふりがな) |
guests[].familyKatakana | テキスト | 姓(カタカナ) |
guests[].firstKatakana | テキスト | 名(カタカナ) |
guests[].phoneNumber | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | VirtualStoreイベント内のゲストのLINEプロフィール |
guests[].line.id | テキスト | LINEユーザーID(U接頭辞付き) |
guests[].line.name | テキスト | LINEの表示名 |
guests[].line.avatar | テキスト | LINEのアバターURL |
guests[].line.isFriend | はい / いいえ | ゲストがLINEの友だちかどうか |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].hashId | テキスト | ゲストのハッシュID |
guests[].visitorId | テキスト | 訪問者ID |
guests[].isBooker | はい / いいえ | このゲストが予約者かどうか |
guests[].identity | テキスト | ゲストのアイデンティティ |
guests[].fullName | テキスト | ゲストの氏名 |
guests[].externalId | テキスト | ゲストの外部ID |
guests[].webId | テキスト | ゲストのWeb ID |
guests[].isSurveyEnabled | はい / いいえ | ゲストに対してアンケートが有効かどうか |
store | オブジェクト | VirtualStoreイベント内のストア情報 |
store.id | テキスト | ストアID |
store.name | テキスト | ストア名 |
store.timezone | テキスト | ストアのタイムゾーン |
store.logo | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.logo.id | テキスト | アセットID |
store.logo.name | テキスト | アセット名 |
store.logo.url | テキスト | アセットのURL |
store.logo.createdAt | テキスト | 作成日時(ISO 8601) |
store.logo.mimeType | テキスト | アセットのMIMEタイプ |
store.logo.size | 数値 | アセットのサイズ(バイト) |
store.logo.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.logo.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.logo.status | テキスト | アセットのステータス |
store.image | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.image.id | テキスト | アセットID |
store.image.name | テキスト | アセット名 |
store.image.url | テキスト | アセットのURL |
store.image.createdAt | テキスト | 作成日時(ISO 8601) |
store.image.mimeType | テキスト | アセットのMIMEタイプ |
store.image.size | 数値 | アセットのサイズ(バイト) |
store.image.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.image.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.image.status | テキスト | アセットのステータス |
hosts[] | リスト | ダイレクトセッションのホスト(ホスト未割り当ての場合、要素はnullになります) |
hosts[].id | テキスト | ホストID |
hosts[].email | テキスト | ホストのメールアドレス |
hosts[].fullName | テキスト | ホストの氏名 |
hosts[].profile | オブジェクト | VirtualStoreイベント内のホストプロフィール情報 |
hosts[].profile.introduction | テキスト | ホストの自己紹介 |
hosts[].profile.position | テキスト | ホストの役職 |
hosts[].profile.url | テキスト | ホストのプロフィールURL |
hosts[].profile.twitter | テキスト | ホストのTwitterハンドル |
hosts[].profile.facebook | テキスト | ホストのFacebookプロフィール |
hosts[].profile.instagram | テキスト | ホストのInstagramプロフィール |
hosts[].profile.nickname | テキスト | ホストのニックネーム |
hosts[].profile.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
hosts[].profile.avatar.id | テキスト | アセットID |
hosts[].profile.avatar.name | テキスト | アセット名 |
hosts[].profile.avatar.url | テキスト | アセットのURL |
hosts[].profile.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
hosts[].profile.avatar.mimeType | テキスト | アセットのMIMEタイプ |
hosts[].profile.avatar.size | 数値 | アセットのサイズ(バイト) |
hosts[].profile.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
hosts[].profile.avatar.status | テキスト | アセットのステータス |
hosts[].displayName | テキスト | ホストの表示名 |
ダイレクトセッション開始
ダイレクトセッションが開始されたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば session は $trigger.output.session です。
{
"session": {},
"guests": [
{
"id": "string",
"familyName": "string",
"firstName": "string",
"familyFurigana": "string",
"firstFurigana": "string",
"familyKatakana": "string",
"firstKatakana": "string",
"phoneNumber": "string",
"line": {},
"email": "string",
"hashId": "string",
"visitorId": "string",
"isBooker": false,
"identity": "string",
"fullName": "string",
"externalId": "string",
"webId": "string",
"isSurveyEnabled": false
}
],
"store": {},
"hosts": [
{
"id": "string",
"email": "string",
"fullName": "string",
"profile": {},
"displayName": "string"
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
session | オブジェクト | VirtualStoreイベント内のダイレクトセッション情報 |
session.id | テキスト | ダイレクトセッションID |
session.oid | テキスト | ダイレクトセッションの組織ID |
session.status | テキスト | ダイレクトセッションのステータス |
session.type | テキスト | セッションの種類(常にdirectsession) |
session.startAt | テキスト | ダイレクトセッション開始日時(ISO 8601) |
session.endAt | テキスト | ダイレクトセッション終了日時(ISO 8601)。終了するまでは空です |
session.createdAt | テキスト | 作成日時(ISO 8601) |
session.updatedAt | テキスト | 更新日時(ISO 8601) |
session.isPrivate | はい / いいえ | ダイレクトセッションがプライベートかどうか |
session.isTest | はい / いいえ | テスト用のダイレクトセッションかどうか |
session.urlType | テキスト | ダイレクトセッション作成時に使用されたURLの種類 |
session.isRecorded | はい / いいえ | ダイレクトセッションが録画されるかどうか |
session.responses[] | リスト | ダイレクトセッションの全ゲストのアンケート結果。ゲストがアンケートに回答するまでは空です |
session.responses[].id | テキスト | 回答ID |
session.responses[].surveyId | テキスト | アンケートID |
session.responses[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.responses[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.responses[].responseId | テキスト | 回答ID |
session.responses[].questionId | テキスト | 設問ID |
session.responses[].questionTitle | テキスト | 設問のタイトル |
session.responses[].questionExplanation | テキスト | 設問の説明 |
session.responses[].questionType | テキスト | 設問のフィールド種別 |
session.responses[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.responses[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.responses[].branchCode | テキスト | 回答から解析された支店コード |
session.responses[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.responses[].assets[] | リスト | 回答に添付されたアセット |
session.responses[].assets[].id | テキスト | アセットID |
session.responses[].assets[].name | テキスト | アセット名 |
session.responses[].assets[].url | テキスト | アセットのURL |
session.responses[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.responses[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.responses[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.responses[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.responses[].assets[].status | テキスト | アセットのステータス |
session.answers[] | リスト | ダイレクトセッションのヒアリングフォームの回答 |
session.answers[].id | テキスト | 回答ID |
session.answers[].surveyId | テキスト | アンケートID |
session.answers[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.answers[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.answers[].responseId | テキスト | 回答ID |
session.answers[].questionId | テキスト | 設問ID |
session.answers[].questionTitle | テキスト | 設問のタイトル |
session.answers[].questionExplanation | テキスト | 設問の説明 |
session.answers[].questionType | テキスト | 設問のフィールド種別 |
session.answers[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.answers[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.answers[].branchCode | テキスト | 回答から解析された支店コード |
session.answers[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.answers[].assets[] | リスト | 回答に添付されたアセット |
session.answers[].assets[].id | テキスト | アセットID |
session.answers[].assets[].name | テキスト | アセット名 |
session.answers[].assets[].url | テキスト | アセットのURL |
session.answers[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.answers[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.answers[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.answers[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.answers[].assets[].status | テキスト | アセットのステータス |
session.cancelledReason | テキスト | キャンセルの理由 |
session.cancelledBy | テキスト | ダイレクトセッションをキャンセルした人 |
guests[] | リスト | ダイレクトセッションのゲスト |
guests[].id | テキスト | ゲストID |
guests[].familyName | テキスト | ゲストの姓 |
guests[].firstName | テキスト | ゲストの名 |
guests[].familyFurigana | テキスト | 姓(ふりがな) |
guests[].firstFurigana | テキスト | 名(ふりがな) |
guests[].familyKatakana | テキスト | 姓(カタカナ) |
guests[].firstKatakana | テキスト | 名(カタカナ) |
guests[].phoneNumber | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | VirtualStoreイベント内のゲストのLINEプロフィール |
guests[].line.id | テキスト | LINEユーザーID(U接頭辞付き) |
guests[].line.name | テキスト | LINEの表示名 |
guests[].line.avatar | テキスト | LINEのアバターURL |
guests[].line.isFriend | はい / いいえ | ゲストがLINEの友だちかどうか |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].hashId | テキスト | ゲストのハッシュID |
guests[].visitorId | テキスト | 訪問者ID |
guests[].isBooker | はい / いいえ | このゲストが予約者かどうか |
guests[].identity | テキスト | ゲストのアイデンティティ |
guests[].fullName | テキスト | ゲストの氏名 |
guests[].externalId | テキスト | ゲストの外部ID |
guests[].webId | テキスト | ゲストのWeb ID |
guests[].isSurveyEnabled | はい / いいえ | ゲストに対してアンケートが有効かどうか |
store | オブジェクト | VirtualStoreイベント内のストア情報 |
store.id | テキスト | ストアID |
store.name | テキスト | ストア名 |
store.timezone | テキスト | ストアのタイムゾーン |
store.logo | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.logo.id | テキスト | アセットID |
store.logo.name | テキスト | アセット名 |
store.logo.url | テキスト | アセットのURL |
store.logo.createdAt | テキスト | 作成日時(ISO 8601) |
store.logo.mimeType | テキスト | アセットのMIMEタイプ |
store.logo.size | 数値 | アセットのサイズ(バイト) |
store.logo.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.logo.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.logo.status | テキスト | アセットのステータス |
store.image | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.image.id | テキスト | アセットID |
store.image.name | テキスト | アセット名 |
store.image.url | テキスト | アセットのURL |
store.image.createdAt | テキスト | 作成日時(ISO 8601) |
store.image.mimeType | テキスト | アセットのMIMEタイプ |
store.image.size | 数値 | アセットのサイズ(バイト) |
store.image.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.image.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.image.status | テキスト | アセットのステータス |
hosts[] | リスト | ダイレクトセッションのホスト(ホスト未割り当ての場合、要素はnullになります) |
hosts[].id | テキスト | ホストID |
hosts[].email | テキスト | ホストのメールアドレス |
hosts[].fullName | テキスト | ホストの氏名 |
hosts[].profile | オブジェクト | VirtualStoreイベント内のホストプロフィール情報 |
hosts[].profile.introduction | テキスト | ホストの自己紹介 |
hosts[].profile.position | テキスト | ホストの役職 |
hosts[].profile.url | テキスト | ホストのプロフィールURL |
hosts[].profile.twitter | テキスト | ホストのTwitterハンドル |
hosts[].profile.facebook | テキスト | ホストのFacebookプロフィール |
hosts[].profile.instagram | テキスト | ホストのInstagramプロフィール |
hosts[].profile.nickname | テキスト | ホストのニックネーム |
hosts[].profile.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
hosts[].profile.avatar.id | テキスト | アセットID |
hosts[].profile.avatar.name | テキスト | アセット名 |
hosts[].profile.avatar.url | テキスト | アセットのURL |
hosts[].profile.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
hosts[].profile.avatar.mimeType | テキスト | アセットのMIMEタイプ |
hosts[].profile.avatar.size | 数値 | アセットのサイズ(バイト) |
hosts[].profile.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
hosts[].profile.avatar.status | テキスト | アセットのステータス |
hosts[].displayName | テキスト | ホストの表示名 |
ダイレクトセッション終了
ダイレクトセッションが終了したときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば session は $trigger.output.session です。
{
"session": {},
"guests": [
{
"id": "string",
"familyName": "string",
"firstName": "string",
"familyFurigana": "string",
"firstFurigana": "string",
"familyKatakana": "string",
"firstKatakana": "string",
"phoneNumber": "string",
"line": {},
"email": "string",
"hashId": "string",
"visitorId": "string",
"isBooker": false,
"identity": "string",
"fullName": "string",
"externalId": "string",
"webId": "string",
"isSurveyEnabled": false
}
],
"store": {},
"hosts": [
{
"id": "string",
"email": "string",
"fullName": "string",
"profile": {},
"displayName": "string"
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
session | オブジェクト | VirtualStoreイベント内のダイレクトセッション情報 |
session.id | テキスト | ダイレクトセッションID |
session.oid | テキスト | ダイレクトセッションの組織ID |
session.status | テキスト | ダイレクトセッションのステータス |
session.type | テキスト | セッションの種類(常にdirectsession) |
session.startAt | テキスト | ダイレクトセッション開始日時(ISO 8601) |
session.endAt | テキスト | ダイレクトセッション終了日時(ISO 8601)。終了するまでは空です |
session.createdAt | テキスト | 作成日時(ISO 8601) |
session.updatedAt | テキスト | 更新日時(ISO 8601) |
session.isPrivate | はい / いいえ | ダイレクトセッションがプライベートかどうか |
session.isTest | はい / いいえ | テスト用のダイレクトセッションかどうか |
session.urlType | テキスト | ダイレクトセッション作成時に使用されたURLの種類 |
session.isRecorded | はい / いいえ | ダイレクトセッションが録画されるかどうか |
session.responses[] | リスト | ダイレクトセッションの全ゲストのアンケート結果。ゲストがアンケートに回答するまでは空です |
session.responses[].id | テキスト | 回答ID |
session.responses[].surveyId | テキスト | アンケートID |
session.responses[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.responses[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.responses[].responseId | テキスト | 回答ID |
session.responses[].questionId | テキスト | 設問ID |
session.responses[].questionTitle | テキスト | 設問のタイトル |
session.responses[].questionExplanation | テキスト | 設問の説明 |
session.responses[].questionType | テキスト | 設問のフィールド種別 |
session.responses[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.responses[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.responses[].branchCode | テキスト | 回答から解析された支店コード |
session.responses[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.responses[].assets[] | リスト | 回答に添付されたアセット |
session.responses[].assets[].id | テキスト | アセットID |
session.responses[].assets[].name | テキスト | アセット名 |
session.responses[].assets[].url | テキスト | アセットのURL |
session.responses[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.responses[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.responses[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.responses[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.responses[].assets[].status | テキスト | アセットのステータス |
session.answers[] | リスト | ダイレクトセッションのヒアリングフォームの回答 |
session.answers[].id | テキスト | 回答ID |
session.answers[].surveyId | テキスト | アンケートID |
session.answers[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.answers[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.answers[].responseId | テキスト | 回答ID |
session.answers[].questionId | テキスト | 設問ID |
session.answers[].questionTitle | テキスト | 設問のタイトル |
session.answers[].questionExplanation | テキスト | 設問の説明 |
session.answers[].questionType | テキスト | 設問のフィールド種別 |
session.answers[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.answers[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.answers[].branchCode | テキスト | 回答から解析された支店コード |
session.answers[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.answers[].assets[] | リスト | 回答に添付されたアセット |
session.answers[].assets[].id | テキスト | アセットID |
session.answers[].assets[].name | テキスト | アセット名 |
session.answers[].assets[].url | テキスト | アセットのURL |
session.answers[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.answers[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.answers[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.answers[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.answers[].assets[].status | テキスト | アセットのステータス |
session.cancelledReason | テキスト | キャンセルの理由 |
session.cancelledBy | テキスト | ダイレクトセッションをキャンセルした人 |
guests[] | リスト | ダイレクトセッションのゲスト |
guests[].id | テキスト | ゲストID |
guests[].familyName | テキスト | ゲストの姓 |
guests[].firstName | テキスト | ゲストの名 |
guests[].familyFurigana | テキスト | 姓(ふりがな) |
guests[].firstFurigana | テキスト | 名(ふりがな) |
guests[].familyKatakana | テキスト | 姓(カタカナ) |
guests[].firstKatakana | テキスト | 名(カタカナ) |
guests[].phoneNumber | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | VirtualStoreイベント内のゲストのLINEプロフィール |
guests[].line.id | テキスト | LINEユーザーID(U接頭辞付き) |
guests[].line.name | テキスト | LINEの表示名 |
guests[].line.avatar | テキスト | LINEのアバターURL |
guests[].line.isFriend | はい / いいえ | ゲストがLINEの友だちかどうか |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].hashId | テキスト | ゲストのハッシュID |
guests[].visitorId | テキスト | 訪問者ID |
guests[].isBooker | はい / いいえ | このゲストが予約者かどうか |
guests[].identity | テキスト | ゲストのアイデンティティ |
guests[].fullName | テキスト | ゲストの氏名 |
guests[].externalId | テキスト | ゲストの外部ID |
guests[].webId | テキスト | ゲストのWeb ID |
guests[].isSurveyEnabled | はい / いいえ | ゲストに対してアンケートが有効かどうか |
store | オブジェクト | VirtualStoreイベント内のストア情報 |
store.id | テキスト | ストアID |
store.name | テキスト | ストア名 |
store.timezone | テキスト | ストアのタイムゾーン |
store.logo | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.logo.id | テキスト | アセットID |
store.logo.name | テキスト | アセット名 |
store.logo.url | テキスト | アセットのURL |
store.logo.createdAt | テキスト | 作成日時(ISO 8601) |
store.logo.mimeType | テキスト | アセットのMIMEタイプ |
store.logo.size | 数値 | アセットのサイズ(バイト) |
store.logo.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.logo.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.logo.status | テキスト | アセットのステータス |
store.image | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.image.id | テキスト | アセットID |
store.image.name | テキスト | アセット名 |
store.image.url | テキスト | アセットのURL |
store.image.createdAt | テキスト | 作成日時(ISO 8601) |
store.image.mimeType | テキスト | アセットのMIMEタイプ |
store.image.size | 数値 | アセットのサイズ(バイト) |
store.image.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.image.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.image.status | テキスト | アセットのステータス |
hosts[] | リスト | ダイレクトセッションのホスト(ホスト未割り当ての場合、要素はnullになります) |
hosts[].id | テキスト | ホストID |
hosts[].email | テキスト | ホストのメールアドレス |
hosts[].fullName | テキスト | ホストの氏名 |
hosts[].profile | オブジェクト | VirtualStoreイベント内のホストプロフィール情報 |
hosts[].profile.introduction | テキスト | ホストの自己紹介 |
hosts[].profile.position | テキスト | ホストの役職 |
hosts[].profile.url | テキスト | ホストのプロフィールURL |
hosts[].profile.twitter | テキスト | ホストのTwitterハンドル |
hosts[].profile.facebook | テキスト | ホストのFacebookプロフィール |
hosts[].profile.instagram | テキスト | ホストのInstagramプロフィール |
hosts[].profile.nickname | テキスト | ホストのニックネーム |
hosts[].profile.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
hosts[].profile.avatar.id | テキスト | アセットID |
hosts[].profile.avatar.name | テキスト | アセット名 |
hosts[].profile.avatar.url | テキスト | アセットのURL |
hosts[].profile.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
hosts[].profile.avatar.mimeType | テキスト | アセットのMIMEタイプ |
hosts[].profile.avatar.size | 数値 | アセットのサイズ(バイト) |
hosts[].profile.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
hosts[].profile.avatar.status | テキスト | アセットのステータス |
hosts[].displayName | テキスト | ホストの表示名 |
ダイレクトセッションキャンセル
ダイレクトセッションがキャンセルされたときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば session は $trigger.output.session です。
{
"session": {},
"guests": [
{
"id": "string",
"familyName": "string",
"firstName": "string",
"familyFurigana": "string",
"firstFurigana": "string",
"familyKatakana": "string",
"firstKatakana": "string",
"phoneNumber": "string",
"line": {},
"email": "string",
"hashId": "string",
"visitorId": "string",
"isBooker": false,
"identity": "string",
"fullName": "string",
"externalId": "string",
"webId": "string",
"isSurveyEnabled": false
}
],
"store": {},
"hosts": [
{
"id": "string",
"email": "string",
"fullName": "string",
"profile": {},
"displayName": "string"
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
session | オブジェクト | VirtualStoreイベント内のダイレクトセッション情報 |
session.id | テキスト | ダイレクトセッションID |
session.oid | テキスト | ダイレクトセッションの組織ID |
session.status | テキスト | ダイレクトセッションのステータス |
session.type | テキスト | セッションの種類(常にdirectsession) |
session.startAt | テキスト | ダイレクトセッション開始日時(ISO 8601) |
session.endAt | テキスト | ダイレクトセッション終了日時(ISO 8601)。終了するまでは空です |
session.createdAt | テキスト | 作成日時(ISO 8601) |
session.updatedAt | テキスト | 更新日時(ISO 8601) |
session.isPrivate | はい / いいえ | ダイレクトセッションがプライベートかどうか |
session.isTest | はい / いいえ | テスト用のダイレクトセッションかどうか |
session.urlType | テキスト | ダイレクトセッション作成時に使用されたURLの種類 |
session.isRecorded | はい / いいえ | ダイレクトセッションが録画されるかどうか |
session.responses[] | リスト | ダイレクトセッションの全ゲストのアンケート結果。ゲストがアンケートに回答するまでは空です |
session.responses[].id | テキスト | 回答ID |
session.responses[].surveyId | テキスト | アンケートID |
session.responses[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.responses[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.responses[].responseId | テキスト | 回答ID |
session.responses[].questionId | テキスト | 設問ID |
session.responses[].questionTitle | テキスト | 設問のタイトル |
session.responses[].questionExplanation | テキスト | 設問の説明 |
session.responses[].questionType | テキスト | 設問のフィールド種別 |
session.responses[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.responses[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.responses[].branchCode | テキスト | 回答から解析された支店コード |
session.responses[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.responses[].assets[] | リスト | 回答に添付されたアセット |
session.responses[].assets[].id | テキスト | アセットID |
session.responses[].assets[].name | テキスト | アセット名 |
session.responses[].assets[].url | テキスト | アセットのURL |
session.responses[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.responses[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.responses[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.responses[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.responses[].assets[].status | テキスト | アセットのステータス |
session.answers[] | リスト | ダイレクトセッションのヒアリングフォームの回答 |
session.answers[].id | テキスト | 回答ID |
session.answers[].surveyId | テキスト | アンケートID |
session.answers[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.answers[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.answers[].responseId | テキスト | 回答ID |
session.answers[].questionId | テキスト | 設問ID |
session.answers[].questionTitle | テキスト | 設問のタイトル |
session.answers[].questionExplanation | テキスト | 設問の説明 |
session.answers[].questionType | テキスト | 設問のフィールド種別 |
session.answers[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.answers[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.answers[].branchCode | テキスト | 回答から解析された支店コード |
session.answers[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.answers[].assets[] | リスト | 回答に添付されたアセット |
session.answers[].assets[].id | テキスト | アセットID |
session.answers[].assets[].name | テキスト | アセット名 |
session.answers[].assets[].url | テキスト | アセットのURL |
session.answers[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.answers[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.answers[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.answers[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.answers[].assets[].status | テキスト | アセットのステータス |
session.cancelledReason | テキスト | キャンセルの理由 |
session.cancelledBy | テキスト | ダイレクトセッションをキャンセルした人 |
guests[] | リスト | ダイレクトセッションのゲスト |
guests[].id | テキスト | ゲストID |
guests[].familyName | テキスト | ゲストの姓 |
guests[].firstName | テキスト | ゲストの名 |
guests[].familyFurigana | テキスト | 姓(ふりがな) |
guests[].firstFurigana | テキスト | 名(ふりがな) |
guests[].familyKatakana | テキスト | 姓(カタカナ) |
guests[].firstKatakana | テキスト | 名(カタカナ) |
guests[].phoneNumber | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | VirtualStoreイベント内のゲストのLINEプロフィール |
guests[].line.id | テキスト | LINEユーザーID(U接頭辞付き) |
guests[].line.name | テキスト | LINEの表示名 |
guests[].line.avatar | テキスト | LINEのアバターURL |
guests[].line.isFriend | はい / いいえ | ゲストがLINEの友だちかどうか |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].hashId | テキスト | ゲストのハッシュID |
guests[].visitorId | テキスト | 訪問者ID |
guests[].isBooker | はい / いいえ | このゲストが予約者かどうか |
guests[].identity | テキスト | ゲストのアイデンティティ |
guests[].fullName | テキスト | ゲストの氏名 |
guests[].externalId | テキスト | ゲストの外部ID |
guests[].webId | テキスト | ゲストのWeb ID |
guests[].isSurveyEnabled | はい / いいえ | ゲストに対してアンケートが有効かどうか |
store | オブジェクト | VirtualStoreイベント内のストア情報 |
store.id | テキスト | ストアID |
store.name | テキスト | ストア名 |
store.timezone | テキスト | ストアのタイムゾーン |
store.logo | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.logo.id | テキスト | アセットID |
store.logo.name | テキスト | アセット名 |
store.logo.url | テキスト | アセットのURL |
store.logo.createdAt | テキスト | 作成日時(ISO 8601) |
store.logo.mimeType | テキスト | アセットのMIMEタイプ |
store.logo.size | 数値 | アセットのサイズ(バイト) |
store.logo.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.logo.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.logo.status | テキスト | アセットのステータス |
store.image | オブジェクト | VirtualStoreイベント内のアセット情報 |
store.image.id | テキスト | アセットID |
store.image.name | テキスト | アセット名 |
store.image.url | テキスト | アセットのURL |
store.image.createdAt | テキスト | 作成日時(ISO 8601) |
store.image.mimeType | テキスト | アセットのMIMEタイプ |
store.image.size | 数値 | アセットのサイズ(バイト) |
store.image.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
store.image.meta.thumbnails[] | リスト | 生成されたサムネイルのバリエーション |
store.image.status | テキスト | アセットのステータス |
hosts[] | リスト | ダイレクトセッションのホスト(ホスト未割り当ての場合、要素はnullになります) |
hosts[].id | テキスト | ホストID |
hosts[].email | テキスト | ホストのメールアドレス |
hosts[].fullName | テキスト | ホストの氏名 |
hosts[].profile | オブジェクト | VirtualStoreイベント内のホストプロフィール情報 |
hosts[].profile.introduction | テキスト | ホストの自己紹介 |
hosts[].profile.position | テキスト | ホストの役職 |
hosts[].profile.url | テキスト | ホストのプロフィールURL |
hosts[].profile.twitter | テキスト | ホストのTwitterハンドル |
hosts[].profile.facebook | テキスト | ホストのFacebookプロフィール |
hosts[].profile.instagram | テキスト | ホストのInstagramプロフィール |
hosts[].profile.nickname | テキスト | ホストのニックネーム |
hosts[].profile.avatar | オブジェクト | VirtualStoreイベント内のアセット情報 |
hosts[].profile.avatar.id | テキスト | アセットID |
hosts[].profile.avatar.name | テキスト | アセット名 |
hosts[].profile.avatar.url | テキスト | アセットのURL |
hosts[].profile.avatar.createdAt | テキスト | 作成日時(ISO 8601) |
hosts[].profile.avatar.mimeType | テキスト | アセットのMIMEタイプ |
hosts[].profile.avatar.size | 数値 | アセットのサイズ(バイト) |
hosts[].profile.avatar.meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
hosts[].profile.avatar.status | テキスト | アセットのステータス |
hosts[].displayName | テキスト | ホストの表示名 |
アンケート回答作成
予約またはダイレクトセッションでゲストがアンケートに回答したときにトリガーされます
設定項目
設定項目はありません。
出力
後続のステップでは、$ の一覧の Current Trigger からこのデータを使います。たとえば session は $trigger.output.session です。
{
"session": {},
"guests": [
{
"id": "string",
"familyName": "string",
"firstName": "string",
"familyFurigana": "string",
"firstFurigana": "string",
"familyKatakana": "string",
"firstKatakana": "string",
"phoneNumber": "string",
"line": {},
"email": "string",
"hashId": "string",
"visitorId": "string",
"isBooker": false,
"identity": "string",
"fullName": "string",
"externalId": "string",
"webId": "string",
"isSurveyEnabled": false
}
],
"response": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
session | オブジェクト | VirtualStoreの予約イベントおよびアンケート回答イベント内のセッション情報 |
session.id | テキスト | セッションID |
session.oid | テキスト | セッションの組織ID |
session.flow | テキスト | 予約フロー |
session.status | テキスト | セッションのステータス |
session.type | テキスト | セッションの種類(例:オンライン、オフライン) |
session.startAt | テキスト | セッション開始日時(ISO 8601) |
session.endAt | テキスト | セッション終了日時(ISO 8601) |
session.createdAt | テキスト | 作成日時(ISO 8601) |
session.updatedAt | テキスト | 更新日時(ISO 8601) |
session.isPrivate | はい / いいえ | セッションがプライベートかどうか |
session.isRestorable | はい / いいえ | 予約を復元できるかどうか |
session.isTest | はい / いいえ | テストセッションかどうか |
session.isChangeable | はい / いいえ | 予約を変更できるかどうか |
session.isHostSelection | はい / いいえ | ホスト選択が有効かどうか |
session.urlType | テキスト | セッション作成時に使用されたURLの種類 |
session.rescheduledAt | テキスト | 日程変更日時(ISO 8601) |
session.originalHostId | テキスト | 日程変更前の元のホストID |
session.isRecorded | はい / いいえ | セッションが録画されるかどうか |
session.duration | オブジェクト | VirtualStoreイベント内の予約セッションの所要時間の詳細 |
session.duration.name | テキスト | 所要時間の名称 |
session.duration.duration | 数値 | 所要時間(分) |
session.duration.description | テキスト | 所要時間の説明 |
session.duration.bufferTime | 数値 | バッファ時間(分) |
session.duration.membership | テキスト | 所要時間に紐づくメンバーシップ |
session.duration.memberMode | テキスト | 所要時間に紐づくメンバーモード |
session.responses[] | リスト | セッションのアンケート結果・回答。最新の回答だけでなく、セッション内のすべてのアンケート回答(全ゲスト分)を含みます。responseId / resourceIdでグループ化してください |
session.responses[].id | テキスト | 回答ID |
session.responses[].surveyId | テキスト | アンケートID |
session.responses[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.responses[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.responses[].responseId | テキスト | 回答ID |
session.responses[].questionId | テキスト | 設問ID |
session.responses[].questionTitle | テキスト | 設問のタイトル |
session.responses[].questionExplanation | テキスト | 設問の説明 |
session.responses[].questionType | テキスト | 設問のフィールド種別 |
session.responses[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.responses[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.responses[].branchCode | テキスト | 回答から解析された支店コード |
session.responses[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.responses[].assets[] | リスト | 回答に添付されたアセット |
session.responses[].assets[].id | テキスト | アセットID |
session.responses[].assets[].name | テキスト | アセット名 |
session.responses[].assets[].url | テキスト | アセットのURL |
session.responses[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.responses[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.responses[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.responses[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.responses[].assets[].status | テキスト | アセットのステータス |
session.answers[] | リスト | セッションのヒアリングフォームの回答 |
session.answers[].id | テキスト | 回答ID |
session.answers[].surveyId | テキスト | アンケートID |
session.answers[].resourceType | テキスト | 回答のリソース種別(guest | identity) |
session.answers[].resourceId | テキスト | 回答のリソースID(ゲストID) |
session.answers[].responseId | テキスト | 回答ID |
session.answers[].questionId | テキスト | 設問ID |
session.answers[].questionTitle | テキスト | 設問のタイトル |
session.answers[].questionExplanation | テキスト | 設問の説明 |
session.answers[].questionType | テキスト | 設問のフィールド種別 |
session.answers[].isSatisfaction | はい / いいえ | 設問が満足度設問かどうか |
session.answers[].answer | 任意 | 回答値:文字列、数値(線形スケールなど)、または文字列のリスト(チェックボックス) |
session.answers[].branchCode | テキスト | 回答から解析された支店コード |
session.answers[].otherAnswer | テキスト | 該当する場合の「その他」の回答テキスト |
session.answers[].assets[] | リスト | 回答に添付されたアセット |
session.answers[].assets[].id | テキスト | アセットID |
session.answers[].assets[].name | テキスト | アセット名 |
session.answers[].assets[].url | テキスト | アセットのURL |
session.answers[].assets[].createdAt | テキスト | 作成日時(ISO 8601) |
session.answers[].assets[].mimeType | テキスト | アセットのMIMEタイプ |
session.answers[].assets[].size | 数値 | アセットのサイズ(バイト) |
session.answers[].assets[].meta | オブジェクト | アセットのメタデータ(任意。例:サムネイル) |
session.answers[].assets[].status | テキスト | アセットのステータス |
session.systemReadiness | オブジェクト | 予約セッションのシステム準備状況チェック |
session.systemReadiness.micro | はい / いいえ | マイクの準備状況 |
session.systemReadiness.camera | はい / いいえ | カメラの準備状況 |
session.systemReadiness.browser | はい / いいえ | ブラウザの準備状況 |
session.systemReadiness.speaker | はい / いいえ | スピーカーの準備状況 |
session.cancelledReason | テキスト | キャンセルの理由 |
session.cancelledBy | テキスト | セッションをキャンセルした人 |
guests[] | リスト | セッションのゲスト |
guests[].id | テキスト | ゲストID |
guests[].familyName | テキスト | ゲストの姓 |
guests[].firstName | テキスト | ゲストの名 |
guests[].familyFurigana | テキスト | 姓(ふりがな) |
guests[].firstFurigana | テキスト | 名(ふりがな) |
guests[].familyKatakana | テキスト | 姓(カタカナ) |
guests[].firstKatakana | テキスト | 名(カタカナ) |
guests[].phoneNumber | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | VirtualStoreイベント内のゲストのLINEプロフィール |
guests[].line.id | テキスト | LINEユーザーID(U接頭辞付き) |
guests[].line.name | テキスト | LINEの表示名 |
guests[].line.avatar | テキスト | LINEのアバターURL |
guests[].line.isFriend | はい / いいえ | ゲストがLINEの友だちかどうか |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].hashId | テキスト | ゲストのハッシュID |
guests[].visitorId | テキスト | 訪問者ID |
guests[].isBooker | はい / いいえ | このゲストが予約者かどうか |
guests[].identity | テキスト | ゲストのアイデンティティ |
guests[].fullName | テキスト | ゲストの氏名 |
guests[].externalId | テキスト | ゲストの外部ID |
guests[].webId | テキスト | ゲストのWeb ID |
guests[].isSurveyEnabled | はい / いいえ | ゲストに対してアンケートが有効かどうか |
response | オブジェクト | VirtualStoreのアンケートイベントをトリガーしたアンケート回答 |
response.responseId | テキスト | 回答ID。session.responsesの各項目のresponseIdと一致します |
response.surveyId | テキスト | アンケートID |
response.resourceType | テキスト | 回答者の種類:guest、identity または user |
response.resourceId | テキスト | 回答者のID(resourceTypeがguestの場合はゲストID) |
response.targetType | テキスト | 回答された場所:予約の場合はstore.reservation.survey、ダイレクトセッションの場合はstore.directsession.survey |
response.targetId | テキスト | 予約またはダイレクトセッションのID |
response.createdAt | テキスト | 最初の回答日時(ISO 8601)。ゲストが再回答しても変わりません |
response.isUpdated | はい / いいえ | ゲストがアンケートに再回答し、既存の回答が更新されたかどうか |
アクション
このノードが実行できる処理です。ステップを追加 からノードを追加し、アクションを選びます。
予約一覧
指定店舗のすべての予約一覧を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ID | テキスト | はい | 特定のストアの予約をリスト |
| ホストID | テキスト | ホストIDでフィルター | |
| ステータス | テキスト | 予約ステータスでフィルター | |
| ページ | 数値 | ページ番号(ページネーション) 既定値: 1 | |
| 1ページあたり | 数値 | 1ページあたりの件数 既定値: 100 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"host_id": "string",
"equipment_id": "string",
"start_at": "string",
"end_at": "string",
"status": "string",
"type": "string",
"is_private": false,
"num_by_guest": 0,
"guests": [
{
"id": "string",
"hash_id": "string",
"family_name": "string",
"first_name": "string",
"family_furigana": "string",
"first_furigana": "string",
"family_katakana": "string",
"first_katakana": "string",
"email": "string",
"note": "string",
"phone_number": "string",
"line": {
"id": "string",
"name": "string",
"avatar": "string",
"user_id": "string"
},
"status": "string",
"resource_type": "string",
"resource_id": "string",
"external_id": "string",
"is_survey_enabled": true
}
],
"host": {},
"equipment": {},
"duration": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 予約の一意の識別子 |
host_id | テキスト | ホストID |
equipment_id | テキスト | 機材ID |
start_at | テキスト | 予約の開始時刻 |
end_at | テキスト | 予約の終了時刻 |
status | テキスト | 予約のステータス |
type | テキスト | 予約の種類 |
is_private | はい / いいえ | 予約がプライベートかどうか |
num_by_guest | 数値 | 予約に含まれるゲスト数 |
guests[] | リスト | 予約のゲスト一覧 |
guests[].id | テキスト | ゲストの一意の識別子 |
guests[].hash_id | テキスト | ゲストのハッシュID |
guests[].family_name | テキスト | ゲストの姓 |
guests[].first_name | テキスト | ゲストの名 |
guests[].family_furigana | テキスト | 姓(ふりがな) |
guests[].first_furigana | テキスト | 名(ふりがな) |
guests[].family_katakana | テキスト | 姓(カタカナ) |
guests[].first_katakana | テキスト | 名(カタカナ) |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].note | テキスト | ゲストメモ |
guests[].phone_number | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | LINEプロフィール |
guests[].line.id | テキスト | LINEプロフィールの内部ID |
guests[].line.name | テキスト | ゲストのLINE名 |
guests[].line.avatar | テキスト | LINEアバター |
guests[].line.user_id | テキスト | LINEプロフィールの外部ID(LINE UID) |
guests[].status | テキスト | 予約ステータス |
guests[].resource_type | テキスト | リソース種別 |
guests[].resource_id | テキスト | リソースID |
guests[].external_id | テキスト | ゲストの外部ID |
guests[].is_survey_enabled | はい / いいえ | アンケートを有効化するフラグ |
host | オブジェクト | ホスト情報 |
equipment | オブジェクト | 機材情報 |
duration | オブジェクト | 所要時間情報 |
予約取得
IDで予約を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 予約ID | テキスト | はい | 予約ID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"host_id": "string",
"equipment_id": "string",
"start_at": "string",
"end_at": "string",
"status": "string",
"type": "string",
"is_private": false,
"num_by_guest": 0,
"guests": [
{
"id": "string",
"hash_id": "string",
"family_name": "string",
"first_name": "string",
"family_furigana": "string",
"first_furigana": "string",
"family_katakana": "string",
"first_katakana": "string",
"email": "string",
"note": "string",
"phone_number": "string",
"line": {
"id": "string",
"name": "string",
"avatar": "string",
"user_id": "string"
},
"status": "string",
"resource_type": "string",
"resource_id": "string",
"external_id": "string",
"is_survey_enabled": true
}
],
"host": {},
"equipment": {},
"duration": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 予約の一意の識別子 |
host_id | テキスト | ホストID |
equipment_id | テキスト | 機材ID |
start_at | テキスト | 予約の開始時刻 |
end_at | テキスト | 予約の終了時刻 |
status | テキスト | 予約のステータス |
type | テキスト | 予約の種類 |
is_private | はい / いいえ | 予約がプライベートかどうか |
num_by_guest | 数値 | 予約に含まれるゲスト数 |
guests[] | リスト | 予約のゲスト一覧 |
guests[].id | テキスト | ゲストの一意の識別子 |
guests[].hash_id | テキスト | ゲストのハッシュID |
guests[].family_name | テキスト | ゲストの姓 |
guests[].first_name | テキスト | ゲストの名 |
guests[].family_furigana | テキスト | 姓(ふりがな) |
guests[].first_furigana | テキスト | 名(ふりがな) |
guests[].family_katakana | テキスト | 姓(カタカナ) |
guests[].first_katakana | テキスト | 名(カタカナ) |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].note | テキスト | ゲストメモ |
guests[].phone_number | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | LINEプロフィール |
guests[].line.id | テキスト | LINEプロフィールの内部ID |
guests[].line.name | テキスト | ゲストのLINE名 |
guests[].line.avatar | テキスト | LINEアバター |
guests[].line.user_id | テキスト | LINEプロフィールの外部ID(LINE UID) |
guests[].status | テキスト | 予約ステータス |
guests[].resource_type | テキスト | リソース種別 |
guests[].resource_id | テキスト | リソースID |
guests[].external_id | テキスト | ゲストの外部ID |
guests[].is_survey_enabled | はい / いいえ | アンケートを有効化するフラグ |
host | オブジェクト | ホスト情報 |
equipment | オブジェクト | 機材情報 |
duration | オブジェクト | 所要時間情報 |
予約キャンセル
IDで予約をキャンセル
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 予約ID | テキスト | はい | 予約ID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"host_id": "string",
"equipment_id": "string",
"start_at": "string",
"end_at": "string",
"status": "string",
"type": "string",
"is_private": false,
"num_by_guest": 0,
"guests": [
{
"id": "string",
"hash_id": "string",
"family_name": "string",
"first_name": "string",
"family_furigana": "string",
"first_furigana": "string",
"family_katakana": "string",
"first_katakana": "string",
"email": "string",
"note": "string",
"phone_number": "string",
"line": {
"id": "string",
"name": "string",
"avatar": "string",
"user_id": "string"
},
"status": "string",
"resource_type": "string",
"resource_id": "string",
"external_id": "string",
"is_survey_enabled": true
}
],
"host": {},
"equipment": {},
"duration": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 予約の一意の識別子 |
host_id | テキスト | ホストID |
equipment_id | テキスト | 機材ID |
start_at | テキスト | 予約の開始時刻 |
end_at | テキスト | 予約の終了時刻 |
status | テキスト | 予約のステータス |
type | テキスト | 予約の種類 |
is_private | はい / いいえ | 予約がプライベートかどうか |
num_by_guest | 数値 | 予約に含まれるゲスト数 |
guests[] | リスト | 予約のゲスト一覧 |
guests[].id | テキスト | ゲストの一意の識別子 |
guests[].hash_id | テキスト | ゲストのハッシュID |
guests[].family_name | テキスト | ゲストの姓 |
guests[].first_name | テキスト | ゲストの名 |
guests[].family_furigana | テキスト | 姓(ふりがな) |
guests[].first_furigana | テキスト | 名(ふりがな) |
guests[].family_katakana | テキスト | 姓(カタカナ) |
guests[].first_katakana | テキスト | 名(カタカナ) |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].note | テキスト | ゲストメモ |
guests[].phone_number | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | LINEプロフィール |
guests[].line.id | テキスト | LINEプロフィールの内部ID |
guests[].line.name | テキスト | ゲストのLINE名 |
guests[].line.avatar | テキスト | LINEアバター |
guests[].line.user_id | テキスト | LINEプロフィールの外部ID(LINE UID) |
guests[].status | テキスト | 予約ステータス |
guests[].resource_type | テキスト | リソース種別 |
guests[].resource_id | テキスト | リソースID |
guests[].external_id | テキスト | ゲストの外部ID |
guests[].is_survey_enabled | はい / いいえ | アンケートを有効化するフラグ |
host | オブジェクト | ホスト情報 |
equipment | オブジェクト | 機材情報 |
duration | オブジェクト | 所要時間情報 |
予約作成
新しい予約を作成
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ID | テキスト | はい | 店舗ID |
| VS組織ID | テキスト | はい | 組織のVS ID |
| 開始日時 | テキスト | はい | 開始日時 |
| 所要時間ID | テキスト | はい | 所要時間設定ID |
| ゲスト | オブジェクト | はい | ゲスト情報 |
| ホストID | テキスト | 特定ホストで予約を作成する場合のホストID | |
| テストモード | はい / いいえ | テストモードのフラグ 既定値: false | |
| URL種別 | 選択 | ユーザーが予約を作成したURLの種別 選択肢: ストア, ホスト, 組織既定値: store | |
| 機材ID | テキスト | 機材ID(オフライン予約で必須) | |
| 種類 | 選択 | 予約の種類 選択肢: オンライン, オフライン既定値: online | |
| 作成者ID | テキスト | 作成者ID(ホストが作成する場合) | |
| 回答 | オブジェクト | ヒアリングフォームの回答 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"host_id": "string",
"equipment_id": "string",
"start_at": "string",
"end_at": "string",
"status": "string",
"type": "string",
"is_private": false,
"num_by_guest": 0,
"guests": [
{
"id": "string",
"hash_id": "string",
"family_name": "string",
"first_name": "string",
"family_furigana": "string",
"first_furigana": "string",
"family_katakana": "string",
"first_katakana": "string",
"email": "string",
"note": "string",
"phone_number": "string",
"line": {
"id": "string",
"name": "string",
"avatar": "string",
"user_id": "string"
},
"status": "string",
"resource_type": "string",
"resource_id": "string",
"external_id": "string",
"is_survey_enabled": true
}
],
"host": {},
"equipment": {},
"duration": {}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 予約の一意の識別子 |
host_id | テキスト | ホストID |
equipment_id | テキスト | 機材ID |
start_at | テキスト | 予約の開始時刻 |
end_at | テキスト | 予約の終了時刻 |
status | テキスト | 予約のステータス |
type | テキスト | 予約の種類 |
is_private | はい / いいえ | 予約がプライベートかどうか |
num_by_guest | 数値 | 予約に含まれるゲスト数 |
guests[] | リスト | 予約のゲスト一覧 |
guests[].id | テキスト | ゲストの一意の識別子 |
guests[].hash_id | テキスト | ゲストのハッシュID |
guests[].family_name | テキスト | ゲストの姓 |
guests[].first_name | テキスト | ゲストの名 |
guests[].family_furigana | テキスト | 姓(ふりがな) |
guests[].first_furigana | テキスト | 名(ふりがな) |
guests[].family_katakana | テキスト | 姓(カタカナ) |
guests[].first_katakana | テキスト | 名(カタカナ) |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].note | テキスト | ゲストメモ |
guests[].phone_number | テキスト | ゲストの電話番号 |
guests[].line | オブジェクト | LINEプロフィール |
guests[].line.id | テキスト | LINEプロフィールの内部ID |
guests[].line.name | テキスト | ゲストのLINE名 |
guests[].line.avatar | テキスト | LINEアバター |
guests[].line.user_id | テキスト | LINEプロフィールの外部ID(LINE UID) |
guests[].status | テキスト | 予約ステータス |
guests[].resource_type | テキスト | リソース種別 |
guests[].resource_id | テキスト | リソースID |
guests[].external_id | テキスト | ゲストの外部ID |
guests[].is_survey_enabled | はい / いいえ | アンケートを有効化するフラグ |
host | オブジェクト | ホスト情報 |
equipment | オブジェクト | 機材情報 |
duration | オブジェクト | 所要時間情報 |
日付スロット一覧
新規予約に利用可能な日付スロット一覧を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ID | テキスト | はい | 店舗ID |
| 種類 | 選択 | はい | 予約の種類 選択肢: オンライン, オフライン |
| 所要時間(分) | 数値 | はい | 分単位の所要時間(15/30/45/60) |
| 所要時間ID | テキスト | 所要時間ID | |
| 開始日 | テキスト | 開始日 | |
| 終了日 | テキスト | 終了日 | |
| 予約ID | テキスト | 日時変更時の予約ID | |
| ホストID | テキスト | ホストID | |
| 機材ID | テキスト | 機材ID(オフライン予約用) |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば today は $.<ステップID>.output.today です。
{
"today": "string",
"days": [
{
"date": "string",
"status": "string",
"is_holiday": false,
"hosts": [
{}
]
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
today | テキスト | 本日 |
days[] | リスト | 日一覧 |
days[].date | テキスト | 日付 |
days[].status | テキスト | ステータス |
days[].is_holiday | はい / いいえ | 休日かどうか |
days[].hosts[] | リスト | ホスト一覧 |
days[].hosts[].id | テキスト | ホストID |
days[].hosts[].name | テキスト | ホスト名 |
days[].hosts[].status | テキスト | ホストのステータス |
days[].hosts[].slots[] | リスト | スロット |
days[].hosts[].slots[].start_time | テキスト | 開始時刻 |
days[].hosts[].slots[].duration | 数値 | 所要時間 |
時間スロット一覧
新規予約に利用可能な時間スロット一覧を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ID | テキスト | はい | 店舗ID |
| 所要時間(分) | 数値 | はい | 分単位の所要時間(15/30/45/60) |
| 選択日 | テキスト | はい | 選択日(例:"2025-09-08") |
| 所要時間ID | テキスト | 所要時間ID | |
| 予約ID | テキスト | 予約更新時の予約ID | |
| ホストID | テキスト | 特定ホストで予約する場合のホストID | |
| 機材ID | テキスト | 機材ID(オフライン予約用) | |
| 種類 | 選択 | 予約の種類 選択肢: オンライン, オフライン |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば data[0].start_time は $.<ステップID>.output.data[0].start_time です。
{
"data": [
{
"start_time": "string",
"duration": 0
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
data[] | リスト | 開始時刻と所要時間を含む時間スロットの配列 |
data[].start_time | テキスト | 開始時刻 |
data[].duration | 数値 | 所要時間 |
店舗一覧
すべての店舗一覧を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ページ | 数値 | ページ番号(ページネーション) 既定値: 1 | |
| 1ページあたり | 数値 | 1ページあたりの件数 既定値: 100 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"name": "string",
"logo": {},
"image": {},
"address": {
"address": "string",
"latitude": 0,
"longitude": 0
},
"settings": {},
"working_days": {},
"hash_id": "string",
"reservation_url": "string",
"time_zone": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 店舗の一意の識別子 |
name | テキスト | 店舗名 |
logo | オブジェクト | 店舗ロゴ情報 |
image | オブジェクト | 店舗画像情報 |
address | オブジェクト | 店舗の住所情報 |
address.address | テキスト | 住所(全文) |
address.latitude | 数値 | 緯度 |
address.longitude | 数値 | 経度 |
settings | オブジェクト | 店舗設定 |
working_days | オブジェクト | 営業日の設定 |
hash_id | テキスト | 店舗のハッシュID |
reservation_url | テキスト | 予約用URL |
time_zone | テキスト | 店舗のタイムゾーン |
店舗取得
IDで店舗を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| リソースID | テキスト | はい | 店舗ID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"name": "string",
"logo": {},
"image": {},
"address": {
"address": "string",
"latitude": 0,
"longitude": 0
},
"settings": {},
"working_days": {},
"hash_id": "string",
"reservation_url": "string",
"time_zone": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 店舗の一意の識別子 |
name | テキスト | 店舗名 |
logo | オブジェクト | 店舗ロゴ情報 |
image | オブジェクト | 店舗画像情報 |
address | オブジェクト | 店舗の住所情報 |
address.address | テキスト | 住所(全文) |
address.latitude | 数値 | 緯度 |
address.longitude | 数値 | 経度 |
settings | オブジェクト | 店舗設定 |
working_days | オブジェクト | 営業日の設定 |
hash_id | テキスト | 店舗のハッシュID |
reservation_url | テキスト | 予約用URL |
time_zone | テキスト | 店舗のタイムゾーン |
ホスト取得
指定店舗のホストをIDで取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ホストID | テキスト | はい | 指定店舗内のホストID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"email": "string",
"full_name": "string",
"display_name": "string",
"role": "string",
"profile": {
"introduction": "string",
"position": "string",
"nickname": "string"
},
"number_of_scheduled_sessions": 0,
"number_of_onhold_sessions": 0
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ホストの一意の識別子 |
email | テキスト | ホストのメールアドレス |
full_name | テキスト | ホストの氏名(フル) |
display_name | テキスト | ホストの表示名 |
role | テキスト | ホストの役割 |
profile | オブジェクト | ホストのプロフィール情報 |
profile.introduction | テキスト | ホスト紹介文 |
profile.position | テキスト | ホストの役職 |
profile.nickname | テキスト | ホストのニックネーム |
number_of_scheduled_sessions | 数値 | 予定済みのセッション数 |
number_of_onhold_sessions | 数値 | 保留中のセッション数 |
店舗作成
新しい店舗を作成
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 名称 | テキスト | はい | 店舗名 |
| ブランド | テキスト | 店舗のブランド(KAO組織のみ使用) |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"name": "string",
"logo": {},
"image": {},
"address": {
"address": "string",
"latitude": 0,
"longitude": 0
},
"settings": {},
"working_days": {},
"hash_id": "string",
"reservation_url": "string",
"time_zone": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 店舗の一意の識別子 |
name | テキスト | 店舗名 |
logo | オブジェクト | 店舗ロゴ情報 |
image | オブジェクト | 店舗画像情報 |
address | オブジェクト | 店舗の住所情報 |
address.address | テキスト | 住所(全文) |
address.latitude | 数値 | 緯度 |
address.longitude | 数値 | 経度 |
settings | オブジェクト | 店舗設定 |
working_days | オブジェクト | 営業日の設定 |
hash_id | テキスト | 店舗のハッシュID |
reservation_url | テキスト | 予約用URL |
time_zone | テキスト | 店舗のタイムゾーン |
店舗ホストの更新
指定店舗のホストをIDで更新
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ホストID | テキスト | はい | 指定店舗内のホストID |
| 割り当て可能 | はい / いいえ | 割り当て可能か 既定値: false | |
| セッション名刺表示 | はい / いいえ | セッションルームで名刺を表示/非表示 既定値: true | |
| プライベートURL名刺表示 | はい / いいえ | プライベートURLで名刺を表示/非表示 既定値: true | |
| ダイレクト利用可 | はい / いいえ | ダイレクトセッションで利用可能 既定値: false | |
| オフライン利用可 | はい / いいえ | オフラインセッションで利用可能 既定値: false | |
| LIFF ID | テキスト | ホストのLIFF ID | |
| LIFFオフラインID | テキスト | ホストのLIFFオフラインID | |
| ダイレクトセッション設定 | オブジェクト | ホストのダイレクトセッション設定 | |
| ダイレクトセッション並び順 | テキスト | ダイレクトセッション一覧の並び順 | |
| オンライン表示 | はい / いいえ | オンラインセッションでホストを表示するか | |
| オフライン表示 | はい / いいえ | オフラインセッションでホストを表示するか | |
| ダイレクトセッション表示 | はい / いいえ | ダイレクトセッションでホストを表示するか | |
| オフライン順序 | 数値 | オフラインセッションの並び順インデックス 既定値: 0 | |
| オンライン順序 | 数値 | オンラインセッションの並び順インデックス 既定値: 0 | |
| ダイレクトセッション順序 | 数値 | ダイレクトセッションの並び順インデックス 既定値: 0 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"email": "string",
"full_name": "string",
"display_name": "string",
"role": "string",
"profile": {
"introduction": "string",
"position": "string",
"nickname": "string"
},
"number_of_scheduled_sessions": 0,
"number_of_onhold_sessions": 0
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ホストの一意の識別子 |
email | テキスト | ホストのメールアドレス |
full_name | テキスト | ホストの氏名(フル) |
display_name | テキスト | ホストの表示名 |
role | テキスト | ホストの役割 |
profile | オブジェクト | ホストのプロフィール情報 |
profile.introduction | テキスト | ホスト紹介文 |
profile.position | テキスト | ホストの役職 |
profile.nickname | テキスト | ホストのニックネーム |
number_of_scheduled_sessions | 数値 | 予定済みのセッション数 |
number_of_onhold_sessions | 数値 | 保留中のセッション数 |
店舗所要時間一覧
指定店舗の所要時間一覧を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ID | テキスト | はい | 店舗ID |
| 種類 | 選択 | 所要時間の種類 選択肢: オンライン, オフライン |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
[
{
"id": "string",
"name": "string",
"type": "online",
"duration": 0,
"description": "string",
"survey_id": "string",
"by_host_survey_id": "string",
"created_at": "string",
"updated_at": "string",
"image_id": "string",
"image": {},
"reception": {
"enabled": false,
"from_date": "string",
"to_date": "string",
"offset_day": 0,
"offset_hour": 0,
"limit_day": 7,
"limit_hour": 0
}
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | 所要時間の一意の識別子 |
name | テキスト | 所要時間名 |
type | テキスト | 所要時間の種類 |
duration | 数値 | 所要時間(分) |
description | テキスト | 所要時間の説明 |
survey_id | テキスト | アンケートID |
by_host_survey_id | テキスト | アンケートID(ホスト別) |
created_at | テキスト | 作成日時 |
updated_at | テキスト | 更新日時 |
image_id | テキスト | 所要時間の画像ID |
image | 任意 | |
image.id | テキスト | アセットID |
image.name | テキスト | ファイル名 |
image.mime_type | テキスト | MIMEタイプ |
image.size | 数値 | ファイルサイズ |
image.path | テキスト | ファイルのURL |
image.resource_type | テキスト | 設定SUPPORTED_ASSET_RESOURCE_TYPEで定義されたリソース種別のいずれか |
image.resource_id | テキスト | リソースID |
image.index | 数値 | 一覧内のアセットのインデックス |
image.created_at | テキスト | 作成日時 |
reception | オブジェクト | 受付時間設定 |
reception.enabled | はい / いいえ | この所要時間で受付時間を有効/無効化 |
reception.from_date | テキスト | 予約の受付開始日 |
reception.to_date | テキスト | 予約の受付終了日 |
reception.offset_day | 数値 | 予約受付のオフセット(日) |
reception.offset_hour | 数値 | 予約受付のオフセット(時間) |
reception.limit_day | 数値 | 予約受付の上限(日) |
reception.limit_hour | 数値 | 予約受付の上限(時間) |
店舗所要時間の更新
指定店舗の所要時間を更新
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ID | テキスト | はい | 店舗ID |
| 所要時間一覧 | リスト | 更新する所要時間の一覧 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば response.message は $.<ステップID>.output.response.message です。
{
"response": {
"message": "Durations updated successfully"
}
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
response | オブジェクト | VirtualStore APIが報告した結果 |
response.message | テキスト | 結果メッセージ(例: Durations updated successfully) |
アンケート一覧
指定店舗のアンケート一覧を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ID | テキスト | はい | 店舗ID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
[
{
"id": "string",
"title": "string",
"description": "string",
"enabled_for": "reservation,directsession",
"is_survey": false,
"resource_type": "string",
"questions": [
{
"id": "string",
"type": "string",
"placeholder": "string",
"question": "string",
"explanation": "string",
"options": [],
"validations": [],
"order": 0,
"has_other": false,
"is_satisfaction": false,
"is_image_option": false,
"columns": 1,
"created_at": "string",
"updated_at": "string"
}
],
"is_editable": true,
"created_at": "string",
"updated_at": "string"
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | アンケートID |
title | テキスト | アンケートのタイトル |
description | テキスト | アンケートの説明 |
enabled_for | テキスト | 有効/無効のフラグ |
is_survey | はい / いいえ | アンケートフラグ |
resource_type | テキスト | アンケートのリソース種別 |
questions[] | リスト | アンケート設問一覧 |
questions[].id | テキスト | 設問ID |
questions[].type | テキスト | 設問の種類 |
questions[].placeholder | テキスト | 入力/テキストエリアのプレースホルダー |
questions[].question | テキスト | 設問内容 |
questions[].explanation | テキスト | 設問の説明 |
questions[].options[] | リスト | ラジオ/チェックボックス/ドロップダウン/リニアスケールの選択肢 |
questions[].options[].value | テキスト | 選択肢の値 |
questions[].options[].asset_id | テキスト | 画像選択肢のアセットID |
questions[].options[].order | テキスト | 満足度設問の表示順 |
questions[].validations[] | リスト | 入力バリデーション |
questions[].order | 数値 | 設問の表示順 |
questions[].has_other | はい / いいえ | 選択肢に「その他」を含めるフラグ |
questions[].is_satisfaction | はい / いいえ | 固定の満足度設問かどうか |
questions[].is_image_option | はい / いいえ | 選択肢に画像を含むかどうか |
questions[].columns | 数値 | チェックボックス/ラジオの列数 |
questions[].created_at | テキスト | 作成日時 |
questions[].updated_at | テキスト | 更新日時 |
is_editable | はい / いいえ | アンケートが編集可能かどうか |
created_at | テキスト | 作成日時 |
updated_at | テキスト | 更新日時 |
アンケート取得
IDでアンケートを取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| アンケートID | テキスト | はい | アンケートID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"title": "string",
"description": "string",
"enabled_for": "reservation,directsession",
"is_survey": false,
"resource_type": "string",
"questions": [
{
"id": "string",
"type": "string",
"placeholder": "string",
"question": "string",
"explanation": "string",
"options": [
{}
],
"validations": [
{}
],
"order": 0,
"has_other": false,
"is_satisfaction": false,
"is_image_option": false,
"columns": 1,
"created_at": "string",
"updated_at": "string"
}
],
"is_editable": true,
"created_at": "string",
"updated_at": "string"
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | アンケートID |
title | テキスト | アンケートのタイトル |
description | テキスト | アンケートの説明 |
enabled_for | テキスト | 有効/無効のフラグ |
is_survey | はい / いいえ | アンケートフラグ |
resource_type | テキスト | アンケートのリソース種別 |
questions[] | リスト | アンケート設問一覧 |
questions[].id | テキスト | 設問ID |
questions[].type | テキスト | 設問の種類 |
questions[].placeholder | テキスト | 入力/テキストエリアのプレースホルダー |
questions[].question | テキスト | 設問内容 |
questions[].explanation | テキスト | 設問の説明 |
questions[].options[] | リスト | ラジオ/チェックボックス/ドロップダウン/リニアスケールの選択肢 |
questions[].options[].value | テキスト | 選択肢の値 |
questions[].options[].asset_id | テキスト | 画像選択肢のアセットID |
questions[].options[].order | テキスト | 満足度設問の表示順 |
questions[].validations[] | リスト | 入力バリデーション |
questions[].order | 数値 | 設問の表示順 |
questions[].has_other | はい / いいえ | 選択肢に「その他」を含めるフラグ |
questions[].is_satisfaction | はい / いいえ | 固定の満足度設問かどうか |
questions[].is_image_option | はい / いいえ | 選択肢に画像を含むかどうか |
questions[].columns | 数値 | チェックボックス/ラジオの列数 |
questions[].created_at | テキスト | 作成日時 |
questions[].updated_at | テキスト | 更新日時 |
is_editable | はい / いいえ | アンケートが編集可能かどうか |
created_at | テキスト | 作成日時 |
updated_at | テキスト | 更新日時 |
ホスト一覧
指定店舗のすべてのホスト一覧を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 役割 | テキスト | ホストの役割でフィルター | |
| ページ | 数値 | ページ番号(ページネーション) 既定値: 1 | |
| 1ページあたり | 数値 | 1ページあたりの件数 既定値: 100 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
[
{
"id": "string",
"email": "string",
"full_name": "string",
"display_name": "string",
"role": "string",
"profile": {
"introduction": "string",
"position": "string",
"nickname": "string"
},
"number_of_scheduled_sessions": 0,
"number_of_onhold_sessions": 0
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ホストの一意の識別子 |
email | テキスト | ホストのメールアドレス |
full_name | テキスト | ホストの氏名(フル) |
display_name | テキスト | ホストの表示名 |
role | テキスト | ホストの役割 |
profile | オブジェクト | ホストのプロフィール情報 |
profile.introduction | テキスト | ホスト紹介文 |
profile.position | テキスト | ホストの役職 |
profile.nickname | テキスト | ホストのニックネーム |
number_of_scheduled_sessions | 数値 | 予定済みのセッション数 |
number_of_onhold_sessions | 数値 | 保留中のセッション数 |
ダイレクトセッション一覧
指定店舗のすべてのダイレクトセッション一覧を取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ID | テキスト | はい | 店舗ID |
| ページ | 数値 | ページ番号(ページネーション) 既定値: 3 | |
| 並び順 | テキスト | ダイレクトセッション一覧の並び順 既定値: -created_at | |
| 1ページあたり | 数値 | 1ページあたりの件数 既定値: 100 |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば [0].id は $.<ステップID>.output.[0].id です。
[
{
"id": "string",
"host_id": "string",
"start_at": "string",
"end_at": "string",
"status": "created",
"created_at": "string",
"updated_at": "string",
"hash_id": "string",
"utm_source": "string",
"is_test": false,
"is_private": false,
"is_blocked_by": "string",
"url_type": "string",
"num_by_guest": 1,
"is_recorded": false,
"guests": [
{
"family_name": "string",
"first_name": "string",
"family_furigana": "string",
"first_furigana": "string",
"family_katakana": "string",
"first_katakana": "string",
"email": "string",
"phone_number": "string",
"external_id": "string",
"web_id": "string",
"hash_id": "string",
"is_booker": false,
"visitor_id": "string",
"identity": 0,
"attendee": {},
"full_name": "string",
"id": "string",
"is_survey_enabled": true
}
],
"host": {},
"responses": [
{
"survey_id": "string",
"resource_id": "string",
"resource_type": "string",
"answers": [],
"created_at": "string",
"updated_at": "string"
}
]
}
]例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ダイレクトセッションID |
host_id | テキスト | ホストID |
start_at | テキスト | 開始日時 |
end_at | テキスト | 終了日時 |
status | テキスト | ダイレクトセッションのステータス |
created_at | テキスト | 作成日時 |
updated_at | テキスト | 更新日時 |
hash_id | テキスト | IDのハッシュ |
utm_source | テキスト | UTMソース |
is_test | はい / いいえ | このダイレクトセッションがテストかどうかのフラグ |
is_private | はい / いいえ | このダイレクトセッションはプライベートホストURLから予約されました |
is_blocked_by | テキスト | このダイレクトセッションはホストによりブロックされています |
url_type | テキスト | ユーザーがダイレクトセッションを作成したURLの種別 |
num_by_guest | 数値 | ゲストのメール別にダイレクトセッション数を表示 |
is_recorded | はい / いいえ | このダイレクトセッションを録画するかどうか |
guests[] | リスト | ゲスト一覧 |
guests[].family_name | テキスト | ゲストの姓 |
guests[].first_name | テキスト | ゲストの名 |
guests[].family_furigana | テキスト | 姓(ふりがな) |
guests[].first_furigana | テキスト | 名(ふりがな) |
guests[].family_katakana | テキスト | 姓(カタカナ) |
guests[].first_katakana | テキスト | 名(カタカナ) |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].phone_number | テキスト | ゲストの電話番号 |
guests[].external_id | テキスト | ゲストの外部ID |
guests[].web_id | テキスト | ゲストのWeb ID |
guests[].hash_id | テキスト | IDのハッシュ |
guests[].is_booker | はい / いいえ | このゲストが予約者かどうか |
guests[].visitor_id | テキスト | ビジターID |
guests[].identity | 数値 | ゲストの識別情報 |
guests[].attendee | 任意 | 参加者情報 |
guests[].attendee.id | テキスト | 参加者ID |
guests[].attendee.external_user_id | テキスト | 外部ユーザーID |
guests[].attendee.join_token | テキスト | 参加トークン |
guests[].full_name | テキスト | ゲストの氏名(フル) |
guests[].id | テキスト | ゲストID |
guests[].is_survey_enabled | はい / いいえ | アンケートを有効化するフラグ |
host | 任意 | |
host.id | テキスト | ホストの一意の識別子 |
host.email | テキスト | ホストのメールアドレス |
host.full_name | テキスト | ホストの氏名(フル) |
host.display_name | テキスト | ホストの表示名 |
host.role | テキスト | ホストの役割 |
host.profile | オブジェクト | ホストのプロフィール情報 |
host.profile.introduction | テキスト | ホスト紹介文 |
host.profile.position | テキスト | ホストの役職 |
host.profile.nickname | テキスト | ホストのニックネーム |
host.number_of_scheduled_sessions | 数値 | 予定済みのセッション数 |
host.number_of_onhold_sessions | 数値 | 保留中のセッション数 |
responses[] | リスト | 回答一覧 |
responses[].survey_id | テキスト | アンケートID |
responses[].resource_id | テキスト | リソースID |
responses[].resource_type | テキスト | リソース種別 |
responses[].answers[] | リスト | 回答一覧 |
responses[].answers[].question_id | テキスト | 設問ID |
responses[].answers[].response_id | テキスト | 回答ID |
responses[].answers[].survey_id | テキスト | アンケートID |
responses[].answers[].answer | オブジェクト | 設問の回答 |
responses[].answers[].assets[] | リスト | アセット |
responses[].answers[].assets[].id | テキスト | アセットID |
responses[].answers[].assets[].name | テキスト | ファイル名 |
responses[].answers[].assets[].mime_type | テキスト | MIMEタイプ |
responses[].answers[].assets[].size | 数値 | ファイルサイズ |
responses[].answers[].assets[].path | テキスト | ファイルのURL |
responses[].answers[].assets[].resource_type | テキスト | 設定SUPPORTED_ASSET_RESOURCE_TYPEで定義されたリソース種別のいずれか |
responses[].answers[].assets[].resource_id | テキスト | リソースID |
responses[].answers[].assets[].index | 数値 | 一覧内のアセットのインデックス |
responses[].answers[].assets[].created_at | テキスト | 作成日時 |
responses[].answers[].response_resource_id | テキスト | 回答のリソースID |
responses[].answers[].response_resource_type | テキスト | 回答のリソース種別 |
responses[].created_at | テキスト | 作成日時 |
responses[].updated_at | テキスト | 更新日時 |
ダイレクトセッション取得
IDでダイレクトセッションを取得
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| ダイレクトセッションID | テキスト | はい | ダイレクトセッションID |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"host_id": "string",
"start_at": "string",
"end_at": "string",
"status": "created",
"created_at": "string",
"updated_at": "string",
"hash_id": "string",
"utm_source": "string",
"is_test": false,
"is_private": false,
"is_blocked_by": "string",
"url_type": "string",
"num_by_guest": 1,
"is_recorded": false,
"guests": [
{
"family_name": "string",
"first_name": "string",
"family_furigana": "string",
"first_furigana": "string",
"family_katakana": "string",
"first_katakana": "string",
"email": "string",
"phone_number": "string",
"external_id": "string",
"web_id": "string",
"hash_id": "string",
"is_booker": false,
"visitor_id": "string",
"identity": 0,
"attendee": {},
"full_name": "string",
"id": "string",
"is_survey_enabled": true
}
],
"host": {},
"responses": [
{
"survey_id": "string",
"resource_id": "string",
"resource_type": "string",
"answers": [
{}
],
"created_at": "string",
"updated_at": "string"
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ダイレクトセッションID |
host_id | テキスト | ホストID |
start_at | テキスト | 開始日時 |
end_at | テキスト | 終了日時 |
status | テキスト | ダイレクトセッションのステータス |
created_at | テキスト | 作成日時 |
updated_at | テキスト | 更新日時 |
hash_id | テキスト | IDのハッシュ |
utm_source | テキスト | UTMソース |
is_test | はい / いいえ | このダイレクトセッションがテストかどうかのフラグ |
is_private | はい / いいえ | このダイレクトセッションはプライベートホストURLから予約されました |
is_blocked_by | テキスト | このダイレクトセッションはホストによりブロックされています |
url_type | テキスト | ユーザーがダイレクトセッションを作成したURLの種別 |
num_by_guest | 数値 | ゲストのメール別にダイレクトセッション数を表示 |
is_recorded | はい / いいえ | このダイレクトセッションを録画するかどうか |
guests[] | リスト | ゲスト一覧 |
guests[].family_name | テキスト | ゲストの姓 |
guests[].first_name | テキスト | ゲストの名 |
guests[].family_furigana | テキスト | 姓(ふりがな) |
guests[].first_furigana | テキスト | 名(ふりがな) |
guests[].family_katakana | テキスト | 姓(カタカナ) |
guests[].first_katakana | テキスト | 名(カタカナ) |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].phone_number | テキスト | ゲストの電話番号 |
guests[].external_id | テキスト | ゲストの外部ID |
guests[].web_id | テキスト | ゲストのWeb ID |
guests[].hash_id | テキスト | IDのハッシュ |
guests[].is_booker | はい / いいえ | このゲストが予約者かどうか |
guests[].visitor_id | テキスト | ビジターID |
guests[].identity | 数値 | ゲストの識別情報 |
guests[].attendee | 任意 | 参加者情報 |
guests[].attendee.id | テキスト | 参加者ID |
guests[].attendee.external_user_id | テキスト | 外部ユーザーID |
guests[].attendee.join_token | テキスト | 参加トークン |
guests[].full_name | テキスト | ゲストの氏名(フル) |
guests[].id | テキスト | ゲストID |
guests[].is_survey_enabled | はい / いいえ | アンケートを有効化するフラグ |
host | 任意 | |
host.id | テキスト | ホストの一意の識別子 |
host.email | テキスト | ホストのメールアドレス |
host.full_name | テキスト | ホストの氏名(フル) |
host.display_name | テキスト | ホストの表示名 |
host.role | テキスト | ホストの役割 |
host.profile | オブジェクト | ホストのプロフィール情報 |
host.profile.introduction | テキスト | ホスト紹介文 |
host.profile.position | テキスト | ホストの役職 |
host.profile.nickname | テキスト | ホストのニックネーム |
host.number_of_scheduled_sessions | 数値 | 予定済みのセッション数 |
host.number_of_onhold_sessions | 数値 | 保留中のセッション数 |
responses[] | リスト | 回答一覧 |
responses[].survey_id | テキスト | アンケートID |
responses[].resource_id | テキスト | リソースID |
responses[].resource_type | テキスト | リソース種別 |
responses[].answers[] | リスト | 回答一覧 |
responses[].answers[].question_id | テキスト | 設問ID |
responses[].answers[].response_id | テキスト | 回答ID |
responses[].answers[].survey_id | テキスト | アンケートID |
responses[].answers[].answer | オブジェクト | 設問の回答 |
responses[].answers[].assets[] | リスト | アセット |
responses[].answers[].assets[].id | テキスト | アセットID |
responses[].answers[].assets[].name | テキスト | ファイル名 |
responses[].answers[].assets[].mime_type | テキスト | MIMEタイプ |
responses[].answers[].assets[].size | 数値 | ファイルサイズ |
responses[].answers[].assets[].path | テキスト | ファイルのURL |
responses[].answers[].assets[].resource_type | テキスト | 設定SUPPORTED_ASSET_RESOURCE_TYPEで定義されたリソース種別のいずれか |
responses[].answers[].assets[].resource_id | テキスト | リソースID |
responses[].answers[].assets[].index | 数値 | 一覧内のアセットのインデックス |
responses[].answers[].assets[].created_at | テキスト | 作成日時 |
responses[].answers[].response_resource_id | テキスト | 回答のリソースID |
responses[].answers[].response_resource_type | テキスト | 回答のリソース種別 |
responses[].created_at | テキスト | 作成日時 |
responses[].updated_at | テキスト | 更新日時 |
ダイレクトセッション作成
新しいダイレクトセッションを作成
設定項目
| 項目 | 型 | 必須 | 説明 |
|---|---|---|---|
| 店舗ID | テキスト | はい | 店舗ID |
| ゲスト | オブジェクト | ゲスト情報 | |
| VS組織ID | テキスト | はい | 組織のVS ID |
| UTMソース | テキスト | UTMソース | |
| ホストID | テキスト | ホストID | |
| キー | テキスト | 個別ダイレクトセッション用の秘密鍵 | |
| テストモード | はい / いいえ | テストモードのフラグ 既定値: false | |
| URL種別 | 選択 | ユーザーがダイレクトセッションを作成したURLの種別 選択肢: ストア, ホスト, 組織既定値: store |
出力
後続のステップでは、$ の一覧でこのステップを選んでデータを使います。たとえば id は $.<ステップID>.output.id です。
{
"id": "string",
"host_id": "string",
"start_at": "string",
"end_at": "string",
"status": "created",
"created_at": "string",
"updated_at": "string",
"hash_id": "string",
"utm_source": "string",
"is_test": false,
"is_private": false,
"is_blocked_by": "string",
"url_type": "string",
"num_by_guest": 1,
"is_recorded": false,
"guests": [
{
"family_name": "string",
"first_name": "string",
"family_furigana": "string",
"first_furigana": "string",
"family_katakana": "string",
"first_katakana": "string",
"email": "string",
"phone_number": "string",
"external_id": "string",
"web_id": "string",
"hash_id": "string",
"is_booker": false,
"visitor_id": "string",
"identity": 0,
"attendee": {},
"full_name": "string",
"id": "string",
"is_survey_enabled": true
}
],
"host": {},
"responses": [
{
"survey_id": "string",
"resource_id": "string",
"resource_type": "string",
"answers": [
{}
],
"created_at": "string",
"updated_at": "string"
}
]
}例の値はデータの形を示すもので、実際の値ではありません。前のステップのデータを使う を参照してください。
フィールドの説明
| 項目 | 型 | 説明 |
|---|---|---|
id | テキスト | ダイレクトセッションID |
host_id | テキスト | ホストID |
start_at | テキスト | 開始日時 |
end_at | テキスト | 終了日時 |
status | テキスト | ダイレクトセッションのステータス |
created_at | テキスト | 作成日時 |
updated_at | テキスト | 更新日時 |
hash_id | テキスト | IDのハッシュ |
utm_source | テキスト | UTMソース |
is_test | はい / いいえ | このダイレクトセッションがテストかどうかのフラグ |
is_private | はい / いいえ | このダイレクトセッションはプライベートホストURLから予約されました |
is_blocked_by | テキスト | このダイレクトセッションはホストによりブロックされています |
url_type | テキスト | ユーザーがダイレクトセッションを作成したURLの種別 |
num_by_guest | 数値 | ゲストのメール別にダイレクトセッション数を表示 |
is_recorded | はい / いいえ | このダイレクトセッションを録画するかどうか |
guests[] | リスト | ゲスト一覧 |
guests[].family_name | テキスト | ゲストの姓 |
guests[].first_name | テキスト | ゲストの名 |
guests[].family_furigana | テキスト | 姓(ふりがな) |
guests[].first_furigana | テキスト | 名(ふりがな) |
guests[].family_katakana | テキスト | 姓(カタカナ) |
guests[].first_katakana | テキスト | 名(カタカナ) |
guests[].email | テキスト | ゲストのメールアドレス |
guests[].phone_number | テキスト | ゲストの電話番号 |
guests[].external_id | テキスト | ゲストの外部ID |
guests[].web_id | テキスト | ゲストのWeb ID |
guests[].hash_id | テキスト | IDのハッシュ |
guests[].is_booker | はい / いいえ | このゲストが予約者かどうか |
guests[].visitor_id | テキスト | ビジターID |
guests[].identity | 数値 | ゲストの識別情報 |
guests[].attendee | 任意 | 参加者情報 |
guests[].attendee.id | テキスト | 参加者ID |
guests[].attendee.external_user_id | テキスト | 外部ユーザーID |
guests[].attendee.join_token | テキスト | 参加トークン |
guests[].full_name | テキスト | ゲストの氏名(フル) |
guests[].id | テキスト | ゲストID |
guests[].is_survey_enabled | はい / いいえ | アンケートを有効化するフラグ |
host | 任意 | |
host.id | テキスト | ホストの一意の識別子 |
host.email | テキスト | ホストのメールアドレス |
host.full_name | テキスト | ホストの氏名(フル) |
host.display_name | テキスト | ホストの表示名 |
host.role | テキスト | ホストの役割 |
host.profile | オブジェクト | ホストのプロフィール情報 |
host.profile.introduction | テキスト | ホスト紹介文 |
host.profile.position | テキスト | ホストの役職 |
host.profile.nickname | テキスト | ホストのニックネーム |
host.number_of_scheduled_sessions | 数値 | 予定済みのセッション数 |
host.number_of_onhold_sessions | 数値 | 保留中のセッション数 |
responses[] | リスト | 回答一覧 |
responses[].survey_id | テキスト | アンケートID |
responses[].resource_id | テキスト | リソースID |
responses[].resource_type | テキスト | リソース種別 |
responses[].answers[] | リスト | 回答一覧 |
responses[].answers[].question_id | テキスト | 設問ID |
responses[].answers[].response_id | テキスト | 回答ID |
responses[].answers[].survey_id | テキスト | アンケートID |
responses[].answers[].answer | オブジェクト | 設問の回答 |
responses[].answers[].assets[] | リスト | アセット |
responses[].answers[].assets[].id | テキスト | アセットID |
responses[].answers[].assets[].name | テキスト | ファイル名 |
responses[].answers[].assets[].mime_type | テキスト | MIMEタイプ |
responses[].answers[].assets[].size | 数値 | ファイルサイズ |
responses[].answers[].assets[].path | テキスト | ファイルのURL |
responses[].answers[].assets[].resource_type | テキスト | 設定SUPPORTED_ASSET_RESOURCE_TYPEで定義されたリソース種別のいずれか |
responses[].answers[].assets[].resource_id | テキスト | リソースID |
responses[].answers[].assets[].index | 数値 | 一覧内のアセットのインデックス |
responses[].answers[].assets[].created_at | テキスト | 作成日時 |
responses[].answers[].response_resource_id | テキスト | 回答のリソースID |
responses[].answers[].response_resource_type | テキスト | 回答のリソース種別 |
responses[].created_at | テキスト | 作成日時 |
responses[].updated_at | テキスト | 更新日時 |