WhatsApp Business Platform On-Premises API

Senden von Mediennachrichten

Mit dem /messages-Node kannst du Nachrichten, die Audio, Dokumente, Bilder, Sticker oder Videos enthalten, an deine Kunden senden.

Das heißt, wenn du eine Nachricht sendest, die Medien enthält, musst du die ID der hochgeladenen Medien oder einen Link zu den Medien im Hauptteil der Anfrage angeben. Außerdem musst du angeben, welchen Medientyp du sendest: audio, document, image, sticker oder video. Bei Empfang der Anfrage werden die Medien zum WhatsApp-Server hochgeladen. Dann werden sie an den Nutzer gesendet, der im Feld to angegeben ist.

Es gibt aktuell zwei Arten, um mit der WhatsApp Business API Mediennachrichten zu senden:

  • IDs: Zur Verwendung einer ID musst du zuerst die Medien mit dem media-Node hochladen, um die ID zu erhalten, die du für den messages-API-Aufruf brauchst.
  • Links: Für die Verwendung eines Links gibst du einen HTTP(S)-Link an, von dem die App die Medien herunterlädt. Somit sparst du den Schritt, die Medien selbst hochzuladen.

Bevor du beginnst

Du benötigst Folgendes:

Schritt 1: POST-Anforderung an /messages erstellen

Nachdem du die Medien hochgeladen hast, gibst du im API-Aufruf, mit dem die Mediennachricht gesendet wird, die in der Antwort erhaltene ID in das Feld id ein. Du kannst auch einen link-Parameter angeben, der auf die Medien verweist, die du senden möchtest (aktuell werden nur HTTP-/HTTPS-Links unterstützt).

id oder link sind erforderlich, dürfen jedoch nicht gleichzeitig verwendet werden.

Beispiel

Im Beispiel unten sind verschiedene Objekte wie audio, document, image, sticker und video nur zu Demonstrationszwecken enthalten. Ein gültiger Anfragentext enthält nur eines dieser Elemente.

POST /v1/messages
{
  "recipient_type": "individual",
  "to": "whatsapp-id",
  "type": "audio" | "contact" | "document" | "image" | "location" | "sticker" | "text" | "video",
  
  "audio": {
    "id": "your-media-id"
  }
  
  "document": {
    "id": "your-media-id",
    "filename": "your-document-filename"
  }
  
  "document": {
    "link": "the-provider-name/protocol://the-url",
    "provider": {
        "name" : "provider-name"
    }
  }
  
  "document": {
    "link": "http(s)://the-url.pdf"
  }
  
  "video": {
    "id": "your-media-id"  
  }
  
  "image": {
    "link": "http(s)://the-url",
    "provider": {
        "name" : "provider-name"
    }
  }
  
  "image": {
    "id": "your-media-id"   
  }
  
  "sticker": {
    "id": "your-media-id"
  }
  
  "sticker": {
    "link": "http(s)://the-url",
    "provider": {
      "name" : "provider-name"
    }
  }
}

Weitere Informationen zu Parametern findest du hier:

Schritt 2: Antwort prüfen

Wenn der Vorgang erfolgreich war, enthält die Antwort ein messages-Objekt mit einer Nachrichten-ID.

{
  "messages": [{
    "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
  }]
}

Schlägt eine Antwort fehl, wird ein Rückruf an deine Webhook-URL gesendet. Dies geschieht auch dann, wenn mit der Antwort eine Nachrichten-ID erhalten wird, die einer erfolgreich gesendeten Nachricht ähnlich ist. Daher ist es wichtig, einen Webhook-Server einzurichten.

Weitere Informationen zu Fehlern findest du unter Fehler- und Statuscodes.

Mehr dazu