Vorlage für eine WhatsApp-Mediennachricht senden

In diesem Codeschnipsel erfahren Sie, wie Sie eine WhatsApp-Mediennachrichtenvorlage mithilfe der Messages API versenden.

Um die Mediennachrichtenvorlage zu senden, müssen Sie das benutzerdefinierte Objekt "Nachrichten" verwenden. Das benutzerdefinierte Objekt nimmt einen Teil der ursprünglichen WhatsApp-API-Anfrage und sendet sie direkt an WhatsApp.

WICHTIG! Wenn Ihnen ein Kunde eine Nachricht sendet, haben Sie 24 Stunden Zeit, um dem Kunden mit einer Freitextnachricht zu antworten. Nach Ablauf dieser Frist müssen Sie eine Vorlagenachricht (MTM) verwenden. Wenn ein Kunde Ihnen nicht zuerst eine Nachricht geschickt hat, verlangt WhatsApp beim ersten Senden einer Nachricht an einen Nutzer, dass die Nachricht eine Vorlage enthält. Dies wird ausführlicher erklärt in der Das Thema WhatsApp verstehen.

Beschränkungen des Nachrichtenformats und der Länge

WhatsApp Media Message Templates bestehen aus einer Header-, Body- und Footer-Struktur. Die Kopfzeile enthält die Medien, bei denen es sich um Text, Ort, Video, Bild oder Datei handeln kann. Der Body enthält die Textnachricht. Diese ist derzeit auf 1024 Zeichen begrenzt, wenn sie dem Endbenutzer angezeigt wird, um das Scrollen zu vermeiden. Die Fußzeile ist optional und enthält nur statischen Text.

HINWEIS: Die Länge der Kopf- und Fußzeile ist derzeit auf jeweils 60 Zeichen und die Länge des Nachrichtentextes auf 1024 Zeichen begrenzt.

Beispiel

Nachstehend finden Sie die Beschreibung aller in den einzelnen Codeausschnitten verwendeten Variablen:

SchlüsselBeschreibung
VONAGE_APPLICATION_ID

The Vonage Application ID.

VONAGE_APPLICATION_PRIVATE_KEY_PATH

Private key path.

BASE_URL

For production use the base URL is https://api.nexmo.com/. For sandbox testing the base URL is https://messages-sandbox.nexmo.com/.

MESSAGES_API_URL

There are two versions of the API, each with their own endpoints. For production the previous Messages API endpoint was https://api.nexmo.com/v0.1/messages, the new one is https://api.nexmo.com/v1/messages. For sandbox testing the Messages API endpoint is https://messages-sandbox.nexmo.com/v0.1/messages or https://messages-sandbox.nexmo.com/v1/messages, depending on which version you have set in the sandbox dashboard.

WHATSAPP_NUMBER

The WhatsApp number that has been allocated to you by Vonage. For sandbox testing the number is 14157386102.

VONAGE_WHATSAPP_NUMBER

Refer to WHATSAPP_NUMBER above.

VONAGE_NUMBER

Refer to WHATSAPP_NUMBER above.

TO_NUMBER

Replace with the number you are sending to. E.g. 447700900001

WHATSAPP_TEMPLATE_NAME

The name of the template created in your WhatsApp Business Account.

IMAGE_URL

The link to the image file to send.

WHATSAPP_TEMPLATE_REPLACEMENT_TEXT

Text to populate place-holders in a WhatsApp template message.

HINWEIS: Verwenden Sie kein führendes + oder 00 Wenn Sie eine Telefonnummer eingeben, beginnen Sie mit der Landesvorwahl, z. B. 447700900000.

Voraussetzungen

Wenn Sie keine Bewerbung haben, können Sie einen erstellen aufrufen. Stellen Sie sicher, dass Sie auch Ihre Webhooks konfigurieren.

Schreiben Sie den Code

Fügen Sie Folgendes zu send-media-mtm.sh hinzu:

