ver.2サポートサイト

アクション実行APIのREQUEST BODY

機能概要

各アクション実行APIは、行いたいアクションによってREQUEST BODYが異なります。

詳しくは以下をご参照ください。

アクション実行APIのリクエスト先などの情報は、SPIRAL ver.2 APIリファレンスをご確認ください。
また、メール配信実行のサンプルプログラムも合わせてご確認ください。

メールアクション

作成したメールアクションの実行を行うAPIです。

アクション実行時には作成したメールアクションに沿って配信を行います。

メールアクションを実行すると配信準備を行い、それが完了してから配信が開始されます。
配信準備は配信対象レコードをDBから取得して宛先リストを作成するなどの処理を行なっています。

※各アクションのステータスは有効にしてください。

※本番環境のメールアクションを実行する場合、本番環境へリリースが必要です。

DBトリガの非同期アクション

{
"recordId":"2"
}

※配信対象のレコードIDを指定することで、作成したメールアクションから配信を実行します。

スケジュールトリガのアクション

{
"triggeredDate":"2020-03-09T12:00:00+09:00"
}

※triggeredDateに任意の時間を指定することで、メール設定に基づいた宛先に即時配信します。
※アクション実行時間の予約指定はできません。
※アクション実行APIで実行した配信ログは、アプリ管理＞アクション＞アクション履歴からご確認ください。
（アプリ管理＞スケジュールトリガ＞アクション＞アクション履歴からは確認できません。）

フォームのメールアクション

{
  "recordId":"1",
  "siteId": "3",
  "formId": "7",
  "formType": "insert",
  "environment": "test"
}

※配信対象のレコードIDを指定することで、作成したメールアクションから配信を実行します。
※サイトID、フォームID、フォームタイプ、サイトの環境を指定することで、操作画面上の配信ログからログを確認できるようになります。

{
　　"recordId":"2"
}

※配信対象のレコードIDを指定することで、作成したメールアクションから配信を実行します。
※レコードIDのみ指定した場合、操作画面上の配信ログに記録せずに実行します。

パスワード再登録フォームの依頼メールアクション

{
  "recordId":"2",
  "siteId": "4",
  "pageId": "6",
  "formId": "8",
  "formType": "rePassword",
  "environment": "test"
}

※メール本文に再登録URLの差替えキーワードを含めた配信設定を実行する場合、サイトID、フォームID、ページID、フォームタイプ、サイトの環境を指定することで、メールが配信され、操作画面上の配信ログからログを確認できるようになります。

※ページIDは認証エリア内にあるパスワード再登録フォームを設置しているページのページIDを指定してください。

各IDの確認方法

アプリID（appId）の確認

アプリIDはアプリの基本設定画面でご確認頂けます。

メールアクションID（actionId）の確認

メールアクションIDはメールアクションの詳細画面でご確認頂けます。

サイトID（siteId）の確認

サイトIDは、サイトの基本設定画面でご確認頂けます。

ページID（pageId）の確認

ページIDは、ページの基本設定画面でご確認頂けます。

フォームID（formId）の確認

フォームIDは、フォームブロックの基本設定画面でご確認頂けます。

フォームのメールアクションリクエスト時のformtype、environmentの指定方法

formtype（フォームブロック）、environment（サイトの環境）をリクエストする際、以下の値でリクエストしてください。

formtype（フォームブロック）

どのフォームブロックに紐づくメールアクションに対して配信実行をリクエストするのか、フォームブロックを指定してください。

environment（サイトの環境）

サイトのどの環境下にあるメールアクションを実行するのか、テスト環境/本番環境のいずれかを指定してください。