REST API を使ってメッセージを送信する

バックエンドからリアルタイムでメッセージを送信するには、2つの異なるBrazeエンドポイントを使用できる。それぞれリクエストの形式が異なる。一つはリクエストにメッセージ全文を要求する。もう一つはキャンペーンIDを要求し、ダッシュボードで定義された内容を送信する。

この方法は、APIがサポートするあらゆるメッセージングチャネル（WhatsApp、メール、SMS、プッシュ通知、コンテンツカード、Webhookなど）で機能する。

送る方法は二つある

完全なリクエストとレスポンスの詳細については、「メッセージを即時送信（APIのみ）」および「APIトリガー配信エンドポイントを使用したキャンペーン送信」のエンドポイント参照を参照せよ。

オプション 1: リクエスト/messages/sendにメッセージ内容を添えて送信する

APIリクエストでメッセージの全文を指定したい場合、このエンドポイントを使用する。オブジェクトmessagesを含めなければならない（例えば、,messages.emailmessages.whats_app , または messages.smsなど）。キャンペーントラッキングなしで送信するにはcampaign_id省略できる。または、message_variation_id各メッセージにAPIキャンペーンIDとを含めることで、ダッシュボードで送信をトラッキングできる（詳細はエンドポイントリファレンスを参照）。

必須：権限messages.send付きのAPI キー。

例: WhatsAppのテンプレートメッセージ

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "external_user_ids": ["user123"],
  "messages": {
    "whats_app": {
      "app_id": "YOUR_APP_ID",
      "subscription_group_id": "YOUR_WHATSAPP_SUBSCRIPTION_GROUP_ID",
      "message_type": "template_message",
      "message": {
        "template_name": "new_message_received",
        "template_language_code": "en_US"
      }
    }
  }
}

WhatsAppオブジェクトの完全な仕様については、WhatsAppオブジェクトを参照せよ。

例: メール

1
2
3
4
5
6
7
8
9
10
11
{
  "external_user_ids": ["user123"],
  "messages": {
    "email": {
      "app_id": "YOUR_APP_ID",
      "subject": "Your order has shipped",
      "from": "[email protected]",
      "body": "<p>Your order #12345 is on its way.</p>"
    }
  }
}

他のチャネルについては、メッセージングオブジェクトを参照せよ。

オプション 2: ダッシュボード/campaigns/trigger/sendでコンテンツを使ってキャンペーンを開始する

メッセージの内容がBrazeダッシュボードで作成された場合（APIトリガー型キャンペーン）、このエンドポイントを使用する。必要なcampaign_id送信元と受信者を送る。オブジェクトmessagesは送らない。

必須：権限campaigns.trigger.send付きのAPI キー。

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

1. Brazeのダッシュボードで、メッセージング＞キャンペーンに移動する。
2. 「キャンペーン作成」を選択し、次に「APIトリガー型キャンペーン」（「APIキャンペーン」ではない）を選択する。
3. メッセージ送信チャネル（WhatsApp、メール、SMSなど）を追加し、ダッシュボードでメッセージ内容を作成する。
4. キャンペーンID（複数のバリアントを使用する場合は送信IDも）をメモしておくこと。これらをAPIリクエストで使用する。

APIトリガー型キャンペーンの作成に関する詳細は、APIトリガー型配信を参照のこと。

ステップ 2:API経由でキャンペーンのトリガーを行う

POSTリクエストを に送信する/campaigns/trigger/send。パラメータはcampaign_id とrecipients （または broadcast/audience）とする。オブジェクトを含めるなmessages——コンテンツはキャンペーンから来る。

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

1
2
3
4
5
6
7
8
{
  "campaign_id": "YOUR_CAMPAIGN_ID",
  "recipients": [
    {
      "external_user_id": "user123"
    }
  ]
}

リクエスト本文全体（、send_to_existing_only、attributes、などをtrigger_properties含む）については、APIトリガー配信エンドポイントを使用したキャンペーン送信のリファレンスを参照のこと。

統合を確認せよ

1. 上記のいずれかの方法でリクエストを送信する。その際、自分のユーザー ID を受信者として指定する。
2. メッセージが送信されたことを確認する。
3. オプション2を使用する場合、Brazeダッシュボードでキャンペーンを確認し、送信が記録されていることを確認せよ。

考慮事項

• 対応している場合は、Brazeのパーソナライゼーション機能を使ってコンテンツをカスタマイズする。
• メッセージングが関連規制に準拠していることを確認し、必要なオプトアウトオプションとプライバシー通知を含めること。
• その他のエンドポイント（スケジューリング、キャンバストリガーなど）については、メッセージングエンドポイントを参照せよ。