API: WhatsApp-Vorlagen auflisten und senden
Zwei Endpunkte lassen Ihre Software Ihre WhatsApp-Vorlagen nutzen. GET /api/v1/whatsapp/templates listet Ihre freigegebenen Vorlagen, und POST /api/v1/whatsapp/send-template sendet eine von Ihrer Standardnummer an einen Gast. Beide brauchen einen Schlüssel mit WhatsApp-Zugriff.
- Wo
- Ask Menuthere support for a key
- Tarif
- Braucht eine verbundene WhatsApp-Business-Nummer, die ab Pro verfügbar ist.
- Aktualisiert
Ihre Vorlagen auflisten
curl 'https://menuthere.com/api/v1/whatsapp/templates' -H 'Authorization: Bearer ck_live_YOUR_KEY'
Es gibt die freigegebenen Vorlagen Ihrer Standardnummer zurück, sodass Sie den genauen Namen kennen und wissen, wie viele Werte jede braucht.
| Feld | Bedeutung |
|---|---|
| name, language | Name und Sprachcode der Vorlage. |
| category, status | Kategorie wie MARKETING oder UTILITY. Der Status ist APPROVED. |
| body_variables | Wie viele {{n}}-Werte der Text braucht. |
| has_header, header_format | Ob es einen Kopf gibt, und TEXT, IMAGE, VIDEO oder DOCUMENT. |
Eine Vorlage senden
POST /api/v1/whatsapp/send-template mit einem JSON-Body. Die Nachricht geht von Ihrem Standardabsender raus, den Sie unter Mehrere Nummern und die Hauptnummer festlegen. Die Nummer können Sie im Aufruf nicht wählen.
| Feld | Pflicht | Was es ist |
|---|---|---|
| to | Ja | Die Nummer des Gastes mit Ländervorwahl. |
| template_name | Ja | Der Name aus dem Listenaufruf. |
| language | Nein | Wird aus der freigegebenen Vorlage nachgeschlagen, wenn Sie es weglassen. |
| body_params | Nein | Array mit Werten für {{1}}, {{2}} usw. in dieser Reihenfolge. |
| header_params | Nein | Array mit Werten für einen Textkopf. |
| header_media_url, header_media_type | Nein | Ein Link und image, video oder document für einen Medienkopf. |
| button_params | Nein | Array mit Werten für eine Schaltfläche mit dynamischer URL. |
| idempotency_key | Nein | Eine Referenz Ihrer Wahl. id und ein Header Idempotency-Key funktionieren ebenfalls. |
Ein erfolgreicher Versand gibt ok: true, die message_id, die Nummer to und status: "sent" zurück. Senden Sie denselben Idempotenzschlüssel erneut, erhalten Sie das erste Ergebnis mit duplicate: true zurück, und nichts wird doppelt gesendet. Ein fehlgeschlagener Versand gibt den Schlüssel frei, sodass Sie es erneut versuchen können.
Fehler und Grenzen
| Status | `error` | Bedeutung |
|---|---|---|
| 400 | missing_fields, invalid_json, invalid_number, template_error | Ein Pflichtfeld fehlt, die Nummer sieht falsch aus, oder die Vorlage passt nicht zu den gesendeten Werten. |
| 404 | template_not_found | Keine freigegebene Vorlage mit diesem Namen auf Ihrer Standardnummer. |
| 409 | recipient_opted_out | Der Gast hat mit STOP geantwortet. Es wird keine Nachricht gesendet. |
| 409 | in_progress | Eine Anfrage mit demselben Idempotenzschlüssel läuft noch. |
| 412 | no_whatsapp_number | Es ist keine Standard-WhatsApp-Nummer verbunden. |
| 429 | daily_limit_reached, rate_limited | Das tägliche WhatsApp-Limit Ihrer Nummer ist aufgebraucht, oder der Schlüssel liegt über seinem Limit. |
| 502 | send_failed | WhatsApp war nicht erreichbar. Versuchen Sie es erneut. |
Fragen
Kann ich über die API eine normale Textnachricht senden?
Schreibt sie jemandem, der sich abgemeldet hat?
Siehe auch
Nicht gefunden? Schreiben Sie an [email protected] oder chatten Sie mit uns, 9 bis 21 Uhr.Hilfe-CenterPreisemenuthere.com