Technische Details der Messages API

Mit der Messages API können Sie Nachrichten über SMS, MMS, RCS, Facebook Messenger, Viber und WhatsApp senden und in einigen Fällen auch empfangen. Weitere Kanäle werden möglicherweise in Zukunft unterstützt.

Das folgende Diagramm veranschaulicht, wie die Vonage Messages API es Ihnen ermöglicht, Nachrichten für den Anwendungsfall Ihrer Wahl über mehrere Kanäle von einem einzigen Endpunkt aus zu versenden; zum Beispiel könnten Sie Benachrichtigungen über WhatsApp und SMS versenden:

Unterstützte Funktionen

Begrenzte Unterstützung wird auch gewährt für benutzerdefinierte Objekte:

Schlüssel:

• = Unterstützt.
• = Wird vom Sender unterstützt, aber nicht von Vonage.
• n/a = wird vom Kanal nicht unterstützt.

Anmerkungen:

1. Für RCS ist die custom Typ ist veraltet. Schaltflächen- und Standortmeldungen werden unterstützt als Anregung Chips in text, cardund carousel Meldungen eingeben

Authentifizierung

Die Messages API unterstützt entweder Basis-Authentifizierung oder JWT (JSON Web Token)-Authentifizierung, aber es gibt einige wichtige Unterschiede zwischen den beiden, die Sie beachten sollten:

• Die Basisauthentifizierung verwendet ein verschlüsseltes API-Schlüssel und Geheimnisund beglaubigt am Account Ebene.
• Die JWT-Authentifizierung verwendet eine JSON-Web-Token die mit einem privaten Schlüssel und einer Anwendungs-ID erzeugt werden. JWTs unterstützen erweiterte Funktionen wie ACLs und Authentifizierung auf der Applikation Ebene, d.h. Sie können auf die Einstellungen Ihrer Vonage-Applikation zugreifen, wie z.B. auf die Anwendungs Webhaken und Sichere eingehende Medien.

Wir empfehlen, dass Sie JWT-Authentifizierung in der Produktion für die meisten Anwendungsfälle. Eine einfache Authentifizierung kann ausreichen, wenn Sie die API ausprobieren, z. B. bei der Verwendung der Messages Sandbox, oder für einige grundlegende Anwendungsfälle (z. B. wenn Webhooks nicht erforderlich sind).

Wenn Sie unser Server-SDKs um mit der Messages API zu interagieren, können diese automatisch JWTs für Sie erstellen.

Externe Accounts API

Die Externe Accounts API wird verwendet, um Ihre Konten für Viber Business Messages, Facebook Messenger und WhatsApp zu verwalten, wenn Sie diese Kanäle mit den Messages- und Dispatch-APIs nutzen.

Erste Schritte

In diesem Beispiel müssen Sie die folgenden Variablen mit einer beliebigen Methode durch aktuelle Werte ersetzen:

Der folgende Code zeigt, wie eine SMS-Nachricht mithilfe der Messages API gesendet wird:

	-u "${VONAGE_API_KEY}:${VONAGE_API_SECRET}" \
	-H 'Content-Type: application/json' \
	-H 'Accept: application/json' \
	-d $'{
		"to": "'${MESSAGES_TO_NUMBER}'",
		"from": "'${SMS_SENDER_ID}'",
		"channel": "sms",
		"message_type": "text",
		"text": "This is an SMS sent using the Vonage Messages API."
	}'

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

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

/**
 * By leaving out the applicationId and privateKey parameters, the Vonage
 * SDK will use basic authentication to authenticate with the Messages API.
 *
 * @link https://developer.vonage.com/en/messages/technical-details#authentication
 */
const vonage = new Vonage(
  {
    apiKey: VONAGE_API_KEY,
    apiSecret: VONAGE_API_SECRET,
  },
  {
    ...(MESSAGES_API_URL ? {apiHost: MESSAGES_API_URL} : {}),
  },
);

vonage.messages.send({
  messageType: 'sms',
  channel: Channels.SMS,
  text: 'This is an SMS text message sent using the Messages API',
  to: MESSAGES_TO_NUMBER,
  from: SMS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

Referenz

• Messages API-Referenz
• Externe Accounts API-Referenz