会員登録から施策実行を自動化するフローAPI連携

新規登録という重要なタイミングを逃さず、フローAPIを活用して即時に施策を自動実行するための具体的な手順を解説します。

目的

ユーザーの行動をトリガーに施策をうつことでよりユーザー体験の向上につながります。
新規登録という重要なタイミングを逃さず、フローAPIを活用して即時に施策を自動実行するための具体的な手順を解説します。

サービス
NTT CPaaS NTT CPaaS

▶ アカウントをお持ちでない方へ|60日間無料トライアルを開始

チュートリアルの内容は、トライアル環境ですぐにお試しいただけます。クレジットカード情報の登録は不要、自動で課金されることもありません。送信テストや動作確認に、ぜひ無料トライアルをご活用ください。

事前準備

ステップ1:フローAPIで利用するAPIについて

https://ib.nttcpaas.com/docs/api/customer-engagement/moments/add-flow-participant

フローAPIでは上記のドキュメントのAPIを利用します。

必須項目として以下の項目があります。

  • cmpaignId: フローの識別子 ※確認方法はステップ2にて記載
  • participants: フローへの参加者の情報
    • ・identifyBy: フローへの参加者の識別子
      • ・type: ユーザーの識別を行う値を設定
      • ・identifier: フローに参加させるユーザーのID
      • ※設定する値は上のtypeにより変わります

メールアドレスが「user@example.com」のユーザーをフローにエントリーさせ、姓「山田」、名「太郎」を連携するためのサンプルコード(Python)は以下のようになります。

import http.client
import json

conn = http.client.HTTPSConnection("{xxx}.ibapi.nttcpaas.com")
payload = json.dumps({
  "participants": [
    {
      "identifyBy": {
        "identifier": "user@example.com",
        "type": "EMAIL"
      },
      "person": {
        "lastName": "山田",
        "firstName": "太郎"
      }
    }
  ]
})

headers = {
  'Authorization': '{authorization}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

conn.request("POST", "/moments/1/flows/{yyyyyyyyyyyyyyy}/participants", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
補足
※conn内「{xxx}」には、各テナントのドメインを設定します。(NTT CPaaSログイン状態でAPIドキュメントを開くと、自動で表示されます。)
※「{yyyyyyyyyyyyyy}」にはフローのcampaignIdを設定します。
※「{authorization}」には「<APIキー>」の値など認証情報を設定します。

ステップ2: campaignId(フローの識別子)の確認方法

campaignIdはフローを開いた際のURLから確認できます。
画像の例では、「200000036065250」になります。

実施手順

このユースケースの手順は、次の3つのセクションに分かれています。

  • プロファイル属性の準備
  • フローの構成
  • APIの実行

ステップ1:プロファイル属性の準備

今回のシナリオでは、会員登録日を利用して待機、クーポンの利用有無を判定して分岐を行います。
そのために事前にプロファイルのカスタム属性を作成します。

  1. ①People > 構成 > パーソンカスタム属性を開き、「カスタム属性を作成」から新規の属性を作成します。
  1. ②属性の名前とデータのタイプを選択し保存をクリックします。

今回は、以下の2つを作成します。

1) 属性の名前を「会員登録日」、データタイプを「日付」に設定します。

2) 属性の名前を「クーポン利用判定」、データタイプを「真/偽 (Boolean)」に設定します。

ステップ2:フローの構成

全体の構成は以下のようになります。

新規会員登録が行われフローAPIが実行されたら、クーポン付きのお礼メールを送信、その後クーポンの期日の前日の15:00にもメールを送信するシナリオになります。

  1. ①フローのエントリーポイントとして「フローAPI」を設定します。
    フローの作成から 外部ソース > フローAPI を選択します。
  1. ②「パーソンプロファイルを更新」の設定をし、用意したカスタム属性「会員登録日」に当日の日付を格納します。

{register_date}はフロー変数という、フロー内でのみ利用できる変数を設定します。フロー変数はフローの設定から可能です。

today()関数を利用して、当日の日付を設定することで会員登録が行われた日を設定できるようにします。

  1. ③メールの送信を設定し、会員登録時のメールコンテンツを準備します。
    今回はすでに作成済みのお礼メールを設定します。「既存のメッセージを選択」から、該当のメールを検索・クリックします。

今回のメールには会員登録のお礼とクーポン獲得用の画像(URL)を含めています。

補足: プレースホルダーについて
{$lastName}、{$firstName}は、プレースホルダーというCPaaS内に保存されているプロファイルの属性などを差し込むものです。
テキストブロックを選択後、 プレースホルダー > 標準の属性 からLastName(姓)とFirstName(名)をメールに表示するようにします。
姓、名の情報はAPI実行時に連携します。

  1. ④「日付まで待機」を設定し、会員登録日から2日待機します。
    クーポンが会員登録後3日で切れることを前提とし、2日後にリマインドを送る設定にします。
  1. ⑤「一時停止」を設定し、15:00まで待機します。
    日付まで待機だけでは何時まで待機するか設定できていないため、一時停止を利用して15:00まで待機させ、クーポンの期限前日の15:00にリマインドのメールを送れるようにします。
  1. ⑥「セグメントオーディエンス」を設定し、用意したカスタム属性「クーポン利用判定」に値があるか確認します。
    値が空である場合は、クーポンの締切が近いことをお知らせするメールを送るようにします。
    ※「クーポン利用判定」の値は、別途CPaaSに連携が必要になります。
  1. ⑦メールの送信を設定し、クーポン未利用のユーザーに締切が近いことを知らせるメールコンテンツを準備します。
    今回はすでに作成済みのリマインドメールを設定します。
  1. ⑧「起動する」ボタンをクリック後、「今すぐ起動」ボタンをクリックし、フローをアクティブ化します。

ステップ3: APIの実行

1. サンプルコードをもとにフローAPIを実行します。
※実際には会員登録時にフローAPIが自動で実行されるようにする必要があります。

2. フローを確認するとエントリーされたことがわかります。

まとめ

フローAPIを利用して、ユーザーの行動をトリガーにリアルタイムに施策を打ちましょう。

NTT CPaaSを、
60日間無料でお試しください

・SMS・Voice・メールを本番同様に無料で検証
・全API機能に即日アクセス / 有料プランと同一環境
・国内開発者向けに最適化された日本語ガイド

無料トライアル

目次
  1. 目的
  2. 事前準備
    1. ステップ1:フローAPIで利用するAPIについて
    2. ステップ2: campaignId(フローの識別子)の確認方法
  3. 実施手順
    1. ステップ1:プロファイル属性の準備
    2. ステップ2:フローの構成
    3. ステップ3: APIの実行
  4. まとめ

2026.03.24