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

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

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

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

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

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

前提条件

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

ステップ 1: APIキャンペーンを作成する

1. Brazeのダッシュボードで、メッセージング＞キャンペーンに移動する。
2. キャンペーン作成を選択し、次にAPIキャンペーンを選択する。
3. キャンペーンの名前と説明を入力する。例えば「SMS通知」など。
4. 識別とトラッキングのために関連タグを追加する。
5. 「メッセージングチャネルを追加」を選択し、次に「SMS」を選択する。
6. キャンペーンページに表示されているキャンペーンIDとメッセージバリエーションIDをメモしておけ。APIリクエストを構築する際には、両方の値が必要だ。

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

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

リクエスト例

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

を、ワークスペースのRESTエンドポイントURLYOUR_REST_ENDPOINTに置き換える。

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のダッシュボードで、キャンペーン結果ページに移動し、送信が記録されていることを確認する。
4. キャンペーンを拡大するにつれて、結果を注意深く監視せよ。

考慮事項

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