curl -X POST "${MESSAGES_API_URL}" \
  -H "Authorization: Bearer "$JWT\
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "to": "'${MESSAGES_TO_NUMBER}'",
    "from": "'${WHATSAPP_SENDER_ID}'",
    "channel": "whatsapp",
    "message_type": "custom",
    "custom": {
      "type": "template",
      "template": {
        "name": "'${WHATSAPP_TEMPLATE_NAME}'",
        "language": {
          "policy": "deterministic",
          "code": "en"
        },
        "components": [
          {
            "type": "header",
            "parameters": [
              {
                "type": "image",
                "image": {
                  "link": "'${MESSAGES_IMAGE_URL}'"
                }
              }
            ]
          },
          {
            "type": "body",
            "parameters": [
              {
                "type": "text",
                "text": "Joe Bloggs"
              },
              {
                "type": "text",
                "text": "AB123456"
              }
            ]
          }
        ]
      }
    }
  }'

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

bash send-media-mtm.sh

Voraussetzungen

Wenn Sie keine Bewerbung haben, können Sie einen erstellen aufrufen. Stellen Sie sicher, dass Sie auch Ihre Webhooks konfigurieren.

npm install @vonage/server-sdk @vonage/messages

Erstellen Sie eine Datei mit dem Namen send-media-mtm.js und fügen Sie den folgenden Code hinzu:

const { Vonage } = require('@vonage/server-sdk');
const { Channels } = require('@vonage/messages');

/**
 * It is best to send messages using JWT instead of basic auth. If you leave out
 * apiKey and apiSecret, the messages SDK will send requests using JWT tokens
 *
 * @link https://developer.vonage.com/en/messages/technical-details#authentication
 */
const vonage = new Vonage(
  {
    applicationId: VONAGE_APPLICATION_ID,
    privateKey: VONAGE_PRIVATE_KEY,
  },
  {
    ...(MESSAGES_API_URL ? {apiHost: MESSAGES_API_URL} : {}),
  },
);

Vollständige Quelle anzeigen

Schreiben Sie den Code

Fügen Sie Folgendes zu send-media-mtm.js hinzu:

