Senden einer WhatsApp-Nachrichtenvorlage (MTM)

In diesem Codeschnipsel lernen Sie, wie man eine WhatsApp Message Template Message (MTM) mit Hilfe der Messages API versendet.

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 Nachrichtenvorlage (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.

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.

VONAGE_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.

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-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": "template",
    "whatsapp": {
      "policy": "deterministic",
      "locale": "en"
    },
    "template":{
      "name": "'${WHATSAPP_TEMPLATE_NAME}'",
      "parameters":[
        "Joe Bloggs",
        "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-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-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-mtm.js hinzu:

vonage.messages.send({
  to: MESSAGES_TO_NUMBER,
  from: WHATSAPP_SENDER_ID,
  channel: Channels.WHATSAPP,
  messageType: 'template',
  whatsapp: {
    policy: 'deterministic',
    locale: 'en',
  },
  template: {
    name: WHATSAPP_TEMPLATE_NAME,
    parameters: [
      'Joe Bloggs',
      '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-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 SendWhatsappTemplate 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 SendWhatsappTemplate Folgendes hinzu:

val messageId = client.messages.send(
    whatsappTemplate {
        to(MESSAGES_TO_NUMBER)
        from(WHATSAPP_SENDER_ID)
        policy(Policy.DETERMINISTIC)
        locale(Locale.ENGLISH_UK)
        name("$WHATSAPP_TEMPLATE_NAMESPACE:$WHATSAPP_TEMPLATE_NAME")
        parameters(listOf(
            "Vonage Verification",
            "64873",
            "10"
        ))
    }
)

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 SendWhatsappTemplate enthält:

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

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 SendWhatsappTemplate 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 SendWhatsappTemplate Folgendes hinzu:

var response = client.getMessagesClient().sendMessage(
		WhatsappTemplateRequest.builder()
			.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
			.policy(Policy.DETERMINISTIC).locale(Locale.ENGLISH_UK)
			.name(WHATSAPP_TEMPLATE_NAMESPACE+':'+WHATSAPP_TEMPLATE_NAME)
			.parameters(List.of(
					"Vonage Verification",
					"64873",
					"10"
			))
			.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 SendWhatsappTemplate enthält:

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

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 SendWhatsAppMtm.cs hinzu:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new WhatsAppTemplateRequest
{
    To = MESSAGES_TO_NUMBER,
    From = WHATSAPP_SENDER_ID,
    WhatsApp = new MessageWhatsApp
    {
        Policy = "deterministic",
        Locale = "en-GB",
    },
    Template = new MessageTemplate
    {
        Name = WHATSAPP_TEMPLATE_NAME,
        Parameters =
        [
            "Vonage Verification",
            "64873",
            "10"
        ],
    }
};
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-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-mtm.php hinzu:

$custom = [
    "name" => WHATSAPP_TEMPLATE_NAMESPACE . ":" . WHATSAPP_TEMPLATE_NAME,
    "parameters" => [
        "Vonage Verification",
        "64873",
        "10",
    ],
];

$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-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-template.py hinzu:

from vonage import Auth, Vonage
from vonage_messages import (WhatsappTemplate, WhatsappTemplateResource,
                             WhatsappTemplateSettings)

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

message = WhatsappTemplate(
    to=MESSAGES_TO_NUMBER,
    from_=WHATSAPP_SENDER_ID,
    template=WhatsappTemplateResource(
        name=WHATSAPP_TEMPLATE_NAME,
        parameters=["Vonage Verification", "64873", "10"],
    ),
    whatsapp=WhatsappTemplateSettings(
        locale="en-GB",
        policy="deterministic",
    ),
)

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-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-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-mtm.rb hinzu:

message = client.messaging.whatsapp(
  type: 'template',
  message: {
    name: WHATSAPP_TEMPLATE_NAME,
    parameters: [
      "Joe Bloggs",
      "AB123456"
    ]
  },
  opts: {
    whatsapp: {
     policy: "deterministic",
     locale: "en"
   }
  }
)

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-mtm.rb

Probieren Sie es aus

Wenn Sie den Code ausführen, wird eine WhatsApp-Nachrichtenvorlage (MTM) an die Zielnummer gesendet.

Weitere Informationen