WhatsApp Business Management API

Gutscheincode-Vorlagen

Gutscheincode-Vorlagen sind Marketing-Vorlagen, die einen einzelnen „Code kopieren“-Button anzeigen. Wenn dieser angetippt wird, wird der Code in die Zwischenablage des*der Kind*in kopiert.

Einschränkungen

  • Gutscheincode-Vorlagen werden derzeit nicht vom WhatsApp Web-Client unterstützt.
  • Codes dürfen maximal 15 Zeichen lang sein.
  • Der Button-Text kann nicht angepasst werden.
  • Vorlagen können nur einen „Code kopieren“-Button enthalten.

Erstellen von Gutscheincode-Vorlagen

Verwende den WhatsApp-Unternehmenskonto > Nachrichtenvorlagen-Endpunkt, um Gutscheincode-Vorlagen zu erstellen.

Anfragesyntax

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

Anfrageinhalt

{
  "name": "<NAME>",
  "language": "<LANGUAGE>",
  "category": "MARKETING",
  "components": [
    ... // Additional components, if using
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type":"COPY_CODE",
          "example": "<EXAMPLE>"
        },
        ... // Additional buttons, if using
      ]
    }
  ]
}

Eigenschaften

PlatzhalterBeschreibungBeispielwert

<NAME>

String

Erforderlich.


Vorlagenname.


Maximal 512 Zeichen.

fall2023_promotion

<LANGUAGE>

Enum

Erforderlich.


Sprache und Ländercode der Vorlage.

en_US

<EXAMPLE>

String

Erforderlich.


Gutscheincode, der bei Antippen kopiert werden soll.


Maximal 15 Zeichen.

25OFF

Antwort

War der Vorgang erfolgreich, gibt die API die folgende Antwort:

{
   "category" : "<CATEGORY>",
   "id" : "<ID>",
   "status" : "<STATUS>"
}

Antworteigenschaften

PlatzhalterBeschreibungBeispielwert

<CATEGORY>

Enum

Vorlagenkategorie.

MARKETING

<ID>

Numerischer String

Vorlagen-ID.

1924084211297547

<STATUS>

Enum

Vorlagenstatus.

PENDING

Beispielanfrage

curl 'https://graph.facebook.com/v21.0/102290129340398/message_templates' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "name": "coupon_code_fall2023_25off",
  "language": "en_US",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Our Fall Sale is on!"
    },
    {
      "type": "BODY",
      "text": "Shop now through November and use code {{1}} to get {{2}} off of all merchandise!",
      "example": {
        "body_text": [
          [
            "25OFF",
            "25%"
          ]
        ]
      }
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Unsubscribe"
        },
        {
          "type": "COPY_CODE",
          "example": "250FF"
        }
      ]
    }
  ]
}'

Beispielantwort

{
  "category" : "MARKETING",
  "id" : "1924084211297547",
  "status" : "PENDING"
}

Gutscheinvorlagen senden

Verwende die Cloud API, um genehmigte Gutscheincode-Vorlagen in Vorlagennachrichten zu senden. Siehe Gutscheincode-Vorlagen senden.