Skip to content

REST APIを使用したSMSメッセージの送信

Braze REST APIを使用して、バックエンドからトランザクションSMSメッセージをリアルタイムで送信します。この方法を使えば、プログラムでSMSメッセージを送信するサービスを構築しながら、Brazeダッシュボード上で他のCampaignsやCanvasesと並行して配信分析をトラッキングできます。

これは特に、バックエンドシステムでコンテンツが定義されている大量のトランザクションメッセージングにおいて有用です。たとえば、他のユーザーからメッセージが届いた際に消費者に通知し、Webサイトにアクセスして受信トレイを確認するよう促すことができます。

この方法を使えば、次のことができます：

  • バックエンドからリアルタイムでSMSメッセージをトリガーする。
  • マーケティング部門が所有するすべてのCampaignsやCanvasesと並行して分析データをトラッキングする。
  • メッセージ遅延、フォローアップリターゲティング、ABテストといった追加のBraze機能でユースケースを拡張する。
  • 必要に応じて、APIトリガー配信に切り替えることで、メッセージテンプレートをBrazeダッシュボードで定義しつつ、送信はバックエンドからトリガーし続けることができる。

REST API経由でSMSメッセージを送信するには、BrazeダッシュボードでAPI Campaignを設定し、/messages/sendエンドポイントを使用してメッセージを送信する必要があります。

前提条件

このガイドを完了するには、以下が必要です：

ステップ1：API Campaignを作成する

  1. Brazeダッシュボードで、Messaging > Campaignsに移動します。
  2. Create Campaignを選択し、次にAPI Campaignsを選択します。
  3. Campaignの名前と説明を入力します（例：「SMS通知」）。
  4. 識別とトラッキングのために関連タグを追加します。
  5. Add Messaging Channelを選択し、次にSMSを選択します。
  6. Campaignページに表示されているCampaign IDとMessage Variation IDをメモしておきます。APIリクエストを構築する際に両方の値が必要です。

ステップ2：APIを使ってSMSメッセージを送信する

/messages/sendエンドポイントへのPOSTリクエストを構築します。リクエストペイロードにCampaign ID、受信者の外部ユーザーID、およびSMSコンテンツを含めます。

リクエスト例

1
2
3

POST YOUR_REST_ENDPOINT/messages/send
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

YOUR_REST_ENDPOINTを、ワークスペースのRESTエンドポイントURLに置き換えます。

1
2
3
4
5
6
7
8
9
10
11
12

{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "external_user_ids": ["user123"],
  "messages": {
    "sms": {
      "app_id": "YOUR_APP_ID",
      "subscription_group_id": "YOUR_SMS_SUBSCRIPTION_GROUP_ID",
      "message_variation_id": "YOUR_MESSAGE_VARIATION_ID",
      "body": "Hi {{${first_name}}}, you have a new message in your inbox. Check it out at https://yourwebsite.com/messages. Text STOP to opt out."
    }
  }
}

プレースホルダーの値を実際のIDに置き換えます。bodyフィールドはLiquidパーソナライゼーションをサポートしているため、メッセージの内容を各受信者に合わせて調整できます。SMSメッセージングオブジェクトがサポートするパラメータの完全な一覧については、SMSオブジェクトを参照してください。

リクエストを構築した後、バックエンドサービスからBraze REST APIへPOSTリクエストを送信します。

ステップ3：統合を確認する

設定を完了したら、統合を確認します：

  1. ステップ2で説明した通りにAPIリクエストを送信します。その際、受信者として自身のユーザーIDを使用します。
  2. SMSメッセージが自分の携帯電話に届いていることを確認します。
  3. Brazeダッシュボードで、Campaignの結果ページに移動し、送信が記録されていることを確認します。
  4. Campaignを拡大するにつれて、結果を注意深く監視します。

考慮事項

  • SMSキャンペーンが関連規制および通信事業者の要件に準拠していることを確認してください。すべてのメッセージにオプトアウトの手順（「STOPと送信してオプトアウト」など）を含めてください。詳細については、SMSに関する法令およびオプトイン・オプトアウトキーワードを参照してください。
  • Brazeのパーソナライゼーション機能を使用して、ダイナミックなコンテンツやユーザー固有のデータを含め、SMSコンテンツをエンドユーザーに合わせてカスタマイズできます。
  • Braze REST APIは、メッセージのスケジュール設定やCampaignsのトリガーなどを行うための追加のメッセージングエンドポイントを提供しています。
New Stuff!