vonage.messages.send({
  to: MESSAGES_TO_NUMBER,
  from: WHATSAPP_SENDER_ID,
  channel: Channels.WHATSAPP,
  messageType: 'custom',
  custom: {
    type: 'template',
    template: {
      name: WHATSAPP_TEMPLATE_NAME,
      language: {
        policy: 'deterministic',
        code: 'en',
      },
      components: [
        {
          type: 'header',
          parameters: [
            {
              type: 'image',
              image: {
                link: MESSAGES_IMAGE_URL,
              },
            },
          ],
        },
        {
          type: 'body',
          parameters: [
            {
              type: 'text',
              text: 'Joe Bloggs',
            },
            {
              type: 'text',
              text: 'AB123456',
            },
          ],
        },
      ],
    },
  },
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

node send-media-mtm.js

Voraussetzungen

Wenn Sie keine Bewerbung haben, können Sie einen erstellen aufrufen. Stellen Sie sicher, dass Sie auch Ihre Webhooks konfigurieren.

Fügen Sie Folgendes zu build.gradle hinzu:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Erstellen Sie eine Datei mit dem Namen SendWhatsappMediaTemplate und fügen Sie den folgenden Code in die Methode main ein:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

Vollständige Quelle anzeigen

Schreiben Sie den Code

Fügen Sie der Methode main in der Datei SendWhatsappMediaTemplate Folgendes hinzu:

val messageId = client.messages.send(
    whatsappCustom {
        to(MESSAGES_TO_NUMBER)
        from(WHATSAPP_SENDER_ID)
        custom(mapOf(
            "type" to MessageType.TEMPLATE,
            "template" to mapOf(
                "name" to WHATSAPP_TEMPLATE_NAME,
                "language" to mapOf(
                    "policy" to Policy.DETERMINISTIC,
                    "code" to Locale.ENGLISH
                ),
                "components" to listOf(
                    mapOf(
                        "type" to "header",
                        "parameters" to listOf(
                            mapOf(
                                "type" to MessageType.IMAGE,
                                "image" to mapOf(
                                    "link" to MESSAGES_IMAGE_URL
                                )
                            )
                        )
                    ),
                    mapOf(
                        "type" to "body",
                        "parameters" to listOf(
                            mapOf(
                                "type" to MessageType.TEXT,
                                "text" to WHATSAPP_TEMPLATE_REPLACEMENT_TEXT
                            )
                        )
                    )
                )
            )
        ))
    }
)

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Wir können das Anmeldung Plugin für Gradle verwenden, um die Ausführung unserer Anwendung zu vereinfachen. Aktualisieren Sie Ihre build.gradle mit dem Folgenden:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Führen Sie den folgenden Befehl gradle aus, um Ihre Anwendung auszuführen, und ersetzen Sie dabei com.vonage.quickstart.kt.messages.whatsapp durch das Paket, das SendWhatsappMediaTemplate enthält:

gradle run -Pmain=com.vonage.quickstart.kt.messages.whatsapp.SendWhatsappMediaTemplate

Voraussetzungen

Wenn Sie keine Bewerbung haben, können Sie einen erstellen aufrufen. Stellen Sie sicher, dass Sie auch Ihre Webhooks konfigurieren.

Fügen Sie Folgendes zu build.gradle hinzu:

implementation 'com.vonage:server-sdk:9.3.1'

Erstellen Sie eine Datei mit dem Namen SendWhatsappMediaTemplate und fügen Sie den folgenden Code in die Methode main ein:

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

Vollständige Quelle anzeigen

Schreiben Sie den Code

Fügen Sie der Methode main in der Datei SendWhatsappMediaTemplate Folgendes hinzu:

var response = client.getMessagesClient().sendMessage(
	WhatsappCustomRequest.builder()
		.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
		.custom(Map.of(
				"type", MessageType.TEMPLATE,
				"template", Map.of(
					"name", WHATSAPP_TEMPLATE_NAME,
					"language", Map.of(
						"policy", Policy.DETERMINISTIC,
						"code", Locale.ENGLISH
					),
					"components", List.of(
						Map.of(
							"type", "header",
							"parameters", List.of(
								Map.of(
									"type", MessageType.IMAGE,
									"image", Map.of(
										"link", MESSAGES_IMAGE_URL
									)
								)
							)
						),
						Map.of(
							"type", "body",
							"parameters", List.of(
								Map.of(
									"type", MessageType.TEXT,
									"text", WHATSAPP_TEMPLATE_REPLACEMENT_TEXT
								)
							)
						)
					)
				)
		)).build()
);
System.out.println("Message sent successfully. ID: "+response.getMessageUuid());

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Wir können das Anmeldung Plugin für Gradle verwenden, um die Ausführung unserer Anwendung zu vereinfachen. Aktualisieren Sie Ihre build.gradle mit dem Folgenden:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Führen Sie den folgenden Befehl gradle aus, um Ihre Anwendung auszuführen, und ersetzen Sie dabei com.vonage.quickstart.messages.whatsapp durch das Paket, das SendWhatsappMediaTemplate enthält:

gradle run -Pmain=com.vonage.quickstart.messages.whatsapp.SendWhatsappMediaTemplate

Voraussetzungen

Wenn Sie keine Bewerbung haben, können Sie einen erstellen aufrufen. Stellen Sie sicher, dass Sie auch Ihre Webhooks konfigurieren.

Install-Package Vonage

Schreiben Sie den Code

Fügen Sie Folgendes zu SendWhatsAppMediaMtm.cs hinzu:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new WhatsAppCustomRequest
{
    To = MESSAGES_TO_NUMBER,
    From = WHATSAPP_SENDER_ID,
    Custom = new
    {
        type = "template",
        template = new
        {
            name = WHATSAPP_TEMPLATE_NAME,
            language = new
            {
                code = "en",
                policy = "deterministic"
            },
            components = new object[]
            {
                new
                {
                    type = "header",
                    image = new
                    {
                        link = MESSAGES_IMAGE_URL
                    }
                },
                new
                {
                    type = "body",
                    parameters = new[]
                    {
                        new
                        {
                            type = "text",
                            text = "This is a WhatsApp Media Message Template Message sent using the Vonage Messages API."
                        }
                    }
                }
            }
        }
    }
};
var response = await vonageClient.MessagesClient.SendAsync(request);

Vollständige Quelle anzeigen

Voraussetzungen

Wenn Sie keine Bewerbung haben, können Sie einen erstellen aufrufen. Stellen Sie sicher, dass Sie auch Ihre Webhooks konfigurieren.

composer require vonage/client

Erstellen Sie eine Datei mit dem Namen send-media-mtm.php und fügen Sie den folgenden Code hinzu:

$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
    VONAGE_APPLICATION_ID
);

$client = new \Vonage\Client($keypair);

Vollständige Quelle anzeigen

Schreiben Sie den Code

Fügen Sie Folgendes zu send-media-mtm.php hinzu:

$custom = [
    "type" => "template",
    "template" => [
        "name" => WHATSAPP_TEMPLATE_NAME,
        "language" => ["policy" => "deterministic", "code" => "en"],
        "components" => [
            [
                "type" => "header",
                "parameters" => [
                    [
                        "type" => "image",
                        "image" => [
                            "link" => IMAGE_URL,
                        ],
                    ],
                ],
            ],
            [
                "type" => "body",
                "parameters" => [
                    "type" => "text",
                    "text" => WHATSAPP_TEMPLATE_REPLACEMENT_TEXT,
                ],
            ],
        ],
    ],
];

$whatsApp = new \Vonage\Messages\Channel\WhatsApp\WhatsAppCustom(
    TO_NUMBER,
    FROM_NUMBER,
    $custom
);

$client->messages()->send($whatsApp);

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

php send-media-mtm.php

Voraussetzungen

Wenn Sie keine Bewerbung haben, können Sie einen erstellen aufrufen. Stellen Sie sicher, dass Sie auch Ihre Webhooks konfigurieren.

pip install vonage python-dotenv

Schreiben Sie den Code

Fügen Sie Folgendes zu send-media-template.py hinzu:

from vonage import Auth, Vonage
from vonage_messages import WhatsappCustom

client = Vonage(
    Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    )
)

