Versenden von SMS-Nachrichten über die REST API

Verwenden Sie die Braze REST API, um Transaktions-SMS-Nachrichten in Echtzeit von Ihrem Backend aus zu versenden. Mit diesem Ansatz können Sie einen Dienst erstellen, der SMS-Nachrichten programmgesteuert versendet und gleichzeitig die Zustellungs-Analytics zusammen mit Ihren anderen Campaigns und Canvases im Braze-Dashboard verfolgt.

Dies kann insbesondere für transaktionsbasiertes Messaging mit hohem Volumen nützlich sein, bei dem der Inhalt in Ihren Backend-Systemen definiert ist. Sie können beispielsweise Verbraucher:innen benachrichtigen, wenn sie eine Nachricht von einer anderen Nutzer:in erhalten, und sie einladen, Ihre Website zu besuchen und ihren Posteingang zu überprüfen.

Mit diesem Ansatz können Sie:

• SMS-Nachrichten in Echtzeit von Ihrem Backend aus triggern.
• Analytics-Daten zusammen mit all Ihren Marketing-Campaigns und Canvases verfolgen.
• Den Anwendungsfall mit zusätzlichen Braze-Features wie Nachrichtenverzögerungen, Follow-up-Retargeting und A/B-Tests erweitern.
• Optional zur API-gesteuerten Zustellung wechseln, um Ihre Nachrichten-Templates im Braze-Dashboard zu definieren, während Sie den Versand weiterhin über Ihr Backend triggern.

Um eine SMS-Nachricht über die REST API zu versenden, müssen Sie im Braze-Dashboard eine API-Kampagne einrichten und anschließend den /messages/send-Endpunkt verwenden, um die Nachricht zu versenden.

Voraussetzungen

Um diese Anleitung abzuschließen, benötigen Sie:

1. Schritt: Erstellen Sie eine API-Kampagne

1. Gehen Sie im Braze-Dashboard zu Messaging > Campaigns.
2. Wählen Sie Kampagne erstellen und anschließend API-Kampagnen.
3. Geben Sie einen Namen und eine Beschreibung für Ihre Kampagne ein, beispielsweise „SMS-Benachrichtigung“.
4. Fügen Sie relevante Tags zur Identifizierung und zum Tracking hinzu.
5. Wählen Sie Add Messaging Channel und anschließend SMS.
6. Notieren Sie sich die Campaign ID und die Message Variation ID, die auf der Kampagnenseite angezeigt werden. Sie benötigen beide Werte, um Ihre API-Anfrage zu erstellen.

2. Schritt: Senden Sie eine SMS-Nachricht über die API

Erstellen Sie eine POST-Anfrage an den /messages/send-Endpunkt. Geben Sie die Campaign-ID, die externe Nutzer-ID der Empfänger:in und den SMS-Inhalt in der Anfrage-Payload an.

Wichtig

Jede in external_user_ids referenzierte Empfänger:in muss bereits in Braze vorhanden sein. API-only-Sends erstellen keine neuen Nutzerprofile. Wenn Sie im Rahmen eines Versands Nutzer:innen anlegen müssen, verwenden Sie zunächst /users/track oder alternativ eine API-gesteuerte Kampagne.

Beispielanfrage

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

Ersetzen Sie YOUR_REST_ENDPOINT durch die REST-Endpunkt-URL für Ihren Workspace.

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."
    }
  }
}

Ersetzen Sie die Platzhalterwerte durch Ihre tatsächlichen IDs. Das Feld body unterstützt Liquid-Personalisierung, sodass Sie den Inhalt der Nachricht individuell an jede Empfänger:in anpassen können. Die vollständige Liste der vom SMS-Messaging-Objekt unterstützten Parameter finden Sie unter SMS-Objekt.

Nachdem Sie die Anfrage erstellt haben, senden Sie die POST-Anfrage von Ihrem Backend-Dienst an die Braze REST API.

3. Schritt: Überprüfen Sie Ihre Integration

Überprüfen Sie nach Abschluss der Einrichtung Ihre Integration:

1. Senden Sie eine API-Anfrage wie in Schritt 2 beschrieben und verwenden Sie dabei Ihre eigene Nutzer-ID als Empfänger:in.
2. Bestätigen Sie, dass die SMS-Nachricht auf Ihrem Telefon zugestellt wurde.
3. Gehen Sie im Braze-Dashboard zur Seite mit den Kampagnenergebnissen und überprüfen Sie, ob der Versand aufgezeichnet wurde.
4. Überwachen Sie die Ergebnisse sorgfältig, während Sie Ihre Kampagne skalieren.

Hinweise

• Stellen Sie sicher, dass Ihre SMS-Kampagnen den geltenden Vorschriften und Anforderungen der Netzbetreiber entsprechen. Fügen Sie in jede Nachricht eine Abmeldeanweisung ein (z. B. „Senden Sie STOP, um sich abzumelden“). Weitere Informationen finden Sie unter SMS-Gesetze und -Vorschriften sowie Opt-in- und Opt-out-Schlüsselwörter.
• Nutzen Sie die Personalisierungs-Features von Braze, um SMS-Inhalte individuell auf einzelne Verbraucher:innen zuzuschneiden, einschließlich dynamischem Content und nutzerspezifischen Daten.
• Die Braze REST API bietet zusätzliche Messaging-Endpunkte für die Zeitplanung von Nachrichten, das Triggern von Kampagnen und vieles mehr.