message = WhatsappCustom(
    to=MESSAGES_TO_NUMBER,
    from_=WHATSAPP_SENDER_ID,
    custom={
        "type": "template",
        "template": {
            "name": WHATSAPP_TEMPLATE_NAME,
            "language": {"policy": "deterministic", "code": "en"},
            "components": [
                {
                    "type": "header",
                    "parameters": [
                        {
                            "type": "image",
                            "image": {
                                "link": MESSAGES_IMAGE_URL,
                            },
                        },
                    ],
                },
                {
                    "type": "body",
                    "parameters": [
                        {"type": "text", "text": "Joe Bloggs"},
                        {"type": "text", "text": "AB123456"},
                    ],
                },
            ],
        },
    },
)

response = client.messages.send(message)
print(response)

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

python messages/whatsapp/send-media-template.py

Voraussetzungen

Wenn Sie keine Bewerbung haben, können Sie einen erstellen aufrufen. Stellen Sie sicher, dass Sie auch Ihre Webhooks konfigurieren.

gem install vonage

Erstellen Sie eine Datei mit dem Namen send-media-mtm.rb und fügen Sie den folgenden Code hinzu:

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: VONAGE_PRIVATE_KEY
)

Vollständige Quelle anzeigen

Schreiben Sie den Code

Fügen Sie Folgendes zu send-media-mtm.rb hinzu:

message = client.messaging.whatsapp(
  type: 'custom',
  message: {
    type: "template",
    template: {
      name: WHATSAPP_TEMPLATE_NAME,
      language: {
        policy: "deterministic",
        code: "en"
      },
      components: [
        {
          type: "header",
          parameters: [
            {
              type: "image",
              image: {
                link: MESSAGES_IMAGE_URL
              }
            }
          ]
        },
        {
          type: "body",
          parameters: [
            {
              type: "text",
              text: "Joe Bloggs"
            },
            {
              type: "text",
              text: "AB123456"
            }
          ]
        }
      ]
    }
  }
)

client.messaging.send(
  from: WHATSAPP_SENDER_ID,
  to: MESSAGES_TO_NUMBER,
  **message
)

Vollständige Quelle anzeigen

Führen Sie Ihren Code aus

Speichern Sie diese Datei auf Ihrem Rechner und führen Sie sie aus:

ruby send-media-mtm.rb

Probieren Sie es aus

Wenn Sie den Code ausführen, wird eine WhatsApp-Mediennachrichtenvorlage an die Zielnummer gesendet.

Weitere Informationen